UndoManagerImpl (undofx 2.1.1 API)

java.lang.Object
- org.fxmisc.undo.impl.UndoManagerImpl<C>

Type Parameters:

C - the type of change to undo/redo

All Implemented Interfaces:

UndoManager<C>

Direct Known Subclasses:

MultiChangeUndoManagerImpl
```
public class UndoManagerImpl<C>
extends java.lang.Object
implements UndoManager<C>
```
Implementation for UndoManager for single changes. For multiple changes, see MultiChangeUndoManagerImpl.

Property Summary

Properties
Type	Property	Description
`javafx.beans.value.ObservableBooleanValue`	`atMarkedPosition`	Indicates whether this UndoManager's current position within its history is the same as the last marked position.
`org.reactfx.value.Val<C>`	`nextRedo`	Gives a peek at the change that will be redone by `UndoManager.redo()`.
`org.reactfx.value.Val<C>`	`nextUndo`	Gives a peek at the change that will be undone by `UndoManager.undo()`.
`javafx.beans.value.ObservableBooleanValue`	`performingAction`	Indicates whether this undo manager is currently performing undo or redo action.
`org.reactfx.value.Val<java.lang.Boolean>`	`redoAvailable`	Indicates whether there is a change that can be redone.
`org.reactfx.value.Val<java.lang.Boolean>`	`undoAvailable`	Indicates whether there is a change that can be undone.

Nested Class Summary
- Nested classes/interfaces inherited from interface org.fxmisc.undo.UndoManager
  UndoManager.UndoPosition

Constructor Summary

Constructors
Constructor	Description
`UndoManagerImpl(ChangeQueue<C> queue, java.util.function.Function<? super C,? extends C> invert, java.util.function.Consumer<C> apply, java.util.function.BiFunction<C,C,java.util.Optional<C>> merge, java.util.function.Predicate<C> isIdentity, org.reactfx.EventStream<C> changeSource)`
`UndoManagerImpl(ChangeQueue<C> queue, java.util.function.Function<? super C,? extends C> invert, java.util.function.Consumer<C> apply, java.util.function.BiFunction<C,C,java.util.Optional<C>> merge, java.util.function.Predicate<C> isIdentity, org.reactfx.EventStream<C> changeSource, java.time.Duration preventMergeDelay)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`javafx.beans.value.ObservableBooleanValue`	`atMarkedPositionProperty()`	Indicates whether this UndoManager's current position within its history is the same as the last marked position.
`void`	`close()`	Stops observing change events.
`void`	`forgetHistory()`	Forgets all changes prior to the current position in the history.
`UndoManager.UndoPosition`	`getCurrentPosition()`	Returns the current position within this UndoManager's history.
`boolean`	`isAtMarkedPosition()`
`boolean`	`isPerformingAction()`
`boolean`	`isRedoAvailable()`
`boolean`	`isUndoAvailable()`
`org.reactfx.value.Val<C>`	`nextRedoProperty()`	Gives a peek at the change that will be redone by `UndoManager.redo()`.
`org.reactfx.value.Val<C>`	`nextUndoProperty()`	Gives a peek at the change that will be undone by `UndoManager.undo()`.
`javafx.beans.value.ObservableBooleanValue`	`performingActionProperty()`	Indicates whether this undo manager is currently performing undo or redo action.
`void`	`preventMerge()`	Prevents the next change from being merged with the latest one.
`boolean`	`redo()`	Redo previously undone change, if there is any change to redo.
`org.reactfx.value.Val<java.lang.Boolean>`	`redoAvailableProperty()`	Indicates whether there is a change that can be redone.
`boolean`	`undo()`	Undo the most recent change, if there is any change to undo.
`org.reactfx.value.Val<java.lang.Boolean>`	`undoAvailableProperty()`	Indicates whether there is a change that can be undone.

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

Methods inherited from interface org.fxmisc.undo.UndoManager
getNextRedo, getNextUndo, mark

- Property Detail
  - nextUndo
```
public org.reactfx.value.Val<C> nextUndoProperty
```
    Specified by:
    
    nextUndoProperty in interface UndoManager<C>
  - nextRedo
```
public org.reactfx.value.Val<C> nextRedoProperty
```
    Specified by:
    
    nextRedoProperty in interface UndoManager<C>
  - undoAvailable
```
public org.reactfx.value.Val<java.lang.Boolean> undoAvailableProperty
```
    Specified by:
    
    undoAvailableProperty in interface UndoManager<C>
  - redoAvailable
```
public org.reactfx.value.Val<java.lang.Boolean> redoAvailableProperty
```
    Specified by:
    
    redoAvailableProperty in interface UndoManager<C>
  - performingAction
```
public javafx.beans.value.ObservableBooleanValue performingActionProperty
```
    Specified by:
    
    performingActionProperty in interface UndoManager<C>
  - atMarkedPosition
```
public javafx.beans.value.ObservableBooleanValue atMarkedPositionProperty
```
    Specified by:
    
    atMarkedPositionProperty in interface UndoManager<C>
- Constructor Detail
  - UndoManagerImpl
```
public UndoManagerImpl(ChangeQueue<C> queue,
                       java.util.function.Function<? super C,? extends C> invert,
                       java.util.function.Consumer<C> apply,
                       java.util.function.BiFunction<C,C,java.util.Optional<C>> merge,
                       java.util.function.Predicate<C> isIdentity,
                       org.reactfx.EventStream<C> changeSource)
