This interface defines the methods that must be provided by all renderers.
If you are implementing a custom renderer, you should consider extending the
AbstractCategoryItemRenderer class.
Most renderer attributes are defined using a "three layer" approach. When
looking up an attribute (for example, the outline paint) the renderer first
checks to see if there is a setting (in layer 0) that applies to ALL items
that the renderer draws. If there is, that setting is used, but if it is
null the renderer looks up the next layer, which contains
"per series" settings for the attribute (many attributes are defined on a
per series basis, so this is the layer that is most commonly used). If the
layer 1 setting is null, the renderer will look up the final
layer, which provides a default or "base" setting. Some attributes allow
the base setting to be null, while other attributes enforce
non-null values.
| Method from org.jfree.chart.renderer.category.CategoryItemRenderer Detail: |
|---|
 public void addChangeListener(RendererChangeListener listener)
|
public void drawBackground(Graphics2D g2,
CategoryPlot plot,
Rectangle2D dataArea) Draws a background for the data area. |
public void drawDomainGridline(Graphics2D g2,
CategoryPlot plot,
Rectangle2D dataArea,
double value) Draws a grid line against the domain axis. |
public void drawDomainMarker(Graphics2D g2,
CategoryPlot plot,
CategoryAxis axis,
CategoryMarker marker,
Rectangle2D dataArea) Draws a line (or some other marker) to indicate a particular category on
the domain axis. |
public void drawItem(Graphics2D g2,
CategoryItemRendererState state,
Rectangle2D dataArea,
CategoryPlot plot,
CategoryAxis domainAxis,
ValueAxis rangeAxis,
CategoryDataset dataset,
int row,
int column,
int pass) Draws a single data item. |
public void drawOutline(Graphics2D g2,
CategoryPlot plot,
Rectangle2D dataArea) Draws an outline for the data area. |
public void drawRangeGridline(Graphics2D g2,
CategoryPlot plot,
ValueAxis axis,
Rectangle2D dataArea,
double value) Draws a grid line against the range axis. |
public void drawRangeMarker(Graphics2D g2,
CategoryPlot plot,
ValueAxis axis,
Marker marker,
Rectangle2D dataArea) Draws a line (or some other marker) to indicate a particular value on
the range axis. |
public Range findRangeBounds(CategoryDataset dataset) Returns the range of values the renderer requires to display all the
items from the specified dataset. |
public Font getBaseItemLabelFont() Returns the base item label font (this is used when no other font
setting is available). |
public CategoryItemLabelGenerator getBaseItemLabelGenerator() Returns the base item label generator. |
public Paint getBaseItemLabelPaint() Returns the base item label paint. |
public Boolean getBaseItemLabelsVisible() Returns the base setting for item label visibility. A null
result should be interpreted as equivalent to Boolean.FALSE
(this is an error in the API design, the return value should have been
a boolean primitive). |
public CategoryURLGenerator getBaseItemURLGenerator() Returns the base item URL generator. |
public ItemLabelPosition getBaseNegativeItemLabelPosition() Returns the base item label position for negative values. |
public Paint getBaseOutlinePaint() Returns the base outline paint. |
public Stroke getBaseOutlineStroke() Returns the base outline stroke. |
public Paint getBasePaint() |
public ItemLabelPosition getBasePositiveItemLabelPosition() Returns the base positive item label position. |
public boolean getBaseSeriesVisible() Returns the base visibility for all series. |
public boolean getBaseSeriesVisibleInLegend() Returns the base visibility in the legend for all series. |
public Shape getBaseShape() |
public Stroke getBaseStroke() |
public CategoryToolTipGenerator getBaseToolTipGenerator() Returns the base tool tip generator (the "layer 2" generator). |
public Font getItemLabelFont()Deprecated! This - method should no longer be used (as of version 1.0.6).
It is sufficient to rely on #getSeriesItemLabelFont(int) and
#getBaseItemLabelFont() .
Returns the font used for all item labels. This may be
null, in which case the per series font settings will apply. |
public Font getItemLabelFont(int row,
int column) Returns the font for an item label. |
public CategoryItemLabelGenerator getItemLabelGenerator(int series,
int item) Returns the item label generator for the specified data item. |
public Paint getItemLabelPaint()Deprecated! This - method should no longer be used (as of version 1.0.6).
It is sufficient to rely on #getSeriesItemLabelPaint(int)
and #getBaseItemLabelPaint() .
Returns the paint used for all item labels. This may be
null, in which case the per series paint settings will
apply. |
public Paint getItemLabelPaint(int row,
int column) Returns the paint used to draw an item label. |
public Paint getItemOutlinePaint(int row,
int column) Returns the paint used to outline data items as they are drawn. |
public Stroke getItemOutlineStroke(int row,
int column) Returns the stroke used to outline data items.
The default implementation passes control to the
lookupSeriesOutlineStroke method. You can override this method if you
require different behaviour. |
public Paint getItemPaint(int row,
int column) Returns the paint used to fill data items as they are drawn. |
public Shape getItemShape(int row,
int column) Returns a shape used to represent a data item. |
public Stroke getItemStroke(int row,
int column) Returns the stroke used to draw data items. |
public CategoryURLGenerator getItemURLGenerator(int series,
int item) Returns the URL generator for an item. |
public boolean getItemVisible(int series,
int item) Returns a boolean that indicates whether or not the specified item
should be drawn (this is typically used to hide an entire series). |
public LegendItem getLegendItem(int datasetIndex,
int series) Returns a legend item for a series. This method can return
null, in which case the series will have no entry in the
legend. |
public ItemLabelPosition getNegativeItemLabelPosition()Deprecated! This - method should no longer be used (as of version 1.0.6).
It is sufficient to rely on
#getSeriesNegativeItemLabelPosition(int)
and #getBaseNegativeItemLabelPosition() .
Returns the item label position for negative values in ALL series. |
public ItemLabelPosition getNegativeItemLabelPosition(int row,
int column) Returns the item label position for negative values. This method can be
overridden to provide customisation of the item label position for
individual data items. |
public int getPassCount() Returns the number of passes through the dataset required by the
renderer. Usually this will be one, but some renderers may use
a second or third pass to overlay items on top of things that were
drawn in an earlier pass. |
public 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). |
public ItemLabelPosition getPositiveItemLabelPosition()Deprecated! This - method should no longer be used (as of version 1.0.6).
It is sufficient to rely on
#getSeriesPositiveItemLabelPosition(int)
and #getBasePositiveItemLabelPosition() .
Returns the item label position for positive values in ALL series. |
public ItemLabelPosition getPositiveItemLabelPosition(int row,
int column) Returns the item label position for positive values. |
public Font getSeriesItemLabelFont(int series) Returns the font for all the item labels in a series. |
public CategoryItemLabelGenerator getSeriesItemLabelGenerator(int series) Returns the item label generator for a series. |
public Paint getSeriesItemLabelPaint(int series) Returns the paint used to draw the item labels for a series. |
public CategoryURLGenerator getSeriesItemURLGenerator(int series) Returns the item URL generator for a series. |
public ItemLabelPosition getSeriesNegativeItemLabelPosition(int series) Returns the item label position for all negative values in a series. |
public Paint getSeriesOutlinePaint(int series) Returns the paint used to outline an item drawn by the renderer. |
public Stroke getSeriesOutlineStroke(int series) Returns the stroke used to outline the items in a series. |
public Paint getSeriesPaint(int series) Returns the paint used to fill an item drawn by the renderer. |
public ItemLabelPosition getSeriesPositiveItemLabelPosition(int series) Returns the item label position for all positive values in a series. |
public Shape getSeriesShape(int series) Returns a shape used to represent the items in a series. |
public Stroke getSeriesStroke(int series) Returns the stroke used to draw the items in a series. |
public CategoryToolTipGenerator getSeriesToolTipGenerator(int series) Returns the tool tip generator for the specified series (a "layer 1"
generator). |
public Boolean getSeriesVisible()Deprecated! This - method should no longer be used (as of version 1.0.6).
It is sufficient to rely on #getSeriesVisible(int) and
#getBaseSeriesVisible() .
Returns the flag that controls the visibility of ALL series. This flag
overrides the per series and default settings - you must set it to
null if you want the other settings to apply. |
public Boolean getSeriesVisible(int series) Returns the flag that controls whether a series is visible. |
public Boolean getSeriesVisibleInLegend()Deprecated! This - method should no longer be used (as of version 1.0.6).
It is sufficient to rely on #getSeriesVisibleInLegend(int)
and #getBaseSeriesVisibleInLegend() .
Returns the flag that controls the visibility of ALL series in the
legend. This flag overrides the per series and default settings - you
must set it to null if you want the other settings to
apply. |
public Boolean getSeriesVisibleInLegend(int series) Returns the flag that controls whether a series is visible in the
legend. This method returns only the "per series" settings - to
incorporate the override and base settings as well, you need to use the
#isSeriesVisibleInLegend(int) method. |
public 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() .
Returns the tool tip generator that will be used for ALL items in the
dataset (the "layer 0" generator). |
public CategoryToolTipGenerator getToolTipGenerator(int row,
int column) Returns the tool tip generator that should be used for the specified
item. This method looks up the generator using the "three-layer"
approach outlined in the general description of this interface. |
public CategoryItemRendererState initialise(Graphics2D g2,
Rectangle2D dataArea,
CategoryPlot plot,
int rendererIndex,
PlotRenderingInfo info) Initialises the renderer. This method will be called before the first
item is rendered, giving the renderer an opportunity to initialise any
state information it wants to maintain. The renderer can do nothing if
it chooses. |
public boolean isItemLabelVisible(int row,
int column) Returns true if an item label is visible, and
false otherwise. |
public boolean isSeriesItemLabelsVisible(int series) Returns true if the item labels for a series are visible,
and false otherwise. |
public boolean isSeriesVisible(int series) Returns a boolean that indicates whether or not the specified series
should be drawn (this is typically used to hide an entire series). |
public boolean isSeriesVisibleInLegend(int series) Returns true if the series should be shown in the legend,
and false otherwise. |
public void removeChangeListener(RendererChangeListener listener) Removes a change listener. |
public void setBaseItemLabelFont(Font font) |
public void setBaseItemLabelGenerator(CategoryItemLabelGenerator generator) Sets the base item label generator and sends a
RendererChangeEvent to all registered listeners. |
public void setBaseItemLabelPaint(Paint paint) |
public void setBaseItemLabelsVisible(boolean visible) Sets the base flag that controls whether or not item labels are visible
and sends a RendererChangeEvent to all registered listeners. |
public void setBaseItemLabelsVisible(Boolean visible) Sets the base setting for item label visibility and sends a
RendererChangeEvent to all registered listeners. |
public void setBaseItemLabelsVisible(Boolean visible,
boolean notify) Sets the base visibility for item labels and, if requested, sends a
RendererChangeEvent to all registered listeners. |
public void setBaseItemURLGenerator(CategoryURLGenerator generator) |
public void setBaseNegativeItemLabelPosition(ItemLabelPosition position) Sets the base item label position for negative values and sends a
RendererChangeEvent to all registered listeners. |
public void setBaseNegativeItemLabelPosition(ItemLabelPosition position,
boolean notify) Sets the base negative item label position and, if requested, sends a
RendererChangeEvent to all registered listeners. |
public void setBaseOutlinePaint(Paint paint) |
public void setBaseOutlineStroke(Stroke stroke) |
public void setBasePaint(Paint paint) |
public void setBasePositiveItemLabelPosition(ItemLabelPosition position) Sets the base positive item label position. |
public void setBasePositiveItemLabelPosition(ItemLabelPosition position,
boolean notify) Sets the base positive item label position and, if requested, sends a
RendererChangeEvent to all registered listeners. |
public void setBaseSeriesVisible(boolean visible) |
public void setBaseSeriesVisible(boolean visible,
boolean notify) Sets the base visibility and, if requested, sends
a RendererChangeEvent to all registered listeners. |
public void setBaseSeriesVisibleInLegend(boolean visible) Sets the base visibility in the legend and sends a
RendererChangeEvent to all registered listeners. |
public void setBaseSeriesVisibleInLegend(boolean visible,
boolean notify) Sets the base visibility in the legend and, if requested, sends
a RendererChangeEvent to all registered listeners. |
public void setBaseShape(Shape shape) |
public void setBaseStroke(Stroke stroke) |
public void setBaseToolTipGenerator(CategoryToolTipGenerator generator) |
public void setItemLabelFont(Font font)Deprecated! This - method should no longer be used (as of version 1.0.6).
It is sufficient to rely on #setSeriesItemLabelFont(int,
Font) and #setBaseItemLabelFont(Font) .
Sets the item label font for ALL series and sends a
RendererChangeEvent to all registered listeners. You can set
this to null if you prefer to set the font on a per series
basis. |
public 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) .
Sets the item label generator for ALL series and sends a
RendererChangeEvent to all registered listeners. This overrides
the per-series settings. |
public void setItemLabelPaint(Paint paint)Deprecated! This - method should no longer be used (as of version 1.0.6).
It is sufficient to rely on #setSeriesItemLabelPaint(int,
Paint) and #setBaseItemLabelPaint(Paint) .
Sets the item label paint for ALL series and sends a
RendererChangeEvent to all registered listeners. |
public void setItemLabelsVisible(boolean visible)Deprecated! This - method should no longer be used (as of version 1.0.6).
It is sufficient to rely on #setSeriesItemLabelsVisible(int,
Boolean) and #setBaseItemLabelsVisible(boolean) .
Sets a flag that controls whether or not the item labels for ALL series
are visible. |
public void setItemLabelsVisible(Boolean visible)Deprecated! This - method should no longer be used (as of version 1.0.6).
It is sufficient to rely on #setSeriesItemLabelsVisible(int,
Boolean) and #setBaseItemLabelsVisible(boolean) .
Sets a flag that controls whether or not the item labels for ALL series
are visible. |
public void setItemLabelsVisible(Boolean visible,
boolean notify)Deprecated! This - method should no longer be used (as of version 1.0.6).
It is sufficient to rely on #setSeriesItemLabelsVisible(int,
Boolean, boolean) and #setBaseItemLabelsVisible(Boolean,
boolean) .
Sets the visibility of item labels for ALL series and, if requested,
sends a RendererChangeEvent to all registered listeners. |
public 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) .
Sets the item URL generator for ALL series. |
public void setNegativeItemLabelPosition(ItemLabelPosition position)Deprecated! This - method should no longer be used (as of version 1.0.6).
It is sufficient to rely on
#setSeriesNegativeItemLabelPosition(int, ItemLabelPosition)
and #setBaseNegativeItemLabelPosition(ItemLabelPosition) .
Sets the item label position for negative values in ALL series, and
sends a RendererChangeEvent to all registered listeners. You
need to set this to null to expose the settings for
individual series. |
public void setNegativeItemLabelPosition(ItemLabelPosition position,
boolean notify)Deprecated! This - method should no longer be used (as of version 1.0.6).
It is sufficient to rely on
#setSeriesNegativeItemLabelPosition(int, ItemLabelPosition,
boolean) and #setBaseNegativeItemLabelPosition(
ItemLabelPosition, boolean) .
Sets the item label position for negative values in ALL series and (if
requested) sends a RendererChangeEvent to all registered
listeners. |
public void setOutlinePaint(Paint paint)Deprecated! This - method should no longer be used (as of version 1.0.6).
It is sufficient to rely on #setSeriesOutlinePaint(int,
Paint) and #setBaseOutlinePaint(Paint) .
Sets the outline paint for ALL series (optional). |
public void setOutlineStroke(Stroke stroke)Deprecated! This - method should no longer be used (as of version 1.0.6).
It is sufficient to rely on #setSeriesOutlineStroke(int,
Stroke) and #setBaseOutlineStroke(Stroke) .
Sets the outline stroke for ALL series and sends a
RendererChangeEvent to all registered listeners. |
public void setPaint(Paint paint)Deprecated! This - method should no longer be used (as of version 1.0.6).
It is sufficient to rely on #setSeriesPaint(int, Paint) and
#setBasePaint(Paint) .
Sets the paint to be used for ALL series, and sends a
RendererChangeEvent to all registered listeners. If this is
null, the renderer will use the paint for the series. |
public void setPlot(CategoryPlot plot) Sets the plot that the renderer has been assigned to. This method is
usually called by the CategoryPlot , in normal usage you
shouldn't need to call this method directly. |
public void setPositiveItemLabelPosition(ItemLabelPosition position)Deprecated! This - method should no longer be used (as of version 1.0.6).
It is sufficient to rely on
#setSeriesPositiveItemLabelPosition(int, ItemLabelPosition)
and #setBasePositiveItemLabelPosition(ItemLabelPosition) .
Sets the item label position for positive values in ALL series, and
sends a RendererChangeEvent to all registered listeners. You
need to set this to null to expose the settings for
individual series. |
public void setPositiveItemLabelPosition(ItemLabelPosition position,
boolean notify)Deprecated! This - method should no longer be used (as of version 1.0.6).
It is sufficient to rely on
#setSeriesPositiveItemLabelPosition(int, ItemLabelPosition,
boolean) and #setBasePositiveItemLabelPosition(
ItemLabelPosition, boolean) .
Sets the positive item label position for ALL series and (if requested)
sends a RendererChangeEvent to all registered listeners. |
public void setSeriesItemLabelFont(int series,
Font font) Sets the item label font for a series and sends a
RendererChangeEvent to all registered listeners. |
public void setSeriesItemLabelGenerator(int series,
CategoryItemLabelGenerator generator) Sets the item label generator for a series and sends a
RendererChangeEvent to all registered listeners. |
public void setSeriesItemLabelPaint(int series,
Paint paint) Sets the item label paint for a series and sends a
RendererChangeEvent to all registered listeners. |
public void setSeriesItemLabelsVisible(int series,
boolean visible) Sets a flag that controls the visibility of the item labels for a series. |
public void setSeriesItemLabelsVisible(int series,
Boolean visible) Sets a flag that controls the visibility of the item labels for a series. |
public void setSeriesItemLabelsVisible(int series,
Boolean visible,
boolean notify) Sets the visibility of item labels for a series and, if requested, sends
a RendererChangeEvent to all registered listeners. |
public void setSeriesItemURLGenerator(int series,
CategoryURLGenerator generator) Sets the item URL generator for a series. |
public void setSeriesNegativeItemLabelPosition(int series,
ItemLabelPosition position) Sets the item label position for negative values in a series and sends a
RendererChangeEvent to all registered listeners. |
public void setSeriesNegativeItemLabelPosition(int series,
ItemLabelPosition position,
boolean notify) Sets the item label position for negative values in a series and (if
requested) sends a RendererChangeEvent to all registered
listeners. |
public void setSeriesOutlinePaint(int series,
Paint paint) Sets the paint used for a series outline and sends a
RendererChangeEvent to all registered listeners. |
public void setSeriesOutlineStroke(int series,
Stroke stroke) Sets the outline stroke used for a series and sends a
RendererChangeEvent to all registered listeners. |
public void setSeriesPaint(int series,
Paint paint) |
public void setSeriesPositiveItemLabelPosition(int series,
ItemLabelPosition position) Sets the item label position for all positive values in a series and
sends a RendererChangeEvent to all registered listeners. |
public void setSeriesPositiveItemLabelPosition(int series,
ItemLabelPosition position,
boolean notify) Sets the item label position for all positive values in a series and (if
requested) sends a RendererChangeEvent to all registered
listeners. |
public void setSeriesShape(int series,
Shape shape) |
public void setSeriesStroke(int series,
Stroke stroke) |
public void setSeriesToolTipGenerator(int series,
CategoryToolTipGenerator generator) |
public void setSeriesVisible(Boolean visible)Deprecated! This - method should no longer be used (as of version 1.0.6).
It is sufficient to rely on #setSeriesVisible(int, Boolean)
and #setBaseSeriesVisible(boolean) .
Sets the flag that controls the visibility of ALL series and sends a
RendererChangeEvent to all registered listeners. This flag
overrides the per series and default settings - you must set it to
null if you want the other settings to apply. |
public void setSeriesVisible(Boolean visible,
boolean notify)Deprecated! This - method should no longer be used (as of version 1.0.6).
It is sufficient to rely on #setSeriesVisible(int, Boolean,
boolean) and #setBaseSeriesVisible(boolean, boolean) .
Sets the flag that controls the visibility of ALL series and sends a
RendererChangeEvent to all registered listeners. This flag
overrides the per series and default settings - you must set it to
null if you want the other settings to apply. |
public void setSeriesVisible(int series,
Boolean visible) Sets the flag that controls whether a series is visible and sends a
RendererChangeEvent to all registered listeners. |
public void setSeriesVisible(int series,
Boolean visible,
boolean notify) Sets the flag that controls whether a series is visible and, if
requested, sends a RendererChangeEvent to all registered
listeners. |
public void setSeriesVisibleInLegend(Boolean visible)Deprecated! This - method should no longer be used (as of version 1.0.6).
It is sufficient to rely on #setSeriesVisibleInLegend(int,
Boolean) and #setBaseSeriesVisibleInLegend(boolean) .
Sets the flag that controls the visibility of ALL series in the legend
and sends a RendererChangeEvent to all registered listeners.
This flag overrides the per series and default settings - you must set
it to null if you want the other settings to apply. |
public void setSeriesVisibleInLegend(Boolean visible,
boolean notify)Deprecated! This - method should no longer be used (as of version 1.0.6).
It is sufficient to rely on #setSeriesVisibleInLegend(int,
Boolean, boolean) and #setBaseSeriesVisibleInLegend(boolean,
boolean) .
Sets the flag that controls the visibility of ALL series in the legend
and sends a RendererChangeEvent to all registered listeners.
This flag overrides the per series and default settings - you must set
it to null if you want the other settings to apply. |
public void setSeriesVisibleInLegend(int series,
Boolean visible) Sets the flag that controls whether a series is visible in the legend
and sends a RendererChangeEvent to all registered listeners. |
public void setSeriesVisibleInLegend(int series,
Boolean visible,
boolean notify) Sets the flag that controls whether a series is visible in the legend
and, if requested, sends a RendererChangeEvent to all registered
listeners. |
public void setShape(Shape shape)Deprecated! This - method should no longer be used (as of version 1.0.6).
It is sufficient to rely on #setSeriesShape(int, Shape) and
#setBaseShape(Shape) .
Sets the shape for ALL series (optional) and sends a
RendererChangeEvent to all registered listeners. |
public void setStroke(Stroke stroke)Deprecated! This - method should no longer be used (as of version 1.0.6).
It is sufficient to rely on #setSeriesStroke(int, Stroke)
and #setBaseStroke(Stroke) .
|
public 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) .
|
Save This Page