Module platform

Class DialTextAnnotation

java.lang.Object
org.jfree.chart.plot.dial.AbstractDialLayer
org.jfree.chart.plot.dial.DialTextAnnotation
All Implemented Interfaces:
Serializable, Cloneable, DialLayer, PublicCloneable

public class DialTextAnnotation extends AbstractDialLayer implements DialLayer, Cloneable, PublicCloneable, Serializable
A text annotation for a DialPlot.
See Also:
  • Constructor Details

    • DialTextAnnotation

      public DialTextAnnotation(String label)
      Creates a new instance of DialTextAnnotation.
      Parameters:
      label - the label (null not permitted).
  • Method Details

    • getLabel

      public String getLabel()
      Returns the label text.
      Returns:
      The label text (never null).
      See Also:
    • setLabel

      public void setLabel(String label)
      Sets the label and sends a DialLayerChangeEvent to all registered listeners.
      Parameters:
      label - the label (null not permitted).
      See Also:
    • getFont

      public Font getFont()
      Returns the font used to display the label.
      Returns:
      The font (never null).
      See Also:
    • setFont

      public void setFont(Font font)
      Sets the font used to display the label and sends a DialLayerChangeEvent to all registered listeners.
      Parameters:
      font - the font (null not permitted).
      See Also:
    • getPaint

      public Paint getPaint()
      Returns the paint used to display the label.
      Returns:
      The paint (never null).
      See Also:
    • setPaint

      public void setPaint(Paint paint)
      Sets the paint used to display the label and sends a DialLayerChangeEvent to all registered listeners.
      Parameters:
      paint - the paint (null not permitted).
      See Also:
    • getAngle

      public double getAngle()
      Returns the angle used to calculate the anchor point.
      Returns:
      The angle (in degrees).
      See Also:
    • setAngle

      public void setAngle(double angle)
      Sets the angle used to calculate the anchor point and sends a DialLayerChangeEvent to all registered listeners.
      Parameters:
      angle - the angle (in degrees).
      See Also:
    • getRadius

      public double getRadius()
      Returns the radius used to calculate the anchor point. This is specified as a percentage relative to the dial's framing rectangle.
      Returns:
      The radius.
      See Also:
    • setRadius

      public void setRadius(double radius)
      Sets the radius used to calculate the anchor point and sends a DialLayerChangeEvent to all registered listeners.
      Parameters:
      radius - the radius (as a percentage of the dial's framing rectangle).
      See Also:
    • getAnchor

      public TextAnchor getAnchor()
      Returns the text anchor point that will be aligned to the position specified by getAngle() and getRadius().
      Returns:
      The anchor point.
      See Also:
    • setAnchor

      public void setAnchor(TextAnchor anchor)
      Sets the text anchor point and sends a DialLayerChangeEvent to all registered listeners.
      Parameters:
      anchor - the anchor point (null not permitted).
      See Also:
    • isClippedToWindow

      public boolean isClippedToWindow()
      Returns true to indicate that this layer should be clipped within the dial window.
      Specified by:
      isClippedToWindow in interface DialLayer
      Returns:
      true.
    • draw

      public void draw(Graphics2D g2, DialPlot plot, Rectangle2D frame, Rectangle2D view)
      Draws the background to the specified graphics device. If the dial frame specifies a window, the clipping region will already have been set to this window before this method is called.
      Specified by:
      draw in interface DialLayer
      Parameters:
      g2 - the graphics device (null not permitted).
      plot - the plot (ignored here).
      frame - the dial frame (ignored here).
      view - the view rectangle (null not permitted).
    • equals

      public boolean equals(Object obj)
      Tests this instance for equality with an arbitrary object.
      Overrides:
      equals in class AbstractDialLayer
      Parameters:
      obj - the object (null permitted).
      Returns:
      A boolean.
    • hashCode

      public int hashCode()
      Returns a hash code for this instance.
      Overrides:
      hashCode in class AbstractDialLayer
      Returns:
      The hash code.
    • clone

      public Object clone() throws CloneNotSupportedException
      Returns a clone of this instance.
      Specified by:
      clone in interface PublicCloneable
      Overrides:
      clone in class AbstractDialLayer
      Returns:
      The clone.
      Throws:
      CloneNotSupportedException - if some attribute of this instance cannot be cloned.