org.jfree.chart.renderer
Class WaterfallBarRenderer

java.lang.Object
  org.jfree.chart.renderer.AbstractRenderer
      org.jfree.chart.renderer.AbstractCategoryItemRenderer
          org.jfree.chart.renderer.BarRenderer
              org.jfree.chart.renderer.WaterfallBarRenderer

All Implemented Interfaces:

CategoryItemRenderer, java.lang.Cloneable, org.jfree.util.PublicCloneable, java.io.Serializable

public class WaterfallBarRenderer

extends BarRenderer

implements java.lang.Cloneable, org.jfree.util.PublicCloneable, java.io.Serializable

A renderer that handles the drawing of waterfall bar charts, for use with the CategoryPlot class.

See Also:

Serialized Form

Field Summary

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

BAR_OUTLINE_WIDTH_THRESHOLD, DEFAULT_ITEM_MARGIN

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

DEFAULT_OUTLINE_PAINT, DEFAULT_OUTLINE_STROKE, DEFAULT_PAINT, DEFAULT_SHAPE, DEFAULT_STROKE, DEFAULT_VALUE_LABEL_FONT, DEFAULT_VALUE_LABEL_PAINT, ZERO

Constructor Summary

WaterfallBarRenderer()
Constructs a new renderer with default values for the bar colors.

WaterfallBarRenderer(java.awt.Paint firstBarPaint, java.awt.Paint positiveBarPaint, java.awt.Paint negativeBarPaint, java.awt.Paint lastBarPaint)
Constructs a new waterfall renderer.

Method Summary

void	drawItem(java.awt.Graphics2D g2, CategoryItemRendererState state, java.awt.geom.Rectangle2D dataArea, CategoryPlot plot, CategoryAxis domainAxis, ValueAxis rangeAxis, CategoryDataset dataset, int row, int column) Draws the bar for a single (series, category) data item.
boolean	equals(java.lang.Object object) Tests an object for equality with this instance.
java.awt.Paint	getFirstBarPaint() Returns the paint used to draw the first bar.
java.awt.Paint	getLastBarPaint() Returns the paint used to draw the last bar.
java.awt.Paint	getNegativeBarPaint() Returns the paint used to draw bars with negative values.
java.awt.Paint	getPositiveBarPaint() Returns the paint used to draw bars with positive values.
RangeType	getRangeType() Returns the range type.
void	setFirstBarPaint(java.awt.Paint paint) Sets the paint that will be used to draw the first bar.
void	setLastBarPaint(java.awt.Paint paint) Sets the paint that will be used to draw the last bar.
void	setNegativeBarPaint(java.awt.Paint paint) Sets the paint that will be used to draw bars having negative values.
void	setPositiveBarPaint(java.awt.Paint paint) Sets the paint that will be used to draw bars having positive values.

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

calculateBarL0L1, calculateBarW0, calculateBarWidth, calculateSeriesWidth, drawItemLabel, getGradientPaintTransformer, getItemMargin, getLowerClip, getMaxBarWidth, getMinimumBarLength, getNegativeItemLabelPositionFallback, getPositiveItemLabelPositionFallback, getUpperClip, initialise, isDrawBarOutline, setDrawBarOutline, setGradientPaintTransformer, setItemMargin, setMaxBarWidth, setMinimumBarLength, setNegativeItemLabelPositionFallback, setPositiveItemLabelPositionFallback

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

clone, drawBackground, drawDomainGridline, drawItemLabel, drawOutline, drawRangeGridline, drawRangeMarker, getBaseItemLabelGenerator, getBaseItemURLGenerator, getColumnCount, getDataset, getDomainAxis, getDrawingSupplier, getItemLabelAnchorOffset, getItemLabelGenerator, getItemURLGenerator, getLegendItem, getPlot, getRangeAxis, getRowCount, getSeriesItemLabelGenerator, getSeriesItemURLGenerator, hashCode, setBaseItemLabelGenerator, setBaseItemURLGenerator, setItemLabelAnchorOffset, setItemLabelGenerator, setItemURLGenerator, setPlot, setSeriesItemLabelGenerator, setSeriesItemURLGenerator

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

