Prev Class | Next Class | Frames | No Frames |
Summary: Nested | Field | Method | Constr | Detail: Nested | Field | Method | Constr |
java.lang.Object
org.jfree.chart.renderer.AbstractRenderer
org.jfree.chart.renderer.xy.AbstractXYItemRenderer
org.jfree.chart.renderer.xy.XYDifferenceRenderer
public class XYDifferenceRenderer
extends AbstractXYItemRenderer
implements XYItemRenderer, Cloneable, PublicCloneable, Serializable
XYPlot
that highlights the differences between two
series.
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 | |
| |
|
Method Summary | |
Object |
|
void |
|
protected void |
|
protected void |
|
boolean |
|
LegendItem |
|
Shape |
|
Paint |
|
int |
|
Paint |
|
boolean |
|
boolean |
|
XYItemRendererState |
|
void |
|
void |
|
void |
|
void |
|
void |
|
public XYDifferenceRenderer(Paint positivePaint, Paint negativePaint, boolean shapes)
Creates a new renderer.
- Parameters:
positivePaint
- the highlight color for positive differences (null
not permitted).negativePaint
- the highlight color for negative differences (null
not permitted).shapes
- draw shapes?
public Object clone() throws CloneNotSupportedException
Returns a clone of the renderer.
- Overrides:
- clone in interface AbstractXYItemRenderer
- Returns:
- A clone.
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)
Draws the visual representation of a single data item.
- Specified by:
- drawItem in interface XYItemRenderer
- Parameters:
g2
- the graphics device.state
- the renderer state.dataArea
- the area within which the data is being drawn.info
- collects information about the drawing.plot
- the plot (can be used to obtain standard color information etc).domainAxis
- the domain (horizontal) axis.rangeAxis
- the range (vertical) 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.
protected void drawItemPass0(Graphics2D x_graphics, Rectangle2D x_dataArea, PlotRenderingInfo x_info, XYPlot x_plot, ValueAxis x_domainAxis, ValueAxis x_rangeAxis, XYDataset x_dataset, int x_series, int x_item, CrosshairState x_crosshairState)
Draws the visual representation of a single data item, first pass.
- Parameters:
x_graphics
- the graphics device.x_dataArea
- the area within which the data is being drawn.x_info
- collects information about the drawing.x_plot
- the plot (can be used to obtain standard color information etc).x_domainAxis
- the domain (horizontal) axis.x_rangeAxis
- the range (vertical) axis.x_dataset
- the dataset.x_series
- the series index (zero-based).x_item
- the item index (zero-based).x_crosshairState
- crosshair information for the plot (null
permitted).
protected void drawItemPass1(Graphics2D x_graphics, Rectangle2D x_dataArea, PlotRenderingInfo x_info, XYPlot x_plot, ValueAxis x_domainAxis, ValueAxis x_rangeAxis, XYDataset x_dataset, int x_series, int x_item, CrosshairState x_crosshairState)
Draws the visual representation of a single data item, second pass. In the second pass, the renderer draws the lines and shapes for the individual points in the two series.
- Parameters:
x_graphics
- the graphics device.x_dataArea
- the area within which the data is being drawn.x_info
- collects information about the drawing.x_plot
- the plot (can be used to obtain standard color information etc).x_domainAxis
- the domain (horizontal) axis.x_rangeAxis
- the range (vertical) axis.x_dataset
- the dataset.x_series
- the series index (zero-based).x_item
- the item index (zero-based).x_crosshairState
- crosshair information for the plot (null
permitted).
public boolean equals(Object obj)
Tests this renderer for equality with an arbitrary object.
- Overrides:
- equals in interface AbstractXYItemRenderer
- Parameters:
obj
- the object (null
permitted).
- Returns:
- A boolean.
public LegendItem getLegendItem(int datasetIndex, int series)
Returns a default legend item for the specified series. Subclasses should override this method to generate customised items.
- Specified by:
- getLegendItem in interface XYItemRenderer
- Overrides:
- getLegendItem in interface AbstractXYItemRenderer
- Parameters:
datasetIndex
- the dataset index (zero-based).series
- the series index (zero-based).
- Returns:
- A legend item for the series.
public Shape getLegendLine()
Returns the shape used to represent a line in the legend.
- Returns:
- The legend line (never
null
).
- See Also:
setLegendLine(Shape)
public Paint getNegativePaint()
Returns the paint used to highlight negative differences.
- Returns:
- The paint (never
null
).
- See Also:
setNegativePaint(Paint)
public int getPassCount()
Returns2
, the number of passes required by the renderer. TheXYPlot
will run through the dataset this number of times.
- Specified by:
- getPassCount in interface XYItemRenderer
- Overrides:
- getPassCount in interface AbstractXYItemRenderer
- Returns:
- The number of passes required by the renderer.
public Paint getPositivePaint()
Returns the paint used to highlight positive differences.
- Returns:
- The paint (never
null
).
- See Also:
setPositivePaint(Paint)
public boolean getRoundXCoordinates()
Returns the flag that controls whether or not the x-coordinates (in Java2D space) are rounded to integer values.
- Returns:
- The flag.
- Since:
- 1.0.4
- See Also:
setRoundXCoordinates(boolean)
public boolean getShapesVisible()
Returns a flag that controls whether or not shapes are drawn for each data value.
- Returns:
- A boolean.
- See Also:
setShapesVisible(boolean)
public XYItemRendererState initialise(Graphics2D g2, Rectangle2D dataArea, XYPlot plot, XYDataset data, PlotRenderingInfo info)
Initialises the renderer and returns a state object that should be passed to subsequent calls to the drawItem() method. 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.
- Specified by:
- initialise in interface XYItemRenderer
- Overrides:
- initialise in interface AbstractXYItemRenderer
- Parameters:
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.
- Returns:
- A state object.
public void setLegendLine(Shape line)
Sets the shape used as a line in each legend item and sends aRendererChangeEvent
to all registered listeners.
- Parameters:
line
- the line (null
not permitted).
- See Also:
getLegendLine()
public void setNegativePaint(Paint paint)
Sets the paint used to highlight negative differences.
- Parameters:
paint
- the paint (null
not permitted).
- See Also:
getNegativePaint()
public void setPositivePaint(Paint paint)
Sets the paint used to highlight positive differences and sends aRendererChangeEvent
to all registered listeners.
- Parameters:
paint
- the paint (null
not permitted).
- See Also:
getPositivePaint()
public void setRoundXCoordinates(boolean round)
Sets the flag that controls whether or not the x-coordinates (in Java2D space) are rounded to integer values, and sends aRendererChangeEvent
to all registered listeners.
- Parameters:
round
- the new flag value.
- Since:
- 1.0.4
- See Also:
getRoundXCoordinates()
public void setShapesVisible(boolean flag)
Sets a flag that controls whether or not shapes are drawn for each data value, and sends aRendererChangeEvent
to all registered listeners.
- Parameters:
flag
- the flag.
- See Also:
getShapesVisible()