ilog.views.chart.renderer

Class IlvSinglePieRenderer

java.lang.Object

ilog.views.chart.IlvChartRenderer

ilog.views.chart.renderer.IlvSingleChartRenderer

ilog.views.chart.renderer.IlvSinglePieRenderer

All Implemented Interfaces:

IlvChartAreaAccessible, IlvChart3DSupport, Serializable

public class IlvSinglePieRenderer
extends IlvSingleChartRenderer

Renders a data set with a pie chart. The IlvSinglePieRenderer instances are used by the IlvPieChartRenderer class to display several data sets.

Since:

JViews 5.0

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_EXPLODE_RATIO The default explode ratio for pie slices.

Fields inherited from class ilog.views.chart.IlvChartRenderer

AREA, BAR, BUBBLE, CANDLE, CENTERED_LABEL_LAYOUT, COMBO, DATA_LABEL, DEFAULT_LABEL_LAYOUT, DEFAULT_LABELING, HILO, HILO_ARROW, HILO_STICK, HLOC, OUTSIDE_LABEL_LAYOUT, PERCENT_LABEL, PIE, POLYLINE, SCATTER, STACKED_AREA, STACKED_BAR, STACKED_DIVERGING_BAR, STACKED_POLYLINE, STACKED_STAIR, STACKED100_AREA, STACKED100_BAR, STACKED100_POLYLINE, STACKED100_STAIR, STAIR, SUMMED_STAIR, SUPERIMPOSED_BAR, TREEMAP, X_VALUE_LABEL, XY_VALUES_LABEL, Y_VALUE_LABEL

Constructor Summary

Constructors

Constructor and Description
IlvSinglePieRenderer() Creates a new pie renderer.
IlvSinglePieRenderer(IlvStyle style) Creates a new pie renderer with the specified style.

Method Summary

Modifier and Type	Method and Description
void	applyDataSetStyle(ilog.views.chart.styling.IlvDataSetStyle dataSetStyle) Applies the styles for a data set.
protected void	chartConnected(IlvChart oldChart, IlvChart newChart) Called when the renderer is added to or removed from a chart.
String	computeDataLabel(IlvDataSetPoint dp) Computes the data label associated with the specified point.
Point	computeDataLabelLocation(IlvDisplayPoint dp, Dimension size) Computes the location of the data label associated with the specified point.
IlvLegendItem[]	createLegendItems() Creates the legend items associated with this renderer.
protected void	dataSetsAdded(int firstIdx, int lastIdx, IlvDataSet[] oldDataSets) Called when data sets are connected to this renderer.
protected void	dataSetsRemoved(int firstIdx, int lastIdx, IlvDataSet[] oldDataSets) Called when data sets are disconnected from this renderer.
void	drawLegendSymbol(IlvLegendItem item, Graphics g, int x, int y, int w, int h) Draws the symbol of the specified legend item.
void	drawSelectionHandles(Graphics g, IlvHandlesSelectionStyle style, IlvDataSet dataSet, int index) Draws a data point with selection handles.
int	getExplodeRatio(int dataIdx) Returns the explode ratio of the slice displaying the specified point.
String	getLegendText(IlvLegendItem item) Returns the label of the specified legend item.
double	getPartialSum(int dataIdx) Returns the sum of the y-values of all the data points that are displayed before the specified data point.
Insets	getPreferredMargins() Returns the preferred margins of this renderer for the calculation of the plotting rectangle.
double	getSlicePercent(int dataIdx) Returns the percentage of the specified slice.
IlvStyle	getSliceStyle(int dataIdx) Returns the style for the specified data point.
IlvDataInterval	getYRange(int dataIdx, IlvDataInterval range) Returns the Y range covered by the specified slice.
boolean	has3DSupport() Indicates whether this renderer supports three-dimensional drawing.
boolean	isExploded(int dataIdx) Indicates whether the slice displaying the specified point is exploded.
boolean	isStrokeOn() Indicates whether the outline of the slices is drawn.
void	setExploded(int dataIdx, boolean exploded) Toggles the exploded state of the slice displaying the specified point.
void	setExplodeRatio(int explodeRatio) Applies the specified explode ratio to all the slices.
void	setExplodeRatio(int dataIdx, int explodeRatio) Sets the explode ratio of the slice displaying the specified point.
void	setSliceColors(Color[] colors) Specifies the color of the pie slices.
void	setSliceStyle(int dataIdx, IlvStyle style) Sets the style for the specified data point.
void	setStrokeOn(boolean strokeOn) Specifies whether the outline of the slices is drawn.

Methods inherited from class ilog.views.chart.renderer.IlvSingleChartRenderer

