org.jfree.chart.entity
Class CategoryItemEntity

java.lang.Object
  |
  +--org.jfree.chart.entity.ChartEntity
        |
        +--org.jfree.chart.entity.CategoryItemEntity

public class CategoryItemEntity

extends ChartEntity

A chart entity that represents one item within a category plot.

Author:

David Gilbert

Constructor Summary

CategoryItemEntity(java.awt.Shape area, java.lang.String toolTipText, int series, java.lang.Object category, int categoryIndex)
Creates a new category item entity.

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

Method Summary

java.lang.Object	getCategory() Returns the category.
int	getCategoryIndex() Returns the category index.
int	getSeries() Returns the series index.
void	setCategory(java.lang.Object category) Sets the category.
void	setCategoryIndex(int index) Sets the category index.
void	setSeries(int series) Sets the series index.
java.lang.String	toString() Returns a string representing this object.

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

getArea, getImageMapAreaTag, getImageMapAreaTag, getShapeCoords, getShapeType, getToolTipText, getURLText, setArea, setToolTipText, setURLText

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

CategoryItemEntity

public CategoryItemEntity(java.awt.Shape area,
                          java.lang.String toolTipText,
                          int series,
                          java.lang.Object category,
                          int categoryIndex)

Creates a new category item entity.

Parameters:

area - the area.

toolTipText - the tool tip text.

series - the series (zero-based index).

category - the category.

categoryIndex - the index of the category.

CategoryItemEntity

public CategoryItemEntity(java.awt.Shape area,
                          java.lang.String toolTipText,
                          java.lang.String urlText,
                          int series,
                          java.lang.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.

series - the series (zero-based index).

category - the category.

categoryIndex - the category index.

Method Detail

getSeries

public int getSeries()

Returns the series index.

Returns:

the series index.

setSeries

public void setSeries(int series)

Sets the series index.

Parameters:

series - the series index (zero-based).

getCategory

public java.lang.Object getCategory()

Returns the category.

Returns:

the category.

setCategory

public void setCategory(java.lang.Object category)

Sets the category.

Parameters:

category - the category.

getCategoryIndex

public int getCategoryIndex()

Returns the category index.

Returns:

the category index.

setCategoryIndex

public void setCategoryIndex(int index)

Sets the category index.

Parameters:

index - the category index.

toString

public java.lang.String toString()

Returns a string representing this object.

Overrides:

toString in class java.lang.Object

Returns:

a string representing this object.