public class

StandardDialScale

extends AbstractDialLayer
implements Serializable Cloneable DialScale
java.lang.Object
   ↳ org.jfree.chart.plot.dial.AbstractDialLayer
     ↳ org.jfree.chart.plot.dial.StandardDialScale

Class Overview

A scale for a DialPlot.

Summary

Public Constructors
StandardDialScale()
Creates a new instance of DialScale.
StandardDialScale(double lowerBound, double upperBound, double startAngle, double extent, double majorTickIncrement, int minorTickCount)
Creates a new instance.
Public Methods
double angleToValue(double angle)
Converts the given angle to a data value, based on this scale.
Object clone()
Returns a clone of this instance.
void draw(Graphics2D g2, DialPlot plot, Rectangle2D frame, Rectangle2D view)
Draws the scale on the dial plot.
boolean equals(Object obj)
Tests this StandardDialScale for equality with an arbitrary object.
double getExtent()
Returns the extent.
boolean getFirstTickLabelVisible()
Returns a flag that controls whether or not the first tick label is visible.
double getLowerBound()
Returns the lower bound for the scale.
double getMajorTickIncrement()
Returns the increment (in data units) between major tick labels.
double getMajorTickLength()
Returns the length factor for the major tick marks.
Paint getMajorTickPaint()
Returns the major tick paint.
Stroke getMajorTickStroke()
Returns the stroke used to draw the major tick marks.
int getMinorTickCount()
Returns the number of minor tick marks between major tick marks.
double getMinorTickLength()
Returns the length factor for the minor tick marks.
Paint getMinorTickPaint()
Returns the paint used to draw the minor tick marks.
Stroke getMinorTickStroke()
Returns the stroke used to draw the minor tick marks.
double getStartAngle()
Returns the start angle for the scale (in degrees using the same orientation as Java's Arc2D class).
Font getTickLabelFont()
Returns the font used to draw the tick labels.
NumberFormat getTickLabelFormatter()
Returns the number formatter used to convert the tick label values to strings.
double getTickLabelOffset()
Returns the tick label offset.
Paint getTickLabelPaint()
Returns the paint used to draw the tick labels.
boolean getTickLabelsVisible()
Returns true if the tick labels should be displayed, and false otherwise.
double getTickRadius()
Returns the radius (as a percentage of the maximum space available) of the outer limit of the tick marks.
double getUpperBound()
Returns the upper bound for the scale.
int hashCode()
Returns a hash code for this instance.
boolean isClippedToWindow()
Returns true to indicate that this layer should be clipped within the dial window.
void setExtent(double extent)
Sets the extent and sends a DialLayerChangeEvent to all registered listeners.
void setFirstTickLabelVisible(boolean visible)
Sets a flag that controls whether or not the first tick label is visible, and sends a DialLayerChangeEvent to all registered listeners.
void setLowerBound(double lower)
Sets the lower bound for the scale and sends a DialLayerChangeEvent to all registered listeners.
void setMajorTickIncrement(double increment)
Sets the increment (in data units) between major tick labels and sends a DialLayerChangeEvent to all registered listeners.
void setMajorTickLength(double length)
Sets the length factor for the major tick marks and sends a DialLayerChangeEvent to all registered listeners.
void setMajorTickPaint(Paint paint)
Sets the major tick paint and sends a DialLayerChangeEvent to all registered listeners.
void setMajorTickStroke(Stroke stroke)
Sets the stroke used to draw the major tick marks and sends a DialLayerChangeEvent to all registered listeners.
void setMinorTickCount(int count)
Sets the number of minor tick marks between major tick marks and sends a DialLayerChangeEvent to all registered listeners.
void setMinorTickLength(double length)
Sets the length factor for the minor tick marks and sends a DialLayerChangeEvent to all registered listeners.
void setMinorTickPaint(Paint paint)
Sets the paint used to draw the minor tick marks and sends a DialLayerChangeEvent to all registered listeners.
void setMinorTickStroke(Stroke stroke)
Sets the stroke used to draw the minor tick marks and sends a DialLayerChangeEvent to all registered listeners.
void setStartAngle(double angle)
Sets the start angle for the scale and sends a DialLayerChangeEvent to all registered listeners.
void setTickLabelFont(Font font)
Sets the font used to display the tick labels and sends a DialLayerChangeEvent to all registered listeners.
void setTickLabelFormatter(NumberFormat formatter)
Sets the number formatter used to convert the tick label values to strings, and sends a DialLayerChangeEvent to all registered listeners.
void setTickLabelOffset(double offset)
Sets the tick label offset and sends a DialLayerChangeEvent to all registered listeners.
void setTickLabelPaint(Paint paint)
Sets the paint used to draw the tick labels and sends a DialLayerChangeEvent to all registered listeners.
void setTickLabelsVisible(boolean visible)
Sets the flag that controls whether or not the tick labels are displayed, and sends a DialLayerChangeEvent to all registered listeners.
void setTickRadius(double radius)
Sets the tick radius and sends a DialLayerChangeEvent to all registered listeners.
void setUpperBound(double upper)
Sets the upper bound for the scale and sends a DialLayerChangeEvent to all registered listeners.
double valueToAngle(double value)
Converts a data value to an angle against this scale.
[Expand]
Inherited Methods
From class org.jfree.chart.plot.dial.AbstractDialLayer
From class java.lang.Object
From interface org.jfree.chart.plot.dial.DialLayer
From interface org.jfree.chart.plot.dial.DialScale

Public Constructors

public StandardDialScale ()

Creates a new instance of DialScale.

public StandardDialScale (double lowerBound, double upperBound, double startAngle, double extent, double majorTickIncrement, int minorTickCount)

Creates a new instance.

Parameters
lowerBound the lower bound of the scale.
upperBound the upper bound of the scale.
startAngle the start angle (in degrees, using the same orientation as Java's Arc2D class).
extent the extent (in degrees, counter-clockwise).
majorTickIncrement the interval between major tick marks
minorTickCount the number of minor ticks between major tick marks.

Public Methods

public double angleToValue (double angle)

Converts the given angle to a data value, based on this scale.

Parameters
angle the angle.
Returns
  • The data value.
See Also

public Object clone ()

Returns a clone of this instance.

Returns
  • A clone.
Throws
CloneNotSupportedException if this instance is not cloneable.

public void draw (Graphics2D g2, DialPlot plot, Rectangle2D frame, Rectangle2D view)

Draws the scale on the dial plot.

Parameters
g2 the graphics target (null not permitted).
plot the dial plot (null not permitted).
frame the reference frame that is used to construct the geometry of the plot (null not permitted).
view the visible part of the plot (null not permitted).

public boolean equals (Object obj)

Tests this StandardDialScale for equality with an arbitrary object.

Parameters
obj the object (null permitted).
Returns
  • A boolean.

public double getExtent ()

Returns the extent.

Returns
  • The extent.
See Also

public boolean getFirstTickLabelVisible ()

Returns a flag that controls whether or not the first tick label is visible.

Returns
  • A boolean.
See Also

public double getLowerBound ()

Returns the lower bound for the scale.

Returns
  • The lower bound for the scale.
See Also

public double getMajorTickIncrement ()

Returns the increment (in data units) between major tick labels.

Returns
  • The increment between major tick labels.
See Also

public double getMajorTickLength ()

Returns the length factor for the major tick marks. The value is subtracted from the tick radius to determine the inner starting point for the tick marks.

Returns
  • The length factor.
See Also

public Paint getMajorTickPaint ()

Returns the major tick paint.

Returns
  • The major tick paint (never null).
See Also

public Stroke getMajorTickStroke ()

Returns the stroke used to draw the major tick marks.

Returns
  • The stroke (never null).
See Also

public int getMinorTickCount ()

Returns the number of minor tick marks between major tick marks.

Returns
  • The number of minor tick marks between major tick marks.
See Also

public double getMinorTickLength ()

Returns the length factor for the minor tick marks. The value is subtracted from the tick radius to determine the inner starting point for the tick marks.

Returns
  • The length factor.
See Also

public Paint getMinorTickPaint ()

Returns the paint used to draw the minor tick marks.

Returns
  • The paint (never null).
See Also

public Stroke getMinorTickStroke ()

Returns the stroke used to draw the minor tick marks.

Returns
  • The paint (never null).
See Also

public double getStartAngle ()

Returns the start angle for the scale (in degrees using the same orientation as Java's Arc2D class).

Returns
  • The start angle.
See Also

public Font getTickLabelFont ()

Returns the font used to draw the tick labels.

Returns
  • The font (never null).
See Also

public NumberFormat getTickLabelFormatter ()

Returns the number formatter used to convert the tick label values to strings.

Returns
  • The formatter (never null).
See Also

public double getTickLabelOffset ()

Returns the tick label offset.

Returns
  • The tick label offset.
See Also

public Paint getTickLabelPaint ()

Returns the paint used to draw the tick labels.

Returns
  • The paint (null not permitted).
See Also

public boolean getTickLabelsVisible ()

Returns true if the tick labels should be displayed, and false otherwise.

Returns
  • A boolean.
See Also

public double getTickRadius ()

Returns the radius (as a percentage of the maximum space available) of the outer limit of the tick marks.

Returns
  • The tick radius.
See Also

public double getUpperBound ()

Returns the upper bound for the scale.

Returns
  • The upper bound for the scale.
See Also

public int hashCode ()

Returns a hash code for this instance.

Returns
  • A hash code.

public boolean isClippedToWindow ()

Returns true to indicate that this layer should be clipped within the dial window.

Returns
  • true.

public void setExtent (double extent)

Sets the extent and sends a DialLayerChangeEvent to all registered listeners.

Parameters
extent the extent.
See Also

public void setFirstTickLabelVisible (boolean visible)

Sets a flag that controls whether or not the first tick label is visible, and sends a DialLayerChangeEvent to all registered listeners.

Parameters
visible the new flag value.
See Also

public void setLowerBound (double lower)

Sets the lower bound for the scale and sends a DialLayerChangeEvent to all registered listeners.

Parameters
lower the lower bound.
See Also

public void setMajorTickIncrement (double increment)

Sets the increment (in data units) between major tick labels and sends a DialLayerChangeEvent to all registered listeners.

Parameters
increment the increment.
See Also

public void setMajorTickLength (double length)

Sets the length factor for the major tick marks and sends a DialLayerChangeEvent to all registered listeners.

Parameters
length the length.
See Also

public void setMajorTickPaint (Paint paint)

Sets the major tick paint and sends a DialLayerChangeEvent to all registered listeners.

Parameters
paint the paint (null not permitted).
See Also

public void setMajorTickStroke (Stroke stroke)

Sets the stroke used to draw the major tick marks and sends a DialLayerChangeEvent to all registered listeners.

Parameters
stroke the stroke (null not permitted).
See Also

public void setMinorTickCount (int count)

Sets the number of minor tick marks between major tick marks and sends a DialLayerChangeEvent to all registered listeners.

Parameters
count the count.
See Also

public void setMinorTickLength (double length)

Sets the length factor for the minor tick marks and sends a DialLayerChangeEvent to all registered listeners.

Parameters
length the length.
See Also

public void setMinorTickPaint (Paint paint)

Sets the paint used to draw the minor tick marks and sends a DialLayerChangeEvent to all registered listeners.

Parameters
paint the paint (null not permitted).
See Also

public void setMinorTickStroke (Stroke stroke)

Sets the stroke used to draw the minor tick marks and sends a DialLayerChangeEvent to all registered listeners.

Parameters
stroke the stroke (null not permitted).
See Also

public void setStartAngle (double angle)

Sets the start angle for the scale and sends a DialLayerChangeEvent to all registered listeners.

Parameters
angle the angle (in degrees).
See Also

public void setTickLabelFont (Font font)

Sets the font used to display the tick labels and sends a DialLayerChangeEvent to all registered listeners.

Parameters
font the font (null not permitted).
See Also

public void setTickLabelFormatter (NumberFormat formatter)

Sets the number formatter used to convert the tick label values to strings, and sends a DialLayerChangeEvent to all registered listeners.

Parameters
formatter the formatter (null not permitted).
See Also

public void setTickLabelOffset (double offset)

Sets the tick label offset and sends a DialLayerChangeEvent to all registered listeners.

Parameters
offset the offset.
See Also

public void setTickLabelPaint (Paint paint)

Sets the paint used to draw the tick labels and sends a DialLayerChangeEvent to all registered listeners.

Parameters
paint the paint (null not permitted).

public void setTickLabelsVisible (boolean visible)

Sets the flag that controls whether or not the tick labels are displayed, and sends a DialLayerChangeEvent to all registered listeners.

Parameters
visible the new flag value.
See Also

public void setTickRadius (double radius)

Sets the tick radius and sends a DialLayerChangeEvent to all registered listeners.

Parameters
radius the radius.
See Also

public void setUpperBound (double upper)

Sets the upper bound for the scale and sends a DialLayerChangeEvent to all registered listeners.

Parameters
upper the upper bound.
See Also

public double valueToAngle (double value)

Converts a data value to an angle against this scale.

Parameters
value the data value.
Returns
  • The angle (in degrees, using the same specification as Java's Arc2D class).
See Also