org.jfree.chart.renderer
Class BarRenderer

java.lang.Object
  |
  +--org.jfree.chart.renderer.AbstractRenderer
        |
        +--org.jfree.chart.renderer.AbstractCategoryItemRenderer
              |
              +--org.jfree.chart.renderer.BarRenderer

All Implemented Interfaces:

CategoryItemRenderer, Renderer, java.io.Serializable

Direct Known Subclasses:

HorizontalBarRenderer, VerticalBarRenderer

public abstract class BarRenderer

extends AbstractCategoryItemRenderer

implements java.io.Serializable

A base class for category item renderers that draw bars.

Author:

David Gilbert

See Also:

Serialized Form

Field Summary

static double	BAR_OUTLINE_WIDTH_THRESHOLD Constant that controls the minimum width before a bar has an outline drawn.
static double	DEFAULT_ITEM_MARGIN The default item margin percentage.

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

DEFAULT_OUTLINE_PAINT, DEFAULT_OUTLINE_STROKE, DEFAULT_PAINT, DEFAULT_SHAPE, DEFAULT_STROKE

Fields inherited from interface org.jfree.chart.renderer.CategoryItemRenderer

STACKED, STANDARD

Constructor Summary

protected

BarRenderer(CategoryToolTipGenerator toolTipGenerator, CategoryURLGenerator urlGenerator) Constructs a bar renderer.

Method Summary

double	getBarWidth() Returns the bar width.
double	getItemMargin() Returns the item margin.
double	getLowerClip() Returns the lower clip value.
double	getUpperClip() Returns the upper clip value.
double	getZeroInJava2D() Returns the zero value in Java2D coordinates.
void	initialise(java.awt.Graphics2D g2, java.awt.geom.Rectangle2D dataArea, CategoryPlot plot, ChartRenderingInfo info) Initialises the renderer.
protected void	setBarWidth(double width) Updates the calculated bar width.
void	setItemMargin(double percent) Sets the item margin.

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

drawBackground, drawDomainGridline, drawOutline, drawRangeGridline, drawRangeMarker, equals, getColumnCount, getLegendItem, getRangeType, getRowCount, getToolTipGenerator, getURLGenerator, setToolTipGenerator, setURLGenerator

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

addPropertyChangeListener, createTransformedShape, firePropertyChanged, getDefaultOutlinePaint, getDefaultOutlineStroke, getDefaultPaint, getDefaultShape, getDefaultStroke, getDrawingSupplier, getInfo, getItemOutlinePaint, getItemOutlineStroke, getItemPaint, getItemShape, getItemStroke, getPlot, getSeriesOutlinePaint, getSeriesOutlineStroke, getSeriesPaint, getSeriesShape, getSeriesStroke, isOutlinePaintTableActive, isOutlineStrokeTableActive, isPaintTableActive, isShapeTableActive, isStrokeTableActive, removePropertyChangeListener, setDefaultOutlinePaint, setDefaultOutlineStroke, setDefaultPaint, setDefaultShape, setDefaultStroke, setDrawingSupplier, setInfo, setOutlinePaintTableActive, setOutlineStrokeTableActive, setPaintTableActive, setPlot, setSeriesOutlinePaint, setSeriesOutlinePaint, setSeriesOutlineStroke, setSeriesOutlineStroke, setSeriesPaint, setSeriesPaint, setSeriesShape, setSeriesShape, setSeriesStroke, setSeriesStroke, setShapeTableActive, setStrokeTableActive

Methods inherited from class java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.jfree.chart.renderer.CategoryItemRenderer

drawItem, getItemOutlinePaint, getItemPaint, getItemShape, getItemStroke, getSeriesOutlinePaint, getSeriesPaint, getSeriesShape, getSeriesStroke

Methods inherited from interface org.jfree.chart.renderer.Renderer

getDefaultOutlinePaint, getDefaultOutlineStroke, getDefaultPaint, getDefaultShape, getDefaultStroke, getDrawingSupplier, getPlot, isOutlinePaintTableActive, isOutlineStrokeTableActive, isPaintTableActive, isShapeTableActive, isStrokeTableActive, setDefaultOutlinePaint, setDefaultOutlineStroke, setDefaultPaint, setDefaultShape, setDefaultStroke, setDrawingSupplier, setOutlinePaintTableActive, setOutlineStrokeTableActive, setPaintTableActive, setPlot, setSeriesPaint, setSeriesPaint, setSeriesStroke, setSeriesStroke, setShapeTableActive, setStrokeTableActive

Field Detail

DEFAULT_ITEM_MARGIN

public static final double DEFAULT_ITEM_MARGIN

The default item margin percentage.

See Also:

Constant Field Values

BAR_OUTLINE_WIDTH_THRESHOLD

public static final double BAR_OUTLINE_WIDTH_THRESHOLD

Constant that controls the minimum width before a bar has an outline drawn.

See Also:

Constant Field Values

Constructor Detail

BarRenderer

protected BarRenderer(CategoryToolTipGenerator toolTipGenerator,
                      CategoryURLGenerator urlGenerator)

Constructs a bar renderer.

Parameters:

toolTipGenerator - the tool tip generator (null permitted).

urlGenerator - the URL generator (null permitted).

Method Detail

getItemMargin

public double getItemMargin()

Returns the item margin.

Returns:

the margin.

setItemMargin

public void setItemMargin(double percent)

Sets the item margin. The value is expressed as a percentage of the available width for plotting all the bars, with the resulting amount to be distributed between all the bars evenly.

Parameters:

percent - the new margin.

getBarWidth

public double getBarWidth()

Returns the bar width.

Returns:

the bar width.

setBarWidth

protected void setBarWidth(double width)

Updates the calculated bar width.

Parameters:

width - the new width.

getZeroInJava2D

public double getZeroInJava2D()

Returns the zero value in Java2D coordinates.

This value is recalculated in the initialise() method.

Returns:

the value.

getLowerClip

public double getLowerClip()

Returns the lower clip value.

This value is recalculated in the initialise() method.

Returns:

the value.

getUpperClip

public double getUpperClip()

Returns the upper clip value.

This value is recalculated in the initialise() method.

Returns:

the value.

initialise

public void initialise(java.awt.Graphics2D g2,
                       java.awt.geom.Rectangle2D dataArea,
                       CategoryPlot plot,
                       ChartRenderingInfo info)

Initialises the renderer.

This method gets called once at the start of the process of drawing a chart.

Specified by:

initialise in interface CategoryItemRenderer

Overrides:

initialise in class AbstractCategoryItemRenderer

Parameters:

g2 - the graphics device.

dataArea - the area in which the data is to be plotted.

plot - the plot.

info - collects chart rendering information for return to caller.