public interface CategoryItemRenderer extends LegendItemSource
CategoryPlot
class to display
individual data items from a CategoryDataset
.
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.
Modifier and Type | Method and Description |
---|---|
void |
addChangeListener(RendererChangeListener listener)
Adds a change listener.
|
void |
drawBackground(Graphics2D g2,
CategoryPlot plot,
Rectangle2D dataArea)
Draws a background for the data area.
|
void |
drawDomainGridline(Graphics2D g2,
CategoryPlot plot,
Rectangle2D dataArea,
double value)
Draws a grid line against the domain axis.
|
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.
|
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.
|
void |
drawOutline(Graphics2D g2,
CategoryPlot plot,
Rectangle2D dataArea)
Draws an outline for the data area.
|
void |
drawRangeGridline(Graphics2D g2,
CategoryPlot plot,
ValueAxis axis,
Rectangle2D dataArea,
double value)
Draws a grid line against the range axis.
|
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.
|
Range |
findRangeBounds(CategoryDataset dataset)
Returns the range of values the renderer requires to display all the
items from the specified dataset.
|
Font |
getBaseItemLabelFont()
Returns the base item label font (this is used when no other font
setting is available).
|
CategoryItemLabelGenerator |
getBaseItemLabelGenerator()
Returns the base item label generator.
|
Paint |
getBaseItemLabelPaint()
Returns the base item label paint.
|
Boolean |
getBaseItemLabelsVisible()
Returns the base setting for item label visibility.
|
CategoryURLGenerator |
getBaseItemURLGenerator()
Returns the base item URL generator.
|
ItemLabelPosition |
getBaseNegativeItemLabelPosition()
Returns the base item label position for negative values.
|
Paint |
getBaseOutlinePaint()
Returns the base outline paint.
|
Stroke |
getBaseOutlineStroke()
Returns the base outline stroke.
|
Paint |
getBasePaint()
Returns the base paint.
|
ItemLabelPosition |
getBasePositiveItemLabelPosition()
Returns the base positive item label position.
|
boolean |
getBaseSeriesVisible()
Returns the base visibility for all series.
|
boolean |
getBaseSeriesVisibleInLegend()
Returns the base visibility in the legend for all series.
|
Shape |
getBaseShape()
Returns the base shape.
|
Stroke |
getBaseStroke()
Returns the base stroke.
|
CategoryToolTipGenerator |
getBaseToolTipGenerator()
Returns the base tool tip generator (the "layer 2" generator).
|
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() . |
Font |
getItemLabelFont(int row,
int column)
Returns the font for an item label.
|
CategoryItemLabelGenerator |
getItemLabelGenerator(int series,
int item)
Returns the item label generator for the specified data item.
|
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() . |
Paint |
getItemLabelPaint(int row,
int column)
Returns the paint used to draw an item label.
|
double |
getItemMiddle(Comparable rowKey,
Comparable columnKey,
CategoryDataset dataset,
CategoryAxis axis,
Rectangle2D area,
org.jfree.ui.RectangleEdge edge)
Returns the Java2D coordinate for the middle of the specified data item.
|
Paint |
getItemOutlinePaint(int row,
int column)
Returns the paint used to outline data items as they are drawn.
|
Stroke |
getItemOutlineStroke(int row,
int column)
Returns the stroke used to outline data items.
|
Paint |
getItemPaint(int row,
int column)
Returns the paint used to fill data items as they are drawn.
|
Shape |
getItemShape(int row,
int column)
Returns a shape used to represent a data item.
|
Stroke |
getItemStroke(int row,
int column)
Returns the stroke used to draw data items.
|
CategoryURLGenerator |
getItemURLGenerator(int series,
int item)
Returns the URL generator for an item.
|
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).
|
LegendItem |
getLegendItem(int datasetIndex,
int series)
Returns a legend item for a series.
|
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() . |
ItemLabelPosition |
getNegativeItemLabelPosition(int row,
int column)
Returns the item label position for negative values.
|
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). |
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() . |
ItemLabelPosition |
getPositiveItemLabelPosition(int row,
int column)
Returns the item label position for positive values.
|
Font |
getSeriesItemLabelFont(int series)
Returns the font for all the item labels in a series.
|
CategoryItemLabelGenerator |
getSeriesItemLabelGenerator(int series)
Returns the item label generator for a series.
|
Paint |
getSeriesItemLabelPaint(int series)
Returns the paint used to draw the item labels for a series.
|
CategoryURLGenerator |
getSeriesItemURLGenerator(int series)
Returns the item URL generator for a series.
|
ItemLabelPosition |
getSeriesNegativeItemLabelPosition(int series)
Returns the item label position for all negative values in a series.
|
Paint |
getSeriesOutlinePaint(int series)
Returns the paint used to outline an item drawn by the renderer.
|
Stroke |
getSeriesOutlineStroke(int series)
Returns the stroke used to outline the items in a series.
|
Paint |
getSeriesPaint(int series)
Returns the paint used to fill an item drawn by the renderer.
|
ItemLabelPosition |
getSeriesPositiveItemLabelPosition(int series)
Returns the item label position for all positive values in a series.
|
Shape |
getSeriesShape(int series)
Returns a shape used to represent the items in a series.
|
Stroke |
getSeriesStroke(int series)
Returns the stroke used to draw the items in a series.
|
CategoryToolTipGenerator |
getSeriesToolTipGenerator(int series)
Returns the tool tip generator for the specified series (a "layer 1"
generator).
|
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() . |
Boolean |
getSeriesVisible(int series)
Returns the flag that controls whether a series is visible.
|
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() . |
Boolean |
getSeriesVisibleInLegend(int series)
Returns the flag that controls whether a series is visible in the
legend.
|
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.
|
CategoryItemRendererState |
initialise(Graphics2D g2,
Rectangle2D dataArea,
CategoryPlot plot,
int rendererIndex,
PlotRenderingInfo info)
Initialises the renderer.
|
boolean |
isItemLabelVisible(int row,
int column)
Returns
true if an item label is visible, and
false otherwise. |
boolean |
isSeriesItemLabelsVisible(int series)
Returns
true if the item labels for a series are visible,
and false otherwise. |
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).
|
boolean |
isSeriesVisibleInLegend(int series)
Returns
true if the series should be shown in the legend,
and false otherwise. |
void |
removeChangeListener(RendererChangeListener listener)
Removes a change listener.
|
void |
setBaseItemLabelFont(Font font)
Sets the base item label font and sends a
RendererChangeEvent
to all registered listeners. |
void |
setBaseItemLabelGenerator(CategoryItemLabelGenerator generator)
Sets the base item label generator and sends a
RendererChangeEvent to all registered listeners. |
void |
setBaseItemLabelPaint(Paint paint)
Sets the base item label paint and sends a
RendererChangeEvent
to all registered listeners. |
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. |
void |
setBaseItemLabelsVisible(Boolean visible)
Sets the base setting for item label visibility and sends a
RendererChangeEvent to all registered listeners. |
void |
setBaseItemLabelsVisible(Boolean visible,
boolean notify)
Sets the base visibility for item labels and, if requested, 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 |
setBaseNegativeItemLabelPosition(ItemLabelPosition position)
Sets the base item label position for negative values and sends a
RendererChangeEvent to all registered listeners. |
void |
setBaseNegativeItemLabelPosition(ItemLabelPosition position,
boolean notify)
Sets the base negative item label position and, if requested, sends a
RendererChangeEvent to all registered listeners. |
void |
setBaseOutlinePaint(Paint paint)
Sets the base outline paint and sends a
RendererChangeEvent to
all registered listeners. |
void |
setBaseOutlineStroke(Stroke stroke)
Sets the base outline stroke and sends a
RendererChangeEvent to
all registered listeners. |
void |
setBasePaint(Paint paint)
Sets the base paint and sends a
RendererChangeEvent to all
registered listeners. |
void |
setBasePositiveItemLabelPosition(ItemLabelPosition position)
Sets the base positive item label position.
|
void |
setBasePositiveItemLabelPosition(ItemLabelPosition position,
boolean notify)
Sets the base positive item label position and, if requested, sends a
RendererChangeEvent to all registered listeners. |
void |
setBaseSeriesVisible(boolean visible)
Sets the base visibility and sends a
RendererChangeEvent to all
registered listeners. |
void |
setBaseSeriesVisible(boolean visible,
boolean notify)
Sets the base visibility and, if requested, sends
a
RendererChangeEvent to all registered listeners. |
void |
setBaseSeriesVisibleInLegend(boolean visible)
Sets the base visibility in the legend and sends a
RendererChangeEvent to all registered listeners. |
void |
setBaseSeriesVisibleInLegend(boolean visible,
boolean notify)
Sets the base visibility in the legend and, if requested, sends
a
RendererChangeEvent to all registered listeners. |
void |
setBaseShape(Shape shape)
Sets the base shape and sends a
RendererChangeEvent to all
registered listeners. |
void |
setBaseStroke(Stroke stroke)
Sets the base stroke 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 |
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) . |
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 |
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) . |
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) . |
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) . |
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) . |
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 |
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) . |
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) . |
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) . |
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) . |
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) . |
void |
setPlot(CategoryPlot plot)
Sets the plot that the renderer has been assigned to.
|
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) . |
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) . |
void |
setSeriesItemLabelFont(int series,
Font font)
Sets the item label font for a series and sends a
RendererChangeEvent to all registered listeners. |
void |
setSeriesItemLabelGenerator(int series,
CategoryItemLabelGenerator generator)
Sets the item label generator for a series and sends a
RendererChangeEvent to all registered listeners. |
void |
setSeriesItemLabelPaint(int series,
Paint paint)
Sets the item label paint for a series and sends a
RendererChangeEvent to all registered listeners. |
void |
setSeriesItemLabelsVisible(int series,
boolean visible)
Sets a flag that controls the visibility of the item labels for a series.
|
void |
setSeriesItemLabelsVisible(int series,
Boolean visible)
Sets a flag that controls the visibility of the item labels for a series.
|
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. |
void |
setSeriesItemURLGenerator(int series,
CategoryURLGenerator generator)
Sets the item URL generator for a series.
|
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. |
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. |
void |
setSeriesOutlinePaint(int series,
Paint paint)
Sets the paint used for a series outline and sends a
RendererChangeEvent to all registered listeners. |
void |
setSeriesOutlineStroke(int series,
Stroke stroke)
Sets the outline stroke used for a series and sends a
RendererChangeEvent to all registered listeners. |
void |
setSeriesPaint(int series,
Paint paint)
Sets the paint used for a series and sends a
RendererChangeEvent
to all registered listeners. |
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. |
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. |
void |
setSeriesShape(int series,
Shape shape)
Sets the shape used for a series and sends a
RendererChangeEvent
to all registered listeners. |
void |
setSeriesStroke(int series,
Stroke stroke)
Sets the stroke used 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 |
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) . |
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) . |
void |
setSeriesVisible(int series,
Boolean visible)
Sets the flag that controls whether a series is visible and sends a
RendererChangeEvent to all registered listeners. |
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. |
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) . |
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) . |
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. |
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. |
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) . |
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) . |
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) . |
getLegendItems
int getPassCount()
CategoryPlot getPlot()
null
indicates that the renderer is not currently assigned
to a plot).null
).setPlot(CategoryPlot)
void setPlot(CategoryPlot plot)
CategoryPlot
, in normal usage you
shouldn't need to call this method directly.plot
- the plot (null
not permitted).getPlot()
void addChangeListener(RendererChangeListener listener)
listener
- the listener.removeChangeListener(RendererChangeListener)
void removeChangeListener(RendererChangeListener listener)
listener
- the listener.addChangeListener(RendererChangeListener)
Range findRangeBounds(CategoryDataset dataset)
dataset
- the dataset (null
permitted).null
if the dataset is
null
or empty).CategoryItemRendererState initialise(Graphics2D g2, Rectangle2D dataArea, CategoryPlot plot, int rendererIndex, PlotRenderingInfo info)
g2
- the graphics device.dataArea
- the area inside the axes.plot
- the plot.rendererIndex
- the renderer index.info
- collects chart rendering information for return to caller.boolean getItemVisible(int series, int item)
series
- the series index.item
- the item index.boolean isSeriesVisible(int series)
series
- the series index.Boolean getSeriesVisible()
getSeriesVisible(int)
and
getBaseSeriesVisible()
.null
if you want the other settings to apply.null
).setSeriesVisible(Boolean)
void setSeriesVisible(Boolean visible)
setSeriesVisible(int, Boolean)
and setBaseSeriesVisible(boolean)
.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.visible
- the flag (null
permitted).getSeriesVisible()
void setSeriesVisible(Boolean visible, boolean notify)
setSeriesVisible(int, Boolean,
boolean)
and setBaseSeriesVisible(boolean, boolean)
.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.visible
- the flag (null
permitted).notify
- notify listeners?getSeriesVisible()
Boolean getSeriesVisible(int series)
series
- the series index (zero-based).null
).setSeriesVisible(int, Boolean)
void setSeriesVisible(int series, Boolean visible)
RendererChangeEvent
to all registered listeners.series
- the series index (zero-based).visible
- the flag (null
permitted).getSeriesVisible(int)
void setSeriesVisible(int series, Boolean visible, boolean notify)
RendererChangeEvent
to all registered
listeners.series
- the series index.visible
- the flag (null
permitted).notify
- notify listeners?getSeriesVisible(int)
boolean getBaseSeriesVisible()
setBaseSeriesVisible(boolean)
void setBaseSeriesVisible(boolean visible)
RendererChangeEvent
to all
registered listeners.visible
- the flag.getBaseSeriesVisible()
void setBaseSeriesVisible(boolean visible, boolean notify)
RendererChangeEvent
to all registered listeners.visible
- the visibility.notify
- notify listeners?getBaseSeriesVisible()
boolean isSeriesVisibleInLegend(int series)
true
if the series should be shown in the legend,
and false
otherwise.series
- the series index.Boolean getSeriesVisibleInLegend()
getSeriesVisibleInLegend(int)
and getBaseSeriesVisibleInLegend()
.null
if you want the other settings to
apply.null
).setSeriesVisibleInLegend(Boolean)
void setSeriesVisibleInLegend(Boolean visible)
setSeriesVisibleInLegend(int,
Boolean)
and setBaseSeriesVisibleInLegend(boolean)
.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.visible
- the flag (null
permitted).getSeriesVisibleInLegend()
void setSeriesVisibleInLegend(Boolean visible, boolean notify)
setSeriesVisibleInLegend(int,
Boolean, boolean)
and setBaseSeriesVisibleInLegend(boolean,
boolean)
.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.visible
- the flag (null
permitted).notify
- notify listeners?getSeriesVisibleInLegend()
Boolean getSeriesVisibleInLegend(int series)
isSeriesVisibleInLegend(int)
method.series
- the series index (zero-based).null
).setSeriesVisibleInLegend(int, Boolean)
void setSeriesVisibleInLegend(int series, Boolean visible)
RendererChangeEvent
to all registered listeners.series
- the series index (zero-based).visible
- the flag (null
permitted).getSeriesVisibleInLegend(int)
void setSeriesVisibleInLegend(int series, Boolean visible, boolean notify)
RendererChangeEvent
to all registered
listeners.series
- the series index.visible
- the flag (null
permitted).notify
- notify listeners?getSeriesVisibleInLegend(int)
boolean getBaseSeriesVisibleInLegend()
setBaseSeriesVisibleInLegend(boolean)
void setBaseSeriesVisibleInLegend(boolean visible)
RendererChangeEvent
to all registered listeners.visible
- the flag.getBaseSeriesVisibleInLegend()
void setBaseSeriesVisibleInLegend(boolean visible, boolean notify)
RendererChangeEvent
to all registered listeners.visible
- the visibility.notify
- notify listeners?getBaseSeriesVisibleInLegend()
Paint getItemPaint(int row, int column)
row
- the row (or series) index (zero-based).column
- the column (or category) index (zero-based).null
).void setPaint(Paint paint)
setSeriesPaint(int, Paint)
and
setBasePaint(Paint)
.RendererChangeEvent
to all registered listeners. If this is
null
, the renderer will use the paint for the series.paint
- the paint (null
permitted).Paint getSeriesPaint(int series)
series
- the series index (zero-based).null
).setSeriesPaint(int, Paint)
void setSeriesPaint(int series, Paint paint)
RendererChangeEvent
to all registered listeners.series
- the series index (zero-based).paint
- the paint (null
permitted).getSeriesPaint(int)
Paint getBasePaint()
null
).setBasePaint(Paint)
void setBasePaint(Paint paint)
RendererChangeEvent
to all
registered listeners.paint
- the paint (null
not permitted).getBasePaint()
Paint getItemOutlinePaint(int row, int column)
row
- the row (or series) index (zero-based).column
- the column (or category) index (zero-based).null
).void setOutlinePaint(Paint paint)
setSeriesOutlinePaint(int,
Paint)
and setBaseOutlinePaint(Paint)
.paint
- the paint (null
permitted).Paint getSeriesOutlinePaint(int series)
series
- the series (zero-based index).null
).setSeriesOutlinePaint(int, Paint)
void setSeriesOutlinePaint(int series, Paint paint)
RendererChangeEvent
to all registered listeners.series
- the series index (zero-based).paint
- the paint (null
permitted).getSeriesOutlinePaint(int)
Paint getBaseOutlinePaint()
null
).setBaseOutlinePaint(Paint)
void setBaseOutlinePaint(Paint paint)
RendererChangeEvent
to
all registered listeners.paint
- the paint (null
not permitted).getBaseOutlinePaint()
Stroke getItemStroke(int row, int column)
row
- the row (or series) index (zero-based).column
- the column (or category) index (zero-based).null
).void setStroke(Stroke stroke)
setSeriesStroke(int, Stroke)
and setBaseStroke(Stroke)
.RendererChangeEvent
to all registered listeners.stroke
- the stroke (null
permitted).Stroke getSeriesStroke(int series)
series
- the series (zero-based index).null
).setSeriesStroke(int, Stroke)
void setSeriesStroke(int series, Stroke stroke)
RendererChangeEvent
to all registered listeners.series
- the series index (zero-based).stroke
- the stroke (null
permitted).getSeriesStroke(int)
Stroke getBaseStroke()
null
).setBaseStroke(Stroke)
void setBaseStroke(Stroke stroke)
RendererChangeEvent
to all
registered listeners.stroke
- the stroke (null
not permitted).getBaseStroke()
Stroke getItemOutlineStroke(int row, int column)
The default implementation passes control to the lookupSeriesOutlineStroke method. You can override this method if you require different behaviour.
row
- the row (or series) index (zero-based).column
- the column (or category) index (zero-based).null
).void setOutlineStroke(Stroke stroke)
setSeriesOutlineStroke(int,
Stroke)
and setBaseOutlineStroke(Stroke)
.RendererChangeEvent
to all registered listeners.stroke
- the stroke (null
permitted).Stroke getSeriesOutlineStroke(int series)
series
- the series (zero-based index).null
).setSeriesOutlineStroke(int, Stroke)
void setSeriesOutlineStroke(int series, Stroke stroke)
RendererChangeEvent
to all registered listeners.series
- the series index (zero-based).stroke
- the stroke (null
permitted).getSeriesOutlineStroke(int)
Stroke getBaseOutlineStroke()
null
).setBaseOutlineStroke(Stroke)
void setBaseOutlineStroke(Stroke stroke)
RendererChangeEvent
to
all registered listeners.stroke
- the stroke (null
not permitted).getBaseOutlineStroke()
Shape getItemShape(int row, int column)
row
- the row (or series) index (zero-based).column
- the column (or category) index (zero-based).null
).void setShape(Shape shape)
setSeriesShape(int, Shape)
and
setBaseShape(Shape)
.RendererChangeEvent
to all registered listeners.shape
- the shape (null
permitted).Shape getSeriesShape(int series)
series
- the series (zero-based index).null
).setSeriesShape(int, Shape)
void setSeriesShape(int series, Shape shape)
RendererChangeEvent
to all registered listeners.series
- the series index (zero-based).shape
- the shape (null
permitted).getSeriesShape(int)
Shape getBaseShape()
null
).setBaseShape(Shape)
void setBaseShape(Shape shape)
RendererChangeEvent
to all
registered listeners.shape
- the shape (null
not permitted).getBaseShape()
boolean isItemLabelVisible(int row, int column)
true
if an item label is visible, and
false
otherwise.row
- the row index (zero-based).column
- the column index (zero-based).void setItemLabelsVisible(boolean visible)
setSeriesItemLabelsVisible(int,
Boolean)
and setBaseItemLabelsVisible(boolean)
.visible
- the flag.setItemLabelsVisible(Boolean)
void setItemLabelsVisible(Boolean visible)
setSeriesItemLabelsVisible(int,
Boolean)
and setBaseItemLabelsVisible(boolean)
.visible
- the flag (null
permitted).setItemLabelsVisible(boolean)
void setItemLabelsVisible(Boolean visible, boolean notify)
setSeriesItemLabelsVisible(int,
Boolean, boolean)
and setBaseItemLabelsVisible(Boolean,
boolean)
.RendererChangeEvent
to all registered listeners.visible
- a flag that controls whether or not the item labels are
visible (null
permitted).notify
- a flag that controls whether or not listeners are
notified.boolean isSeriesItemLabelsVisible(int series)
true
if the item labels for a series are visible,
and false
otherwise.series
- the series index (zero-based).setSeriesItemLabelsVisible(int, Boolean)
void setSeriesItemLabelsVisible(int series, boolean visible)
series
- the series index (zero-based).visible
- the flag.isSeriesItemLabelsVisible(int)
void setSeriesItemLabelsVisible(int series, Boolean visible)
series
- the series index (zero-based).visible
- the flag (null
permitted).isSeriesItemLabelsVisible(int)
void setSeriesItemLabelsVisible(int series, Boolean visible, boolean notify)
RendererChangeEvent
to all registered listeners.series
- the series index (zero-based).visible
- the visible flag.notify
- a flag that controls whether or not listeners are
notified.isSeriesItemLabelsVisible(int)
Boolean getBaseItemLabelsVisible()
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).null
).setBaseItemLabelsVisible(Boolean)
void setBaseItemLabelsVisible(boolean visible)
RendererChangeEvent
to all registered listeners.visible
- the flag.getBaseItemLabelsVisible()
void setBaseItemLabelsVisible(Boolean visible)
RendererChangeEvent
to all registered listeners.visible
- the flag (null
permitted).getBaseItemLabelsVisible()
void setBaseItemLabelsVisible(Boolean visible, boolean notify)
RendererChangeEvent
to all registered listeners.visible
- the visibility flag.notify
- a flag that controls whether or not listeners are
notified.getBaseItemLabelsVisible()
CategoryItemLabelGenerator getItemLabelGenerator(int series, int item)
series
- the series index (zero-based).item
- the item index (zero-based).null
).void setItemLabelGenerator(CategoryItemLabelGenerator generator)
setSeriesItemLabelGenerator(int,
CategoryItemLabelGenerator)
and
setBaseItemLabelGenerator(CategoryItemLabelGenerator)
.RendererChangeEvent
to all registered listeners. This overrides
the per-series settings.generator
- the generator (null
permitted).CategoryItemLabelGenerator getSeriesItemLabelGenerator(int series)
series
- the series index (zero-based).null
).setSeriesItemLabelGenerator(int, CategoryItemLabelGenerator)
void setSeriesItemLabelGenerator(int series, CategoryItemLabelGenerator generator)
RendererChangeEvent
to all registered listeners.series
- the series index (zero-based).generator
- the generator.getSeriesItemLabelGenerator(int)
CategoryItemLabelGenerator getBaseItemLabelGenerator()
null
).setBaseItemLabelGenerator(CategoryItemLabelGenerator)
void setBaseItemLabelGenerator(CategoryItemLabelGenerator generator)
RendererChangeEvent
to all registered listeners.generator
- the generator (null
permitted).getBaseItemLabelGenerator()
CategoryToolTipGenerator getToolTipGenerator(int row, int column)
row
- the row index (zero-based).column
- the column index (zero-based).null
).CategoryToolTipGenerator getToolTipGenerator()
getSeriesToolTipGenerator(int)
and getBaseToolTipGenerator()
.null
).setToolTipGenerator(CategoryToolTipGenerator)
void setToolTipGenerator(CategoryToolTipGenerator generator)
setSeriesToolTipGenerator(int,
CategoryToolTipGenerator)
and
setBaseToolTipGenerator(CategoryToolTipGenerator)
.RendererChangeEvent
to all registered
listeners.generator
- the generator (null
permitted).getToolTipGenerator()
CategoryToolTipGenerator getSeriesToolTipGenerator(int series)
series
- the series index (zero-based).null
).setSeriesToolTipGenerator(int, CategoryToolTipGenerator)
void setSeriesToolTipGenerator(int series, CategoryToolTipGenerator generator)
RendererChangeEvent
to all registered
listeners.series
- the series index (zero-based).generator
- the generator (null
permitted).getSeriesToolTipGenerator(int)
CategoryToolTipGenerator getBaseToolTipGenerator()
null
).setBaseToolTipGenerator(CategoryToolTipGenerator)
void setBaseToolTipGenerator(CategoryToolTipGenerator generator)
RendererChangeEvent
to all registered
listeners.generator
- the generator (null
permitted).getBaseToolTipGenerator()
Font getItemLabelFont(int row, int column)
row
- the row index (zero-based).column
- the column index (zero-based).null
).Font getItemLabelFont()
getSeriesItemLabelFont(int)
and
getBaseItemLabelFont()
.null
, in which case the per series font settings will apply.null
).setItemLabelFont(Font)
void setItemLabelFont(Font font)
setSeriesItemLabelFont(int,
Font)
and setBaseItemLabelFont(Font)
.RendererChangeEvent
to all registered listeners. You can set
this to null
if you prefer to set the font on a per series
basis.font
- the font (null
permitted).getItemLabelFont()
Font getSeriesItemLabelFont(int series)
series
- the series index (zero-based).null
).setSeriesItemLabelFont(int, Font)
void setSeriesItemLabelFont(int series, Font font)
RendererChangeEvent
to all registered listeners.series
- the series index (zero-based).font
- the font (null
permitted).getSeriesItemLabelFont(int)
Font getBaseItemLabelFont()
never
null).setBaseItemLabelFont(Font)
void setBaseItemLabelFont(Font font)
RendererChangeEvent
to all registered listeners.font
- the font (null
not permitted).getBaseItemLabelFont()
Paint getItemLabelPaint(int row, int column)
row
- the row index (zero based).column
- the column index (zero based).null
).Paint getItemLabelPaint()
getSeriesItemLabelPaint(int)
and getBaseItemLabelPaint()
.null
, in which case the per series paint settings will
apply.null
).setItemLabelPaint(Paint)
void setItemLabelPaint(Paint paint)
setSeriesItemLabelPaint(int,
Paint)
and setBaseItemLabelPaint(Paint)
.RendererChangeEvent
to all registered listeners.paint
- the paint (null
permitted).getItemLabelPaint()
Paint getSeriesItemLabelPaint(int series)
series
- the series index (zero based).null
).setSeriesItemLabelPaint(int, Paint)
void setSeriesItemLabelPaint(int series, Paint paint)
RendererChangeEvent
to all registered listeners.series
- the series (zero based index).paint
- the paint (null
permitted).getSeriesItemLabelPaint(int)
Paint getBaseItemLabelPaint()
null
).setBaseItemLabelPaint(Paint)
void setBaseItemLabelPaint(Paint paint)
RendererChangeEvent
to all registered listeners.paint
- the paint (null
not permitted).getBaseItemLabelPaint()
ItemLabelPosition getPositiveItemLabelPosition(int row, int column)
row
- the row index (zero-based).column
- the column index (zero-based).null
).ItemLabelPosition getPositiveItemLabelPosition()
getSeriesPositiveItemLabelPosition(int)
and getBasePositiveItemLabelPosition()
.null
).setPositiveItemLabelPosition(ItemLabelPosition)
void setPositiveItemLabelPosition(ItemLabelPosition position)
setSeriesPositiveItemLabelPosition(int, ItemLabelPosition)
and setBasePositiveItemLabelPosition(ItemLabelPosition)
.RendererChangeEvent
to all registered listeners. You
need to set this to null
to expose the settings for
individual series.position
- the position (null
permitted).getPositiveItemLabelPosition()
void setPositiveItemLabelPosition(ItemLabelPosition position, boolean notify)
setSeriesPositiveItemLabelPosition(int, ItemLabelPosition,
boolean)
and setBasePositiveItemLabelPosition(
ItemLabelPosition, boolean)
.RendererChangeEvent
to all registered listeners.position
- the position (null
permitted).notify
- notify registered listeners?getPositiveItemLabelPosition()
ItemLabelPosition getSeriesPositiveItemLabelPosition(int series)
series
- the series index (zero-based).setSeriesPositiveItemLabelPosition(int, ItemLabelPosition)
void setSeriesPositiveItemLabelPosition(int series, ItemLabelPosition position)
RendererChangeEvent
to all registered listeners.series
- the series index (zero-based).position
- the position (null
permitted).getSeriesPositiveItemLabelPosition(int)
void setSeriesPositiveItemLabelPosition(int series, ItemLabelPosition position, boolean notify)
RendererChangeEvent
to all registered
listeners.series
- the series index (zero-based).position
- the position (null
permitted).notify
- notify registered listeners?getSeriesPositiveItemLabelPosition(int)
ItemLabelPosition getBasePositiveItemLabelPosition()
setBasePositiveItemLabelPosition(ItemLabelPosition)
void setBasePositiveItemLabelPosition(ItemLabelPosition position)
position
- the position.getBasePositiveItemLabelPosition()
void setBasePositiveItemLabelPosition(ItemLabelPosition position, boolean notify)
RendererChangeEvent
to all registered listeners.position
- the position.notify
- notify registered listeners?getBasePositiveItemLabelPosition()
ItemLabelPosition getNegativeItemLabelPosition(int row, int column)
row
- the row index (zero-based).column
- the column (zero-based).ItemLabelPosition getNegativeItemLabelPosition()
getSeriesNegativeItemLabelPosition(int)
and getBaseNegativeItemLabelPosition()
.null
).setNegativeItemLabelPosition(ItemLabelPosition)
void setNegativeItemLabelPosition(ItemLabelPosition position)
setSeriesNegativeItemLabelPosition(int, ItemLabelPosition)
and setBaseNegativeItemLabelPosition(ItemLabelPosition)
.RendererChangeEvent
to all registered listeners. You
need to set this to null
to expose the settings for
individual series.position
- the position (null
permitted).getNegativeItemLabelPosition()
void setNegativeItemLabelPosition(ItemLabelPosition position, boolean notify)
setSeriesNegativeItemLabelPosition(int, ItemLabelPosition,
boolean)
and setBaseNegativeItemLabelPosition(
ItemLabelPosition, boolean)
.RendererChangeEvent
to all registered
listeners.position
- the position (null
permitted).notify
- notify registered listeners?getNegativeItemLabelPosition()
ItemLabelPosition getSeriesNegativeItemLabelPosition(int series)
series
- the series index (zero-based).setSeriesNegativeItemLabelPosition(int, ItemLabelPosition)
void setSeriesNegativeItemLabelPosition(int series, ItemLabelPosition position)
RendererChangeEvent
to all registered listeners.series
- the series index (zero-based).position
- the position (null
permitted).getSeriesNegativeItemLabelPosition(int)
void setSeriesNegativeItemLabelPosition(int series, ItemLabelPosition position, boolean notify)
RendererChangeEvent
to all registered
listeners.series
- the series index (zero-based).position
- the position (null
permitted).notify
- notify registered listeners?getSeriesNegativeItemLabelPosition(int)
ItemLabelPosition getBaseNegativeItemLabelPosition()
setBaseNegativeItemLabelPosition(ItemLabelPosition)
void setBaseNegativeItemLabelPosition(ItemLabelPosition position)
RendererChangeEvent
to all registered listeners.position
- the position.getBaseNegativeItemLabelPosition()
void setBaseNegativeItemLabelPosition(ItemLabelPosition position, boolean notify)
RendererChangeEvent
to all registered listeners.position
- the position.notify
- notify registered listeners?getBaseNegativeItemLabelPosition()
CategoryURLGenerator getItemURLGenerator(int series, int item)
series
- the series index (zero-based).item
- the item index (zero-based).void setItemURLGenerator(CategoryURLGenerator generator)
setSeriesItemURLGenerator(int,
CategoryURLGenerator)
and
setBaseItemURLGenerator(CategoryURLGenerator)
.generator
- the generator.getSeriesItemURLGenerator(int)
CategoryURLGenerator getSeriesItemURLGenerator(int series)
series
- the series index (zero-based).setSeriesItemURLGenerator(int, CategoryURLGenerator)
void setSeriesItemURLGenerator(int series, CategoryURLGenerator generator)
series
- the series index (zero-based).generator
- the generator.getSeriesItemURLGenerator(int)
CategoryURLGenerator getBaseItemURLGenerator()
null
).setBaseItemURLGenerator(CategoryURLGenerator)
void setBaseItemURLGenerator(CategoryURLGenerator generator)
RendererChangeEvent
to all registered listeners.generator
- the item URL generator (null
permitted).getBaseItemURLGenerator()
LegendItem getLegendItem(int datasetIndex, int series)
null
, in which case the series will have no entry in the
legend.datasetIndex
- the dataset index (zero-based).series
- the series (zero-based index).null
).void drawBackground(Graphics2D g2, CategoryPlot plot, Rectangle2D dataArea)
g2
- the graphics device.plot
- the plot.dataArea
- the data area.void drawOutline(Graphics2D g2, CategoryPlot plot, Rectangle2D dataArea)
g2
- the graphics device.plot
- the plot.dataArea
- the data area.void drawItem(Graphics2D g2, CategoryItemRendererState state, Rectangle2D dataArea, CategoryPlot plot, CategoryAxis domainAxis, ValueAxis rangeAxis, CategoryDataset dataset, int row, int column, int pass)
g2
- the graphics device.state
- state information for one chart.dataArea
- the data plot area.plot
- the plot.domainAxis
- the domain axis.rangeAxis
- the range axis.dataset
- the data.row
- the row index (zero-based).column
- the column index (zero-based).pass
- the pass index.void drawDomainGridline(Graphics2D g2, CategoryPlot plot, Rectangle2D dataArea, double value)
g2
- the graphics device.plot
- the plot.dataArea
- the area for plotting data (not yet adjusted for any
3D effect).value
- the value.drawRangeGridline(Graphics2D, CategoryPlot, ValueAxis,
Rectangle2D, double)
void drawRangeGridline(Graphics2D g2, CategoryPlot plot, ValueAxis axis, Rectangle2D dataArea, double value)
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.drawDomainGridline(Graphics2D, CategoryPlot, Rectangle2D, double)
void drawDomainMarker(Graphics2D g2, CategoryPlot plot, CategoryAxis axis, CategoryMarker marker, Rectangle2D dataArea)
g2
- the graphics device.plot
- the plot.axis
- the category axis.marker
- the marker.dataArea
- the area for plotting data (not including 3D effect).drawRangeMarker(Graphics2D, CategoryPlot, ValueAxis, Marker,
Rectangle2D)
void drawRangeMarker(Graphics2D g2, CategoryPlot plot, ValueAxis axis, Marker marker, Rectangle2D dataArea)
g2
- the graphics device.plot
- the plot.axis
- the value axis.marker
- the marker.dataArea
- the area for plotting data (not including 3D effect).drawDomainMarker(Graphics2D, CategoryPlot, CategoryAxis,
CategoryMarker, Rectangle2D)
double getItemMiddle(Comparable rowKey, Comparable columnKey, CategoryDataset dataset, CategoryAxis axis, Rectangle2D area, org.jfree.ui.RectangleEdge edge)
rowKey
- the row key.columnKey
- the column key.dataset
- the dataset.axis
- the axis.area
- the data area.edge
- the edge along which the axis lies.Jas4pp 1.5 © Java Analysis Studio for Particle Physics