001/* 002 * $Id: HyphenationAuto.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.pdf; 045 046import com.itextpdf.text.pdf.hyphenation.Hyphenation; 047import com.itextpdf.text.pdf.hyphenation.Hyphenator; 048 049/** Hyphenates words automatically accordingly to the language and country. 050 * The hyphenator engine was taken from FOP and uses the TEX patterns. If a language 051 * is not provided and a TEX pattern for it exists, it can be easily adapted. 052 * 053 * @author Paulo Soares 054 */ 055public class HyphenationAuto implements HyphenationEvent { 056 057 /** The hyphenator engine. 058 */ 059 protected Hyphenator hyphenator; 060 /** The second part of the hyphenated word. 061 */ 062 protected String post; 063 064 /** Creates a new hyphenation instance usable in <CODE>Chunk</CODE>. 065 * @param lang the language ("en" for English, for example) 066 * @param country the country ("GB" for Great-Britain or "none" for no country, for example) 067 * @param leftMin the minimum number of letters before the hyphen 068 * @param rightMin the minimum number of letters after the hyphen 069 */ 070 public HyphenationAuto(String lang, String country, int leftMin, int rightMin) { 071 hyphenator = new Hyphenator(lang, country, leftMin, rightMin); 072 } 073 074 /** Gets the hyphen symbol. 075 * @return the hyphen symbol 076 */ 077 public String getHyphenSymbol() { 078 return "-"; 079 } 080 081 /** Hyphenates a word and returns the first part of it. To get 082 * the second part of the hyphenated word call <CODE>getHyphenatedWordPost()</CODE>. 083 * @param word the word to hyphenate 084 * @param font the font used by this word 085 * @param fontSize the font size used by this word 086 * @param remainingWidth the width available to fit this word in 087 * @return the first part of the hyphenated word including 088 * the hyphen symbol, if any 089 */ 090 public String getHyphenatedWordPre(String word, BaseFont font, float fontSize, float remainingWidth) { 091 post = word; 092 String hyphen = getHyphenSymbol(); 093 float hyphenWidth = font.getWidthPoint(hyphen, fontSize); 094 if (hyphenWidth > remainingWidth) 095 return ""; 096 Hyphenation hyphenation = hyphenator.hyphenate(word); 097 if (hyphenation == null) { 098 return ""; 099 } 100 int len = hyphenation.length(); 101 int k; 102 for (k = 0; k < len; ++k) { 103 if (font.getWidthPoint(hyphenation.getPreHyphenText(k), fontSize) + hyphenWidth > remainingWidth) 104 break; 105 } 106 --k; 107 if (k < 0) 108 return ""; 109 post = hyphenation.getPostHyphenText(k); 110 return hyphenation.getPreHyphenText(k) + hyphen; 111 } 112 113 /** Gets the second part of the hyphenated word. Must be called 114 * after <CODE>getHyphenatedWordPre()</CODE>. 115 * @return the second part of the hyphenated word 116 */ 117 public String getHyphenatedWordPost() { 118 return post; 119 } 120 121}