org.jfree.chart.renderer.xy
Class XYBarRenderer
java.lang.Object
org.jfree.chart.renderer.AbstractRenderer
org.jfree.chart.renderer.xy.AbstractXYItemRenderer
org.jfree.chart.renderer.xy.XYBarRenderer
- All Implemented Interfaces:
- java.lang.Cloneable, org.jfree.util.PublicCloneable, java.io.Serializable, XYItemRenderer
- Direct Known Subclasses:
- ClusteredXYBarRenderer, StackedXYBarRenderer
- public class XYBarRenderer
- extends AbstractXYItemRenderer
- implements XYItemRenderer, java.lang.Cloneable, org.jfree.util.PublicCloneable, java.io.Serializable
A renderer that draws bars on an XYPlot
(requires an IntervalXYDataset
).
This renderer does not include any code for calculating the crosshair point.
- See Also:
- Serialized Form
Method Summary |
java.lang.Object |
clone()
Returns a clone of the renderer. |
void |
drawItem(java.awt.Graphics2D g2,
XYItemRendererState state,
java.awt.geom.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. |
boolean |
equals(java.lang.Object obj)
Tests this renderer for equality with an arbitrary object. |
double |
getBase()
Returns the base value for the bars. |
org.jfree.ui.GradientPaintTransformer |
getGradientPaintTransformer()
Returns the gradient paint transformer (an object used to transform gradient paint objects
to fit each bar. |
double |
getMargin()
Returns the margin which is a percentage amount by which the bars are trimmed. |
boolean |
getUseYInterval()
Returns a flag that determines whether the y-interval from the dataset is
used to calculate the length of each bar. |
XYItemRendererState |
initialise(java.awt.Graphics2D g2,
java.awt.geom.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. |
boolean |
isDrawBarOutline()
Returns a flag that controls whether or not bar outlines are drawn. |
void |
setBase(double base)
Sets the base value for the bars and sends a RendererChangeEvent
to all registered listeners. |
void |
setDrawBarOutline(boolean draw)
Sets the flag that controls whether or not bar outlines are drawn and sends a
RendererChangeEvent to all registered listeners. |
void |
setGradientPaintTransformer(org.jfree.ui.GradientPaintTransformer transformer)
Sets the gradient paint transformer and sends a RendererChangeEvent to all registered
listeners. |
void |
setMargin(double margin)
Sets the percentage amount by which the bars are trimmed and sends a
RendererChangeEvent to all registered listeners. |
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 a
RendererChangeEvent to all registered listeners.. |
Methods inherited from class org.jfree.chart.renderer.xy.AbstractXYItemRenderer |
addEntity, drawDomainGridLine, drawDomainMarker, drawItemLabel, drawRangeGridLine, drawRangeMarker, fillDomainGridBand, fillRangeGridBand, getBaseLabelGenerator, getBaseToolTipGenerator, getDefaultEntityRadius, getDrawingSupplier, getLabelGenerator, getLegendItem, getPassCount, getPlot, getRangeExtent, getSeriesLabelGenerator, getSeriesToolTipGenerator, getToolTipGenerator, getURLGenerator, setBaseLabelGenerator, setBaseToolTipGenerator, setDefaultEntityRadius, setLabelGenerator, setPlot, setSeriesLabelGenerator, setSeriesToolTipGenerator, setToolTipGenerator, setURLGenerator, updateCrosshairValues |
Methods inherited from class org.jfree.chart.renderer.AbstractRenderer |
addChangeListener, calculateLabelAnchorPoint, createTransformedShape, getBaseItemLabelAnchor, getBaseItemLabelAngle, getBaseItemLabelFont, getBaseItemLabelPaint, getBaseItemLabelRotationAnchor, getBaseItemLabelsVisible, getBaseItemLabelTextAnchor, getBaseNegativeItemLabelPosition, getBaseOutlinePaint, getBaseOutlineStroke, getBasePaint, getBasePositiveItemLabelPosition, getBaseSeriesVisible, getBaseShape, getBaseStroke, getItemLabelAnchor, getItemLabelAnchorOffset, getItemLabelAngle, getItemLabelFont, getItemLabelFont, getItemLabelPaint, getItemLabelPaint, getItemLabelRotationAnchor, getItemLabelTextAnchor, getItemOutlinePaint, getItemOutlineStroke, getItemPaint, getItemShape, getItemStroke, getItemVisible, getNegativeItemLabelPosition, getNegativeItemLabelPosition, getPositiveItemLabelPosition, getPositiveItemLabelPosition, getSeriesItemLabelAnchor, getSeriesItemLabelAngle, getSeriesItemLabelFont, getSeriesItemLabelPaint, getSeriesItemLabelRotationAnchor, getSeriesItemLabelTextAnchor, getSeriesNegativeItemLabelPosition, getSeriesOutlinePaint, getSeriesOutlineStroke, getSeriesPaint, getSeriesPositiveItemLabelPosition, getSeriesShape, getSeriesStroke, getSeriesVisible, getSeriesVisible, hashCode, isItemLabelVisible, isSeriesItemLabelsVisible, notifyListeners, removeChangeListener, setBaseAngle, setBaseItemLabelAnchor, setBaseItemLabelFont, setBaseItemLabelFont, setBaseItemLabelPaint, setBaseItemLabelPaint, setBaseItemLabelRotationAnchor, setBaseItemLabelsVisible, setBaseItemLabelsVisible, setBaseItemLabelsVisible, setBaseItemLabelTextAnchor, setBaseNegativeItemLabelPosition, setBaseNegativeItemLabelPosition, setBaseOutlinePaint, setBaseOutlinePaint, setBaseOutlineStroke, setBaseOutlineStroke, setBasePaint, setBasePaint, setBasePositiveItemLabelPosition, setBasePositiveItemLabelPosition, setBaseSeriesVisible, setBaseSeriesVisible, setBaseShape, setBaseShape, setBaseStroke, setBaseStroke, setItemLabelAnchor, setItemLabelAnchorOffset, setItemLabelAngle, setItemLabelFont, setItemLabelFont, setItemLabelPaint, setItemLabelPaint, setItemLabelRotationAnchor, setItemLabelsVisible, setItemLabelsVisible, setItemLabelsVisible, setItemLabelTextAnchor, setNegativeItemLabelPosition, setNegativeItemLabelPosition, setOutlinePaint, setOutlinePaint, setOutlineStroke, setOutlineStroke, setPaint, setPaint, setPositiveItemLabelPosition, setPositiveItemLabelPosition, setSeriesAngle, setSeriesItemLabelAnchor, setSeriesItemLabelFont, setSeriesItemLabelFont, setSeriesItemLabelPaint, setSeriesItemLabelPaint, setSeriesItemLabelRotationAnchor, setSeriesItemLabelsVisible, setSeriesItemLabelsVisible, setSeriesItemLabelsVisible, setSeriesItemLabelTextAnchor, setSeriesNegativeItemLabelPosition, setSeriesNegativeItemLabelPosition, setSeriesOutlinePaint, setSeriesOutlinePaint, setSeriesOutlineStroke, setSeriesOutlineStroke, setSeriesPaint, setSeriesPaint, setSeriesPositiveItemLabelPosition, setSeriesPositiveItemLabelPosition, setSeriesShape, setSeriesShape, setSeriesStroke, setSeriesStroke, setSeriesVisible, setSeriesVisible, setSeriesVisible, setSeriesVisible, setShape, setShape, setStroke, setStroke |
Methods inherited from class java.lang.Object |
finalize, getClass, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface org.jfree.chart.renderer.xy.XYItemRenderer |
addChangeListener, drawDomainGridLine, drawDomainMarker, drawRangeGridLine, drawRangeMarker, fillDomainGridBand, fillRangeGridBand, getBaseItemLabelFont, getBaseItemLabelPaint, getBaseItemLabelsVisible, getBaseLabelGenerator, getBaseNegativeItemLabelPosition, getBaseOutlinePaint, getBaseOutlineStroke, getBasePaint, getBasePositiveItemLabelPosition, getBaseSeriesVisible, getBaseShape, getBaseStroke, getBaseToolTipGenerator, getItemLabelFont, getItemLabelFont, getItemLabelPaint, getItemLabelPaint, getItemOutlinePaint, getItemOutlineStroke, getItemPaint, getItemShape, getItemStroke, getItemVisible, getLabelGenerator, getLegendItem, getNegativeItemLabelPosition, getNegativeItemLabelPosition, getPassCount, getPlot, getPositiveItemLabelPosition, getPositiveItemLabelPosition, getRangeExtent, getSeriesItemLabelFont, getSeriesItemLabelPaint, getSeriesLabelGenerator, getSeriesNegativeItemLabelPosition, getSeriesOutlinePaint, getSeriesOutlineStroke, getSeriesPaint, getSeriesPositiveItemLabelPosition, getSeriesShape, getSeriesStroke, getSeriesToolTipGenerator, getSeriesVisible, getSeriesVisible, getToolTipGenerator, getURLGenerator, isItemLabelVisible, isSeriesItemLabelsVisible, removeChangeListener, setBaseItemLabelFont, setBaseItemLabelPaint, setBaseItemLabelsVisible, setBaseItemLabelsVisible, setBaseItemLabelsVisible, setBaseLabelGenerator, setBaseNegativeItemLabelPosition, setBaseNegativeItemLabelPosition, setBaseOutlinePaint, setBaseOutlineStroke, setBasePaint, setBasePositiveItemLabelPosition, setBasePositiveItemLabelPosition, setBaseSeriesVisible, setBaseSeriesVisible, setBaseShape, setBaseStroke, setBaseToolTipGenerator, setItemLabelFont, setItemLabelPaint, setItemLabelsVisible, setItemLabelsVisible, setItemLabelsVisible, setLabelGenerator, setNegativeItemLabelPosition, setNegativeItemLabelPosition, setOutlinePaint, setOutlineStroke, setPaint, setPlot, setPositiveItemLabelPosition, setPositiveItemLabelPosition, setSeriesItemLabelFont, setSeriesItemLabelPaint, setSeriesItemLabelsVisible, setSeriesItemLabelsVisible, setSeriesItemLabelsVisible, setSeriesLabelGenerator, setSeriesNegativeItemLabelPosition, setSeriesNegativeItemLabelPosition, setSeriesOutlinePaint, setSeriesOutlineStroke, setSeriesPaint, setSeriesPositiveItemLabelPosition, setSeriesPositiveItemLabelPosition, setSeriesShape, setSeriesStroke, setSeriesToolTipGenerator, setSeriesVisible, setSeriesVisible, setSeriesVisible, setSeriesVisible, setShape, setStroke, setToolTipGenerator, setURLGenerator |
XYBarRenderer
public XYBarRenderer()
- The default constructor.
XYBarRenderer
public XYBarRenderer(double margin)
- Constructs a new renderer.
- Parameters:
margin
- the percentage amount to trim from the width of each bar.
getBase
public double getBase()
- Returns the base value for the bars.
- Returns:
- The base value for the bars.
setBase
public void setBase(double base)
- Sets the base value for the bars and sends a
RendererChangeEvent
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.
getUseYInterval
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.
setUseYInterval
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 a
RendererChangeEvent
to all registered listeners..
- Parameters:
use
- the flag.
getMargin
public double getMargin()
- Returns the margin which is a percentage amount by which the bars are trimmed.
- Returns:
- The margin.
setMargin
public void setMargin(double margin)
- Sets the percentage amount by which the bars are trimmed and sends a
RendererChangeEvent
to all registered listeners.
- Parameters:
margin
- the new margin.
isDrawBarOutline
public boolean isDrawBarOutline()
- Returns a flag that controls whether or not bar outlines are drawn.
- Returns:
- A boolean.
setDrawBarOutline
public void setDrawBarOutline(boolean draw)
- Sets the flag that controls whether or not bar outlines are drawn and sends a
RendererChangeEvent
to all registered listeners.
- Parameters:
draw
- the flag.
getGradientPaintTransformer
public org.jfree.ui.GradientPaintTransformer getGradientPaintTransformer()
- Returns the gradient paint transformer (an object used to transform gradient paint objects
to fit each bar.
- Returns:
- A transformer (
null
possible).
setGradientPaintTransformer
public void setGradientPaintTransformer(org.jfree.ui.GradientPaintTransformer transformer)
- Sets the gradient paint transformer and sends a
RendererChangeEvent
to all registered
listeners.
- Parameters:
transformer
- the transformer (null
permitted).
initialise
public XYItemRendererState initialise(java.awt.Graphics2D g2,
java.awt.geom.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 class 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.
drawItem
public void drawItem(java.awt.Graphics2D g2,
XYItemRendererState state,
java.awt.geom.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.
clone
public java.lang.Object clone()
throws java.lang.CloneNotSupportedException
- Returns a clone of the renderer.
- Specified by:
clone
in interface org.jfree.util.PublicCloneable
- Overrides:
clone
in class AbstractXYItemRenderer
- Returns:
- A clone.
- Throws:
java.lang.CloneNotSupportedException
- if the renderer cannot be cloned.
equals
public boolean equals(java.lang.Object obj)
- Tests this renderer for equality with an arbitrary object.
- Overrides:
equals
in class AbstractXYItemRenderer
- Parameters:
obj
- the object to test against (null
permitted).
- Returns:
- A boolean.