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.XYBarRenderer
public class XYBarRenderer
extends AbstractXYItemRenderer
implements XYItemRenderer, Cloneable, PublicCloneable, Serializable
XYPlot
(requires an
IntervalXYDataset
).
Nested Class Summary | |
protected class |
|
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 |
|
boolean |
|
Range |
|
double |
|
GradientPaintTransformer |
|
Shape |
|
LegendItem |
|
double |
|
ItemLabelPosition |
|
ItemLabelPosition |
|
boolean |
|
XYItemRendererState |
|
boolean |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
public XYBarRenderer(double margin)
Constructs a new renderer.
- Parameters:
margin
- the percentage amount to trim from the width of each bar.
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 plot is being drawn.info
- collects information about the drawing.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.
protected void drawItemLabel(Graphics2D g2, XYDataset dataset, int series, int item, XYPlot plot, XYItemLabelGenerator generator, Rectangle2D bar, boolean negative)
Draws an item label. This method is overridden so that the bar can be used to calculate the label anchor point.
- Parameters:
g2
- the graphics device.dataset
- the dataset.series
- the series index.item
- the item index.plot
- the plot.generator
- the label generator.bar
- the bar.negative
- a flag indicating a negative value.
public boolean equals(Object obj)
Tests this renderer for equality with an arbitrary object.
- Overrides:
- equals in interface AbstractXYItemRenderer
- Parameters:
obj
- the object to test against (null
permitted).
- Returns:
- A boolean.
public Range findDomainBounds(XYDataset dataset)
Returns the lower and upper bounds (range) of the x-values in the specified dataset. Since this renderer uses the x-interval in the dataset, this is taken into account for the range.
- Specified by:
- findDomainBounds in interface XYItemRenderer
- Overrides:
- findDomainBounds in interface AbstractXYItemRenderer
- Parameters:
dataset
- the dataset (null
permitted).
- Returns:
- The range (
null
if the dataset isnull
or empty).
public double getBase()
Returns the base value for the bars.
- Returns:
- The base value for the bars.
- See Also:
setBase(double)
public GradientPaintTransformer getGradientPaintTransformer()
Returns the gradient paint transformer (an object used to transform gradient paint objects to fit each bar.
- Returns:
- A transformer (
null
possible).
public Shape getLegendBar()
Returns the shape used to represent bars in each legend item.
- Returns:
- The shape used to represent bars in each legend item (never
null
).
- See Also:
setLegendBar(Shape)
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 double getMargin()
Returns the margin which is a percentage amount by which the bars are trimmed.
- Returns:
- The margin.
- See Also:
setMargin(double)
public ItemLabelPosition getNegativeItemLabelPositionFallback()
Returns the fallback position for negative item labels that don't fit within a bar.
- Returns:
- The fallback position (
null
possible).
- Since:
- 1.0.2
public ItemLabelPosition getPositiveItemLabelPositionFallback()
Returns the fallback position for positive item labels that don't fit within a bar.
- Returns:
- The fallback position (
null
possible).
- Since:
- 1.0.2
public boolean getUseYInterval()
Returns a flag that determines whether the y-interval from the dataset is used to calculate the length of each bar.
- Returns:
- A boolean.
- See Also:
setUseYInterval(boolean)
public XYItemRendererState initialise(Graphics2D g2, Rectangle2D dataArea, XYPlot plot, XYDataset dataset, PlotRenderingInfo info)
Initialises the renderer and returns a state object that should be passed to all subsequent calls to the drawItem() method. Here we calculate the Java2D y-coordinate for zero, since all the bars have their bases fixed at zero.
- 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.dataset
- the data.info
- an optional info collection object to return data back to the caller.
- Returns:
- A state object.
public boolean isDrawBarOutline()
Returns a flag that controls whether or not bar outlines are drawn.
- Returns:
- A boolean.
- See Also:
setDrawBarOutline(boolean)
public void setBase(double base)
Sets the base value for the bars and sends aRendererChangeEvent
to all registered listeners. The base value is not used if the dataset's y-interval is being used to determine the bar length.
- Parameters:
base
- the new base value.
- See Also:
getBase()
,getUseYInterval()
public void setDrawBarOutline(boolean draw)
Sets the flag that controls whether or not bar outlines are drawn and sends aRendererChangeEvent
to all registered listeners.
- Parameters:
draw
- the flag.
- See Also:
isDrawBarOutline()
public void setGradientPaintTransformer(GradientPaintTransformer transformer)
Sets the gradient paint transformer and sends aRendererChangeEvent
to all registered listeners.
- Parameters:
transformer
- the transformer (null
permitted).
- See Also:
getGradientPaintTransformer()
public void setLegendBar(Shape bar)
Sets the shape used to represent bars in each legend item and sends aRendererChangeEvent
to all registered listeners.
- Parameters:
bar
- the bar shape (null
not permitted).
- See Also:
getLegendBar()
public void setMargin(double margin)
Sets the percentage amount by which the bars are trimmed and sends aRendererChangeEvent
to all registered listeners.
- Parameters:
margin
- the new margin.
- See Also:
getMargin()
public void setNegativeItemLabelPositionFallback(ItemLabelPosition position)
Sets the fallback position for negative item labels that don't fit within a bar, and sends aRendererChangeEvent
to all registered listeners.
- Parameters:
position
- the position (null
permitted).
- Since:
- 1.0.2
public void setPositiveItemLabelPositionFallback(ItemLabelPosition position)
Sets the fallback position for positive item labels that don't fit within a bar, and sends aRendererChangeEvent
to all registered listeners.
- Parameters:
position
- the position (null
permitted).
- Since:
- 1.0.2
public void setUseYInterval(boolean use)
Sets the flag that determines whether the y-interval from the dataset is used to calculate the length of each bar, and sends aRendererChangeEvent
to all registered listeners.
- Parameters:
use
- the flag.
- See Also:
getUseYInterval()