/* ===========================================================
* JFreeChart : a free chart library for the Java(tm) platform
* ===========================================================
*
* (C) Copyright 2000-2006, 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.
*
* [Java is a trademark or registered trademark of Sun Microsystems, Inc.
* in the United States and other countries.]
*
* -------------------
* IntervalMarker.java
* -------------------
* (C) Copyright 2002-2006, by Object Refinery Limited.
*
* Original Author: David Gilbert (for Object Refinery Limited);
* Contributor(s): -;
*
* $Id: IntervalMarker.java,v 1.1 2007/08/24 12:43:41 slapukhov Exp $
*
* Changes (since 20-Aug-2002)
* --------------------------
* 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);
*
*/
package com.positive.charts.plot;
import java.io.Serializable;
import org.eclipse.swt.graphics.Color;
import com.positive.charts.event.MarkerChangeEvent;
import com.positive.charts.util.LengthAdjustmentType;
import com.positive.charts.util.Stroke;
/**
* 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;
/**
* Constructs an interval marker.
*
* @param start
* the start of the interval.
* @param end
* the end of the interval.
* @param paint
* the paint.
* @param stroke
* the stroke.
* @param outlinePaint
* the outline paint.
* @param outlineStroke
* the outline stroke.
* @param alpha
* the alpha transparency.
*/
public IntervalMarker(final double start, final double end,
final Color paint, final Stroke stroke, final Color outlinePaint,
final Stroke outlineStroke, final int alpha) {
super(paint, stroke, outlinePaint, outlineStroke, alpha);
this.startValue = start;
this.endValue = end;
this.setLabelOffsetType(LengthAdjustmentType.CONTRACT);
}
/**
* 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();
}
/**
* Tests the marker for equality with an arbitrary object.
*
* @param obj
* the object (<code>null</code> permitted).
*
* @return A boolean.
*/
public boolean equals(final Object obj) {
if (obj == this) {
return true;
}
if (!(obj instanceof IntervalMarker)) {
return false;
}
if (!super.equals(obj)) {
return false;
}
final IntervalMarker that = (IntervalMarker) obj;
if (this.startValue != that.startValue) {
return false;
}
if (this.endValue != that.endValue) {
return false;
}
return true;
}
/**
* Returns the end value for the interval.
*
* @return The end value.
*/
public double getEndValue() {
return this.endValue;
}
/**
* Returns the start value for the interval.
*
* @return The start value.
*/
public double getStartValue() {
return this.startValue;
}
/**
* 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(final double value) {
this.endValue = value;
this.notifyListeners(new MarkerChangeEvent(this));
}
/**
* 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(final double value) {
this.startValue = value;
this.notifyListeners(new MarkerChangeEvent(this));
}
}