com.itextpdf.layout.splitting.ISplitCharacters Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of layout-android Show documentation

There is a newer version: 9.0.0

/*
    This file is part of the iText (R) project.
    Copyright (c) 1998-2023 Apryse Group NV
    Authors: Apryse Software.

    This program is offered under a commercial and under the AGPL license.
    For commercial licensing, contact us at https://itextpdf.com/sales.  For AGPL licensing, see below.

    AGPL licensing:
    This program is free software: you can redistribute it and/or modify
    it under the terms of the GNU Affero 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 Affero General Public License for more details.

    You should have received a copy of the GNU Affero General Public License
    along with this program.  If not, see .
 */
package com.itextpdf.layout.splitting;

import com.itextpdf.io.font.otf.Glyph;
import com.itextpdf.io.font.otf.GlyphLine;

/**
 * Interface for customizing the split character.
 */
public interface ISplitCharacters {

    /**
     * The splitting implementation is free to look ahead or look behind characters to make a decision.
     * @param glyphPos the position of {@link Glyph} in the {@link GlyphLine}
     * @param text an array of unicode char codes which represent current text
     * @return true if the character can split a line.
     */
    boolean isSplitCharacter(GlyphLine text, int glyphPos);

}