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.io.Serializable, java.lang.Cloneable, java.util.EventListener, AnnotationChangeListener, LegendItemSource, XYItemRenderer, org.jfree.util.PublicCloneable

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). The example shown here is generated by the XYBarChartDemo1.java program included in the JFreeChart demo collection:

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

protected class XYBarRenderer.XYBarRendererState
The state class used by this renderer.

Nested Classes
Modifier and Type	Class and Description
`protected class`	`XYBarRenderer.XYBarRendererState` The state class used by this renderer.

Field Summary

Fields
Modifier and Type	Field and Description
`private double`	`barAlignmentFactor` A factor used to align the bars about the x-value.
`private XYBarPainter`	`barPainter` The bar painter (never `null`).
`private double`	`base` The default base value for the bars.
`private static XYBarPainter`	`defaultBarPainter` The default bar painter assigned to each new instance of this renderer.
`private static boolean`	`defaultShadowsVisible` The default value for the initialisation of the shadowsVisible flag.
`private boolean`	`drawBarOutline` A flag that controls whether or not bar outlines are drawn.
`private org.jfree.ui.GradientPaintTransformer`	`gradientPaintTransformer` An optional class used to transform gradient paint objects to fit each bar.
`private java.awt.Shape`	`legendBar` The shape used to represent a bar in each legend item (this should never be `null`).
`private double`	`margin` Percentage margin (to reduce the width of bars).
`private ItemLabelPosition`	`negativeItemLabelPositionFallback` The fallback position if a negative item label doesn't fit inside the bar.
`private ItemLabelPosition`	`positiveItemLabelPositionFallback` The fallback position if a positive item label doesn't fit inside the bar.
`private static long`	`serialVersionUID` For serialization.
`private boolean`	`shadowsVisible` The flag that controls whether or not shadows are drawn for the bars.
`private double`	`shadowXOffset` The x-offset for the shadow effect.
`private double`	`shadowYOffset` The y-offset for the shadow effect.
`private boolean`	`useYInterval` A flag that controls whether the bars use the y-interval supplied by the dataset.

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

Constructors
Constructor and Description

XYBarRenderer()
The default constructor.

XYBarRenderer(double margin)
Constructs a new renderer.

Constructors
Constructor and Description
`XYBarRenderer()` The default constructor.
`XYBarRenderer(double margin)` Constructs a new renderer.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`private java.awt.geom.Point2D`	`calculateLabelAnchorPoint(ItemLabelAnchor anchor, java.awt.geom.Rectangle2D bar, PlotOrientation orientation)` Calculates the item label anchor point.
`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.
`protected void`	`drawItemLabel(java.awt.Graphics2D g2, XYDataset dataset, int series, int item, XYPlot plot, XYItemLabelGenerator generator, java.awt.geom.Rectangle2D bar, boolean negative)` Draws an item label.
`boolean`	`equals(java.lang.Object obj)` Tests this renderer for equality with an arbitrary object.
`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 lower and upper bounds (range) of the y-values in the specified dataset.
`double`	`getBarAlignmentFactor()` Returns the bar alignment factor.
`XYBarPainter`	`getBarPainter()` Returns the bar painter.
`double`	`getBase()` Returns the base value for the bars.
`static XYBarPainter`	`getDefaultBarPainter()` Returns the default bar painter.
`static boolean`	`getDefaultShadowsVisible()` Returns the default value for the `shadowsVisible` flag.
`org.jfree.ui.GradientPaintTransformer`	`getGradientPaintTransformer()` Returns the gradient paint transformer (an object used to transform gradient paint objects to fit each bar).
`java.awt.Shape`	`getLegendBar()` Returns the shape used to represent bars in each legend item.
`LegendItem`	`getLegendItem(int datasetIndex, int series)` Returns a default legend item for the specified series.
`double`	`getMargin()` Returns the margin which is a percentage amount by which the bars are trimmed.
`ItemLabelPosition`	`getNegativeItemLabelPositionFallback()` Returns the fallback position for negative item labels that don't fit within a bar.
`ItemLabelPosition`	`getPositiveItemLabelPositionFallback()` Returns the fallback position for positive item labels that don't fit within a bar.
`boolean`	`getShadowsVisible()` Returns the flag that controls whether or not shadows are drawn for the bars.
`double`	`getShadowXOffset()` Returns the shadow x-offset.
`double`	`getShadowYOffset()` Returns the shadow y-offset.
`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.
`private boolean`	`isInternalAnchor(ItemLabelAnchor anchor)` Returns `true` if the specified anchor point is inside a bar.
`private void`	`readObject(java.io.ObjectInputStream stream)` Provides serialization support.
`void`	`setBarAlignmentFactor(double factor)` Sets the bar alignment factor and sends a `RendererChangeEvent` to all registered listeners.
`void`	`setBarPainter(XYBarPainter painter)` Sets the bar painter and sends a `RendererChangeEvent` to all registered listeners.
`void`	`setBase(double base)` Sets the base value for the bars and sends a `RendererChangeEvent` to all registered listeners.
`static void`	`setDefaultBarPainter(XYBarPainter painter)` Sets the default bar painter.
`static void`	`setDefaultShadowsVisible(boolean visible)` Sets the default value for the shadows visible flag.
`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`	`setLegendBar(java.awt.Shape bar)` Sets the shape used to represent bars in each legend item 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`	`setNegativeItemLabelPositionFallback(ItemLabelPosition position)` Sets the fallback position for negative item labels that don't fit within a bar, and sends a `RendererChangeEvent` to all registered listeners.
`void`	`setPositiveItemLabelPositionFallback(ItemLabelPosition position)` Sets the fallback position for positive item labels that don't fit within a bar, and sends a `RendererChangeEvent` to all registered listeners.
`void`	`setShadowVisible(boolean visible)` Sets the flag that controls whether or not the renderer draws shadows for the bars, and sends a `RendererChangeEvent` to all registered listeners.
`void`	`setShadowXOffset(double offset)` Sets the x-offset for the bar shadow and sends a `RendererChangeEvent` to all registered listeners.
`void`	`setShadowYOffset(double offset)` Sets the y-offset for the bar shadow 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.
`private void`	`writeObject(java.io.ObjectOutputStream stream)` Provides serialization support.

Methods inherited from class org.jfree.chart.renderer.xy.AbstractXYItemRenderer
addAnnotation, addAnnotation, addEntity, annotationChanged, calculateDomainMarkerTextAnchorPoint, drawAnnotations, drawDomainGridLine, drawDomainLine, drawDomainMarker, drawItemLabel, drawRangeLine, drawRangeMarker, fillDomainGridBand, fillRangeGridBand, findDomainBounds, findRangeBounds, getAnnotations, getBaseItemLabelGenerator, getBaseToolTipGenerator, getDrawingSupplier, getItemLabelGenerator, getItemLabelGenerator, getLegendItemLabelGenerator, getLegendItems, getLegendItemToolTipGenerator, getLegendItemURLGenerator, getPassCount, getPlot, getSeriesItemLabelGenerator, getSeriesToolTipGenerator, getToolTipGenerator, getToolTipGenerator, getURLGenerator, isPointInRect, lineTo, moveTo, removeAnnotation, removeAnnotations, setBaseItemLabelGenerator, setBaseToolTipGenerator, setItemLabelGenerator, setLegendItemLabelGenerator, setLegendItemToolTipGenerator, setLegendItemURLGenerator, setPlot, setSeriesItemLabelGenerator, setSeriesToolTipGenerator, setToolTipGenerator, setURLGenerator, updateCrosshairValues, updateCrosshairValues

Methods inherited from class org.jfree.chart.renderer.AbstractRenderer
addChangeListener, calculateLabelAnchorPoint, clearSeriesPaints, clearSeriesStrokes, fireChangeEvent, getAutoPopulateSeriesFillPaint, getAutoPopulateSeriesOutlinePaint, getAutoPopulateSeriesOutlineStroke, getAutoPopulateSeriesPaint, getAutoPopulateSeriesShape, getAutoPopulateSeriesStroke, getBaseCreateEntities, getBaseFillPaint, getBaseItemLabelFont, getBaseItemLabelPaint, getBaseItemLabelsVisible, getBaseLegendShape, getBaseLegendTextFont, getBaseLegendTextPaint, getBaseNegativeItemLabelPosition, getBaseOutlinePaint, getBaseOutlineStroke, getBasePaint, getBasePositiveItemLabelPosition, getBaseSeriesVisible, getBaseSeriesVisibleInLegend, getBaseShape, getBaseStroke, getCreateEntities, getDataBoundsIncludesVisibleSeriesOnly, getDefaultEntityRadius, getItemCreateEntity, getItemFillPaint, getItemLabelAnchorOffset, getItemLabelFont, getItemLabelFont, getItemLabelPaint, getItemLabelPaint, getItemOutlinePaint, getItemOutlineStroke, getItemPaint, getItemShape, getItemStroke, getItemVisible, getLegendShape, getLegendTextFont, getLegendTextPaint, getNegativeItemLabelPosition, getNegativeItemLabelPosition, getPositiveItemLabelPosition, getPositiveItemLabelPosition, getSeriesCreateEntities, getSeriesFillPaint, getSeriesItemLabelFont, getSeriesItemLabelPaint, getSeriesNegativeItemLabelPosition, getSeriesOutlinePaint, getSeriesOutlineStroke, getSeriesPaint, getSeriesPositiveItemLabelPosition, getSeriesShape, getSeriesStroke, getSeriesVisible, getSeriesVisible, getSeriesVisibleInLegend, getSeriesVisibleInLegend, getTreatLegendShapeAsLine, hashCode, hasListener, isItemLabelVisible, isSeriesItemLabelsVisible, isSeriesVisible, isSeriesVisibleInLegend, lookupLegendShape, lookupLegendTextFont, lookupLegendTextPaint, lookupSeriesFillPaint, lookupSeriesOutlinePaint, lookupSeriesOutlineStroke, lookupSeriesPaint, lookupSeriesShape, lookupSeriesStroke, notifyListeners, removeChangeListener, setAutoPopulateSeriesFillPaint, setAutoPopulateSeriesOutlinePaint, setAutoPopulateSeriesOutlineStroke, setAutoPopulateSeriesPaint, setAutoPopulateSeriesShape, setAutoPopulateSeriesStroke, setBaseCreateEntities, setBaseCreateEntities, setBaseFillPaint, setBaseFillPaint, setBaseItemLabelFont, setBaseItemLabelFont, setBaseItemLabelPaint, setBaseItemLabelPaint, setBaseItemLabelsVisible, setBaseItemLabelsVisible, setBaseItemLabelsVisible, setBaseLegendShape, setBaseLegendTextFont, setBaseLegendTextPaint, setBaseNegativeItemLabelPosition, setBaseNegativeItemLabelPosition, setBaseOutlinePaint, setBaseOutlinePaint, setBaseOutlineStroke, setBaseOutlineStroke, setBasePaint, setBasePaint, setBasePositiveItemLabelPosition, setBasePositiveItemLabelPosition, setBaseSeriesVisible, setBaseSeriesVisible, setBaseSeriesVisibleInLegend, setBaseSeriesVisibleInLegend, setBaseShape, setBaseShape, setBaseStroke, setBaseStroke, setCreateEntities, setCreateEntities, setDataBoundsIncludesVisibleSeriesOnly, setDefaultEntityRadius, setFillPaint, setFillPaint, setItemLabelAnchorOffset, setItemLabelFont, setItemLabelFont, setItemLabelPaint, setItemLabelPaint, setItemLabelsVisible, setItemLabelsVisible, setItemLabelsVisible, setLegendShape, setLegendTextFont, setLegendTextPaint, setNegativeItemLabelPosition, setNegativeItemLabelPosition, setOutlinePaint, setOutlinePaint, setOutlineStroke, setOutlineStroke, setPaint, setPaint, setPositiveItemLabelPosition, setPositiveItemLabelPosition, setSeriesCreateEntities, setSeriesCreateEntities, setSeriesFillPaint, setSeriesFillPaint, setSeriesItemLabelFont, setSeriesItemLabelFont, setSeriesItemLabelPaint, setSeriesItemLabelPaint, setSeriesItemLabelsVisible, setSeriesItemLabelsVisible, setSeriesItemLabelsVisible, setSeriesNegativeItemLabelPosition, setSeriesNegativeItemLabelPosition, setSeriesOutlinePaint, setSeriesOutlinePaint, setSeriesOutlineStroke, setSeriesOutlineStroke, setSeriesPaint, setSeriesPaint, setSeriesPositiveItemLabelPosition, setSeriesPositiveItemLabelPosition, setSeriesShape, setSeriesShape, setSeriesStroke, setSeriesStroke, setSeriesVisible, setSeriesVisible, setSeriesVisible, setSeriesVisible, setSeriesVisibleInLegend, setSeriesVisibleInLegend, setSeriesVisibleInLegend, setSeriesVisibleInLegend, setShape, setShape, setStroke, setStroke, setTreatLegendShapeAsLine

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
addAnnotation, addAnnotation, addChangeListener, drawAnnotations, drawDomainGridLine, drawDomainMarker, drawRangeLine, drawRangeMarker, fillDomainGridBand, fillRangeGridBand, getBaseItemLabelFont, getBaseItemLabelGenerator, getBaseItemLabelPaint, getBaseItemLabelsVisible, getBaseNegativeItemLabelPosition, getBaseOutlinePaint, getBaseOutlineStroke, getBasePaint, getBasePositiveItemLabelPosition, getBaseSeriesVisible, getBaseSeriesVisibleInLegend, getBaseShape, getBaseStroke, getBaseToolTipGenerator, getItemLabelFont, getItemLabelFont, getItemLabelGenerator, getItemLabelPaint, getItemLabelPaint, getItemOutlinePaint, getItemOutlineStroke, getItemPaint, getItemShape, getItemStroke, getItemVisible, getLegendItemLabelGenerator, getNegativeItemLabelPosition, getNegativeItemLabelPosition, getPassCount, getPlot, getPositiveItemLabelPosition, getPositiveItemLabelPosition, getSeriesItemLabelFont, getSeriesItemLabelGenerator, getSeriesItemLabelPaint, getSeriesNegativeItemLabelPosition, getSeriesOutlinePaint, getSeriesOutlineStroke, getSeriesPaint, getSeriesPositiveItemLabelPosition, getSeriesShape, getSeriesStroke, getSeriesToolTipGenerator, getSeriesVisible, getSeriesVisible, getSeriesVisibleInLegend, getSeriesVisibleInLegend, getToolTipGenerator, getURLGenerator, isItemLabelVisible, isSeriesItemLabelsVisible, isSeriesVisible, isSeriesVisibleInLegend, removeAnnotation, removeAnnotations, removeChangeListener, setBaseItemLabelFont, setBaseItemLabelGenerator, setBaseItemLabelPaint, setBaseItemLabelsVisible, setBaseItemLabelsVisible, setBaseItemLabelsVisible, setBaseNegativeItemLabelPosition, setBaseNegativeItemLabelPosition, setBaseOutlinePaint, setBaseOutlineStroke, setBasePaint, setBasePositiveItemLabelPosition, setBasePositiveItemLabelPosition, setBaseSeriesVisible, setBaseSeriesVisible, setBaseSeriesVisibleInLegend, setBaseSeriesVisibleInLegend, setBaseShape, setBaseStroke, setBaseToolTipGenerator, setItemLabelFont, setItemLabelGenerator, setItemLabelPaint, setItemLabelsVisible, setItemLabelsVisible, setItemLabelsVisible, setLegendItemLabelGenerator, setNegativeItemLabelPosition, setNegativeItemLabelPosition, setOutlinePaint, setOutlineStroke, setPaint, setPlot, setPositiveItemLabelPosition, setPositiveItemLabelPosition, setSeriesItemLabelFont, setSeriesItemLabelGenerator, setSeriesItemLabelPaint, setSeriesItemLabelsVisible, setSeriesItemLabelsVisible, setSeriesItemLabelsVisible, setSeriesNegativeItemLabelPosition, setSeriesNegativeItemLabelPosition, setSeriesOutlinePaint, setSeriesOutlineStroke, setSeriesPaint, setSeriesPositiveItemLabelPosition, setSeriesPositiveItemLabelPosition, setSeriesShape, setSeriesStroke, setSeriesToolTipGenerator, setSeriesVisible, setSeriesVisible, setSeriesVisible, setSeriesVisible, setSeriesVisibleInLegend, setSeriesVisibleInLegend, setSeriesVisibleInLegend, setSeriesVisibleInLegend, setShape, setStroke, setToolTipGenerator, setURLGenerator

Methods inherited from interface org.jfree.chart.LegendItemSource
getLegendItems

- Field Detail
  - serialVersionUID
```
private static final long serialVersionUID
```
    For serialization.
    
    See Also:
    
    Constant Field Values
  - defaultBarPainter
```
private static XYBarPainter defaultBarPainter
```
    The default bar painter assigned to each new instance of this renderer.
    
    Since:
    
    1.0.11
  - defaultShadowsVisible
```
private static boolean defaultShadowsVisible
```
    The default value for the initialisation of the shadowsVisible flag.
  - base
```
private double base
```
    The default base value for the bars.
  - useYInterval
```
private boolean useYInterval
```
    A flag that controls whether the bars use the y-interval supplied by the dataset.
  - margin
```
private double margin
```
    Percentage margin (to reduce the width of bars).
  - drawBarOutline
```
private boolean drawBarOutline
```
    A flag that controls whether or not bar outlines are drawn.
  - gradientPaintTransformer
```
private org.jfree.ui.GradientPaintTransformer gradientPaintTransformer
```
    An optional class used to transform gradient paint objects to fit each bar.
  - legendBar
```
private transient java.awt.Shape legendBar
```
    The shape used to represent a bar in each legend item (this should never be null).
  - positiveItemLabelPositionFallback
