Class StateEdit
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 StateEditable
The object being editedThe state information after the editThe state information prior to the editprotected static final String
Obsolete RCS version identity.protected String
The undo/redo presentation nameFields declared in class AbstractUndoableEdit
RedoName, UndoName
Modifier and TypeFieldDescriptionprotected static final String
String returned bygetRedoPresentationName
; as of Java 2 platform v1.3.1 this field is no longer used.protected static final String
String returned bygetUndoPresentationName
; as of Java 2 platform v1.3.1 this field is no longer used. -
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 TypeMethodDescriptionvoid
end()
Gets the post-edit state of the StateEditable object and ends the edit.Gets the presentation name for this editprotected void
init
(StateEditable anObject, String name) Initialize the state edit.void
redo()
Tells the edited object to apply the state after the editprotected void
Remove redundant key/values in state hashtables.void
undo()
Tells the edited object to apply the state prior to the editMethods declared in class AbstractUndoableEdit
addEdit, canRedo, canUndo, die, getRedoPresentationName, getUndoPresentationName, isSignificant, replaceEdit, toString
Modifier and TypeMethodDescriptionboolean
addEdit
(UndoableEdit anEdit) This default implementation returns false.boolean
canRedo()
Returnstrue
if this edit isalive
andhasBeenDone
isfalse
.boolean
canUndo()
Returns true if this edit isalive
andhasBeenDone
istrue
.void
die()
Setsalive
to false.Retrieves the value from the defaults table with keyAbstractUndoableEdit.redoText
and returns that value followed by a space, followed bygetPresentationName
.Retrieves the value from the defaults table with keyAbstractUndoableEdit.undoText
and returns that value followed by a space, followed bygetPresentationName
.boolean
This default implementation returns true.boolean
replaceEdit
(UndoableEdit anEdit) This default implementation returns false.toString()
Returns a string that displays and identifies this object's properties.Methods declared in class Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Modifier and TypeMethodDescriptionprotected Object
clone()
Creates and returns a copy of this object.boolean
Indicates whether some other object is "equal to" this one.protected void
finalize()
Deprecated, for removal: This API element is subject to removal in a future version.Finalization is deprecated and subject to removal in a future release.final Class
<?> getClass()
Returns the runtime class of thisObject
.int
hashCode()
Returns a hash code value for this object.final void
notify()
Wakes up a single thread that is waiting on this object's monitor.final void
Wakes up all threads that are waiting on this object's monitor.final void
wait()
Causes the current thread to wait until it is awakened, typically by being notified or interrupted.final void
wait
(long timeoutMillis) Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.final void
wait
(long timeoutMillis, int nanos) Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
-
Field Details
-
RCSID
-
object
The object being edited -
preState
-
postState
-
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:
undo
in interfaceUndoableEdit
- Overrides:
undo
in classAbstractUndoableEdit
- See Also:
-
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:
-
getPresentationName
Gets the presentation name for this edit- Specified by:
getPresentationName
in interfaceUndoableEdit
- Overrides:
getPresentationName
in classAbstractUndoableEdit
- Returns:
- the empty string ""
- See Also:
-
removeRedundantState
protected void removeRedundantState()Remove redundant key/values in state hashtables.
-