com.ijchart.xychart.render.category
Class WaterfallBarRender

java.lang.Object
  extended by com.ijchart.xychart.render.AbstractRender
      extended by com.ijchart.xychart.render.AbstractWithAxisRender
          extended by com.ijchart.xychart.render.category.AbstractCategoryRender
              extended by com.ijchart.xychart.render.category.WaterfallBarRender
All Implemented Interfaces:
IDatasetChangeListener, IRender, IRenderWithAxis, java.io.Serializable, java.lang.Cloneable, java.util.EventListener

public class WaterfallBarRender
extends AbstractCategoryRender
implements java.lang.Cloneable, java.io.Serializable

Title: IJChart

Description: a chart library for the Java(tm) platform.

Draw waterfall bar shapes.

Copyright: Copyright (c) 2013

Company:

Version:
1.0
Author:
zhang feng min,shanghai china. Contract me by email.
See Also:
Serialized Form

Field Summary
static java.awt.Paint DEFAULT_FIRST_BAR_PAINT
           The default paint used to draw the first bar.
static java.awt.Paint DEFAULT_LAST_BAR_PAINT
           The default paint used to draw the last bar.
static java.awt.Paint DEFAULT_NEGATIVE_BAR_PAINT
           The default paint used to draw bars having negative values.
static java.awt.Paint DEFAULT_POSITIVE_BAR_PAINT
           The default paint used to draw bars having positive values.
 
Fields inherited from class com.ijchart.xychart.render.category.AbstractCategoryRender
DEFAULT_BASE_VALUE, DEFAULT_ITEM_MARGIN, DEFAULT_MAXIMUM_BAR_WIDTH, DEFAULT_MINIMUM_BAR_WIDTH
 
Fields inherited from class com.ijchart.xychart.render.AbstractRender
borderPaints, borderStrokes, DEFAULT_AUTO_SELECT_BORDER_PAINT, DEFAULT_AUTO_SELECT_BORDER_STROKE, DEFAULT_AUTO_SELECT_FILL_PAINT, DEFAULT_BACKGROUND_IMAGE_ALIGNMENT, DEFAULT_BACKGROUND_PAINT, DEFAULT_BASE_BORDER_PAINT, DEFAULT_BASE_BORDER_STROKE, DEFAULT_BASE_ITEM_FILL, DEFAULT_BASE_ITEM_FILL_PAINT, DEFAULT_BASE_ITEM_FILL_PAINT_TRANSFORMER, DEFAULT_BASE_ITEM_LABEL_FONT, DEFAULT_BASE_ITEM_LABEL_HORIZONTAL_ALIGNMENT, DEFAULT_BASE_ITEM_LABEL_PAINT, DEFAULT_BASE_ITEM_LABEL_VERTICAL_ALIGNMENT, DEFAULT_BASE_ITEM_LABEL_VISIBLE, DEFAULT_BORDER_PAINT, DEFAULT_BORDER_STROKE, DEFAULT_DRAW_BORDER, DEFAULT_DRAWINT_SUPPLIER, DEFAULT_GENERATOR_TOOLTIP, DEFAULT_GENERATOR_URL, DEFAULT_LABEL_GENERATOR, DEFAULT_RENDER_AREA_BORDER_VISIBLE, DEFAULT_TOOLTIP_GENERATOR, fillPaints
 
Constructor Summary
WaterfallBarRender(IMatrixDataset dataset)
           constructor.
WaterfallBarRender(IMatrixDataset dataset, java.awt.Paint firstBarPaint, java.awt.Paint positiveBarPaint, java.awt.Paint negativeBarPaint, java.awt.Paint lastBarPaint)
           constructor.
 
Method Summary
 java.lang.Object clone()
           Creates and returns a copy of this object.
 void drawAllItems(CategoryAxis categoryAxis, AbstractValueAxis valueAxis, RectangleEdge valueAxisEdge, java.awt.geom.Rectangle2D dataArea, ChartOrientation orientation, RenderShapeCollection renderShapes, float alpha)
           Draws all data items.
 boolean equals(java.lang.Object obj)
           Tests this instance for equality with an arbitrary object.
 java.awt.Paint getFirstBarPaint()
           Returns the paint used to draw the first bar.
protected  java.awt.Paint getItemFillPaintHelper(java.awt.Paint autoFillPaint, int row, int column)
           Helper method for returns the fill paint.
 java.awt.Paint getLastBarPaint()
           Returns the paint used to draw the last bar.
 LegendType getLegendType()
           Return the legend type.
 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.
 int hashCode()
           Returns a hash code value for the object.
 void setFirstBarPaint(java.awt.Paint paint)
           Sets the paint that will be used to draw the first bar and sends a RenderChangeEvent to all registered listeners.
 void setLastBarPaint(java.awt.Paint paint)
           Sets the paint that will be used to draw the last bar and sends a RenderChangeEvent to all registered listeners.
 void setNegativeBarPaint(java.awt.Paint paint)
           Sets the paint that will be used to draw bars with positive values and sends a RenderChangeEvent to all registered listeners.
 void setPositiveBarPaint(java.awt.Paint paint)
           Sets the paint that will be used to draw bars with positive values and sends a RenderChangeEvent to all registered listeners.
 java.lang.String toString()
           Returns a string representation of the object.
 
Methods inherited from class com.ijchart.xychart.render.category.AbstractCategoryRender
addAnnotation, createCategoryMarkerShape, drawAllAnnotation, drawCategoryMarker, getAllAnnotations, getBaseValue, getItemMargin, getMaximumBarWidth, getMinimumBarWidth, removeAllAnnotation, setBaseValue, setItemMargin, setMaximumBarWidth, setMinimumBarWidth
 
Methods inherited from class com.ijchart.xychart.render.AbstractWithAxisRender
createItemShape, createValueMarkerShape, drawIntervalValueMarker, drawValueMarker, getValueAxisOffsetType
 
