Home » jcommon-1.0.13 » org.jfree » chart » axis » [javadoc | source]

org.jfree.chart.axis
public class: NumberAxis [javadoc | source]

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

All Implemented Interfaces:
    Cloneable, Serializable, PublicCloneable

Direct Known Subclasses:
    NumberAxis3D, LogarithmicAxis, ModuloAxis, CyclicNumberAxis, SymbolicAxis, SymbolAxis

An axis for displaying numerical data.

If the axis is set up to automatically determine its range to fit the data, you can ensure that the range includes zero (statisticians usually prefer this) by setting the autoRangeIncludesZero flag to true.

The NumberAxis class has a mechanism for automatically selecting a tick unit that is appropriate for the current axis range. This mechanism is an adaptation of code suggested by Laurence Vanhelsuwe.

Field Summary
public static final  boolean	DEFAULT_AUTO_RANGE_INCLUDES_ZERO	The default value for the autoRangeIncludesZero flag.
public static final  boolean	DEFAULT_AUTO_RANGE_STICKY_ZERO	The default value for the autoRangeStickyZero flag.
public static final  NumberTickUnit	DEFAULT_TICK_UNIT	The default tick unit.
public static final  boolean	DEFAULT_VERTICAL_TICK_LABELS	The default setting for the vertical tick labels flag.

Fields inherited from org.jfree.chart.axis.ValueAxis:
DEFAULT_RANGE,  DEFAULT_AUTO_RANGE,  DEFAULT_INVERTED,  DEFAULT_AUTO_RANGE_MINIMUM_SIZE,  DEFAULT_LOWER_MARGIN,  DEFAULT_UPPER_MARGIN,  DEFAULT_LOWER_BOUND,  DEFAULT_UPPER_BOUND,  DEFAULT_AUTO_TICK_UNIT_SELECTION,  MAXIMUM_TICK_COUNT

Fields inherited from org.jfree.chart.axis.Axis:

DEFAULT_AXIS_VISIBLE,  DEFAULT_AXIS_LABEL_FONT,  DEFAULT_AXIS_LABEL_PAINT,  DEFAULT_AXIS_LABEL_INSETS,  DEFAULT_AXIS_LINE_PAINT,  DEFAULT_AXIS_LINE_STROKE,  DEFAULT_TICK_LABELS_VISIBLE,  DEFAULT_TICK_LABEL_FONT,  DEFAULT_TICK_LABEL_PAINT,  DEFAULT_TICK_LABEL_INSETS,  DEFAULT_TICK_MARKS_VISIBLE,  DEFAULT_TICK_MARK_STROKE,  DEFAULT_TICK_MARK_PAINT,  DEFAULT_TICK_MARK_INSIDE_LENGTH,  DEFAULT_TICK_MARK_OUTSIDE_LENGTH

Constructor:
public NumberAxis() { this(null); } Default constructor.
public NumberAxis(String label) { super(label, NumberAxis.createStandardTickUnits()); this.rangeType = RangeType.FULL; this.autoRangeIncludesZero = DEFAULT_AUTO_RANGE_INCLUDES_ZERO; this.autoRangeStickyZero = DEFAULT_AUTO_RANGE_STICKY_ZERO; this.tickUnit = DEFAULT_TICK_UNIT; this.numberFormatOverride = null; this.markerBand = null; } Constructs a number axis, using default values where necessary. Parameters: label - the axis label (null permitted).

Method from org.jfree.chart.axis.NumberAxis Summary:

autoAdjustRange,   calculateHighestVisibleTickValue,   calculateLowestVisibleTickValue,   calculateVisibleTickCount,   clone,   configure,   createIntegerTickUnits,   createIntegerTickUnits,   createStandardTickUnits,   createStandardTickUnits,   draw,   equals,   estimateMaximumTickLabelHeight,   estimateMaximumTickLabelWidth,   getAutoRangeIncludesZero,   getAutoRangeStickyZero,   getMarkerBand,   getNumberFormatOverride,   getRangeType,   getTickUnit,   hashCode,   java2DToValue,   refreshTicks,   refreshTicksHorizontal,   refreshTicksVertical,   selectAutoTickUnit,   selectHorizontalAutoTickUnit,   selectVerticalAutoTickUnit,   setAutoRangeIncludesZero,   setAutoRangeStickyZero,   setMarkerBand,   setNumberFormatOverride,   setRangeType,   setTickUnit,   setTickUnit,   valueToJava2D

Methods from org.jfree.chart.axis.ValueAxis:

