|
Runtime | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.eclipse.ui.views.properties.PropertyDescriptor
org.eclipse.gmf.runtime.common.ui.services.properties.descriptors.CompositeSourcePropertyDescriptor
public class CompositeSourcePropertyDescriptor
A concrete implementation of the
ICompositeSourcePropertyDescriptor
. A property descriptor
designed to work with the CompositePropertySource.
Constructor Summary | |
---|---|
CompositeSourcePropertyDescriptor(java.lang.Object object,
java.lang.Object id,
java.lang.String displayName)
Create an instance of the CompositeSourePropertyDescriptor |
Method Summary | |
---|---|
void |
addFilterFlag(java.lang.String flag)
Add filter flag IPropertySheetEntry.FILTER_ID_EXPERT |
CellEditor |
createPropertyEditor(Composite parent)
|
java.lang.Object |
getDefaultValue()
Returns default value |
protected java.lang.Object |
getEditableValue()
This is a utility method, which allows recursive display of the properties. |
protected java.lang.Object |
getObject()
Returns the object target of the property |
CellEditor |
getPropertyEditor()
Returns the propertyEditor. |
protected IPropertySource |
getPropertySource(java.lang.Object value)
Returns an property source for the given value. |
java.lang.Object |
getPropertyValue()
Returns the value of the property |
boolean |
isCompatibleWith(IPropertyDescriptor anotherProperty)
|
boolean |
isReadOnly()
Returns the readOnly property |
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)
|
void |
setDefaultValue(java.lang.Object defaultValue)
Assigns a default value to this property |
void |
setPropertyEditor(CellEditor propertyEditor)
Parametrize cell editor creation - assign a custom cell editor to an instance variable |
void |
setPropertyValue(java.lang.Object value)
Sets new value to the property |
void |
setReadOnly(boolean readOnly)
Set read-only to true if the property is read-only, or to false otherwise |
protected void |
setValue(java.lang.Object value)
Utility method - all the checks and context set up are done in the setPropertyValue. |
Methods inherited from class org.eclipse.ui.views.properties.PropertyDescriptor |
---|
getAlwaysIncompatible, getCategory, getDescription, getDisplayName, getFilterFlags, getHelpContextIds, getId, getLabelProvider, getValidator, isLabelProviderSet, setAlwaysIncompatible, setCategory, setDescription, setFilterFlags, setHelpContextIds, setLabelProvider, setValidator |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface org.eclipse.gmf.runtime.common.ui.services.properties.descriptors.ICompositeSourcePropertyDescriptor |
---|
setCategory |
Methods inherited from interface org.eclipse.ui.views.properties.IPropertyDescriptor |
---|
getCategory, getDescription, getDisplayName, getFilterFlags, getHelpContextIds, getId, getLabelProvider |
Constructor Detail |
---|
public CompositeSourcePropertyDescriptor(java.lang.Object object, java.lang.Object id, java.lang.String displayName)
CompositeSourePropertyDescriptor
object
- id
- property iddisplayName
- property display nameMethod Detail |
---|
protected java.lang.Object getObject()
public CellEditor getPropertyEditor()
public boolean isReadOnly()
isReadOnly
in interface ICompositeSourcePropertyDescriptor
public void addFilterFlag(java.lang.String flag)
IPropertySheetEntry.FILTER_ID_EXPERT
flag
- a filter flagpublic java.lang.Object getPropertyValue()
getPropertyValue
in interface ICompositeSourcePropertyDescriptor
public void resetPropertyValue()
ICompositeSourcePropertyDescriptor
resetPropertyValue
in interface ICompositeSourcePropertyDescriptor
public void setPropertyValue(java.lang.Object value)
setPropertyValue
in interface ICompositeSourcePropertyDescriptor
value
- the new valueprotected void setValue(java.lang.Object value)
value
- the new valuepublic CellEditor createPropertyEditor(Composite parent)
createPropertyEditor
in interface IPropertyDescriptor
createPropertyEditor
in class PropertyDescriptor
public boolean isCompatibleWith(IPropertyDescriptor anotherProperty)
isCompatibleWith
in interface IPropertyDescriptor
isCompatibleWith
in class PropertyDescriptor
public void setPropertyEditor(CellEditor propertyEditor)
propertyEditor
- a custom cell editorprotected java.lang.Object getEditableValue()
protected IPropertySource getPropertySource(java.lang.Object value)
value
- an object for which to obtain a property source or
null
if a property source is not available
public void setReadOnly(boolean readOnly)
ICompositeSourcePropertyDescriptor
setReadOnly
in interface ICompositeSourcePropertyDescriptor
readOnly
- -
true if the property is read-only, or to false otherwisepublic java.lang.Object getDefaultValue()
public void setDefaultValue(java.lang.Object defaultValue)
defaultValue
- assign a default value to this propertypublic void resetPropertyValue(java.lang.Object value)
value
- ICompositeSourcePropertyDescriptor.resetPropertyValue()
|
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.