Interface for rendering the visual representation of a single (x, y) item on
an
.
| Method from org.jfree.chart.renderer.xy.XYItemRenderer Detail: |
public void addAnnotation(XYAnnotation annotation)
Adds an annotation and sends a RendererChangeEvent to all
registered listeners. The annotation is added to the foreground
layer. |
public void addAnnotation(XYAnnotation annotation,
Layer layer)
Adds an annotation to the specified layer. |
public void addChangeListener(RendererChangeListener listener)
Add a renderer change listener. |
public void drawAnnotations(Graphics2D g2,
Rectangle2D dataArea,
ValueAxis domainAxis,
ValueAxis rangeAxis,
Layer layer,
PlotRenderingInfo info)
Draws all the annotations for the specified layer. |
public void drawDomainGridLine(Graphics2D g2,
XYPlot plot,
ValueAxis axis,
Rectangle2D dataArea,
double value)
Draws a grid line against the domain axis. |
public void drawDomainMarker(Graphics2D g2,
XYPlot plot,
ValueAxis axis,
Marker marker,
Rectangle2D dataArea)
Draws the specified marker against the domain axis. |
public void drawItem(Graphics2D g2,
XYItemRendererState state,
Rectangle2D dataArea,
PlotRenderingInfo info,
XYPlot plot,
ValueAxis domainAxis,
ValueAxis rangeAxis,
XYDataset dataset,
int series,
int item,
CrosshairState crosshairState,
int pass)
Called for each item to be plotted.
The XYPlot can make multiple passes through the dataset,
depending on the value returned by the renderer's initialise() method. |
public void drawRangeLine(Graphics2D g2,
XYPlot plot,
ValueAxis axis,
Rectangle2D dataArea,
double value,
Paint paint,
Stroke stroke)
Draws a grid line against the range axis. |
public void drawRangeMarker(Graphics2D g2,
XYPlot plot,
ValueAxis axis,
Marker marker,
Rectangle2D dataArea)
Draws a horizontal line across the chart to represent a 'range marker'. |
public void fillDomainGridBand(Graphics2D g2,
XYPlot plot,
ValueAxis axis,
Rectangle2D dataArea,
double start,
double end)
Fills a band between two values on the axis. This can be used to color
bands between the grid lines. |
public void fillRangeGridBand(Graphics2D g2,
XYPlot plot,
ValueAxis axis,
Rectangle2D dataArea,
double start,
double end)
Fills a band between two values on the range axis. This can be used to
color bands between the grid lines. |
public Range findDomainBounds(XYDataset dataset)
Returns the lower and upper bounds (range) of the x-values in the
specified dataset. |
public Range findRangeBounds(XYDataset dataset)
Returns the lower and upper bounds (range) of the y-values in the
specified dataset. The implementation of this method will take
into account the presentation used by the renderers (for example,
a renderer that "stacks" values will return a bigger range than
a renderer that doesn't. |
public Font getBaseItemLabelFont()
Returns the base item label font (this is used when no other font
setting is available). |
public XYItemLabelGenerator 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. |
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 XYToolTipGenerator getBaseToolTipGenerator()
Returns the base tool tip 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 XYItemLabelGenerator getItemLabelGenerator(int row,
int column)
Returns the item label generator for a 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 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 from a dataset. |
public XYSeriesLabelGenerator getLegendItemLabelGenerator()
Returns the legend item label generator. |
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 data required by the renderer. |
public XYPlot getPlot()
Returns the plot that this renderer has been assigned to. |
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 XYItemLabelGenerator 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 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 XYToolTipGenerator getSeriesToolTipGenerator(int series)
Returns the tool tip generator for a series. |
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 XYToolTipGenerator getToolTipGenerator(int row,
int column)
Returns the tool tip generator for a data item. |
public XYURLGenerator getURLGenerator()
Returns the URL generator for HTML image maps. |
public XYItemRendererState initialise(Graphics2D g2,
Rectangle2D dataArea,
XYPlot plot,
XYDataset dataset,
PlotRenderingInfo info)
Initialises the renderer then returns the number of 'passes' through the
data that the renderer will require (usually just one). 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 boolean removeAnnotation(XYAnnotation annotation)
|
public void removeAnnotations()
|
public void removeChangeListener(RendererChangeListener listener)
Removes a change listener. |
public void setBaseItemLabelFont(Font font)
|
public void setBaseItemLabelGenerator(XYItemLabelGenerator 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. |
public void setBaseItemLabelsVisible(Boolean visible)
Sets the base setting for item label visibility. |
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 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(XYToolTipGenerator 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(XYItemLabelGenerator generator)Deprecated! As - of version 1.0.6, this override setting should not be
used. You can use the base setting instead
(#setBaseItemLabelGenerator(XYItemLabelGenerator) ).
Sets the item label generator for ALL series and sends a
RendererChangeEvent to all registered listeners. |
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 setLegendItemLabelGenerator(XYSeriesLabelGenerator generator)
Sets the legend item label generator. |
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(XYPlot plot)
Sets the plot that this renderer is assigned to. This method will be
called by the plot class...you do not need to call it yourself. |
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,
XYItemLabelGenerator 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 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,
XYToolTipGenerator generator)
Sets the tool tip generator for a series and sends a
RendererChangeEvent to all registered listeners. |
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(XYToolTipGenerator generator)Deprecated! As - of version 1.0.6, this override setting should not be
used. You can use the base setting instead
(#setBaseToolTipGenerator(XYToolTipGenerator) ).
Sets the tool tip generator for ALL series and sends a
RendererChangeEvent to all registered listeners. |
public void setURLGenerator(XYURLGenerator urlGenerator)
Sets the URL generator for HTML image maps. |