org.jfree.chart.axis

Class DateAxis

public class DateAxis extends ValueAxis implements Cloneable, Serializable

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.

Field Summary
static DateDEFAULT_ANCHOR_DATE
The default anchor date.
static doubleDEFAULT_AUTO_RANGE_MINIMUM_SIZE_IN_MILLISECONDS
The default minimum auto range size.
static DateRangeDEFAULT_DATE_RANGE
The default axis range.
static DateTickUnitDEFAULT_DATE_TICK_UNIT
The default date tick unit.
Constructor Summary
DateAxis()
Creates a date axis with no label.
DateAxis(String label)
Creates a date axis with the specified label.
DateAxis(String label, TimeZone zone)
Creates a date axis.
Method Summary
protected voidautoAdjustRange()
Rescales the axis to ensure that all data is visible.
DatecalculateHighestVisibleTickValue(DateTickUnit unit)
Calculates the value of the highest visible tick on the axis.
DatecalculateLowestVisibleTickValue(DateTickUnit unit)
Calculates the value of the lowest visible tick on the axis.
Objectclone()
Returns a clone of the object.
voidconfigure()
Configures the axis to work with the specified plot.
static TickUnitSourcecreateStandardDateTickUnits()
Returns a collection of standard date tick units that uses the default time zone.
static TickUnitSourcecreateStandardDateTickUnits(TimeZone zone)
Returns a collection of standard date tick units.
doubledateToJava2D(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.
AxisStatedraw(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).
booleanequals(Object obj)
Tests this axis for equality with an arbitrary object.
DateFormatgetDateFormatOverride()
Returns the date format override.
DategetMaximumDate()
Returns the latest date visible on the axis.
DategetMinimumDate()
Returns the earliest date visible on the axis.
DateTickMarkPositiongetTickMarkPosition()
Returns the tick mark position (start, middle or end of the time period).
DateTickUnitgetTickUnit()
Returns the tick unit for the axis.
TimelinegetTimeline()
Returns the underlying timeline used by this axis.
TimeZonegetTimeZone()
Returns the time zone for the axis.
inthashCode()
Returns a hash code for this object.
booleanisHiddenValue(long millis)
Returns true if the axis hides this value, and false otherwise.
doublejava2DToValue(double java2DValue, Rectangle2D area, RectangleEdge edge)
Translates a Java2D coordinate into the corresponding data value.
protected DatenextStandardDate(Date date, DateTickUnit unit)
Returns the first "standard" date (based on the specified field and units).
protected DatepreviousStandardDate(Date date, DateTickUnit unit)
Returns the previous "standard" date, for a given date and tick unit.
ListrefreshTicks(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).
protected ListrefreshTicksHorizontal(Graphics2D g2, Rectangle2D dataArea, RectangleEdge edge)
Recalculates the ticks for the date axis.
protected ListrefreshTicksVertical(Graphics2D g2, Rectangle2D dataArea, RectangleEdge edge)
Recalculates the ticks for the date axis.
protected voidselectAutoTickUnit(Graphics2D g2, Rectangle2D dataArea, RectangleEdge edge)
Selects an appropriate tick value for the axis.
protected voidselectHorizontalAutoTickUnit(Graphics2D g2, Rectangle2D dataArea, RectangleEdge edge)
Selects an appropriate tick size for the axis.
protected voidselectVerticalAutoTickUnit(Graphics2D g2, Rectangle2D dataArea, RectangleEdge edge)
Selects an appropriate tick size for the axis.
voidsetDateFormatOverride(DateFormat formatter)
Sets the date format override.
voidsetMaximumDate(Date maximumDate)
Sets the maximum date visible on the axis and sends an AxisChangeEvent to all registered listeners.
voidsetMinimumDate(Date date)
Sets the minimum date visible on the axis and sends an AxisChangeEvent to all registered listeners.
voidsetRange(Range range)
Sets the upper and lower bounds for the axis and sends an AxisChangeEvent to all registered listeners.
voidsetRange(Range range, boolean turnOffAutoRange, boolean notify)
Sets the range for the axis, if requested, sends an AxisChangeEvent to all registered listeners.
voidsetRange(Date lower, Date upper)
Sets the axis range and sends an AxisChangeEvent to all registered listeners.
voidsetRange(double lower, double upper)
Sets the axis range and sends an AxisChangeEvent to all registered listeners.
voidsetTickMarkPosition(DateTickMarkPosition position)
Sets the tick mark position (start, middle or end of the time period) and sends an AxisChangeEvent to all registered listeners.
voidsetTickUnit(DateTickUnit unit)
Sets the tick unit for the axis.
voidsetTickUnit(DateTickUnit unit, boolean notify, boolean turnOffAutoSelection)
Sets the tick unit attribute.
voidsetTimeline(Timeline timeline)
Sets the underlying timeline to use for this axis.
voidsetTimeZone(TimeZone zone)
Sets the time zone for the axis and sends an AxisChangeEvent to all registered listeners.
doublevalueToJava2D(double value, Rectangle2D area, RectangleEdge edge)
Translates the data value to the display coordinates (Java 2D User Space) of the chart.
voidzoomRange(double lowerPercent, double upperPercent)
Zooms in on the current range.

Field Detail

DEFAULT_ANCHOR_DATE

public static final Date DEFAULT_ANCHOR_DATE
The default anchor date.

DEFAULT_AUTO_RANGE_MINIMUM_SIZE_IN_MILLISECONDS

public static final double DEFAULT_AUTO_RANGE_MINIMUM_SIZE_IN_MILLISECONDS
The default minimum auto range size.

DEFAULT_DATE_RANGE

public static final DateRange DEFAULT_DATE_RANGE
The default axis range.

DEFAULT_DATE_TICK_UNIT

public static final DateTickUnit DEFAULT_DATE_TICK_UNIT
The default date tick unit.

Constructor Detail

DateAxis

public DateAxis()
Creates a date axis with no label.

DateAxis

public DateAxis(String label)
Creates a date axis with the specified label.

Parameters: label the axis label (null permitted).

DateAxis

public DateAxis(String label, TimeZone zone)
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.

See Also:

Method Detail

autoAdjustRange

protected void autoAdjustRange()
Rescales the axis to ensure that all data is visible.

calculateHighestVisibleTickValue

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.

calculateLowestVisibleTickValue

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.

clone

public Object clone()
Returns a clone of the object.

Returns: A clone.

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

configure

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.

createStandardDateTickUnits

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 method inherited from the ValueAxis class).

