- 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 StateEditableobjectThe object being editedprotected Hashtable<Object,Object>postStateThe state information after the editprotected Hashtable<Object,Object>preStateThe state information prior to the editprotected static StringRCSIDprotected StringundoRedoNameThe 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 voidend()Gets the post-edit state of the StateEditable object and ends the edit.StringgetPresentationName()Gets the presentation name for this editprotected voidinit(StateEditable anObject, String name)voidredo()Tells the edited object to apply the state after the editprotected voidremoveRedundantState()Remove redundant key/values in state hashtables.voidundo()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:
undoin interfaceUndoableEdit- Overrides:
undoin classAbstractUndoableEdit- See Also:
AbstractUndoableEdit.canUndo()
-
redo
public void redo()
Tells the edited object to apply the state after the edit- Specified by:
redoin interfaceUndoableEdit- Overrides:
redoin classAbstractUndoableEdit- See Also:
AbstractUndoableEdit.canRedo()
-
getPresentationName
public String getPresentationName()
Gets the presentation name for this edit- Specified by:
getPresentationNamein interfaceUndoableEdit- Overrides:
getPresentationNamein classAbstractUndoableEdit- Returns:
- the empty string ""
- See Also:
AbstractUndoableEdit.getUndoPresentationName(),AbstractUndoableEdit.getRedoPresentationName()
-
removeRedundantState
protected void removeRedundantState()
Remove redundant key/values in state hashtables.
-
-
Traduction non disponible
Les API Java ne sont pas encore traduites en français sur l'infobrol. Seule la version anglaise est disponible pour l'instant.
Document créé le 31/08/2006, dernière modification le 04/03/2020
Source du document imprimé : https://www.gaudry.be/java-api-rf-javax/swing/undo/StateEdit.html
L'infobrol est un site personnel dont le contenu n'engage que moi. Le texte est mis à disposition sous licence CreativeCommons(BY-NC-SA). Plus d'info sur les conditions d'utilisation et sur l'auteur.
Références
Ces références et liens indiquent des documents consultés lors de la rédaction de cette page, ou qui peuvent apporter un complément d'information, mais les auteurs de ces sources ne peuvent être tenus responsables du contenu de cette page.
L'auteur de ce site est seul responsable de la manière dont sont présentés ici les différents concepts, et des libertés qui sont prises avec les ouvrages de référence. N'oubliez pas que vous devez croiser les informations de sources multiples afin de diminuer les risques d'erreurs.
