KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > lowagie > text > SplitCharacter


1 /*
2  * $Id: SplitCharacter.java 2739 2007-05-04 11:24:51Z blowagie $
3  * $Name$
4  *
5  * Copyright 2001, 2002 by Paulo Soares
6  *
7  * The contents of this file are subject to the Mozilla Public License Version 1.1
8  * (the "License"); you may not use this file except in compliance with the License.
9  * You may obtain a copy of the License at http://www.mozilla.org/MPL/
10  *
11  * Software distributed under the License is distributed on an "AS IS" basis,
12  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
13  * for the specific language governing rights and limitations under the License.
14  *
15  * The Original Code is 'iText, a free JAVA-PDF library'.
16  *
17  * The Initial Developer of the Original Code is Bruno Lowagie. Portions created by
18  * the Initial Developer are Copyright (C) 1999, 2000, 2001, 2002 by Bruno Lowagie.
19  * All Rights Reserved.
20  * Co-Developer of the code is Paulo Soares. Portions created by the Co-Developer
21  * are Copyright (C) 2000, 2001, 2002 by Paulo Soares. All Rights Reserved.
22  *
23  * Contributor(s): all the names of the contributors are added in the source code
24  * where applicable.
25  *
26  * Alternatively, the contents of this file may be used under the terms of the
27  * LGPL license (the "GNU LIBRARY GENERAL PUBLIC LICENSE"), in which case the
28  * provisions of LGPL are applicable instead of those above. If you wish to
29  * allow use of your version of this file only under the terms of the LGPL
30  * License and not to allow others to use your version of this file under
31  * the MPL, indicate your decision by deleting the provisions above and
32  * replace them with the notice and other provisions required by the LGPL.
33  * If you do not delete the provisions above, a recipient may use your version
34  * of this file under either the MPL or the GNU LIBRARY GENERAL PUBLIC LICENSE.
35  *
36  * This library is free software; you can redistribute it and/or modify it
37  * under the terms of the MPL as stated above or under the terms of the GNU
38  * Library General Public License as published by the Free Software Foundation;
39  * either version 2 of the License, or any later version.
40  *
41  * This library is distributed in the hope that it will be useful, but WITHOUT
42  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
43  * FOR A PARTICULAR PURPOSE. See the GNU Library general Public License for more
44  * details.
45  *
46  * If you didn't download this code from the following link, you should check if
47  * you aren't using an obsolete version:
48  * http://www.lowagie.com/iText/
49  */
50
51 package com.lowagie.text;
52
53 import com.lowagie.text.pdf.PdfChunk;
54
55 /** Interface for customizing the split character.
56  *
57  * @author Paulo Soares (psoares@consiste.pt)
58  */
59
60 public interface SplitCharacter {
61     
62     /**
63      * Returns <CODE>true</CODE> if the character can split a line. The splitting implementation
64      * is free to look ahead or look behind characters to make a decision.
65      * <p>
66      * The default implementation is:
67      * <p>
68      * <pre>
69      * public boolean isSplitCharacter(int start, int current, int end, char[] cc, PdfChunk[] ck) {
70      * char c;
71      * if (ck == null)
72      * c = cc[current];
73      * else
74      * c = ck[Math.min(current, ck.length - 1)].getUnicodeEquivalent(cc[current]);
75      * if (c <= ' ' || c == '-') {
76      * return true;
77      * }
78      * if (c < 0x2e80)
79      * return false;
80      * return ((c >= 0x2e80 && c < 0xd7a0)
81      * || (c >= 0xf900 && c < 0xfb00)
82      * || (c >= 0xfe30 && c < 0xfe50)
83      * || (c >= 0xff61 && c < 0xffa0));
84      * }
85      * </pre>
86      * @param start the lower limit of <CODE>cc</CODE> inclusive
87      * @param current the pointer to the character in <CODE>cc</CODE>
88      * @param end the upper limit of <CODE>cc</CODE> exclusive
89      * @param cc an array of characters at least <CODE>end</CODE> sized
90      * @param ck an array of <CODE>PdfChunk</CODE>. The main use is to be able to call
91      * {@link PdfChunk#getUnicodeEquivalent(char)}. It may be <CODE>null</CODE>
92      * or shorter than <CODE>end</CODE>. If <CODE>null</CODE> no convertion takes place.
93      * If shorter than <CODE>end</CODE> the last element is used
94      * @return <CODE>true</CODE> if the character(s) can split a line
95      */
96     public boolean isSplitCharacter(int start, int current, int end, char cc[], PdfChunk ck[]);
97 }
98
Popular Tags