Serializable
, UndoableEdit
public class StateEdit extends AbstractUndoableEdit
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!
Modifier and Type | Field | 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 |
RedoName, UndoName
Constructor | Description |
---|---|
StateEdit |
Create and return a new StateEdit. |
StateEdit |
Create and return a new StateEdit with a presentation name. |
Modifier and Type | Method | Description |
---|---|---|
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 |
Initialize the state edit. |
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 |
addEdit, canRedo, canUndo, die, getRedoPresentationName, getUndoPresentationName, isSignificant, replaceEdit, toString
protected static final String RCSID
protected StateEditable object
protected Hashtable<Object,Object> preState
protected Hashtable<Object,Object> postState
protected String undoRedoName
public StateEdit(StateEditable anObject)
anObject
- The object to watch for changing statepublic StateEdit(StateEditable anObject, String name)
anObject
- The object to watch for changing statename
- The presentation name to be used for this editprotected void init(StateEditable anObject, String name)
anObject
- The object to watch for changing statename
- The presentation name to be used for this editpublic void end()
public void undo()
undo
in interface UndoableEdit
undo
in class AbstractUndoableEdit
public void redo()
redo
in interface UndoableEdit
redo
in class AbstractUndoableEdit
public String getPresentationName()
getPresentationName
in interface UndoableEdit
getPresentationName
in class AbstractUndoableEdit
protected void removeRedundantState()
© 1993, 2023, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/en/java/javase/21/docs/api/java.desktop/javax/swing/undo/StateEdit.html