- java.lang.Object
-
- javax.swing.undo.AbstractUndoableEdit
-
- javax.swing.undo.StateEdit
-
- All Implemented Interfaces:
- 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!
- See Also:
StateEditable
-
-
Field Summary
Fields Modifier and Type Field and Description protected StateEditable
object
The object being editedprotected Hashtable<Object,Object>
postState
The state information after the editprotected Hashtable<Object,Object>
preState
The state information prior to the editprotected static String
RCSID
protected String
undoRedoName
The undo/redo presentation name
-
Constructor Summary
Constructors Constructor and Description 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
Methods Modifier and Type Method and Description void
end()
Gets the post-edit state of the StateEditable object and ends the edit.String
getPresentationName()
Gets the presentation name for this editprotected void
init(StateEditable anObject, String name)
void
redo()
Tells the edited object to apply the state after the editprotected 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
-
-
-
-
Field Detail
-
RCSID
protected static final String RCSID
- See Also:
- Constant Field Values
-
object
protected StateEditable object
The object being edited
-
undoRedoName
protected String undoRedoName
The undo/redo presentation name
-
-
Constructor Detail
-
StateEdit
public StateEdit(StateEditable anObject)
Create and return a new StateEdit.- Parameters:
anObject
- The object to watch for changing state- See Also:
StateEdit
-
StateEdit
public StateEdit(StateEditable anObject, String name)
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:
StateEdit
-
-
Method Detail
-
init
protected void init(StateEditable anObject, String name)
-
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:
undo
in interfaceUndoableEdit
- Overrides:
undo
in classAbstractUndoableEdit
- See Also:
AbstractUndoableEdit.canUndo()
-
redo
public void redo()
Tells the edited object to apply the state after the edit- Specified by:
redo
in interfaceUndoableEdit
- Overrides:
redo
in classAbstractUndoableEdit
- See Also:
AbstractUndoableEdit.canRedo()
-
getPresentationName
public String getPresentationName()
Gets the presentation name for this edit- Specified by:
getPresentationName
in interfaceUndoableEdit
- Overrides:
getPresentationName
in classAbstractUndoableEdit
- Returns:
- the empty string ""
- See Also:
AbstractUndoableEdit.getUndoPresentationName()
,AbstractUndoableEdit.getRedoPresentationName()
-
removeRedundantState
protected void removeRedundantState()
Remove redundant key/values in state hashtables.
-
-
Document created the 11/06/2005, last modified the 04/03/2020
Source of the printed document:https://www.gaudry.be/en/java-api-rf-javax/swing/undo/stateedit.html
The infobrol is a personal site whose content is my sole responsibility. The text is available under CreativeCommons license (BY-NC-SA). More info on the terms of use and the author.
References
These references and links indicate documents consulted during the writing of this page, or which may provide additional information, but the authors of these sources can not be held responsible for the content of this page.
The author This site is solely responsible for the way in which the various concepts, and the freedoms that are taken with the reference works, are presented here. Remember that you must cross multiple source information to reduce the risk of errors.