public class

CategoryItemRendererState

extends RendererState
java.lang.Object
   ↳ org.jfree.chart.renderer.RendererState
     ↳ org.jfree.chart.renderer.category.CategoryItemRendererState
Known Direct Subclasses

Class Overview

An object that retains temporary state information for a CategoryItemRenderer.

Summary

Public Constructors
CategoryItemRendererState(PlotRenderingInfo info)
Creates a new object for recording temporary state information for a renderer.
Public Methods
double getBarWidth()
Returns the bar width.
CategoryCrosshairState getCrosshairState()
Returns the crosshair state, if any.
double getSeriesRunningTotal()
Returns the series running total.
int[] getVisibleSeriesArray()
Returns a copy of the visible series array.
int getVisibleSeriesCount()
Returns the number of visible series or -1 if no visible series have been specified.
int getVisibleSeriesIndex(int rowIndex)
Returns the index of the row relative to the visible rows.
void setBarWidth(double width)
Sets the bar width.
void setCrosshairState(CategoryCrosshairState state)
Sets the crosshair state.
void setVisibleSeriesArray(int[] visibleSeries)
Sets an array with the indices of the visible rows.
[Expand]
Inherited Methods
From class org.jfree.chart.renderer.RendererState
From class java.lang.Object

Public Constructors

public CategoryItemRendererState (PlotRenderingInfo info)

Creates a new object for recording temporary state information for a renderer.

Parameters
info the plot rendering info (null permitted).

Public Methods

public double getBarWidth ()

Returns the bar width.

Returns
  • The bar width.
See Also

public CategoryCrosshairState getCrosshairState ()

Returns the crosshair state, if any.

Returns
  • The crosshair state (possibly null).
See Also

public double getSeriesRunningTotal ()

Returns the series running total.

Returns
  • The running total.
See Also
  • #setSeriesRunningTotal(double)

public int[] getVisibleSeriesArray ()

Returns a copy of the visible series array.

Returns
  • The visible series array (possibly null).

public int getVisibleSeriesCount ()

Returns the number of visible series or -1 if no visible series have been specified.

Returns
  • The number or -1.

public int getVisibleSeriesIndex (int rowIndex)

Returns the index of the row relative to the visible rows. If no visible rows have been specified, the original row index is returned. If the row index is not included in the array of visible rows, -1 is returned.

Parameters
rowIndex the row index.
Returns
  • The new row index or -1.

public void setBarWidth (double width)

Sets the bar width. The renderer calculates this value and stores it here - it is not intended that users can manually set the bar width.

Parameters
width the width.
See Also

public void setCrosshairState (CategoryCrosshairState state)

Sets the crosshair state.

Parameters
state the new state (null permitted).
See Also

public void setVisibleSeriesArray (int[] visibleSeries)

Sets an array with the indices of the visible rows.

Parameters
visibleSeries the array (null permitted).