KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > lowagie > text > pdf > HyphenationAuto


1 /*
2  * Copyright 2002 Paulo Soares
3  *
4  * The contents of this file are subject to the Mozilla Public License Version 1.1
5  * (the "License"); you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at http://www.mozilla.org/MPL/
7  *
8  * Software distributed under the License is distributed on an "AS IS" basis,
9  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
10  * for the specific language governing rights and limitations under the License.
11  *
12  * The Original Code is 'iText, a free JAVA-PDF library'.
13  *
14  * The Initial Developer of the Original Code is Bruno Lowagie. Portions created by
15  * the Initial Developer are Copyright (C) 1999, 2000, 2001, 2002 by Bruno Lowagie.
16  * All Rights Reserved.
17  * Co-Developer of the code is Paulo Soares. Portions created by the Co-Developer
18  * are Copyright (C) 2000, 2001, 2002 by Paulo Soares. All Rights Reserved.
19  *
20  * Contributor(s): all the names of the contributors are added in the source code
21  * where applicable.
22  *
23  * Alternatively, the contents of this file may be used under the terms of the
24  * LGPL license (the "GNU LIBRARY GENERAL PUBLIC LICENSE"), in which case the
25  * provisions of LGPL are applicable instead of those above. If you wish to
26  * allow use of your version of this file only under the terms of the LGPL
27  * License and not to allow others to use your version of this file under
28  * the MPL, indicate your decision by deleting the provisions above and
29  * replace them with the notice and other provisions required by the LGPL.
30  * If you do not delete the provisions above, a recipient may use your version
31  * of this file under either the MPL or the GNU LIBRARY GENERAL PUBLIC LICENSE.
32  *
33  * This library is free software; you can redistribute it and/or modify it
34  * under the terms of the MPL as stated above or under the terms of the GNU
35  * Library General Public License as published by the Free Software Foundation;
36  * either version 2 of the License, or any later version.
37  *
38  * This library is distributed in the hope that it will be useful, but WITHOUT
39  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
40  * FOR A PARTICULAR PURPOSE. See the GNU Library general Public License for more
41  * details.
42  *
43  * If you didn't download this code from the following link, you should check if
44  * you aren't using an obsolete version:
45  * http://www.lowagie.com/iText/
46  */
47
48 package com.lowagie.text.pdf;
49
50 import com.lowagie.text.pdf.hyphenation.Hyphenation;
51 import com.lowagie.text.pdf.hyphenation.Hyphenator;
52
53 /** Hyphenates words automatically accordingly to the language and country.
54  * The hyphenator engine was taken from FOP and uses the TEX patterns. If a language
55  * is not provided and a TEX pattern for it exists, it can be easily adapted.
56  *
57  * @author Paulo Soares (psoares@consiste.pt)
58  */
59 public class HyphenationAuto implements HyphenationEvent {
60
61     /** The hyphenator engine.
62      */
63     protected Hyphenator hyphenator;
64     /** The second part of the hyphenated word.
65      */
66     protected String JavaDoc post;
67     
68     /** Creates a new hyphenation instance usable in <CODE>Chunk</CODE>.
69      * @param lang the language ("en" for english, for example)
70      * @param country the country ("GB" for Great-Britain or "none" for no country, for example)
71      * @param leftMin the minimun number of letters before the hyphen
72      * @param rightMin the minimun number of letters after the hyphen
73      */
74     public HyphenationAuto(String JavaDoc lang, String JavaDoc country, int leftMin, int rightMin) {
75         hyphenator = new Hyphenator(lang, country, leftMin, rightMin);
76     }
77
78     /** Gets the hyphen symbol.
79      * @return the hyphen symbol
80      */
81     public String JavaDoc getHyphenSymbol() {
82         return "-";
83     }
84     
85     /** Hyphenates a word and returns the first part of it. To get
86      * the second part of the hyphenated word call <CODE>getHyphenatedWordPost()</CODE>.
87      * @param word the word to hyphenate
88      * @param font the font used by this word
89      * @param fontSize the font size used by this word
90      * @param remainingWidth the width available to fit this word in
91      * @return the first part of the hyphenated word including
92      * the hyphen symbol, if any
93      */
94     public String JavaDoc getHyphenatedWordPre(String JavaDoc word, BaseFont font, float fontSize, float remainingWidth) {
95         post = word;
96         String JavaDoc hyphen = getHyphenSymbol();
97         float hyphenWidth = font.getWidthPoint(hyphen, fontSize);
98         if (hyphenWidth > remainingWidth)
99             return "";
100         Hyphenation hyphenation = hyphenator.hyphenate(word);
101         if (hyphenation == null) {
102             return "";
103         }
104         int len = hyphenation.length();
105         int k;
106         for (k = 0; k < len; ++k) {
107             if (font.getWidthPoint(hyphenation.getPreHyphenText(k), fontSize) + hyphenWidth > remainingWidth)
108                 break;
109         }
110         --k;
111         if (k < 0)
112             return "";
113         post = hyphenation.getPostHyphenText(k);
114         return hyphenation.getPreHyphenText(k) + hyphen;
115     }
116     
117     /** Gets the second part of the hyphenated word. Must be called
118      * after <CODE>getHyphenatedWordPre()</CODE>.
119      * @return the second part of the hyphenated word
120      */
121     public String JavaDoc getHyphenatedWordPost() {
122         return post;
123     }
124     
125 }
126
Popular Tags