org.jfree.chart.axis

Class PeriodAxis

java.lang.Object

org.jfree.chart.axis.Axis

org.jfree.chart.axis.ValueAxis

org.jfree.chart.axis.PeriodAxis

All Implemented Interfaces:

Serializable, Cloneable, org.jfree.util.PublicCloneable

public class PeriodAxis
extends ValueAxis
implements Cloneable, org.jfree.util.PublicCloneable, Serializable

An axis that displays a date scale based on a RegularTimePeriod. This axis works when displayed across the bottom or top of a plot, but is broken for display at the left or right of charts.

See Also:

Serialized Form

Field Summary

Fields inherited from class org.jfree.chart.axis.ValueAxis

DEFAULT_AUTO_RANGE, DEFAULT_AUTO_RANGE_MINIMUM_SIZE, DEFAULT_AUTO_TICK_UNIT_SELECTION, DEFAULT_INVERTED, DEFAULT_LOWER_BOUND, DEFAULT_LOWER_MARGIN, DEFAULT_RANGE, DEFAULT_UPPER_BOUND, DEFAULT_UPPER_MARGIN, MAXIMUM_TICK_COUNT

Fields inherited from class org.jfree.chart.axis.Axis

DEFAULT_AXIS_LABEL_FONT, DEFAULT_AXIS_LABEL_INSETS, DEFAULT_AXIS_LABEL_PAINT, DEFAULT_AXIS_LINE_PAINT, DEFAULT_AXIS_LINE_STROKE, DEFAULT_AXIS_VISIBLE, DEFAULT_TICK_LABEL_FONT, DEFAULT_TICK_LABEL_INSETS, DEFAULT_TICK_LABEL_PAINT, DEFAULT_TICK_LABELS_VISIBLE, DEFAULT_TICK_MARK_INSIDE_LENGTH, DEFAULT_TICK_MARK_OUTSIDE_LENGTH, DEFAULT_TICK_MARK_PAINT, DEFAULT_TICK_MARK_STROKE, DEFAULT_TICK_MARKS_VISIBLE

Constructor Summary

Constructors

Constructor and Description
PeriodAxis(String label) Creates a new axis.
PeriodAxis(String label, RegularTimePeriod first, RegularTimePeriod last) Creates a new axis.
PeriodAxis(String label, RegularTimePeriod first, RegularTimePeriod last, TimeZone timeZone) Deprecated. As of version 1.0.13, you should use the constructor that specifies a Locale also.
PeriodAxis(String label, RegularTimePeriod first, RegularTimePeriod last, TimeZone timeZone, Locale locale) Creates a new axis.

Method Summary

