001/* ===========================================================
002 * JFreeChart : a free chart library for the Java(tm) platform
003 * ===========================================================
004 *
005 * (C) Copyright 2000-2022, by David Gilbert 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 * [Oracle and Java are registered trademarks of Oracle and/or its affiliates. 
025 * Other names may be trademarks of their respective owners.]
026 *
027 * --------------------
028 * PlotOrientation.java
029 * --------------------
030 * (C) Copyright 2003-2022, by David Gilbert.
031 *
032 * Original Author:  David Gilbert;
033 * Contributor(s):   -;
034 *
035 */
036
037package org.jfree.chart.plot;
038
039/**
040 * Used to indicate the orientation (horizontal or vertical) of a 2D plot.
041 * It is the direction of the y-axis that is the determinant (a conventional
042 * plot has a vertical y-axis).
043 */
044public enum PlotOrientation {
045
046    /** For a plot where the range axis is horizontal. */
047    HORIZONTAL,
048
049    /** For a plot where the range axis is vertical. */
050    VERTICAL;
051
052    /**
053     * Returns {@code true} if this orientation is {@code HORIZONTAL},
054     * and {@code false} otherwise.  
055     * 
056     * @return A boolean.
057     */
058    public boolean isHorizontal() {
059        return this.equals(PlotOrientation.HORIZONTAL);
060    }
061    
062    /**
063     * Returns {@code true} if this orientation is {@code VERTICAL},
064     * and {@code false} otherwise.
065     * 
066     * @return A boolean.
067     */
068    public boolean isVertical() {
069        return this.equals(PlotOrientation.VERTICAL);
070    }
071
072}