|
JavaTM 2 Platform Standard Edition |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--javax.swing.undo.AbstractUndoableEdit | +--javax.swing.undo.StateEdit
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
, Serialized FormField Summary | |
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 String |
RCSID
|
protected String |
undoRedoName
The undo/redo presentation name |
Fields inherited from class javax.swing.undo.AbstractUndoableEdit |
RedoName,
UndoName |
Constructor Summary | |
StateEdit(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 | |
void |
end()
Gets the post-edit state of the StateEditable object and ends the edit. |
String |
getPresentationName()
Gets the presentation name for this edit |
protected void |
init(StateEditable anObject,
String name)
|
void |
redo()
Tells the edited object to apply the state after the edit |
protected void |
removeRedundantState()
Remove redundant key/values in state hashtables. |
void |
undo()
Tells the edited object to apply the state prior to the edit |
Methods inherited from class javax.swing.undo.AbstractUndoableEdit |
addEdit,
canRedo,
canUndo,
die,
getRedoPresentationName,
getUndoPresentationName,
isSignificant,
replaceEdit,
toString |
Methods inherited from class java.lang.Object |
clone,
equals,
finalize,
getClass,
hashCode,
notify,
notifyAll,
wait,
wait,
wait |
Field Detail |
protected static final String RCSID
protected StateEditable object
protected Hashtable preState
protected Hashtable postState
protected String undoRedoName
Constructor Detail |
public StateEdit(StateEditable anObject)
anObject
- The object to watch for changing stateStateEdit
public StateEdit(StateEditable anObject, String name)
anObject
- The object to watch for changing statename
- The presentation name to be used for this editStateEdit
Method Detail |
protected void init(StateEditable anObject, String name)
public void end()
public void undo()
AbstractUndoableEdit.canUndo()
public void redo()
AbstractUndoableEdit.canRedo()
public String getPresentationName()
protected void removeRedundantState()
|
JavaTM 2 Platform Standard Edition |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |