com.gluonhq.richtextarea.model.Document Maven / Gradle / Ivy

Go to download
/*
 * Copyright (c) 2022, 2024, Gluon
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see .
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL GLUON BE LIABLE FOR ANY
 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
package com.gluonhq.richtextarea.model;

import com.gluonhq.richtextarea.Tools;

import java.io.Serializable;
import java.util.List;
import java.util.Objects;
import java.util.stream.Collectors;

/**
 * A Document is the basic model that contains all the information required for the {@link com.gluonhq.richtextarea.RichTextArea}
 * control, in order to render all the rich content, including decorated text, images and other non-text objects.
 *
 * A document is basically a string with the full raw text, and a list of {@link DecorationModel} that contain the text and
 * paragraph decorations for one or more fragments of the text, where a fragment can be defined as the longest
 * substring of the text that shares the same text and paragraph decorations.
 *
 * The document can be serialized/deserialized, and therefore the full raw text should contain all characters that define it,
 * whether these can be rendered by a text editor or not. All the indices used by the Document model (like start/length of
 * decorations or caret position) should refer to their position within the full raw text.
 *
 */
public class Document implements Serializable {

    private final String text;
    private final List decorationList;
    private final int caretPosition;

    public Document() {
        this("");
    }

    public Document(String text) {
        this(text, 0);
    }

    public Document(String text, int caretPosition) {
        this(text,
                List.of(DecorationModel.createDefaultDecorationModel(text.length())),
                caretPosition);
    }

    public Document(String text, List decorationList, int caretPosition) {
        this.text = text;
        this.decorationList = decorationList;
        this.caretPosition = caretPosition;
    }

    /**
     * Returns the full raw text of the document.
     *
     * This can include unicode characters that may or may not be rendered by an editor
     *
     * @return a string with the full text of the document
     */
    public String getText() {
        return text;
    }

    /**
     * Returns the list of {@link DecorationModel} that define the fragments of text
     * that share the same decorations.
     *
     * The range of each {@link Decoration} is defined based on the full raw text.
     *
     * @return the list of {@link DecorationModel}
     */
    public List getDecorations() {
        return decorationList;
    }

    /**
     * Returns the caret position in order to restore the caret when the document
     * is opened, in terms of the full raw text, and not the rendered or visible text.
     *
     * @return the caret position when document was saved
     */
    public int getCaretPosition() {
        return caretPosition;
    }

    @Override
    public boolean equals(Object o) {
        if (this == o) return true;
        if (o == null || getClass() != o.getClass()) return false;
        Document document = (Document) o;
        return Objects.equals(text, document.text) &&
                Objects.equals(decorationList, document.decorationList);
    }

    @Override
    public int hashCode() {
        return Objects.hash(text, decorationList, caretPosition);
    }

    @Override
    public String toString() {
        return "Document{" +
                "text='" + Tools.formatTextWithAnchors(text) + '\'' +
                ", decorationList=" + (decorationList == null ? "null" : "{" +
                    decorationList.stream().map(decorationModel -> " - " + decorationModel.toString()).collect(Collectors.joining("\n", "\n", ""))) +
                "\n}, caretPosition=" + caretPosition +
                '}';
    }
}