1 /*
2 * $Id: PdfFont.java 3373 2008-05-12 16:21:24Z xlv $
3 *
4 * Copyright 1999, 2000, 2001, 2002 Bruno Lowagie
5 *
6 * The contents of this file are subject to the Mozilla Public License Version 1.1
7 * (the "License"); you may not use this file except in compliance with the License.
8 * You may obtain a copy of the License at http://www.mozilla.org/MPL/
9 *
10 * Software distributed under the License is distributed on an "AS IS" basis,
11 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
12 * for the specific language governing rights and limitations under the License.
13 *
14 * The Original Code is 'iText, a free JAVA-PDF library'.
15 *
16 * The Initial Developer of the Original Code is Bruno Lowagie. Portions created by
17 * the Initial Developer are Copyright (C) 1999, 2000, 2001, 2002 by Bruno Lowagie.
18 * All Rights Reserved.
19 * Co-Developer of the code is Paulo Soares. Portions created by the Co-Developer
20 * are Copyright (C) 2000, 2001, 2002 by Paulo Soares. All Rights Reserved.
21 *
22 * Contributor(s): all the names of the contributors are added in the source code
23 * where applicable.
24 *
25 * Alternatively, the contents of this file may be used under the terms of the
26 * LGPL license (the "GNU LIBRARY GENERAL PUBLIC LICENSE"), in which case the
27 * provisions of LGPL are applicable instead of those above. If you wish to
28 * allow use of your version of this file only under the terms of the LGPL
29 * License and not to allow others to use your version of this file under
30 * the MPL, indicate your decision by deleting the provisions above and
31 * replace them with the notice and other provisions required by the LGPL.
32 * If you do not delete the provisions above, a recipient may use your version
33 * of this file under either the MPL or the GNU LIBRARY GENERAL PUBLIC LICENSE.
34 *
35 * This library is free software; you can redistribute it and/or modify it
36 * under the terms of the MPL as stated above or under the terms of the GNU
37 * Library General Public License as published by the Free Software Foundation;
38 * either version 2 of the License, or any later version.
39 *
40 * This library is distributed in the hope that it will be useful, but WITHOUT
41 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
42 * FOR A PARTICULAR PURPOSE. See the GNU Library general Public License for more
43 * details.
44 *
45 * If you didn't download this code from the following link, you should check if
46 * you aren't using an obsolete version:
47 * http://www.lowagie.com/iText/
48 */
49
50 package com.lowagie.text.pdf;
51
52 import com.lowagie.text.ExceptionConverter;
53 import com.lowagie.text.Image;
54
55 /**
56 * <CODE>PdfFont</CODE> is the Pdf Font object.
57 * <P>
58 * Limitation: in this class only base 14 Type 1 fonts (courier, courier bold, courier oblique,
59 * courier boldoblique, helvetica, helvetica bold, helvetica oblique, helvetica boldoblique,
60 * symbol, times roman, times bold, times italic, times bolditalic, zapfdingbats) and their
61 * standard encoding (standard, MacRoman, (MacExpert,) WinAnsi) are supported.<BR>
62 * This object is described in the 'Portable Document Format Reference Manual version 1.3'
63 * section 7.7 (page 198-203).
64 *
65 * @see PdfName
66 * @see PdfDictionary
67 * @see BadPdfFormatException
68 */
69
70 class PdfFont implements Comparable {
71
72
73 /** the font metrics. */
74 private BaseFont font;
75
76 /** the size. */
77 private float size;
78
79 /** an image. */
80 protected Image image;
81
82 protected float hScale = 1;
83
84 // constructors
85
86 PdfFont(BaseFont bf, float size) {
87 this.size = size;
88 font = bf;
89 }
90
91 // methods
92
93 /**
94 * Compares this <CODE>PdfFont</CODE> with another
95 *
96 * @param object the other <CODE>PdfFont</CODE>
97 * @return a value
98 */
99
100 public int compareTo(Object object) {
101 if (image != null)
102 return 0;
103 if (object == null) {
104 return -1;
105 }
106 PdfFont pdfFont;
107 try {
108 pdfFont = (PdfFont) object;
109 if (font != pdfFont.font) {
110 return 1;
111 }
112 if (this.size() != pdfFont.size()) {
113 return 2;
114 }
115 return 0;
116 }
117 catch(ClassCastException cce) {
118 return -2;
119 }
120 }
121
122 /**
123 * Returns the size of this font.
124 *
125 * @return a size
126 */
127
128 float size() {
129 if (image == null)
130 return size;
131 else {
132 return image.getScaledHeight();
133 }
134 }
135
136 /**
137 * Returns the approximative width of 1 character of this font.
138 *
139 * @return a width in Text Space
140 */
141
142 float width() {
143 return width(' ');
144 }
145
146 /**
147 * Returns the width of a certain character of this font.
148 *
149 * @param character a certain character
150 * @return a width in Text Space
151 */
152
153 float width(int character) {
154 if (image == null)
155 return font.getWidthPoint(character, size) * hScale;
156 else
157 return image.getScaledWidth();
158 }
159
160 float width(String s) {
161 if (image == null)
162 return font.getWidthPoint(s, size) * hScale;
163 else
164 return image.getScaledWidth();
165 }
166
167 BaseFont getFont() {
168 return font;
169 }
170
171 void setImage(Image image) {
172 this.image = image;
173 }
174
175 static PdfFont getDefaultFont() {
176 try {
177 BaseFont bf = BaseFont.createFont(BaseFont.HELVETICA, BaseFont.WINANSI, false);
178 return new PdfFont(bf, 12);
179 }
180 catch (Exception ee) {
181 throw new ExceptionConverter(ee);
182 }
183 }
184 void setHorizontalScaling(float hScale) {
185 this.hScale = hScale;
186 }
187 }
188