autoAdjustRange,   calculateAnchorPoint,   centerRange,   clone,   drawAxisLine,   drawTickMarksAndLabels,   equals,   findMaximumTickLabelHeight,   findMaximumTickLabelWidth,   getAutoRangeMinimumSize,   getAutoTickIndex,   getDefaultAutoRange,   getDownArrow,   getFixedAutoRange,   getLeftArrow,   getLowerBound,   getLowerMargin,   getRange,   getRightArrow,   getStandardTickUnits,   getUpArrow,   getUpperBound,   getUpperMargin,   isAutoRange,   isAutoTickUnitSelection,   isInverted,   isNegativeArrowVisible,   isPositiveArrowVisible,   isVerticalTickLabels,   java2DToValue,   lengthToJava2D,   reserveSpace,   resizeRange,   resizeRange,   setAutoRange,   setAutoRange,   setAutoRangeMinimumSize,   setAutoRangeMinimumSize,   setAutoTickIndex,   setAutoTickUnitSelection,   setAutoTickUnitSelection,   setDefaultAutoRange,   setDownArrow,   setFixedAutoRange,   setInverted,   setLeftArrow,   setLowerBound,   setLowerMargin,   setNegativeArrowVisible,   setPositiveArrowVisible,   setRange,   setRange,   setRange,   setRangeAboutValue,   setRangeWithMargins,   setRangeWithMargins,   setRangeWithMargins,   setRightArrow,   setStandardTickUnits,   setUpArrow,   setUpperBound,   setUpperMargin,   setVerticalTickLabels,   valueToJava2D,   zoomRange

Methods from org.jfree.chart.axis.Axis:

addChangeListener,   clone,   configure,   draw,   drawAxisLine,   drawLabel,   equals,   getAxisLinePaint,   getAxisLineStroke,   getFixedDimension,   getLabel,   getLabelAngle,   getLabelEnclosure,   getLabelFont,   getLabelInsets,   getLabelPaint,   getPlot,   getTickLabelFont,   getTickLabelInsets,   getTickLabelPaint,   getTickMarkInsideLength,   getTickMarkOutsideLength,   getTickMarkPaint,   getTickMarkStroke,   hasListener,   isAxisLineVisible,   isTickLabelsVisible,   isTickMarksVisible,   isVisible,   notifyListeners,   refreshTicks,   removeChangeListener,   reserveSpace,   setAxisLinePaint,   setAxisLineStroke,   setAxisLineVisible,   setFixedDimension,   setLabel,   setLabelAngle,   setLabelFont,   setLabelInsets,   setLabelInsets,   setLabelPaint,   setPlot,   setTickLabelFont,   setTickLabelInsets,   setTickLabelPaint,   setTickLabelsVisible,   setTickMarkInsideLength,   setTickMarkOutsideLength,   setTickMarkPaint,   setTickMarkStroke,   setTickMarksVisible,   setVisible

Methods from java.lang.Object:
equals,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait

