|
Runtime | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectorg.eclipse.gmf.runtime.emf.ui.properties.sections.PropertySheetEntry
public class PropertySheetEntry
PropertySheetEntry that will be used in the PropertySheet view
| Field Summary | |
|---|---|
protected IPropertyDescriptor |
descriptor
IPropertyDescriptor for thie PropertySheetEntry |
protected CellEditor |
editor
CellEditor associated with this PropertySheetEntry |
protected java.lang.Object |
editValue
The value of this entry is defined as the the first object in its value array or, if that object is an IPropertySource, the value
it returns when sent getEditableValue |
protected PropertySheetEntry |
parent
Parent of this PropertySheetEntry |
protected java.lang.Object[] |
values
The values we are displaying/editing. |
| Fields inherited from interface org.eclipse.ui.views.properties.IPropertySheetEntry |
|---|
FILTER_ID_EXPERT |
| Constructor Summary | |
|---|---|
PropertySheetEntry()
|
|
| Method Summary | |
|---|---|
void |
addPropertySheetEntryListener(IPropertySheetEntryListener listener)
|
void |
applyEditorValue()
|
void |
cancelEditor()
|
protected java.util.List |
computeMergedPropertyDescriptors()
Return the sorted intersection of all the IPropertyDescriptors for the objects. |
protected java.util.Map |
computePropertyDescriptorsFor(IPropertySource source)
Returns an map of property descritptors (keyed on id) for the given property source. |
protected void |
createChildEntries()
Create our child entries. |
protected PropertySheetEntry[] |
createChildEntries(int size)
Creates a list of child PropertySheetEntry entries. |
protected PropertySheetEntry |
createChildEntry()
Create child entry for this PropertySheerEntry |
void |
dispose()
|
void |
editorValueChanged(boolean oldValidState,
boolean newValidState)
|
java.lang.String |
getCategory()
|
IPropertySheetEntry[] |
getChildEntries()
|
java.lang.String |
getDescription()
|
protected IPropertyDescriptor |
getDescriptor()
Returns the descriptor for this entry. |
java.lang.String |
getDisplayName()
|
CellEditor |
getEditor(Composite parentComposite)
|
protected java.lang.Object |
getEditValue(int index)
Returns the edit value for the object at the given index. |
java.lang.String |
getErrorText()
|
java.lang.String[] |
getFilters()
|
java.lang.Object |
getHelpContextIds()
|
Image |
getImage()
|
protected IPropertySource |
getPropertySource(java.lang.Object object)
Returns an property source for the given object. |
java.lang.String |
getValueAsString()
|
protected java.lang.Object[] |
getValues()
Returns the value objects of this entry. |
boolean |
hasChildEntries()
|
protected void |
refreshValues()
Update our value objects. |
void |
removePropertySheetEntryListener(IPropertySheetEntryListener listener)
|
void |
resetPropertyValue()
|
protected void |
setErrorText(java.lang.String newErrorText)
Set the error text. |
void |
setPropertySourceProvider(IPropertySourceProvider provider)
Sets a property source provider for this entry. |
protected void |
setValue(java.lang.Object newValue)
Set the value for this entry. |
void |
setValues(java.lang.Object[] objects)
The PropertySheetEntry implmentation of this method
declared on IPropertySheetEntry will obtain an editable
value for the given objects and update the child entries. |
protected void |
valueChanged(PropertySheetEntry child)
The value of the given child entry has changed. |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Field Detail |
|---|
protected java.lang.Object[] values
protected java.lang.Object editValue
IPropertySource, the value
it returns when sent getEditableValue
protected PropertySheetEntry parent
PropertySheetEntry
protected IPropertyDescriptor descriptor
IPropertyDescriptor for thie PropertySheetEntry
protected CellEditor editor
CellEditor associated with this PropertySheetEntry
| Constructor Detail |
|---|
public PropertySheetEntry()
| Method Detail |
|---|
public void editorValueChanged(boolean oldValidState,
boolean newValidState)
editorValueChanged in interface ICellEditorListenerpublic void cancelEditor()
cancelEditor in interface ICellEditorListenerpublic void addPropertySheetEntryListener(IPropertySheetEntryListener listener)
addPropertySheetEntryListener in interface IPropertySheetEntrypublic void applyEditorValue()
applyEditorValue in interface ICellEditorListenerapplyEditorValue in interface IPropertySheetEntryprotected java.util.List computeMergedPropertyDescriptors()
IPropertyDescriptors for the objects.
List of all the IPropertyDescriptors for the objectsprotected java.util.Map computePropertyDescriptorsFor(IPropertySource source)
source - a property source for which to obtain descriptors
protected void createChildEntries()
protected PropertySheetEntry[] createChildEntries(int size)
PropertySheetEntry entries.
size - list size
PropertySheerEntryprotected PropertySheetEntry createChildEntry()
PropertySheerEntry
PropertySheetEntrypublic void dispose()
dispose in interface IPropertySheetEntrypublic java.lang.String getCategory()
getCategory in interface IPropertySheetEntrypublic IPropertySheetEntry[] getChildEntries()
getChildEntries in interface IPropertySheetEntrypublic java.lang.String getDescription()
getDescription in interface IPropertySheetEntryprotected IPropertyDescriptor getDescriptor()
IPropertyDescriptor for this entrypublic java.lang.String getDisplayName()
getDisplayName in interface IPropertySheetEntrypublic CellEditor getEditor(Composite parentComposite)
getEditor in interface IPropertySheetEntryprotected java.lang.Object getEditValue(int index)
index - the value object index
public java.lang.String getErrorText()
getErrorText in interface IPropertySheetEntrypublic java.lang.String[] getFilters()
getFilters in interface IPropertySheetEntrypublic java.lang.Object getHelpContextIds()
getHelpContextIds in interface IPropertySheetEntrypublic Image getImage()
getImage in interface IPropertySheetEntryprotected IPropertySource getPropertySource(java.lang.Object object)
object - an object for which to obtain a property source or
null if a property source is not available
public java.lang.String getValueAsString()
getValueAsString in interface IPropertySheetEntryprotected java.lang.Object[] getValues()
public boolean hasChildEntries()
hasChildEntries in interface IPropertySheetEntryprotected void refreshValues()
public void removePropertySheetEntryListener(IPropertySheetEntryListener listener)
removePropertySheetEntryListener in interface IPropertySheetEntrypublic void resetPropertyValue()
resetPropertyValue in interface IPropertySheetEntryprotected void setErrorText(java.lang.String newErrorText)
newErrorText - the error texpublic void setPropertySourceProvider(IPropertySourceProvider provider)
IPropertySource for each of this entries
objects. If no provider is set then a default provider is used.
provider - the IPropertySourceProviderprotected void setValue(java.lang.Object newValue)
We set the given value as the value for all our value objects. We then call our parent to update the property we represent with the given value. We then trigger a model refresh.
newValue - the new valuepublic void setValues(java.lang.Object[] objects)
PropertySheetEntry implmentation of this method
declared on IPropertySheetEntry will obtain an editable
value for the given objects and update the child entries.
Updating the child entries will typically call this method on the child entries and thus the entire entry tree is updated
setValues in interface IPropertySheetEntryobjects - the new values for this entryprotected void valueChanged(PropertySheetEntry child)
We must inform our parent so that it can update its value objects
Subclasses may override to set the property value in some custom way.
child - entry that changed its 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.