oracle.rules.sdk2.dictionary

Class UndoableEdit

java.lang.Object

oracle.rules.sdk2.dictionary.UndoableEdit

All Implemented Interfaces:

javax.swing.undo.UndoableEdit

public class UndoableEdit
extends java.lang.Object
implements javax.swing.undo.UndoableEdit

Simplified version of javax.swing.undo.UndoableEdit. A swing app should delegate to this class.

Note that undo and redo operations rollback any updates in progress on the RuleDictionary that generated the UndoableEdit.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	addEdit(javax.swing.undo.UndoableEdit anEdit) Adds an UndoableEdit to this UndoableEdit.
boolean	canRedo() True if it is still possible to redo this operation.
boolean	canUndo() True if it is still possible to undo this operation.
void	die() May be sent to inform an edit that it should no longer be used.
java.lang.String	getPresentationName() Returns a localized, human-readable description of this edit, suitable for use in a change log, for example.
java.lang.String	getRedoPresentationName() Returns a localized, human-readable description of the redoable form of this edit, suitable for use as a Redo menu item, for example.
java.lang.String	getUndoPresentationName() Returns a localized, human-readable description of the undoable form of this edit, suitable for use as an Undo menu item, for example.
boolean	isSignificant() Returns true if this edit is considered significant.
void	redo() Re-apply the edit, assuming that it has been undone.
boolean	replaceEdit(javax.swing.undo.UndoableEdit anEdit) Returns true if this UndoableEdit should replace anEdit.
void	setPresentationName(java.lang.String pn)
void	setRedoPresentationName(java.lang.String pn)
void	setUndoPresentationName(java.lang.String pn)
void	undo() Undo the edit that was made.

Methods inherited from class java.lang.Object

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

Method Detail

undo

public void undo()
          throws javax.swing.undo.CannotUndoException

Undo the edit that was made.

Specified by:

undo in interface javax.swing.undo.UndoableEdit

Throws:

javax.swing.undo.CannotUndoException - if this edit can not be undone

canUndo

public boolean canUndo()

True if it is still possible to undo this operation.

Specified by:

canUndo in interface javax.swing.undo.UndoableEdit

Returns:

true if this edit may be undone

redo

public void redo()
          throws javax.swing.undo.CannotRedoException

Re-apply the edit, assuming that it has been undone.

Specified by:

redo in interface javax.swing.undo.UndoableEdit

Throws:

javax.swing.undo.CannotRedoException - if this edit can not be redone

canRedo

public boolean canRedo()

True if it is still possible to redo this operation.

Specified by:

canRedo in interface javax.swing.undo.UndoableEdit

Returns:

true if this edit may be redone

die

public void die()

May be sent to inform an edit that it should no longer be used. This is a useful hook for cleaning up state no longer needed once undoing or redoing is impossible--for example, deleting file resources used by objects that can no longer be undeleted.

UndoManager

calls this before it dequeues edits. Note that this is a one-way operation. There is no "un-die" method.

Specified by:

die in interface javax.swing.undo.UndoableEdit

See Also:

CompoundEdit.die()

addEdit

public boolean addEdit(javax.swing.undo.UndoableEdit anEdit)

Description copied from interface: javax.swing.undo.UndoableEdit

Adds an UndoableEdit to this UndoableEdit. This method can be used to coalesce smaller edits into a larger compound edit. For example, text editors typically allow undo operations to apply to words or sentences. The text editor may choose to generate edits on each key event, but allow those edits to be coalesced into a more user-friendly unit, such as a word. In this case, the UndoableEdit would override addEdit to return true when the edits may be coalesced.

A return value of true indicates anEdit was incorporated into this edit. A return value of false indicates anEdit may not be incorporated into this edit.

Typically the receiver is already in the queue of a UndoManager (or other UndoableEditListener), and is being given a chance to incorporate anEdit rather than letting it be added to the queue in turn.

If true is returned, from now on anEdit must return false from canUndo and canRedo, and must throw the appropriate exception on undo or redo.

Specified by:

addEdit in interface javax.swing.undo.UndoableEdit

Parameters:

anEdit - the edit to be added

Returns:

true if anEdit may be incorporated into this edit

replaceEdit

public boolean replaceEdit(javax.swing.undo.UndoableEdit anEdit)

Description copied from interface: javax.swing.undo.UndoableEdit

Returns true if this UndoableEdit should replace anEdit. This method is used by CompoundEdit and the UndoManager; it is called if anEdit could not be added to the current edit (addEdit returns false).

This method provides a way for an edit to replace an existing edit.

This message is the opposite of addEdit--anEdit has typically already been queued in an UndoManager (or other UndoableEditListener), and the receiver is being given a chance to take its place.

If true is returned, from now on anEdit must return false from canUndo() and canRedo(), and must throw the appropriate exception on undo() or redo().

Specified by:

replaceEdit in interface javax.swing.undo.UndoableEdit

Parameters:

anEdit - the edit that replaces the current edit

Returns:

true if this edit should replace anEdit

isSignificant

public boolean isSignificant()

Description copied from interface: javax.swing.undo.UndoableEdit

Returns true if this edit is considered significant. A significant edit is typically an edit that should be presented to the user, perhaps on a menu item or tooltip. The UndoManager will undo, or redo, all insignificant edits to the next significant edit.

Specified by:

isSignificant in interface javax.swing.undo.UndoableEdit

Returns:

true if this edit is significant

getPresentationName

public java.lang.String getPresentationName()

Description copied from interface: javax.swing.undo.UndoableEdit

Returns a localized, human-readable description of this edit, suitable for use in a change log, for example.

Specified by:

getPresentationName in interface javax.swing.undo.UndoableEdit

Returns:

description of this edit

setPresentationName

public void setPresentationName(java.lang.String pn)

getUndoPresentationName

public java.lang.String getUndoPresentationName()

Description copied from interface: javax.swing.undo.UndoableEdit

Returns a localized, human-readable description of the undoable form of this edit, suitable for use as an Undo menu item, for example. This is typically derived from getPresentationName.

Specified by:

getUndoPresentationName in interface javax.swing.undo.UndoableEdit

Returns:

a description of the undoable form of this edit

setUndoPresentationName

public void setUndoPresentationName(java.lang.String pn)

getRedoPresentationName

public java.lang.String getRedoPresentationName()

Description copied from interface: javax.swing.undo.UndoableEdit

Returns a localized, human-readable description of the redoable form of this edit, suitable for use as a Redo menu item, for example. This is typically derived from getPresentationName.

Specified by:

getRedoPresentationName in interface javax.swing.undo.UndoableEdit

Returns:

a description of the redoable form of this edit

setRedoPresentationName

public void setRedoPresentationName(java.lang.String pn)