org.zaproxy.zap.utils

Class ZapTextComponentUndoManager

java.lang.Object

javax.swing.undo.AbstractUndoableEdit

javax.swing.undo.CompoundEdit

javax.swing.undo.UndoManager

org.zaproxy.zap.utils.ZapTextComponentUndoManager

All Implemented Interfaces:

PropertyChangeListener, Serializable, EventListener, UndoableEditListener, UndoableEdit

public class ZapTextComponentUndoManager
extends UndoManager
implements PropertyChangeListener

ZapTextComponentUndoManager manages a list of UndoableEdits, providing a way to undo or redo the appropriate edits with undo and redo actions accessible through KeyStrokes created with Constant.ACCELERATOR_UNDO and Constant.ACCELERATOR_REDO, respectively.

The default is to maintain a window of 100 undoable edits. When the limit is reached older undoable edits start to be discarded when new ones are saved. The limit can be changed with the method setLimit(int).

There are three policies that affect if, and when, the undoable edits are saved:

• UndoManagerPolicy.DEFAULT
• UndoManagerPolicy.ALWAYS_ENABLED
• UndoManagerPolicy.ALWAYS_DISABLED

The policy can be changed with the method setUndoManagerPolicy.

The ZapTextComponentUndoManager listens to changes to the Document of the JTextComponent used with the ZapTextComponentUndoManager, so there is no need to do anything if the document is changed.

Since:

1.4.1

See Also:

UndoManager.setLimit(int), setUndoManagerPolicy(UndoManagerPolicy), ZapTextComponentUndoManager.UndoManagerPolicy, UndoManager, Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ZapTextComponentUndoManager.UndoManagerPolicy There are three policies that affect if, and when, the undoable edits are saved: UndoManagerPolicy.DEFAULT UndoManagerPolicy.ALWAYS_ENABLED UndoManagerPolicy.ALWAYS_DISABLED

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
ZapTextComponentUndoManager(JTextComponent textComponent) Creates a new ZapTextComponentUndoManager with a DEFAULT policy.

Method Summary

Modifier and Type	Method and Description
void	propertyChange(PropertyChangeEvent evt)
void	setUndoManagerPolicy(ZapTextComponentUndoManager.UndoManagerPolicy policy) Sets the new policy.

Methods inherited from class javax.swing.undo.UndoManager

addEdit, canRedo, canUndo, canUndoOrRedo, discardAllEdits, editToBeRedone, editToBeUndone, end, getLimit, getRedoPresentationName, getUndoOrRedoPresentationName, getUndoPresentationName, redo, redoTo, setLimit, toString, trimEdits, trimForLimit, undo, 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

ZapTextComponentUndoManager

public ZapTextComponentUndoManager(JTextComponent textComponent)

Creates a new ZapTextComponentUndoManager with a DEFAULT policy.

Parameters:

textComponent - the JTextComponent that will have undoable edits.

Throws:

NullPointerException - if textComponent is null.

See Also:

ZapTextComponentUndoManager.UndoManagerPolicy.DEFAULT

Method Detail

setUndoManagerPolicy

public final void setUndoManagerPolicy(ZapTextComponentUndoManager.UndoManagerPolicy policy)
                                throws NullPointerException

Sets the new policy.

Parameters:

policy - the new policy

Throws:

NullPointerException - if policy is null

See Also:

ZapTextComponentUndoManager.UndoManagerPolicy

propertyChange

public void propertyChange(PropertyChangeEvent evt)

Specified by:

propertyChange in interface PropertyChangeListener