addChangeListener, addPropertyChangeListener, createTransformedShape, firePropertyChanged, getBaseItemLabelAnchor, getBaseItemLabelAngle, getBaseItemLabelFont, getBaseItemLabelPaint, getBaseItemLabelRotationAnchor, getBaseItemLabelsVisible, getBaseItemLabelTextAnchor, getBaseNegativeItemLabelPosition, getBaseOutlinePaint, getBaseOutlineStroke, getBasePaint, getBasePositiveItemLabelPosition, getBaseShape, getBaseStroke, getItemLabelAnchor, getItemLabelAngle, getItemLabelFont, getItemLabelPaint, getItemLabelRotationAnchor, getItemLabelTextAnchor, getItemOutlinePaint, getItemOutlineStroke, getItemPaint, getItemShape, getItemStroke, getNegativeItemLabelPosition, getNegativeItemLabelPosition, getPositiveItemLabelPosition, getPositiveItemLabelPosition, getSeriesItemLabelAnchor, getSeriesItemLabelAngle, getSeriesItemLabelFont, getSeriesItemLabelPaint, getSeriesItemLabelRotationAnchor, getSeriesItemLabelTextAnchor, getSeriesNegativeItemLabelPosition, getSeriesOutlinePaint, getSeriesOutlineStroke, getSeriesPaint, getSeriesPositiveItemLabelPosition, getSeriesShape, getSeriesStroke, isItemLabelVisible, isSeriesItemLabelsVisible, notifyListeners, removeChangeListener, removePropertyChangeListener, setBaseAngle, setBaseItemLabelAnchor, setBaseItemLabelFont, setBaseItemLabelFont, setBaseItemLabelPaint, setBaseItemLabelPaint, setBaseItemLabelRotationAnchor, setBaseItemLabelsVisible, setBaseItemLabelsVisible, setBaseItemLabelTextAnchor, setBaseNegativeItemLabelPosition, setBaseNegativeItemLabelPosition, setBaseOutlinePaint, setBaseOutlinePaint, setBaseOutlineStroke, setBaseOutlineStroke, setBasePaint, setBasePaint, setBasePositiveItemLabelPosition, setBasePositiveItemLabelPosition, setBaseShape, setBaseShape, setBaseStroke, setBaseStroke, setItemLabelAnchor, setItemLabelAngle, setItemLabelFont, setItemLabelFont, setItemLabelPaint, setItemLabelPaint, setItemLabelRotationAnchor, setItemLabelsVisible, setItemLabelsVisible, setItemLabelsVisible, setItemLabelTextAnchor, setNegativeItemLabelPosition, setNegativeItemLabelPosition, setOutlinePaint, setOutlinePaint, setOutlineStroke, setOutlineStroke, setPaint, setPaint, setPositiveItemLabelPosition, setPositiveItemLabelPosition, setSeriesAngle, setSeriesItemLabelAnchor, setSeriesItemLabelFont, setSeriesItemLabelFont, setSeriesItemLabelPaint, setSeriesItemLabelPaint, setSeriesItemLabelRotationAnchor, setSeriesItemLabelsVisible, setSeriesItemLabelsVisible, setSeriesItemLabelTextAnchor, setSeriesNegativeItemLabelPosition, setSeriesNegativeItemLabelPosition, setSeriesOutlinePaint, setSeriesOutlinePaint, setSeriesOutlineStroke, setSeriesOutlineStroke, setSeriesPaint, setSeriesPaint, setSeriesPositiveItemLabelPosition, setSeriesPositiveItemLabelPosition, setSeriesShape, setSeriesShape, setSeriesStroke, setSeriesStroke, setShape, setShape, setStroke, setStroke

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.jfree.util.PublicCloneable

clone

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