Method from org.jfree.chart.axis.NumberAxis Detail:
protected void autoAdjustRange() { Plot plot = getPlot(); if (plot == null) { return; // no plot, no data } if (plot instanceof ValueAxisPlot) { ValueAxisPlot vap = (ValueAxisPlot) plot; Range r = vap.getDataRange(this); if (r == null) { r = getDefaultAutoRange(); } double upper = r.getUpperBound(); double lower = r.getLowerBound(); if (this.rangeType == RangeType.POSITIVE) { lower = Math.max(0.0, lower); upper = Math.max(0.0, upper); } else if (this.rangeType == RangeType.NEGATIVE) { lower = Math.min(0.0, lower); upper = Math.min(0.0, upper); } if (getAutoRangeIncludesZero()) { lower = Math.min(lower, 0.0); upper = Math.max(upper, 0.0); } double range = upper - lower; // if fixed auto range, then derive lower bound... double fixedAutoRange = getFixedAutoRange(); if (fixedAutoRange > 0.0) { lower = upper - fixedAutoRange; } else { // ensure the autorange is at least < minRange > in size... double minRange = getAutoRangeMinimumSize(); if (range < minRange) { double expand = (minRange - range) / 2; upper = upper + expand; lower = lower - expand; if (lower == upper) { // see bug report 1549218 double adjust = Math.abs(lower) / 10.0; lower = lower - adjust; upper = upper + adjust; } if (this.rangeType == RangeType.POSITIVE) { if (lower < 0.0) { upper = upper - lower; lower = 0.0; } } else if (this.rangeType == RangeType.NEGATIVE) { if (upper > 0.0) { lower = lower - upper; upper = 0.0; } } } if (getAutoRangeStickyZero()) { if (upper < = 0.0) { upper = Math.min(0.0, upper + getUpperMargin() * range); } else { upper = upper + getUpperMargin() * range; } if (lower >= 0.0) { lower = Math.max(0.0, lower - getLowerMargin() * range); } else { lower = lower - getLowerMargin() * range; } } else { upper = upper + getUpperMargin() * range; lower = lower - getLowerMargin() * range; } } setRange(new Range(lower, upper), false, false); } } Rescales the axis to ensure that all data is visible.
protected double calculateHighestVisibleTickValue() { double unit = getTickUnit().getSize(); double index = Math.floor(getRange().getUpperBound() / unit); return index * unit; } Calculates the value of the highest visible tick on the axis.
protected double calculateLowestVisibleTickValue() { double unit = getTickUnit().getSize(); double index = Math.ceil(getRange().getLowerBound() / unit); return index * unit; } Calculates the value of the lowest visible tick on the axis.
protected int calculateVisibleTickCount() { double unit = getTickUnit().getSize(); Range range = getRange(); return (int) (Math.floor(range.getUpperBound() / unit) - Math.ceil(range.getLowerBound() / unit) + 1); } Calculates the number of visible ticks.
public Object clone() throws CloneNotSupportedException { NumberAxis clone = (NumberAxis) super.clone(); if (this.numberFormatOverride != null) { clone.numberFormatOverride = (NumberFormat) this.numberFormatOverride.clone(); } return clone; } Returns a clone of the axis.
public void configure() { if (isAutoRange()) { autoAdjustRange(); } } 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 createIntegerTickUnits() { TickUnits units = new TickUnits(); DecimalFormat df0 = new DecimalFormat("0"); DecimalFormat df1 = new DecimalFormat("#,##0"); units.add(new NumberTickUnit(1, df0)); units.add(new NumberTickUnit(2, df0)); units.add(new NumberTickUnit(5, df0)); units.add(new NumberTickUnit(10, df0)); units.add(new NumberTickUnit(20, df0)); units.add(new NumberTickUnit(50, df0)); units.add(new NumberTickUnit(100, df0)); units.add(new NumberTickUnit(200, df0)); units.add(new NumberTickUnit(500, df0)); units.add(new NumberTickUnit(1000, df1)); units.add(new NumberTickUnit(2000, df1)); units.add(new NumberTickUnit(5000, df1)); units.add(new NumberTickUnit(10000, df1)); units.add(new NumberTickUnit(20000, df1)); units.add(new NumberTickUnit(50000, df1)); units.add(new NumberTickUnit(100000, df1)); units.add(new NumberTickUnit(200000, df1)); units.add(new NumberTickUnit(500000, df1)); units.add(new NumberTickUnit(1000000, df1)); units.add(new NumberTickUnit(2000000, df1)); units.add(new NumberTickUnit(5000000, df1)); units.add(new NumberTickUnit(10000000, df1)); units.add(new NumberTickUnit(20000000, df1)); units.add(new NumberTickUnit(50000000, df1)); units.add(new NumberTickUnit(100000000, df1)); units.add(new NumberTickUnit(200000000, df1)); units.add(new NumberTickUnit(500000000, df1)); units.add(new NumberTickUnit(1000000000, df1)); units.add(new NumberTickUnit(2000000000, df1)); units.add(new NumberTickUnit(5000000000.0, df1)); units.add(new NumberTickUnit(10000000000.0, df1)); return units; } Returns a collection of tick units for integer values.
public static TickUnitSource createIntegerTickUnits(Locale locale) { TickUnits units = new TickUnits(); NumberFormat numberFormat = NumberFormat.getNumberInstance(locale); units.add(new NumberTickUnit(1, numberFormat)); units.add(new NumberTickUnit(2, numberFormat)); units.add(new NumberTickUnit(5, numberFormat)); units.add(new NumberTickUnit(10, numberFormat)); units.add(new NumberTickUnit(20, numberFormat)); units.add(new NumberTickUnit(50, numberFormat)); units.add(new NumberTickUnit(100, numberFormat)); units.add(new NumberTickUnit(200, numberFormat)); units.add(new NumberTickUnit(500, numberFormat)); units.add(new NumberTickUnit(1000, numberFormat)); units.add(new NumberTickUnit(2000, numberFormat)); units.add(new NumberTickUnit(5000, numberFormat)); units.add(new NumberTickUnit(10000, numberFormat)); units.add(new NumberTickUnit(20000, numberFormat)); units.add(new NumberTickUnit(50000, numberFormat)); units.add(new NumberTickUnit(100000, numberFormat)); units.add(new NumberTickUnit(200000, numberFormat)); units.add(new NumberTickUnit(500000, numberFormat)); units.add(new NumberTickUnit(1000000, numberFormat)); units.add(new NumberTickUnit(2000000, numberFormat)); units.add(new NumberTickUnit(5000000, numberFormat)); units.add(new NumberTickUnit(10000000, numberFormat)); units.add(new NumberTickUnit(20000000, numberFormat)); units.add(new NumberTickUnit(50000000, numberFormat)); units.add(new NumberTickUnit(100000000, numberFormat)); units.add(new NumberTickUnit(200000000, numberFormat)); units.add(new NumberTickUnit(500000000, numberFormat)); units.add(new NumberTickUnit(1000000000, numberFormat)); units.add(new NumberTickUnit(2000000000, numberFormat)); units.add(new NumberTickUnit(5000000000.0, numberFormat)); units.add(new NumberTickUnit(10000000000.0, numberFormat)); return units; } Returns a collection of tick units for integer values. Uses a given Locale to create the DecimalFormats.
public static TickUnitSource createStandardTickUnits() { TickUnits units = new TickUnits(); DecimalFormat df0 = new DecimalFormat("0.00000000"); DecimalFormat df1 = new DecimalFormat("0.0000000"); DecimalFormat df2 = new DecimalFormat("0.000000"); DecimalFormat df3 = new DecimalFormat("0.00000"); DecimalFormat df4 = new DecimalFormat("0.0000"); DecimalFormat df5 = new DecimalFormat("0.000"); DecimalFormat df6 = new DecimalFormat("0.00"); DecimalFormat df7 = new DecimalFormat("0.0"); DecimalFormat df8 = new DecimalFormat("#,##0"); DecimalFormat df9 = new DecimalFormat("#,###,##0"); DecimalFormat df10 = new DecimalFormat("#,###,###,##0"); // we can add the units in any order, the TickUnits collection will // sort them... units.add(new NumberTickUnit(0.0000001, df1)); units.add(new NumberTickUnit(0.000001, df2)); units.add(new NumberTickUnit(0.00001, df3)); units.add(new NumberTickUnit(0.0001, df4)); units.add(new NumberTickUnit(0.001, df5)); units.add(new NumberTickUnit(0.01, df6)); units.add(new NumberTickUnit(0.1, df7)); units.add(new NumberTickUnit(1, df8)); units.add(new NumberTickUnit(10, df8)); units.add(new NumberTickUnit(100, df8)); units.add(new NumberTickUnit(1000, df8)); units.add(new NumberTickUnit(10000, df8)); units.add(new NumberTickUnit(100000, df8)); units.add(new NumberTickUnit(1000000, df9)); units.add(new NumberTickUnit(10000000, df9)); units.add(new NumberTickUnit(100000000, df9)); units.add(new NumberTickUnit(1000000000, df10)); units.add(new NumberTickUnit(10000000000.0, df10)); units.add(new NumberTickUnit(100000000000.0, df10)); units.add(new NumberTickUnit(0.00000025, df0)); units.add(new NumberTickUnit(0.0000025, df1)); units.add(new NumberTickUnit(0.000025, df2)); units.add(new NumberTickUnit(0.00025, df3)); units.add(new NumberTickUnit(0.0025, df4)); units.add(new NumberTickUnit(0.025, df5)); units.add(new NumberTickUnit(0.25, df6)); units.add(new NumberTickUnit(2.5, df7)); units.add(new NumberTickUnit(25, df8)); units.add(new NumberTickUnit(250, df8)); units.add(new NumberTickUnit(2500, df8)); units.add(new NumberTickUnit(25000, df8)); units.add(new NumberTickUnit(250000, df8)); units.add(new NumberTickUnit(2500000, df9)); units.add(new NumberTickUnit(25000000, df9)); units.add(new NumberTickUnit(250000000, df9)); units.add(new NumberTickUnit(2500000000.0, df10)); units.add(new NumberTickUnit(25000000000.0, df10)); units.add(new NumberTickUnit(250000000000.0, df10)); units.add(new NumberTickUnit(0.0000005, df1)); units.add(new NumberTickUnit(0.000005, df2)); units.add(new NumberTickUnit(0.00005, df3)); units.add(new NumberTickUnit(0.0005, df4)); units.add(new NumberTickUnit(0.005, df5)); units.add(new NumberTickUnit(0.05, df6)); units.add(new NumberTickUnit(0.5, df7)); units.add(new NumberTickUnit(5L, df8)); units.add(new NumberTickUnit(50L, df8)); units.add(new NumberTickUnit(500L, df8)); units.add(new NumberTickUnit(5000L, df8)); units.add(new NumberTickUnit(50000L, df8)); units.add(new NumberTickUnit(500000L, df8)); units.add(new NumberTickUnit(5000000L, df9)); units.add(new NumberTickUnit(50000000L, df9)); units.add(new NumberTickUnit(500000000L, df9)); units.add(new NumberTickUnit(5000000000L, df10)); units.add(new NumberTickUnit(50000000000L, df10)); units.add(new NumberTickUnit(500000000000L, df10)); return units; } Creates the standard tick units. If you don't like these defaults, create your own instance of TickUnits and then pass it to the setStandardTickUnits() method in the NumberAxis class.
public static TickUnitSource createStandardTickUnits(Locale locale) { TickUnits units = new TickUnits(); NumberFormat numberFormat = NumberFormat.getNumberInstance(locale); // we can add the units in any order, the TickUnits collection will // sort them... units.add(new NumberTickUnit(0.0000001, numberFormat)); units.add(new NumberTickUnit(0.000001, numberFormat)); units.add(new NumberTickUnit(0.00001, numberFormat)); units.add(new NumberTickUnit(0.0001, numberFormat)); units.add(new NumberTickUnit(0.001, numberFormat)); units.add(new NumberTickUnit(0.01, numberFormat)); units.add(new NumberTickUnit(0.1, numberFormat)); units.add(new NumberTickUnit(1, numberFormat)); units.add(new NumberTickUnit(10, numberFormat)); units.add(new NumberTickUnit(100, numberFormat)); units.add(new NumberTickUnit(1000, numberFormat)); units.add(new NumberTickUnit(10000, numberFormat)); units.add(new NumberTickUnit(100000, numberFormat)); units.add(new NumberTickUnit(1000000, numberFormat)); units.add(new NumberTickUnit(10000000, numberFormat)); units.add(new NumberTickUnit(100000000, numberFormat)); units.add(new NumberTickUnit(1000000000, numberFormat)); units.add(new NumberTickUnit(10000000000.0, numberFormat)); units.add(new NumberTickUnit(0.00000025, numberFormat)); units.add(new NumberTickUnit(0.0000025, numberFormat)); units.add(new NumberTickUnit(0.000025, numberFormat)); units.add(new NumberTickUnit(0.00025, numberFormat)); units.add(new NumberTickUnit(0.0025, numberFormat)); units.add(new NumberTickUnit(0.025, numberFormat)); units.add(new NumberTickUnit(0.25, numberFormat)); units.add(new NumberTickUnit(2.5, numberFormat)); units.add(new NumberTickUnit(25, numberFormat)); units.add(new NumberTickUnit(250, numberFormat)); units.add(new NumberTickUnit(2500, numberFormat)); units.add(new NumberTickUnit(25000, numberFormat)); units.add(new NumberTickUnit(250000, numberFormat)); units.add(new NumberTickUnit(2500000, numberFormat)); units.add(new NumberTickUnit(25000000, numberFormat)); units.add(new NumberTickUnit(250000000, numberFormat)); units.add(new NumberTickUnit(2500000000.0, numberFormat)); units.add(new NumberTickUnit(25000000000.0, numberFormat)); units.add(new NumberTickUnit(0.0000005, numberFormat)); units.add(new NumberTickUnit(0.000005, numberFormat)); units.add(new NumberTickUnit(0.00005, numberFormat)); units.add(new NumberTickUnit(0.0005, numberFormat)); units.add(new NumberTickUnit(0.005, numberFormat)); units.add(new NumberTickUnit(0.05, numberFormat)); units.add(new NumberTickUnit(0.5, numberFormat)); units.add(new NumberTickUnit(5L, numberFormat)); units.add(new NumberTickUnit(50L, numberFormat)); units.add(new NumberTickUnit(500L, numberFormat)); units.add(new NumberTickUnit(5000L, numberFormat)); units.add(new NumberTickUnit(50000L, numberFormat)); units.add(new NumberTickUnit(500000L, numberFormat)); units.add(new NumberTickUnit(5000000L, numberFormat)); units.add(new NumberTickUnit(50000000L, numberFormat)); units.add(new NumberTickUnit(500000000L, numberFormat)); units.add(new NumberTickUnit(5000000000L, numberFormat)); units.add(new NumberTickUnit(50000000000L, numberFormat)); return units; } Creates a collection of standard tick units. The supplied locale is used to create the number formatter (a localised instance of NumberFormat). If you don't like these defaults, create your own instance of TickUnits and then pass it to the setStandardTickUnits() method.
public AxisState draw(Graphics2D g2, double cursor, Rectangle2D plotArea, Rectangle2D dataArea, RectangleEdge edge, PlotRenderingInfo plotState) { AxisState state = null; // if the axis is not visible, don't draw it... if (!isVisible()) { state = new AxisState(cursor); // even though the axis is not visible, we need ticks for the // gridlines... List ticks = refreshTicks(g2, state, dataArea, edge); state.setTicks(ticks); return state; } // draw the tick marks and labels... state = drawTickMarksAndLabels(g2, cursor, plotArea, dataArea, edge); // // draw the marker band (if there is one)... // if (getMarkerBand() != null) { // if (edge == RectangleEdge.BOTTOM) { // cursor = cursor - getMarkerBand().getHeight(g2); // } // getMarkerBand().draw(g2, plotArea, dataArea, 0, cursor); // } // draw the axis label... state = drawLabel(getLabel(), g2, plotArea, dataArea, edge, state); return state; } Draws the axis on a Java 2D graphics device (such as the screen or a printer).
public boolean equals(Object obj) { if (obj == this) { return true; } if (!(obj instanceof NumberAxis)) { return false; } if (!super.equals(obj)) { return false; } NumberAxis that = (NumberAxis) obj; if (this.autoRangeIncludesZero != that.autoRangeIncludesZero) { return false; } if (this.autoRangeStickyZero != that.autoRangeStickyZero) { return false; } if (!ObjectUtilities.equal(this.tickUnit, that.tickUnit)) { return false; } if (!ObjectUtilities.equal(this.numberFormatOverride, that.numberFormatOverride)) { return false; } if (!this.rangeType.equals(that.rangeType)) { return false; } return true; } Tests the axis for equality with an arbitrary object.
protected double estimateMaximumTickLabelHeight(Graphics2D g2) { RectangleInsets tickLabelInsets = getTickLabelInsets(); double result = tickLabelInsets.getTop() + tickLabelInsets.getBottom(); Font tickLabelFont = getTickLabelFont(); FontRenderContext frc = g2.getFontRenderContext(); result += tickLabelFont.getLineMetrics("123", frc).getHeight(); return result; } Estimates the maximum tick label height.
protected double estimateMaximumTickLabelWidth(Graphics2D g2, TickUnit unit) { RectangleInsets tickLabelInsets = getTickLabelInsets(); double result = tickLabelInsets.getLeft() + tickLabelInsets.getRight(); if (isVerticalTickLabels()) { // all tick labels have the same width (equal to the height of the // font)... FontRenderContext frc = g2.getFontRenderContext(); LineMetrics lm = getTickLabelFont().getLineMetrics("0", frc); result += lm.getHeight(); } else { // look at lower and upper bounds... FontMetrics fm = g2.getFontMetrics(getTickLabelFont()); Range range = getRange(); double lower = range.getLowerBound(); double upper = range.getUpperBound(); String lowerStr = ""; String upperStr = ""; NumberFormat formatter = getNumberFormatOverride(); if (formatter != null) { lowerStr = formatter.format(lower); upperStr = formatter.format(upper); } else { lowerStr = unit.valueToString(lower); upperStr = unit.valueToString(upper); } double w1 = fm.stringWidth(lowerStr); double w2 = fm.stringWidth(upperStr); result += Math.max(w1, w2); } return result; } Estimates the maximum width of the tick labels, assuming the specified tick unit is used. Rather than computing the string bounds of every tick on the axis, we just look at two values: the lower bound and the upper bound for the axis. These two values will usually be representative.
public boolean getAutoRangeIncludesZero() { return this.autoRangeIncludesZero; } Returns the flag that indicates whether or not the automatic axis range (if indeed it is determined automatically) is forced to include zero.
public boolean getAutoRangeStickyZero() { return this.autoRangeStickyZero; } Returns a flag that affects the auto-range when zero falls outside the data range but inside the margins defined for the axis.
public MarkerAxisBand getMarkerBand() { return this.markerBand; } Returns the (optional) marker band for the axis.
public NumberFormat getNumberFormatOverride() { return this.numberFormatOverride; } Returns the number format override. If this is non-null, then it will be used to format the numbers on the axis.
public RangeType getRangeType() { return this.rangeType; } Returns the axis range type.
public NumberTickUnit getTickUnit() { return this.tickUnit; } 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.
public int hashCode() { if (getLabel() != null) { return getLabel().hashCode(); } else { return 0; } } Returns a hash code for this object.
public double java2DToValue(double java2DValue, Rectangle2D area, RectangleEdge edge) { Range range = getRange(); double axisMin = range.getLowerBound(); double axisMax = range.getUpperBound(); double min = 0.0; double max = 0.0; if (RectangleEdge.isTopOrBottom(edge)) { min = area.getX(); max = area.getMaxX(); } else if (RectangleEdge.isLeftOrRight(edge)) { min = area.getMaxY(); max = area.getY(); } if (isInverted()) { return axisMax - (java2DValue - min) / (max - min) * (axisMax - axisMin); } else { return axisMin + (java2DValue - min) / (max - min) * (axisMax - axisMin); } } Converts a coordinate in Java2D space to the corresponding data value, assuming that the axis runs along one edge of the specified dataArea.
public List refreshTicks(Graphics2D g2, AxisState state, Rectangle2D dataArea, RectangleEdge edge) { List result = new java.util.ArrayList(); if (RectangleEdge.isTopOrBottom(edge)) { result = refreshTicksHorizontal(g2, dataArea, edge); } else if (RectangleEdge.isLeftOrRight(edge)) { result = refreshTicksVertical(g2, dataArea, edge); } return result; } Calculates the positions of the tick labels for the axis, storing the results in the tick label list (ready for drawing).
protected List refreshTicksHorizontal(Graphics2D g2, Rectangle2D dataArea, RectangleEdge edge) { List result = new java.util.ArrayList(); Font tickLabelFont = getTickLabelFont(); g2.setFont(tickLabelFont); if (isAutoTickUnitSelection()) { selectAutoTickUnit(g2, dataArea, edge); } double size = getTickUnit().getSize(); int count = calculateVisibleTickCount(); double lowestTickValue = calculateLowestVisibleTickValue(); if (count < = ValueAxis.MAXIMUM_TICK_COUNT) { for (int i = 0; i < count; i++) { double currentTickValue = lowestTickValue + (i * size); String tickLabel; NumberFormat formatter = getNumberFormatOverride(); if (formatter != null) { tickLabel = formatter.format(currentTickValue); } else { tickLabel = getTickUnit().valueToString(currentTickValue); } TextAnchor anchor = null; TextAnchor rotationAnchor = null; double angle = 0.0; if (isVerticalTickLabels()) { anchor = TextAnchor.CENTER_RIGHT; rotationAnchor = TextAnchor.CENTER_RIGHT; if (edge == RectangleEdge.TOP) { angle = Math.PI / 2.0; } else { angle = -Math.PI / 2.0; } } else { if (edge == RectangleEdge.TOP) { anchor = TextAnchor.BOTTOM_CENTER; rotationAnchor = TextAnchor.BOTTOM_CENTER; } else { anchor = TextAnchor.TOP_CENTER; rotationAnchor = TextAnchor.TOP_CENTER; } } Tick tick = new NumberTick(new Double(currentTickValue), tickLabel, anchor, rotationAnchor, angle); result.add(tick); } } return result; } Calculates the positions of the tick labels for the axis, storing the results in the tick label list (ready for drawing).
protected List refreshTicksVertical(Graphics2D g2, Rectangle2D dataArea, RectangleEdge edge) { List result = new java.util.ArrayList(); result.clear(); Font tickLabelFont = getTickLabelFont(); g2.setFont(tickLabelFont); if (isAutoTickUnitSelection()) { selectAutoTickUnit(g2, dataArea, edge); } double size = getTickUnit().getSize(); int count = calculateVisibleTickCount(); double lowestTickValue = calculateLowestVisibleTickValue(); if (count < = ValueAxis.MAXIMUM_TICK_COUNT) { for (int i = 0; i < count; i++) { double currentTickValue = lowestTickValue + (i * size); String tickLabel; NumberFormat formatter = getNumberFormatOverride(); if (formatter != null) { tickLabel = formatter.format(currentTickValue); } else { tickLabel = getTickUnit().valueToString(currentTickValue); } TextAnchor anchor = null; TextAnchor rotationAnchor = null; double angle = 0.0; if (isVerticalTickLabels()) { if (edge == RectangleEdge.LEFT) { anchor = TextAnchor.BOTTOM_CENTER; rotationAnchor = TextAnchor.BOTTOM_CENTER; angle = -Math.PI / 2.0; } else { anchor = TextAnchor.BOTTOM_CENTER; rotationAnchor = TextAnchor.BOTTOM_CENTER; angle = Math.PI / 2.0; } } else { if (edge == RectangleEdge.LEFT) { anchor = TextAnchor.CENTER_RIGHT; rotationAnchor = TextAnchor.CENTER_RIGHT; } else { anchor = TextAnchor.CENTER_LEFT; rotationAnchor = TextAnchor.CENTER_LEFT; } } Tick tick = new NumberTick(new Double(currentTickValue), tickLabel, anchor, rotationAnchor, angle); result.add(tick); } } return result; } Calculates the positions of the tick labels for the axis, storing the results in the tick label list (ready for drawing).
protected void selectAutoTickUnit(Graphics2D g2, Rectangle2D dataArea, RectangleEdge edge) { if (RectangleEdge.isTopOrBottom(edge)) { selectHorizontalAutoTickUnit(g2, dataArea, edge); } else if (RectangleEdge.isLeftOrRight(edge)) { selectVerticalAutoTickUnit(g2, dataArea, 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.
protected void selectHorizontalAutoTickUnit(Graphics2D g2, Rectangle2D dataArea, RectangleEdge edge) { double tickLabelWidth = estimateMaximumTickLabelWidth( g2, getTickUnit() ); // start with the current tick unit... TickUnitSource tickUnits = getStandardTickUnits(); TickUnit unit1 = tickUnits.getCeilingTickUnit(getTickUnit()); double unit1Width = lengthToJava2D(unit1.getSize(), dataArea, edge); // then extrapolate... double guess = (tickLabelWidth / unit1Width) * unit1.getSize(); NumberTickUnit unit2 = (NumberTickUnit) tickUnits.getCeilingTickUnit(guess); double unit2Width = lengthToJava2D(unit2.getSize(), dataArea, edge); tickLabelWidth = estimateMaximumTickLabelWidth(g2, unit2); if (tickLabelWidth > unit2Width) { unit2 = (NumberTickUnit) tickUnits.getLargerTickUnit(unit2); } setTickUnit(unit2, false, false); } 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.
protected void selectVerticalAutoTickUnit(Graphics2D g2, Rectangle2D dataArea, RectangleEdge edge) { double tickLabelHeight = estimateMaximumTickLabelHeight(g2); // start with the current tick unit... TickUnitSource tickUnits = getStandardTickUnits(); TickUnit unit1 = tickUnits.getCeilingTickUnit(getTickUnit()); double unitHeight = lengthToJava2D(unit1.getSize(), dataArea, edge); // then extrapolate... double guess = (tickLabelHeight / unitHeight) * unit1.getSize(); NumberTickUnit unit2 = (NumberTickUnit) tickUnits.getCeilingTickUnit(guess); double unit2Height = lengthToJava2D(unit2.getSize(), dataArea, edge); tickLabelHeight = estimateMaximumTickLabelHeight(g2); if (tickLabelHeight > unit2Height) { unit2 = (NumberTickUnit) tickUnits.getLargerTickUnit(unit2); } setTickUnit(unit2, false, false); } 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.
public void setAutoRangeIncludesZero(boolean flag) { if (this.autoRangeIncludesZero != flag) { this.autoRangeIncludesZero = flag; if (isAutoRange()) { autoAdjustRange(); } notifyListeners(new AxisChangeEvent(this)); } } Sets the flag that indicates whether or not the axis range, if automatically calculated, is forced to include zero. If the flag is changed to true, the axis range is recalculated. Any change to the flag will trigger an AxisChangeEvent .
public void setAutoRangeStickyZero(boolean flag) { if (this.autoRangeStickyZero != flag) { this.autoRangeStickyZero = flag; if (isAutoRange()) { autoAdjustRange(); } notifyListeners(new AxisChangeEvent(this)); } } Sets a flag that affects the auto-range when zero falls outside the data range but inside the margins defined for the axis.
public void setMarkerBand(MarkerAxisBand band) { this.markerBand = band; notifyListeners(new AxisChangeEvent(this)); } Sets the marker band for the axis. The marker band is optional, leave it set to null if you don't require it.
public void setNumberFormatOverride(NumberFormat formatter) { this.numberFormatOverride = formatter; notifyListeners(new AxisChangeEvent(this)); } Sets the number format override. If this is non-null, then it will be used to format the numbers on the axis.
public void setRangeType(RangeType rangeType) { if (rangeType == null) { throw new IllegalArgumentException("Null 'rangeType' argument."); } this.rangeType = rangeType; notifyListeners(new AxisChangeEvent(this)); } Sets the axis range type.
public void setTickUnit(NumberTickUnit unit) { // defer argument checking... setTickUnit(unit, true, true); } Sets the tick unit for the axis and sends an AxisChangeEvent to all registered listeners. A side effect of calling this method is that the "auto-select" feature for tick units is switched off (you can restore it using the ValueAxis#setAutoTickUnitSelection(boolean) method).
public void setTickUnit(NumberTickUnit unit, boolean notify, boolean turnOffAutoSelect) { if (unit == null) { throw new IllegalArgumentException("Null 'unit' argument."); } this.tickUnit = unit; if (turnOffAutoSelect) { setAutoTickUnitSelection(false, false); } if (notify) { notifyListeners(new AxisChangeEvent(this)); } } Sets the tick unit for the axis and, if requested, sends an AxisChangeEvent to all registered listeners. In addition, an option is provided to turn off the "auto-select" feature for tick units (you can restore it using the ValueAxis#setAutoTickUnitSelection(boolean) method).
public double valueToJava2D(double value, Rectangle2D area, RectangleEdge edge) { Range range = getRange(); double axisMin = range.getLowerBound(); double axisMax = range.getUpperBound(); double min = 0.0; double max = 0.0; if (RectangleEdge.isTopOrBottom(edge)) { min = area.getX(); max = area.getMaxX(); } else if (RectangleEdge.isLeftOrRight(edge)) { max = area.getMinY(); min = area.getMaxY(); } if (isInverted()) { return max - ((value - axisMin) / (axisMax - axisMin)) * (max - min); } else { return min + ((value - axisMin) / (axisMax - axisMin)) * (max - min); } } Converts a data value to a coordinate in Java2D space, assuming that the axis runs along one edge of the specified dataArea. Note that it is possible for the coordinate to fall outside the plotArea.