org.jfree.chart.renderer
Class HorizontalBarRenderer

java.lang.Object
  |
  +--org.jfree.chart.renderer.AbstractRenderer
        |
        +--org.jfree.chart.renderer.AbstractCategoryItemRenderer
              |
              +--org.jfree.chart.renderer.BarRenderer
                    |
                    +--org.jfree.chart.renderer.HorizontalBarRenderer

All Implemented Interfaces:

CategoryItemRenderer, Renderer, java.io.Serializable

Direct Known Subclasses:

HorizontalBarRenderer3D, HorizontalIntervalBarRenderer, StackedHorizontalBarRenderer

public class HorizontalBarRenderer

extends BarRenderer

implements CategoryItemRenderer, java.io.Serializable

A renderer that handles the drawing of bars for a horizontal bar plot.

For use with the HorizontalCategoryPlot class.

Author:

David Gilbert

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

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

STACKED, STANDARD

Constructor Summary

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

HorizontalBarRenderer(CategoryToolTipGenerator toolTipGenerator)
Creates a new renderer with the specified tooltip generator but no URL generator.

HorizontalBarRenderer(CategoryToolTipGenerator toolTipGenerator, CategoryURLGenerator urlGenerator)
Creates a new renderer with the specified tooltip generator and URL generator.

HorizontalBarRenderer(CategoryURLGenerator urlGenerator)
Creates a new renderer with the specified URL generator but no tooltip generator.

Method Summary

void	drawDomainGridline(java.awt.Graphics2D g2, CategoryPlot plot, java.awt.geom.Rectangle2D dataArea, double value) Draws a grid line against the domain axis.
void	drawItem(java.awt.Graphics2D g2, java.awt.geom.Rectangle2D dataArea, CategoryPlot plot, CategoryAxis domainAxis, ValueAxis rangeAxis, CategoryDataset data, int dataset, int row, int column) Draws the bar for a single (series, category) data item.
void	drawRangeGridline(java.awt.Graphics2D g2, CategoryPlot plot, ValueAxis axis, java.awt.geom.Rectangle2D dataArea, double value) Draws a grid line against the range axis.
void	drawRangeMarker(java.awt.Graphics2D g2, CategoryPlot plot, ValueAxis axis, Marker marker, java.awt.geom.Rectangle2D dataArea) Draws a vertical line across the chart to represent the marker.
void	initialise(java.awt.Graphics2D g2, java.awt.geom.Rectangle2D dataArea, CategoryPlot plot, ChartRenderingInfo info) Initialises the renderer.

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

getBarWidth, getItemMargin, getLowerClip, getUpperClip, getZeroInJava2D, setBarWidth, setItemMargin

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

drawBackground, drawOutline, equals, getColumnCount, getLegendItem, getRangeType, getRowCount, getToolTipGenerator, getURLGenerator, setToolTipGenerator, setURLGenerator

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

addPropertyChangeListener, createTransformedShape, firePropertyChanged, getDefaultOutlinePaint, getDefaultOutlineStroke, getDefaultPaint, getDefaultShape, getDefaultStroke, getDrawingSupplier, getInfo, getItemOutlinePaint, getItemOutlineStroke, getItemPaint, getItemShape, getItemStroke, getPlot, getSeriesOutlinePaint, getSeriesOutlineStroke, getSeriesPaint, getSeriesShape, getSeriesStroke, isOutlinePaintTableActive, isOutlineStrokeTableActive, isPaintTableActive, isShapeTableActive, isStrokeTableActive, removePropertyChangeListener, setDefaultOutlinePaint, setDefaultOutlineStroke, setDefaultPaint, setDefaultShape, setDefaultStroke, setDrawingSupplier, setInfo, setOutlinePaintTableActive, setOutlineStrokeTableActive, setPaintTableActive, setPlot, setSeriesOutlinePaint, setSeriesOutlinePaint, setSeriesOutlineStroke, setSeriesOutlineStroke, setSeriesPaint, setSeriesPaint, setSeriesShape, setSeriesShape, setSeriesStroke, setSeriesStroke, setShapeTableActive, setStrokeTableActive

Methods inherited from class java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

