001/*
002 * $Id: SplitCharacter.java 4784 2011-03-15 08:33:00Z blowagie $
003 *
004 * This file is part of the iText (R) project.
005 * Copyright (c) 1998-2011 1T3XT BVBA
006 * Authors: Bruno Lowagie, Paulo Soares, et al.
007 *
008 * This program is free software; you can redistribute it and/or modify
009 * it under the terms of the GNU Affero General Public License version 3
010 * as published by the Free Software Foundation with the addition of the
011 * following permission added to Section 15 as permitted in Section 7(a):
012 * FOR ANY PART OF THE COVERED WORK IN WHICH THE COPYRIGHT IS OWNED BY 1T3XT,
013 * 1T3XT DISCLAIMS THE WARRANTY OF NON INFRINGEMENT OF THIRD PARTY RIGHTS.
014 *
015 * This program is distributed in the hope that it will be useful, but
016 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
017 * or FITNESS FOR A PARTICULAR PURPOSE.
018 * See the GNU Affero General Public License for more details.
019 * You should have received a copy of the GNU Affero General Public License
020 * along with this program; if not, see http://www.gnu.org/licenses or write to
021 * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
022 * Boston, MA, 02110-1301 USA, or download the license from the following URL:
023 * http://itextpdf.com/terms-of-use/
024 *
025 * The interactive user interfaces in modified source and object code versions
026 * of this program must display Appropriate Legal Notices, as required under
027 * Section 5 of the GNU Affero General Public License.
028 *
029 * In accordance with Section 7(b) of the GNU Affero General Public License,
030 * a covered work must retain the producer line in every PDF that is created
031 * or manipulated using iText.
032 *
033 * You can be released from the requirements of the license by purchasing
034 * a commercial license. Buying such a license is mandatory as soon as you
035 * develop commercial activities involving the iText software without
036 * disclosing the source code of your own applications.
037 * These activities include: offering paid services to customers as an ASP,
038 * serving PDFs on the fly in a web application, shipping iText with a closed
039 * source product.
040 *
041 * For more information, please contact iText Software Corp. at this
042 * address: sales@itextpdf.com
043 */
044package com.itextpdf.text;
045
046import com.itextpdf.text.pdf.PdfChunk;
047
048/** Interface for customizing the split character.
049 *
050 * @author Paulo Soares
051 */
052
053public interface SplitCharacter {
054    
055    /**
056     * Returns <CODE>true</CODE> if the character can split a line. The splitting implementation
057     * is free to look ahead or look behind characters to make a decision.
058     * <p>
059     * The default implementation is:
060     * <p>
061     * <pre>
062     * public boolean isSplitCharacter(int start, int current, int end, char[] cc, PdfChunk[] ck) {
063     *    char c;
064     *    if (ck == null)
065     *        c = cc[current];
066     *    else
067     *        c = (char) ck[Math.min(current, ck.length - 1)].getUnicodeEquivalent(cc[current]);
068     *    if (c <= ' ' || c == '-') {
069     *        return true;
070     *    }
071     *    if (c < 0x2e80)
072     *        return false;
073     *    return ((c >= 0x2e80 && c < 0xd7a0)
074     *    || (c >= 0xf900 && c < 0xfb00)
075     *    || (c >= 0xfe30 && c < 0xfe50)
076     *    || (c >= 0xff61 && c < 0xffa0));
077     * }
078     * </pre>
079     * @param start the lower limit of <CODE>cc</CODE> inclusive
080     * @param current the pointer to the character in <CODE>cc</CODE>
081     * @param end the upper limit of <CODE>cc</CODE> exclusive
082     * @param cc an array of characters at least <CODE>end</CODE> sized
083     * @param ck an array of <CODE>PdfChunk</CODE>. The main use is to be able to call
084     * {@link PdfChunk#getUnicodeEquivalent(int)}. It may be <CODE>null</CODE>
085     * or shorter than <CODE>end</CODE>. If <CODE>null</CODE> no conversion takes place.
086     * If shorter than <CODE>end</CODE> the last element is used
087     * @return <CODE>true</CODE> if the character(s) can split a line
088     */
089    public boolean isSplitCharacter(int start, int current, int end, char cc[], PdfChunk ck[]);
090}