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

Go to download
Show more of this group Show more artifacts with this name
Show all versions of rich-text-area Show documentation
Rich text control for JavaFX
The newest version!
/*
 * Copyright (c) 2023, 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;

/**
 * Defines an object that can be inserted into a PieceTable. It can be mainly a
 * text string, but also other non-text objects like emojis or images
 */
public interface Unit {

    /**
     * Gets the exportable text of the unit. It is useful for clipboard or
     * serializing the document, but shouldn't be used internally to do Piece
     * operations
     * @return a string with the exportable text content
     */
    String getText();

    /**
     * Gets the internal text. For text units, matches the exportable text.
     * For non-text units, this is used as an anchor point
     * @return a string with the internal text representation
     */
    String getInternalText();

    /**
     * Gets the internal length of the unit. Useful for Piece operations
     * @return an integer value of the internal number of positions that the unit spans
     */
    int length();

    /**
     * Check if unit is null or its content is empty
     * @return boolean true if null or empty unit
     */
    boolean isEmpty();

}