PeriodAxis
org.jfree.chart.axis

Class PeriodAxis

    • Constructor Detail

      • PeriodAxis

        public PeriodAxis(String label)
        Creates a new axis.
        Parameters:
        label - the axis label.
      • PeriodAxis

        public PeriodAxis(String label,          RegularTimePeriod first,          RegularTimePeriod last)
        Creates a new axis.
        Parameters:
        label - the axis label (null permitted).
        first - the first time period in the axis range (null not permitted).
        last - the last time period in the axis range (null not permitted).
      • PeriodAxis

        public PeriodAxis(String label,          RegularTimePeriod first,          RegularTimePeriod last,          TimeZone timeZone)
        Deprecated. As of version 1.0.13, you should use the constructor that specifies a Locale also.
        Creates a new axis.
        Parameters:
        label - the axis label (null permitted).
        first - the first time period in the axis range (null not permitted).
        last - the last time period in the axis range (null not permitted).
        timeZone - the time zone (null not permitted).
      • PeriodAxis

        public PeriodAxis(String label,          RegularTimePeriod first,          RegularTimePeriod last,          TimeZone timeZone,          Locale locale)
        Creates a new axis.
        Parameters:
        label - the axis label (null permitted).
        first - the first time period in the axis range (null not permitted).
        last - the last time period in the axis range (null not permitted).
        timeZone - the time zone (null not permitted).
        locale - the locale (null not permitted).
    • Method Detail

      • getFirst

        public RegularTimePeriod getFirst()
        Returns the first time period in the axis range.
        Returns:
        The first time period (never null).
      • setFirst

        public void setFirst(RegularTimePeriod first)
        Sets the first time period in the axis range and sends an AxisChangeEvent to all registered listeners.
        Parameters:
        first - the time period (null not permitted).
      • getLast

        public RegularTimePeriod getLast()
        Returns the last time period in the axis range.
        Returns:
        The last time period (never null).
      • setLast

        public void setLast(RegularTimePeriod last)
        Sets the last time period in the axis range and sends an AxisChangeEvent to all registered listeners.
        Parameters:
        last - the time period (null not permitted).
      • getTimeZone

        public TimeZone getTimeZone()
        Returns the time zone used to convert the periods defining the axis range into absolute milliseconds.
        Returns:
        The time zone (never null).
      • setTimeZone

        public void setTimeZone(TimeZone zone)
        Sets the time zone that is used to convert the time periods into absolute milliseconds.
        Parameters:
        zone - the time zone (null not permitted).
      • getLocale

        public Locale getLocale()
        Returns the locale for this axis.
        Returns:
        The locale (never (null).
      • getAutoRangeTimePeriodClass

        public Class getAutoRangeTimePeriodClass()
        Returns the class used to create the first and last time periods for the axis range when the auto-range flag is set to true.
        Returns:
        The class (never null).
      • setAutoRangeTimePeriodClass

        public void setAutoRangeTimePeriodClass(Class c)
        Sets the class used to create the first and last time periods for the axis range when the auto-range flag is set to true and sends an AxisChangeEvent to all registered listeners.
        Parameters:
        c - the class (null not permitted).
      • getMajorTickTimePeriodClass

        public Class getMajorTickTimePeriodClass()
        Returns the class that controls the spacing of the major tick marks.
        Returns:
        The class (never null).
      • setMajorTickTimePeriodClass

        public void setMajorTickTimePeriodClass(Class c)
        Sets the class that controls the spacing of the major tick marks, and sends an AxisChangeEvent to all registered listeners.
        Parameters:
        c - the class (a subclass of RegularTimePeriod is expected).
      • getMinorTickTimePeriodClass

        public Class getMinorTickTimePeriodClass()
        Returns the class that controls the spacing of the minor tick marks.
        Returns:
        The class (never null).
      • setMinorTickTimePeriodClass

        public void setMinorTickTimePeriodClass(Class c)
        Sets the class that controls the spacing of the minor tick marks, and sends an AxisChangeEvent to all registered listeners.
        Parameters:
        c - the class (a subclass of RegularTimePeriod is expected).
      • getMinorTickMarkStroke

        public Stroke getMinorTickMarkStroke()
        Returns the stroke used to display minor tick marks, if they are visible.
        Returns:
        A stroke (never null).
      • setMinorTickMarkStroke

        public void setMinorTickMarkStroke(Stroke stroke)
        Sets the stroke used to display minor tick marks, if they are visible, and sends a AxisChangeEvent to all registered listeners.
        Parameters:
        stroke - the stroke (null not permitted).
      • getMinorTickMarkPaint

        public Paint getMinorTickMarkPaint()
        Returns the paint used to display minor tick marks, if they are visible.
        Returns:
        A paint (never null).
      • setMinorTickMarkPaint

        public void setMinorTickMarkPaint(Paint paint)
        Sets the paint used to display minor tick marks, if they are visible, and sends a AxisChangeEvent to all registered listeners.
        Parameters:
        paint - the paint (null not permitted).
      • getLabelInfo

        public PeriodAxisLabelInfo[] getLabelInfo()
        Returns an array of label info records.
        Returns:
        An array.
      • setLabelInfo

        public void setLabelInfo(PeriodAxisLabelInfo[] info)
        Sets the array of label info records and sends an AxisChangeEvent to all registered listeners.
        Parameters:
        info - the info.
      • 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).
        Overrides:
        setRange in class ValueAxis
        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.
        See Also:
        ValueAxis.getRange()
      • configure

        public void configure()
        Configures the axis to work with the current plot. Override this method to perform any special processing (such as auto-rescaling).
        Specified by:
        configure in class Axis
      • reserveSpace

        public AxisSpace reserveSpace(Graphics2D g2,                     Plot plot,                     Rectangle2D plotArea,                     org.jfree.ui.RectangleEdge edge,                     AxisSpace space)
        Estimates the space (height or width) required to draw the axis.
        Overrides:
        reserveSpace in class ValueAxis
        Parameters:
        g2 - the graphics device.
        plot - the plot that the axis belongs to.
        plotArea - the area within which the plot (including axes) should be drawn.
        edge - the axis location.
        space - space already reserved.
        Returns:
        The space required to draw the axis (including pre-reserved space).
      • draw

        public AxisState draw(Graphics2D g2,             double cursor,             Rectangle2D plotArea,             Rectangle2D dataArea,             org.jfree.ui.RectangleEdge edge,             PlotRenderingInfo plotState)
        Draws the axis on a Java 2D graphics device (such as the screen or a printer).
        Specified by:
        draw in class Axis
        Parameters:
        g2 - the graphics device (null not permitted).
        cursor - the cursor location (determines where to draw the axis).
        plotArea - the area within which the axes and plot should be drawn.
        dataArea - the area within which the data should be drawn.
        edge - the axis location (null not permitted).
        plotState - collects information about the plot (null permitted).
        Returns:
        The axis state (never null).
      • refreshTicks

        public List refreshTicks(Graphics2D g2,                AxisState state,                Rectangle2D dataArea,                org.jfree.ui.RectangleEdge edge)
        Calculates the positions of the ticks for the axis, storing the results in the tick list (ready for drawing).
        Specified by:
        refreshTicks in class Axis
        Parameters:
        g2 - the graphics device.
        state - the axis state.
        dataArea - the area inside the axes.
        edge - the edge on which the axis is located.
        Returns:
        The list of ticks.
      • valueToJava2D

        public double valueToJava2D(double value,                   Rectangle2D area,                   org.jfree.ui.RectangleEdge edge)
        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 area.

        Specified by:
        valueToJava2D in class ValueAxis
        Parameters:
        value - the data value.
        area - the area for plotting the data.
        edge - the edge along which the axis lies.
        Returns:
        The Java2D coordinate.
        See Also:
        ValueAxis.java2DToValue(double, Rectangle2D, RectangleEdge)
      • java2DToValue

        public double java2DToValue(double java2DValue,                   Rectangle2D area,                   org.jfree.ui.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.
        Specified by:
        java2DToValue in class ValueAxis
        Parameters:
        java2DValue - the coordinate in Java2D space.
        area - the area in which the data is plotted.
        edge - the edge along which the axis lies.
        Returns:
        The data value.
        See Also:
        ValueAxis.valueToJava2D(double, Rectangle2D, RectangleEdge)
      • equals

        public boolean equals(Object obj)
        Tests the axis for equality with an arbitrary object.
        Overrides:
        equals in class ValueAxis
        Parameters:
        obj - the object (null permitted).
        Returns:
        A boolean.
      • hashCode

        public int hashCode()
        Returns a hash code for this object.
        Overrides:
        hashCode in class Axis
        Returns:
        A hash code.

SCaVis 2.0 © jWork.ORG