|
||||||||||
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.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 | |
java.lang.Object |
clone()
Returns an independent copy of the renderer. |
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. |
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. |
CategoryItemLabelGenerator |
getBaseItemLabelGenerator()
Returns the base item label generator. |
CategoryURLGenerator |
getBaseItemURLGenerator()
Returns the base item URL generator. |
int |
getColumnCount()
Returns the number of columns in the dataset. |
protected CategoryDataset |
getDataset(CategoryPlot plot,
java.lang.Integer index)
Returns a dataset for a plot. |
protected CategoryAxis |
getDomainAxis(CategoryPlot plot,
java.lang.Integer index)
Returns a domain axis for a plot. |
DrawingSupplier |
getDrawingSupplier()
Returns the drawing supplier from the plot. |
double |
getItemLabelAnchorOffset()
Returns the item label anchor offset. |
CategoryItemLabelGenerator |
getItemLabelGenerator(int row,
int column)
Returns the label generator for a 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. |
CategoryPlot |
getPlot()
Returns the plot that the renderer is currently assigned to. |
protected ValueAxis |
getRangeAxis(CategoryPlot plot,
java.lang.Integer index)
Returns a range axis for a plot. |
RangeType |
getRangeType()
Returns the range type for the renderer. |
int |
getRowCount()
Returns the number of rows in the dataset. |
CategoryItemLabelGenerator |
getSeriesItemLabelGenerator(int series)
Returns the label generator for a series. |
CategoryURLGenerator |
getSeriesItemURLGenerator(int series)
Returns the URL generator for a series. |
int |
hashCode()
Returns a hash code for the renderer. |
CategoryItemRendererState |
initialise(java.awt.Graphics2D g2,
java.awt.geom.Rectangle2D dataArea,
CategoryPlot plot,
java.lang.Integer index,
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. |
void |
setBaseItemURLGenerator(CategoryURLGenerator generator)
Sets the base item URL generator. |
void |
setItemLabelAnchorOffset(double offset)
Sets the item label anchor offset. |
void |
setItemLabelGenerator(CategoryItemLabelGenerator generator)
Sets the item label generator for ALL series. |
void |
setItemURLGenerator(CategoryURLGenerator generator)
Sets the item URL generator for ALL series. |
void |
setPlot(CategoryPlot plot)
Sets the plot that the renderer is currently assigned to. |
void |
setSeriesItemLabelGenerator(int series,
CategoryItemLabelGenerator generator)
Sets the label generator for a series. |
void |
setSeriesItemURLGenerator(int series,
CategoryURLGenerator generator)
Sets the URL generator for a series. |
Methods inherited from class java.lang.Object |
finalize, getClass, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
protected AbstractCategoryItemRenderer()
The defaults (no tool tip or URL generators) have been chosen to minimise the processing required to generate a default chart. If you require tool tips or URLs, then you can easily add the required generators.
Method Detail |
public CategoryPlot getPlot()
getPlot
in interface CategoryItemRenderer
public void setPlot(CategoryPlot plot)
setPlot
in interface CategoryItemRenderer
plot
- the plot.public CategoryItemLabelGenerator getItemLabelGenerator(int row, int column)
getItemLabelGenerator
in interface CategoryItemRenderer
row
- the row index (zero based).column
- the column index (zero based).
public CategoryItemLabelGenerator getSeriesItemLabelGenerator(int series)
getSeriesItemLabelGenerator
in interface CategoryItemRenderer
series
- the series index (zero based).
public void setItemLabelGenerator(CategoryItemLabelGenerator generator)
setItemLabelGenerator
in interface CategoryItemRenderer
generator
- the generator.public void setSeriesItemLabelGenerator(int series, CategoryItemLabelGenerator generator)
setSeriesItemLabelGenerator
in interface CategoryItemRenderer
series
- the series index (zero based).generator
- the generator.public CategoryItemLabelGenerator getBaseItemLabelGenerator()
getBaseItemLabelGenerator
in interface CategoryItemRenderer
public void setBaseItemLabelGenerator(CategoryItemLabelGenerator generator)
setBaseItemLabelGenerator
in interface CategoryItemRenderer
generator
- the base item label generator.public CategoryURLGenerator getItemURLGenerator(int row, int column)
getItemURLGenerator
in interface CategoryItemRenderer
row
- the row index (zero based).column
- the column index (zero based).
public CategoryURLGenerator getSeriesItemURLGenerator(int series)
getSeriesItemURLGenerator
in interface CategoryItemRenderer
series
- the series index (zero based).
public void setItemURLGenerator(CategoryURLGenerator generator)
setItemURLGenerator
in interface CategoryItemRenderer
generator
- the generator.public void setSeriesItemURLGenerator(int series, CategoryURLGenerator generator)
setSeriesItemURLGenerator
in interface CategoryItemRenderer
series
- the series index (zero based).generator
- the generator.public CategoryURLGenerator getBaseItemURLGenerator()
getBaseItemURLGenerator
in interface CategoryItemRenderer
public void setBaseItemURLGenerator(CategoryURLGenerator generator)
setBaseItemURLGenerator
in interface CategoryItemRenderer
generator
- the item URL generator.public double getItemLabelAnchorOffset()
public void setItemLabelAnchorOffset(double offset)
offset
- the offset.public int getRowCount()
initialise(java.awt.Graphics2D, java.awt.geom.Rectangle2D, org.jfree.chart.plot.CategoryPlot, java.lang.Integer, org.jfree.chart.plot.PlotRenderingInfo)
method.
public int getColumnCount()
initialise(java.awt.Graphics2D, java.awt.geom.Rectangle2D, org.jfree.chart.plot.CategoryPlot, java.lang.Integer, org.jfree.chart.plot.PlotRenderingInfo)
method.
public CategoryItemRendererState initialise(java.awt.Graphics2D g2, java.awt.geom.Rectangle2D dataArea, CategoryPlot plot, java.lang.Integer index, PlotRenderingInfo info)
Stores a reference to the PlotRenderingInfo
object (which might be
null
), and then sets the useCategoriesPaint flag according to the special case
conditions a) there is only one series and b) the categoriesPaint array is not null.
initialise
in interface CategoryItemRenderer
g2
- the graphics device.dataArea
- the data area.plot
- the plot.index
- the secondary index (null
for primary renderer).info
- an object for returning information about the structure of the plot
(null
permitted).
public RangeType getRangeType()
The default implementation returns STANDARD
, subclasses may override this
behaviour.
The CategoryPlot
uses this information when auto-calculating the range for the axis.
getRangeType
in interface CategoryItemRenderer
public void drawBackground(java.awt.Graphics2D g2, CategoryPlot plot, java.awt.geom.Rectangle2D dataArea)
drawBackground
in interface CategoryItemRenderer
g2
- the graphics device.plot
- the plot.dataArea
- the data area.public void drawOutline(java.awt.Graphics2D g2, CategoryPlot plot, java.awt.geom.Rectangle2D dataArea)
drawOutline
in interface CategoryItemRenderer
g2
- the graphics device.plot
- the plot.dataArea
- the data area.public void drawDomainGridline(java.awt.Graphics2D g2, CategoryPlot plot, java.awt.geom.Rectangle2D dataArea, double value)
Note that this default implementation assumes that the horizontal axis is the domain axis. If this is not the case, you will need to override this method.
drawDomainGridline
in interface CategoryItemRenderer
g2
- the graphics device.plot
- the plot.dataArea
- the area for plotting data (not yet adjusted for any 3D effect).value
- the Java2D value at which the grid line should be drawn.public void drawRangeGridline(java.awt.Graphics2D g2, CategoryPlot plot, ValueAxis axis, java.awt.geom.Rectangle2D dataArea, double value)
drawRangeGridline
in interface CategoryItemRenderer
g2
- the graphics device.plot
- the plot.axis
- the value axis.dataArea
- the area for plotting data (not yet adjusted for any 3D effect).value
- the value at which the grid line should be drawn.public void drawRangeMarker(java.awt.Graphics2D g2, CategoryPlot plot, ValueAxis axis, Marker marker, java.awt.geom.Rectangle2D dataArea)
A marker is a constant value, usually represented by a line.
drawRangeMarker
in interface CategoryItemRenderer
g2
- the graphics device.plot
- the plot.axis
- the range axis.marker
- the marker to be drawn.dataArea
- the area inside the axes.public LegendItem getLegendItem(int datasetIndex, int series)
getLegendItem
in interface CategoryItemRenderer
datasetIndex
- the dataset index (zero-based).series
- the series index (zero-based).
public boolean equals(java.lang.Object obj)
equals
in class AbstractRenderer
obj
- the object.
true
or false
.public int hashCode()
hashCode
in class AbstractRenderer
public DrawingSupplier getDrawingSupplier()
getDrawingSupplier
in class AbstractRenderer
null
).protected void drawItemLabel(java.awt.Graphics2D g2, PlotOrientation orientation, CategoryDataset dataset, int row, int column, double x, double y, boolean negative)
g2
- the graphics device.orientation
- the orientation.dataset
- the dataset.row
- the row.column
- the column.x
- the x coordinate.y
- the y coordinate.negative
- indicates a negative value (which affects the item label position).public java.lang.Object clone() throws java.lang.CloneNotSupportedException
The plot
reference is shallow copied.
clone
in class AbstractRenderer
java.lang.CloneNotSupportedException
- should not happen.protected CategoryAxis getDomainAxis(CategoryPlot plot, java.lang.Integer index)
plot
- the plot.index
- the axis index (null
for the primary axis).
protected ValueAxis getRangeAxis(CategoryPlot plot, java.lang.Integer index)
plot
- the plot.index
- the axis index (null
for the primary axis).
protected CategoryDataset getDataset(CategoryPlot plot, java.lang.Integer index)
plot
- the plot.index
- the dataset index (null
for the primary dataset).
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |