public class

PeriodAxisLabelInfo

extends Object
implements Serializable Cloneable
java.lang.Object
   ↳ org.jfree.chart.axis.PeriodAxisLabelInfo

Class Overview

A record that contains information for one "band" of date labels in a PeriodAxis.

Summary

Fields
public static final Paint DEFAULT_DIVIDER_PAINT The default divider paint.
public static final Stroke DEFAULT_DIVIDER_STROKE The default divider stroke.
public static final Font DEFAULT_FONT The default font.
public static final RectangleInsets DEFAULT_INSETS The default insets.
public static final Paint DEFAULT_LABEL_PAINT The default label paint.
Public Constructors
PeriodAxisLabelInfo(Class periodClass, DateFormat dateFormat)
Creates a new instance.
PeriodAxisLabelInfo(Class periodClass, DateFormat dateFormat, RectangleInsets padding, Font labelFont, Paint labelPaint, boolean drawDividers, Stroke dividerStroke, Paint dividerPaint)
Creates a new instance.
Public Methods
Object clone()
Returns a clone of the object.
RegularTimePeriod createInstance(Date millisecond, TimeZone zone)
This method is deprecated. As of 1.0.13, use the method that specifies the locale also.
RegularTimePeriod createInstance(Date millisecond, TimeZone zone, Locale locale)
Creates a time period that includes the specified millisecond, assuming the given time zone.
boolean equals(Object obj)
Tests this object for equality with an arbitrary object.
DateFormat getDateFormat()
Returns the date formatter.
Paint getDividerPaint()
Returns the paint used to draw the dividers.
Stroke getDividerStroke()
Returns the stroke used to draw the dividers.
boolean getDrawDividers()
Returns a flag that controls whether or not dividers are drawn.
Font getLabelFont()
Returns the label font.
Paint getLabelPaint()
Returns the label paint.
RectangleInsets getPadding()
Returns the padding for the band.
Class getPeriodClass()
Returns the subclass of RegularTimePeriod that should be used to generate the date labels.
int hashCode()
Returns a hash code for this object.
[Expand]
Inherited Methods
From class java.lang.Object

Fields

public static final Paint DEFAULT_DIVIDER_PAINT

The default divider paint.

public static final Stroke DEFAULT_DIVIDER_STROKE

The default divider stroke.

public static final Font DEFAULT_FONT

The default font.

public static final RectangleInsets DEFAULT_INSETS

The default insets.

public static final Paint DEFAULT_LABEL_PAINT

The default label paint.

Public Constructors

public PeriodAxisLabelInfo (Class periodClass, DateFormat dateFormat)

Creates a new instance.

Parameters
periodClass the subclass of RegularTimePeriod to use (null not permitted).
dateFormat the date format (null not permitted).

public PeriodAxisLabelInfo (Class periodClass, DateFormat dateFormat, RectangleInsets padding, Font labelFont, Paint labelPaint, boolean drawDividers, Stroke dividerStroke, Paint dividerPaint)

Creates a new instance.

Parameters
periodClass the subclass of RegularTimePeriod to use (null not permitted).
dateFormat the date format (null not permitted).
padding controls the space around the band (null not permitted).
labelFont the label font (null not permitted).
labelPaint the label paint (null not permitted).
drawDividers a flag that controls whether dividers are drawn.
dividerStroke the stroke used to draw the dividers (null not permitted).
dividerPaint the paint used to draw the dividers (null not permitted).

Public Methods

public Object clone ()

Returns a clone of the object.

Returns
  • A clone.
Throws
CloneNotSupportedException if cloning is not supported.

public RegularTimePeriod createInstance (Date millisecond, TimeZone zone)

This method is deprecated.
As of 1.0.13, use the method that specifies the locale also.

Creates a time period that includes the specified millisecond, assuming the given time zone.

Parameters
millisecond the time.
zone the time zone.
Returns
  • The time period.

public RegularTimePeriod createInstance (Date millisecond, TimeZone zone, Locale locale)

Creates a time period that includes the specified millisecond, assuming the given time zone.

Parameters
millisecond the time.
zone the time zone.
locale the locale.
Returns
  • The time period.

public boolean equals (Object obj)

Tests this object for equality with an arbitrary object.

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

public DateFormat getDateFormat ()

Returns the date formatter.

Returns
  • The date formatter (never null).

public Paint getDividerPaint ()

Returns the paint used to draw the dividers.

Returns
  • The paint.

public Stroke getDividerStroke ()

Returns the stroke used to draw the dividers.

Returns
  • The stroke.

public boolean getDrawDividers ()

Returns a flag that controls whether or not dividers are drawn.

Returns
  • A flag.

public Font getLabelFont ()

Returns the label font.

Returns
  • The label font (never null).

public Paint getLabelPaint ()

Returns the label paint.

Returns
  • The label paint.

public RectangleInsets getPadding ()

Returns the padding for the band.

Returns
  • The padding.

public Class getPeriodClass ()

Returns the subclass of RegularTimePeriod that should be used to generate the date labels.

Returns
  • The class.

public int hashCode ()

Returns a hash code for this object.

Returns
  • A hash code.