ca.odell.glazedlists

Class TransactionEventAssembler.UndoRedoSupport<E>

java.lang.Object

ca.odell.glazedlists.TransactionEventAssembler.UndoRedoSupport<E>

Enclosing class:

TransactionEventAssembler<E>

public static final class TransactionEventAssembler.UndoRedoSupport<E>
extends java.lang.Object

UndoRedoSupport, as the name suggests, will provide generic support for undoing and redoing groups of changes to an EventList. The granularity of each undoable edit is determined by the ListEvent from which it was generated.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	TransactionEventAssembler.UndoRedoSupport.Edit Provides an easy interface to undo/redo a ListEvent in its entirety.
static interface	TransactionEventAssembler.UndoRedoSupport.Listener Implementations of this Listener interface should be registered with an UndoRedoSupport object via UndoRedoSupport.addUndoSupportListener(ca.odell.glazedlists.UndoRedoSupport.Listener).

Method Summary

Modifier and Type	Method and Description
void	addUndoSupportListener(TransactionEventAssembler.UndoRedoSupport.Listener l) Add a TransactionEventAssembler.UndoRedoSupport.Listener which will receive a callback when an undoable edit occurs on the given source EventList.
static <E> TransactionEventAssembler.UndoRedoSupport<E>	install(TransactionEventAssembler<E> source) Installs support for undoing and redoing changes to the given source.
void	removeUndoSupportListener(TransactionEventAssembler.UndoRedoSupport.Listener l) Remove a TransactionEventAssembler.UndoRedoSupport.Listener from receiving a callback when an undoable edit occurs on the given source EventList.
void	uninstall() This method removes undo/redo support from the EventList it was installed on.

Methods inherited from class java.lang.Object

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

Method Detail

addUndoSupportListener

public void addUndoSupportListener(TransactionEventAssembler.UndoRedoSupport.Listener l)

Add a TransactionEventAssembler.UndoRedoSupport.Listener which will receive a callback when an undoable edit occurs on the given source EventList.

removeUndoSupportListener

public void removeUndoSupportListener(TransactionEventAssembler.UndoRedoSupport.Listener l)

Remove a TransactionEventAssembler.UndoRedoSupport.Listener from receiving a callback when an undoable edit occurs on the given source EventList.

install

public static <E> TransactionEventAssembler.UndoRedoSupport<E> install(TransactionEventAssembler<E> source)

Installs support for undoing and redoing changes to the given source. To be notified of undoable changes, a TransactionEventAssembler.UndoRedoSupport.Listener must be registered on the object that is returned by this method. That Listener object will typically add the TransactionEventAssembler.UndoRedoSupport.Edit it is given over to whatever data structure is managing all undo/redo functions for the entire application.

Parameters:

source - the EventList on which to provide undo/redo capabilities

Returns:

an instance of UndoRedoSupport through which the undo/redo behaviour can be customized

uninstall

public void uninstall()

This method removes undo/redo support from the EventList it was installed on. This method is useful when the EventList must outlive the UndoRedoSupport object itself. The UndoRedoSupport object will become available for garbage collection independently of the EventList it decorated with behaviour.