This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.


javax.swing.undo
class StateEdit

java.lang.Object extended by javax.swing.undo.AbstractUndoableEdit extended by 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!


Field Summary
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 String RCSID
          
protected String undoRedoName
          The undo/redo presentation name
 
Fields inherited from class javax.swing.undo.AbstractUndoableEdit
RedoName, UndoName
 
Constructor Summary

          Create and return a new StateEdit.
StateEdit(StateEditable anObject, String name)

          Create and return a new StateEdit with a presentation name.
 
Method Summary
 void
end()

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

          Gets the presentation name for this edit
protected void
init(StateEditable anObject, String name)

          
 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 inherited from class javax.swing.undo.AbstractUndoableEdit
addEdit, canRedo, canUndo, die, getPresentationName, getRedoPresentationName, getUndoPresentationName, isSignificant, redo, replaceEdit, toString, undo
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

object

protected StateEditable object
The object being edited

postState

protected Hashtable postState
The state information after the edit

preState

protected Hashtable preState
The state information prior to the edit

RCSID

protected static final String RCSID

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

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 state
name - The presentation name to be used for this edit
Method Detail

end

public void end()
Gets the post-edit state of the StateEditable object and ends the edit.


getPresentationName

public String getPresentationName()
Gets the presentation name for this edit

Overrides:
getPresentationName in class AbstractUndoableEdit

init

protected void init(StateEditable anObject,
                    String name)
Parameters:
anObject
name

redo

public void redo()
Tells the edited object to apply the state after the edit

Overrides:
redo in class AbstractUndoableEdit

removeRedundantState

protected void removeRedundantState()
Remove redundant key/values in state hashtables.


undo

public void undo()
Tells the edited object to apply the state prior to the edit

Overrides:
undo in class AbstractUndoableEdit


This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.
This page displays the Jadeite version of the documention, which is derived from the offical documentation that contains this copyright notice:
Copyright 2008 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.
The official Sun™ documentation can be found here at http://java.sun.com/javase/6/docs/api/.