org.fxmisc.richtext.util

Class UndoUtils

java.lang.Object

org.fxmisc.richtext.util.UndoUtils

public final class UndoUtils
extends java.lang.Object

A class filled with factory methods to help easily construct an UndoManager for a GenericStyledArea.

Field Summary

Fields

Modifier and Type	Field and Description
static java.time.Duration	DEFAULT_PREVENT_MERGE_DELAY

Method Summary

Modifier and Type	Method and Description
static <PS,SEG,S> java.util.function.Consumer<PlainTextChange>	applyPlainTextChange(GenericStyledArea<PS,SEG,S> area) Applies a PlainTextChange to the given area when the UndoManager's change stream emits an event by area.replaceText(change.getPosition(), change.getRemovalEnd(), change.getInserted().
static <PS,SEG,S> java.util.function.Consumer<RichTextChange<PS,SEG,S>>	applyRichTextChange(GenericStyledArea<PS,SEG,S> area) Applies a PlainTextChange to the given area when the UndoManager's change stream emits an event by area.replace(change.getPosition(), change.getRemovalEnd(), change.getInserted().
static <PS,SEG,S> UndoManager	defaultUndoManager(GenericStyledArea<PS,SEG,S> area) Constructs an UndoManager with an unlimited history: if the area's preserveStyle flag is true, the returned UndoManager can undo/redo RichTextChanges; otherwise, it can undo/redo PlainTextChanges.
static <PS,SEG,S> UndoManager<PlainTextChange>	plainTextUndoManager(GenericStyledArea<PS,SEG,S> area) Returns an UndoManager with an unlimited history that can undo/redo PlainTextChanges.
static <PS,SEG,S> UndoManager<PlainTextChange>	plainTextUndoManager(GenericStyledArea<PS,SEG,S> area, java.time.Duration preventMergeDelay) Returns an UndoManager that can undo/redo PlainTextChanges.
static <PS,SEG,S> UndoManager<PlainTextChange>	plainTextUndoManager(GenericStyledArea<PS,SEG,S> area, UndoManagerFactory factory) Returns an UndoManager that can undo/redo PlainTextChanges.
static <PS,SEG,S> UndoManager<PlainTextChange>	plainTextUndoManager(GenericStyledArea<PS,SEG,S> area, UndoManagerFactory factory, java.time.Duration preventMergeDelay) Returns an UndoManager that can undo/redo PlainTextChanges.
static <PS,SEG,S> UndoManager<RichTextChange<PS,SEG,S>>	richTextUndoManager(GenericStyledArea<PS,SEG,S> area) Returns an UndoManager with an unlimited history that can undo/redo RichTextChanges.
static <PS,SEG,S> UndoManager<RichTextChange<PS,SEG,S>>	richTextUndoManager(GenericStyledArea<PS,SEG,S> area, java.time.Duration preventMergeDelay) Returns an UndoManager that can undo/redo RichTextChanges.
static <PS,SEG,S> UndoManager<RichTextChange<PS,SEG,S>>	richTextUndoManager(GenericStyledArea<PS,SEG,S> area, UndoManagerFactory factory) Returns an UndoManager that can undo/redo RichTextChanges.
static <PS,SEG,S> UndoManager<RichTextChange<PS,SEG,S>>	richTextUndoManager(GenericStyledArea<PS,SEG,S> area, UndoManagerFactory factory, java.time.Duration preventMergeDelay) Returns an UndoManager that can undo/redo RichTextChanges.
static <T> UndoManager<T>	wrap(UndoManager<T> undoManager, EventStream<T> changeStream, java.time.Duration preventMergeDelay) Deprecated. No longer needed since UndoFX 1.4.0

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_PREVENT_MERGE_DELAY

public static final java.time.Duration DEFAULT_PREVENT_MERGE_DELAY

Method Detail

defaultUndoManager

public static <PS,SEG,S> UndoManager defaultUndoManager(GenericStyledArea<PS,SEG,S> area)

Constructs an UndoManager with an unlimited history: if the area's preserveStyle flag is true, the returned UndoManager can undo/redo RichTextChanges; otherwise, it can undo/redo PlainTextChanges.

richTextUndoManager

