org.jfree.chart.plot.IntervalMarker Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of jfreechart Show documentation
Show all versions of jfreechart Show documentation
JFreeChart is a class library, written in Java, for generating charts.
Utilising the Java2D API, it supports a wide range of chart types including
bar charts, pie charts, line charts, XY-plots, time series plots, Sankey charts
and more.
/* ===========================================================
* JFreeChart : a free chart library for the Java(tm) platform
* ===========================================================
*
* (C) Copyright 2000-2011, by Object Refinery Limited and Contributors.
*
* Project Info: http://www.jfree.org/jfreechart/index.html
*
* This library is free software; you can redistribute it and/or modify it
* under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation; either version 2.1 of the License, or
* (at your option) any later version.
*
* This library 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 Lesser General Public
* License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301,
* USA.
*
* [Oracle and Java are registered trademarks of Oracle and/or its affiliates.
* Other names may be trademarks of their respective owners.]
*
* -------------------
* IntervalMarker.java
* -------------------
* (C) Copyright 2002-2008, by Object Refinery Limited.
*
* Original Author: David Gilbert (for Object Refinery Limited);
* Contributor(s): -;
*
* Changes
* -------
* 20-Aug-2002 : Added stroke to constructor in Marker class (DG);
* 02-Oct-2002 : Fixed errors reported by Checkstyle (DG);
* 26-Mar-2003 : Implemented Serializable (DG);
* ------------- JFREECHART 1.0.x ---------------------------------------------
* 05-Sep-2006 : Added MarkerChangeEvent notification (DG);
* 18-Dec-2007 : Added new constructor (DG);
*
*/
package org.jfree.chart.plot;
import java.awt.BasicStroke;
import java.awt.Color;
import java.awt.Paint;
import java.awt.Stroke;
import java.io.Serializable;
import org.jfree.chart.event.MarkerChangeEvent;
import org.jfree.ui.GradientPaintTransformer;
import org.jfree.ui.LengthAdjustmentType;
import org.jfree.util.ObjectUtilities;
/**
* Represents an interval to be highlighted in some way.
*/
public class IntervalMarker extends Marker implements Cloneable, Serializable {
/** For serialization. */
private static final long serialVersionUID = -1762344775267627916L;
/** The start value. */
private double startValue;
/** The end value. */
private double endValue;
/** The gradient paint transformer (optional). */
private GradientPaintTransformer gradientPaintTransformer;
/**
* Constructs an interval marker.
*
* @param start the start of the interval.
* @param end the end of the interval.
*/
public IntervalMarker(double start, double end) {
this(start, end, Color.gray, new BasicStroke(0.5f), Color.gray,
new BasicStroke(0.5f), 0.8f);
}
/**
* Creates a new interval marker with the specified range and fill paint.
* The outline paint and stroke default to null.
*
* @param start the lower bound of the interval.
* @param end the upper bound of the interval.
* @param paint the fill paint (null not permitted).
*
* @since 1.0.9
*/
public IntervalMarker(double start, double end, Paint paint) {
this(start, end, paint, new BasicStroke(0.5f), null, null, 0.8f);
}
/**
* Constructs an interval marker.
*
* @param start the start of the interval.
* @param end the end of the interval.
* @param paint the paint (null not permitted).
* @param stroke the stroke (null not permitted).
* @param outlinePaint the outline paint.
* @param outlineStroke the outline stroke.
* @param alpha the alpha transparency.
*/
public IntervalMarker(double start, double end,
Paint paint, Stroke stroke,
Paint outlinePaint, Stroke outlineStroke,
float alpha) {
super(paint, stroke, outlinePaint, outlineStroke, alpha);
this.startValue = start;
this.endValue = end;
this.gradientPaintTransformer = null;
setLabelOffsetType(LengthAdjustmentType.CONTRACT);
}
/**
* Returns the start value for the interval.
*
* @return The start value.
*/
public double getStartValue() {
return this.startValue;
}
/**
* Sets the start value for the marker and sends a
* {@link MarkerChangeEvent} to all registered listeners.
*
* @param value the value.
*
* @since 1.0.3
*/
public void setStartValue(double value) {
this.startValue = value;
notifyListeners(new MarkerChangeEvent(this));
}
/**
* Returns the end value for the interval.
*
* @return The end value.
*/
public double getEndValue() {
return this.endValue;
}
/**
* Sets the end value for the marker and sends a
* {@link MarkerChangeEvent} to all registered listeners.
*
* @param value the value.
*
* @since 1.0.3
*/
public void setEndValue(double value) {
this.endValue = value;
notifyListeners(new MarkerChangeEvent(this));
}
/**
* Returns the gradient paint transformer.
*
* @return The gradient paint transformer (possibly null).
*/
public GradientPaintTransformer getGradientPaintTransformer() {
return this.gradientPaintTransformer;
}
/**
* Sets the gradient paint transformer and sends a
* {@link MarkerChangeEvent} to all registered listeners.
*
* @param transformer the transformer (null permitted).
*/
public void setGradientPaintTransformer(
GradientPaintTransformer transformer) {
this.gradientPaintTransformer = transformer;
notifyListeners(new MarkerChangeEvent(this));
}
/**
* Tests the marker for equality with an arbitrary object.
*
* @param obj the object (null permitted).
*
* @return A boolean.
*/
public boolean equals(Object obj) {
if (obj == this) {
return true;
}
if (!(obj instanceof IntervalMarker)) {
return false;
}
if (!super.equals(obj)) {
return false;
}
IntervalMarker that = (IntervalMarker) obj;
if (this.startValue != that.startValue) {
return false;
}
if (this.endValue != that.endValue) {
return false;
}
if (!ObjectUtilities.equal(this.gradientPaintTransformer,
that.gradientPaintTransformer)) {
return false;
}
return true;
}
/**
* Returns a clone of the marker.
*
* @return A clone.
*
* @throws CloneNotSupportedException Not thrown by this class, but the
* exception is declared for the use of subclasses.
*/
public Object clone() throws CloneNotSupportedException {
return super.clone();
}
}