Returns: A collection of standard date tick units.

createStandardDateTickUnits

public static TickUnitSource createStandardDateTickUnits(TimeZone 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 method inherited from the ValueAxis class).

Parameters: zone the time zone (null not permitted).

Returns: A collection of standard date tick units.

dateToJava2D

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.

draw

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

equals

public boolean equals(Object obj)
Tests this axis for equality with an arbitrary object.

Parameters: obj the object (null permitted).

Returns: A boolean.

getDateFormatOverride

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

getMaximumDate

public Date getMaximumDate()
Returns the latest date visible on the axis.

Returns: The date.

See Also: setMaximumDate getMinimumDate

getMinimumDate

public Date getMinimumDate()
Returns the earliest date visible on the axis.

Returns: The date.

See Also: setMinimumDate getMaximumDate

getTickMarkPosition

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

Returns: The position (never null).

getTickUnit

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

See Also: setTickUnit isAutoTickUnitSelection

getTimeline

public Timeline getTimeline()
Returns the underlying timeline used by this axis.

Returns: The timeline.

getTimeZone

public TimeZone getTimeZone()
Returns the time zone for the axis.

Returns: The time zone.

Since: 1.0.4

See Also: setTimeZone

hashCode

public int hashCode()
Returns a hash code for this object.

Returns: A hash code.

isHiddenValue

public boolean isHiddenValue(long millis)
Returns true if the axis hides this value, and false otherwise.

Parameters: millis the data value.

Returns: A value.

java2DToValue

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.

nextStandardDate

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.

previousStandardDate

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.

refreshTicks

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.

refreshTicksHorizontal

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.

refreshTicksVertical

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.

selectAutoTickUnit

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.

selectHorizontalAutoTickUnit

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.

selectVerticalAutoTickUnit

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.

setDateFormatOverride

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

setMaximumDate

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

See Also: getMinimumDate setMinimumDate

setMinimumDate

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

See Also: getMinimumDate setMaximumDate

setRange

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

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

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.

setRange

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.

setRange

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.

setTickMarkPosition

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

setTickUnit

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.

See Also: getTickUnit DateAxis

setTickUnit

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?

See Also: getTickUnit

setTimeline

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.

setTimeZone

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

Since: 1.0.4

See Also: getTimeZone

valueToJava2D

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.

zoomRange

public void zoomRange(double lowerPercent, double upperPercent)
Zooms in on the current range.

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