```
private ItemLabelPosition positiveItemLabelPositionFallback
```
    The fallback position if a positive item label doesn't fit inside the bar.
  - negativeItemLabelPositionFallback
```
private ItemLabelPosition negativeItemLabelPositionFallback
```
    The fallback position if a negative item label doesn't fit inside the bar.
  - barPainter
```
private XYBarPainter barPainter
```
    The bar painter (never null).
    
    Since:
    
    1.0.11
  - shadowsVisible
```
private boolean shadowsVisible
```
    The flag that controls whether or not shadows are drawn for the bars.
    
    Since:
    
    1.0.11
  - shadowXOffset
```
private double shadowXOffset
```
    The x-offset for the shadow effect.
    
    Since:
    
    1.0.11
  - shadowYOffset
```
private double shadowYOffset
```
    The y-offset for the shadow effect.
    
    Since:
    
    1.0.11
  - barAlignmentFactor
```
private double barAlignmentFactor
```
    A factor used to align the bars about the x-value.
    
    Since:
    
    1.0.13
- Constructor Detail
  - 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.
- Method Detail
  - getDefaultBarPainter
```
public static XYBarPainter getDefaultBarPainter()
```
    Returns the default bar painter.
    
    Returns:
    
    The default bar painter.
    
    Since:
    
    1.0.11
  - setDefaultBarPainter
```
public static void setDefaultBarPainter(XYBarPainter painter)
```
    Sets the default bar painter.
    
    Parameters:
    
    painter - the painter (null not permitted).
    
    Since:
    
    1.0.11
  - getDefaultShadowsVisible
```
public static boolean getDefaultShadowsVisible()
```
    Returns the default value for the shadowsVisible flag.
    
    Returns:
    
    A boolean.
    
    Since:
    
    1.0.13
    
    See Also:
    
    setDefaultShadowsVisible(boolean)
  - setDefaultShadowsVisible
```
public static void setDefaultShadowsVisible(boolean visible)
```
    Sets the default value for the shadows visible flag.
    
    Parameters:
    
    visible - the new value for the default.
    
    Since:
    
    1.0.13
    
    See Also:
    
    getDefaultShadowsVisible()
  - getBase
```
public double getBase()
```
    Returns the base value for the bars.
    
    Returns:
    
    The base value for the bars.
    
    See Also:
    
    setBase(double)
  - 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.
    
    See Also:
    
    getBase(), getUseYInterval()
  - 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.
    
    See Also:
    
    setUseYInterval(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.
    
    See Also:
    
    getUseYInterval()
  - getMargin
```
public double getMargin()
```
    Returns the margin which is a percentage amount by which the bars are trimmed.
    
    Returns:
    
    The margin.
    
    See Also:
    
    setMargin(double)
  - 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.
    
    See Also:
    
    getMargin()
  - isDrawBarOutline
```
public boolean isDrawBarOutline()
```
    Returns a flag that controls whether or not bar outlines are drawn.
    
    Returns:
    
    A boolean.
    
    See Also:
    
    setDrawBarOutline(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.
    
    See Also:
    
    isDrawBarOutline()
  - 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).
    
    See Also:
    
    setGradientPaintTransformer(GradientPaintTransformer)
  - 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).
    
    See Also:
    
    getGradientPaintTransformer()
  - getLegendBar
```
public java.awt.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)
  - setLegendBar
```
public void setLegendBar(java.awt.Shape bar)
```
    Sets the shape used to represent bars in each legend item and sends a RendererChangeEvent to all registered listeners.
    
    Parameters:
    
    bar - the bar shape (null not permitted).
    
    See Also:
    
    getLegendBar()
  - getPositiveItemLabelPositionFallback
```
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
    
    See Also:
    
    setPositiveItemLabelPositionFallback(ItemLabelPosition)
  - setPositiveItemLabelPositionFallback
