public class

DateAxis

extends ValueAxis
implements Serializable Cloneable

java.lang.Object
↳	org.jfree.chart.axis.Axis
	↳	org.jfree.chart.axis.ValueAxis
		↳	org.jfree.chart.axis.DateAxis

Class Overview

The base class for axes that display dates. You will find it easier to understand how this axis works if you bear in mind that it really displays/measures integer (or long) data, where the integers are milliseconds since midnight, 1-Jan-1970. When displaying tick labels, the millisecond values are converted back to dates using a DateFormat instance.

You can also create a Timeline and supply in the constructor to create an axis that only contains certain domain values. For example, this allows you to create a date axis that only contains working days.

Summary

Constants
double	DEFAULT_AUTO_RANGE_MINIMUM_SIZE_IN_MILLISECONDS	The default minimum auto range size.

[Expand]

Inherited Constants

From class org.jfree.chart.axis.ValueAxis

From class org.jfree.chart.axis.Axis

Fields
public static final Date	DEFAULT_ANCHOR_DATE	The default anchor date.
public static final DateRange	DEFAULT_DATE_RANGE	The default axis range.
public static final DateTickUnit	DEFAULT_DATE_TICK_UNIT	The default date tick unit.

[Expand]

Inherited Fields

From class org.jfree.chart.axis.ValueAxis

From class org.jfree.chart.axis.Axis

Public Constructors
	DateAxis() Creates a date axis with no label.
	DateAxis(String label) Creates a date axis with the specified label.
	DateAxis(String label, TimeZone zone) This constructor is deprecated. From 1.0.11 onwards, use `DateAxis(String, TimeZone, Locale)` instead, to explicitly set the locale.
	DateAxis(String label, TimeZone zone, Locale locale) Creates a date axis.

Public Methods
Date	calculateHighestVisibleTickValue(DateTickUnit unit) Calculates the value of the highest visible tick on the axis.
Date	calculateLowestVisibleTickValue(DateTickUnit unit) Calculates the value of the lowest visible tick on the axis.
Object	clone() Returns a clone of the object.
void	configure() Configures the axis to work with the specified plot.
static TickUnitSource	createStandardDateTickUnits(TimeZone zone) This method is deprecated. Since 1.0.11, use `createStandardDateTickUnits(TimeZone, Locale)` to explicitly set the locale as well as the time zone.
static TickUnitSource	createStandardDateTickUnits(TimeZone zone, Locale locale) Returns a collection of standard date tick units.
static TickUnitSource	createStandardDateTickUnits() Returns a collection of standard date tick units that uses the default time zone.
double	dateToJava2D(Date date, Rectangle2D area, RectangleEdge edge) Translates a date to Java2D coordinates, based on the range displayed by this axis for the specified data area.
AxisState	draw(Graphics2D g2, double cursor, Rectangle2D plotArea, Rectangle2D dataArea, 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 this axis for equality with an arbitrary object.
DateFormat	getDateFormatOverride() Returns the date format override.
Date	getMaximumDate() Returns the latest date visible on the axis.
Date	getMinimumDate() Returns the earliest date visible on the axis.
DateTickMarkPosition	getTickMarkPosition() Returns the tick mark position (start, middle or end of the time period).
DateTickUnit	getTickUnit() Returns the tick unit for the axis.
TimeZone	getTimeZone() Returns the time zone for the axis.
Timeline	getTimeline() Returns the underlying timeline used by this axis.
int	hashCode() Returns a hash code for this object.
boolean	isHiddenValue(long millis) Returns `true` if the axis hides this value, and `false` otherwise.
double	java2DToValue(double java2DValue, Rectangle2D area, RectangleEdge edge) Translates a Java2D coordinate into the corresponding data value.
List	refreshTicks(Graphics2D g2, AxisState state, Rectangle2D dataArea, RectangleEdge edge) Calculates the positions of the tick labels for the axis, storing the results in the tick label list (ready for drawing).
void	setDateFormatOverride(DateFormat formatter) Sets the date format override.
void	setMaximumDate(Date maximumDate) Sets the maximum date visible on the axis and sends an `AxisChangeEvent` to all registered listeners.
void	setMinimumDate(Date date) Sets the minimum date visible on the axis 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	setRange(double lower, double upper) Sets the axis range and sends an `AxisChangeEvent` to all registered listeners.
void	setRange(Range range) Sets the upper and lower bounds for the axis and sends an `AxisChangeEvent` to all registered listeners.
void	setRange(Date lower, Date upper) Sets the axis range and sends an `AxisChangeEvent` to all registered listeners.
void	setTickMarkPosition(DateTickMarkPosition position) Sets the tick mark position (start, middle or end of the time period) and sends an `AxisChangeEvent` to all registered listeners.
void	setTickUnit(DateTickUnit unit) Sets the tick unit for the axis.
void	setTickUnit(DateTickUnit unit, boolean notify, boolean turnOffAutoSelection) Sets the tick unit attribute.
void	setTimeZone(TimeZone zone) Sets the time zone for the axis and sends an `AxisChangeEvent` to all registered listeners.
void	setTimeline(Timeline timeline) Sets the underlying timeline to use for this axis.
double	valueToJava2D(double value, Rectangle2D area, RectangleEdge edge) Translates the data value to the display coordinates (Java 2D User Space) of the chart.
void	zoomRange(double lowerPercent, double upperPercent) Zooms in on the current range.

Protected Methods
void	autoAdjustRange() Rescales the axis to ensure that all data is visible.
Date	nextStandardDate(Date date, DateTickUnit unit) Returns the first "standard" date (based on the specified field and units).
Date	previousStandardDate(Date date, DateTickUnit unit) Returns the previous "standard" date, for a given date and tick unit.
List	refreshTicksHorizontal(Graphics2D g2, Rectangle2D dataArea, RectangleEdge edge) Recalculates the ticks for the date axis.
List	refreshTicksVertical(Graphics2D g2, Rectangle2D dataArea, RectangleEdge edge) Recalculates the ticks for the date axis.
void	selectAutoTickUnit(Graphics2D g2, Rectangle2D dataArea, RectangleEdge edge) Selects an appropriate tick value for the axis.
void	selectHorizontalAutoTickUnit(Graphics2D g2, Rectangle2D dataArea, RectangleEdge edge) Selects an appropriate tick size for the axis.
void	selectVerticalAutoTickUnit(Graphics2D g2, Rectangle2D dataArea, RectangleEdge edge) Selects an appropriate tick size for the axis.

[Expand]

Inherited Methods

From class org.jfree.chart.axis.ValueAxis

abstract void	autoAdjustRange() Automatically sets the axis range to fit the range of values in the dataset.
float[]	calculateAnchorPoint(ValueTick tick, double cursor, Rectangle2D dataArea, RectangleEdge edge) Calculates the anchor point for a tick label.
void	centerRange(double value) Centers the axis range about the specified value and sends an `AxisChangeEvent` to all registered listeners.
Object	clone() Returns a clone of the object.
void	drawAxisLine(Graphics2D g2, double cursor, Rectangle2D dataArea, RectangleEdge edge) Draws an axis line at the current cursor position and edge.
AxisState	drawTickMarksAndLabels(Graphics2D g2, double cursor, Rectangle2D plotArea, Rectangle2D dataArea, RectangleEdge edge) Draws the axis line, tick marks and tick mark labels.
boolean	equals(Object obj) Tests the axis for equality with an arbitrary object.
double	findMaximumTickLabelHeight(List ticks, Graphics2D g2, Rectangle2D drawArea, boolean vertical) A utility method for determining the height of the tallest tick label.
double	findMaximumTickLabelWidth(List ticks, Graphics2D g2, Rectangle2D drawArea, boolean vertical) A utility method for determining the width of the widest tick label.
double	getAutoRangeMinimumSize() Returns the minimum size allowed for the axis range when it is automatically calculated.
int	getAutoTickIndex() Returns the auto tick index.
Range	getDefaultAutoRange() Returns the default auto range.
Shape	getDownArrow() Returns a shape that can be displayed as an arrow pointing downwards at the end of an axis line.
double	getFixedAutoRange() Returns the fixed auto range.
Shape	getLeftArrow() Returns a shape that can be displayed as an arrow pointing left at the end of an axis line.
double	getLowerBound() Returns the lower bound of the axis range.
double	getLowerMargin() Returns the lower margin for the axis, expressed as a percentage of the axis range.
int	getMinorTickCount() Returns the number of minor tick marks to display.
Range	getRange() Returns the range for the axis.
Shape	getRightArrow() Returns a shape that can be displayed as an arrow pointing right at the end of an axis line.
TickUnitSource	getStandardTickUnits() Returns the source for obtaining standard tick units for the axis.
Shape	getUpArrow() Returns a shape that can be displayed as an arrow pointing upwards at the end of an axis line.
double	getUpperBound() Returns the upper bound for the axis range.
double	getUpperMargin() Returns the upper margin for the axis, expressed as a percentage of the axis range.
boolean	isAutoRange() Returns the flag that controls whether or not the axis range is automatically adjusted to fit the data values.
boolean	isAutoTickUnitSelection() Returns a flag indicating whether or not the tick unit is automatically selected from a range of standard tick units.
boolean	isInverted() Returns a flag that controls the direction of values on the axis.
boolean	isNegativeArrowVisible() Returns a flag that controls whether or not the axis line has an arrow drawn that points in the negative direction for the axis.
boolean	isPositiveArrowVisible() Returns a flag that controls whether or not the axis line has an arrow drawn that points in the positive direction for the axis.
boolean	isVerticalTickLabels() Returns `true` if the tick labels should be rotated (to vertical), and `false` otherwise.
abstract double	java2DToValue(double java2DValue, Rectangle2D area, 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.
double	lengthToJava2D(double length, Rectangle2D area, RectangleEdge edge) Converts a length in data coordinates into the corresponding length in Java2D coordinates.
void	pan(double percent) Slides the axis range by the specified percentage.
AxisSpace	reserveSpace(Graphics2D g2, Plot plot, Rectangle2D plotArea, RectangleEdge edge, AxisSpace space) Returns the space required to draw the axis.
void	resizeRange(double percent) Increases or decreases the axis range by the specified percentage about the central value and sends an `AxisChangeEvent` to all registered listeners.
void	resizeRange(double percent, double anchorValue) Increases or decreases the axis range by the specified percentage about the specified anchor value and sends an `AxisChangeEvent` to all registered listeners.
void	resizeRange2(double percent, double anchorValue) Increases or decreases the axis range by the specified percentage about the specified anchor value and sends an `AxisChangeEvent` to all registered listeners.
void	setAutoRange(boolean auto, boolean notify) Sets the auto range attribute.
void	setAutoRange(boolean auto) Sets a flag that determines whether or not the axis range is automatically adjusted to fit the data, and notifies registered listeners that the axis has been modified.
void	setAutoRangeMinimumSize(double size) Sets the auto range minimum size and sends an `AxisChangeEvent` to all registered listeners.
void	setAutoRangeMinimumSize(double size, boolean notify) Sets the minimum size allowed for the axis range when it is automatically calculated.
void	setAutoTickIndex(int index) Sets the auto tick index.
void	setAutoTickUnitSelection(boolean flag, boolean notify) Sets a flag indicating whether or not the tick unit is automatically selected from a range of standard tick units.
void	setAutoTickUnitSelection(boolean flag) Sets a flag indicating whether or not the tick unit is automatically selected from a range of standard tick units.
void	setDefaultAutoRange(Range range) Sets the default auto range and sends an `AxisChangeEvent` to all registered listeners.
void	setDownArrow(Shape arrow) Sets the shape that can be displayed as an arrow pointing downwards at the end of an axis line and sends an `AxisChangeEvent` to all registered listeners.
void	setFixedAutoRange(double length) Sets the fixed auto range for the axis.
void	setInverted(boolean flag) Sets a flag that controls the direction of values on the axis, and notifies registered listeners that the axis has changed.
void	setLeftArrow(Shape arrow) Sets the shape that can be displayed as an arrow pointing left at the end of an axis line and sends an `AxisChangeEvent` to all registered listeners.
void	setLowerBound(double min) Sets the lower bound for the axis range.
void	setLowerMargin(double margin) Sets the lower margin for the axis (as a percentage of the axis range) and sends an `AxisChangeEvent` to all registered listeners.
void	setMinorTickCount(int count) Sets the number of minor tick marks to display, and sends an `AxisChangeEvent` to all registered listeners.
void	setNegativeArrowVisible(boolean visible) Sets a flag that controls whether or not the axis lines has an arrow drawn that points in the negative direction for the axis, and sends an `AxisChangeEvent` to all registered listeners.
void	setPositiveArrowVisible(boolean visible) Sets a flag that controls whether or not the axis lines has an arrow drawn that points in the positive direction for the axis, 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	setRange(double lower, double upper) Sets the axis range and sends an `AxisChangeEvent` to all registered listeners.
void	setRange(Range range) Sets the range attribute and sends an `AxisChangeEvent` to all registered listeners.
void	setRangeAboutValue(double value, double length) Sets the axis range, where the new range is 'size' in length, and centered on 'value'.
void	setRangeWithMargins(Range range) Sets the range for the axis (after first adding the current margins to the specified range) and sends an `AxisChangeEvent` to all registered listeners.
void	setRangeWithMargins(double lower, double upper) Sets the axis range (after first adding the current margins to the range) and sends an `AxisChangeEvent` to all registered listeners.
void	setRangeWithMargins(Range range, boolean turnOffAutoRange, boolean notify) Sets the range for the axis after first adding the current margins to the range and, if requested, sends an `AxisChangeEvent` to all registered listeners.
void	setRightArrow(Shape arrow) Sets the shape that can be displayed as an arrow pointing rightwards at the end of an axis line and sends an `AxisChangeEvent` to all registered listeners.
void	setStandardTickUnits(TickUnitSource source) Sets the source for obtaining standard tick units for the axis and sends an `AxisChangeEvent` to all registered listeners.
void	setUpArrow(Shape arrow) Sets the shape that can be displayed as an arrow pointing upwards at the end of an axis line and sends an `AxisChangeEvent` to all registered listeners.
void	setUpperBound(double max) Sets the upper bound for the axis range, and sends an `AxisChangeEvent` to all registered listeners.
void	setUpperMargin(double margin) Sets the upper margin for the axis (as a percentage of the axis range) and sends an `AxisChangeEvent` to all registered listeners.
void	setVerticalTickLabels(boolean flag) Sets the flag that controls whether the tick labels are displayed vertically (that is, rotated 90 degrees from horizontal).
abstract double	valueToJava2D(double value, Rectangle2D area, RectangleEdge edge) Converts a data value to a coordinate in Java2D space, assuming that the axis runs along one edge of the specified dataArea.
void	zoomRange(double lowerPercent, double upperPercent) Zooms in on the current range.

From class org.jfree.chart.axis.Axis

void	addChangeListener(AxisChangeListener listener) Registers an object for notification of changes to the axis.
Object	clone() Returns a clone of the axis.
abstract void	configure() Configures the axis to work with the current plot.
void	createAndAddEntity(double cursor, AxisState state, Rectangle2D dataArea, RectangleEdge edge, PlotRenderingInfo plotState) Created an entity for the axis.
abstract AxisState	draw(Graphics2D g2, double cursor, Rectangle2D plotArea, Rectangle2D dataArea, RectangleEdge edge, PlotRenderingInfo plotState) Draws the axis on a Java 2D graphics device (such as the screen or a printer).
void	drawAxisLine(Graphics2D g2, double cursor, Rectangle2D dataArea, RectangleEdge edge) Draws an axis line at the current cursor position and edge.
AxisState	drawLabel(String label, Graphics2D g2, Rectangle2D plotArea, Rectangle2D dataArea, RectangleEdge edge, AxisState state) Draws the axis label.
boolean	equals(Object obj) Tests this axis for equality with another object.
void	fireChangeEvent() Sends an `AxisChangeEvent` to all registered listeners.
Paint	getAxisLinePaint() Returns the paint used to draw the axis line.
Stroke	getAxisLineStroke() Returns the stroke used to draw the axis line.
double	getFixedDimension() Returns the fixed dimension for the axis.
String	getLabel() Returns the label for the axis.
double	getLabelAngle() Returns the angle of the axis label.
Rectangle2D	getLabelEnclosure(Graphics2D g2, RectangleEdge edge) Returns a rectangle that encloses the axis label.
Font	getLabelFont() Returns the font for the axis label.
RectangleInsets	getLabelInsets() Returns the insets for the label (that is, the amount of blank space that should be left around the label).
Paint	getLabelPaint() Returns the color/shade used to draw the axis label.
float	getMinorTickMarkInsideLength() Returns the inside length of the minor tick marks.
float	getMinorTickMarkOutsideLength() Returns the outside length of the minor tick marks.
Plot	getPlot() Returns the plot that the axis is assigned to.
Font	getTickLabelFont() Returns the font used for the tick labels (if showing).
RectangleInsets	getTickLabelInsets() Returns the insets for the tick labels.
Paint	getTickLabelPaint() Returns the color/shade used for the tick labels.
float	getTickMarkInsideLength() Returns the inside length of the tick marks.
float	getTickMarkOutsideLength() Returns the outside length of the tick marks.
Paint	getTickMarkPaint() Returns the paint used to draw tick marks (if they are showing).
Stroke	getTickMarkStroke() Returns the stroke used to draw tick marks.
boolean	hasListener(EventListener listener) Returns `true` if the specified object is registered with the dataset as a listener.
boolean	isAxisLineVisible() A flag that controls whether or not the axis line is drawn.
boolean	isMinorTickMarksVisible() Returns the flag that indicates whether or not the minor tick marks are showing.
boolean	isTickLabelsVisible() Returns a flag indicating whether or not the tick labels are visible.
boolean	isTickMarksVisible() Returns the flag that indicates whether or not the tick marks are showing.
boolean	isVisible() Returns `true` if the axis is visible, and `false` otherwise.
void	notifyListeners(AxisChangeEvent event) Notifies all registered listeners that the axis has changed.
abstract List	refreshTicks(Graphics2D g2, AxisState state, Rectangle2D dataArea, RectangleEdge edge) Calculates the positions of the ticks for the axis, storing the results in the tick list (ready for drawing).
void	removeChangeListener(AxisChangeListener listener) Deregisters an object for notification of changes to the axis.
abstract AxisSpace	reserveSpace(Graphics2D g2, Plot plot, Rectangle2D plotArea, RectangleEdge edge, AxisSpace space) Estimates the space (height or width) required to draw the axis.
void	setAxisLinePaint(Paint paint) Sets the paint used to draw the axis line and sends an `AxisChangeEvent` to all registered listeners.
void	setAxisLineStroke(Stroke stroke) Sets the stroke used to draw the axis line and sends an `AxisChangeEvent` to all registered listeners.
void	setAxisLineVisible(boolean visible) Sets a flag that controls whether or not the axis line is visible and sends an `AxisChangeEvent` to all registered listeners.
void	setFixedDimension(double dimension) Sets the fixed dimension for the axis.
void	setLabel(String label) Sets the label for the axis and sends an `AxisChangeEvent` to all registered listeners.
void	setLabelAngle(double angle) Sets the angle for the label and sends an `AxisChangeEvent` to all registered listeners.
void	setLabelFont(Font font) Sets the font for the axis label and sends an `AxisChangeEvent` to all registered listeners.
void	setLabelInsets(RectangleInsets insets) Sets the insets for the axis label, and sends an `AxisChangeEvent` to all registered listeners.
void	setLabelInsets(RectangleInsets insets, boolean notify) Sets the insets for the axis label, and sends an `AxisChangeEvent` to all registered listeners.
void	setLabelPaint(Paint paint) Sets the paint used to draw the axis label 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	setMinorTickMarksVisible(boolean flag) Sets the flag that indicates whether or not the minor tick marks are showing and sends an `AxisChangeEvent` to all registered listeners.
void	setPlot(Plot plot) Sets a reference to the plot that the axis is assigned to.
void	setTickLabelFont(Font font) Sets the font for the tick labels and sends an `AxisChangeEvent` to all registered listeners.
void	setTickLabelInsets(RectangleInsets insets) Sets the insets for the tick labels and sends an `AxisChangeEvent` to all registered listeners.
void	setTickLabelPaint(Paint paint) Sets the paint used to draw tick labels (if they are showing) and sends an `AxisChangeEvent` to all registered listeners.
void	setTickLabelsVisible(boolean flag) Sets the flag that determines whether or not the tick labels are visible and sends an `AxisChangeEvent` to all registered listeners.
void	setTickMarkInsideLength(float length) Sets the inside length of the tick marks and sends an `AxisChangeEvent` to all registered listeners.
void	setTickMarkOutsideLength(float length) Sets the outside length of the tick marks and sends an `AxisChangeEvent` to all registered listeners.
void	setTickMarkPaint(Paint paint) Sets the paint used to draw tick marks and sends an `AxisChangeEvent` to all registered listeners.
void	setTickMarkStroke(Stroke stroke) Sets the stroke used to draw tick marks and sends an `AxisChangeEvent` to all registered listeners.
void	setTickMarksVisible(boolean flag) Sets the flag that indicates whether or not the tick marks are showing and sends an `AxisChangeEvent` to all registered listeners.
void	setVisible(boolean flag) Sets a flag that controls whether or not the axis is visible and sends an `AxisChangeEvent` to all registered listeners.

From class java.lang.Object

Constants

public static final double DEFAULT_AUTO_RANGE_MINIMUM_SIZE_IN_MILLISECONDS

The default minimum auto range size.

Constant Value: 2.0

Fields

public static final Date DEFAULT_ANCHOR_DATE

The default anchor date.

public static final DateRange DEFAULT_DATE_RANGE

The default axis range.

public static final DateTickUnit DEFAULT_DATE_TICK_UNIT

The default date tick unit.

Public Constructors

public DateAxis ()

Creates a date axis with no label.

public DateAxis (String label)

Creates a date axis with the specified label.

Parameters

label	the axis label (`null` permitted).

public DateAxis (String label, TimeZone zone)

This constructor is deprecated.
From 1.0.11 onwards, use DateAxis(String, TimeZone, Locale) instead, to explicitly set the locale.

Creates a date axis. A timeline is specified for the axis. This allows special transformations to occur between a domain of values and the values included in the axis.

Parameters

label	the axis label (`null` permitted).
zone	the time zone.

public DateAxis (String label, TimeZone zone, Locale locale)

Creates a date axis. A timeline is specified for the axis. This allows special transformations to occur between a domain of values and the values included in the axis.

Parameters

label	the axis label (`null` permitted).
zone	the time zone.
locale	the locale (`null` not permitted).

Public Methods

public Date calculateHighestVisibleTickValue (DateTickUnit unit)

Calculates the value of the highest visible tick on the axis.

Parameters

unit	date unit to use.

Returns

The value of the highest visible tick on the axis.

public Date calculateLowestVisibleTickValue (DateTickUnit unit)

Calculates the value of the lowest visible tick on the axis.

Parameters

unit	date unit to use.

Returns

The value of the lowest visible tick on the axis.

public Object clone ()

Returns a clone of the object.

Returns

A clone.

Throws

CloneNotSupportedException	if some component of the axis does not support cloning.

public void configure ()

Configures the axis to work with the specified plot. If the axis has auto-scaling, then sets the maximum and minimum values.

public static TickUnitSource createStandardDateTickUnits (TimeZone zone)

This method is deprecated.
Since 1.0.11, use createStandardDateTickUnits(TimeZone, Locale) to explicitly set the locale as well as the time zone.

Returns a collection of standard date tick units. This collection will be used by default, but you are free to create your own collection if you want to (see the setStandardTickUnits(TickUnitSource) method inherited from the ValueAxis class).

Parameters

zone	the time zone (`null` not permitted).

Returns

A collection of standard date tick units.

public static TickUnitSource createStandardDateTickUnits (TimeZone zone, Locale locale)

Returns a collection of standard date tick units. This collection will be used by default, but you are free to create your own collection if you want to (see the setStandardTickUnits(TickUnitSource) method inherited from the ValueAxis class).

Parameters

zone	the time zone (`null` not permitted).
locale	the locale (`null` not permitted).

Returns

A collection of standard date tick units.

public static TickUnitSource createStandardDateTickUnits ()

Returns a collection of standard date tick units that uses the default time zone. This collection will be used by default, but you are free to create your own collection if you want to (see the setStandardTickUnits(TickUnitSource) method inherited from the ValueAxis class).

Returns

A collection of standard date tick units.

public double dateToJava2D (Date date, Rectangle2D area, RectangleEdge edge)

Translates a date to Java2D coordinates, based on the range displayed by this axis for the specified data area.

Parameters

date	the date.
area	the rectangle (in Java2D space) where the data is to be plotted.
edge	the axis location.

Returns

The coordinate corresponding to the supplied date.

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

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

Parameters

g2	the graphics device (`null` not permitted).
cursor	the cursor location.
plotArea	the area within which the axes and data should be drawn (`null` not permitted).
dataArea	the area within which the data should be drawn (`null` not permitted).
edge	the location of the axis (`null` not permitted).
plotState	collects information about the plot (`null` permitted).

Returns

The axis state (never null).

public boolean equals (Object obj)

Tests this axis for equality with an arbitrary object.

Parameters

obj	the object (`null` permitted).

Returns

A boolean.

public DateFormat getDateFormatOverride ()

Returns the date format override. If this is non-null, then it will be used to format the dates on the axis.

Returns

The formatter (possibly null).

public Date getMaximumDate ()

Returns the latest date visible on the axis.

Returns

The date.

public Date getMinimumDate ()

Returns the earliest date visible on the axis.

Returns

The date.

public DateTickMarkPosition getTickMarkPosition ()

Returns the tick mark position (start, middle or end of the time period).

Returns

The position (never null).

public DateTickUnit getTickUnit ()

Returns the tick unit for the axis.

Note: if the autoTickUnitSelection flag is true the tick unit may be changed while the axis is being drawn, so in that case the return value from this method may be irrelevant if the method is called before the axis has been drawn.

Returns

The tick unit (possibly null).

public TimeZone getTimeZone ()

Returns the time zone for the axis.

Returns

The time zone (never null).

public Timeline getTimeline ()

Returns the underlying timeline used by this axis.

Returns

The timeline.

public int hashCode ()

Returns a hash code for this object.

Returns

A hash code.

public boolean isHiddenValue (long millis)

Returns true if the axis hides this value, and false otherwise.

Parameters

millis	the data value.

Returns

A value.

public double java2DToValue (double java2DValue, Rectangle2D area, RectangleEdge edge)

Translates a Java2D coordinate into the corresponding data value. To perform this translation, you need to know the area used for plotting data, and which edge the axis is located on.

Parameters

java2DValue	the coordinate in Java2D space.
area	the rectangle (in Java2D space) where the data is to be plotted.
edge	the axis location.

Returns

A data value.

public List refreshTicks (Graphics2D g2, AxisState state, Rectangle2D dataArea, RectangleEdge edge)

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

Parameters

g2	the graphics device.
state	the axis state.
dataArea	the area in which the plot should be drawn.
edge	the location of the axis.

Returns

A list of ticks.

public void setDateFormatOverride (DateFormat formatter)

Sets the date format override. If this is non-null, then it will be used to format the dates on the axis.

Parameters

formatter	the date formatter (`null` permitted).

public void setMaximumDate (Date maximumDate)

Sets the maximum date visible on the axis and sends an AxisChangeEvent to all registered listeners. If maximumDate is on or before the current minimum date for the axis, the minimum date will be shifted to preserve the current length of the axis.

Parameters

maximumDate	the date (`null` not permitted).

public void setMinimumDate (Date date)

Sets the minimum date visible on the axis and sends an AxisChangeEvent to all registered listeners. If date is on or after the current maximum date for the axis, the maximum date will be shifted to preserve the current length of the axis.

Parameters

date	the date (`null` not permitted).

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).

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.

public void setRange (double lower, double upper)

Sets the axis range and sends an AxisChangeEvent to all registered listeners.

Parameters

lower	the lower bound for the axis.
upper	the upper bound for the axis.

public void setRange (Range range)

Sets the upper and lower bounds for the axis and sends an AxisChangeEvent to all registered listeners. As a side-effect, the auto-range flag is set to false.

Parameters

range	the new range (`null` not permitted).

public void setRange (Date lower, Date upper)

Sets the axis range and sends an AxisChangeEvent to all registered listeners.

Parameters

lower	the lower bound for the axis.
upper	the upper bound for the axis.

public void setTickMarkPosition (DateTickMarkPosition position)

Sets the tick mark position (start, middle or end of the time period) and sends an AxisChangeEvent to all registered listeners.

Parameters

position	the position (`null` not permitted).

public void setTickUnit (DateTickUnit unit)

Sets the tick unit for the axis. The auto-tick-unit-selection flag is set to false, and registered listeners are notified that the axis has been changed.

Parameters

unit	the tick unit.

public void setTickUnit (DateTickUnit unit, boolean notify, boolean turnOffAutoSelection)

Sets the tick unit attribute.

Parameters

unit	the new tick unit.
notify	notify registered listeners?
turnOffAutoSelection	turn off auto selection?

public void setTimeZone (TimeZone zone)

Sets the time zone for the axis and sends an AxisChangeEvent to all registered listeners.

Parameters

zone	the time zone (`null` not permitted).

public void setTimeline (Timeline timeline)

Sets the underlying timeline to use for this axis.

If the timeline is changed, an AxisChangeEvent is sent to all registered listeners.

Parameters

timeline	the timeline.

public double valueToJava2D (double value, Rectangle2D area, RectangleEdge edge)

Translates the data value to the display coordinates (Java 2D User Space) of the chart.

Parameters

value	the date to be plotted.
area	the rectangle (in Java2D space) where the data is to be plotted.
edge	the axis location.

Returns

The coordinate corresponding to the supplied data value.

public void zoomRange (double lowerPercent, double upperPercent)

Zooms in on the current range.

Parameters

lowerPercent	the new lower bound.
upperPercent	the new upper bound.

Protected Methods

protected void autoAdjustRange ()

Rescales the axis to ensure that all data is visible.

protected Date nextStandardDate (Date date, DateTickUnit unit)

Returns the first "standard" date (based on the specified field and units).

Parameters

date	the reference date.
unit	the date tick unit.

Returns

The next "standard" date.

protected Date previousStandardDate (Date date, DateTickUnit unit)

Returns the previous "standard" date, for a given date and tick unit.

Parameters

date	the reference date.
unit	the tick unit.

Returns

The previous "standard" date.

protected List refreshTicksHorizontal (Graphics2D g2, Rectangle2D dataArea, RectangleEdge edge)

Recalculates the ticks for the date axis.

Parameters

g2	the graphics device.
dataArea	the area in which the data is to be drawn.
edge	the location of the axis.

Returns

A list of ticks.

protected List refreshTicksVertical (Graphics2D g2, Rectangle2D dataArea, RectangleEdge edge)

Recalculates the ticks for the date axis.

Parameters

g2	the graphics device.
dataArea	the area in which the plot should be drawn.
edge	the location of the axis.

Returns

A list of ticks.

protected void selectAutoTickUnit (Graphics2D g2, Rectangle2D dataArea, RectangleEdge edge)

Selects an appropriate tick value for the axis. The strategy is to display as many ticks as possible (selected from an array of 'standard' tick units) without the labels overlapping.

Parameters

g2	the graphics device.
dataArea	the area defined by the axes.
edge	the axis location.

protected void selectHorizontalAutoTickUnit (Graphics2D g2, Rectangle2D dataArea, RectangleEdge edge)

Selects an appropriate tick size for the axis. The strategy is to display as many ticks as possible (selected from a collection of 'standard' tick units) without the labels overlapping.

Parameters

g2	the graphics device.
dataArea	the area defined by the axes.
edge	the axis location.

protected void selectVerticalAutoTickUnit (Graphics2D g2, Rectangle2D dataArea, RectangleEdge edge)

Selects an appropriate tick size for the axis. The strategy is to display as many ticks as possible (selected from a collection of 'standard' tick units) without the labels overlapping.

Parameters

g2	the graphics device.
dataArea	the area in which the plot should be drawn.
edge	the axis location.

Interfaces

Classes

DateAxis

Class Overview

Summary

Constants

public static final double DEFAULT_AUTO_RANGE_MINIMUM_SIZE_IN_MILLISECONDS

Fields

public static final Date DEFAULT_ANCHOR_DATE

public static final DateRange DEFAULT_DATE_RANGE

public static final DateTickUnit DEFAULT_DATE_TICK_UNIT

Public Constructors

public DateAxis ()

public DateAxis (String label)

Parameters

public DateAxis (String label, TimeZone zone)

Parameters

See Also

public DateAxis (String label, TimeZone zone, Locale locale)

Parameters

See Also

Public Methods

public Date calculateHighestVisibleTickValue (DateTickUnit unit)

Parameters

Returns

public Date calculateLowestVisibleTickValue (DateTickUnit unit)

Parameters

Returns

public Object clone ()

Returns

Throws

public void configure ()

public static TickUnitSource createStandardDateTickUnits (TimeZone zone)

Parameters

Returns

public static TickUnitSource createStandardDateTickUnits (TimeZone zone, Locale locale)

Parameters

Returns

public static TickUnitSource createStandardDateTickUnits ()

Returns

public double dateToJava2D (Date date, Rectangle2D area, RectangleEdge edge)

Parameters

Returns

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

Parameters

Returns

public boolean equals (Object obj)

Parameters

Returns

public DateFormat getDateFormatOverride ()

Returns

public Date getMaximumDate ()

Returns

See Also

public Date getMinimumDate ()

Returns

See Also

public DateTickMarkPosition getTickMarkPosition ()

Returns

public DateTickUnit getTickUnit ()

Returns

See Also

public TimeZone getTimeZone ()

Returns

See Also

public Timeline getTimeline ()

Returns

public int hashCode ()

Returns

public boolean isHiddenValue (long millis)

Parameters

Returns

public double java2DToValue (double java2DValue, Rectangle2D area, RectangleEdge edge)

Parameters

Returns

public List refreshTicks (Graphics2D g2, AxisState state, Rectangle2D dataArea, RectangleEdge edge)

Parameters

Returns

public void setDateFormatOverride (DateFormat formatter)

Parameters