java.lang.Object
javax.swing.undo.AbstractUndoableEdit
javax.swing.undo.StateEdit
- All Implemented Interfaces:
Serializable,UndoableEdit
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!
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected StateEditableThe object being editedThe state information after the editThe state information prior to the editprotected static final StringObsolete RCS version identity.protected StringThe undo/redo presentation nameFields declared in class javax.swing.undo.AbstractUndoableEdit
RedoName, UndoName -
Constructor Summary
ConstructorsConstructorDescriptionStateEdit(StateEditable anObject) Create and return a new StateEdit.StateEdit(StateEditable anObject, String name) Create and return a new StateEdit with a presentation name. -
Method Summary
Modifier and TypeMethodDescriptionvoidend()Gets the post-edit state of the StateEditable object and ends the edit.Gets the presentation name for this editprotected voidinit(StateEditable anObject, String name) Initialize the state edit.voidredo()Tells the edited object to apply the state after the editprotected voidRemove redundant key/values in state hashtables.voidundo()Tells the edited object to apply the state prior to the editMethods declared in class javax.swing.undo.AbstractUndoableEdit
addEdit, canRedo, canUndo, die, getRedoPresentationName, getUndoPresentationName, isSignificant, replaceEdit, toString
-
Field Details
-
RCSID
Obsolete RCS version identity.- See Also:
-
object
The object being edited -
preState
The state information prior to the edit -
postState
The state information after the edit -
undoRedoName
The undo/redo presentation name
-
-
Constructor Details
-
StateEdit
Create and return a new StateEdit.- Parameters:
anObject- The object to watch for changing state- See Also:
-
StateEdit
Create and return a new StateEdit with a presentation name.- Parameters:
anObject- The object to watch for changing statename- The presentation name to be used for this edit- See Also:
-
-
Method Details
-
init
Initialize the state edit.- Parameters:
anObject- The object to watch for changing statename- The presentation name to be used for this edit
-
end
public void end()Gets the post-edit state of the StateEditable object and ends the edit. -
undo
public void undo()Tells the edited object to apply the state prior to the edit- Specified by:
undoin interfaceUndoableEdit- Overrides:
undoin classAbstractUndoableEdit- See Also:
-
redo
public void redo()Tells the edited object to apply the state after the edit- Specified by:
redoin interfaceUndoableEdit- Overrides:
redoin classAbstractUndoableEdit- See Also:
-
getPresentationName
Gets the presentation name for this edit- Specified by:
getPresentationNamein interfaceUndoableEdit- Overrides:
getPresentationNamein classAbstractUndoableEdit- Returns:
- the empty string ""
- See Also:
-
removeRedundantState
protected void removeRedundantState()Remove redundant key/values in state hashtables.
-