Class 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:
  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    protected StateEditable
    The object being edited
    The state information after the edit
    The state information prior to the edit
    protected static final String
    Obsolete RCS version identity.
    protected String
    The undo/redo presentation name

    Fields declared in class AbstractUndoableEdit

    RedoName, UndoName
    Modifier and Type
    Field
    Description
    protected static final String
    String returned by getRedoPresentationName; as of Java 2 platform v1.3.1 this field is no longer used.
    protected static final String
    String returned by getUndoPresentationName; as of Java 2 platform v1.3.1 this field is no longer used.
  • Constructor Summary

    Constructors
    Constructor
    Description
    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 Type
    Method
    Description
    void
    end()
    Gets the post-edit state of the StateEditable object and ends the edit.
    Gets the presentation name for this edit
    protected void
    init(StateEditable anObject, String name)
    Initialize the state edit.
    void
    Tells the edited object to apply the state after the edit
    protected void
    Remove redundant key/values in state hashtables.
    void
    Tells the edited object to apply the state prior to the edit

    Methods declared in class AbstractUndoableEdit

    addEdit, canRedo, canUndo, die, getRedoPresentationName, getUndoPresentationName, isSignificant, replaceEdit, toString
    Modifier and Type
    Method
    Description
    boolean
    This default implementation returns false.
    boolean
    Returns true if this edit is alive and hasBeenDone is false.
    boolean
    Returns true if this edit is alive and hasBeenDone is true.
    void
    die()
    Sets alive to false.
    Retrieves the value from the defaults table with key AbstractUndoableEdit.redoText and returns that value followed by a space, followed by getPresentationName.
    Retrieves the value from the defaults table with key AbstractUndoableEdit.undoText and returns that value followed by a space, followed by getPresentationName.
    boolean
    This default implementation returns true.
    boolean
    This default implementation returns false.
    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 Type
    Method
    Description
    protected Object
    Creates and returns a copy of this object.
    boolean
    Indicates whether some other object is "equal to" this one.
    protected void
    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<?>
    Returns the runtime class of this Object.
    int
    Returns a hash code value for this object.
    final void
    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
    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.