Overview  Package   Class  Use  Deprecated  Index
Home >> All >> javax >> swing >> [ undo overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---

javax.swing.undo
Class UndoableEditSupport  

java.lang.Object
  javax.swing.undo.UndoableEditSupport

---

public class UndoableEditSupport

extends java.lang.Object

A helper class for supporting javax.swing.event.UndoableEditListener.

---

Field Summary
protected  CompoundEdit	compoundEdit           compoundEdit
protected  java.util.Vector	listeners           The currently registered listeners.
protected  java.lang.Object	realSource           The source of the broadcast UndoableEditEvents.
protected  int	updateLevel           The number of times that beginUpdate() 55 has been called without a matching call to endUpdate() 55 .

 

Constructor Summary

UndoableEditSupport()           Constructs a new helper for broadcasting UndoableEditEvents.

UndoableEditSupport(java.lang.Object realSource)           Constructs a new helper for broadcasting UndoableEditEvents.

 

Method Summary
protected  void	_postEdit(UndoableEdit edit)           Notifies all registered listeners that an javax.swing.event.UndoableEditEvent has occured.
void	addUndoableEditListener(javax.swing.event.UndoableEditListener val)           Registers a listener.
void	beginUpdate()           Starts a (possibly nested) update session.
protected  CompoundEdit	createCompoundEdit()           Creates a new instance of CompoundEdit.
void	endUpdate()           Ends an update session.
javax.swing.event.UndoableEditListener[]	getUndoableEditListeners()           Returns an array containing the currently registered listeners.
int	getUpdateLevel()           Returns the current update level.
void	postEdit(UndoableEdit edit)           If beginUpdate() 55 has been called (so that the current update level is greater than zero), adds the specified edit to compoundEdit 55 .
void	removeUndoableEditListener(javax.swing.event.UndoableEditListener val)           Unregisters a listener.
java.lang.String	toString()           Returns a string representation of this object that may be useful for debugging.

 

Methods inherited from class java.lang.Object

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

 

Field Detail

updateLevel

protected int updateLevel

The number of times that beginUpdate() 55 has been called without a matching call to endUpdate() 55 .

---

compoundEdit

protected CompoundEdit compoundEdit

compoundEdit

---

listeners

protected java.util.Vector listeners

The currently registered listeners.

---

realSource

protected java.lang.Object realSource

The source of the broadcast UndoableEditEvents.

Constructor Detail

UndoableEditSupport

public UndoableEditSupport()

Constructs a new helper for broadcasting UndoableEditEvents. The events will indicate the newly constructed UndoableEditSupport instance as their source.

---

UndoableEditSupport

public UndoableEditSupport(java.lang.Object realSource)

Constructs a new helper for broadcasting UndoableEditEvents.

Method Detail

toString

public java.lang.String toString()

Returns a string representation of this object that may be useful for debugging.

---

addUndoableEditListener

public void addUndoableEditListener(javax.swing.event.UndoableEditListener val)

Registers a listener.

---

removeUndoableEditListener

public void removeUndoableEditListener(javax.swing.event.UndoableEditListener val)

Unregisters a listener.

---

getUndoableEditListeners

public javax.swing.event.UndoableEditListener[] getUndoableEditListeners()

Returns an array containing the currently registered listeners.

---

_postEdit

protected void _postEdit(UndoableEdit edit)

Notifies all registered listeners that an javax.swing.event.UndoableEditEvent has occured.

Lack of Thread Safety: It is not safe to call this method from concurrent threads, unless the call is protected by a synchronization on this UndoableEditSupport instance.

---

postEdit

public void postEdit(UndoableEdit edit)

If beginUpdate() 55 has been called (so that the current update level is greater than zero), adds the specified edit to compoundEdit 55 . Otherwise, notify listeners of the edit by calling _postEdit(UndoableEdit) 55 .

Thread Safety: It is safe to call this method from any thread without external synchronization.

---

getUpdateLevel

public int getUpdateLevel()

Returns the current update level.

---

beginUpdate

public void beginUpdate()

Starts a (possibly nested) update session. If the current update level is zero, compoundEdit 55 is set to the result of the createCompoundEdit() 55 method. In any case, the update level is increased by one.

Thread Safety: It is safe to call this method from any thread without external synchronization.

---

createCompoundEdit

protected CompoundEdit createCompoundEdit()

Creates a new instance of CompoundEdit. Called by beginUpdate() 55 . If a subclass wants beginUpdate() 55 to work on a specific compoundEdit 55 , it should override this method.

---

endUpdate

public void endUpdate()

Ends an update session. If the terminated session was the outermost session, compoundEdit 55 will receive an end message, and _postEdit(javax.swing.undo.UndoableEdit) 55 gets called in order to notify any listeners. Finally, the compoundEdit is discarded.

Thread Safety: It is safe to call this method from any thread without external synchronization.

---

Overview  Package   Class  Use  Deprecated  Index
Home >> All >> javax >> swing >> [ undo overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---