org.jfree.chart.renderer.category

Class StackedBarRenderer

public class StackedBarRenderer extends BarRenderer implements Cloneable, PublicCloneable, Serializable

A stacked bar renderer for use with the CategoryPlot class.
Constructor Summary
StackedBarRenderer()
Creates a new renderer.
StackedBarRenderer(boolean renderAsPercentages)
Creates a new renderer.
Method Summary
protected voidcalculateBarWidth(CategoryPlot plot, Rectangle2D dataArea, int rendererIndex, CategoryItemRendererState state)
Calculates the bar width and stores it in the renderer state.
voiddrawItem(Graphics2D g2, CategoryItemRendererState state, Rectangle2D dataArea, CategoryPlot plot, CategoryAxis domainAxis, ValueAxis rangeAxis, CategoryDataset dataset, int row, int column, int pass)
Draws a stacked bar for a specific item.
booleanequals(Object obj)
Tests this renderer for equality with an arbitrary object.
RangefindRangeBounds(CategoryDataset dataset)
Returns the range of values the renderer requires to display all the items from the specified dataset.
intgetPassCount()
Returns the number of passes (2) required by this renderer.
booleangetRenderAsPercentages()
Returns true if the renderer displays each item value as a percentage (so that the stacked bars add to 100%), and false otherwise.
voidsetRenderAsPercentages(boolean asPercentages)
Sets the flag that controls whether the renderer displays each item value as a percentage (so that the stacked bars add to 100%), and sends a RendererChangeEvent to all registered listeners.

Constructor Detail

StackedBarRenderer

public StackedBarRenderer()
Creates a new renderer. By default, the renderer has no tool tip generator and no URL generator. These defaults have been chosen to minimise the processing required to generate a default chart. If you require tool tips or URLs, then you can easily add the required generators.

StackedBarRenderer

public StackedBarRenderer(boolean renderAsPercentages)
Creates a new renderer.

Parameters: renderAsPercentages a flag that controls whether the data values are rendered as percentages.

Method Detail

calculateBarWidth

protected void calculateBarWidth(CategoryPlot plot, Rectangle2D dataArea, int rendererIndex, CategoryItemRendererState state)
Calculates the bar width and stores it in the renderer state.

Parameters: plot the plot. dataArea the data area. rendererIndex the renderer index. state the renderer state.

drawItem

public void drawItem(Graphics2D g2, CategoryItemRendererState state, Rectangle2D dataArea, CategoryPlot plot, CategoryAxis domainAxis, ValueAxis rangeAxis, CategoryDataset dataset, int row, int column, int pass)
Draws a stacked bar for a specific item.

Parameters: g2 the graphics device. state the renderer state. dataArea the plot area. plot the plot. domainAxis the domain (category) axis. rangeAxis the range (value) axis. dataset the data. row the row index (zero-based). column the column index (zero-based). pass the pass index.

equals

public boolean equals(Object obj)
Tests this renderer for equality with an arbitrary object.

Parameters: obj the object (null permitted).

Returns: A boolean.

findRangeBounds

public Range findRangeBounds(CategoryDataset dataset)
Returns the range of values the renderer requires to display all the items from the specified dataset.

Parameters: dataset the dataset (null permitted).

Returns: The range (or null if the dataset is empty).

getPassCount

public int getPassCount()
Returns the number of passes (2) required by this renderer. The first pass is used to draw the bars, the second pass is used to draw the item labels (if visible).

Returns: The number of passes required by the renderer.

getRenderAsPercentages

public boolean getRenderAsPercentages()
Returns true if the renderer displays each item value as a percentage (so that the stacked bars add to 100%), and false otherwise.

Returns: A boolean.

See Also: StackedBarRenderer

setRenderAsPercentages

public void setRenderAsPercentages(boolean asPercentages)
Sets the flag that controls whether the renderer displays each item value as a percentage (so that the stacked bars add to 100%), and sends a RendererChangeEvent to all registered listeners.

Parameters: asPercentages the flag.

See Also: getRenderAsPercentages