addImageMapAreas, applyStyles, dataSetContentsChanged, dataSetPropertyChanged, draw, draw, drawAnnotations, drawIntoHitmap, drawSelectionHandles, drawSelectionHandles, getAnnotation, getBounds, getBounds, getDefaultLegendText, getDisplayItem, getDisplayPoint, getDisplayStyle, getNearestItem, getNearestPoint, getRenderingHint, getRenderingHint, getStyle, getStyle, getStyles, getXRange, getYRange, getYRange, getZAnnotationText, holdsAnnotations, isFilled, makeDefaultStyle, set3D, setAnnotation, setAnnotation, setDataPoint, setDisplayPoint, setRenderingHint, setRenderingHint, setStyle, setStyles, toDisplay, toDisplay

Methods inherited from class ilog.views.chart.IlvChartRenderer

applyStyles, applyStyles, collectDisplayItems, create, createRenderer, dataSetsChangesBatchEnding, dataSetsChangesBatchStarting, dispose, drawSelectionHandles, endRendererChanges, findAppropriateColor, fireTreemapFocusEvent, getAnnotation, getBounds, getChart, getChild, getChildCount, getChildIterator, getChildren, getClipRect, getCoordinateSystem, getDataLabeling, getDataLabelLayout, getDataLabelling, getDataSetIndex, getDataSetMainIndex, getDataSetMainRenderer, getDataSource, getDefaultColors, getDefaultLegendTitle, getDepths, getDisplayItem, getDisplayItems, getLegendStyle, getMinDataSetCount, getName, getNearestItem, getNearestPoint, getParent, getPlotRect, getRenderingHint, getStyle, getVirtualDataSet, getXShift, getYAxisIdx, isDisplayingDataSet, isViewable, isVisible, isVisibleInLegend, reDraw, register, setAnnotation, setDataLabeling, setDataLabelLayout, setDataLabelling, setDataSource, setName, setParent, setRenderingHint, setRenderingHintWithNoDraw, setStyle, setVisible, setVisibleInLegend, setXShift, setYAxisIdx, startRendererChanges, toData, triggerChange

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_EXPLODE_RATIO

public static final int DEFAULT_EXPLODE_RATIO

The default explode ratio for pie slices.

See Also:

setExploded(int, boolean), setExplodeRatio(int, int), Constant Field Values

Constructor Detail

IlvSinglePieRenderer

public IlvSinglePieRenderer()

Creates a new pie renderer.

IlvSinglePieRenderer

public IlvSinglePieRenderer(IlvStyle style)

Creates a new pie renderer with the specified style.

Method Detail

has3DSupport

public boolean has3DSupport()

Indicates whether this renderer supports three-dimensional drawing.

Specified by:

has3DSupport in interface IlvChart3DSupport

Overrides:

has3DSupport in class IlvChartRenderer

Returns:

true

Since:

JViews 5.5

chartConnected

protected void chartConnected(IlvChart oldChart,
                              IlvChart newChart)

Called when the renderer is added to or removed from a chart. If no color has been specified for the slices, this method performs an automatic coloring when the renderer is added to a chart.

Overrides:

chartConnected in class IlvSingleChartRenderer

Parameters:

oldChart - The chart which this renderer was associated to. This parameter is null if this renderer is added to a new chart.

newChart - The chart which this renderer is added to. This parameter is null if this renderer is removed from its current chart.

setSliceStyle

public void setSliceStyle(int dataIdx,
                          IlvStyle style)

Sets the style for the specified data point.

Parameters:

dataIdx - The index of the considered data point.

style - The new style.

getSliceStyle

public final IlvStyle getSliceStyle(int dataIdx)

Returns the style for the specified data point.

Parameters:

dataIdx - The index of the considered data point.

Returns:

style The style used to render the data point.

applyDataSetStyle

public void applyDataSetStyle(ilog.views.chart.styling.IlvDataSetStyle dataSetStyle)

Applies the styles for a data set. Internal method.

Overrides:

applyDataSetStyle in class IlvSingleChartRenderer

Since:

JViews 6.0

Internal: do not use!

setSliceColors

public void setSliceColors(Color[] colors)

Specifies the color of the pie slices.

See Also:

setSliceStyle(int, ilog.views.chart.IlvStyle)

isStrokeOn

public final boolean isStrokeOn()

Indicates whether the outline of the slices is drawn.

Since:

JViews 5.5

See Also:

setStrokeOn(boolean)

setStrokeOn

public void setStrokeOn(boolean strokeOn)

Specifies whether the outline of the slices is drawn.

Parameters:

strokeOn - A boolean value indicating whether the outline of the slices is drawn. This property overrides the setting of each slice rendering style.

Since:

JViews 5.5

See Also:

setSliceStyle(int, ilog.views.chart.IlvStyle), setSliceColors(java.awt.Color[])

isExploded

public final boolean isExploded(int dataIdx)

Indicates whether the slice displaying the specified point is exploded.

setExploded

public final void setExploded(int dataIdx,
                              boolean exploded)

Toggles the exploded state of the slice displaying the specified point.

See Also:

setExplodeRatio(int, int)

getExplodeRatio

public final int getExplodeRatio(int dataIdx)

Returns the explode ratio of the slice displaying the specified point.

Parameters:

dataIdx - The index of the considered data point.