Methods inherited from class com.ijchart.xychart.render.AbstractRender
add3DShapes, addChangeListener, calculateLegendItemShapes, createItemShapeOnly, datasetChanged, drawBackground, drawBackgroundImage, drawDrawAreaBorder, fireRenderChanged, getBackgroundImage, getBackgroundImageAlignment, getBackgroundImageAlpha, getBackgroundPaint, getBaseItemBorderPaint, getBaseItemBorderStroke, getBaseItemFillPaint, getBaseItemFillPaintTransformer, getBaseItemLabelDirection, getBaseItemLabelFont, getBaseItemLabelHorizontalAlignment, getBaseItemLabelPaint, getBaseItemLabelPosition, getBaseItemLabelVerticalAlignment, getBaseItemLabelVisible, getBorderPaints, getBorderStrokes, getChartArea, getColumnItemBorderPaint, getColumnItemBorderStroke, getColumnItemFillPaint, getColumnItemFillPaintTransformer, getColumnItemLabelDirection, getColumnItemLabelFont, getColumnItemLabelHorizontalAlignment, getColumnItemLabelPaint, getColumnItemLabelPosition, getColumnItemLabelVerticalAlignment, getDataset, getDrawingSupplier, getFillPaints, getItemBorderPaint, getItemBorderStroke, getItemFillPaint, getItemFillPaintTransformer, getItemLabelDirection, getItemLabelFont, getItemLabelHorizontalAlignment, getItemLabelPaint, getItemLabelPosition, getItemLabelVerticalAlignment, getLabelGenerator, getLegendItemCount, getLegendItemLabels, getLegendItemLabelsByColumn, getLegendItemLabelsByRow, getLegendItemShapes, getLegendPositon, getNegativeItemLabelHorizontalAlignment, getNegativeItemLabelVerticalAlignment, getPositiveItemLabelHorizontalAlignment, getPositiveItemLabelVerticalAlignment, getRenderAreaBorderPaint, getRenderAreaBorderStroke, getRowItemBorderPaint, getRowItemBorderStroke, getRowItemFillPaint, getRowItemFillPaintTransformer, getRowItemLabelDirection, getRowItemLabelFont, getRowItemLabelHorizontalAlignment, getRowItemLabelPaint, getRowItemLabelPosition, getRowItemLabelVerticalAlignment, getToolTipGenerator, hasListener, isAutoSelectBorderPaint, isAutoSelectBorderStroke, isAutoSelectFillPaint, isBaseItemDrawBorder, isBaseItemFill, isColumnItemDrawBorder, isColumnItemFill, isColumnItemLabelVisible, isColumnItemVisible, isGeneratorTooltip, isGeneratorUrl, isItemDrawBorder, isItemFill, isItemLabelVisible, isItemVisible, isRenderAreaBorderVisible, isRowItemDrawBorder, isRowItemFill, isRowItemLabelVisible, isRowItemVisible, notifyListeners, removeAllChangeListener, removeChangeListener, setAutoSelectBorderPaint, setAutoSelectBorderStroke, setAutoSelectFillPaint, setBackgroundImage, setBackgroundImageAlignment, setBackgroundImageAlpha, setBackgroundPaint, setBaseItemBorderPaint, setBaseItemBorderStroke, setBaseItemDrawBorder, setBaseItemFill, setBaseItemFillPaint, setBaseItemFillPaintTransformer, setBaseItemLabelDirection, setBaseItemLabelFont, setBaseItemLabelHorizontalAlignment, setBaseItemLabelPaint, setBaseItemLabelPosition, setBaseItemLabelVerticalAlignment, setBaseItemLabelVisible, setChartArea, setColumnItemBorderPaint, setColumnItemBorderStroke, setColumnItemDrawBorder, setColumnItemFill, setColumnItemFillPaint, setColumnItemFillPaintTransformer, setColumnItemLabelDirection, setColumnItemLabelFont, setColumnItemLabelHorizontalAlignment, setColumnItemLabelPaint, setColumnItemLabelPosition, setColumnItemLabelVerticalAlignment, setColumnItemLabelVisible, setColumnItemVisible, setCustomLegendType, setDataset, setDrawingSupplier, setDrawingSupplier, setGeneratorTooltip, setGeneratorUrl, setItemBorderPaint, setItemBorderStroke, setItemDrawBorder, setItemFill, setItemFillPaint, setItemFillPaintTransformer, setItemLabelDirection, setItemLabelFont, setItemLabelHorizontalAlignment, setItemLabelPaint, setItemLabelPosition, setItemLabelVerticalAlignment, setItemLabelVisible, setItemVisible, setLabelGenerator, setLegendPositon, setNegativeItemLabelHorizontalAlignment, setNegativeItemLabelVerticalAlignment, setPositiveItemLabelHorizontalAlignment, setPositiveItemLabelVerticalAlignment, setRenderAreaBorderPaint, setRenderAreaBorderStroke, setRenderAreaBorderVisible, setRowItemBorderPaint, setRowItemBorderStroke, setRowItemDrawBorder, setRowItemFill, setRowItemFillPaint, setRowItemFillPaintTransformer, setRowItemLabelDirection, setRowItemLabelFont, setRowItemLabelHorizontalAlignment, setRowItemLabelPaint, setRowItemLabelPosition, setRowItemLabelVerticalAlignment, setRowItemLabelVisible, setRowItemVisible, setToolTipGenerator
 
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface com.ijchart.xychart.render.IRender
addChangeListener, drawBackground, drawBackgroundImage, drawDrawAreaBorder, getBaseItemBorderPaint, getBaseItemBorderStroke, getBaseItemFillPaint, getBaseItemFillPaintTransformer, getBaseItemLabelFont, getBaseItemLabelHorizontalAlignment, getBaseItemLabelPaint, getBaseItemLabelPosition, getBaseItemLabelVerticalAlignment, getBaseItemLabelVisible, getColumnItemBorderPaint, getColumnItemBorderStroke, getColumnItemFillPaint, getColumnItemFillPaintTransformer, getColumnItemLabelFont, getColumnItemLabelHorizontalAlignment, getColumnItemLabelPaint, getColumnItemLabelPosition, getColumnItemLabelVerticalAlignment, getItemBorderPaint, getItemBorderStroke, getItemFillPaint, getItemFillPaintTransformer, getItemLabelFont, getItemLabelHorizontalAlignment, getItemLabelPaint, getItemLabelPosition, getItemLabelVerticalAlignment, getLabelGenerator, getNegativeItemLabelHorizontalAlignment, getNegativeItemLabelVerticalAlignment, getPositiveItemLabelHorizontalAlignment, getPositiveItemLabelVerticalAlignment, getRowItemBorderPaint, getRowItemBorderStroke, getRowItemFillPaint, getRowItemFillPaintTransformer, getRowItemLabelFont, getRowItemLabelHorizontalAlignment, getRowItemLabelPaint, getRowItemLabelPosition, getRowItemLabelVerticalAlignment, getToolTipGenerator, isBaseItemDrawBorder, isBaseItemFill, isColumnItemDrawBorder, isColumnItemFill, isColumnItemLabelVisible, isColumnItemVisible, isItemDrawBorder, isItemFill, isItemLabelVisible, isItemVisible, isRowItemDrawBorder, isRowItemFill, isRowItemLabelVisible, isRowItemVisible, removeAllChangeListener, removeChangeListener, setBaseItemBorderPaint, setBaseItemBorderStroke, setBaseItemDrawBorder, setBaseItemFill, setBaseItemFillPaint, setBaseItemFillPaintTransformer, setBaseItemLabelFont, setBaseItemLabelHorizontalAlignment, setBaseItemLabelPaint, setBaseItemLabelPosition, setBaseItemLabelVerticalAlignment, setBaseItemLabelVisible, setColumnItemBorderPaint, setColumnItemBorderStroke, setColumnItemDrawBorder, setColumnItemFill, setColumnItemFillPaint, setColumnItemFillPaintTransformer, setColumnItemLabelFont, setColumnItemLabelHorizontalAlignment, setColumnItemLabelPaint, setColumnItemLabelPosition, setColumnItemLabelVerticalAlignment, setColumnItemLabelVisible, setColumnItemVisible, setCustomLegendType, setItemBorderPaint, setItemBorderStroke, setItemDrawBorder, setItemFill, setItemFillPaint, setItemFillPaintTransformer, setItemLabelFont, setItemLabelHorizontalAlignment, setItemLabelPaint, setItemLabelPosition, setItemLabelVerticalAlignment, setItemLabelVisible, setItemVisible, setLabelGenerator, setNegativeItemLabelHorizontalAlignment, setNegativeItemLabelVerticalAlignment, setPositiveItemLabelHorizontalAlignment, setPositiveItemLabelVerticalAlignment, setRowItemBorderPaint, setRowItemBorderStroke, setRowItemDrawBorder, setRowItemFill, setRowItemFillPaint, setRowItemFillPaintTransformer, setRowItemLabelFont, setRowItemLabelHorizontalAlignment, setRowItemLabelPaint, setRowItemLabelPosition, setRowItemLabelVerticalAlignment, setRowItemLabelVisible, setRowItemVisible, setToolTipGenerator
 