```
public void setPositiveItemLabelPositionFallback(ItemLabelPosition position)
```
    Sets the fallback position for positive item labels that don't fit within a bar, and sends a RendererChangeEvent to all registered listeners.
    
    Parameters:
    
    position - the position (null permitted).
    
    Since:
    
    1.0.2
    
    See Also:
    
    getPositiveItemLabelPositionFallback()
  - getNegativeItemLabelPositionFallback
```
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
    
    See Also:
    
    setNegativeItemLabelPositionFallback(ItemLabelPosition)
  - setNegativeItemLabelPositionFallback
```
public void setNegativeItemLabelPositionFallback(ItemLabelPosition position)
```
    Sets the fallback position for negative item labels that don't fit within a bar, and sends a RendererChangeEvent to all registered listeners.
    
    Parameters:
    
    position - the position (null permitted).
    
    Since:
    
    1.0.2
    
    See Also:
    
    getNegativeItemLabelPositionFallback()
  - getBarPainter
```
public XYBarPainter getBarPainter()
```
    Returns the bar painter.
    
    Returns:
    
    The bar painter (never null).
    
    Since:
    
    1.0.11
  - setBarPainter
```
public void setBarPainter(XYBarPainter painter)
```
    Sets the bar painter and sends a RendererChangeEvent to all registered listeners.
    
    Parameters:
    
    painter - the painter (null not permitted).
    
    Since:
    
    1.0.11
  - getShadowsVisible
```
public boolean getShadowsVisible()
```
    Returns the flag that controls whether or not shadows are drawn for the bars.
    
    Returns:
    
    A boolean.
    
    Since:
    
    1.0.11
  - setShadowVisible
```
public void setShadowVisible(boolean visible)
```
    Sets the flag that controls whether or not the renderer draws shadows for the bars, and sends a RendererChangeEvent to all registered listeners.
    
    Parameters:
    
    visible - the new flag value.
    
    Since:
    
    1.0.11
  - getShadowXOffset
```
public double getShadowXOffset()
```
    Returns the shadow x-offset.
    
    Returns:
    
    The shadow x-offset.
    
    Since:
    
    1.0.11
  - setShadowXOffset
```
public void setShadowXOffset(double offset)
```
    Sets the x-offset for the bar shadow and sends a RendererChangeEvent to all registered listeners.
    
    Parameters:
    
    offset - the offset.
    
    Since:
    
    1.0.11
  - getShadowYOffset
```
public double getShadowYOffset()
```
    Returns the shadow y-offset.
    
    Returns:
    
    The shadow y-offset.
    
    Since:
    
    1.0.11
  - setShadowYOffset
```
public void setShadowYOffset(double offset)
```
    Sets the y-offset for the bar shadow and sends a RendererChangeEvent to all registered listeners.
    
    Parameters:
    
    offset - the offset.
    
    Since:
    
    1.0.11
  - getBarAlignmentFactor
```
public double getBarAlignmentFactor()
```
    Returns the bar alignment factor.
    
    Returns:
    
    The bar alignment factor.
    
    Since:
    
    1.0.13
  - setBarAlignmentFactor
```
public void setBarAlignmentFactor(double factor)
```
    Sets the bar alignment factor and sends a RendererChangeEvent to all registered listeners. If the alignment factor is outside the range 0.0 to 1.0, no alignment will be performed by the renderer.
    
    Parameters:
    
    factor - the factor.
    
    Since:
    
    1.0.13
  - 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.
  - getLegendItem
```
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 class AbstractXYItemRenderer
    
    Parameters:
    
    datasetIndex - the dataset index (zero-based).
    
    series - the series index (zero-based).
    
    Returns:
    
    A legend item for the series.
  - 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.
  - drawItemLabel
```
protected void drawItemLabel(java.awt.Graphics2D g2,
                             XYDataset dataset,
                             int series,
                             int item,
                             XYPlot plot,
                             XYItemLabelGenerator generator,
                             java.awt.geom.Rectangle2D bar,
                             boolean negative)
```
    Draws an item label. This method is provided as an alternative to AbstractXYItemRenderer.drawItemLabel(Graphics2D, PlotOrientation, XYDataset, int, int, double, double, boolean) 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 (null permitted, in which case the method does nothing, just returns).
    
    bar - the bar.
    
    negative - a flag indicating a negative value.
  - calculateLabelAnchorPoint
