01: /**
02: * ===========================================
03: * JFreeReport : a free Java reporting library
04: * ===========================================
05: *
06: * Project Info: http://reporting.pentaho.org/
07: *
08: * (C) Copyright 2001-2007, by Object Refinery Ltd, Pentaho Corporation and Contributors.
09: *
10: * This library is free software; you can redistribute it and/or modify it under the terms
11: * of the GNU Lesser General Public License as published by the Free Software Foundation;
12: * either version 2.1 of the License, or (at your option) any later version.
13: *
14: * This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
15: * without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
16: * See the GNU Lesser General Public License for more details.
17: *
18: * You should have received a copy of the GNU Lesser General Public License along with this
19: * library; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330,
20: * Boston, MA 02111-1307, USA.
21: *
22: * [Java is a trademark or registered trademark of Sun Microsystems, Inc.
23: * in the United States and other countries.]
24: *
25: * ------------
26: * SizeCalculator.java
27: * ------------
28: * (C) Copyright 2001-2007, by Object Refinery Ltd, Pentaho Corporation and Contributors.
29: */package org.jfree.report.layout;
30:
31: /**
32: * The interface for an class that is able to calculate the width of a given string, and
33: * the height of a line of text. The calculations rely on state information (e.g. font
34: * size, graphics device, etc) maintained by the calculator.
35: * <p/>
36: * Every {@link org.jfree.report.layout.LayoutSupport} can create an instance of a class
37: * that implements this interface, via the {@link org.jfree.report.layout.LayoutSupport#createTextSizeCalculator}
38: * method.
39: *
40: * @author Thomas Morgner
41: */
42: public interface SizeCalculator {
43: /**
44: * @deprecated This config-key should not be declared here.
45: */
46: public static final String USE_MAX_CHAR_SIZE = "org.jfree.report.layout.fontrenderer.UseMaxCharBounds";
47:
48: /**
49: * @deprecated This config-key is no longer used.
50: */
51: public static final String CLIP_TEXT = "org.jfree.report.layout.fontrenderer.ClipText";
52:
53: /**
54: * Calculates the width of a <code>String<code> in the current <code>Graphics</code>
55: * context.
56: *
57: * @param text the text.
58: * @param lineStartPos the start position of the substring to be measured.
59: * @param endPos the position of the last character to be measured.
60: * @return the width of the string in Java2D units.
61: */
62: public float getStringWidth(String text, int lineStartPos,
63: int endPos);
64:
65: /**
66: * Returns the line height. This includes the font's ascent, descent and leading.
67: *
68: * @return the line height.
69: */
70: public float getLineHeight();
71:
72: }
|