Module org.jfree.chart
Package org.jfree.chart.axis

Class SymbolAxis

    • Constructor Detail

      • SymbolAxis

        public SymbolAxis​(String label,
                  String[] sv)
        Constructs a symbol axis, using default attribute values where necessary.
        Parameters:
        label - the axis label (null permitted).
        sv - the list of symbols to display instead of the numeric values.

    • Method Detail

      • getSymbols

        public String[] getSymbols()
        Returns an array of the symbols for the axis.
        Returns:
        The symbols.

      • setGridBandsVisible

        public void setGridBandsVisible​(boolean flag)
        Sets the flag that controls whether or not grid bands are drawn for this axis and notifies registered listeners that the axis has been modified. Each band is the area between two adjacent gridlines running perpendicular to the axis. When the bands are drawn they are filled with the colors getGridBandPaint() and getGridBandAlternatePaint() in an alternating sequence.
        Parameters:
        flag - the new setting.
        See Also:
        isGridBandsVisible()

      • draw

        public 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).
        Overrides:
        draw in class NumberAxis
        Parameters:
        g2 - the graphics device (null not permitted).
        cursor - the cursor location.
        plotArea - the area within which the plot and axes should be drawn (null not permitted).
        dataArea - the area within which the data should be drawn (null not permitted).
        edge - the axis location (null not permitted).
        plotState - collects information about the plot (null permitted).
        Returns:
        The axis state (never null).

      • drawGridBands

        protected void drawGridBands​(Graphics2D g2,
                             Rectangle2D plotArea,
                             Rectangle2D dataArea,
                             RectangleEdge edge,
                             List ticks)
        Draws the grid bands (alternate bands are colored using getGridBandPaint() and getGridBandAlternatePaint().
        Parameters:
        g2 - the graphics target (null not permitted).
        plotArea - the area within which the plot is drawn (null not permitted).
        dataArea - the data area to which the axes are aligned (null not permitted).
        edge - the edge to which the axis is aligned (null not permitted).
        ticks - the ticks (null not permitted).

      • drawGridBandsHorizontal

        protected void drawGridBandsHorizontal​(Graphics2D g2,
                                       Rectangle2D plotArea,
                                       Rectangle2D dataArea,
                                       boolean firstGridBandIsDark,
                                       List ticks)
        Draws the grid bands for the axis when it is at the top or bottom of the plot.
        Parameters:
        g2 - the graphics target (null not permitted).
        plotArea - the area within which the plot is drawn (not used here).
        dataArea - the area for the data (to which the axes are aligned, null not permitted).
        firstGridBandIsDark - True: the first grid band takes the color of gridBandPaint. False: the second grid band takes the color of gridBandPaint.
        ticks - a list of ticks (null not permitted).

      • drawGridBandsVertical

        protected void drawGridBandsVertical​(Graphics2D g2,
                                     Rectangle2D plotArea,
                                     Rectangle2D dataArea,
                                     boolean firstGridBandIsDark,
                                     List ticks)
        Draws the grid bands for an axis that is aligned to the left or right of the data area (that is, a vertical axis).
        Parameters:
        g2 - the graphics target (null not permitted).
        plotArea - the area within which the plot is drawn (not used here).
        dataArea - the area for the data (to which the axes are aligned, null not permitted).
        firstGridBandIsDark - True: the first grid band takes the color of gridBandPaint. False: the second grid band takes the color of gridBandPaint.
        ticks - a list of ticks (null not permitted).

      • refreshTicks

        public List refreshTicks​(Graphics2D g2,
                         AxisState state,
                         Rectangle2D dataArea,
                         RectangleEdge edge)
        Calculates the positions of the tick labels for the axis, storing the results in the tick label list (ready for drawing).
        Overrides:
        refreshTicks in class NumberAxis
        Parameters:
        g2 - the graphics device.
        state - the axis state.
        dataArea - the area in which the data should be drawn.
        edge - the location of the axis.
        Returns:
        A list of ticks.

      • refreshTicksVertical

        protected List refreshTicksVertical​(Graphics2D g2,
                                    Rectangle2D dataArea,
                                    RectangleEdge edge)
        Calculates the positions of the tick labels for the axis, storing the results in the tick label list (ready for drawing).
        Overrides:
        refreshTicksVertical in class NumberAxis
        Parameters:
        g2 - the graphics device.
        dataArea - the area in which the plot should be drawn.
        edge - the location of the axis.
        Returns:
        The ticks.

      • valueToString

        public String valueToString​(double value)
        Converts a value to a string, using the list of symbols.
        Parameters:
        value - value to convert.
        Returns:
        The symbol.

      • equals

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