```
private java.awt.geom.Point2D calculateLabelAnchorPoint(ItemLabelAnchor anchor,
                                                        java.awt.geom.Rectangle2D bar,
                                                        PlotOrientation orientation)
```
    Calculates the item label anchor point.
    
    Parameters:
    
    anchor - the anchor.
    
    bar - the bar.
    
    orientation - the plot orientation.
    
    Returns:
    
    The anchor point.
  - isInternalAnchor
```
private boolean isInternalAnchor(ItemLabelAnchor anchor)
```
    Returns true if the specified anchor point is inside a bar.
    
    Parameters:
    
    anchor - the anchor point.
    
    Returns:
    
    A boolean.
  - findDomainBounds
```
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 class AbstractXYItemRenderer
    
    Parameters:
    
    dataset - the dataset (null permitted).
    
    Returns:
    
    The range (null if the dataset is null or empty).
    
    See Also:
    
    AbstractXYItemRenderer.findRangeBounds(XYDataset)
  - findRangeBounds
```
public Range findRangeBounds(XYDataset dataset)
```
    Returns the lower and upper bounds (range) of the y-values in the specified dataset. If the renderer is plotting the y-interval from the dataset, this is taken into account for the range.
    
    Specified by:
    
    findRangeBounds in interface XYItemRenderer
    
    Overrides:
    
    findRangeBounds in class AbstractXYItemRenderer
    
    Parameters:
    
    dataset - the dataset (null permitted).
    
    Returns:
    
    The range (null if the dataset is null or empty).
    
    See Also:
    
    AbstractXYItemRenderer.findDomainBounds(XYDataset)
  - 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.
  - readObject
```
private void readObject(java.io.ObjectInputStream stream)
                 throws java.io.IOException,
                        java.lang.ClassNotFoundException
```
    Provides serialization support.
    
    Parameters:
    
    stream - the input stream.
    
    Throws:
    
    java.io.IOException - if there is an I/O error.
    
    java.lang.ClassNotFoundException - if there is a classpath problem.
  - writeObject
```
private void writeObject(java.io.ObjectOutputStream stream)
                  throws java.io.IOException
```
    Provides serialization support.
    
    Parameters:
    
    stream - the output stream.
    
    Throws:
    
    java.io.IOException - if there is an I/O error.

Class XYBarRenderer

Nested Class Summary

Field Summary

Fields inherited from class org.jfree.chart.renderer.AbstractRenderer

Constructor Summary

Method Summary

Methods inherited from class org.jfree.chart.renderer.xy.AbstractXYItemRenderer

Methods inherited from class org.jfree.chart.renderer.AbstractRenderer

Methods inherited from class java.lang.Object

Methods inherited from interface org.jfree.chart.renderer.xy.XYItemRenderer

Methods inherited from interface org.jfree.chart.LegendItemSource

Field Detail

serialVersionUID

defaultBarPainter

defaultShadowsVisible

base

useYInterval

margin

drawBarOutline

gradientPaintTransformer

legendBar

positiveItemLabelPositionFallback

negativeItemLabelPositionFallback

barPainter

shadowsVisible

shadowXOffset

shadowYOffset

barAlignmentFactor

Constructor Detail

XYBarRenderer

XYBarRenderer

Method Detail

getDefaultBarPainter

setDefaultBarPainter

getDefaultShadowsVisible

setDefaultShadowsVisible

getBase

setBase

getUseYInterval

setUseYInterval

getMargin

setMargin

isDrawBarOutline

setDrawBarOutline

getGradientPaintTransformer

setGradientPaintTransformer

getLegendBar

setLegendBar

getPositiveItemLabelPositionFallback

setPositiveItemLabelPositionFallback

getNegativeItemLabelPositionFallback

setNegativeItemLabelPositionFallback

getBarPainter

setBarPainter

getShadowsVisible

setShadowVisible

getShadowXOffset

setShadowXOffset

getShadowYOffset

setShadowYOffset

getBarAlignmentFactor

setBarAlignmentFactor

initialise

getLegendItem

drawItem

drawItemLabel

calculateLabelAnchorPoint

isInternalAnchor

findDomainBounds

findRangeBounds

clone

equals

readObject

writeObject