- java.lang.Object
- javax.swing.undo.UndoableEditSupport
public class UndoableEditSupport extends Object
A support class used for managingUndoableEdit
listeners.
Field Summary
Fields Modifier and Type Field Description protected CompoundEdit
compoundEdit
The compound edit.protected Vector<UndoableEditListener>
listeners
The list of listeners.protected Object
realSource
The real source.protected int
updateLevel
The update level.
Constructor Summary
Constructors Constructor Description UndoableEditSupport()
Constructs anUndoableEditSupport
object.UndoableEditSupport(Object r)
Constructs anUndoableEditSupport
object.
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected void
_postEdit(UndoableEdit e)
Called only frompostEdit
andendUpdate
.void
addUndoableEditListener(UndoableEditListener l)
Registers anUndoableEditListener
.void
beginUpdate()
protected CompoundEdit
createCompoundEdit()
Called only frombeginUpdate
.void
endUpdate()
DEADLOCK WARNING: Calling this method may callundoableEditHappened
in all listeners.UndoableEditListener[]
getUndoableEditListeners()
Returns an array of all theUndoableEditListener
s added to this UndoableEditSupport with addUndoableEditListener().int
getUpdateLevel()
Returns the update level value.void
postEdit(UndoableEdit e)
DEADLOCK WARNING: Calling this method may callundoableEditHappened
in all listeners.void
removeUndoableEditListener(UndoableEditListener l)
Removes anUndoableEditListener
.String
toString()
Returns a string that displays and identifies this object's properties.
Field Detail
updateLevel
protected int updateLevel
The update level.
compoundEdit
protected CompoundEdit compoundEdit
The compound edit.
listeners
protected Vector<UndoableEditListener> listeners
The list of listeners.
realSource
protected Object realSource
The real source.
Constructor Detail
UndoableEditSupport
public UndoableEditSupport()
Constructs anUndoableEditSupport
object.
UndoableEditSupport
public UndoableEditSupport(Object r)
Constructs anUndoableEditSupport
object.- Parameters:
r
- anObject
Method Detail
addUndoableEditListener
public void addUndoableEditListener(UndoableEditListener l)
Registers anUndoableEditListener
. The listener is notified whenever an edit occurs which can be undone.- Parameters:
l
- anUndoableEditListener
object- See Also:
removeUndoableEditListener(javax.swing.event.UndoableEditListener)
removeUndoableEditListener
public void removeUndoableEditListener(UndoableEditListener l)
Removes anUndoableEditListener
.- Parameters:
l
- theUndoableEditListener
object to be removed- See Also:
addUndoableEditListener(javax.swing.event.UndoableEditListener)
getUndoableEditListeners
public UndoableEditListener[] getUndoableEditListeners()
Returns an array of all theUndoableEditListener
s added to this UndoableEditSupport with addUndoableEditListener().- Returns:
- all of the
UndoableEditListener
s added or an empty array if no listeners have been added - Since:
- 1.4
_postEdit
protected void _postEdit(UndoableEdit e)
Called only frompostEdit
andendUpdate
. CallsundoableEditHappened
in all listeners. No synchronization is performed here, since the two calling methods are synchronized.- Parameters:
e
- edit to be verified
postEdit
public void postEdit(UndoableEdit e)
DEADLOCK WARNING: Calling this method may callundoableEditHappened
in all listeners. It is unwise to call this method from one of its listeners.- Parameters:
e
- edit to be posted
getUpdateLevel
public int getUpdateLevel()
Returns the update level value.- Returns:
- an integer representing the update level
beginUpdate
public void beginUpdate()
createCompoundEdit
protected CompoundEdit createCompoundEdit()
Called only frombeginUpdate
. Exposed here for subclasses' use.- Returns:
- new created
CompoundEdit
object
endUpdate
public void endUpdate()
DEADLOCK WARNING: Calling this method may callundoableEditHappened
in all listeners. It is unwise to call this method from one of its listeners.