Returns:

The explode ratio of the slice. A value of 0 means that the slice is not exploded.

See Also:

isExploded(int), setExplodeRatio(int, int)

setExplodeRatio

public void setExplodeRatio(int dataIdx,
                            int explodeRatio)

Sets the explode ratio of the slice displaying the specified point.

Parameters:

dataIdx - The index of the considered data point.

explodeRatio - A value between 0 and 100. The distance between the slice and the center of the chart increases proportionally with this value.

See Also:

getExplodeRatio(int)

setExplodeRatio

public void setExplodeRatio(int explodeRatio)

Applies the specified explode ratio to all the slices.

See Also:

setExplodeRatio(int, int)

getSlicePercent

public double getSlicePercent(int dataIdx)

Returns the percentage of the specified slice.

getPartialSum

public double getPartialSum(int dataIdx)

Returns the sum of the y-values of all the data points that are displayed before the specified data point.

Parameters:

dataIdx - The index of the considered data point (this point is included in the returned sum).

Returns:

The partial sum.

getPreferredMargins

public Insets getPreferredMargins()

Returns the preferred margins of this renderer for the calculation of the plotting rectangle. This method takes into account the annotations that are set on the pie slices.

Overrides:

getPreferredMargins in class IlvSingleChartRenderer

Returns:

The preferred margins.

See Also:

IlvChart.Area.getMargins()

dataSetsRemoved

protected void dataSetsRemoved(int firstIdx,
                               int lastIdx,
                               IlvDataSet[] oldDataSets)

Called when data sets are disconnected from this renderer.

Overrides:

dataSetsRemoved in class IlvSingleChartRenderer

Parameters:

firstIdx - The index of the first data set.

lastIdx - The index of the last data set.

oldDataSets - The data sets previously connected to this renderer.

dataSetsAdded

protected void dataSetsAdded(int firstIdx,
                             int lastIdx,
                             IlvDataSet[] oldDataSets)

Called when data sets are connected to this renderer.

Overrides:

dataSetsAdded in class IlvSingleChartRenderer

Parameters:

firstIdx - The index of the first data set.

lastIdx - The index of the last data set.

oldDataSets - The data sets previously connected to this renderer.

computeDataLabelLocation

public Point computeDataLabelLocation(IlvDisplayPoint dp,
                                      Dimension size)

Computes the location of the data label associated with the specified point.

Overrides:

computeDataLabelLocation in class IlvChartRenderer

Parameters:

dp - The considered display point.

size - The size of the label.

Returns:

The location of the center of the label.

See Also:

IlvChartRenderer.setDataLabeling(int)

computeDataLabel

public String computeDataLabel(IlvDataSetPoint dp)

Computes the data label associated with the specified point. This method takes into account the IlvChartRenderer.PERCENT_LABEL labeling mode.

Overrides:

computeDataLabel in class IlvChartRenderer

Parameters:

dp - The considered data point.

Returns:

The string corresponding to the specified data point, or null if none is available.

drawSelectionHandles

public void drawSelectionHandles(Graphics g,
                                 IlvHandlesSelectionStyle style,
                                 IlvDataSet dataSet,
                                 int index)

Draws a data point with selection handles.

Overrides:

drawSelectionHandles in class IlvChartRenderer

Parameters:

g - A graphics context.

style - The graphic style parameters.

dataSet - One of the data sets of this renderer's data source.

index - The index of a data point in the data set.

Since:

JViews 8.8

getYRange

public IlvDataInterval getYRange(int dataIdx,
                                 IlvDataInterval range)

Returns the Y range covered by the specified slice. This range is computed by the pie and takes into account the exploded state of the slice.

Parameters:

dataIdx - The index of the considered data point.

range - An interval used to store the result. If this parameter is null, a new IlvDataInterval is allocated.

Returns:

The Y range covered by the slice.

getLegendText

public String getLegendText(IlvLegendItem item)

Returns the label of the specified legend item.

Overrides:

getLegendText in class IlvSingleChartRenderer

Returns:

The string returned by the IlvSingleChartRenderer.getDefaultLegendText() method.

createLegendItems

public IlvLegendItem[] createLegendItems()

Creates the legend items associated with this renderer. This method creates an instance of IlvPieRendererLegendItem for each data point displayed by this renderer.

Overrides:

createLegendItems in class IlvSingleChartRenderer

Returns:

An array containing the legend item associated to this renderer, or null.

See Also:

IlvPieRendererLegendItem

drawLegendSymbol

public void drawLegendSymbol(IlvLegendItem item,
                             Graphics g,
                             int x,
                             int y,
                             int w,
                             int h)

Draws the symbol of the specified legend item.

Overrides:

drawLegendSymbol in class IlvSingleChartRenderer

Parameters:

item - The legend item to draw.

g - The graphics context.

x - The symbol x-coordinate.

y - The symbol y-coordinate.

w - The symbol width.

h - The symbol height.

See Also:

IlvRendererLegendItem