public class

StackedBarRenderer3D

extends BarRenderer3D
implements Serializable Cloneable
java.lang.Object
   ↳ org.jfree.chart.renderer.AbstractRenderer
     ↳ org.jfree.chart.renderer.category.AbstractCategoryItemRenderer
       ↳ org.jfree.chart.renderer.category.BarRenderer
         ↳ org.jfree.chart.renderer.category.BarRenderer3D
           ↳ org.jfree.chart.renderer.category.StackedBarRenderer3D

Class Overview

Renders stacked bars with 3D-effect, for use with the CategoryPlot class. The example shown here is generated by the StackedBarChart3DDemo1.java program included in the JFreeChart Demo Collection:

StackedBarRenderer3DSample.png

Summary

[Expand]
Inherited Constants
From class org.jfree.chart.renderer.category.BarRenderer3D
From class org.jfree.chart.renderer.category.BarRenderer
[Expand]
Inherited Fields
From class org.jfree.chart.renderer.category.BarRenderer3D
From class org.jfree.chart.renderer.AbstractRenderer
Public Constructors
StackedBarRenderer3D()
Creates a new renderer with no tool tip generator and no URL generator.
StackedBarRenderer3D(double xOffset, double yOffset)
Constructs a new renderer with the specified '3D effect'.
StackedBarRenderer3D(boolean renderAsPercentages)
Creates a new renderer.
StackedBarRenderer3D(double xOffset, double yOffset, boolean renderAsPercentages)
Constructs a new renderer with the specified '3D effect'.
Public Methods
void drawItem(Graphics2D g2, CategoryItemRendererState state, Rectangle2D dataArea, CategoryPlot plot, CategoryAxis domainAxis, ValueAxis rangeAxis, CategoryDataset dataset, int row, int column, int pass)
Draws the visual representation of one data item from the chart (in fact, this method does nothing until it reaches the last item for each category, at which point it draws all the items for that category).
boolean equals(Object obj)
Tests this renderer for equality with an arbitrary object.
Range findRangeBounds(CategoryDataset dataset)
Returns the range of values the renderer requires to display all the items from the specified dataset.
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.
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.
Protected Methods
void calculateBarWidth(CategoryPlot plot, Rectangle2D dataArea, int rendererIndex, CategoryItemRendererState state)
Calculates the bar width and stores it in the renderer state.
static List createStackedValueList(CategoryDataset dataset, Comparable category, double base, boolean asPercentages)
This method is deprecated. As of 1.0.13, use createStackedValueList(CategoryDataset, Comparable, int[], double, boolean).
static List createStackedValueList(CategoryDataset dataset, Comparable category, int[] includedRows, double base, boolean asPercentages)
Returns a list containing the stacked values for the specified series in the given dataset, plus the supplied base value.
void drawStackHorizontal(List values, Comparable category, Graphics2D g2, CategoryItemRendererState state, Rectangle2D dataArea, CategoryPlot plot, CategoryAxis domainAxis, ValueAxis rangeAxis, CategoryDataset dataset)
Draws a stack of bars for one category, with a horizontal orientation.
void drawStackVertical(List values, Comparable category, Graphics2D g2, CategoryItemRendererState state, Rectangle2D dataArea, CategoryPlot plot, CategoryAxis domainAxis, ValueAxis rangeAxis, CategoryDataset dataset)
Draws a stack of bars for one category, with a vertical orientation.
[Expand]
Inherited Methods
From class org.jfree.chart.renderer.category.BarRenderer3D
From class org.jfree.chart.renderer.category.BarRenderer
From class org.jfree.chart.renderer.category.AbstractCategoryItemRenderer
From class org.jfree.chart.renderer.AbstractRenderer
From class java.lang.Object
From interface org.jfree.chart.Effect3D
From interface org.jfree.chart.LegendItemSource
From interface org.jfree.chart.renderer.category.CategoryItemRenderer

Public Constructors

public StackedBarRenderer3D ()

Creates a new renderer with no tool tip generator and no URL generator.

The defaults (no tool tip or URL generators) 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.

public StackedBarRenderer3D (double xOffset, double yOffset)

Constructs a new renderer with the specified '3D effect'.

Parameters
xOffset the x-offset for the 3D effect.
yOffset the y-offset for the 3D effect.

public StackedBarRenderer3D (boolean renderAsPercentages)

Creates a new renderer.

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

public StackedBarRenderer3D (double xOffset, double yOffset, boolean renderAsPercentages)

Constructs a new renderer with the specified '3D effect'.

Parameters
xOffset the x-offset for the 3D effect.
yOffset the y-offset for the 3D effect.
renderAsPercentages a flag that controls whether the data values are rendered as percentages.

Public Methods

public void drawItem (Graphics2D g2, CategoryItemRendererState state, Rectangle2D dataArea, CategoryPlot plot, CategoryAxis domainAxis, ValueAxis rangeAxis, CategoryDataset dataset, int row, int column, int pass)

Draws the visual representation of one data item from the chart (in fact, this method does nothing until it reaches the last item for each category, at which point it draws all the items for that category).

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.

public boolean equals (Object obj)

Tests this renderer for equality with an arbitrary object.

Parameters
obj the object (null permitted).
Returns
  • A boolean.

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 not permitted).
Returns
  • The range (or null if the dataset is empty).

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.

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.

Protected Methods

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.

protected static List createStackedValueList (CategoryDataset dataset, Comparable category, double base, boolean asPercentages)

This method is deprecated.
As of 1.0.13, use createStackedValueList(CategoryDataset, Comparable, int[], double, boolean).

Returns a list containing the stacked values for the specified series in the given dataset, plus the supplied base value.

Parameters
dataset the dataset (null not permitted).
category the category key (null not permitted).
base the base value.
asPercentages a flag that controls whether the values in the list are converted to percentages of the total.
Returns
  • The value list.

protected static List createStackedValueList (CategoryDataset dataset, Comparable category, int[] includedRows, double base, boolean asPercentages)

Returns a list containing the stacked values for the specified series in the given dataset, plus the supplied base value.

Parameters
dataset the dataset (null not permitted).
category the category key (null not permitted).
includedRows the included rows.
base the base value.
asPercentages a flag that controls whether the values in the list are converted to percentages of the total.
Returns
  • The value list.

protected void drawStackHorizontal (List values, Comparable category, Graphics2D g2, CategoryItemRendererState state, Rectangle2D dataArea, CategoryPlot plot, CategoryAxis domainAxis, ValueAxis rangeAxis, CategoryDataset dataset)

Draws a stack of bars for one category, with a horizontal orientation.

Parameters
values the value list.
category the category.
g2 the graphics device.
state the state.
dataArea the data area (adjusted for the 3D effect).
plot the plot.
domainAxis the domain axis.
rangeAxis the range axis.
dataset the dataset.

protected void drawStackVertical (List values, Comparable category, Graphics2D g2, CategoryItemRendererState state, Rectangle2D dataArea, CategoryPlot plot, CategoryAxis domainAxis, ValueAxis rangeAxis, CategoryDataset dataset)

Draws a stack of bars for one category, with a vertical orientation.

Parameters
values the value list.
category the category.
g2 the graphics device.
state the state.
dataArea the data area (adjusted for the 3D effect).
plot the plot.
domainAxis the domain axis.
rangeAxis the range axis.
dataset the dataset.