Modifier and Type	Method and Description
Object	clone() Returns a clone of the axis.
void	configure() Configures the axis to work with the current plot.
AxisState	draw(Graphics2D g2, double cursor, Rectangle2D plotArea, Rectangle2D dataArea, org.jfree.ui.RectangleEdge edge, PlotRenderingInfo plotState) Draws the axis on a Java 2D graphics device (such as the screen or a printer).
boolean	equals(Object obj) Tests the axis for equality with an arbitrary object.
Class	getAutoRangeTimePeriodClass() Returns the class used to create the first and last time periods for the axis range when the auto-range flag is set to true.
RegularTimePeriod	getFirst() Returns the first time period in the axis range.
PeriodAxisLabelInfo[]	getLabelInfo() Returns an array of label info records.
RegularTimePeriod	getLast() Returns the last time period in the axis range.
Locale	getLocale() Returns the locale for this axis.
Class	getMajorTickTimePeriodClass() Returns the class that controls the spacing of the major tick marks.
float	getMinorTickMarkInsideLength() Returns the inside length for the minor tick marks.
float	getMinorTickMarkOutsideLength() Returns the outside length for the minor tick marks.
Paint	getMinorTickMarkPaint() Returns the paint used to display minor tick marks, if they are visible.
Stroke	getMinorTickMarkStroke() Returns the stroke used to display minor tick marks, if they are visible.
Class	getMinorTickTimePeriodClass() Returns the class that controls the spacing of the minor tick marks.
TimeZone	getTimeZone() Returns the time zone used to convert the periods defining the axis range into absolute milliseconds.
int	hashCode() Returns a hash code for this object.
boolean	isMinorTickMarksVisible() Returns the flag that controls whether or not minor tick marks are displayed for the axis.
double	java2DToValue(double java2DValue, Rectangle2D area, org.jfree.ui.RectangleEdge edge) Converts a coordinate in Java2D space to the corresponding data value, assuming that the axis runs along one edge of the specified dataArea.
List	refreshTicks(Graphics2D g2, AxisState state, Rectangle2D dataArea, org.jfree.ui.RectangleEdge edge) Calculates the positions of the ticks for the axis, storing the results in the tick list (ready for drawing).
AxisSpace	reserveSpace(Graphics2D g2, Plot plot, Rectangle2D plotArea, org.jfree.ui.RectangleEdge edge, AxisSpace space) Estimates the space (height or width) required to draw the axis.
void	setAutoRangeTimePeriodClass(Class c) Sets the class used to create the first and last time periods for the axis range when the auto-range flag is set to true and sends an AxisChangeEvent to all registered listeners.
void	setFirst(RegularTimePeriod first) Sets the first time period in the axis range and sends an AxisChangeEvent to all registered listeners.
void	setLabelInfo(PeriodAxisLabelInfo[] info) Sets the array of label info records and sends an AxisChangeEvent to all registered listeners.
void	setLast(RegularTimePeriod last) Sets the last time period in the axis range and sends an AxisChangeEvent to all registered listeners.
void	setMajorTickTimePeriodClass(Class c) Sets the class that controls the spacing of the major tick marks, and sends an AxisChangeEvent to all registered listeners.
void	setMinorTickMarkInsideLength(float length) Sets the inside length of the minor tick marks and sends an AxisChangeEvent to all registered listeners.
void	setMinorTickMarkOutsideLength(float length) Sets the outside length of the minor tick marks and sends an AxisChangeEvent to all registered listeners.
void	setMinorTickMarkPaint(Paint paint) Sets the paint used to display minor tick marks, if they are visible, and sends a AxisChangeEvent to all registered listeners.
void	setMinorTickMarkStroke(Stroke stroke) Sets the stroke used to display minor tick marks, if they are visible, and sends a AxisChangeEvent to all registered listeners.
void	setMinorTickMarksVisible(boolean visible) Sets the flag that controls whether or not minor tick marks are displayed for the axis, and sends a AxisChangeEvent to all registered listeners.
void	setMinorTickTimePeriodClass(Class c) Sets the class that controls the spacing of the minor tick marks, and sends an AxisChangeEvent to all registered listeners.
void	setRange(Range range, boolean turnOffAutoRange, boolean notify) Sets the range for the axis, if requested, sends an AxisChangeEvent to all registered listeners.
void	setTimeZone(TimeZone zone) Sets the time zone that is used to convert the time periods into absolute milliseconds.
double	valueToJava2D(double value, Rectangle2D area, org.jfree.ui.RectangleEdge edge) Converts a data value to a coordinate in Java2D space, assuming that the axis runs along one edge of the specified dataArea.

Methods inherited from class org.jfree.chart.axis.ValueAxis

centerRange, getAutoRangeMinimumSize, getDefaultAutoRange, getDownArrow, getFixedAutoRange, getLeftArrow, getLowerBound, getLowerMargin, getMinorTickCount, getRange, getRightArrow, getStandardTickUnits, getUpArrow, getUpperBound, getUpperMargin, isAutoRange, isAutoTickUnitSelection, isInverted, isNegativeArrowVisible, isPositiveArrowVisible, isVerticalTickLabels, lengthToJava2D, pan, resizeRange, resizeRange, resizeRange2, setAutoRange, setAutoRangeMinimumSize, setAutoRangeMinimumSize, setAutoTickUnitSelection, setAutoTickUnitSelection, setDefaultAutoRange, setDownArrow, setFixedAutoRange, setInverted, setLeftArrow, setLowerBound, setLowerMargin, setMinorTickCount, setNegativeArrowVisible, setPositiveArrowVisible, setRange, setRange, setRangeAboutValue, setRangeWithMargins, setRangeWithMargins, setRangeWithMargins, setRightArrow, setStandardTickUnits, setUpArrow, setUpperBound, setUpperMargin, setVerticalTickLabels, zoomRange

