Module platform
Package 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:
Serializable, Cloneable, EventListener, AnnotationChangeListener, LegendItemSource, XYItemRenderer, PublicCloneable
Direct Known Subclasses:
ClusteredXYBarRenderer, StackedXYBarRenderer
public class XYBarRenderer extends AbstractXYItemRenderer implements XYItemRenderer, Cloneable, PublicCloneable, 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:

XYBarRendererSample.png
See Also:

  • Constructor Details

    • 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 Details

    • getDefaultBarPainter

      public static XYBarPainter getDefaultBarPainter()
      Returns the default bar painter.
      Returns:
      The default bar painter.

    • setDefaultBarPainter

      public static void setDefaultBarPainter(XYBarPainter painter)
      Sets the default bar painter.
      Parameters:
      painter - the painter (null not permitted).

    • getDefaultShadowsVisible

      public static boolean getDefaultShadowsVisible()
      Returns the default value for the shadowsVisible flag.
      Returns:
      A boolean.
      See Also:

    • setDefaultShadowsVisible

      public static void setDefaultShadowsVisible(boolean visible)
      Sets the default value for the shadows visible flag.
      Parameters:
      visible - the new value for the default.
      See Also:

    • getBase

      public double getBase()
      Returns the base value for the bars.
      Returns:
      The base value for the bars.
      See Also:

    • 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:

    • 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

      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:

    • getMargin

      public double getMargin()
      Returns the margin which is a percentage amount by which the bars are trimmed.
      Returns:
      The margin.
      See Also:

    • 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:

    • isDrawBarOutline

      public boolean isDrawBarOutline()
      Returns a flag that controls whether or not bar outlines are drawn.
      Returns:
      A boolean.
      See Also:

    • 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:

    • getGradientPaintTransformer

      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).
      See Also:

    • setGradientPaintTransformer

      public void setGradientPaintTransformer(GradientPaintTransformer transformer)
      Sets the gradient paint transformer and sends a RendererChangeEvent to all registered listeners.
      Parameters:
      transformer - the transformer (null permitted).
      See Also:

    • getLegendBar

      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

      public void setLegendBar(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:

    • 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).
      See Also:

    • 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).
      See Also:

    • 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).
      See Also:

    • 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).
      See Also:

    • getBarPainter

      public XYBarPainter getBarPainter()
      Returns the bar painter.
      Returns:
      The bar painter (never null).

    • 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).

    • getShadowsVisible

      public boolean getShadowsVisible()
      Returns the flag that controls whether or not shadows are drawn for the bars.
      Returns:
      A boolean.

    • 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.

    • getShadowXOffset

      public double getShadowXOffset()
      Returns the shadow x-offset.
      Returns:
      The shadow x-offset.

    • 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.

    • getShadowYOffset

      public double getShadowYOffset()
      Returns the shadow y-offset.
      Returns:
      The shadow y-offset.

    • 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.

    • getBarAlignmentFactor

      public double getBarAlignmentFactor()
      Returns the bar alignment factor.
      Returns:
      The bar alignment factor.

    • 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.

    • initialise

      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 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(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.

    • drawItemLabel

      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 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.

    • 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:

    • 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:

    • clone

      public Object clone() throws CloneNotSupportedException
      Returns a clone of the renderer.
      Specified by:
      clone in interface PublicCloneable
      Overrides:
      clone in class AbstractXYItemRenderer
      Returns:
      A clone.
      Throws:
      CloneNotSupportedException - if the renderer cannot be cloned.

    • equals

      public boolean equals(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.