|
Runtime | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.eclipse.emf.edit.ui.provider.PropertyDescriptor
org.eclipse.gmf.runtime.emf.ui.properties.descriptors.EMFCompositeSourcePropertyDescriptor
public class EMFCompositeSourcePropertyDescriptor
The descriptor that works with the EMFCompositePropertySource
object.
When the property value is set while an EMF transaction is open on the editing domain, I will not execute the set command through the editing domain command stack. In this case, I rely on whoever opened the EMF transaction to put their operation on the operation history.
Nested Class Summary |
---|
Nested classes/interfaces inherited from class org.eclipse.emf.edit.ui.provider.PropertyDescriptor |
---|
org.eclipse.emf.edit.ui.provider.PropertyDescriptor.EDataTypeCellEditor, org.eclipse.emf.edit.ui.provider.PropertyDescriptor.EDataTypeValueHandler, org.eclipse.emf.edit.ui.provider.PropertyDescriptor.FloatCellEditor, org.eclipse.emf.edit.ui.provider.PropertyDescriptor.IntegerCellEditor |
Field Summary | |
---|---|
protected java.lang.String |
category
|
protected java.lang.String[] |
filterFlags
|
protected CellEditor |
propertyEditor
|
protected boolean |
readOnly
|
protected ICellEditorValidator |
validator
The object to validate the values in the cell editor, or null if none (the default). |
Fields inherited from class org.eclipse.emf.edit.ui.provider.PropertyDescriptor |
---|
ecorePackage, itemPropertyDescriptor, object |
Constructor Summary | |
---|---|
EMFCompositeSourcePropertyDescriptor(java.lang.Object object,
org.eclipse.emf.edit.provider.IItemPropertyDescriptor itemPropertyDescriptor)
|
|
EMFCompositeSourcePropertyDescriptor(java.lang.Object object,
org.eclipse.emf.edit.provider.IItemPropertyDescriptor itemPropertyDescriptor,
java.lang.String category)
Creates an instance of EMFCompositeSourcePropertyDescriptor . |
Method Summary | |
---|---|
void |
addFilterFlag(java.lang.String flag)
Add filter flag (@see IPropertySheetEntry.FILTER_ID_EXPERT) |
protected CellEditor |
createBooleanCellEditor(Composite composite)
|
protected CellEditor |
createComboBoxCellEditor(Composite composite)
|
protected CellEditor |
createDataTypeCellEditor(Composite composite)
|
protected CellEditor |
createDialogCellEditor(Composite composite,
org.eclipse.emf.ecore.EStructuralFeature feature,
java.util.List choiceOfValues)
Creates a dialog cell editor for editing multivalued features. |
static ILabelProvider |
createLabelProvider(org.eclipse.emf.edit.provider.IItemPropertyDescriptor itemPropertyDescriptor)
A convinience method to create an instance of a ILabelProvider using IItemPropertyDescriptor |
CellEditor |
createPropertyEditor(Composite composite)
This returns the cell editor that will be used to edit the value of this property. |
protected CellEditor |
doCreateEditor(Composite composite)
|
java.lang.String |
getCategory()
|
java.util.List |
getChoiceOfValues()
Return choice of values for the given property. |
protected java.lang.Object |
getEditableValue()
This is a temporary method. |
java.lang.Object |
getFeature()
Retrieves the feature. |
java.lang.String[] |
getFilterFlags()
|
java.lang.Object |
getId()
|
org.eclipse.emf.edit.provider.IItemPropertyDescriptor |
getItemDescriptor()
|
protected java.lang.Object |
getObject()
Retrieve an object for which this class is a property source. |
protected CellEditor |
getPropertyEditor()
|
protected org.eclipse.emf.edit.provider.IItemPropertySource |
getPropertySource(java.lang.Object value)
Returns an property source for the given value. |
java.lang.Object |
getPropertyValue()
Return a value of the the property represented by this descriptor |
ICellEditorValidator |
getValidator()
|
boolean |
isCompatibleWith(IPropertyDescriptor anotherProperty)
|
boolean |
isReadOnly()
Returns boolean - an indicator either or not this property can be set or re-set. |
void |
resetPropertyValue()
This method is used by the property source to reset the property that this property descriptor maps to. |
void |
resetPropertyValue(java.lang.Object value)
Resets the property to specified value. |
void |
setCategory(java.lang.String category)
Sets the category. |
void |
setPropertyEditor(CellEditor propertyEditor)
|
void |
setPropertyValue(java.lang.Object value)
This method is used by the property source to set the property that this property descriptor maps to. |
void |
setReadOnly(boolean value)
Sets the specified value to be read only. |
void |
setValidator(ICellEditorValidator validator)
|
Methods inherited from class org.eclipse.emf.edit.ui.provider.PropertyDescriptor |
---|
createEDataTypeCellEditor, getDescription, getDisplayName, getEditLabelProvider, getHelpContextIds, getLabelProvider |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface org.eclipse.ui.views.properties.IPropertyDescriptor |
---|
getDescription, getDisplayName, getHelpContextIds, getLabelProvider |
Field Detail |
---|
protected java.lang.String category
protected java.lang.String[] filterFlags
protected boolean readOnly
protected CellEditor propertyEditor
protected ICellEditorValidator validator
null
if none (the default).
Constructor Detail |
---|
public EMFCompositeSourcePropertyDescriptor(java.lang.Object object, org.eclipse.emf.edit.provider.IItemPropertyDescriptor itemPropertyDescriptor)
object
- itemPropertyDescriptor
- public EMFCompositeSourcePropertyDescriptor(java.lang.Object object, org.eclipse.emf.edit.provider.IItemPropertyDescriptor itemPropertyDescriptor, java.lang.String category)
EMFCompositeSourcePropertyDescriptor
.
object
- itemPropertyDescriptor
- category
- Method Detail |
---|
public static ILabelProvider createLabelProvider(org.eclipse.emf.edit.provider.IItemPropertyDescriptor itemPropertyDescriptor)
itemPropertyDescriptor
-
public void setCategory(java.lang.String category)
setCategory
in interface ICompositeSourcePropertyDescriptor
category
- The category to set.public java.lang.String getCategory()
getCategory
in interface IPropertyDescriptor
getCategory
in class org.eclipse.emf.edit.ui.provider.PropertyDescriptor
public java.lang.String[] getFilterFlags()
getFilterFlags
in interface IPropertyDescriptor
getFilterFlags
in class org.eclipse.emf.edit.ui.provider.PropertyDescriptor
public void addFilterFlag(java.lang.String flag)
flag
- public CellEditor createPropertyEditor(Composite composite)
createPropertyEditor
in interface IPropertyDescriptor
createPropertyEditor
in class org.eclipse.emf.edit.ui.provider.PropertyDescriptor
protected CellEditor doCreateEditor(Composite composite)
public boolean isReadOnly()
isReadOnly
in interface ICompositeSourcePropertyDescriptor
public void setReadOnly(boolean value)
setReadOnly
in interface ICompositeSourcePropertyDescriptor
value
- The readOnly to set.public boolean isCompatibleWith(IPropertyDescriptor anotherProperty)
isCompatibleWith
in interface IPropertyDescriptor
isCompatibleWith
in class org.eclipse.emf.edit.ui.provider.PropertyDescriptor
IPropertyDescriptor.isCompatibleWith(IPropertyDescriptor)
protected java.lang.Object getObject()
Object
for which this class is a property sourcepublic org.eclipse.emf.edit.provider.IItemPropertyDescriptor getItemDescriptor()
public java.lang.Object getFeature()
protected CellEditor getPropertyEditor()
public void setPropertyEditor(CellEditor propertyEditor)
propertyEditor
- The propertyEditor to set.public ICellEditorValidator getValidator()
public void setValidator(ICellEditorValidator validator)
validator
- The validator to set.protected CellEditor createComboBoxCellEditor(Composite composite)
protected CellEditor createDialogCellEditor(Composite composite, org.eclipse.emf.ecore.EStructuralFeature feature, java.util.List choiceOfValues)
composite
- the composite to contain the new cell editorfeature
- the feature being editedchoiceOfValues
- the possible values for that feature
protected CellEditor createBooleanCellEditor(Composite composite)
protected CellEditor createDataTypeCellEditor(Composite composite)
public java.lang.Object getPropertyValue()
ICompositeSourcePropertyDescriptor
getPropertyValue
in interface ICompositeSourcePropertyDescriptor
protected java.lang.Object getEditableValue()
public void setPropertyValue(java.lang.Object value)
ICompositeSourcePropertyDescriptor
setPropertyValue
in interface ICompositeSourcePropertyDescriptor
value
- value of the propertypublic void resetPropertyValue()
ICompositeSourcePropertyDescriptor
resetPropertyValue
in interface ICompositeSourcePropertyDescriptor
protected org.eclipse.emf.edit.provider.IItemPropertySource getPropertySource(java.lang.Object value)
public java.lang.Object getId()
getId
in interface IPropertyDescriptor
getId
in class org.eclipse.emf.edit.ui.provider.PropertyDescriptor
public java.util.List getChoiceOfValues()
public void resetPropertyValue(java.lang.Object value)
value
- the new property value
|
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.