UndoRedo.Manager (UI Utilities API)

java.lang.Object
- javax.swing.undo.AbstractUndoableEdit
- - javax.swing.undo.CompoundEdit
  - - javax.swing.undo.UndoManager
    - - org.openide.awt.UndoRedo.Manager

All Implemented Interfaces:

UndoRedo

Enclosing interface:

UndoRedo
```
public static class UndoRedo.Manager
extends javax.swing.undo.UndoManager
implements UndoRedo
```
An undo manager which fires a change event each time it consumes a new undoable edit.
Compared to Swing this implementation is more stable. If any contained undo edit throws an exception from its undo/redo methods the implementation will fail gracefully (unlike in Swing it will not change an internal pointer inside edits).

See Also:

Serialized Form

Nested Class Summary
- Nested classes/interfaces inherited from interface org.openide.awt.UndoRedo
  UndoRedo.Empty, UndoRedo.Manager, UndoRedo.Provider

Field Summary
- Fields inherited from class javax.swing.undo.AbstractUndoableEdit
  RedoName, UndoName
- Fields inherited from class javax.swing.undo.CompoundEdit
  edits
- Fields inherited from interface org.openide.awt.UndoRedo
  NONE

Constructor Summary

Constructors
Constructor Description

Manager()

Constructors
Constructor	Description
`Manager()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`addChangeListener(javax.swing.event.ChangeListener l)`	Add a change listener.
`boolean`	`addEdit(javax.swing.undo.UndoableEdit anEdit)`
`boolean`	`canRedo()`	Test whether the component currently has undone edits which may be redone.
`boolean`	`canUndo()`	Test whether the component currently has edits which may be undone.
`boolean`	`canUndoOrRedo()`
`void`	`die()`
`void`	`discardAllEdits()`
`protected javax.swing.undo.UndoableEdit`	`editToBeRedone()`
`protected javax.swing.undo.UndoableEdit`	`editToBeUndone()`
`void`	`end()`
`int`	`getLimit()`
`java.lang.String`	`getPresentationName()`
`java.lang.String`	`getRedoPresentationName()`	Get a human-presentable name describing the redo operation.
`java.lang.String`	`getUndoOrRedoPresentationName()`
`java.lang.String`	`getUndoPresentationName()`	Get a human-presentable name describing the undo operation.
`boolean`	`isInProgress()`
`boolean`	`isSignificant()`
`protected javax.swing.undo.UndoableEdit`	`lastEdit()`
`void`	`redo()`	Redo a previously undone edit.
`protected void`	`redoTo(javax.swing.undo.UndoableEdit edit)`
`void`	`removeChangeListener(javax.swing.event.ChangeListener l)`	Remove a change listener.
`boolean`	`replaceEdit(javax.swing.undo.UndoableEdit anEdit)`
`void`	`setLimit(int l)`
`java.lang.String`	`toString()`
`protected void`	`trimEdits(int from, int to)`
`protected void`	`trimForLimit()`
`void`	`undo()`	Undo an edit.
`void`	`undoableEditHappened(javax.swing.event.UndoableEditEvent ue)`	Consume an undoable edit.
`void`	`undoOrRedo()`
`protected void`	`undoTo(javax.swing.undo.UndoableEdit edit)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - Manager
```
public Manager()
```
- Method Detail
  - die
```
public void die()
```
    Overrides:
    
    die in class javax.swing.undo.CompoundEdit
  - isInProgress
```
public boolean isInProgress()
```
    Overrides:
    
    isInProgress in class javax.swing.undo.CompoundEdit
  - end
```
public void end()
```
    Overrides:
    
    end in class javax.swing.undo.UndoManager
  - undo
```
public void undo()
          throws javax.swing.undo.CannotUndoException
```
    Description copied from interface: UndoRedo
    
    Undo an edit.
    
    Specified by:
    
    undo in interface UndoRedo
    
    Overrides:
    
    undo in class javax.swing.undo.UndoManager
    
    Throws:
    
    javax.swing.undo.CannotUndoException - if it fails
  - undoTo
```
protected void undoTo(javax.swing.undo.UndoableEdit edit)
               throws javax.swing.undo.CannotUndoException
```
    Overrides:
    
    undoTo in class javax.swing.undo.UndoManager
    
    Throws:
    
    javax.swing.undo.CannotUndoException
  - canUndo
```
public boolean canUndo()
```
    Description copied from interface: UndoRedo
    
    Test whether the component currently has edits which may be undone.
    
    Specified by:
    
    canUndo in interface UndoRedo
    
    Overrides:
    
    canUndo in class javax.swing.undo.UndoManager
    
    Returns:
    
    true if undo is allowed
  - redo
```
public void redo()
          throws javax.swing.undo.CannotRedoException
```
    Description copied from interface: UndoRedo
    
    Redo a previously undone edit.
    
    Specified by:
    
    redo in interface UndoRedo
    
    Overrides:
    
    redo in class javax.swing.undo.UndoManager
    
    Throws:
    
    javax.swing.undo.CannotRedoException - if it fails
  - redoTo
```
protected void redoTo(javax.swing.undo.UndoableEdit edit)
               throws javax.swing.undo.CannotRedoException
```
    Overrides:
    
    redoTo in class javax.swing.undo.UndoManager
    
    Throws:
    
    javax.swing.undo.CannotRedoException
  - canRedo
```
public boolean canRedo()
```
    Description copied from interface: UndoRedo
    
    Test whether the component currently has undone edits which may be redone.
    
    Specified by:
    
    canRedo in interface UndoRedo
    
    Overrides:
    
    canRedo in class javax.swing.undo.UndoManager
    
    Returns:
    
    true if redo is allowed
  - undoOrRedo
