001/* =========================================================== 002 * JFreeChart : a free chart library for the Java(tm) platform 003 * =========================================================== 004 * 005 * (C) Copyright 2000-2020, by Object Refinery Limited and Contributors. 006 * 007 * Project Info: http://www.jfree.org/jfreechart/index.html 008 * 009 * This library is free software; you can redistribute it and/or modify it 010 * under the terms of the GNU Lesser General Public License as published by 011 * the Free Software Foundation; either version 2.1 of the License, or 012 * (at your option) any later version. 013 * 014 * This library is distributed in the hope that it will be useful, but 015 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY 016 * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public 017 * License for more details. 018 * 019 * You should have received a copy of the GNU Lesser General Public 020 * License along with this library; if not, write to the Free Software 021 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, 022 * USA. 023 * 024 * [Oracle and Java are registered trademarks of Oracle and/or its affiliates. 025 * Other names may be trademarks of their respective owners.] 026 * 027 * ----------------------- 028 * XYAnnotationEntity.java 029 * ----------------------- 030 * (C) Copyright 2004-2020, by Object Refinery Limited. 031 * 032 * Original Author: David Gilbert (for Object Refinery Limited); 033 * Contributor(s): -; 034 * 035 */ 036 037package org.jfree.chart.entity; 038 039import java.awt.Shape; 040import java.io.Serializable; 041 042/** 043 * A chart entity that represents an annotation on an 044 * {@link org.jfree.chart.plot.XYPlot}. 045 */ 046public class XYAnnotationEntity extends ChartEntity 047 implements Serializable { 048 049 /** For serialization. */ 050 private static final long serialVersionUID = 2340334068383660799L; 051 052 /** The renderer index. */ 053 private int rendererIndex; 054 055 /** 056 * Creates a new entity. 057 * 058 * @param hotspot the area. 059 * @param rendererIndex the rendererIndex (zero-based index). 060 * @param toolTipText the tool tip text. 061 * @param urlText the URL text for HTML image maps. 062 */ 063 public XYAnnotationEntity(Shape hotspot, int rendererIndex, 064 String toolTipText, String urlText) { 065 super(hotspot, toolTipText, urlText); 066 this.rendererIndex = rendererIndex; 067 } 068 069 /** 070 * Returns the renderer index. 071 * 072 * @return The renderer index. 073 */ 074 public int getRendererIndex() { 075 return this.rendererIndex; 076 } 077 078 /** 079 * Sets the renderer index. 080 * 081 * @param index the item index (zero-based). 082 */ 083 public void setRendererIndex(int index) { 084 this.rendererIndex = index; 085 } 086 087 /** 088 * Tests the entity for equality with an arbitrary object. 089 * 090 * @param obj the object ({@code null} permitted). 091 * 092 * @return A boolean. 093 */ 094 @Override 095 public boolean equals(Object obj) { 096 if (obj == this) { 097 return true; 098 } 099 if (!super.equals(obj)) { 100 return false; 101 } 102 if (!(obj instanceof XYAnnotationEntity)) { 103 return false; 104 } 105 XYAnnotationEntity that = (XYAnnotationEntity) obj; 106 if (this.rendererIndex != that.rendererIndex) { 107 return false; 108 } 109 return true; 110 } 111 112}