Overview Package Class Use Source Tree Index Deprecated About
Prev Class | Next ClassFrames | No Frames
Summary: Nested | Field | Method | ConstrDetail: Nested | Field | Method | Constr

org.jfree.chart.entity

Class CategoryItemEntity

Implemented Interfaces:
Cloneable, PublicCloneable, Serializable
public class CategoryItemEntity
extends ChartEntity
implements Cloneable, Serializable
A chart entity that represents one item within a category plot.

Constructor Summary

CategoryItemEntity(Shape area, String toolTipText, String urlText, CategoryDataset dataset, int series, Object category, int categoryIndex)
Creates a new category item entity.

Method Summary

boolean
equals(Object obj)
Tests the entity for equality with an arbitrary object.
Object
getCategory()
Returns the category.
int
getCategoryIndex()
Returns the category index.
CategoryDataset
getDataset()
Returns the datset this entity refers to.
int
getSeries()
Returns the series index.
void
setCategory(Object category)
Sets the category.
void
setCategoryIndex(int index)
Sets the category index.
void
setDataset(CategoryDataset dataset)
Sets the datset this entity refers to.
void
setSeries(int series)
Sets the series index.
String
toString()
Returns a string representing this object (useful for debugging purposes).

Methods inherited from class org.jfree.chart.entity.ChartEntity

clone, equals, getArea, getImageMapAreaTag, getShapeCoords, getShapeType, getToolTipText, getURLText, setArea, setToolTipText, setURLText, toString

Constructor Details

CategoryItemEntity

public CategoryItemEntity(Shape area,
                          String toolTipText,
                          String urlText,
                          CategoryDataset dataset,
                          int series,
                          Object category,
                          int categoryIndex)
Creates a new category item entity.
Parameters:
area - the area.
toolTipText - the tool tip text.
urlText - the URL text for HTML image maps.
dataset - the dataset.
series - the series (zero-based index).
category - the category.
categoryIndex - the category index.

Method Details

equals

public boolean equals(Object obj)
Tests the entity for equality with an arbitrary object.
Overrides:
equals in interface ChartEntity
Parameters:
obj - the object (null permitted).
Returns:
A boolean.

getCategory

public Object getCategory()
Returns the category.
Returns:
The category (possibly null).

getCategoryIndex

public int getCategoryIndex()
Returns the category index.
Returns:
The index.

getDataset

public CategoryDataset getDataset()
Returns the datset this entity refers to.
Returns:
The dataset (possibly null).

getSeries

public int getSeries()
Returns the series index.
Returns:
The series index.

setCategory

public void setCategory(Object category)
Sets the category.
Parameters:
category - the category (null permitted).

setCategoryIndex

public void setCategoryIndex(int index)
Sets the category index.
Parameters:
index - the category index.

setDataset

public void setDataset(CategoryDataset dataset)
Sets the datset this entity refers to.
Parameters:
dataset - the dataset (null permited).

setSeries

public void setSeries(int series)
Sets the series index.
Parameters:
series - the series index (zero-based).

toString

public String toString()
Returns a string representing this object (useful for debugging purposes).
Overrides:
toString in interface ChartEntity
Returns:
A string.

Overview Package Class Use Source Tree Index Deprecated About