|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.jfree.chart.renderer.AbstractRenderer
org.jfree.chart.renderer.xy.AbstractXYItemRenderer
A base class that can be used to create new XYItemRenderer
implementations.
Field Summary |
Fields inherited from class org.jfree.chart.renderer.AbstractRenderer |
DEFAULT_OUTLINE_PAINT, DEFAULT_OUTLINE_STROKE, DEFAULT_PAINT, DEFAULT_SHAPE, DEFAULT_STROKE, DEFAULT_VALUE_LABEL_FONT, DEFAULT_VALUE_LABEL_PAINT, ZERO |
Constructor Summary | |
protected |
AbstractXYItemRenderer()
Creates a renderer where the tooltip generator and the URL generator are both null . |
Method Summary | |
void |
addAnnotation(XYAnnotation annotation)
Adds an annotation and sends a RendererChangeEvent to all
registered listeners. |
void |
addAnnotation(XYAnnotation annotation,
Layer layer)
Adds an annotation to the specified layer. |
protected void |
addEntity(EntityCollection entities,
java.awt.Shape area,
XYDataset dataset,
int series,
int item,
double entityX,
double entityY)
Adds an entity to the collection. |
protected java.awt.geom.Point2D |
calculateDomainMarkerTextAnchorPoint(java.awt.Graphics2D g2,
PlotOrientation orientation,
java.awt.geom.Rectangle2D dataArea,
java.awt.geom.Rectangle2D markerArea,
RectangleInsets markerOffset,
LengthAdjustmentType labelOffsetForDomain,
LengthAdjustmentType labelOffsetForRange,
RectangleAnchor anchor)
Calculates the (x, y) coordinates for drawing a marker label. |
protected java.lang.Object |
clone()
Returns a clone of the renderer. |
void |
drawAnnotations(java.awt.Graphics2D g2,
java.awt.geom.Rectangle2D dataArea,
ValueAxis domainAxis,
ValueAxis rangeAxis,
Layer layer,
PlotRenderingInfo info)
Draws all the annotations for the specified layer. |
void |
drawDomainGridLine(java.awt.Graphics2D g2,
XYPlot plot,
ValueAxis axis,
java.awt.geom.Rectangle2D dataArea,
double value)
Draws a grid line against the range axis. |
void |
drawDomainMarker(java.awt.Graphics2D g2,
XYPlot plot,
ValueAxis domainAxis,
Marker marker,
java.awt.geom.Rectangle2D dataArea)
Draws a vertical line on the chart to represent a 'range marker'. |
protected void |
drawItemLabel(java.awt.Graphics2D g2,
PlotOrientation orientation,
XYDataset dataset,
int series,
int item,
double x,
double y,
boolean negative)
Draws an item label. |
void |
drawRangeLine(java.awt.Graphics2D g2,
XYPlot plot,
ValueAxis axis,
java.awt.geom.Rectangle2D dataArea,
double value,
java.awt.Paint paint,
java.awt.Stroke stroke)
Draws a line perpendicular to the range axis. |
void |
drawRangeMarker(java.awt.Graphics2D g2,
XYPlot plot,
ValueAxis rangeAxis,
Marker marker,
java.awt.geom.Rectangle2D dataArea)
Draws a horizontal line across the chart to represent a 'range marker'. |
boolean |
equals(java.lang.Object obj)
Tests this renderer for equality with another object. |
void |
fillDomainGridBand(java.awt.Graphics2D g2,
XYPlot plot,
ValueAxis axis,
java.awt.geom.Rectangle2D dataArea,
double start,
double end)
Fills a band between two values on the axis. |
void |
fillRangeGridBand(java.awt.Graphics2D g2,
XYPlot plot,
ValueAxis axis,
java.awt.geom.Rectangle2D dataArea,
double start,
double end)
Fills a band between two values on the range axis. |
Range |
findDomainBounds(XYDataset dataset)
Returns the lower and upper bounds (range) of the x-values in the specified dataset. |
Range |
findRangeBounds(XYDataset dataset)
Returns the range of values the renderer requires to display all the items from the specified dataset. |
XYLabelGenerator |
getBaseLabelGenerator()
Returns the base item label generator. |
XYToolTipGenerator |
getBaseToolTipGenerator()
Returns the base tool tip generator. |
int |
getDefaultEntityRadius()
Returns the radius of the circle used for the default entity area when no area is specified. |
DrawingSupplier |
getDrawingSupplier()
Returns the drawing supplier from the plot. |
XYLabelGenerator |
getLabelGenerator(int row,
int column)
Returns the label generator for a data item. |
LegendItem |
getLegendItem(int datasetIndex,
int series)
Returns a default legend item for the specified series. |
XYSeriesLabelGenerator |
getLegendItemLabelGenerator()
Returns the legend item label generator. |
LegendItemCollection |
getLegendItems()
Returns a (possibly empty) collection of legend items for the series that this renderer is responsible for drawing. |
int |
getPassCount()
Returns the number of passes through the data that the renderer requires in order to draw the chart. |
XYPlot |
getPlot()
Returns the plot that the renderer is assigned to. |
XYLabelGenerator |
getSeriesLabelGenerator(int series)
Returns the label generator for 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(java.awt.Graphics2D g2,
java.awt.geom.Rectangle2D dataArea,
XYPlot plot,
XYDataset data,
PlotRenderingInfo info)
Initialises the renderer and returns a state object that should be passed to all subsequent calls to the drawItem() method. |
boolean |
removeAnnotation(XYAnnotation annotation)
Removes the specified annotation and sends a RendererChangeEvent
to all registered listeners. |
void |
removeAnnotations()
Removes all annotations and sends a RendererChangeEvent
to all registered listeners. |
void |
setBaseLabelGenerator(XYLabelGenerator generator)
Sets the base item label generator and sends a RendererChangeEvent to all registered listeners. |
void |
setBaseToolTipGenerator(XYToolTipGenerator generator)
Sets the base tool tip generator and sends a RendererChangeEvent
to all registered listeners. |
void |
setDefaultEntityRadius(int radius)
Sets the radius of the circle used for the default entity area when no area is specified. |
void |
setLabelGenerator(XYLabelGenerator generator)
Sets the item label generator for ALL series and sends a RendererChangeEvent to all registered listeners. |
void |
setLegendItemLabelGenerator(XYSeriesLabelGenerator generator)
Sets the legend item label generator. |
void |
setPlot(XYPlot plot)
Sets the plot that the renderer is assigned to. |
void |
setSeriesLabelGenerator(int series,
XYLabelGenerator generator)
Sets the label generator for a series and sends a RendererChangeEvent to all registered listeners. |
void |
setSeriesToolTipGenerator(int series,
XYToolTipGenerator generator)
Sets the tool tip generator for a series and sends a RendererChangeEvent to all registered listeners. |
void |
setToolTipGenerator(XYToolTipGenerator generator)
Sets the tool tip generator for ALL series and sends a RendererChangeEvent to all registered listeners. |
void |
setURLGenerator(XYURLGenerator urlGenerator)
Sets the URL generator for HTML image maps. |
protected void |
updateCrosshairValues(CrosshairState crosshairState,
double x,
double y,
double transX,
double transY,
PlotOrientation orientation)
Considers the current (x, y) coordinate and updates the crosshair point if it meets the criteria (usually means the (x, y) coordinate is the closest to the anchor point so far). |
Methods inherited from class java.lang.Object |
finalize, getClass, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
protected AbstractXYItemRenderer()
null
.
Method Detail |
public int getPassCount()
getPassCount
in interface XYItemRenderer
public XYPlot getPlot()
getPlot
in interface XYItemRenderer
public void setPlot(XYPlot plot)
setPlot
in interface XYItemRenderer
plot
- the plot.public XYItemRendererState initialise(java.awt.Graphics2D g2, java.awt.geom.Rectangle2D dataArea, XYPlot plot, XYDataset data, PlotRenderingInfo info)
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.
initialise
in interface XYItemRenderer
g2
- the graphics device.dataArea
- the area inside the axes.plot
- the plot.data
- the data.info
- an optional info collection object to return data back to
the caller.
null
).public XYLabelGenerator getLabelGenerator(int row, int column)
getSeriesLabelGenerator(int)
method. If,
for some reason, you want a different generator for individual items,
you can override this method.
getLabelGenerator
in interface XYItemRenderer
row
- the row index (zero based).column
- the column index (zero based).
null
).public XYLabelGenerator getSeriesLabelGenerator(int series)
getSeriesLabelGenerator
in interface XYItemRenderer
series
- the series index (zero based).
null
).public void setLabelGenerator(XYLabelGenerator generator)
RendererChangeEvent
to all registered listeners.
setLabelGenerator
in interface XYItemRenderer
generator
- the generator (null
permitted).public void setSeriesLabelGenerator(int series, XYLabelGenerator generator)
RendererChangeEvent
to all registered listeners.
setSeriesLabelGenerator
in interface XYItemRenderer
series
- the series index (zero based).generator
- the generator (null
permitted).public XYLabelGenerator getBaseLabelGenerator()
getBaseLabelGenerator
in interface XYItemRenderer
null
).public void setBaseLabelGenerator(XYLabelGenerator generator)
RendererChangeEvent
to all registered listeners.
setBaseLabelGenerator
in interface XYItemRenderer
generator
- the generator (null
permitted).public XYToolTipGenerator getToolTipGenerator(int row, int column)
getToolTipGenerator
in interface XYItemRenderer
row
- the row index (zero based).column
- the column index (zero based).
null
).public XYToolTipGenerator getSeriesToolTipGenerator(int series)
getSeriesToolTipGenerator
in interface XYItemRenderer
series
- the series index (zero based).
null
).public void setToolTipGenerator(XYToolTipGenerator generator)
RendererChangeEvent
to all registered listeners.
setToolTipGenerator
in interface XYItemRenderer
generator
- the generator (null
permitted).public void setSeriesToolTipGenerator(int series, XYToolTipGenerator generator)
RendererChangeEvent
to all registered listeners.
setSeriesToolTipGenerator
in interface XYItemRenderer
series
- the series index (zero based).generator
- the generator (null
permitted).public XYToolTipGenerator getBaseToolTipGenerator()
getBaseToolTipGenerator
in interface XYItemRenderer
null
).public void setBaseToolTipGenerator(XYToolTipGenerator generator)
RendererChangeEvent
to all registered listeners.
setBaseToolTipGenerator
in interface XYItemRenderer
generator
- the generator (null
permitted).public XYURLGenerator getURLGenerator()
getURLGenerator
in interface XYItemRenderer
null
).public void setURLGenerator(XYURLGenerator urlGenerator)
setURLGenerator
in interface XYItemRenderer
urlGenerator
- the URL generator (null
permitted).public void addAnnotation(XYAnnotation annotation)
RendererChangeEvent
to all
registered listeners. The annotation is added to the foreground
layer.
addAnnotation
in interface XYItemRenderer
annotation
- the annotation (null
not permitted).public void addAnnotation(XYAnnotation annotation, Layer layer)
addAnnotation
in interface XYItemRenderer
annotation
- the annotation (null
not permitted).layer
- the layer (null
not permitted).public boolean removeAnnotation(XYAnnotation annotation)
RendererChangeEvent
to all registered listeners.
removeAnnotation
in interface XYItemRenderer
annotation
- the annotation to remove (null
not
permitted).
public void removeAnnotations()
RendererChangeEvent
to all registered listeners.
removeAnnotations
in interface XYItemRenderer
public int getDefaultEntityRadius()
public void setDefaultEntityRadius(int radius)
radius
- the radius.public XYSeriesLabelGenerator getLegendItemLabelGenerator()
null
).public void setLegendItemLabelGenerator(XYSeriesLabelGenerator generator)
generator
- the generator (null
not permitted).public Range findDomainBounds(XYDataset dataset)
findDomainBounds
in interface XYItemRenderer
dataset
- the dataset (null
permitted).
null
if the dataset is null
or empty).public Range findRangeBounds(XYDataset dataset)
findRangeBounds
in interface XYItemRenderer
dataset
- the dataset (null
permitted).
null
if the dataset is null
or empty).public LegendItemCollection getLegendItems()
getLegendItems
in interface LegendItemSource
null
).public LegendItem getLegendItem(int datasetIndex, int series)
getLegendItem
in interface XYItemRenderer
datasetIndex
- the dataset index (zero-based).series
- the series index (zero-based).
public void fillDomainGridBand(java.awt.Graphics2D g2, XYPlot plot, ValueAxis axis, java.awt.geom.Rectangle2D dataArea, double start, double end)
fillDomainGridBand
in interface XYItemRenderer
g2
- the graphics device.plot
- the plot.axis
- the domain axis.dataArea
- the data area.start
- the start value.end
- the end value.public void fillRangeGridBand(java.awt.Graphics2D g2, XYPlot plot, ValueAxis axis, java.awt.geom.Rectangle2D dataArea, double start, double end)
fillRangeGridBand
in interface XYItemRenderer
g2
- the graphics device.plot
- the plot.axis
- the range axis.dataArea
- the data area.start
- the start value.end
- the end value.public void drawDomainGridLine(java.awt.Graphics2D g2, XYPlot plot, ValueAxis axis, java.awt.geom.Rectangle2D dataArea, double value)
drawDomainGridLine
in interface XYItemRenderer
g2
- the graphics device.plot
- the plot.axis
- the value axis.dataArea
- the area for plotting data (not yet adjusted for any
3D effect).value
- the value at which the grid line should be drawn.public void drawRangeLine(java.awt.Graphics2D g2, XYPlot plot, ValueAxis axis, java.awt.geom.Rectangle2D dataArea, double value, java.awt.Paint paint, java.awt.Stroke stroke)
drawRangeLine
in interface XYItemRenderer
g2
- the graphics device.plot
- the plot.axis
- the value axis.dataArea
- the area for plotting data (not yet adjusted for any 3D
effect).value
- the value at which the grid line should be drawn.paint
- the paint.stroke
- the stroke.public void drawDomainMarker(java.awt.Graphics2D g2, XYPlot plot, ValueAxis domainAxis, Marker marker, java.awt.geom.Rectangle2D dataArea)
drawDomainMarker
in interface XYItemRenderer
g2
- the graphics device.plot
- the plot.domainAxis
- the domain axis.marker
- the marker line.dataArea
- the axis data area.protected java.awt.geom.Point2D calculateDomainMarkerTextAnchorPoint(java.awt.Graphics2D g2, PlotOrientation orientation, java.awt.geom.Rectangle2D dataArea, java.awt.geom.Rectangle2D markerArea, RectangleInsets markerOffset, LengthAdjustmentType labelOffsetForDomain, LengthAdjustmentType labelOffsetForRange, RectangleAnchor anchor)
g2
- the graphics device.orientation
- the plot orientation.dataArea
- the data area.markerArea
- the rectangle surrounding the marker area.markerOffset
- the marker label offset.labelOffsetForDomain
- the domain offset type.labelOffsetForRange
- the range offset type.anchor
- the label anchor.
public void drawRangeMarker(java.awt.Graphics2D g2, XYPlot plot, ValueAxis rangeAxis, Marker marker, java.awt.geom.Rectangle2D dataArea)
drawRangeMarker
in interface XYItemRenderer
g2
- the graphics device.plot
- the plot.rangeAxis
- the range axis.marker
- the marker line.dataArea
- the axis data area.protected java.lang.Object clone() throws java.lang.CloneNotSupportedException
clone
in class AbstractRenderer
java.lang.CloneNotSupportedException
- if the renderer does not support
cloning.public boolean equals(java.lang.Object obj)
equals
in class AbstractRenderer
obj
- the object.
true
or false
.public DrawingSupplier getDrawingSupplier()
getDrawingSupplier
in class AbstractRenderer
null
).protected void updateCrosshairValues(CrosshairState crosshairState, double x, double y, double transX, double transY, PlotOrientation orientation)
crosshairState
- the crosshair state (null
permitted,
but the method does nothing in that case).x
- the x-value (in data space).y
- the y-value (in data space).transX
- the x-value translated to Java2D space.transY
- the y-value translated to Java2D space.orientation
- the plot orientation (null
not
permitted).protected void drawItemLabel(java.awt.Graphics2D g2, PlotOrientation orientation, XYDataset dataset, int series, int item, double x, double y, boolean negative)
g2
- the graphics device.orientation
- the orientation.dataset
- the dataset.series
- the series index (zero-based).item
- the item index (zero-based).x
- the x coordinate (in Java2D space).y
- the y coordinate (in Java2D space).negative
- indicates a negative value (which affects the item
label position).public void drawAnnotations(java.awt.Graphics2D g2, java.awt.geom.Rectangle2D dataArea, ValueAxis domainAxis, ValueAxis rangeAxis, Layer layer, PlotRenderingInfo info)
drawAnnotations
in interface XYItemRenderer
g2
- the graphics device.dataArea
- the data area.domainAxis
- the domain axis.rangeAxis
- the range axis.layer
- the layer.info
- the plot rendering info.protected void addEntity(EntityCollection entities, java.awt.Shape area, XYDataset dataset, int series, int item, double entityX, double entityY)
entities
- the entity collection being populated.area
- the entity area (if null
a default will be
used).dataset
- the dataset.series
- the series.item
- the item.entityX
- the entity's center x-coordinate in user space.entityY
- the entity's center y-coordinate in user space.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |