org.fxmisc.richtext.model.RichTextChange Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of richtextfx Show documentation
Rich-text area for JavaFX
The newest version!
package org.fxmisc.richtext.model;

/**
 * An object that specifies where a change occurred in a {@link org.fxmisc.richtext.GenericStyledArea}.
 */
public class RichTextChange extends TextChange, RichTextChange> {

    public RichTextChange(int position, StyledDocument removed, StyledDocument inserted) {
        super(position, removed, inserted);
    }

    @Override
    protected int removedLength() {
        return removed.length();
    }

    @Override
    protected int insertedLength() {
        return inserted.length();
    }

    @Override
    protected final StyledDocument concat(StyledDocument a, StyledDocument b) {
        return a.concat(b);
    }

    @Override
    protected final StyledDocument sub(StyledDocument doc, int from, int to) {
        return doc.subSequence(from, to);
    }

    @Override
    protected final RichTextChange create(int position, StyledDocument removed, StyledDocument inserted) {
        return new RichTextChange<>(position, removed, inserted);
    }

    public final PlainTextChange toPlainTextChange() {
        return new PlainTextChange(position, removed.getText(), inserted.getText());
    }

    /**
     * Equivalent to {@code richChange.toPlainTextChange().isIdentity()} but without the additional object
     * creation via {@link #toPlainTextChange()}.
     */
    public final boolean isPlainTextIdentity() {
        return removed.getText().equals(inserted.getText());
    }
    
    private static boolean skipStyleComparison = false;
    
    public static void skipStyleComparison( boolean value )
    {
        skipStyleComparison = value;
    }
    
    /* 
     * This gets used, by the default UndoManagers supplied by UndoUtils,
     * to check that a submitted undo/redo matches the change reported. 
     */
    public boolean equals( Object other )
    {
        if( skipStyleComparison && other instanceof RichTextChange )
        {
            PlainTextChange otherChange = ((RichTextChange) other).toPlainTextChange();
            boolean matches = toPlainTextChange().equals( otherChange );
            if ( ! matches ) System.err.println(
                "Plain text comparison mismatch caused by text change"
                +" during undo manager suspension (styling ignored)."
            );
            return matches;
        }

        return super.equals( other );
    }
}