```
  - UndoManagerImpl
```
public UndoManagerImpl(ChangeQueue<C> queue,
                       java.util.function.Function<? super C,? extends C> invert,
                       java.util.function.Consumer<C> apply,
                       java.util.function.BiFunction<C,C,java.util.Optional<C>> merge,
                       java.util.function.Predicate<C> isIdentity,
                       org.reactfx.EventStream<C> changeSource,
                       java.time.Duration preventMergeDelay)
```
- Method Detail
  - close
```
public void close()
```
    Description copied from interface: UndoManager
    
    Stops observing change events.
    
    Specified by:
    
    close in interface UndoManager<C>
  - undo
```
public boolean undo()
```
    Description copied from interface: UndoManager
    
    Undo the most recent change, if there is any change to undo.
    
    Specified by:
    
    undo in interface UndoManager<C>
    
    Returns:
    
    true if a change was undone, false otherwise.
  - redo
```
public boolean redo()
```
    Description copied from interface: UndoManager
    
    Redo previously undone change, if there is any change to redo.
    
    Specified by:
    
    redo in interface UndoManager<C>
    
    Returns:
    
    true if a change was redone, false otherwise.
  - nextUndoProperty
```
public org.reactfx.value.Val<C> nextUndoProperty()
```
    Description copied from interface: UndoManager
    
    Gives a peek at the change that will be undone by UndoManager.undo().
    
    Specified by:
    
    nextUndoProperty in interface UndoManager<C>
  - nextRedoProperty
```
public org.reactfx.value.Val<C> nextRedoProperty()
```
    Description copied from interface: UndoManager
    
    Gives a peek at the change that will be redone by UndoManager.redo().
    
    Specified by:
    
    nextRedoProperty in interface UndoManager<C>
  - isUndoAvailable
```
public boolean isUndoAvailable()
```
    Specified by:
    
    isUndoAvailable in interface UndoManager<C>
  - undoAvailableProperty
```
public org.reactfx.value.Val<java.lang.Boolean> undoAvailableProperty()
```
    Description copied from interface: UndoManager
    
    Indicates whether there is a change that can be undone.
    
    Specified by:
    
    undoAvailableProperty in interface UndoManager<C>
  - isRedoAvailable
```
public boolean isRedoAvailable()
```
    Specified by:
    
    isRedoAvailable in interface UndoManager<C>
  - redoAvailableProperty
```
public org.reactfx.value.Val<java.lang.Boolean> redoAvailableProperty()
```
    Description copied from interface: UndoManager
    
    Indicates whether there is a change that can be redone.
    
    Specified by:
    
    redoAvailableProperty in interface UndoManager<C>
  - isPerformingAction
```
public boolean isPerformingAction()
```
    Specified by:
    
    isPerformingAction in interface UndoManager<C>
  - performingActionProperty
```
public javafx.beans.value.ObservableBooleanValue performingActionProperty()
```
    Description copied from interface: UndoManager
    
    Indicates whether this undo manager is currently performing undo or redo action.
    
    Specified by:
    
    performingActionProperty in interface UndoManager<C>
  - isAtMarkedPosition
```
public boolean isAtMarkedPosition()
```
    Specified by:
    
    isAtMarkedPosition in interface UndoManager<C>
  - atMarkedPositionProperty
```
public javafx.beans.value.ObservableBooleanValue atMarkedPositionProperty()
```
    Description copied from interface: UndoManager
    
    Indicates whether this UndoManager's current position within its history is the same as the last marked position.
    
    Specified by:
    
    atMarkedPositionProperty in interface UndoManager<C>
  - getCurrentPosition
```
public UndoManager.UndoPosition getCurrentPosition()
```
    Description copied from interface: UndoManager
    
    Returns the current position within this UndoManager's history.
    
    Specified by:
    
    getCurrentPosition in interface UndoManager<C>
  - preventMerge
```
public void preventMerge()
```
    Description copied from interface: UndoManager
    
    Prevents the next change from being merged with the latest one.
    
    Specified by:
    
    preventMerge in interface UndoManager<C>
  - forgetHistory
```
public void forgetHistory()
```
    Description copied from interface: UndoManager
    
    Forgets all changes prior to the current position in the history.
    
    Specified by:
    
    forgetHistory in interface UndoManager<C>

Class UndoManagerImpl<C>

Property Summary

Nested Class Summary

Nested classes/interfaces inherited from interface org.fxmisc.undo.UndoManager

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface org.fxmisc.undo.UndoManager

Property Detail

nextUndo

nextRedo

undoAvailable

redoAvailable

performingAction

atMarkedPosition

Constructor Detail

UndoManagerImpl

UndoManagerImpl

Method Detail

close

undo

redo

nextUndoProperty

nextRedoProperty

isUndoAvailable

undoAvailableProperty

isRedoAvailable

redoAvailableProperty

isPerformingAction

performingActionProperty

isAtMarkedPosition

atMarkedPositionProperty

getCurrentPosition

preventMerge

forgetHistory