JFreeChart 1.0.14-redhat-2

org.jfree.chart.axis
Class PeriodAxisLabelInfo

java.lang.Object
  extended by org.jfree.chart.axis.PeriodAxisLabelInfo
All Implemented Interfaces:
Serializable, Cloneable

public class PeriodAxisLabelInfo
extends Object
implements Cloneable, Serializable

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

See Also:
Serialized Form

Field Summary
static Paint DEFAULT_DIVIDER_PAINT
          The default divider paint.
static Stroke DEFAULT_DIVIDER_STROKE
          The default divider stroke.
static Font DEFAULT_FONT
          The default font.
static org.jfree.ui.RectangleInsets DEFAULT_INSETS
          The default insets.
static Paint DEFAULT_LABEL_PAINT
          The default label paint.
 
Constructor Summary
PeriodAxisLabelInfo(Class periodClass, DateFormat dateFormat)
          Creates a new instance.
PeriodAxisLabelInfo(Class periodClass, DateFormat dateFormat, org.jfree.ui.RectangleInsets padding, Font labelFont, Paint labelPaint, boolean drawDividers, Stroke dividerStroke, Paint dividerPaint)
          Creates a new instance.
 
Method Summary
 Object clone()
          Returns a clone of the object.
 RegularTimePeriod createInstance(Date millisecond, TimeZone zone)
          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.
 org.jfree.ui.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.
 
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

DEFAULT_INSETS

public static final org.jfree.ui.RectangleInsets DEFAULT_INSETS
The default insets.


DEFAULT_FONT

public static final Font DEFAULT_FONT
The default font.


DEFAULT_LABEL_PAINT

public static final Paint DEFAULT_LABEL_PAINT
The default label paint.


DEFAULT_DIVIDER_STROKE

public static final Stroke DEFAULT_DIVIDER_STROKE
The default divider stroke.


DEFAULT_DIVIDER_PAINT

public static final Paint DEFAULT_DIVIDER_PAINT
The default divider paint.

Constructor Detail

PeriodAxisLabelInfo

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

PeriodAxisLabelInfo

public PeriodAxisLabelInfo(Class periodClass,
                           DateFormat dateFormat,
                           org.jfree.ui.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).
Method Detail

getPeriodClass

public Class getPeriodClass()
Returns the subclass of RegularTimePeriod that should be used to generate the date labels.

Returns:
The class.

getDateFormat

public DateFormat getDateFormat()
Returns the date formatter.

Returns:
The date formatter (never null).

getPadding

public org.jfree.ui.RectangleInsets getPadding()
Returns the padding for the band.

Returns:
The padding.

getLabelFont

public Font getLabelFont()
Returns the label font.

Returns:
The label font (never null).

getLabelPaint

public Paint getLabelPaint()
Returns the label paint.

Returns:
The label paint.

getDrawDividers

public boolean getDrawDividers()
Returns a flag that controls whether or not dividers are drawn.

Returns:
A flag.

getDividerStroke

public Stroke getDividerStroke()
Returns the stroke used to draw the dividers.

Returns:
The stroke.

getDividerPaint

public Paint getDividerPaint()
Returns the paint used to draw the dividers.

Returns:
The paint.

createInstance

public RegularTimePeriod createInstance(Date millisecond,
                                        TimeZone zone)
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.

createInstance

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.
Since:
1.0.13.

equals

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

Overrides:
equals in class Object
Parameters:
obj - the object to test against (null permitted).
Returns:
A boolean.

hashCode

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

Overrides:
hashCode in class Object
Returns:
A hash code.

clone

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

Overrides:
clone in class Object
Returns:
A clone.
Throws:
CloneNotSupportedException - if cloning is not supported.

JFreeChart 1.0.14-redhat-2

Copyright © 2001-2012 JFree.org. All Rights Reserved.