de.gsi.chart.ui.geometry.Side Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of chartfx-chart Show documentation

This charting library ${project.artifactId}- is an extension in the spirit of Oracle's XYChart and performance/time-proven JDataViewer charting functionalities. Emphasis was put on plotting performance for both large number of data points and real-time displays, as well as scientific accuracies leading to error bar/surface plots, and other scientific plotting features (parameter measurements, fitting, multiple axes, zoom, ...).

There is a newer version: 11.2.7

Show newest version

package de.gsi.chart.ui.geometry;

/**
 * Re-implementation of JavaFX's {@code javafx.geometry.Side} implementation to
 * also include centre axes.
 * 
 * @author rstein
 *
 */
public enum Side {
    /**
     * Represents top side of a rectangle.
     */
    TOP,

    /**
     * Represents bottom side of a rectangle.
     */
    BOTTOM,

    /**
     * Represents left side of a rectangle.
     */
    LEFT,

    /**
     * Represents right side of a rectangle.
     */
    RIGHT,
    /**
     * Represents horizontal centre axis of a rectangle.
     */
    CENTER_HOR,
    /**
     * Represents vertical centre axis of a rectangle.
     */
    CENTER_VER;

    /**
     * Indicates whether this is vertical side of a rectangle (returns
     * {@code true} for {@code LEFT} and {@code RIGHT}.
     * 
     * @return {@code true} if this represents a vertical side of a rectangle
     */
    public boolean isVertical() {
        return this == LEFT || this == RIGHT || this == CENTER_VER;
    }

    /**
     * Indicates whether this is horizontal side of a rectangle (returns
     * {@code true} for {@code TOP} and {@code BOTTOM}.
     * 
     * @return {@code true} if this represents a horizontal side of a rectangle
     */
    public boolean isHorizontal() {
        return this == TOP || this == BOTTOM || this == CENTER_HOR;
    }
}