|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectorg.jfree.chart.renderer.AbstractRenderer
org.jfree.chart.renderer.category.AbstractCategoryItemRenderer
public abstract class AbstractCategoryItemRenderer
An abstract base class that you can use to implement a new
CategoryItemRenderer. When you create a new
CategoryItemRenderer you are not required to extend this class,
but it makes the job easier.
| Field Summary |
|---|
| Fields inherited from class org.jfree.chart.renderer.AbstractRenderer |
|---|
DEFAULT_OUTLINE_PAINT, DEFAULT_OUTLINE_STROKE, DEFAULT_PAINT, DEFAULT_SHAPE, DEFAULT_STROKE, DEFAULT_VALUE_LABEL_FONT, DEFAULT_VALUE_LABEL_PAINT, ZERO |
| Constructor Summary | |
|---|---|
protected |
AbstractCategoryItemRenderer()
Creates a new renderer with no tool tip generator and no URL generator. |
| Method Summary | |
|---|---|
protected void |
addItemEntity(EntityCollection entities,
CategoryDataset dataset,
int row,
int column,
java.awt.Shape hotspot)
Adds an entity with the specified hotspot. |
protected java.awt.geom.Point2D |
calculateDomainMarkerTextAnchorPoint(java.awt.Graphics2D g2,
PlotOrientation orientation,
java.awt.geom.Rectangle2D dataArea,
java.awt.geom.Rectangle2D markerArea,
org.jfree.ui.RectangleInsets markerOffset,
org.jfree.ui.LengthAdjustmentType labelOffsetType,
org.jfree.ui.RectangleAnchor anchor)
Calculates the (x, y) coordinates for drawing the label for a marker on the range axis. |
protected java.awt.geom.Point2D |
calculateRangeMarkerTextAnchorPoint(java.awt.Graphics2D g2,
PlotOrientation orientation,
java.awt.geom.Rectangle2D dataArea,
java.awt.geom.Rectangle2D markerArea,
org.jfree.ui.RectangleInsets markerOffset,
org.jfree.ui.LengthAdjustmentType labelOffsetType,
org.jfree.ui.RectangleAnchor anchor)
Calculates the (x, y) coordinates for drawing a marker label. |
java.lang.Object |
clone()
Returns an independent copy of the renderer. |
protected CategoryItemRendererState |
createState(PlotRenderingInfo info)
Creates a new state instance---this method is called from the initialise(Graphics2D, Rectangle2D, CategoryPlot, int,
PlotRenderingInfo) method. |
void |
drawBackground(java.awt.Graphics2D g2,
CategoryPlot plot,
java.awt.geom.Rectangle2D dataArea)
Draws a background for the data area. |
void |
drawDomainGridline(java.awt.Graphics2D g2,
CategoryPlot plot,
java.awt.geom.Rectangle2D dataArea,
double value)
Draws a grid line against the domain axis. |
void |
drawDomainMarker(java.awt.Graphics2D g2,
CategoryPlot plot,
CategoryAxis axis,
CategoryMarker marker,
java.awt.geom.Rectangle2D dataArea)
Draws a marker for the domain axis. |
protected void |
drawItemLabel(java.awt.Graphics2D g2,
PlotOrientation orientation,
CategoryDataset dataset,
int row,
int column,
double x,
double y,
boolean negative)
Draws an item label. |
void |
drawOutline(java.awt.Graphics2D g2,
CategoryPlot plot,
java.awt.geom.Rectangle2D dataArea)
Draws an outline for the data area. |
void |
drawRangeGridline(java.awt.Graphics2D g2,
CategoryPlot plot,
ValueAxis axis,
java.awt.geom.Rectangle2D dataArea,
double value)
Draws a grid line against the range axis. |
void |
drawRangeMarker(java.awt.Graphics2D g2,
CategoryPlot plot,
ValueAxis axis,
Marker marker,
java.awt.geom.Rectangle2D dataArea)
Draws a marker for the range axis. |
boolean |
equals(java.lang.Object obj)
Tests this renderer for equality with another object. |
Range |
findRangeBounds(CategoryDataset dataset)
Returns the range of values the renderer requires to display all the items from the specified dataset. |
CategoryItemLabelGenerator |
getBaseItemLabelGenerator()
Returns the base item label generator. |
CategoryURLGenerator |
getBaseItemURLGenerator()
Returns the base item URL generator. |
CategoryToolTipGenerator |
getBaseToolTipGenerator()
Returns the base tool tip generator (the "layer 2" generator). |
int |
getColumnCount()
Returns the number of columns in the dataset. |
protected CategoryAxis |
getDomainAxis(CategoryPlot plot,
int index)
Returns a domain axis for a plot. |
DrawingSupplier |
getDrawingSupplier()
Returns the drawing supplier from the plot. |
CategoryItemLabelGenerator |
getItemLabelGenerator(int row,
int column)
Returns the item label generator for a data item. |
double |
getItemMiddle(java.lang.Comparable rowKey,
java.lang.Comparable columnKey,
CategoryDataset dataset,
CategoryAxis axis,
java.awt.geom.Rectangle2D area,
org.jfree.ui.RectangleEdge edge)
Returns the Java2D coordinate for the middle of the specified data item. |
CategoryURLGenerator |
getItemURLGenerator(int row,
int column)
Returns the URL generator for a data item. |
LegendItem |
getLegendItem(int datasetIndex,
int series)
Returns a legend item for a series. |
CategorySeriesLabelGenerator |
getLegendItemLabelGenerator()
Returns the legend item label generator. |
LegendItemCollection |
getLegendItems()
Returns a (possibly empty) collection of legend items for the series that this renderer is responsible for drawing. |
CategorySeriesLabelGenerator |
getLegendItemToolTipGenerator()
Returns the legend item tool tip generator. |
CategorySeriesLabelGenerator |
getLegendItemURLGenerator()
Returns the legend item URL generator. |
int |
getPassCount()
Returns the number of passes through the dataset required by the renderer. |
CategoryPlot |
getPlot()
Returns the plot that the renderer has been assigned to (where null indicates that the renderer is not currently assigned
to a plot). |
protected ValueAxis |
getRangeAxis(CategoryPlot plot,
int index)
Returns a range axis for a plot. |
int |
getRowCount()
Returns the number of rows in the dataset. |
CategoryItemLabelGenerator |
getSeriesItemLabelGenerator(int series)
Returns the item label generator for a series. |
CategoryURLGenerator |
getSeriesItemURLGenerator(int series)
Returns the URL generator for a series. |
CategoryToolTipGenerator |
getSeriesToolTipGenerator(int series)
Returns the tool tip generator for the specified series (a "layer 1" generator). |
CategoryToolTipGenerator |
getToolTipGenerator()
Deprecated. This method should no longer be used (as of version 1.0.6). It is sufficient to rely on getSeriesToolTipGenerator(int)
and getBaseToolTipGenerator(). |
CategoryToolTipGenerator |
getToolTipGenerator(int row,
int column)
Returns the tool tip generator that should be used for the specified item. |
int |
hashCode()
Returns a hash code for the renderer. |
CategoryItemRendererState |
initialise(java.awt.Graphics2D g2,
java.awt.geom.Rectangle2D dataArea,
CategoryPlot plot,
int rendererIndex,
PlotRenderingInfo info)
Initialises the renderer and returns a state object that will be used for the remainder of the drawing process for a single chart. |
void |
setBaseItemLabelGenerator(CategoryItemLabelGenerator generator)
Sets the base item label generator and sends a RendererChangeEvent to all registered listeners. |
void |
setBaseItemURLGenerator(CategoryURLGenerator generator)
Sets the base item URL generator and sends a RendererChangeEvent to all registered listeners. |
void |
setBaseToolTipGenerator(CategoryToolTipGenerator generator)
Sets the base tool tip generator and sends a RendererChangeEvent
to all registered listeners. |
void |
setItemLabelGenerator(CategoryItemLabelGenerator generator)
Deprecated. This method should no longer be used (as of version 1.0.6). It is sufficient to rely on setSeriesItemLabelGenerator(int,
CategoryItemLabelGenerator) and
setBaseItemLabelGenerator(CategoryItemLabelGenerator). |
void |
setItemURLGenerator(CategoryURLGenerator generator)
Deprecated. This method should no longer be used (as of version 1.0.6). It is sufficient to rely on setSeriesItemURLGenerator(int,
CategoryURLGenerator) and
setBaseItemURLGenerator(CategoryURLGenerator). |
void |
setLegendItemLabelGenerator(CategorySeriesLabelGenerator generator)
Sets the legend item label generator and sends a RendererChangeEvent to all registered listeners. |
void |
setLegendItemToolTipGenerator(CategorySeriesLabelGenerator generator)
Sets the legend item tool tip generator and sends a RendererChangeEvent to all registered listeners. |
void |
setLegendItemURLGenerator(CategorySeriesLabelGenerator generator)
Sets the legend item URL generator and sends a RendererChangeEvent to all registered listeners. |
void |
setPlot(CategoryPlot plot)
Sets the plot that the renderer has been assigned to. |
void |
setSeriesItemLabelGenerator(int series,
CategoryItemLabelGenerator generator)
Sets the item label generator for a series and sends a RendererChangeEvent to all registered listeners. |
void |
setSeriesItemURLGenerator(int series,
CategoryURLGenerator generator)
Sets the URL generator for a series and sends a RendererChangeEvent to all registered listeners. |
void |
setSeriesToolTipGenerator(int series,
CategoryToolTipGenerator generator)
Sets the tool tip generator for a series and sends a RendererChangeEvent to all registered listeners. |
void |
setToolTipGenerator(CategoryToolTipGenerator generator)
Deprecated. This method should no longer be used (as of version 1.0.6). It is sufficient to rely on setSeriesToolTipGenerator(int,
CategoryToolTipGenerator) and
setBaseToolTipGenerator(CategoryToolTipGenerator). |
protected void |
updateCrosshairValues(CategoryCrosshairState crosshairState,
java.lang.Comparable rowKey,
java.lang.Comparable columnKey,
double value,
int datasetIndex,
double transX,
double transY,
PlotOrientation orientation)
Considers the current (x, y) coordinate and updates the crosshair point if it meets the criteria (usually means the (x, y) coordinate is the closest to the anchor point so far). |
| Methods inherited from class java.lang.Object |
|---|
finalize, getClass, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
|---|
protected AbstractCategoryItemRenderer()
| Method Detail |
|---|
public int getPassCount()
1, subclasses should
override if they need more passes.
getPassCount in interface CategoryItemRendererpublic CategoryPlot getPlot()
null indicates that the renderer is not currently assigned
to a plot).
getPlot in interface CategoryItemRenderernull).setPlot(CategoryPlot)public void setPlot(CategoryPlot plot)
CategoryPlot, in normal usage you
shouldn't need to call this method directly.
setPlot in interface CategoryItemRendererplot - the plot (null not permitted).getPlot()
public CategoryItemLabelGenerator getItemLabelGenerator(int row,
int column)
getSeriesItemLabelGenerator(int)
method. If, for some reason, you want a different generator for
individual items, you can override this method.
getItemLabelGenerator in interface CategoryItemRendererrow - the row index (zero based).column - the column index (zero based).
null).public CategoryItemLabelGenerator getSeriesItemLabelGenerator(int series)
getSeriesItemLabelGenerator in interface CategoryItemRendererseries - the series index (zero based).
null).setSeriesItemLabelGenerator(int, CategoryItemLabelGenerator)public void setItemLabelGenerator(CategoryItemLabelGenerator generator)
setSeriesItemLabelGenerator(int,
CategoryItemLabelGenerator) and
setBaseItemLabelGenerator(CategoryItemLabelGenerator).
RendererChangeEvent to all registered listeners.
setItemLabelGenerator in interface CategoryItemRenderergenerator - the generator (null permitted).
public void setSeriesItemLabelGenerator(int series,
CategoryItemLabelGenerator generator)
RendererChangeEvent to all registered listeners.
setSeriesItemLabelGenerator in interface CategoryItemRendererseries - the series index (zero based).generator - the generator (null permitted).getSeriesItemLabelGenerator(int)public CategoryItemLabelGenerator getBaseItemLabelGenerator()
getBaseItemLabelGenerator in interface CategoryItemRenderernull).setBaseItemLabelGenerator(CategoryItemLabelGenerator)public void setBaseItemLabelGenerator(CategoryItemLabelGenerator generator)
RendererChangeEvent to all registered listeners.
setBaseItemLabelGenerator in interface CategoryItemRenderergenerator - the generator (null permitted).getBaseItemLabelGenerator()
public CategoryToolTipGenerator getToolTipGenerator(int row,
int column)
getToolTipGenerator in interface CategoryItemRendererrow - the row index (zero-based).column - the column index (zero-based).
null).public CategoryToolTipGenerator getToolTipGenerator()
getSeriesToolTipGenerator(int)
and getBaseToolTipGenerator().
getToolTipGenerator in interface CategoryItemRenderernull).setToolTipGenerator(CategoryToolTipGenerator)public void setToolTipGenerator(CategoryToolTipGenerator generator)
setSeriesToolTipGenerator(int,
CategoryToolTipGenerator) and
setBaseToolTipGenerator(CategoryToolTipGenerator).
RendererChangeEvent to all registered
listeners.
setToolTipGenerator in interface CategoryItemRenderergenerator - the generator (null permitted).getToolTipGenerator()public CategoryToolTipGenerator getSeriesToolTipGenerator(int series)
getSeriesToolTipGenerator in interface CategoryItemRendererseries - the series index (zero-based).
null).setSeriesToolTipGenerator(int, CategoryToolTipGenerator)
public void setSeriesToolTipGenerator(int series,
CategoryToolTipGenerator generator)
RendererChangeEvent to all registered listeners.
setSeriesToolTipGenerator in interface CategoryItemRendererseries - the series index (zero-based).generator - the generator (null permitted).getSeriesToolTipGenerator(int)public CategoryToolTipGenerator getBaseToolTipGenerator()
getBaseToolTipGenerator in interface CategoryItemRenderernull).setBaseToolTipGenerator(CategoryToolTipGenerator)public void setBaseToolTipGenerator(CategoryToolTipGenerator generator)
RendererChangeEvent
to all registered listeners.
setBaseToolTipGenerator in interface CategoryItemRenderergenerator - the generator (null permitted).getBaseToolTipGenerator()
public CategoryURLGenerator getItemURLGenerator(int row,
int column)
getItemURLGenerator in interface CategoryItemRendererrow - the row index (zero based).column - the column index (zero based).
public CategoryURLGenerator getSeriesItemURLGenerator(int series)
getSeriesItemURLGenerator in interface CategoryItemRendererseries - the series index (zero based).
setSeriesItemURLGenerator(int, CategoryURLGenerator)public void setItemURLGenerator(CategoryURLGenerator generator)
setSeriesItemURLGenerator(int,
CategoryURLGenerator) and
setBaseItemURLGenerator(CategoryURLGenerator).
RendererChangeEvent to all registered listeners.
setItemURLGenerator in interface CategoryItemRenderergenerator - the generator.CategoryItemRenderer.getSeriesItemURLGenerator(int)
public void setSeriesItemURLGenerator(int series,
CategoryURLGenerator generator)
RendererChangeEvent to all registered listeners.
setSeriesItemURLGenerator in interface CategoryItemRendererseries - the series index (zero based).generator - the generator.getSeriesItemURLGenerator(int)public CategoryURLGenerator getBaseItemURLGenerator()
getBaseItemURLGenerator in interface CategoryItemRenderersetBaseItemURLGenerator(CategoryURLGenerator)public void setBaseItemURLGenerator(CategoryURLGenerator generator)
RendererChangeEvent to all registered listeners.
setBaseItemURLGenerator in interface CategoryItemRenderergenerator - the item URL generator (null permitted).getBaseItemURLGenerator()public int getRowCount()
initialise(java.awt.Graphics2D, java.awt.geom.Rectangle2D, org.jfree.chart.plot.CategoryPlot, int, org.jfree.chart.plot.PlotRenderingInfo) method.
public int getColumnCount()
initialise(java.awt.Graphics2D, java.awt.geom.Rectangle2D, org.jfree.chart.plot.CategoryPlot, int, org.jfree.chart.plot.PlotRenderingInfo) method.
protected CategoryItemRendererState createState(PlotRenderingInfo info)
initialise(Graphics2D, Rectangle2D, CategoryPlot, int,
PlotRenderingInfo) method. Subclasses can override this method if
they need to use a subclass of