Field Detail

DEFAULT_FIRST_BAR_PAINT

public static final java.awt.Paint DEFAULT_FIRST_BAR_PAINT
The default paint used to draw the first bar.


DEFAULT_LAST_BAR_PAINT

public static final java.awt.Paint DEFAULT_LAST_BAR_PAINT
The default paint used to draw the last bar.


DEFAULT_POSITIVE_BAR_PAINT

public static final java.awt.Paint DEFAULT_POSITIVE_BAR_PAINT
The default paint used to draw bars having positive values.


DEFAULT_NEGATIVE_BAR_PAINT

public static final java.awt.Paint DEFAULT_NEGATIVE_BAR_PAINT
The default paint used to draw bars having negative values.

Constructor Detail

WaterfallBarRender

public WaterfallBarRender(IMatrixDataset dataset)
constructor.

Parameters:
dataset - IMatrixDataset The dataset (null not permitted).

WaterfallBarRender

public WaterfallBarRender(IMatrixDataset dataset,
                          java.awt.Paint firstBarPaint,
                          java.awt.Paint positiveBarPaint,
                          java.awt.Paint negativeBarPaint,
                          java.awt.Paint lastBarPaint)
constructor.

Parameters:
dataset - IMatrixDataset The dataset (null not permitted).
firstBarPaint - Paint The paint used to draw the first bar.
positiveBarPaint - Paint The paint used to draw the last bar.
negativeBarPaint - Paint The paint used to draw bars having positive values.
lastBarPaint - Paint The paint used to draw bars having negative values.
Method Detail