```
public void undoOrRedo()
                throws javax.swing.undo.CannotRedoException,
                       javax.swing.undo.CannotUndoException
```
    Overrides:
    
    undoOrRedo in class javax.swing.undo.UndoManager
    
    Throws:
    
    javax.swing.undo.CannotRedoException
    
    javax.swing.undo.CannotUndoException
  - canUndoOrRedo
```
public boolean canUndoOrRedo()
```
    Overrides:
    
    canUndoOrRedo in class javax.swing.undo.UndoManager
  - getLimit
```
public int getLimit()
```
    Overrides:
    
    getLimit in class javax.swing.undo.UndoManager
  - setLimit
```
public void setLimit(int l)
```
    Overrides:
    
    setLimit in class javax.swing.undo.UndoManager
  - trimForLimit
```
protected void trimForLimit()
```
    Overrides:
    
    trimForLimit in class javax.swing.undo.UndoManager
  - trimEdits
```
protected void trimEdits(int from,
                         int to)
```
    Overrides:
    
    trimEdits in class javax.swing.undo.UndoManager
  - discardAllEdits
```
public void discardAllEdits()
```
    Overrides:
    
    discardAllEdits in class javax.swing.undo.UndoManager
  - lastEdit
```
protected javax.swing.undo.UndoableEdit lastEdit()
```
    Overrides:
    
    lastEdit in class javax.swing.undo.CompoundEdit
  - editToBeUndone
```
protected javax.swing.undo.UndoableEdit editToBeUndone()
```
    Overrides:
    
    editToBeUndone in class javax.swing.undo.UndoManager
  - editToBeRedone
```
protected javax.swing.undo.UndoableEdit editToBeRedone()
```
    Overrides:
    
    editToBeRedone in class javax.swing.undo.UndoManager
  - undoableEditHappened
```
public void undoableEditHappened(javax.swing.event.UndoableEditEvent ue)
```
    Consume an undoable edit. Delegates to superclass and notifies listeners.
    
    Overrides:
    
    undoableEditHappened in class javax.swing.undo.UndoManager
    
    Parameters:
    
    ue - the edit
  - addEdit
```
public boolean addEdit(javax.swing.undo.UndoableEdit anEdit)
```
    Overrides:
    
    addEdit in class javax.swing.undo.UndoManager
  - replaceEdit
```
public boolean replaceEdit(javax.swing.undo.UndoableEdit anEdit)
```
    Overrides:
    
    replaceEdit in class javax.swing.undo.AbstractUndoableEdit
  - isSignificant
```
public boolean isSignificant()
```
    Overrides:
    
    isSignificant in class javax.swing.undo.CompoundEdit
  - getPresentationName
```
public java.lang.String getPresentationName()
```
    Overrides:
    
    getPresentationName in class javax.swing.undo.CompoundEdit
  - getUndoPresentationName
```
public java.lang.String getUndoPresentationName()
```
    Description copied from interface: UndoRedo
    
    Get a human-presentable name describing the undo operation.
    
    Specified by:
    
    getUndoPresentationName in interface UndoRedo
    
    Overrides:
    
    getUndoPresentationName in class javax.swing.undo.UndoManager
    
    Returns:
    
    the name
  - getRedoPresentationName
```
public java.lang.String getRedoPresentationName()
```
    Description copied from interface: UndoRedo
    
    Get a human-presentable name describing the redo operation.
    
    Specified by:
    
    getRedoPresentationName in interface UndoRedo
    
    Overrides:
    
    getRedoPresentationName in class javax.swing.undo.UndoManager
    
    Returns:
    
    the name
  - getUndoOrRedoPresentationName
```
public java.lang.String getUndoOrRedoPresentationName()
```
    Overrides:
    
    getUndoOrRedoPresentationName in class javax.swing.undo.UndoManager
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class javax.swing.undo.UndoManager
  - addChangeListener
```
public void addChangeListener(javax.swing.event.ChangeListener l)
```
    Description copied from interface: UndoRedo
    
    Add a change listener. The listener will be notified every time the undo/redo ability of this object changes.
    
    Specified by:
    
    addChangeListener in interface UndoRedo
    
    Parameters:
    
    l - the listener to add
  - removeChangeListener
```
public void removeChangeListener(javax.swing.event.ChangeListener l)
```
    Description copied from interface: UndoRedo
    
    Remove a change listener.
    
    Specified by:
    
    removeChangeListener in interface UndoRedo
    
    Parameters:
    
    l - the listener to remove
    
    See Also:
    
    UndoRedo.addChangeListener(javax.swing.event.ChangeListener)

Class UndoRedo.Manager

Nested Class Summary

Nested classes/interfaces inherited from interface org.openide.awt.UndoRedo

Field Summary

Fields inherited from class javax.swing.undo.AbstractUndoableEdit

Fields inherited from class javax.swing.undo.CompoundEdit

Fields inherited from interface org.openide.awt.UndoRedo

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Manager

Method Detail

die

isInProgress

end

undo

undoTo

canUndo

redo

redoTo

canRedo

undoOrRedo

canUndoOrRedo

getLimit

setLimit

trimForLimit

trimEdits

discardAllEdits

lastEdit

editToBeUndone

editToBeRedone

undoableEditHappened

addEdit

replaceEdit

isSignificant

getPresentationName

getUndoPresentationName

getRedoPresentationName

getUndoOrRedoPresentationName

toString

addChangeListener

removeChangeListener