KickJava   Java API By Example, From Geeks To Geeks.

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


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 /** Called by <code>Chunk</code> to hyphenate a word.
51  *
52  * @author Paulo Soares (psoares@consiste.pt)
53  */
54 public interface HyphenationEvent {
55
56     /** Gets the hyphen symbol.
57      * @return the hyphen symbol
58      */
59     public String JavaDoc getHyphenSymbol();
60     
61     /** Hyphenates a word and returns the first part of it. To get
62      * the second part of the hyphenated word call <CODE>getHyphenatedWordPost()</CODE>.
63      * @param word the word to hyphenate
64      * @param font the font used by this word
65      * @param fontSize the font size used by this word
66      * @param remainingWidth the width available to fit this word in
67      * @return the first part of the hyphenated word including
68      * the hyphen symbol, if any
69      */
70     public String JavaDoc getHyphenatedWordPre(String JavaDoc word, BaseFont font, float fontSize, float remainingWidth);
71     
72     /** Gets the second part of the hyphenated word. Must be called
73      * after <CODE>getHyphenatedWordPre()</CODE>.
74      * @return the second part of the hyphenated word
75      */
76     public String JavaDoc getHyphenatedWordPost();
77 }
78
79
Popular Tags