drawBackground, drawOutline, getItemOutlinePaint, getItemPaint, getItemShape, getItemStroke, getLegendItem, getRangeType, getSeriesOutlinePaint, getSeriesPaint, getSeriesShape, getSeriesStroke, getToolTipGenerator, setToolTipGenerator

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

getDefaultOutlinePaint, getDefaultOutlineStroke, getDefaultPaint, getDefaultShape, getDefaultStroke, getDrawingSupplier, getPlot, isOutlinePaintTableActive, isOutlineStrokeTableActive, isPaintTableActive, isShapeTableActive, isStrokeTableActive, setDefaultOutlinePaint, setDefaultOutlineStroke, setDefaultPaint, setDefaultShape, setDefaultStroke, setDrawingSupplier, setOutlinePaintTableActive, setOutlineStrokeTableActive, setPaintTableActive, setPlot, setSeriesPaint, setSeriesPaint, setSeriesStroke, setSeriesStroke, setShapeTableActive, setStrokeTableActive

Constructor Detail

HorizontalBarRenderer

public HorizontalBarRenderer()

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.

HorizontalBarRenderer

public HorizontalBarRenderer(CategoryToolTipGenerator toolTipGenerator)

Creates a new renderer with the specified tooltip generator but no URL generator.

Parameters:

toolTipGenerator - the tool tip generator.

HorizontalBarRenderer

public HorizontalBarRenderer(CategoryURLGenerator urlGenerator)

Creates a new renderer with the specified URL generator but no tooltip generator.

Parameters:

urlGenerator - the URL generator.

HorizontalBarRenderer

public HorizontalBarRenderer(CategoryToolTipGenerator toolTipGenerator,
                             CategoryURLGenerator urlGenerator)

Creates a new renderer with the specified tooltip generator and URL generator.

Parameters:

toolTipGenerator - the tool tip generator.

urlGenerator - the URL generator.

Method Detail

initialise

public void initialise(java.awt.Graphics2D g2,
                       java.awt.geom.Rectangle2D dataArea,
                       CategoryPlot plot,
                       ChartRenderingInfo info)

Initialises the renderer.

This method gets called once at the start of the process of drawing a chart.

Specified by:

initialise in interface CategoryItemRenderer

Overrides:

initialise in class BarRenderer

Parameters:

g2 - the graphics device.

dataArea - the data area.

plot - the plot.

info - optional information collection.

drawDomainGridline

public void drawDomainGridline(java.awt.Graphics2D g2,
                               CategoryPlot plot,
                               java.awt.geom.Rectangle2D dataArea,
                               double value)

Draws a grid line against the domain axis.

Specified by:

drawDomainGridline in interface CategoryItemRenderer

Overrides:

drawDomainGridline in class AbstractCategoryItemRenderer

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.

drawRangeGridline

public void drawRangeGridline(java.awt.Graphics2D g2,
                              CategoryPlot plot,
                              ValueAxis axis,
                              java.awt.geom.Rectangle2D dataArea,
                              double value)

Draws a grid line against the range axis.

Specified by:

drawRangeGridline in interface CategoryItemRenderer

Overrides:

drawRangeGridline in class AbstractCategoryItemRenderer

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.

drawRangeMarker

public void drawRangeMarker(java.awt.Graphics2D g2,
                            CategoryPlot plot,
                            ValueAxis axis,
                            Marker marker,
                            java.awt.geom.Rectangle2D dataArea)

Draws a vertical line across the chart to represent the marker.

Specified by:

drawRangeMarker in interface CategoryItemRenderer

Overrides:

drawRangeMarker in class AbstractCategoryItemRenderer

Parameters:

g2 - the graphics device.

plot - the plot.

axis - the value axis.

marker - the marker line.

dataArea - the axis data area.

drawItem

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

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

Specified by:

drawItem in interface CategoryItemRenderer

Parameters:

g2 - the graphics device.

dataArea - the data area.

plot - the plot.

domainAxis - the domain axis.

rangeAxis - the range axis.

data - the data.

dataset - the dataset index (zero-based).

row - the row index (zero-based).

column - the column index (zero-based).