| java.lang.Object org.jfree.text.TextUtilities
TextUtilities | public class TextUtilities (Code) | | Some utility methods for working with text.
author: David Gilbert |
Field Summary | |
final protected static LogContext | logger Access to logging facilities. |
Method Summary | |
public static Shape | calculateRotatedStringBounds(String text, Graphics2D g2, float x, float y, TextAnchor textAnchor, double angle, TextAnchor rotationAnchor) Returns a shape that represents the bounds of the string after the
specified rotation has been applied.
Parameters: text - the text (null permitted). Parameters: g2 - the graphics device. Parameters: x - the x coordinate for the anchor point. Parameters: y - the y coordinate for the anchor point. Parameters: textAnchor - the text anchor. Parameters: angle - the angle. Parameters: rotationAnchor - the rotation anchor. | public static Shape | calculateRotatedStringBounds(String text, Graphics2D g2, float textX, float textY, double angle, float rotateX, float rotateY) Returns a shape that represents the bounds of the string after the
specified rotation has been applied.
Parameters: text - the text (null permitted). Parameters: g2 - the graphics device. Parameters: textX - the x coordinate for the text. Parameters: textY - the y coordinate for the text. Parameters: angle - the angle. Parameters: rotateX - the x coordinate for the rotation point. Parameters: rotateY - the y coordinate for the rotation point. | public static TextBlock | createTextBlock(String text, Font font, Paint paint) Creates a
TextBlock from a String . | public static TextBlock | createTextBlock(String text, Font font, Paint paint, float maxWidth, TextMeasurer measurer) Creates a new text block from the given string, breaking the
text into lines so that the maxWidth value is
respected.
Parameters: text - the text. Parameters: font - the font. Parameters: paint - the paint. Parameters: maxWidth - the maximum width for each line. Parameters: measurer - the text measurer. | public static TextBlock | createTextBlock(String text, Font font, Paint paint, float maxWidth, int maxLines, TextMeasurer measurer) Creates a new text block from the given string, breaking the
text into lines so that the maxWidth value is
respected.
Parameters: text - the text. Parameters: font - the font. Parameters: paint - the paint. Parameters: maxWidth - the maximum width for each line. Parameters: maxLines - the maximum number of lines. Parameters: measurer - the text measurer. | public static Rectangle2D | drawAlignedString(String text, Graphics2D g2, float x, float y, TextAnchor anchor) Draws a string such that the specified anchor point is aligned to the
given (x, y) location.
Parameters: text - the text. Parameters: g2 - the graphics device. Parameters: x - the x coordinate (Java 2D). Parameters: y - the y coordinate (Java 2D). Parameters: anchor - the anchor location. | public static void | drawRotatedString(String text, Graphics2D g2, double angle, float x, float y) A utility method for drawing rotated text. | public static void | drawRotatedString(String text, Graphics2D g2, float textX, float textY, double angle, float rotateX, float rotateY) A utility method for drawing rotated text. | public static void | drawRotatedString(String text, Graphics2D g2, float x, float y, TextAnchor textAnchor, double angle, float rotationX, float rotationY) Draws a string that is aligned by one anchor point and rotated about
another anchor point. | public static void | drawRotatedString(String text, Graphics2D g2, float x, float y, TextAnchor textAnchor, double angle, TextAnchor rotationAnchor) Draws a string that is aligned by one anchor point and rotated about
another anchor point. | public static Rectangle2D | getTextBounds(String text, Graphics2D g2, FontMetrics fm) Returns the bounds for the specified text.
Parameters: text - the text (null permitted). Parameters: g2 - the graphics context (not null ). Parameters: fm - the font metrics (not null ). | public static boolean | getUseFontMetricsGetStringBounds() Returns the flag that controls whether the FontMetrics.getStringBounds()
method is used or not. | public static boolean | isUseDrawRotatedStringWorkaround() | public static void | setUseDrawRotatedStringWorkaround(boolean use) Sets the flag that controls whether or not a workaround is used for
drawing rotated strings. | public static void | setUseFontMetricsGetStringBounds(boolean use) Sets the flag that controls whether the FontMetrics.getStringBounds()
method is used or not. |
logger | final protected static LogContext logger(Code) | | Access to logging facilities.
|
calculateRotatedStringBounds | public static Shape calculateRotatedStringBounds(String text, Graphics2D g2, float x, float y, TextAnchor textAnchor, double angle, TextAnchor rotationAnchor)(Code) | | Returns a shape that represents the bounds of the string after the
specified rotation has been applied.
Parameters: text - the text (null permitted). Parameters: g2 - the graphics device. Parameters: x - the x coordinate for the anchor point. Parameters: y - the y coordinate for the anchor point. Parameters: textAnchor - the text anchor. Parameters: angle - the angle. Parameters: rotationAnchor - the rotation anchor. The bounds (possibly null ). |
calculateRotatedStringBounds | public static Shape calculateRotatedStringBounds(String text, Graphics2D g2, float textX, float textY, double angle, float rotateX, float rotateY)(Code) | | Returns a shape that represents the bounds of the string after the
specified rotation has been applied.
Parameters: text - the text (null permitted). Parameters: g2 - the graphics device. Parameters: textX - the x coordinate for the text. Parameters: textY - the y coordinate for the text. Parameters: angle - the angle. Parameters: rotateX - the x coordinate for the rotation point. Parameters: rotateY - the y coordinate for the rotation point. The bounds (null if text is null or has zero length). |
createTextBlock | public static TextBlock createTextBlock(String text, Font font, Paint paint)(Code) | | Creates a
TextBlock from a String . Line breaks
are added where the String contains '\n' characters.
Parameters: text - the text. Parameters: font - the font. Parameters: paint - the paint. A text block. |
createTextBlock | public static TextBlock createTextBlock(String text, Font font, Paint paint, float maxWidth, TextMeasurer measurer)(Code) | | Creates a new text block from the given string, breaking the
text into lines so that the maxWidth value is
respected.
Parameters: text - the text. Parameters: font - the font. Parameters: paint - the paint. Parameters: maxWidth - the maximum width for each line. Parameters: measurer - the text measurer. A text block. |
createTextBlock | public static TextBlock createTextBlock(String text, Font font, Paint paint, float maxWidth, int maxLines, TextMeasurer measurer)(Code) | | Creates a new text block from the given string, breaking the
text into lines so that the maxWidth value is
respected.
Parameters: text - the text. Parameters: font - the font. Parameters: paint - the paint. Parameters: maxWidth - the maximum width for each line. Parameters: maxLines - the maximum number of lines. Parameters: measurer - the text measurer. A text block. |
drawAlignedString | public static Rectangle2D drawAlignedString(String text, Graphics2D g2, float x, float y, TextAnchor anchor)(Code) | | Draws a string such that the specified anchor point is aligned to the
given (x, y) location.
Parameters: text - the text. Parameters: g2 - the graphics device. Parameters: x - the x coordinate (Java 2D). Parameters: y - the y coordinate (Java 2D). Parameters: anchor - the anchor location. The text bounds (adjusted for the text position). |
drawRotatedString | public static void drawRotatedString(String text, Graphics2D g2, double angle, float x, float y)(Code) | | A utility method for drawing rotated text.
A common rotation is -Math.PI/2 which draws text 'vertically' (with the
top of the characters on the left).
Parameters: text - the text. Parameters: g2 - the graphics device. Parameters: angle - the angle of the (clockwise) rotation (in radians). Parameters: x - the x-coordinate. Parameters: y - the y-coordinate. |
drawRotatedString | public static void drawRotatedString(String text, Graphics2D g2, float textX, float textY, double angle, float rotateX, float rotateY)(Code) | | A utility method for drawing rotated text.
A common rotation is -Math.PI/2 which draws text 'vertically' (with the
top of the characters on the left).
Parameters: text - the text. Parameters: g2 - the graphics device. Parameters: textX - the x-coordinate for the text (before rotation). Parameters: textY - the y-coordinate for the text (before rotation). Parameters: angle - the angle of the (clockwise) rotation (in radians). Parameters: rotateX - the point about which the text is rotated. Parameters: rotateY - the point about which the text is rotated. |
drawRotatedString | public static void drawRotatedString(String text, Graphics2D g2, float x, float y, TextAnchor textAnchor, double angle, float rotationX, float rotationY)(Code) | | Draws a string that is aligned by one anchor point and rotated about
another anchor point.
Parameters: text - the text. Parameters: g2 - the graphics device. Parameters: x - the x-coordinate for positioning the text. Parameters: y - the y-coordinate for positioning the text. Parameters: textAnchor - the text anchor. Parameters: angle - the rotation angle. Parameters: rotationX - the x-coordinate for the rotation anchor point. Parameters: rotationY - the y-coordinate for the rotation anchor point. |
drawRotatedString | public static void drawRotatedString(String text, Graphics2D g2, float x, float y, TextAnchor textAnchor, double angle, TextAnchor rotationAnchor)(Code) | | Draws a string that is aligned by one anchor point and rotated about
another anchor point.
Parameters: text - the text. Parameters: g2 - the graphics device. Parameters: x - the x-coordinate for positioning the text. Parameters: y - the y-coordinate for positioning the text. Parameters: textAnchor - the text anchor. Parameters: angle - the rotation angle (in radians). Parameters: rotationAnchor - the rotation anchor. |
getTextBounds | public static Rectangle2D getTextBounds(String text, Graphics2D g2, FontMetrics fm)(Code) | | Returns the bounds for the specified text.
Parameters: text - the text (null permitted). Parameters: g2 - the graphics context (not null ). Parameters: fm - the font metrics (not null ). The text bounds (null if the text argument is null ). |
getUseFontMetricsGetStringBounds | public static boolean getUseFontMetricsGetStringBounds()(Code) | | Returns the flag that controls whether the FontMetrics.getStringBounds()
method is used or not. If you are having trouble with label alignment
or positioning, try changing the value of this flag.
A boolean. |
isUseDrawRotatedStringWorkaround | public static boolean isUseDrawRotatedStringWorkaround()(Code) | | |
setUseDrawRotatedStringWorkaround | public static void setUseDrawRotatedStringWorkaround(boolean use)(Code) | | Sets the flag that controls whether or not a workaround is used for
drawing rotated strings. The related bug is on Sun's bug parade
(id 4312117) and the workaround involves using a TextLayout
instance to draw the text instead of calling the
drawString() method in the Graphics2D class.
Parameters: use - the new flag value. |
setUseFontMetricsGetStringBounds | public static void setUseFontMetricsGetStringBounds(boolean use)(Code) | | Sets the flag that controls whether the FontMetrics.getStringBounds()
method is used or not. If you are having trouble with label alignment
or positioning, try changing the value of this flag.
Parameters: use - the flag. |
|
|