KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > fop > layout > hyphenation > Hyphenation


1 /*
2  * $Id: Hyphenation.java,v 1.3.2.3 2003/02/25 14:07:10 jeremias Exp $
3  * ============================================================================
4  * The Apache Software License, Version 1.1
5  * ============================================================================
6  *
7  * Copyright (C) 1999-2003 The Apache Software Foundation. All rights reserved.
8  *
9  * Redistribution and use in source and binary forms, with or without modifica-
10  * tion, are permitted provided that the following conditions are met:
11  *
12  * 1. Redistributions of source code must retain the above copyright notice,
13  * this list of conditions and the following disclaimer.
14  *
15  * 2. Redistributions in binary form must reproduce the above copyright notice,
16  * this list of conditions and the following disclaimer in the documentation
17  * and/or other materials provided with the distribution.
18  *
19  * 3. The end-user documentation included with the redistribution, if any, must
20  * include the following acknowledgment: "This product includes software
21  * developed by the Apache Software Foundation (http://www.apache.org/)."
22  * Alternately, this acknowledgment may appear in the software itself, if
23  * and wherever such third-party acknowledgments normally appear.
24  *
25  * 4. The names "FOP" and "Apache Software Foundation" must not be used to
26  * endorse or promote products derived from this software without prior
27  * written permission. For written permission, please contact
28  * apache@apache.org.
29  *
30  * 5. Products derived from this software may not be called "Apache", nor may
31  * "Apache" appear in their name, without prior written permission of the
32  * Apache Software Foundation.
33  *
34  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES,
35  * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
36  * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
37  * APACHE SOFTWARE FOUNDATION OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
38  * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLU-
39  * DING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
40  * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
41  * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
42  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
43  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
44  * ============================================================================
45  *
46  * This software consists of voluntary contributions made by many individuals
47  * on behalf of the Apache Software Foundation and was originally created by
48  * James Tauber <jtauber@jtauber.com>. For more information on the Apache
49  * Software Foundation, please see <http://www.apache.org/>.
50  */
51 package org.apache.fop.layout.hyphenation;
52
53 /**
54  * This class represents a hyphenated word.
55  *
56  * @author Carlos Villegas <cav@uniscope.co.jp>
57  */
58 public class Hyphenation {
59     int[] hyphenPoints;
60     String JavaDoc word;
61
62     /**
63      * number of hyphenation points in word
64      */
65     int len;
66
67     /**
68      * rawWord as made of alternating strings and {@link Hyphen Hyphen}
69      * instances
70      */
71     Hyphenation(String JavaDoc word, int[] points) {
72         this.word = word;
73         hyphenPoints = points;
74         len = points.length;
75     }
76
77     /**
78      * @return the number of hyphenation points in the word
79      */
80     public int length() {
81         return len;
82     }
83
84     /**
85      * @return the pre-break text, not including the hyphen character
86      */
87     public String JavaDoc getPreHyphenText(int index) {
88         return word.substring(0, hyphenPoints[index]);
89     }
90
91     /**
92      * @return the post-break text
93      */
94     public String JavaDoc getPostHyphenText(int index) {
95         return word.substring(hyphenPoints[index]);
96     }
97
98     /**
99      * @return the hyphenation points
100      */
101     public int[] getHyphenationPoints() {
102         return hyphenPoints;
103     }
104
105     public String JavaDoc toString() {
106         StringBuffer JavaDoc str = new StringBuffer JavaDoc();
107         int start = 0;
108         for (int i = 0; i < len; i++) {
109             str.append(word.substring(start, hyphenPoints[i]) + "-");
110             start = hyphenPoints[i];
111         }
112         str.append(word.substring(start));
113         return str.toString();
114     }
115
116 }
117
Popular Tags