Liking cljdoc? Tell your friends :D

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!

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!
raw docstring

->state-editclj

(->state-edit an-object)
(->state-edit an-object name)

Constructor.

Create and return a new StateEdit with a presentation name.

an-object - The object to watch for changing state - javax.swing.undo.StateEditable name - The presentation name to be used for this edit - java.lang.String

Constructor.

Create and return a new StateEdit with a presentation name.

an-object - The object to watch for changing state - `javax.swing.undo.StateEditable`
name - The presentation name to be used for this edit - `java.lang.String`
raw docstring

endclj

(end this)

Gets the post-edit state of the StateEditable object and ends the edit.

Gets the post-edit state of the StateEditable object and
ends the edit.
raw docstring

get-presentation-nameclj

(get-presentation-name this)

Gets the presentation name for this edit

returns: the empty string "" - java.lang.String

Gets the presentation name for this edit

returns: the empty string "" - `java.lang.String`
raw docstring

redoclj

(redo this)

Tells the edited object to apply the state after the edit

Tells the edited object to apply the state after the edit
raw docstring

undoclj

(undo this)

Tells the edited object to apply the state prior to the edit

Tells the edited object to apply the state prior to the edit
raw docstring

cljdoc is a website building & hosting documentation for Clojure/Script libraries

× close