getFirstBarPaint

public java.awt.Paint getFirstBarPaint()
Returns the paint used to draw the first bar.

Returns:
Paint The paint (never null).

setFirstBarPaint

public void setFirstBarPaint(java.awt.Paint paint)
Sets the paint that will be used to draw the first bar and sends a RenderChangeEvent to all registered listeners.

Parameters:
paint - Paint The paint (null not permitted).

getLastBarPaint

public java.awt.Paint getLastBarPaint()
Returns the paint used to draw the last bar.

Returns:
Paint The paint (never null).

setLastBarPaint

public void setLastBarPaint(java.awt.Paint paint)
Sets the paint that will be used to draw the last bar and sends a RenderChangeEvent to all registered listeners.

Parameters:
paint - Paint The paint (null not permitted).

getPositiveBarPaint

public java.awt.Paint getPositiveBarPaint()
Returns the paint used to draw bars with positive values.

Returns:
Paint The paint (never null).

setPositiveBarPaint

public void setPositiveBarPaint(java.awt.Paint paint)
Sets the paint that will be used to draw bars with positive values and sends a RenderChangeEvent to all registered listeners.

Parameters:
paint - Paint The paint (null not permitted).

getNegativeBarPaint

public java.awt.Paint getNegativeBarPaint()
Returns the paint used to draw bars with negative values.

Returns:
Paint The paint (never null).

setNegativeBarPaint

public void setNegativeBarPaint(java.awt.Paint paint)
Sets the paint that will be used to draw bars with positive values and sends a RenderChangeEvent to all registered listeners.

Parameters:
paint - Paint The paint (null not permitted).

drawAllItems

public void drawAllItems(CategoryAxis categoryAxis,
                         AbstractValueAxis valueAxis,
                         RectangleEdge valueAxisEdge,
                         java.awt.geom.Rectangle2D dataArea,
                         ChartOrientation orientation,
                         RenderShapeCollection renderShapes,
                         float alpha)
Draws all data items.

Specified by:
drawAllItems in class AbstractCategoryRender
Parameters:
categoryAxis - CategoryAxis The category axis (null not permitted).
valueAxis - AbstractValueAxis The value axis (null not permitted).
valueAxisEdge - RectangleEdge The value axis edge (null not permitted).
dataArea - Rectangle2D The chart data area (null not permitted).
orientation - ChartOrientation The chart orientation (null not permitted).
renderShapes - RenderShapeCollection Collects information about the render (null not permitted).
alpha - float The alpha transparency (in the range 0.0f to 1.0f, where 0.0f is fully transparent, and 1.0f is fully opaque).

getItemFillPaintHelper

protected java.awt.Paint getItemFillPaintHelper(java.awt.Paint autoFillPaint,
                                                int row,
                                                int column)
Helper method for returns the fill paint.

Overrides:
getItemFillPaintHelper in class AbstractRender
Parameters:
autoFillPaint - Paint The auto selected fill paint.
row - int The dataset row number.
column - int The dataset column number.
Returns:
Paint The paint (never null).

getLegendType

public LegendType getLegendType()
Return the legend type.

Specified by:
getLegendType in interface IRender
Overrides:
getLegendType in class AbstractRender
Returns:
LegendType The legend type.

equals

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

Overrides:
equals in class AbstractCategoryRender
Parameters:
obj - the object (null permitted).
Returns:
A boolean.

hashCode

public int hashCode()
Returns a hash code value for the object.

Overrides:
hashCode in class AbstractCategoryRender
Returns:
int A hash code value for this object.

clone

public java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException
Creates and returns a copy of this object.

Overrides:
clone in class AbstractCategoryRender
Returns:
object a clone of this instance.
Throws:
java.lang.CloneNotSupportedException - if the object's class does not support the Cloneable interface. Subclasses that override the clone method can also throw this exception to indicate that an instance cannot be cloned.

toString

public java.lang.String toString()
Returns a string representation of the object.

Overrides:
toString in class AbstractCategoryRender
Returns:
a string representation of the object.