org.jfree.text

## Class TextUtilities

- java.lang.Object
- - org.jfree.text.TextUtilities

-     public class TextUtilities
      extends java.lang.Object

  Some utility methods for working with text.
  Author:
    David Gilbert

- - ### Field Summary

    Fields
    Modifier and Type | Field and Description
    --- | ---
    `protected static LogContext` | `logger` Access to logging facilities.

  - ### Method Summary

    Methods
    Modifier and Type | Method and Description
    --- | ---
    `static java.awt.Shape` | `calculateRotatedStringBounds(java.lang.String text, java.awt.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.
    `static java.awt.Shape` | `calculateRotatedStringBounds(java.lang.String text, java.awt.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.
    `static TextBlock` | `createTextBlock(java.lang.String text, java.awt.Font font, java.awt.Paint paint)` Creates a `TextBlock` from a `String`.
    `static TextBlock` | `createTextBlock(java.lang.String text, java.awt.Font font, java.awt.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.
    `static TextBlock` | `createTextBlock(java.lang.String text, java.awt.Font font, java.awt.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.
    `static java.awt.geom.Rectangle2D` | `drawAlignedString(java.lang.String text, java.awt.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.
    `static void` | `drawRotatedString(java.lang.String text, java.awt.Graphics2D g2, double angle, float x, float y)` A utility method for drawing rotated text.
    `static void` | `drawRotatedString(java.lang.String text, java.awt.Graphics2D g2, float textX, float textY, double angle, float rotateX, float rotateY)` A utility method for drawing rotated text.
    `static void` | `drawRotatedString(java.lang.String text, java.awt.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.
    `static void` | `drawRotatedString(java.lang.String text, java.awt.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.
    `static java.awt.geom.Rectangle2D` | `getTextBounds(java.lang.String text, java.awt.Graphics2D g2, java.awt.FontMetrics fm)` Returns the bounds for the specified text.
    `static boolean` | `getUseFontMetricsGetStringBounds()` Returns the flag that controls whether the FontMetrics.getStringBounds() method is used or not.
    `static boolean` | `isUseDrawRotatedStringWorkaround()` Returns the flag that controls whether or not a workaround is used for drawing rotated strings.
    `static void` | `setUseDrawRotatedStringWorkaround(boolean use)` Sets the flag that controls whether or not a workaround is used for drawing rotated strings.
    `static void` | `setUseFontMetricsGetStringBounds(boolean use)` Sets the flag that controls whether the FontMetrics.getStringBounds() method is used or not.

    - ### Methods inherited from class java.lang.Object

      `clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

- - ### Field Detail

    - #### logger

          protected static final LogContext logger

      Access to logging facilities.

  - ### Method Detail

    - #### createTextBlock

          public static TextBlock createTextBlock(java.lang.String text,
                                  java.awt.Font font,
                                  java.awt.Paint paint)

      Creates a `TextBlock` from a `String`. Line breaks are added where the `String` contains '\n' characters.
      Parameters:
        `text` - the text.
        `font` - the font.
        `paint` - the paint.
      Returns:
        A text block.

    - #### createTextBlock

          public static TextBlock createTextBlock(java.lang.String text,
                                  java.awt.Font font,
                                  java.awt.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.
        `font` - the font.
        `paint` - the paint.
        `maxWidth` - the maximum width for each line.
        `measurer` - the text measurer.
      Returns:
        A text block.

    - #### createTextBlock

          public static TextBlock createTextBlock(java.lang.String text,
                                  java.awt.Font font,
                                  java.awt.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.
        `font` - the font.
        `paint` - the paint.
        `maxWidth` - the maximum width for each line.
        `maxLines` - the maximum number of lines.
        `measurer` - the text measurer.
      Returns:
        A text block.

    - #### getTextBounds

          public static java.awt.geom.Rectangle2D getTextBounds(java.lang.String text,
                                                java.awt.Graphics2D g2,
                                                java.awt.FontMetrics fm)

      Returns the bounds for the specified text.
      Parameters:
        `text` - the text (`null` permitted).
        `g2` - the graphics context (not `null`).
        `fm` - the font metrics (not `null`).
      Returns:
        The text bounds (`null` if the `text` argument is `null`).

    - #### drawAlignedString

          public static java.awt.geom.Rectangle2D drawAlignedString(java.lang.String text,
                                                    java.awt.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.
        `g2` - the graphics device.
        `x` - the x coordinate (Java 2D).
        `y` - the y coordinate (Java 2D).
        `anchor` - the anchor location.
      Returns:
        The text bounds (adjusted for the text position).

    - #### setUseDrawRotatedStringWorkaround

          public static void setUseDrawRotatedStringWorkaround(boolean use)

      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.

    - #### drawRotatedString

          public static void drawRotatedString(java.lang.String text,
                               java.awt.Graphics2D g2,
                               double angle,
                               float x,
                               float y)

      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.
        `g2` - the graphics device.
        `angle` - the angle of the (clockwise) rotation (in radians).
        `x` - the x-coordinate.
        `y` - the y-coordinate.

    - #### drawRotatedString

          public static void drawRotatedString(java.lang.String text,
                               java.awt.Graphics2D g2,
                               float textX,
                               float textY,
                               double angle,
                               float rotateX,
                               float rotateY)

      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.
        `g2` - the graphics device.
        `textX` - the x-coordinate for the text (before rotation).
        `textY` - the y-coordinate for the text (before rotation).
        `angle` - the angle of the (clockwise) rotation (in radians).
        `rotateX` - the point about which the text is rotated.
        `rotateY` - the point about which the text is rotated.

    - #### drawRotatedString

          public static void drawRotatedString(java.lang.String text,
                               java.awt.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.
      Parameters:
        `text` - the text.
        `g2` - the graphics device.
        `x` - the x-coordinate for positioning the text.
        `y` - the y-coordinate for positioning the text.
        `textAnchor` - the text anchor.
        `angle` - the rotation angle.
        `rotationX` - the x-coordinate for the rotation anchor point.
        `rotationY` - the y-coordinate for the rotation anchor point.

    - #### drawRotatedString

          public static void drawRotatedString(java.lang.String text,
                               java.awt.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.
      Parameters:
        `text` - the text.
        `g2` - the graphics device.
        `x` - the x-coordinate for positioning the text.
        `y` - the y-coordinate for positioning the text.
        `textAnchor` - the text anchor.
        `angle` - the rotation angle (in radians).
        `rotationAnchor` - the rotation anchor.

    - #### calculateRotatedStringBounds

          public static java.awt.Shape calculateRotatedStringBounds(java.lang.String text,
                                                    java.awt.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).
        `g2` - the graphics device.
        `x` - the x coordinate for the anchor point.
        `y` - the y coordinate for the anchor point.
        `textAnchor` - the text anchor.
        `angle` - the angle.
        `rotationAnchor` - the rotation anchor.
      Returns:
        The bounds (possibly `null`).

    - #### calculateRotatedStringBounds

          public static java.awt.Shape calculateRotatedStringBounds(java.lang.String text,
                                                    java.awt.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).
        `g2` - the graphics device.
        `textX` - the x coordinate for the text.
        `textY` - the y coordinate for the text.
        `angle` - the angle.
        `rotateX` - the x coordinate for the rotation point.
        `rotateY` - the y coordinate for the rotation point.
      Returns:
        The bounds (`null` if `text` is null or has zero length).

    - #### getUseFontMetricsGetStringBounds

          public static boolean getUseFontMetricsGetStringBounds()

      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.
      Returns:
        A boolean.

    - #### setUseFontMetricsGetStringBounds

          public static void setUseFontMetricsGetStringBounds(boolean use)

      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.

    - #### isUseDrawRotatedStringWorkaround

          public static boolean isUseDrawRotatedStringWorkaround()

      Returns the flag that controls whether or not a workaround is used for drawing rotated strings.
      Returns:
        A boolean.