Package org.jfree.chart.renderer
Interface XYItemRenderer
- All Known Implementing Classes:
AbstractXYItemRenderer
,AreaXYRenderer
,CandlestickRenderer
,ClusteredXYBarRenderer
,CyclicXYItemRenderer
,DefaultXYItemRenderer
,HighLowRenderer
,SignalRenderer
,StackedAreaXYRenderer
,StackedXYAreaRenderer
,StackedXYAreaRenderer2
,StackedXYBarRenderer
,StandardXYItemRenderer
,WindItemRenderer
,XYAreaRenderer
,XYAreaRenderer2
,XYBarRenderer
,XYBoxAndWhiskerRenderer
,XYBubbleRenderer
,XYDifferenceRenderer
,XYDotRenderer
,XYLineAndShapeRenderer
,XYStepAreaRenderer
,XYStepRenderer
,YIntervalRenderer
public interface XYItemRenderer
-
Method Summary
Modifier and Type Method Description void
addChangeListener(RendererChangeListener listener)
Add a renderer change listener.void
drawDomainGridLine(Graphics2D g2, XYPlot plot, ValueAxis axis, Rectangle2D dataArea, double value)
Draws a grid line against the domain axis.void
drawDomainMarker(Graphics2D g2, XYPlot plot, ValueAxis axis, Marker marker, Rectangle2D dataArea)
Draws a vertical line on the chart to represent a 'range marker'.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.void
drawRangeGridLine(Graphics2D g2, XYPlot plot, ValueAxis axis, Rectangle2D dataArea, double value)
Draws a grid line against the range axis.void
drawRangeMarker(Graphics2D g2, XYPlot plot, ValueAxis axis, Marker marker, Rectangle2D dataArea)
Draws a horizontal line across the chart to represent a 'range marker'.void
fillDomainGridBand(Graphics2D g2, XYPlot plot, ValueAxis axis, Rectangle2D dataArea, double start, double end)
Fills a band between two values on the axis.void
fillRangeGridBand(Graphics2D g2, XYPlot plot, ValueAxis axis, Rectangle2D dataArea, double start, double end)
Fills a band between two values on the range axis.Font
getBaseItemLabelFont()
Returns the base item label font (this is used when no other font setting is available).Paint
getBaseItemLabelPaint()
Returns the base item label paint.Boolean
getBaseItemLabelsVisible()
Returns the base setting for item label visibility.XYLabelGenerator
getBaseLabelGenerator()
Returns the base item label 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.Shape
getBaseShape()
Returns the base shape.Stroke
getBaseStroke()
Returns the base stroke.XYToolTipGenerator
getBaseToolTipGenerator()
Returns the base tool tip generator.Font
getItemLabelFont()
Returns the font used for all item labels.Font
getItemLabelFont(int row, int column)
Returns the font for an item label.Paint
getItemLabelPaint()
Returns the paint used for all item labels.Paint
getItemLabelPaint(int row, int column)
Returns the paint used to draw an item label.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.XYLabelGenerator
getLabelGenerator(int row, int column)
Returns the label generator for a data item.LegendItem
getLegendItem(int datasetIndex, int series)
Returns a legend item for a series from a dataset.ItemLabelPosition
getNegativeItemLabelPosition()
Returns the item label position for negative values in ALL series.ItemLabelPosition
getNegativeItemLabelPosition(int row, int column)
Returns the item label position for negative values.int
getPassCount()
Returns the number of passes through the data required by the renderer.XYPlot
getPlot()
Returns the plot that this renderer has been assigned to.ItemLabelPosition
getPositiveItemLabelPosition()
Returns the item label position for positive values in ALL series.ItemLabelPosition
getPositiveItemLabelPosition(int row, int column)
Returns the item label position for positive values.Range
getRangeExtent(XYDataset dataset)
Returns the range of values the renderer requires to display all the items from the specified dataset.RangeType
getRangeType()
Returns the range type for the renderer.Font
getSeriesItemLabelFont(int series)
Returns the font for all the item labels in a series.Paint
getSeriesItemLabelPaint(int series)
Returns the paint used to draw the item labels for a series.XYLabelGenerator
getSeriesLabelGenerator(int series)
Returns the label 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.XYToolTipGenerator
getSeriesToolTipGenerator(int series)
Returns the tool tip generator for a series.XYToolTipGenerator
getToolTipGenerator(int row, int column)
Returns the tool tip generator for a data item.XYURLGenerator
getURLGenerator()
Returns the URL generator for HTML image maps.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).boolean
isItemLabelVisible(int row, int column)
Returnstrue
if an item label is visible, andfalse
otherwise.boolean
isSeriesItemLabelsVisible(int series)
Returnstrue
if the item labels for a series are visible, andfalse
otherwise.void
removeChangeListener(RendererChangeListener listener)
Removes a change listener.void
setBaseItemLabelFont(Font font)
Sets the base item label font and sends aRendererChangeEvent
to all registered listeners.void
setBaseItemLabelPaint(Paint paint)
Sets the base item label paint and sends aRendererChangeEvent
to all registered listeners.void
setBaseItemLabelsVisible(boolean visible)
Sets the base flag that controls whether or not item labels are visible.void
setBaseItemLabelsVisible(Boolean visible)
Sets the base setting for item label visibility.void
setBaseItemLabelsVisible(Boolean visible, boolean notify)
Sets the base visibility for item labels and, if requested, sends aRendererChangeEvent
to all registered listeners.void
setBaseLabelGenerator(XYLabelGenerator generator)
Sets the base item label generator and sends aRendererChangeEvent
to all registered listeners.void
setBaseNegativeItemLabelPosition(ItemLabelPosition position)
Sets the base item label position for negative values and sends aRendererChangeEvent
to all registered listeners.void
setBaseNegativeItemLabelPosition(ItemLabelPosition position, boolean notify)
Sets the base negative item label position and, if requested, sends aRendererChangeEvent
to all registered listeners.void
setBaseOutlinePaint(Paint paint)
Sets the base outline paint and sends aRendererChangeEvent
to all registered listeners.void
setBaseOutlineStroke(Stroke stroke)
Sets the base outline stroke and sends aRendererChangeEvent
to all registered listeners.void
setBasePaint(Paint paint)
Sets the base paint and sends aRendererChangeEvent
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 aRendererChangeEvent
to all registered listeners.void
setBaseShape(Shape shape)
Sets the base shape and sends aRendererChangeEvent
to all registered listeners.void
setBaseStroke(Stroke stroke)
Sets the base stroke.void
setBaseToolTipGenerator(XYToolTipGenerator generator)
Sets the base tool tip generator and sends aRendererChangeEvent
to all registered listeners.void
setItemLabelFont(Font font)
Sets the item label font for ALL series and sends aRendererChangeEvent
to all registered listeners.void
setItemLabelPaint(Paint paint)
Sets the item label paint for ALL series and sends aRendererChangeEvent
to all registered listeners.void
setItemLabelsVisible(boolean visible)
Sets a flag that controls whether or not the item labels for ALL series are visible.void
setItemLabelsVisible(Boolean visible)
Sets a flag that controls whether or not the item labels for ALL series are visible.void
setItemLabelsVisible(Boolean visible, boolean notify)
Sets the visibility of item labels for ALL series and, if requested, sends aRendererChangeEvent
to all registered listeners.void
setLabelGenerator(XYLabelGenerator generator)
Sets the item label generator for ALL series and sends aRendererChangeEvent
to all registered listeners.void
setNegativeItemLabelPosition(ItemLabelPosition position)
Sets the item label position for negative values in ALL series, and sends aRendererChangeEvent
to all registered listeners.void
setNegativeItemLabelPosition(ItemLabelPosition position, boolean notify)
Sets the item label position for negative values in ALL series and (if requested) sends aRendererChangeEvent
to all registered listeners.void
setOutlinePaint(Paint paint)
Sets the outline paint for ALL series (optional).void
setOutlineStroke(Stroke stroke)
Sets the outline stroke for ALL series and sends aRendererChangeEvent
to all registered listeners.void
setPaint(Paint paint)
Sets the paint to be used for ALL series, and sends aRendererChangeEvent
to all registered listeners.void
setPlot(XYPlot plot)
Sets the plot that this renderer is assigned to.void
setPositiveItemLabelPosition(ItemLabelPosition position)
Sets the item label position for positive values in ALL series, and sends aRendererChangeEvent
to all registered listeners.void
setPositiveItemLabelPosition(ItemLabelPosition position, boolean notify)
Sets the positive item label position for ALL series and (if requested) sends aRendererChangeEvent
to all registered listeners.void
setSeriesItemLabelFont(int series, Font font)
Sets the item label font for a series and sends aRendererChangeEvent
to all registered listeners.void
setSeriesItemLabelPaint(int series, Paint paint)
Sets the item label paint for a series and sends aRendererChangeEvent
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 aRendererChangeEvent
to all registered listeners.void
setSeriesLabelGenerator(int series, XYLabelGenerator generator)
Sets the label generator for a series and sends aRendererChangeEvent
to all registered listeners.void
setSeriesNegativeItemLabelPosition(int series, ItemLabelPosition position)
Sets the item label position for negative values in a series and sends aRendererChangeEvent
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.void
setSeriesOutlinePaint(int series, Paint paint)
Sets the paint used for a series outline and sends aRendererChangeEvent
to all registered listeners.void
setSeriesOutlineStroke(int series, Stroke stroke)
Sets the outline stroke used for a series and sends aRendererChangeEvent
to all registered listeners.void
setSeriesPaint(int series, Paint paint)
Sets the paint used for a series and sends aRendererChangeEvent
to all registered listeners.void
setSeriesPositiveItemLabelPosition(int series, ItemLabelPosition position)
Sets the item label position for all positive values in a series and sends aRendererChangeEvent
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 aRendererChangeEvent
to all registered listeners.void
setSeriesShape(int series, Shape shape)
Sets the shape used for a series and sends aRendererChangeEvent
to all registered listeners.void
setSeriesStroke(int series, Stroke stroke)
Sets the stroke used for a series and sends aRendererChangeEvent
to all registered listeners.void
setSeriesToolTipGenerator(int series, XYToolTipGenerator generator)
Sets the tool tip generator for a series and sends aRendererChangeEvent
to all registered listeners.void
setShape(Shape shape)
Sets the shape for ALL series (optional) and sends aRendererChangeEvent
to all registered listeners.void
setStroke(Stroke stroke)
Sets the stroke for ALL series and sends aRendererChangeEvent
to all registered listeners.void
setToolTipGenerator(XYToolTipGenerator generator)
Sets the tool tip generator for ALL series and sends aRendererChangeEvent
to all registered listeners.void
setURLGenerator(XYURLGenerator urlGenerator)
Sets the URL generator for HTML image maps.
-
Method Details
-
initialise
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.- Parameters:
g2
- the graphics device.dataArea
- the area inside the axes.plot
- the plot.dataset
- the dataset.info
- an optional info collection object to return data back to the caller.- Returns:
- The number of passes the renderer requires.
-
getPassCount
int getPassCount()Returns the number of passes through the data required by the renderer.- Returns:
- The pass count.
-
getItemPaint
Returns the paint used to fill data items as they are drawn.- Parameters:
row
- the row (or series) index (zero-based).column
- the column (or category) index (zero-based).- Returns:
- the paint (never
null
).
-
getSeriesPaint
Returns the paint used to fill an item drawn by the renderer.- Parameters:
series
- the series index (zero-based).- Returns:
- the paint (never
null
).
-
setPaint
Sets the paint to be used for ALL series, and sends aRendererChangeEvent
to all registered listeners. If this isnull
, the renderer will use the paint for the series.- Parameters:
paint
- the paint (null
permitted).
-
setSeriesPaint
Sets the paint used for a series and sends aRendererChangeEvent
to all registered listeners.- Parameters:
series
- the series index (zero-based).paint
- the paint (null
permitted).
-
getBasePaint
Paint getBasePaint()Returns the base paint.- Returns:
- the base paint (never
null
).
-
setBasePaint
Sets the base paint and sends aRendererChangeEvent
to all registered listeners.- Parameters:
paint
- the paint (null
not permitted).
-
getItemOutlinePaint
Returns the paint used to outline data items as they are drawn.- Parameters:
row
- the row (or series) index (zero-based).column
- the column (or category) index (zero-based).- Returns:
- the paint (never
null
).
-
getSeriesOutlinePaint
Returns the paint used to outline an item drawn by the renderer.- Parameters:
series
- the series (zero-based index).- Returns:
- the paint (never
null
).
-
setSeriesOutlinePaint
Sets the paint used for a series outline and sends aRendererChangeEvent
to all registered listeners.- Parameters:
series
- the series index (zero-based).paint
- the paint (null
permitted).
-
setOutlinePaint
Sets the outline paint for ALL series (optional).- Parameters:
paint
- the paint (null
permitted).
-
getBaseOutlinePaint
Paint getBaseOutlinePaint()Returns the base outline paint.- Returns:
- the paint (never
null
).
-
setBaseOutlinePaint
Sets the base outline paint and sends aRendererChangeEvent
to all registered listeners.- Parameters:
paint
- the paint (null
not permitted).
-
getItemStroke
Returns the stroke used to draw data items.- Parameters:
row
- the row (or series) index (zero-based).column
- the column (or category) index (zero-based).- Returns:
- the stroke (never
null
).
-
getSeriesStroke
Returns the stroke used to draw the items in a series.- Parameters:
series
- the series (zero-based index).- Returns:
- the stroke (never
null
).
-
setStroke
Sets the stroke for ALL series and sends aRendererChangeEvent
to all registered listeners.- Parameters:
stroke
- the stroke (null
permitted).
-
setSeriesStroke
Sets the stroke used for a series and sends aRendererChangeEvent
to all registered listeners.- Parameters:
series
- the series index (zero-based).stroke
- the stroke (null
permitted).
-
getBaseStroke
Stroke getBaseStroke()Returns the base stroke.- Returns:
- the base stroke (never
null
).
-
setBaseStroke
Sets the base stroke.- Parameters:
stroke
- the stroke (null
not permitted).
-
getItemOutlineStroke
Returns the stroke used to outline data items.The default implementation passes control to the getSeriesOutlineStroke method. You can override this method if you require different behaviour.
- Parameters:
row
- the row (or series) index (zero-based).column
- the column (or category) index (zero-based).- Returns:
- the stroke (never
null
).
-
getSeriesOutlineStroke
Returns the stroke used to outline the items in a series.- Parameters:
series
- the series (zero-based index).- Returns:
- the stroke (never
null
).
-
setOutlineStroke
Sets the outline stroke for ALL series and sends aRendererChangeEvent
to all registered listeners.- Parameters:
stroke
- the stroke (null
permitted).
-
setSeriesOutlineStroke
Sets the outline stroke used for a series and sends aRendererChangeEvent
to all registered listeners.- Parameters:
series
- the series index (zero-based).stroke
- the stroke (null
permitted).
-
getBaseOutlineStroke
Stroke getBaseOutlineStroke()Returns the base outline stroke.- Returns:
- the stroke (never
null
).
-
setBaseOutlineStroke
Sets the base outline stroke and sends aRendererChangeEvent
to all registered listeners.- Parameters:
stroke
- the stroke (null
not permitted).
-
getItemShape
Returns a shape used to represent a data item.- Parameters:
row
- the row (or series) index (zero-based).column
- the column (or category) index (zero-based).- Returns:
- the shape (never
null
).
-
getSeriesShape
Returns a shape used to represent the items in a series.- Parameters:
series
- the series (zero-based index).- Returns:
- the shape (never
null
).
-
setShape
Sets the shape for ALL series (optional) and sends aRendererChangeEvent
to all registered listeners.- Parameters:
shape
- the shape (null
permitted).
-
setSeriesShape
Sets the shape used for a series and sends aRendererChangeEvent
to all registered listeners.- Parameters:
series
- the series index (zero-based).shape
- the shape (null
permitted).
-
getBaseShape
Shape getBaseShape()Returns the base shape.- Returns:
- the shape (never
null
).
-
setBaseShape
Sets the base shape and sends aRendererChangeEvent
to all registered listeners.- Parameters:
shape
- the shape (null
not permitted).
-
isItemLabelVisible
boolean isItemLabelVisible(int row, int column)Returnstrue
if an item label is visible, andfalse
otherwise.- Parameters:
row
- the row index (zero-based).column
- the column index (zero-based).- Returns:
- a boolean.
-
isSeriesItemLabelsVisible
boolean isSeriesItemLabelsVisible(int series)Returnstrue
if the item labels for a series are visible, andfalse
otherwise.- Parameters:
series
- the series index (zero-based).- Returns:
- a boolean.
-
setItemLabelsVisible
void setItemLabelsVisible(boolean visible)Sets a flag that controls whether or not the item labels for ALL series are visible.- Parameters:
visible
- the flag.
-
setItemLabelsVisible
Sets a flag that controls whether or not the item labels for ALL series are visible.- Parameters:
visible
- the flag (null
permitted).
-
setItemLabelsVisible
Sets the visibility of item labels for ALL series and, if requested, sends aRendererChangeEvent
to all registered listeners.- Parameters:
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.
-
setSeriesItemLabelsVisible
void setSeriesItemLabelsVisible(int series, boolean visible)Sets a flag that controls the visibility of the item labels for a series.- Parameters:
series
- the series index (zero-based).visible
- the flag.
-
setSeriesItemLabelsVisible
Sets a flag that controls the visibility of the item labels for a series.- Parameters:
series
- the series index (zero-based).visible
- the flag (null
permitted).
-
setSeriesItemLabelsVisible
Sets the visibility of item labels for a series and, if requested, sends aRendererChangeEvent
to all registered listeners.- Parameters:
series
- the series index (zero-based).visible
- the visible flag.notify
- a flag that controls whether or not listeners are notified.
-
getBaseItemLabelsVisible
Boolean getBaseItemLabelsVisible()Returns the base setting for item label visibility.- Returns:
- A flag (possibly
null
).
-
setBaseItemLabelsVisible
void setBaseItemLabelsVisible(boolean visible)Sets the base flag that controls whether or not item labels are visible.- Parameters:
visible
- the flag.
-
setBaseItemLabelsVisible
Sets the base setting for item label visibility.- Parameters:
visible
- the flag (null
permitted).
-
setBaseItemLabelsVisible
Sets the base visibility for item labels and, if requested, sends aRendererChangeEvent
to all registered listeners.- Parameters:
visible
- the visibility flag.notify
- a flag that controls whether or not listeners are notified.
-
getLabelGenerator
Returns the label generator for a data item.- Parameters:
row
- the row index (zero based).column
- the column index (zero based).- Returns:
- the generator (possibly
null
).
-
getSeriesLabelGenerator
Returns the label generator for a series.- Parameters:
series
- the series index (zero based).- Returns:
- the generator (possibly
null
).
-
setLabelGenerator
Sets the item label generator for ALL series and sends aRendererChangeEvent
to all registered listeners.- Parameters:
generator
- the generator (null
permitted).
-
setSeriesLabelGenerator
Sets the label generator for a series and sends aRendererChangeEvent
to all registered listeners.- Parameters:
series
- the series index (zero based).generator
- the generator (null
permitted).
-
getBaseLabelGenerator
XYLabelGenerator getBaseLabelGenerator()Returns the base item label generator.- Returns:
- the generator (possibly
null
).
-
setBaseLabelGenerator
Sets the base item label generator and sends aRendererChangeEvent
to all registered listeners.- Parameters:
generator
- the generator (null
permitted).
-
getToolTipGenerator
Returns the tool tip generator for a data item.- Parameters:
row
- the row index (zero based).column
- the column index (zero based).- Returns:
- The generator (possibly
null
).
-
getSeriesToolTipGenerator
Returns the tool tip generator for a series.- Parameters:
series
- the series index (zero based).- Returns:
- The generator (possibly
null
).
-
setToolTipGenerator
Sets the tool tip generator for ALL series and sends aRendererChangeEvent
to all registered listeners.- Parameters:
generator
- the generator (null
permitted).
-
setSeriesToolTipGenerator
Sets the tool tip generator for a series and sends aRendererChangeEvent
to all registered listeners.- Parameters:
series
- the series index (zero based).generator
- the generator (null
permitted).
-
getBaseToolTipGenerator
XYToolTipGenerator getBaseToolTipGenerator()Returns the base tool tip generator.- Returns:
- the generator (possibly
null
).
-
setBaseToolTipGenerator
Sets the base tool tip generator and sends aRendererChangeEvent
to all registered listeners.- Parameters:
generator
- the generator (null
permitted).
-
getURLGenerator
XYURLGenerator getURLGenerator()Returns the URL generator for HTML image maps.- Returns:
- the URL generator (possibly null).
-
setURLGenerator
Sets the URL generator for HTML image maps.- Parameters:
urlGenerator
- the URL generator (null permitted).
-
getItemLabelFont
Returns the font for an item label.- Parameters:
row
- the row index (zero-based).column
- the column index (zero-based).- Returns:
- The font (never
null
).
-
getItemLabelFont
Font getItemLabelFont()Returns the font used for all item labels. This may benull
, in which case the per series font settings will apply.- Returns:
- The font (possibly
null
).
-
setItemLabelFont
Sets the item label font for ALL series and sends aRendererChangeEvent
to all registered listeners. You can set this tonull
if you prefer to set the font on a per series basis.- Parameters:
font
- the font (null
permitted).
-
getSeriesItemLabelFont
Returns the font for all the item labels in a series.- Parameters:
series
- the series index (zero-based).- Returns:
- The font (possibly
null
).
-
setSeriesItemLabelFont
Sets the item label font for a series and sends aRendererChangeEvent
to all registered listeners.- Parameters:
series
- the series index (zero-based).font
- the font (null
permitted).
-
getBaseItemLabelFont
Font getBaseItemLabelFont()Returns the base item label font (this is used when no other font setting is available).- Returns:
- The font (
never
null).
-
setBaseItemLabelFont
Sets the base item label font and sends aRendererChangeEvent
to all registered listeners.- Parameters:
font
- the font (null
not permitted).
-
getItemLabelPaint
Returns the paint used to draw an item label.- Parameters:
row
- the row index (zero based).column
- the column index (zero based).- Returns:
- The paint (never
null
).
-
getItemLabelPaint
Paint getItemLabelPaint()Returns the paint used for all item labels. This may benull
, in which case the per series paint settings will apply.- Returns:
- The paint (possibly
null
).
-
setItemLabelPaint
Sets the item label paint for ALL series and sends aRendererChangeEvent
to all registered listeners.- Parameters:
paint
- the paint (null
permitted).
-
getSeriesItemLabelPaint
Returns the paint used to draw the item labels for a series.- Parameters:
series
- the series index (zero based).- Returns:
- The paint (possibly
null
).
-
setSeriesItemLabelPaint
Sets the item label paint for a series and sends aRendererChangeEvent
to all registered listeners.- Parameters:
series
- the series (zero based index).paint
- the paint (null
permitted).
-
getBaseItemLabelPaint
Paint getBaseItemLabelPaint()Returns the base item label paint.- Returns:
- The paint (never
null
).
-
setBaseItemLabelPaint
Sets the base item label paint and sends aRendererChangeEvent
to all registered listeners.- Parameters:
paint
- the paint (null
not permitted).
-
getPositiveItemLabelPosition
Returns the item label position for positive values.- Parameters:
row
- the row index (zero-based).column
- the column index (zero-based).- Returns:
- the item label position (never
null
).
-
getPositiveItemLabelPosition
ItemLabelPosition getPositiveItemLabelPosition()Returns the item label position for positive values in ALL series.- Returns:
- the item label position (possibly
null
).
-
setPositiveItemLabelPosition
Sets the item label position for positive values in ALL series, and sends aRendererChangeEvent
to all registered listeners. You need to set this tonull
to expose the settings for individual series.- Parameters:
position
- the position (null
permitted).
-
setPositiveItemLabelPosition
Sets the positive item label position for ALL series and (if requested) sends aRendererChangeEvent
to all registered listeners.- Parameters:
position
- the position (null
permitted).notify
- notify registered listeners?
-
getSeriesPositiveItemLabelPosition
Returns the item label position for all positive values in a series.- Parameters:
series
- the series index (zero-based).- Returns:
- the item label position (never
null
).
-
setSeriesPositiveItemLabelPosition
Sets the item label position for all positive values in a series and sends aRendererChangeEvent
to all registered listeners.- Parameters:
series
- the series index (zero-based).position
- the position (null
permitted).
-
setSeriesPositiveItemLabelPosition
Sets the item label position for all positive values in a series and (if requested) sends aRendererChangeEvent
to all registered listeners.- Parameters:
series
- the series index (zero-based).position
- the position (null
permitted).notify
- notify registered listeners?
-
getBasePositiveItemLabelPosition
ItemLabelPosition getBasePositiveItemLabelPosition()Returns the base positive item label position.- Returns:
- the position (never
null
).
-
setBasePositiveItemLabelPosition
Sets the base positive item label position.- Parameters:
position
- the position (null
not permitted).
-
setBasePositiveItemLabelPosition
Sets the base positive item label position and, if requested, sends aRendererChangeEvent
to all registered listeners.- Parameters:
position
- the position (null
not permitted).notify
- notify registered listeners?
-
getNegativeItemLabelPosition
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.- Parameters:
row
- the row index (zero-based).column
- the column (zero-based).- Returns:
- the item label position (never
null
).
-
getNegativeItemLabelPosition
ItemLabelPosition getNegativeItemLabelPosition()Returns the item label position for negative values in ALL series.- Returns:
- the item label position (possibly
null
).
-
setNegativeItemLabelPosition
Sets the item label position for negative values in ALL series, and sends aRendererChangeEvent
to all registered listeners. You need to set this tonull
to expose the settings for individual series.- Parameters:
position
- the position (null
permitted).
-
setNegativeItemLabelPosition
Sets the item label position for negative values in ALL series and (if requested) sends aRendererChangeEvent
to all registered listeners.- Parameters:
position
- the position (null
permitted).notify
- notify registered listeners?
-
getSeriesNegativeItemLabelPosition
Returns the item label position for all negative values in a series.- Parameters:
series
- the series index (zero-based).- Returns:
- the item label position (never
null
).
-
setSeriesNegativeItemLabelPosition
Sets the item label position for negative values in a series and sends aRendererChangeEvent
to all registered listeners.- Parameters:
series
- the series index (zero-based).position
- the position (null
permitted).
-
setSeriesNegativeItemLabelPosition
Sets the item label position for negative values in a series and (if requested) sends a.RendererChangeEvent
to all registered listeners.- Parameters:
series
- the series index (zero-based).position
- the position (null
permitted).notify
- notify registered listeners?
-
getBaseNegativeItemLabelPosition
ItemLabelPosition getBaseNegativeItemLabelPosition()Returns the base item label position for negative values.- Returns:
- the position (never
null
).
-
setBaseNegativeItemLabelPosition
Sets the base item label position for negative values and sends aRendererChangeEvent
to all registered listeners.- Parameters:
position
- the position (null
not permitted).
-
setBaseNegativeItemLabelPosition
Sets the base negative item label position and, if requested, sends aRendererChangeEvent
to all registered listeners.- Parameters:
position
- the position (null
not permitted).notify
- notify registered listeners?
-
drawItem
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.- Parameters:
g2
- the graphics device.state
- the renderer state.dataArea
- the area within which the data is being rendered.info
- collects drawing info.plot
- the plot (can be used to obtain standard color information etc).domainAxis
- the domain axis.rangeAxis
- the range axis.dataset
- the dataset.series
- the series index (zero-based).item
- the item index (zero-based).crosshairState
- crosshair information for the plot (null
permitted).pass
- the pass index.
-
getLegendItem
Returns a legend item for a series from a dataset.- Parameters:
datasetIndex
- the dataset index.series
- the series (zero-based index).- Returns:
- The legend item (possibly
null
).
-
fillDomainGridBand
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.- Parameters:
g2
- the graphics device.plot
- the plot.axis
- the domain axis.dataArea
- the data area.start
- the start value.end
- the end value.
-
fillRangeGridBand
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.- Parameters:
g2
- the graphics device.plot
- the plot.axis
- the range axis.dataArea
- the data area.start
- the start value.end
- the end value.
-
drawDomainGridLine
void drawDomainGridLine(Graphics2D g2, XYPlot plot, ValueAxis axis, Rectangle2D dataArea, double value)Draws a grid line against the domain axis.- Parameters:
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.
-
drawRangeGridLine
void drawRangeGridLine(Graphics2D g2, XYPlot plot, ValueAxis axis, Rectangle2D dataArea, double value)Draws a grid line against the range axis.- Parameters:
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.
-
drawDomainMarker
void drawDomainMarker(Graphics2D g2, XYPlot plot, ValueAxis axis, Marker marker, Rectangle2D dataArea)Draws a vertical line on the chart to represent a 'range marker'.- Parameters:
g2
- the graphics device.plot
- the plot.axis
- the value axis.marker
- the marker line.dataArea
- the axis data area.
-
drawRangeMarker
void drawRangeMarker(Graphics2D g2, XYPlot plot, ValueAxis axis, Marker marker, Rectangle2D dataArea)Draws a horizontal line across the chart to represent a 'range marker'.- Parameters:
g2
- the graphics device.plot
- the plot.axis
- the value axis.marker
- the marker line.dataArea
- the axis data area.
-
getPlot
XYPlot getPlot()Returns the plot that this renderer has been assigned to.- Returns:
- the plot.
-
setPlot
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.
- Parameters:
plot
- the plot.
-
getRangeType
RangeType getRangeType()Returns the range type for the renderer. The plot needs to know this information in order to determine an appropriate axis range (when the axis auto-range calculation is on).Two types are recognised:
STANDARD
- data items are plotted individually, so the axis range should extend from the smallest value to the largest value;STACKED
- data items are stacked on top of one another, so to determine the axis range, all the items in a series need to be summed together.
- Returns:
- a flag indicating whether or not the data values are stacked.
-
getRangeExtent
Returns the range of values the renderer requires to display all the items from the specified dataset.- Parameters:
dataset
- the dataset (null
permitted).- Returns:
- The range (or
null
if the dataset isnull
or empty).
-
addChangeListener
Add a renderer change listener.- Parameters:
listener
- the listener.
-
removeChangeListener
Removes a change listener.- Parameters:
listener
- the listener.
-