Eclipse GEF
3.8.1.201208200205

org.eclipse.gef.ui.properties
Class UndoablePropertySheetEntry

java.lang.Object
  extended by org.eclipse.core.commands.common.EventManager
      extended by org.eclipse.ui.views.properties.PropertySheetEntry
          extended by org.eclipse.gef.ui.properties.UndoablePropertySheetEntry
All Implemented Interfaces:
IPropertySheetEntry

public class UndoablePropertySheetEntry
extends PropertySheetEntry

UndoablePropertySheetEntry provides undo support for changes made to IPropertySources by the PropertySheetViewer. Clients can construct a PropertySheetPage and use this class as the root entry. All changes made to property sources displayed on that page will be done using the provided command stack.

NOTE: If you intend to use an IPropertySourceProvider for a PropertySheetPage whose root entry is an instance of of UndoablePropertySheetEntry, you should set the IPropertySourceProvider on that root entry, rather than the PropertySheetPage.


Field Summary
 
Fields inherited from interface org.eclipse.ui.views.properties.IPropertySheetEntry
FILTER_ID_EXPERT
 
Constructor Summary
UndoablePropertySheetEntry(CommandStack commandStack)
          Constructs the root entry using the given command stack.
 
Method Summary
protected  PropertySheetEntry createChildEntry()
           
 void dispose()
           
protected  CommandStack getCommandStack()
          Returns the CommandStack that is used by this entry.
 void resetPropertyValue()
           
protected  void valueChanged(PropertySheetEntry child)
           
 
Methods inherited from class org.eclipse.ui.views.properties.PropertySheetEntry
addPropertySheetEntryListener, applyEditorValue, getCategory, getChildEntries, getDescription, getDescriptor, getDisplayName, getEditor, getEditValue, getErrorText, getFilters, getHelpContextIds, getImage, getParent, getPropertySource, getValueAsString, getValues, hasChildEntries, refreshFromRoot, removePropertySheetEntryListener, setPropertySourceProvider, setValues
 
Methods inherited from class org.eclipse.core.commands.common.EventManager
addListenerObject, clearListeners, getListeners, isListenerAttached, removeListenerObject
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

UndoablePropertySheetEntry

public UndoablePropertySheetEntry(CommandStack commandStack)
Constructs the root entry using the given command stack.

Parameters:
commandStack - the command stack to use
Since:
3.1
Method Detail

createChildEntry

protected PropertySheetEntry createChildEntry()
Overrides:
createChildEntry in class PropertySheetEntry
See Also:
PropertySheetEntry.createChildEntry()

dispose

public void dispose()
Specified by:
dispose in interface IPropertySheetEntry
Overrides:
dispose in class PropertySheetEntry
See Also:
IPropertySheetEntry.dispose()

getCommandStack

protected CommandStack getCommandStack()
Returns the CommandStack that is used by this entry. It is obtained from the parent in case the entry is not a root entry.

Returns:
the CommandStack to be used.
Since:
3.7

resetPropertyValue

public void resetPropertyValue()
Specified by:
resetPropertyValue in interface IPropertySheetEntry
Overrides:
resetPropertyValue in class PropertySheetEntry
See Also:
IPropertySheetEntry.resetPropertyValue()

valueChanged

protected void valueChanged(PropertySheetEntry child)
Overrides:
valueChanged in class PropertySheetEntry
See Also:
PropertySheetEntry.valueChanged(PropertySheetEntry)

Eclipse GEF
3.8.1.201208200205

Copyright (c) IBM Corp. and others 2000, 2011. All Rights Reserved.