public class

ModuloAxis

extends NumberAxis

java.lang.Object
↳	org.jfree.chart.axis.Axis
	↳	org.jfree.chart.axis.ValueAxis
		↳	org.jfree.chart.axis.NumberAxis
			↳	org.jfree.chart.axis.ModuloAxis

Class Overview

An axis that displays numerical values within a fixed range using a modulo calculation.

Summary

[Expand]

Inherited Constants

From class org.jfree.chart.axis.NumberAxis

From class org.jfree.chart.axis.ValueAxis

From class org.jfree.chart.axis.Axis

[Expand]

Inherited Fields

From class org.jfree.chart.axis.NumberAxis

From class org.jfree.chart.axis.ValueAxis

From class org.jfree.chart.axis.Axis

Public Constructors
	ModuloAxis(String label, Range fixedRange) Creates a new axis.

Public Methods
boolean	equals(Object obj) Tests this axis for equality with an arbitrary object.
double	getDisplayEnd() Returns the display end value.
double	getDisplayStart() Returns the display start value.
double	java2DToValue(double java2DValue, Rectangle2D area, RectangleEdge edge) Translates a Java2D coordinate into a data value.
double	lengthToJava2D(double length, Rectangle2D area, RectangleEdge edge) Converts a length in data coordinates into the corresponding length in Java2D coordinates.
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	setDisplayRange(double start, double end) Sets the display range.
double	valueToJava2D(double value, Rectangle2D area, RectangleEdge edge) Translates a data value to a Java2D coordinate.

Protected Methods
void	autoAdjustRange() This method should calculate a range that will show all the data values.

[Expand]

Inherited Methods

From class org.jfree.chart.axis.NumberAxis

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

Public Constructors

public ModuloAxis (String label, Range fixedRange)

Creates a new axis.

Parameters

label	the axis label (`null` permitted).
fixedRange	the fixed range (`null` not permitted).

Public Methods

public boolean equals (Object obj)

Tests this axis for equality with an arbitrary object.

Parameters

obj	the object (`null` permitted).

Returns

A boolean.

public double getDisplayEnd ()

Returns the display end value.

Returns

The display end value.

public double getDisplayStart ()

Returns the display start value.

Returns

The display start value.

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

Translates a Java2D coordinate into a data value.

Parameters

java2DValue	the Java2D coordinate.
area	the area.
edge	the edge.

Returns

The Java2D coordinate.

public double lengthToJava2D (double length, Rectangle2D area, RectangleEdge edge)

Converts a length in data coordinates into the corresponding length in Java2D coordinates.

Parameters

length	the length.
area	the plot area.
edge	the edge along which the axis lies.

Returns

The length in Java2D coordinates.

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

To double the length of the axis range, use 200% (2.0). To halve the length of the axis range, use 50% (0.5).

Parameters

percent	the resize factor.

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

To double the length of the axis range, use 200% (2.0). To halve the length of the axis range, use 50% (0.5).

Parameters

percent	the resize factor.
anchorValue	the new central value after the resize.

public void setDisplayRange (double start, double end)

Sets the display range. The values will be mapped to the fixed range if necessary.

Parameters

start	the start value.
end	the end value.

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

Translates a data value to a Java2D coordinate.

Parameters

value	the value.
area	the area.
edge	the edge.

Returns

A Java2D coordinate.

Protected Methods

protected void autoAdjustRange ()

This method should calculate a range that will show all the data values. For now, it just sets the axis range to the fixedRange.

Interfaces

Classes

ModuloAxis

Class Overview

Summary

Public Constructors

public ModuloAxis (String label, Range fixedRange)

Parameters

Public Methods

public boolean equals (Object obj)

Parameters

Returns

public double getDisplayEnd ()

Returns

public double getDisplayStart ()

Returns

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

Parameters

Returns

public double lengthToJava2D (double length, Rectangle2D area, RectangleEdge edge)

Parameters

Returns

public void resizeRange (double percent)

Parameters

public void resizeRange (double percent, double anchorValue)

Parameters

public void setDisplayRange (double start, double end)

Parameters

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

Parameters

Returns

Protected Methods

protected void autoAdjustRange ()