Methods inherited from class org.jfree.chart.axis.Axis

addChangeListener, createAttributedLabel, getAttributedLabel, getAxisLinePaint, getAxisLineStroke, getFixedDimension, getLabel, getLabelAngle, getLabelFont, getLabelInsets, getLabelLocation, getLabelPaint, getPlot, getTickLabelFont, getTickLabelInsets, getTickLabelPaint, getTickMarkInsideLength, getTickMarkOutsideLength, getTickMarkPaint, getTickMarkStroke, hasListener, isAxisLineVisible, isTickLabelsVisible, isTickMarksVisible, isVisible, removeChangeListener, setAttributedLabel, setAttributedLabel, setAxisLinePaint, setAxisLineStroke, setAxisLineVisible, setFixedDimension, setLabel, setLabelAngle, setLabelFont, setLabelInsets, setLabelInsets, setLabelLocation, setLabelPaint, setPlot, setTickLabelFont, setTickLabelInsets, setTickLabelPaint, setTickLabelsVisible, setTickMarkInsideLength, setTickMarkOutsideLength, setTickMarkPaint, setTickMarkStroke, setTickMarksVisible, setVisible

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PeriodAxis

public PeriodAxis(String label)

Creates a new axis.

Parameters:

label - the axis label.

PeriodAxis

public PeriodAxis(String label,
                  RegularTimePeriod first,
                  RegularTimePeriod last)

Creates a new axis.

Parameters:

label - the axis label (null permitted).

first - the first time period in the axis range (null not permitted).

last - the last time period in the axis range (null not permitted).

PeriodAxis

public PeriodAxis(String label,
                  RegularTimePeriod first,
                  RegularTimePeriod last,
                  TimeZone timeZone)

Deprecated. As of version 1.0.13, you should use the constructor that specifies a Locale also.

Creates a new axis.

Parameters:

label - the axis label (null permitted).

first - the first time period in the axis range (null not permitted).

last - the last time period in the axis range (null not permitted).

timeZone - the time zone (null not permitted).

PeriodAxis

public PeriodAxis(String label,
                  RegularTimePeriod first,
                  RegularTimePeriod last,
                  TimeZone timeZone,
                  Locale locale)

Creates a new axis.

Parameters:

label - the axis label (null permitted).

first - the first time period in the axis range (null not permitted).

last - the last time period in the axis range (null not permitted).

timeZone - the time zone (null not permitted).

locale - the locale (null not permitted).

Since:

1.0.13

Method Detail

getFirst

public RegularTimePeriod getFirst()

Returns the first time period in the axis range.

Returns:

The first time period (never null).

setFirst

public void setFirst(RegularTimePeriod first)

Sets the first time period in the axis range and sends an AxisChangeEvent to all registered listeners.

Parameters:

first - the time period (null not permitted).

getLast

public RegularTimePeriod getLast()

Returns the last time period in the axis range.

Returns:

The last time period (never null).

setLast

public void setLast(RegularTimePeriod last)

Sets the last time period in the axis range and sends an AxisChangeEvent to all registered listeners.

Parameters:

last - the time period (null not permitted).

getTimeZone

public TimeZone getTimeZone()

Returns the time zone used to convert the periods defining the axis range into absolute milliseconds.

Returns:

The time zone (never null).

setTimeZone

public void setTimeZone(TimeZone zone)

Sets the time zone that is used to convert the time periods into absolute milliseconds.

Parameters:

zone - the time zone (null not permitted).

getLocale

public Locale getLocale()

Returns the locale for this axis.

Returns:

