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 SummaryFieldsModifier 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.AbstractUndoableEditRedoName, UndoName
- 
Constructor SummaryConstructorsConstructorDescriptionStateEdit(StateEditable anObject) Create and return a new StateEdit.StateEdit(StateEditable anObject, String name) Create and return a new StateEdit with a presentation name.
- 
Method SummaryModifier 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.AbstractUndoableEditaddEdit, canRedo, canUndo, die, getRedoPresentationName, getUndoPresentationName, isSignificant, replaceEdit, toString
- 
Field Details- 
RCSIDObsolete RCS version identity.- See Also:
 
- 
objectThe object being edited
- 
preStateThe state information prior to the edit
- 
postStateThe state information after the edit
- 
undoRedoNameThe undo/redo presentation name
 
- 
- 
Constructor Details- 
StateEditCreate and return a new StateEdit.- Parameters:
- anObject- The object to watch for changing state
- See Also:
 
- 
StateEditCreate and return a new StateEdit with a presentation name.- Parameters:
- anObject- The object to watch for changing state
- name- The presentation name to be used for this edit
- See Also:
 
 
- 
- 
Method Details- 
initInitialize the state edit.- Parameters:
- anObject- The object to watch for changing state
- name- The presentation name to be used for this edit
 
- 
endpublic void end()Gets the post-edit state of the StateEditable object and ends the edit.
- 
undopublic void undo()Tells the edited object to apply the state prior to the edit- Specified by:
- undoin interface- UndoableEdit
- Overrides:
- undoin class- AbstractUndoableEdit
- See Also:
 
- 
redopublic void redo()Tells the edited object to apply the state after the edit- Specified by:
- redoin interface- UndoableEdit
- Overrides:
- redoin class- AbstractUndoableEdit
- See Also:
 
- 
getPresentationNameGets the presentation name for this edit- Specified by:
- getPresentationNamein interface- UndoableEdit
- Overrides:
- getPresentationNamein class- AbstractUndoableEdit
- Returns:
- the empty string ""
- See Also:
 
- 
removeRedundantStateprotected void removeRedundantState()Remove redundant key/values in state hashtables.
 
-