Class TextBox

java.lang.Object
org.jfree.chart.text.TextBox
All Implemented Interfaces:
Serializable
public class TextBox extends Object implements Serializable
A box containing a text block.
See Also:

  • Field Details

    • serialVersionUID

      private static final long serialVersionUID
      For serialization.
      See Also:

    • outlinePaint

      private transient Paint outlinePaint
      The outline paint.

    • outlineStroke

      private transient Stroke outlineStroke
      The outline stroke.

    • interiorGap

      private RectangleInsets interiorGap
      The interior space.

    • backgroundPaint

      private transient Paint backgroundPaint
      The background paint.

    • shadowPaint

      private transient Paint shadowPaint
      The shadow paint.

    • shadowXOffset

      private double shadowXOffset
      The shadow x-offset.

    • shadowYOffset

      private double shadowYOffset
      The shadow y-offset.

    • textBlock

      private TextBlock textBlock
      The text block.

  • Constructor Details

    • TextBox

      public TextBox()
      Creates an empty text box.

    • TextBox

      public TextBox(String text)
      Creates a text box.
      Parameters:
      text - the text.

    • TextBox

      public TextBox(TextBlock block)
      Creates a new text box.
      Parameters:
      block - the text block.

  • Method Details

    • getOutlinePaint

      public Paint getOutlinePaint()
      Returns the outline paint.
      Returns:
      The outline paint.

    • setOutlinePaint

      public void setOutlinePaint(Paint paint)
      Sets the outline paint.
      Parameters:
      paint - the paint.

    • getOutlineStroke

      public Stroke getOutlineStroke()
      Returns the outline stroke.
      Returns:
      The outline stroke.

    • setOutlineStroke

      public void setOutlineStroke(Stroke stroke)
      Sets the outline stroke.
      Parameters:
      stroke - the stroke.

    • getInteriorGap

      public RectangleInsets getInteriorGap()
      Returns the interior gap.
      Returns:
      The interior gap.

    • setInteriorGap

      public void setInteriorGap(RectangleInsets gap)
      Sets the interior gap.
      Parameters:
      gap - the gap.

    • getBackgroundPaint

      public Paint getBackgroundPaint()
      Returns the background paint.
      Returns:
      The background paint.

    • setBackgroundPaint

      public void setBackgroundPaint(Paint paint)
      Sets the background paint.
      Parameters:
      paint - the paint.

    • getShadowPaint

      public Paint getShadowPaint()
      Returns the shadow paint.
      Returns:
      The shadow paint.

    • setShadowPaint

      public void setShadowPaint(Paint paint)
      Sets the shadow paint.
      Parameters:
      paint - the paint.

    • getShadowXOffset

      public double getShadowXOffset()
      Returns the x-offset for the shadow effect.
      Returns:
      The offset.

    • setShadowXOffset

      public void setShadowXOffset(double offset)
      Sets the x-offset for the shadow effect.
      Parameters:
      offset - the offset (in Java2D units).

    • getShadowYOffset

      public double getShadowYOffset()
      Returns the y-offset for the shadow effect.
      Returns:
      The offset.

    • setShadowYOffset

      public void setShadowYOffset(double offset)
      Sets the y-offset for the shadow effect.
      Parameters:
      offset - the offset (in Java2D units).

    • getTextBlock

      public TextBlock getTextBlock()
      Returns the text block.
      Returns:
      The text block.

    • setTextBlock

      public void setTextBlock(TextBlock block)
      Sets the text block.
      Parameters:
      block - the block.

    • draw

      public void draw(Graphics2D g2, float x, float y, RectangleAnchor anchor)
      Draws the text box.
      Parameters:
      g2 - the graphics device.
      x - the x-coordinate.
      y - the y-coordinate.
      anchor - the anchor point.

    • getHeight

      public double getHeight(Graphics2D g2)
      Returns the height of the text box.
      Parameters:
      g2 - the graphics device.
      Returns:
      The height (in Java2D units).

    • equals

      public boolean equals(Object obj)
      Tests this object for equality with an arbitrary object.
      Overrides:
      equals in class Object
      Parameters:
      obj - the object to test against (null permitted).
      Returns:
      A boolean.

    • hashCode

      public int hashCode()
      Returns a hash code for this object.
      Overrides:
      hashCode in class Object
      Returns:
      A hash code.

    • writeObject

      private void writeObject(ObjectOutputStream stream) throws IOException
      Provides serialization support.
      Parameters:
      stream - the output stream.
      Throws:
      IOException - if there is an I/O error.

    • readObject

      private void readObject(ObjectInputStream stream) throws IOException, ClassNotFoundException
      Provides serialization support.
      Parameters:
      stream - the input stream.
      Throws:
      IOException - if there is an I/O error.
      ClassNotFoundException - if there is a classpath problem.