All Downloads are FREE. Search and download functionalities are using the official Maven repository.

org.jfree.chart3d.marker.RangeMarker Maven / Gradle / Ivy

/* ===========================================================
 * Orson Charts : a 3D chart library for the Java(tm) platform
 * ===========================================================
 * 
 * (C)opyright 2013-2020, by Object Refinery Limited.  All rights reserved.
 * 
 * https://github.com/jfree/orson-charts
 * 
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see .
 * 
 * [Oracle and Java are registered trademarks of Oracle and/or its affiliates. 
 * Other names may be trademarks of their respective owners.]
 * 
 * If you do not wish to be bound by the terms of the GPL, an alternative
 * commercial license can be purchased.  For details, please see visit the
 * Orson Charts home page:
 * 
 * http://www.object-refinery.com/orsoncharts/index.html
 * 
 */

package org.jfree.chart3d.marker;

import java.awt.Color;
import java.awt.Font;
import java.awt.Graphics2D;
import java.awt.geom.Line2D;
import java.awt.geom.Path2D;
import java.awt.geom.Point2D;
import java.io.Serializable;

import org.jfree.chart3d.data.Range;
import org.jfree.chart3d.graphics2d.Anchor2D;
import org.jfree.chart3d.internal.Args;
import org.jfree.chart3d.internal.ObjectUtils;