The locale (never (null).

Since:

1.0.13

getAutoRangeTimePeriodClass

public Class getAutoRangeTimePeriodClass()

Returns the class used to create the first and last time periods for the axis range when the auto-range flag is set to true.

Returns:

The class (never null).

setAutoRangeTimePeriodClass

public void setAutoRangeTimePeriodClass(Class c)

Sets the class used to create the first and last time periods for the axis range when the auto-range flag is set to true and sends an AxisChangeEvent to all registered listeners.

Parameters:

c - the class (null not permitted).

getMajorTickTimePeriodClass

public Class getMajorTickTimePeriodClass()

Returns the class that controls the spacing of the major tick marks.

Returns:

The class (never null).

setMajorTickTimePeriodClass

public void setMajorTickTimePeriodClass(Class c)

Sets the class that controls the spacing of the major tick marks, and sends an AxisChangeEvent to all registered listeners.

Parameters:

c - the class (a subclass of RegularTimePeriod is expected).

isMinorTickMarksVisible

public boolean isMinorTickMarksVisible()

Returns the flag that controls whether or not minor tick marks are displayed for the axis.

Overrides:

isMinorTickMarksVisible in class Axis

Returns:

A boolean.

See Also:

Axis.setMinorTickMarksVisible(boolean)

setMinorTickMarksVisible

public void setMinorTickMarksVisible(boolean visible)

Sets the flag that controls whether or not minor tick marks are displayed for the axis, and sends a AxisChangeEvent to all registered listeners.

Overrides:

setMinorTickMarksVisible in class Axis

Parameters:

visible - the flag.

See Also:

Axis.isMinorTickMarksVisible()

getMinorTickTimePeriodClass

public Class getMinorTickTimePeriodClass()

Returns the class that controls the spacing of the minor tick marks.

Returns:

The class (never null).

setMinorTickTimePeriodClass

public void setMinorTickTimePeriodClass(Class c)

Sets the class that controls the spacing of the minor tick marks, and sends an AxisChangeEvent to all registered listeners.

Parameters:

c - the class (a subclass of RegularTimePeriod is expected).

getMinorTickMarkStroke

public Stroke getMinorTickMarkStroke()

Returns the stroke used to display minor tick marks, if they are visible.

Returns:

A stroke (never null).

setMinorTickMarkStroke

public void setMinorTickMarkStroke(Stroke stroke)

Sets the stroke used to display minor tick marks, if they are visible, and sends a AxisChangeEvent to all registered listeners.

Parameters:

stroke - the stroke (null not permitted).

getMinorTickMarkPaint

public Paint getMinorTickMarkPaint()

Returns the paint used to display minor tick marks, if they are visible.

Returns:

A paint (never null).

setMinorTickMarkPaint

public void setMinorTickMarkPaint(Paint paint)

Sets the paint used to display minor tick marks, if they are visible, and sends a AxisChangeEvent to all registered listeners.

Parameters:

paint - the paint (null not permitted).

getMinorTickMarkInsideLength

public float getMinorTickMarkInsideLength()

Returns the inside length for the minor tick marks.

Overrides:

getMinorTickMarkInsideLength in class Axis

Returns:

The length.

See Also:

Axis.getMinorTickMarkOutsideLength(), Axis.setMinorTickMarkInsideLength(float)

setMinorTickMarkInsideLength

public void setMinorTickMarkInsideLength(float length)

Sets the inside length of the minor tick marks and sends an AxisChangeEvent to all registered listeners.

Overrides:

setMinorTickMarkInsideLength in class Axis

Parameters:

length - the length.

See Also:

Axis.getMinorTickMarkInsideLength()

getMinorTickMarkOutsideLength

public float getMinorTickMarkOutsideLength()

Returns the outside length for the minor tick marks.

Overrides:

getMinorTickMarkOutsideLength in class Axis

Returns:

The length.

See Also:

Axis.getMinorTickMarkInsideLength(), Axis.setMinorTickMarkOutsideLength(float)

setMinorTickMarkOutsideLength

public void setMinorTickMarkOutsideLength(float length)

Sets the outside length of the minor tick marks and sends an AxisChangeEvent to all registered listeners.

Overrides:

setMinorTickMarkOutsideLength in class Axis

Parameters:

length - the length.

See Also:

Axis.getMinorTickMarkInsideLength()

getLabelInfo

public PeriodAxisLabelInfo[] getLabelInfo()

Returns an array of label info records.

Returns:

An array.

setLabelInfo

public void setLabelInfo(PeriodAxisLabelInfo[] info)

Sets the array of label info records and sends an AxisChangeEvent to all registered listeners.

Parameters:

info - the info.

setRange

public void setRange(Range range,
                     boolean turnOffAutoRange,
                     boolean notify)

Sets the range for the axis, if requested, sends an AxisChangeEvent to all registered listeners. As a side-effect, the auto-range flag is set to false (optional).

Overrides:

setRange in class ValueAxis

Parameters:

range - the range (null not permitted).

turnOffAutoRange - a flag that controls whether or not the auto range is turned off.

notify - a flag that controls whether or not listeners are notified.

See Also:

ValueAxis.getRange()

configure

public void configure()

Configures the axis to work with the current plot. Override this method to perform any special processing (such as auto-rescaling).

Specified by:

configure in class Axis

reserveSpace

public AxisSpace reserveSpace(Graphics2D g2,
                              Plot plot,
                              Rectangle2D plotArea,
                              org.jfree.ui.RectangleEdge edge,
                              AxisSpace space)

Estimates the space (height or width) required to draw the axis.

Overrides:

reserveSpace in class ValueAxis

Parameters:

g2 - the graphics device.

plot - the plot that the axis belongs to.

plotArea - the area within which the plot (including axes) should be drawn.

edge - the axis location.

space - space already reserved.

Returns:

The space required to draw the axis (including pre-reserved space).

draw

public AxisState draw(Graphics2D g2,
                      double cursor,
                      Rectangle2D plotArea,
                      Rectangle2D dataArea,
                      org.jfree.ui.RectangleEdge edge,
                      PlotRenderingInfo plotState)

Draws the axis on a Java 2D graphics device (such as the screen or a printer).

Specified by:

draw in class Axis

Parameters:

g2 - the graphics device (null not permitted).

cursor - the cursor location (determines where to draw the axis).

plotArea - the area within which the axes and plot should be drawn.

dataArea - the area within which the data should be drawn.

edge - the axis location (null not permitted).

plotState - collects information about the plot (null permitted).

Returns:

The axis state (never null).

refreshTicks

public List refreshTicks(Graphics2D g2,
                         AxisState state,
                         Rectangle2D dataArea,
                         org.jfree.ui.RectangleEdge edge)

Calculates the positions of the ticks for the axis, storing the results in the tick list (ready for drawing).

Specified by:

refreshTicks in class Axis

Parameters:

g2 - the graphics device.

state - the axis state.

dataArea - the area inside the axes.

edge - the edge on which the axis is located.

Returns:

The list of ticks.

valueToJava2D

public double valueToJava2D(double value,
                            Rectangle2D area,
                            org.jfree.ui.RectangleEdge edge)

Converts a data value to a coordinate in Java2D space, assuming that the axis runs along one edge of the specified dataArea.

Note that it is possible for the coordinate to fall outside the area.

Specified by:

valueToJava2D in class ValueAxis

Parameters:

value - the data value.

area - the area for plotting the data.

edge - the edge along which the axis lies.

Returns:

The Java2D coordinate.

See Also:

ValueAxis.java2DToValue(double, Rectangle2D, RectangleEdge)

java2DToValue

public double java2DToValue(double java2DValue,
                            Rectangle2D area,
                            org.jfree.ui.RectangleEdge edge)

Converts a coordinate in Java2D space to the corresponding data value, assuming that the axis runs along one edge of the specified dataArea.

Specified by:

java2DToValue in class ValueAxis

Parameters:

java2DValue - the coordinate in Java2D space.

area - the area in which the data is plotted.

edge - the edge along which the axis lies.

Returns:

The data value.

See Also:

ValueAxis.valueToJava2D(double, Rectangle2D, RectangleEdge)

equals

public boolean equals(Object obj)

Tests the axis for equality with an arbitrary object.

Overrides:

equals in class ValueAxis

Parameters:

obj - the object (null permitted).

Returns:

A boolean.

hashCode

public int hashCode()

Returns a hash code for this object.

Overrides:

hashCode in class Axis

Returns:

A hash code.

clone

public Object clone()
             throws CloneNotSupportedException

Returns a clone of the axis.

Specified by:

clone in interface org.jfree.util.PublicCloneable

Overrides:

clone in class ValueAxis

Returns:

A clone.

Throws:

CloneNotSupportedException - this class is cloneable, but subclasses may not be.