org.jfree.chart.renderer.category

Class BarRenderer3D

public class BarRenderer3D extends BarRenderer implements Effect3D, Cloneable, PublicCloneable, Serializable

A renderer for bars with a 3D effect, for use with the CategoryPlot class. The example shown here is generated by the BarChart3DDemo1.java program included in the JFreeChart Demo Collection:

BarRenderer3DSample.png
Field Summary
static PaintDEFAULT_WALL_PAINT
The default wall paint.
static doubleDEFAULT_X_OFFSET
The default x-offset for the 3D effect.
static doubleDEFAULT_Y_OFFSET
The default y-offset for the 3D effect.
Constructor Summary
BarRenderer3D()
Default constructor, creates a renderer with a default '3D effect'.
BarRenderer3D(double xOffset, double yOffset)
Constructs a new renderer with the specified '3D effect'.
Method Summary
voiddrawBackground(Graphics2D g2, CategoryPlot plot, Rectangle2D dataArea)
Draws the background for the plot.
voiddrawDomainGridline(Graphics2D g2, CategoryPlot plot, Rectangle2D dataArea, double value)
Draws a grid line against the domain axis.
voiddrawItem(Graphics2D g2, CategoryItemRendererState state, Rectangle2D dataArea, CategoryPlot plot, CategoryAxis domainAxis, ValueAxis rangeAxis, CategoryDataset dataset, int row, int column, int pass)
Draws a 3D bar to represent one data item.
voiddrawOutline(Graphics2D g2, CategoryPlot plot, Rectangle2D dataArea)
Draws the outline for the plot.
voiddrawRangeGridline(Graphics2D g2, CategoryPlot plot, ValueAxis axis, Rectangle2D dataArea, double value)
Draws a grid line against the range axis.
voiddrawRangeLine(Graphics2D g2, CategoryPlot plot, ValueAxis axis, Rectangle2D dataArea, double value, Paint paint, Stroke stroke)
Draws a line perpendicular to the range axis.
voiddrawRangeMarker(Graphics2D g2, CategoryPlot plot, ValueAxis axis, Marker marker, Rectangle2D dataArea)
Draws a range marker.
booleanequals(Object obj)
Tests this renderer for equality with an arbitrary object.
PaintgetWallPaint()
Returns the paint used to highlight the left and bottom wall in the plot background.
doublegetXOffset()
Returns the x-offset for the 3D effect.
doublegetYOffset()
Returns the y-offset for the 3D effect.
CategoryItemRendererStateinitialise(Graphics2D g2, Rectangle2D dataArea, CategoryPlot plot, int rendererIndex, PlotRenderingInfo info)
Initialises the renderer and returns a state object that will be passed to subsequent calls to the drawItem method.
voidsetWallPaint(Paint paint)
Sets the paint used to hightlight the left and bottom walls in the plot background, and sends a RendererChangeEvent to all registered listeners.

Field Detail

DEFAULT_WALL_PAINT

public static final Paint DEFAULT_WALL_PAINT
The default wall paint.

DEFAULT_X_OFFSET

public static final double DEFAULT_X_OFFSET
The default x-offset for the 3D effect.

DEFAULT_Y_OFFSET

public static final double DEFAULT_Y_OFFSET
The default y-offset for the 3D effect.

Constructor Detail

BarRenderer3D

public BarRenderer3D()
Default constructor, creates a renderer with a default '3D effect'.

BarRenderer3D

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

Method Detail

drawBackground

public void drawBackground(Graphics2D g2, CategoryPlot plot, Rectangle2D dataArea)
Draws the background for the plot.

Parameters: g2 the graphics device. plot the plot. dataArea the area inside the axes.

drawDomainGridline

public void drawDomainGridline(Graphics2D g2, CategoryPlot plot, Rectangle2D dataArea, double value)
Draws a grid line against the domain axis.

Parameters: g2 the graphics device. plot the plot. dataArea the area for plotting data (not yet adjusted for any 3D effect). value the Java2D value at which the grid line should be drawn.

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 3D bar to represent one data item.

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

drawOutline

public void drawOutline(Graphics2D g2, CategoryPlot plot, Rectangle2D dataArea)
Draws the outline for the plot.

Parameters: g2 the graphics device. plot the plot. dataArea the area inside the axes.

drawRangeGridline

public void drawRangeGridline(Graphics2D g2, CategoryPlot plot, ValueAxis axis, Rectangle2D dataArea, double value)
Draws a grid line against the range axis.

Parameters: g2 the graphics device. plot the plot. axis the value axis. dataArea the area for plotting data (not yet adjusted for any 3D effect). value the value at which the grid line should be drawn.

drawRangeLine

public void drawRangeLine(Graphics2D g2, CategoryPlot plot, ValueAxis axis, Rectangle2D dataArea, double value, Paint paint, Stroke stroke)
Draws a line perpendicular to the range axis.

Parameters: g2 the graphics device. plot the plot. axis the value axis. dataArea the area for plotting data (not yet adjusted for any 3D effect). value the value at which the grid line should be drawn. paint the paint. stroke the stroke.

Since: 1.0.13

See Also: BarRenderer3D

drawRangeMarker

public void drawRangeMarker(Graphics2D g2, CategoryPlot plot, ValueAxis axis, Marker marker, Rectangle2D dataArea)
Draws a range marker.

Parameters: g2 the graphics device. plot the plot. axis the value axis. marker the marker. dataArea the area for plotting data (not including 3D effect).

equals

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

Parameters: obj the object (null permitted).

Returns: A boolean.

getWallPaint

public Paint getWallPaint()
Returns the paint used to highlight the left and bottom wall in the plot background.

Returns: The paint.

See Also: setWallPaint

getXOffset

public double getXOffset()
Returns the x-offset for the 3D effect.

Returns: The 3D effect.

See Also: getYOffset

getYOffset

public double getYOffset()
Returns the y-offset for the 3D effect.

Returns: The 3D effect.

initialise

public CategoryItemRendererState initialise(Graphics2D g2, Rectangle2D dataArea, CategoryPlot plot, int rendererIndex, PlotRenderingInfo info)
Initialises the renderer and returns a state object that will be passed to subsequent calls to the drawItem method. This method gets called once at the start of the process of drawing a chart.

Parameters: g2 the graphics device. dataArea the area in which the data is to be plotted. plot the plot. rendererIndex the renderer index. info collects chart rendering information for return to caller.

Returns: The renderer state.

setWallPaint

public void setWallPaint(Paint paint)
Sets the paint used to hightlight the left and bottom walls in the plot background, and sends a RendererChangeEvent to all registered listeners.

Parameters: paint the paint (null not permitted).

See Also: getWallPaint

Copyright © 2000-2009 by Object Refinery Limited. All Rights Reserved.