Class CategoryItemRendererState
java.lang.Object
org.jfree.chart.renderer.RendererState
org.jfree.chart.renderer.category.CategoryItemRendererState
- Direct Known Subclasses:
CategoryStepRenderer.State
An object that retains temporary state information for a
CategoryItemRenderer.-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate doubleThe bar width.private CategoryCrosshairStateState information for crosshairs in the plot (this is updated by the renderer, but may be passed to several renderers in one chart).private doubleThe series running total.private int[]The array with the indices of the visible series. -
Constructor Summary
ConstructorsConstructorDescriptionCreates a new object for recording temporary state information for a renderer. -
Method Summary
Modifier and TypeMethodDescriptiondoubleReturns the bar width.Returns the crosshair state, if any.doubleReturns the series running total.int[]Returns a copy of the visible series array.intReturns the number of visible series or -1 if no visible series have been specified.intgetVisibleSeriesIndex(int rowIndex) Returns the index of the row relative to the visible rows.voidsetBarWidth(double width) Sets the bar width.voidSets the crosshair state.(package private) voidsetSeriesRunningTotal(double total) Sets the series running total (this method is intended for the use of the renderer only).voidsetVisibleSeriesArray(int[] visibleSeries) Sets an array with the indices of the visible rows.Methods inherited from class org.jfree.chart.renderer.RendererState
getElementHinting, getEntityCollection, getInfo, setElementHinting
-
Field Details
-
barWidth
private double barWidthThe bar width. -
seriesRunningTotal
private double seriesRunningTotalThe series running total. -
visibleSeries
private int[] visibleSeriesThe array with the indices of the visible series. -
crosshairState
State information for crosshairs in the plot (this is updated by the renderer, but may be passed to several renderers in one chart).
-
-
Constructor Details
-
CategoryItemRendererState
Creates a new object for recording temporary state information for a renderer.- Parameters:
info- the plot rendering info (nullpermitted).
-
-
Method Details
-
getBarWidth
public double getBarWidth()Returns the bar width.- Returns:
- The bar width.
- See Also:
-
setBarWidth
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:
-
getSeriesRunningTotal
public double getSeriesRunningTotal()Returns the series running total.- Returns:
- The running total.
- See Also:
-
setSeriesRunningTotal
void setSeriesRunningTotal(double total) Sets the series running total (this method is intended for the use of the renderer only).- Parameters:
total- the new total.- See Also:
-
getCrosshairState
Returns the crosshair state, if any.- Returns:
- The crosshair state (possibly
null). - See Also:
-
setCrosshairState
Sets the crosshair state.- Parameters:
state- the new state (nullpermitted).- See Also:
-
getVisibleSeriesIndex
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.
-
getVisibleSeriesCount
public int getVisibleSeriesCount()Returns the number of visible series or -1 if no visible series have been specified.- Returns:
- The number or -1.
-
getVisibleSeriesArray
public int[] getVisibleSeriesArray()Returns a copy of the visible series array.- Returns:
- The visible series array (possibly
null).
-
setVisibleSeriesArray
public void setVisibleSeriesArray(int[] visibleSeries) Sets an array with the indices of the visible rows.- Parameters:
visibleSeries- the array (nullpermitted).
-