public static <PS,SEG,S> UndoManager<RichTextChange<PS,SEG,S>> richTextUndoManager(GenericStyledArea<PS,SEG,S> area)

Returns an UndoManager with an unlimited history that can undo/redo RichTextChanges. New changes emitted from the stream will not be merged with the previous change after DEFAULT_PREVENT_MERGE_DELAY

richTextUndoManager

public static <PS,SEG,S> UndoManager<RichTextChange<PS,SEG,S>> richTextUndoManager(GenericStyledArea<PS,SEG,S> area,
                                                                                   java.time.Duration preventMergeDelay)

Returns an UndoManager that can undo/redo RichTextChanges. New changes emitted from the stream will not be merged with the previous change after preventMergeDelay

richTextUndoManager

public static <PS,SEG,S> UndoManager<RichTextChange<PS,SEG,S>> richTextUndoManager(GenericStyledArea<PS,SEG,S> area,
                                                                                   UndoManagerFactory factory)

Returns an UndoManager that can undo/redo RichTextChanges. New changes emitted from the stream will not be merged with the previous change after DEFAULT_PREVENT_MERGE_DELAY

richTextUndoManager

public static <PS,SEG,S> UndoManager<RichTextChange<PS,SEG,S>> richTextUndoManager(GenericStyledArea<PS,SEG,S> area,
                                                                                   UndoManagerFactory factory,
                                                                                   java.time.Duration preventMergeDelay)

Returns an UndoManager that can undo/redo RichTextChanges. New changes emitted from the stream will not be merged with the previous change after preventMergeDelay

plainTextUndoManager

public static <PS,SEG,S> UndoManager<PlainTextChange> plainTextUndoManager(GenericStyledArea<PS,SEG,S> area)

Returns an UndoManager with an unlimited history that can undo/redo PlainTextChanges. New changes emitted from the stream will not be merged with the previous change after DEFAULT_PREVENT_MERGE_DELAY

plainTextUndoManager

public static <PS,SEG,S> UndoManager<PlainTextChange> plainTextUndoManager(GenericStyledArea<PS,SEG,S> area,
                                                                           java.time.Duration preventMergeDelay)

Returns an UndoManager that can undo/redo PlainTextChanges. New changes emitted from the stream will not be merged with the previous change after preventMergeDelay

plainTextUndoManager

public static <PS,SEG,S> UndoManager<PlainTextChange> plainTextUndoManager(GenericStyledArea<PS,SEG,S> area,
                                                                           UndoManagerFactory factory)

Returns an UndoManager that can undo/redo PlainTextChanges. New changes emitted from the stream will not be merged with the previous change after DEFAULT_PREVENT_MERGE_DELAY

plainTextUndoManager

public static <PS,SEG,S> UndoManager<PlainTextChange> plainTextUndoManager(GenericStyledArea<PS,SEG,S> area,
                                                                           UndoManagerFactory factory,
                                                                           java.time.Duration preventMergeDelay)

Returns an UndoManager that can undo/redo PlainTextChanges. New changes emitted from the stream will not be merged with the previous change after preventMergeDelay

applyPlainTextChange

public static <PS,SEG,S> java.util.function.Consumer<PlainTextChange> applyPlainTextChange(GenericStyledArea<PS,SEG,S> area)

Applies a PlainTextChange to the given area when the UndoManager's change stream emits an event by area.replaceText(change.getPosition(), change.getRemovalEnd(), change.getInserted().

applyRichTextChange

public static <PS,SEG,S> java.util.function.Consumer<RichTextChange<PS,SEG,S>> applyRichTextChange(GenericStyledArea<PS,SEG,S> area)

Applies a PlainTextChange to the given area when the UndoManager's change stream emits an event by area.replace(change.getPosition(), change.getRemovalEnd(), change.getInserted().

wrap

@Deprecated
public static <T> UndoManager<T> wrap(UndoManager<T> undoManager,
                                                  EventStream<T> changeStream,
                                                  java.time.Duration preventMergeDelay)

Deprecated. No longer needed since UndoFX 1.4.0

Wraps an UndoManager and prevents the next emitted change from merging with the previous one are a period of inactivity (i.e., the changeStream has not emitted an event in preventMergeDelay