org.autoplot.state

Class UndoRedoSupport

java.lang.Object

org.autoplot.state.UndoRedoSupport

public class UndoRedoSupport
extends java.lang.Object

UndoRedoSupport keeps track of a series of application states, providing "undo" and "redo" operations.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	UndoRedoSupport.StateStackElement A model containing a state, including a description of what changed and a thumbnail.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	PROP_DEPTH property name of the current depth
static java.lang.String	PROP_REDOLABEL
static java.lang.String	PROP_SAVE_STATE_DEPTH the number of states to keep in the states folder.
static java.lang.String	PROP_SIZE_LIMIT name of the property containing the number of states kept

Constructor Summary

Constructors

Constructor and Description
UndoRedoSupport(ApplicationModel applicationModel) Creates a new instance of UndoRedoSupport

Method Summary

Modifier and Type	Method and Description
void	addPropertyChangeListener(java.beans.PropertyChangeListener listener)
void	addPropertyChangeListener(java.lang.String propertyName, java.beans.PropertyChangeListener listener)
int	getDepth() get the current depth, where depth can be lower than the number of states held, when redos can be done.
java.lang.String	getLongUndoDescription(int i) used for feedback.
javax.swing.Action	getRedoAction() get the action to trigger redo.
java.lang.String	getRedoDescription() get the longer description for the action, intended to be used for the tooltip.
java.lang.String	getRedoLabel() returns a label describing the redo operation, or null if the operation doesn't exist.
int	getSaveStateDepth() get the current number of persistent states stored in autoplot_data/state
int	getSizeLimit() get the number of states which will be kept
javax.swing.Action	getUndoAction() get the action to trigger undo.
java.lang.String	getUndoDescription() get the longer description for the action, intended to be used for the tooltip.
java.lang.String	getUndoLabel() returns a label describing the undo operation, or null if the operation doesn't exist.
boolean	isIgnoringUpdates() Getter for property ignoringUpdates.
UndoRedoSupport.StateStackElement	peekAt(int pos) allow scripts to peek into undo/redo stack for debugging.
void	pushState(java.beans.PropertyChangeEvent ev) request that a state be pushed onto the state stack.
void	pushState(java.beans.PropertyChangeEvent ev, java.lang.String label) push the current state of the application onto the stack.
void	redo() redo the state change that was undone, popping up the state stack one position.
void	refreshUndoMultipleMenu(javax.swing.JMenu undoMultipleMenu) create all the menu items for a JMenu offering undo targets.
void	removePropertyChangeListener(java.beans.PropertyChangeListener listener)
void	removePropertyChangeListener(java.lang.String propertyName, java.beans.PropertyChangeListener listener)
void	resetHistory() reset the history, for example after a vap file is loaded.
void	setIgnoringUpdates(boolean ignoringUpdates) Setter for property ignoringUpdates.
void	setSaveStateDepth(int depth) set the number of persistent states to keep, or 0 will disable the feature.
void	setSizeLimit(int size) set the number of states which will be kept
void	undo() undo the last state change.
void	undo(int level) reset the application to an old state from the state stack.

Methods inherited from class java.lang.Object

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

Field Detail

PROP_REDOLABEL

public static final java.lang.String PROP_REDOLABEL

See Also:

Constant Field Values

PROP_SIZE_LIMIT

public static final java.lang.String PROP_SIZE_LIMIT

name of the property containing the number of states kept

See Also:

Constant Field Values

PROP_DEPTH

public static final java.lang.String PROP_DEPTH

property name of the current depth

See Also:

Constant Field Values

PROP_SAVE_STATE_DEPTH

public static final java.lang.String PROP_SAVE_STATE_DEPTH

the number of states to keep in the states folder. Presently this is only implemented so that 0 disables the feature.

See Also:

Constant Field Values

Constructor Detail

UndoRedoSupport

public UndoRedoSupport(ApplicationModel applicationModel)

Creates a new instance of UndoRedoSupport

Parameters:

applicationModel - the model which contains basic information about any Autoplot application.

Method Detail

refreshUndoMultipleMenu

public void refreshUndoMultipleMenu(javax.swing.JMenu undoMultipleMenu)

create all the menu items for a JMenu offering undo targets.

Parameters:

undoMultipleMenu - the menu

removePropertyChangeListener

public void removePropertyChangeListener(java.lang.String propertyName,
                                         java.beans.PropertyChangeListener listener)

removePropertyChangeListener

public void removePropertyChangeListener(java.beans.PropertyChangeListener listener)

addPropertyChangeListener

public void addPropertyChangeListener(java.lang.String propertyName,
                                      java.beans.PropertyChangeListener listener)

addPropertyChangeListener

public void addPropertyChangeListener(java.beans.PropertyChangeListener listener)

getUndoAction

public javax.swing.Action getUndoAction()

get the action to trigger undo.

Returns:

action that can be attached to button.

undo

public void undo()

undo the last state change.

undo

public void undo(int level)

reset the application to an old state from the state stack.

Parameters:

level - the number of states to undo (1 is jump to the last state).

getRedoAction

public javax.swing.Action getRedoAction()

get the action to trigger redo.

Returns:

action that can be attached to button.

redo

public void redo()

redo the state change that was undone, popping up the state stack one position.

pushState

public void pushState(java.beans.PropertyChangeEvent ev)

request that a state be pushed onto the state stack.

Parameters:

ev -

getSizeLimit

public int getSizeLimit()

get the number of states which will be kept

Returns:

size

setSizeLimit

public void setSizeLimit(int size)

set the number of states which will be kept

Parameters:

size -

pushState

public void pushState(java.beans.PropertyChangeEvent ev,
                      java.lang.String label)

push the current state of the application onto the stack.

Parameters:

ev -

label -

getUndoDescription

public java.lang.String getUndoDescription()

get the longer description for the action, intended to be used for the tooltip.

Returns:

a human-readable description

getUndoLabel

public java.lang.String getUndoLabel()

returns a label describing the undo operation, or null if the operation doesn't exist.

Returns:

the label

getRedoDescription

public java.lang.String getRedoDescription()

get the longer description for the action, intended to be used for the tooltip.

Returns:

getRedoLabel

public java.lang.String getRedoLabel()

returns a label describing the redo operation, or null if the operation doesn't exist.

Returns:

the label

resetHistory

public void resetHistory()

reset the history, for example after a vap file is loaded.

isIgnoringUpdates

public boolean isIgnoringUpdates()

Getter for property ignoringUpdates.

Returns:

Value of property ignoringUpdates.

setIgnoringUpdates

public void setIgnoringUpdates(boolean ignoringUpdates)

Setter for property ignoringUpdates.

Parameters:

ignoringUpdates - New value of property ignoringUpdates.

getDepth

public int getDepth()

get the current depth, where depth can be lower than the number of states held, when redos can be done.

Returns:

the current depth.

getSaveStateDepth

public int getSaveStateDepth()

get the current number of persistent states stored in autoplot_data/state

Returns:

setSaveStateDepth

public void setSaveStateDepth(int depth)

set the number of persistent states to keep, or 0 will disable the feature.

Parameters:

depth - zero or the number of states to keep.

peekAt

public UndoRedoSupport.StateStackElement peekAt(int pos)

allow scripts to peek into undo/redo stack for debugging.

Parameters:

pos -

Returns:

getLongUndoDescription

public java.lang.String getLongUndoDescription(int i)

used for feedback.

Parameters:

i -

Returns: