com.xmlmind.xmledit.edit

Class UndoManager.Action

java.lang.Object

com.xmlmind.util.PropertySet

com.xmlmind.xmledit.edit.UndoManager.Action

Enclosing class:

UndoManager

public abstract static class UndoManager.Action
extends PropertySet

An undo or redo action managed by an undo manager.

Field Summary

Fields

Modifier and Type	Field and Description
protected String	description

Fields inherited from class com.xmlmind.util.PropertySet

properties

Constructor Summary

Constructors

Constructor and Description
Action()

Method Summary

Modifier and Type	Method and Description
String	getDefaultDescription() Returns an automatically generated description for simple, atomic, actions such as removing an attribute from an element or typing text.
String	getDescription() Returns the description of this action.
abstract DocumentEvent[]	getDocumentEvents() Returns the DocumentEvents which compose this action.
void	setDescription(String description) Describes this action.

Methods inherited from class com.xmlmind.util.PropertySet

getProperties, getProperty, getPropertyCount, hasProperty, putProperties, putProperty, removeAllProperties, removeProperty

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

description

protected String description

Constructor Detail

Action

public Action()

Method Detail

setDescription

public void setDescription(String description)

Describes this action. This description is intended to be displayed by the GUI.

This method is typically invoked by the application just after the user has performed an action because at that time, the application knows how to describe this user action.

Descriptions are automatically moved from undo action to corresponding redo action after the undo action has been performed, so there is no need to invoke this method for a redo action.

Commands automatically adds a description to top undo action, so in principle, there is no need to use this method at all.

getDescription

public String getDescription()

Returns the description of this action. Returns null if such description has not been specified.

See Also:

getDefaultDescription()

getDefaultDescription

public String getDefaultDescription()

Returns an automatically generated description for simple, atomic, actions such as removing an attribute from an element or typing text. Returns null if such description cannot be guessed.

getDocumentEvents

public abstract DocumentEvent[] getDocumentEvents()

Returns the DocumentEvents which compose this action.