www.pudn.com > jfreechart-0.9.12.zip > TextAnnotation.java
/* ======================================
* JFreeChart : a free Java chart library
* ======================================
*
* Project Info: http://www.jfree.org/jfreechart/index.html
* Project Lead: David Gilbert (david.gilbert@object-refinery.com);
*
* (C) Copyright 2000-2003, by Object Refinery Limited and Contributors.
*
* 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., 59 Temple Place, Suite 330,
* Boston, MA 02111-1307, USA.
*
* -------------------
* TextAnnotation.java
* -------------------
* (C) Copyright 2002, 2003, by Object Refinery Limited.
*
* Original Author: David Gilbert (for Object Refinery Limited);
* Contributor(s): -;
*
* $Id: TextAnnotation.java,v 1.5 2003/08/20 11:34:36 mungady Exp $
*
* Changes:
* --------
* 28-Aug-2002 : Version 1 (DG);
* 07-Nov-2002 : Fixed errors reported by Checkstyle, added accessor methods (DG);
* 13-Jan-2003 : Reviewed Javadocs (DG);
* 26-Mar-2003 : Implemented Serializable (DG);
* 02-Jun-2003 : Added anchor and rotation settings (DG);
* 19-Aug-2003 : Added equals(...) method and implemented Cloneable (DG);
*
*/
package org.jfree.chart.annotations;
import java.awt.Color;
import java.awt.Font;
import java.awt.Paint;
import java.io.IOException;
import java.io.ObjectInputStream;
import java.io.ObjectOutputStream;
import java.io.Serializable;
import org.jfree.io.SerialUtilities;
import org.jfree.ui.TextAnchor;
import org.jfree.util.ObjectUtils;
/**
* A base class for text annotations. This class records the content but not the location of the
* annotation.
*
* @author David Gilbert
*/
public class TextAnnotation implements Serializable {
/** The default font. */
public static final Font DEFAULT_FONT = new Font("SansSerif", Font.PLAIN, 10);
/** The default paint. */
public static final Paint DEFAULT_PAINT = Color.black;
/** The default text anchor. */
public static final TextAnchor DEFAULT_TEXT_ANCHOR = TextAnchor.CENTER;
/** The default rotation anchor. */
public static final TextAnchor DEFAULT_ROTATION_ANCHOR = TextAnchor.CENTER;
/** The default rotation angle. */
public static final double DEFAULT_ROTATION_ANGLE = 0.0;
/** The text. */
private String text;
/** The font. */
private Font font;
/** The paint. */
private transient Paint paint;
/** The text anchor. */
private TextAnchor textAnchor;
/** The rotation anchor. */
private TextAnchor rotationAnchor;
/** The rotation angle. */
private double rotationAngle;
/**
* Creates a text annotation with default settings.
*
* @param text the text.
*/
protected TextAnnotation(String text) {
this.text = text;
this.font = DEFAULT_FONT;
this.paint = DEFAULT_PAINT;
this.textAnchor = DEFAULT_TEXT_ANCHOR;
this.rotationAnchor = DEFAULT_ROTATION_ANCHOR;
this.rotationAngle = DEFAULT_ROTATION_ANGLE;
}
/**
* Returns the text for the annotation.
*
* @return The text.
*/
public String getText() {
return this.text;
}
/**
* Sets the text for the annotation.
*
* @param text the text.
*/
public void setText(String text) {
this.text = text;
}
/**
* Returns the font for the annotation.
*
* @return The font.
*/
public Font getFont() {
return this.font;
}
/**
* Sets the font for the annotation.
*
* @param font the font.
*/
public void setFont(Font font) {
this.font = font;
}
/**
* Returns the paint for the annotation.
*
* @return The paint.
*/
public Paint getPaint() {
return this.paint;
}
/**
* Sets the paint for the annotation.
*
* @param paint the paint.
*/
public void setPaint(Paint paint) {
this.paint = paint;
}
/**
* Returns the text anchor.
*
* @return The text anchor.
*/
public TextAnchor getTextAnchor() {
return this.textAnchor;
}
/**
* Sets the text anchor (the point on the text bounding rectangle that is aligned to the
* (x, y) coordinate of the annotation).
*
* @param anchor the anchor point.
*/
public void setTextAnchor(TextAnchor anchor) {
this.textAnchor = anchor;
}
/**
* Returns the rotation anchor.
*
* @return The rotation anchor point.
*/
public TextAnchor getRotationAnchor() {
return this.rotationAnchor;
}
/**
* Sets the rotation anchor point.
*
* @param anchor the anchor.
*/
public void setRotationAnchor(TextAnchor anchor) {
this.rotationAnchor = anchor;
}
/**
* Returns the rotation angle.
*
* @return The rotation angle.
*/
public double getRotationAngle() {
return this.rotationAngle;
}
/**
* Sets the rotation angle.
*
* The angle is measured clockwise in radians.
*
* @param angle the angle (in radians).
*/
public void setRotationAngle(double angle) {
this.rotationAngle = angle;
}
/**
* Tests this object for equality with another object.
*
* @param object the object.
*
* @return true or false.
*/
public boolean equals(Object object) {
if (object == null) {
return false;
}
if (object == this) {
return true;
}
if (object instanceof TextAnnotation) {
TextAnnotation ta = (TextAnnotation) object;
boolean b0 = ObjectUtils.equal(this.text, ta.getText());
boolean b1 = ObjectUtils.equal(this.font, ta.getFont());
boolean b2 = ObjectUtils.equal(this.paint, ta.getPaint());
boolean b3 = ObjectUtils.equal(this.textAnchor, ta.getTextAnchor());
boolean b4 = ObjectUtils.equal(this.rotationAnchor, ta.getRotationAnchor());
boolean b5 = (this.rotationAngle == ta.getRotationAngle());
return b0 && b1 && b2 && b3 && b4 && b5;
}
return false;
}
/**
* Provides serialization support.
*
* @param stream the output stream.
*
* @throws IOException if there is an I/O error.
*/
private void writeObject(ObjectOutputStream stream) throws IOException {
stream.defaultWriteObject();
SerialUtilities.writePaint(this.paint, stream);
}
/**
* Provides serialization support.
*
* @param stream the input stream.
*
* @throws IOException if there is an I/O error.
* @throws ClassNotFoundException if there is a classpath problem.
*/
private void readObject(ObjectInputStream stream) throws IOException, ClassNotFoundException {
stream.defaultReadObject();
this.paint = SerialUtilities.readPaint(stream);
}
}