|
Runtime | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.eclipse.gmf.runtime.common.ui.services.properties.extended.PropertySource
public class PropertySource
Field Summary | |
---|---|
protected ICompositePropertySource |
enclosed
ICompositePropertySource |
protected java.util.Map |
properties
map containing properties key: id Value: property |
protected java.util.Map |
propertyDescriptors
map containing propertyDescriptors key: id value: propertydescriptor |
Constructor Summary | |
---|---|
PropertySource()
basic constructor |
|
PropertySource(java.lang.Object element)
The constructor which accepts an element object as an argument. |
Method Summary | |
---|---|
void |
addProperty(java.lang.Object id,
java.lang.Object property)
add properties to the properties map |
void |
addPropertyDescriptor(IExtendedPropertyDescriptor propertyDescriptor)
Adds propertyDescriptor to this property source. |
void |
addPropertySource(ICompositePropertySource source)
Add enclosed property source object (a child) - this creates a linked list of property sources |
java.lang.Object |
getEditableValue()
getter for the editable value |
java.lang.Object |
getElement()
Returns the element. |
java.util.Map |
getProperties()
Returns the properties. |
IExtendedPropertyDescriptor |
getPropertyDescriptor(java.lang.Object id)
Gets IExtendedPropertyDescriptor |
IPropertyDescriptor[] |
getPropertyDescriptors()
|
java.lang.Object |
getPropertyValue(java.lang.Object id)
|
boolean |
isDirty()
Return if the dirty flag. |
boolean |
isPropertySet(java.lang.Object id)
|
boolean |
isValueOkay(java.lang.Object id,
java.lang.Object value)
checks to see if the value entered is the same as the BLANK value displayed in multiple select. |
void |
refresh()
Refresh properties |
void |
removeProperty(java.lang.Object id)
removes properties from the properties map |
void |
resetPropertyValue(java.lang.Object id)
|
void |
setDirty(boolean flag)
Set the dirty flag to boolean. |
void |
setEditableValue(java.lang.Object object)
Deprecated. |
void |
setElement(java.lang.Object element)
Sets the element. |
void |
setProperties(java.util.Map properties)
Sets the properties. |
void |
setPropertyDescriptors(java.util.Map propertyDescriptors)
Sets the propertyDescriptors. |
void |
setPropertyValue(java.lang.Object id,
java.lang.Object value)
|
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
protected java.util.Map properties
protected java.util.Map propertyDescriptors
protected ICompositePropertySource enclosed
ICompositePropertySource
Constructor Detail |
---|
public PropertySource()
public PropertySource(java.lang.Object element)
element
- The element which is in the selectionMethod Detail |
---|
public void addPropertySource(ICompositePropertySource source)
addPropertySource
in interface ICompositePropertySource
source
- -
an eclosed (a child) property source objectpublic java.lang.Object getEditableValue()
getEditableValue
in interface IPropertySource
IPropertySource.getEditableValue()
public void setEditableValue(java.lang.Object object)
object
- public IPropertyDescriptor[] getPropertyDescriptors()
getPropertyDescriptors
in interface IPropertySource
IPropertySource.getPropertyDescriptors()
public void addPropertyDescriptor(IExtendedPropertyDescriptor propertyDescriptor)
addPropertyDescriptor
in interface IExtendedPropertySource
propertyDescriptor
- IExtendedPropertyDescriptor descriptor to be addedpublic java.lang.Object getPropertyValue(java.lang.Object id)
getPropertyValue
in interface IPropertySource
IPropertySource.getPropertyValue(Object)
public boolean isPropertySet(java.lang.Object id)
isPropertySet
in interface IPropertySource
IPropertySource.isPropertySet(Object)
public void resetPropertyValue(java.lang.Object id)
resetPropertyValue
in interface IPropertySource
IPropertySource.resetPropertyValue(Object)
public void setPropertyValue(java.lang.Object id, java.lang.Object value)
setPropertyValue
in interface IPropertySource
IPropertySource.setPropertyValue(Object,
Object)
public java.lang.Object getElement()
getElement
in interface IExtendedPropertySource
public void setElement(java.lang.Object element)
setElement
in interface IExtendedPropertySource
element
- The modelElement to setpublic void addProperty(java.lang.Object id, java.lang.Object property)
addProperty
in interface IExtendedPropertySource
id
- Objectproperty
- Objectpublic void removeProperty(java.lang.Object id)
removeProperty
in interface IExtendedPropertySource
id
- Objectpublic IExtendedPropertyDescriptor getPropertyDescriptor(java.lang.Object id)
IExtendedPropertyDescriptor
id
- The id of the property descriptor.
IExtendedPropertyDescriptor
public boolean isDirty()
IExtendedPropertySource
isDirty
in interface IExtendedPropertySource
IExtendedPropertySource.isDirty()
public void setDirty(boolean flag)
IExtendedPropertySource
setDirty
in interface IExtendedPropertySource
flag
- : Flag = true means dirty, Flag = false means not dirty.IExtendedPropertySource.setDirty(boolean)
public java.util.Map getProperties()
getProperties
in interface IExtendedPropertySource
public void setProperties(java.util.Map properties)
properties
- The properties to setpublic void setPropertyDescriptors(java.util.Map propertyDescriptors)
propertyDescriptors
- The propertyDescriptors to setpublic void refresh()
IExtendedPropertySource
refresh
in interface IExtendedPropertySource
IExtendedPropertySource.refresh()
public boolean isValueOkay(java.lang.Object id, java.lang.Object value)
isValueOkay
in interface IExtendedPropertySource
id
- property idvalue
- value to verify
true
if value is ok, false
otherwise
|
Runtime | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Guidelines for using Eclipse APIs.
Copyright (c) IBM Corp., Borland Software Corp., and others 2005,2006. All rights reserved.