    001    /* ===========================================================
    002     * JFreeChart : a free chart library for the Java(tm) platform
    003     * ===========================================================
    004     *
    005     * (C) Copyright 2000-2006, by Object Refinery Limited and Contributors.
    006     *
    007     * Project Info:  http://www.jfree.org/jfreechart/index.html
    008     *
    009     * This library is free software; you can redistribute it and/or modify it
    010     * under the terms of the GNU Lesser General Public License as published by
    011     * the Free Software Foundation; either version 2.1 of the License, or
    012     * (at your option) any later version.
    013     *
    014     * This library is distributed in the hope that it will be useful, but
    015     * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
    016     * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public
    017     * License for more details.
    018     *
    019     * You should have received a copy of the GNU Lesser General Public
    020     * License along with this library; if not, write to the Free Software
    021     * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301,
    022     * USA.
    023     *
    024     * [Java is a trademark or registered trademark of Sun Microsystems, Inc.
    025     * in the United States and other countries.]
    026     *
    027     * -----------------
    028     * NumberAxis3D.java
    029     * -----------------
    030     * (C) Copyright 2001-2006, by Serge V. Grachov and Contributors.
    031     *
    032     * Original Author:  Serge V. Grachov;
    033     * Contributor(s):   David Gilbert (for Object Refinery Limited);
    034     *                   Jonathan Nash;
    035     *                   Richard Atkinson;
    036     *                   Tin Luu;
    037     *
    038     * $Id: NumberAxis3D.java,v 1.5.2.2 2006/01/18 11:03:02 mungady Exp $
    039     *
    040     * Changes
    041     * -------
    042     * 31-Oct-2001 : Version 1 contributed by Serge V. Grachov (DG);
    043     * 23-Nov-2001 : Overhauled auto tick unit code for all axes (DG);
    044     * 12-Dec-2001 : Minor change due to grid lines bug fix (DG);
    045     * 08-Jan-2002 : Added flag allowing the axis to be 'inverted'.  That is, run
    046     *               from positive to negative.  Added default values to
    047     *               constructors (DG);
    048     * 16-Jan-2002 : Added an optional crosshair, based on the implementation by
    049     *               Jonathan Nash (DG);
    050     * 25-Feb-2002 : Updated constructors for new autoRangeStickyZero flag (DG);
    051     * 19-Apr-2002 : drawVerticalString() is now drawRotatedString() in
    052     *               RefineryUtilities (DG);
    053     * 25-Jun-2002 : Removed redundant import (DG);
    054     * 25-Jul-2002 : Changed order of parameters in ValueAxis constructor (DG);
    055     * 06-Aug-2002 : Modified draw method to not draw axis label if label is empty
    056     *               String (RA);
    057     * 05-Sep-2002 : Updated constructor for changes in the Axis class, and changed
    058     *               draw method to observe tickMarkPaint (DG);
    059     * 22-Sep-2002 : Fixed errors reported by Checkstyle (DG);
    060     * 08-Nov-2002 : Moved to new package com.jrefinery.chart.axis (DG);
    061     * 20-Jan-2003 : Removed unnecessary constructors (DG);
    062     * 26-Mar-2003 : Implemented Serializable (DG);
    063     * 13-May-2003 : Merged HorizontalNumberAxis3D and VerticalNumberAxis3D (DG);
    064     * 21-Aug-2003 : Updated draw() method signature (DG);
    065     * 07-Nov-2003 : Modified refreshTicks method signature (DG);
    066     * 18-Jan-2006 : Fixed bug 1408904 (axis assumes CategoryPlot) (DG):
    067     *
    068     */
    069
    070    package org.jfree.chart.axis;
    071
    072    import java.awt.Graphics2D;
    073    import java.awt.geom.Rectangle2D;
    074    import java.io.Serializable;
    075    import java.util.List;
    076
    077    import org.jfree.chart.Effect3D;
    078    import org.jfree.chart.plot.CategoryPlot;
    079    import org.jfree.chart.plot.Plot;
    080    import org.jfree.chart.plot.PlotRenderingInfo;
    081    import org.jfree.chart.renderer.category.CategoryItemRenderer;
    082    import org.jfree.ui.RectangleEdge;
    083
    084    /**
    085     * A standard linear value axis with a 3D effect corresponding to the
    086     * offset specified by some renderers.
    087     */
    088    public class NumberAxis3D extends NumberAxis implements Serializable {
    089
    090        /** For serialization. */
    091        private static final long serialVersionUID = -1790205852569123512L;
    092
    093        /**
    094         * Default constructor.
    095         */
    096        public NumberAxis3D() {
    097            this(null);
    098        }
    099
    100        /**
    101         * Constructs a new axis.
    102         *
    103         * @param label  the axis label (<code>null</code> permitted).
    104         */
    105        public NumberAxis3D(String label) {
    106            super(label);
    107            setAxisLineVisible(false);
    108        }
    109
    110        /**
    111         * Draws the axis on a Java 2D graphics device (such as the screen or a
    112         * printer).
    113         *
    114         * @param g2  the graphics device.
    115         * @param cursor  the cursor.
    116         * @param plotArea  the area for drawing the axes and data.
    117         * @param dataArea  the area for drawing the data (a subset of the
    118         *                  plotArea).
    119         * @param edge  the axis location.
    120         * @param plotState  collects information about the plot (<code>null</code>
    121         *                   permitted).
    122         *
    123         * @return The updated cursor value.
    124         */
    125        public AxisState draw(Graphics2D g2, double cursor, Rectangle2D plotArea,
    126                Rectangle2D dataArea, RectangleEdge edge,
    127                PlotRenderingInfo plotState) {
    128
    129            // if the axis is not visible, don't draw it...
    130            if (!isVisible()) {
    131                AxisState state = new AxisState(cursor);
    132                // even though the axis is not visible, we need ticks for the
    133                // gridlines...
    134                List ticks = refreshTicks(g2, state, dataArea, edge);
    135                state.setTicks(ticks);
    136                return state;
    137            }
    138
    139            // calculate the adjusted data area taking into account the 3D effect...
    140            double xOffset = 0.0;
    141            double yOffset = 0.0;
    142            Plot plot = getPlot();
    143            if (plot instanceof CategoryPlot) {
    144                CategoryPlot cp = (CategoryPlot) plot;
    145                CategoryItemRenderer r = cp.getRenderer();
    146                if (r instanceof Effect3D) {
    147                    Effect3D e3D = (Effect3D) r;
    148                    xOffset = e3D.getXOffset();
    149                    yOffset = e3D.getYOffset();
    150                }
    151            }
    152
    153            double adjustedX = dataArea.getMinX();
    154            double adjustedY = dataArea.getMinY();
    155            double adjustedW = dataArea.getWidth() - xOffset;
    156            double adjustedH = dataArea.getHeight() - yOffset;
    157
    158            if (edge == RectangleEdge.LEFT || edge == RectangleEdge.BOTTOM) {
    159                adjustedY += yOffset;
    160            }
    161            else if (edge == RectangleEdge.RIGHT || edge == RectangleEdge.TOP) {
    162                adjustedX += xOffset;
    163            }
    164            Rectangle2D adjustedDataArea = new Rectangle2D.Double(adjustedX,
    165                    adjustedY, adjustedW, adjustedH);
    166
    167            // draw the tick marks and labels...
    168            AxisState info = drawTickMarksAndLabels(g2, cursor, plotArea,
    169                    adjustedDataArea, edge);
    170
    171            // draw the axis label...
    172            info = drawLabel(getLabel(), g2, plotArea, dataArea, edge, info);
    173
    174            return info;
    175
    176        }
    177
    178    }