/**
 * A marker that marks a range of values on an axis.
 * 

* For an example, please refer to the demo {@code RangeMarkerDemo1.java}. *

* NOTE: This class is serializable, but the serialization format is subject * to change in future releases and should not be relied upon for persisting * instances of this class. * * @since 1.2 */ @SuppressWarnings("serial") public class RangeMarker extends AbstractMarker implements ValueMarker, MarkerChangeListener, Serializable { /** The start of the range. */ private NumberMarker start; /** The end of the range. */ private NumberMarker end; /** The label for the marker (optional). */ private String label; /** The font for the label. */ private Font font; /** The color for the label. */ private Color labelColor; /** The anchor for the label. */ private Anchor2D labelAnchor; /** The color used to fill the band representing the marker range. */ Color fillColor; /** * Creates a new range marker for the given bounds. * * @param lowerBound the lower bound. * @param upperBound the upper bound. */ public RangeMarker(double lowerBound, double upperBound) { this(lowerBound, upperBound, null); } /** * Creates a new range marker for the given bounds. * * @param lowerBound the lower bound. * @param upperBound the upper bound. * @param label the label ({@code null} permitted). */ public RangeMarker(double lowerBound, double upperBound, String label) { super(); this.start = new NumberMarker(lowerBound); this.start.addChangeListener(this); this.end = new NumberMarker(upperBound); this.end.addChangeListener(this); this.label = label; this.font = DEFAULT_MARKER_FONT; this.labelColor = DEFAULT_LABEL_COLOR; this.labelAnchor = Anchor2D.CENTER; this.fillColor = DEFAULT_FILL_COLOR; } /** * Returns the starting point for the range marker. * * @return The starting point. */ public NumberMarker getStart() { return this.start; } /** * Returns the ending point for the range marker. * * @return The ending point. */ public NumberMarker getEnd() { return this.end; } /** * Returns the range of values for the marker. * * @return The range of values for the marker. */ @Override public Range getRange() { return new Range(this.start.getValue(), this.end.getValue()); } /** * Returns the label for the marker (if this is {@code null} then no * label is displayed). * * @return The label (possibly {@code null}). */ public String getLabel() { return this.label; } /** * Sets the label and sends a change event to all registered listeners. If * the label is set to {@code null} then no label is displayed for * the marker. * * @param label the label ({@code null} permitted). */ public void setLabel(String label) { this.label = label; fireChangeEvent(); } /** * Returns the font for the label. The default value is * {@link Marker#DEFAULT_MARKER_FONT}. * * @return The font (never {@code null}). */ public Font getFont() { return this.font; } /** * Sets the font for the marker label and sends a change event to all * registered listeners. * * @param font the font ({@code null} not permitted). */ public void setFont(Font font) { Args.nullNotPermitted(font, "font"); this.font = font; fireChangeEvent(); } /** * Returns the label color. The default value is * {@link Marker#DEFAULT_LABEL_COLOR}. * * @return The label color (never {@code null}). */ public Color getLabelColor() { return this.labelColor; } /** * Sets the label color and sends a change event to all registered * listeners. * * @param color the color ({@code null} not permitted). */ public void setLabelColor(Color color) { Args.nullNotPermitted(color, "color"); this.labelColor = color; fireChangeEvent(); } /** * Returns the anchor for the label. The default value is * {@link Anchor2D#CENTER}. * * @return The anchor for the label. */ public Anchor2D getLabelAnchor() { return this.labelAnchor; } /** * Sets the anchor for the label and sends a change event to all registered * listeners. * * @param anchor the anchor ({@code null} not permitted). */ public void setLabelAnchor(Anchor2D anchor) { Args.nullNotPermitted(anchor, "anchor"); this.labelAnchor = anchor; fireChangeEvent(); } /** * Returns the color used to fill the band representing the range for * the marker. The default value is {@link Marker#DEFAULT_FILL_COLOR}. * * @return The fill color (never {@code null}). */ public Color getFillColor() { return this.fillColor; } /** * Sets the color used to fill the band representing the range for the * marker and sends a change event to all registered listeners. * * @param color the color ({@code null} not permitted). */ public void setFillColor(Color color) { Args.nullNotPermitted(color, "color"); this.fillColor = color; fireChangeEvent(); } @Override public void draw(Graphics2D g2, MarkerData markerData, boolean reverse) { MarkerLine startLine = markerData.getStartLine(); Line2D l1 = new Line2D.Double(startLine.getStartPoint(), startLine.getEndPoint()); MarkerLine endLine = markerData.getEndLine(); Line2D l2 = new Line2D.Double(endLine.getStartPoint(), endLine.getEndPoint()); Path2D path = new Path2D.Double(); path.moveTo(l1.getX1(), l1.getY1()); path.lineTo(l1.getX2(), l1.getY2()); path.lineTo(l2.getX2(), l2.getY2()); path.lineTo(l2.getX1(), l2.getY1()); path.closePath(); g2.setPaint(this.fillColor); g2.fill(path); if (!startLine.isPegged()) { g2.setPaint(this.start.getLineColor()); g2.setStroke(this.start.getLineStroke()); g2.draw(l1); } if (!endLine.isPegged()) { g2.setPaint(this.end.getLineColor()); g2.setStroke(this.end.getLineStroke()); g2.draw(l2); } Point2D labelPoint = markerData.getLabelPoint(); if (labelPoint != null) { g2.setFont(this.font); g2.setColor(this.labelColor); drawMarkerLabel(g2, this.label, labelPoint.getX(), labelPoint.getY(), markerData.getLabelAnchor(), l1, l2, reverse); } } /** * Receives notification of a change to the start or end marker for the * range. * * @param event the event ({@code null} not permitted). */ @Override public void markerChanged(MarkerChangeEvent event) { fireChangeEvent(); } @Override public int hashCode() { int hash = 7; hash = 97 * hash + ObjectUtils.hashCode(this.start); hash = 97 * hash + ObjectUtils.hashCode(this.end); hash = 97 * hash + ObjectUtils.hashCode(this.label); return hash; } /** * Tests this marker for equality with an arbitrary object. * * @param obj the object to test against ({@code null} permitted). * * @return A boolean. */ @Override public boolean equals(Object obj) { if (obj == null) { return false; } if (getClass() != obj.getClass()) { return false; } final RangeMarker other = (RangeMarker) obj; if (!ObjectUtils.equals(this.start, other.start)) { return false; } if (!ObjectUtils.equals(this.end, other.end)) { return false; } if (!ObjectUtils.equals(this.label, other.label)) { return false; } if (!ObjectUtils.equals(this.font, other.font)) { return false; } if (!ObjectUtils.equals(this.labelColor, other.labelColor)) { return false; } if (!ObjectUtils.equals(this.labelAnchor, other.labelAnchor)) { return false; } if (!ObjectUtils.equals(this.fillColor, other.fillColor)) { return false; } return true; } }




© 2015 - 2024 Weber Informatics LLC | Privacy Policy