org.fxmisc.richtext.util.UndoManagerInactivityWrapper Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of richtextfx Show documentation
FX-Text-Area for formatted text and other special effects.
There is a newer version: 1.11
package org.fxmisc.richtext.util;

import javafx.beans.value.ObservableBooleanValue;
import org.fxmisc.undo.UndoManager;
import org.reactfx.EventStream;
import org.reactfx.Subscription;
import org.reactfx.value.Val;

import java.time.Duration;

/**
 * A wrapper around an {@link UndoManager} that prevents the next emitted change from merging with the previous
 * one after a period of inactivity (i.e., the UndoManager's {@code changeSource} has not emitted an event
 * after a specified period of time.
 *
 * @param  the type of change the UndoManager can undo/redo
 */
final class UndoManagerInactivityWrapper implements UndoManager {

    private final UndoManager delegate;
    private final Subscription subscription;

    /**
     * Wraps an {@link UndoManager} and prevents the next emitted change from merging with the previous one
     * after a period of inactivity (i.e., the {@code changeSource} has not emitted an event for
     * {@code preventMergeDelay}). Note: there is no check that insures that the {@code changeSource}
     * parameter is the same one used by the {@code undoManager} parameter
     */
    public UndoManagerInactivityWrapper(UndoManager undoManager, EventStream changeSource, Duration preventMergeDelay) {
        this.delegate = undoManager;
        subscription = changeSource.successionEnds(preventMergeDelay).subscribe(ignore -> preventMerge());
    }

    @Override
    public boolean undo() {
        return delegate.undo();
    }

    @Override
    public boolean redo() {
        return delegate.redo();
    }

    @Override
    public Val undoAvailableProperty() {
        return delegate.undoAvailableProperty();
    }

    @Override
    public boolean isUndoAvailable() {
        return delegate.isUndoAvailable();
    }

    @Override
    public Val nextToUndoProperty() {
        return delegate.nextToUndoProperty();
    }

    @Override
    public C getNextToUndo() {
        return delegate.getNextToUndo();
    }

    @Override
    public Val nextToRedoProperty() {
        return delegate.nextToRedoProperty();
    }

    @Override
    public C getNextToRedo() {
        return delegate.getNextToRedo();
    }

    @Override
    public Val redoAvailableProperty() {
        return delegate.redoAvailableProperty();
    }

    @Override
    public boolean isRedoAvailable() {
        return delegate.isRedoAvailable();
    }

    @Override
    public ObservableBooleanValue performingActionProperty() {
        return delegate.performingActionProperty();
    }

    @Override
    public boolean isPerformingAction() {
        return delegate.isPerformingAction();
    }

    @Override
    public void preventMerge() {
        delegate.preventMerge();
    }

    @Override
    public void forgetHistory() {
        delegate.forgetHistory();
    }

    @Override
    public UndoPosition getCurrentPosition() {
        return delegate.getCurrentPosition();
    }

    @Override
    public void mark() {
        delegate.mark();
    }

    @Override
    public ObservableBooleanValue atMarkedPositionProperty() {
        return delegate.atMarkedPositionProperty();
    }

    @Override
    public boolean isAtMarkedPosition() {
        return delegate.isAtMarkedPosition();
    }

    @Override
    public void close() {
        subscription.unsubscribe();
        delegate.close();
    }
}