StateEdit is a general edit for objects that change state. Objects being edited must conform to the StateEditable interface.
This edit class works by asking an object to store it's state in Hashtables before and after editing occurs. Upon undo or redo the object is told to restore it's state from these Hashtables.
A state edit is used as follows:
// Create the edit during the "before" state of the object
StateEdit newEdit = new StateEdit(myObject);
// Modify the object
myObject.someStateModifyingMethod();
// "end" the edit when you are done modifying the object
newEdit.end();
Note that when a StateEdit ends, it removes redundant state from the Hashtables - A state Hashtable is not guaranteed to contain all keys/values placed into it when the state is stored!
StateEditable
| Modifier and Type | Field and Description |
|---|---|
| protected StateEditable | object
The object being edited |
| protected Hashtable | postState
The state information after the edit |
| protected Hashtable | preState
The state information prior to the edit |
| protected static final String | RCSID
Obsolete RCS version identity. |
| protected String | undoRedoName
The undo/redo presentation name |
| Access | Constructor and Description |
|---|---|
| public | StateEdit(StateEditable
The object to watch for changing state anObject)Create and return a new StateEdit. |
| public | StateEdit(StateEditable
The object to watch for changing state anObject, String The presentation name to be used for this edit name)Create and return a new StateEdit with a presentation name. |
| Modifier and Type | Method and Description |
|---|---|
| public void | |
| public String | getPresentationName()
Overrides javax. Implements javax. Gets the presentation name for this edit |
| protected void | init(StateEditable
The object to watch for changing state anObject, String The presentation name to be used for this edit name)Initialize the state edit. |
| public void | redo()
Overrides javax. Implements javax. Tells the edited object to apply the state after the edit |
| protected void | |
| public void | undo()
Overrides javax. Implements javax. Tells the edited object to apply the state prior to the edit |
| object | back to summary |
|---|---|
| protected StateEditable object The object being edited | |
| postState | back to summary |
|---|---|
| protected Hashtable<Object, Object> postState The state information after the edit | |
| preState | back to summary |
|---|---|
| protected Hashtable<Object, Object> preState The state information prior to the edit | |
| RCSID | back to summary |
|---|---|
| protected static final String RCSID Obsolete RCS version identity. | |
| undoRedoName | back to summary |
|---|---|
| protected String undoRedoName The undo/redo presentation name | |
| StateEdit | back to summary |
|---|---|
| public StateEdit(StateEditable anObject) Create and return a new StateEdit.
| |
| StateEdit | back to summary |
|---|---|
| public StateEdit(StateEditable anObject, String name) Create and return a new StateEdit with a presentation name.
| |
| end | back to summary |
|---|---|
| public void end() Gets the post-edit state of the StateEditable object and ends the edit. | |
| getPresentationName | back to summary |
|---|---|
| public String getPresentationName() Overrides javax. Implements javax. Gets the presentation name for this edit | |
| init | back to summary |
|---|---|
| protected void init(StateEditable anObject, String name) Initialize the state edit.
| |
| redo | back to summary |
|---|---|
| public void redo() Overrides javax. Implements javax. Tells the edited object to apply the state after the edit | |
| removeRedundantState | back to summary |
|---|---|
| protected void removeRedundantState() Remove redundant key/values in state hashtables. | |
| undo | back to summary |
|---|---|
| public void undo() Overrides javax. Implements javax. Tells the edited object to apply the state prior to the edit | |