ilog.views.sdm.swing

Class IlvSDMUndoManager

java.lang.Object

javax.swing.undo.AbstractUndoableEdit

javax.swing.undo.CompoundEdit

javax.swing.undo.UndoManager

ilog.views.sdm.swing.IlvSDMUndoManager

All Implemented Interfaces:

Serializable, EventListener, UndoableEditListener, UndoableEdit

public class IlvSDMUndoManager
extends UndoManager

The class IlvSDMUndoManager provides undo/redo capabilities for an SDM engine.

The SDM undo manager adds a filtering data model on top of the existing data model of the SDM engine. This filtering model captures all the modifications made to the underlying model, and stores them as UndoableEdits in a Swing UndoManager.

To enable undo in an SDM engine, create an IlvSDMUndoManager associated with the engine.

You can also register UndoableEditListener objects to be notified when an edit has happened and update your GUI accordingly (for example, to gray out undo/redo buttons).

Since:

JViews 4.0

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	IlvSDMUndoManager.UndoSDMModel This class is the filtering SDM data model that records in the undo manager all the editing calls on the underlying data model.

Field Summary

Fields inherited from class javax.swing.undo.CompoundEdit

edits

Fields inherited from class javax.swing.undo.AbstractUndoableEdit

RedoName, UndoName

Constructor Summary

Constructors

Constructor and Description
IlvSDMUndoManager(IlvSDMEngine engine) Creates a new undo manager for the specified SDM engine.

Method Summary

Modifier and Type	Method and Description
void	addUndoableEditListener(UndoableEditListener listener) Registers an UndoableEditListener that will be called when a new edit is added to this undo manager.
boolean	isEnabled() Returns true if this undo manager is enabled, that is, if it is currently recording changes in the SDM model.
void	redo() Redoes the last undone edit.
void	removeUndoableEditListener(UndoableEditListener listener) Removes an UndoableEditListener.
void	setEnabled(boolean enabled) Enables or disables this undo manager.
void	undo() Undoes the last edit.

Methods inherited from class javax.swing.undo.UndoManager

addEdit, canRedo, canUndo, canUndoOrRedo, discardAllEdits, editToBeRedone, editToBeUndone, end, getLimit, getRedoPresentationName, getUndoOrRedoPresentationName, getUndoPresentationName, redoTo, setLimit, toString, trimEdits, trimForLimit, undoableEditHappened, undoOrRedo, undoTo

Methods inherited from class javax.swing.undo.CompoundEdit

die, getPresentationName, isInProgress, isSignificant, lastEdit

Methods inherited from class javax.swing.undo.AbstractUndoableEdit

replaceEdit

Methods inherited from class java.lang.Object

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

Constructor Detail

IlvSDMUndoManager

public IlvSDMUndoManager(IlvSDMEngine engine)

Creates a new undo manager for the specified SDM engine.

Parameters:

engine - The SDM engine.

Method Detail

isEnabled

public boolean isEnabled()

Returns true if this undo manager is enabled, that is, if it is currently recording changes in the SDM model.

Since:

JViews 6.0

See Also:

setEnabled(boolean)

setEnabled

public void setEnabled(boolean enabled)

Enables or disables this undo manager. The undo manager can be temporarily disabled to prevent it from recording changes in the SDM model.

The undo manager is enabled by default.

Parameters:

enabled - If true, the undo manager records all changes in the SDM model. Otherwise the changes are not recorded until the undo manager is enabled again.

Since:

JViews 6.0

undo

public void undo()

Undoes the last edit.

Specified by:

undo in interface UndoableEdit

Overrides:

undo in class UndoManager

redo

public void redo()

Redoes the last undone edit.

Specified by:

redo in interface UndoableEdit

Overrides:

redo in class UndoManager

addUndoableEditListener

public void addUndoableEditListener(UndoableEditListener listener)

Registers an UndoableEditListener that will be called when a new edit is added to this undo manager.

Parameters:

listener - The listener to add.

removeUndoableEditListener

public void removeUndoableEditListener(UndoableEditListener listener)

Removes an UndoableEditListener.

Parameters:

listener - The listener to remove.