addChangeListener, getBaseItemLabelAnchor, getBaseItemLabelFont, getBaseItemLabelTextAnchor, getBaseOutlinePaint, getBaseOutlineStroke, getBasePaint, getBaseShape, getBaseStroke, getItemLabelAnchor, getItemLabelFont, getItemLabelTextAnchor, getItemOutlinePaint, getItemOutlineStroke, getItemPaint, getItemShape, getItemStroke, getNegativeItemLabelPosition, getPositiveItemLabelPosition, getSeriesItemLabelAnchor, getSeriesItemLabelFont, getSeriesItemLabelTextAnchor, getSeriesOutlinePaint, getSeriesOutlineStroke, getSeriesPaint, getSeriesShape, getSeriesStroke, removeChangeListener, setBaseItemLabelAnchor, setBaseItemLabelFont, setBaseItemLabelTextAnchor, setBaseOutlinePaint, setBaseOutlineStroke, setBasePaint, setBaseShape, setBaseStroke, setItemLabelAnchor, setItemLabelFont, setItemLabelsVisible, setItemLabelsVisible, setItemLabelTextAnchor, setNegativeItemLabelPosition, setOutlinePaint, setOutlineStroke, setPositiveItemLabelPosition, setSeriesItemLabelAnchor, setSeriesItemLabelFont, setSeriesItemLabelTextAnchor, setSeriesOutlinePaint, setSeriesOutlineStroke, setSeriesPaint, setSeriesShape, setSeriesStroke, setStroke

Constructor Detail

WaterfallBarRenderer

public WaterfallBarRenderer()

Constructs a new renderer with default values for the bar colors.

WaterfallBarRenderer

public WaterfallBarRenderer(java.awt.Paint firstBarPaint,
                            java.awt.Paint positiveBarPaint,
                            java.awt.Paint negativeBarPaint,
                            java.awt.Paint lastBarPaint)

Constructs a new waterfall renderer.

Parameters:

firstBarPaint - the color of the first bar.

positiveBarPaint - the color for bars with positive values.

negativeBarPaint - the color for bars with negative values.

lastBarPaint - the color of the last bar.

Method Detail

getRangeType

public RangeType getRangeType()

Returns the range type.

Specified by:

getRangeType in interface CategoryItemRenderer

Overrides:

getRangeType in class AbstractCategoryItemRenderer

Returns:

The range type.

getFirstBarPaint

public java.awt.Paint getFirstBarPaint()

Returns the paint used to draw the first bar.

Returns:

The paint.

setFirstBarPaint

public void setFirstBarPaint(java.awt.Paint paint)

Sets the paint that will be used to draw the first bar.

Parameters:

paint - the paint.

getLastBarPaint

public java.awt.Paint getLastBarPaint()

Returns the paint used to draw the last bar.

Returns:

The paint.

setLastBarPaint

public void setLastBarPaint(java.awt.Paint paint)

Sets the paint that will be used to draw the last bar.

Parameters:

paint - the paint.

getPositiveBarPaint

public java.awt.Paint getPositiveBarPaint()

Returns the paint used to draw bars with positive values.

Returns:

The paint.

setPositiveBarPaint

public void setPositiveBarPaint(java.awt.Paint paint)

Sets the paint that will be used to draw bars having positive values.

Parameters:

paint - the paint.

getNegativeBarPaint

public java.awt.Paint getNegativeBarPaint()

Returns the paint used to draw bars with negative values.

Returns:

The paint.

setNegativeBarPaint

public void setNegativeBarPaint(java.awt.Paint paint)

Sets the paint that will be used to draw bars having negative values.

Parameters:

paint - the paint.

drawItem

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

Draws the bar for a single (series, category) data item.

Specified by:

drawItem in interface CategoryItemRenderer

Overrides:

drawItem in class BarRenderer

Parameters:

g2 - the graphics device.

state - the renderer state.

dataArea - the data area.

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

equals

public boolean equals(java.lang.Object object)

Tests an object for equality with this instance.

Overrides:

equals in class BarRenderer

Parameters:

object - the object.

Returns:

A boolean.