ilog.views.chart.interactor

Class IlvChartAreaSelectionManager

java.lang.Object

ilog.views.chart.interactor.IlvChartAreaSelectionManager

All Implemented Interfaces:

Serializable

public class IlvChartAreaSelectionManager
extends Object
implements Serializable

This class manages a concept of "selection" in the chart area. An accessible element, that is, a scale, renderer, data set, data point, or data object, can be marked as "selected".

The rendering of the selection can be done in three ways:

1. Through handles.
2. Through an IlvDataRenderingHint.
3. Through a CSS pseudo-class and specific rules for this pseudo-class.

Since:

JViews 8.8

See Also:

IlvChartCycleSelectInteractor, Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static int	SHOW_HANDLES The rendering mode that shows handles around the selected element.
static int	SHOW_HIGHLIGHT The rendering mode that shows the selected element through a rendering hint, such as with a brighter color.
static int	USE_CSS The rendering mode that shows the selected elements according to CSS rules with a given CSS pseudo-class.

Constructor Summary

Constructors

Constructor and Description
IlvChartAreaSelectionManager() Creates a selection manager.

Method Summary

Modifier and Type	Method and Description
void	attach(IlvChart chart) Attaches this selection manager to a chart.
void	detach() Detaches this selection manager from its chart.
void	dispose() Detaches this selection manager from the chart and cleans it up, to help garbage collection.
IlvChart	getChart() Returns the chart to which this selection manager is currently connected to, or null for none.
IlvHandlesSelectionStyle	getHandlesSelectionStyle() Returns the graphic style parameters used for drawing a selection using handles.
IlvDataRenderingHint	getRenderingHint() Returns the rendering hint through which the selection is displayed.
int	getRenderingMode() Returns the rendering mode for the selection.
String	getRenderingPseudoClass() Returns the CSS pseudo-class through which the selection is displayed.
IlvChartAreaAccessible	getSelection() Returns the currently selected element, or null for none.
void	setHandlesSelectionStyle(IlvHandlesSelectionStyle style) Sets the graphic style parameters used for drawing a selection using handles.
protected void	setRenderingAsSelected(IlvChartAreaAccessible elem, boolean enable) Enables or disables the rendering of the given element as selected.
void	setRenderingHint(IlvDataRenderingHint hint) Sets the rendering hint through which the selection is displayed.
void	setRenderingMode(int mode) Specifies the rendering mode for the selection.
void	setRenderingPseudoClass(String pseudoClass) Sets the CSS pseudo-class through which the selection is displayed.
void	setSelection(IlvChartAreaAccessible selection) Determines which element shall be selected.

Methods inherited from class java.lang.Object

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

Field Detail

SHOW_HANDLES

public static final int SHOW_HANDLES

The rendering mode that shows handles around the selected element.

See Also:

setRenderingMode(int), Constant Field Values

SHOW_HIGHLIGHT

public static final int SHOW_HIGHLIGHT

The rendering mode that shows the selected element through a rendering hint, such as with a brighter color.

Note: The visual impression of a highlighted color depends on the area filled with that color. Therefore this rendering mode is more suitable for area charts, pie charts, and treemap charts, than for polyline charts.

See Also:

setRenderingMode(int), Constant Field Values

USE_CSS

public static final int USE_CSS

The rendering mode that shows the selected elements according to CSS rules with a given CSS pseudo-class.

See Also:

setRenderingMode(int), Constant Field Values

Constructor Detail

IlvChartAreaSelectionManager

public IlvChartAreaSelectionManager()

Creates a selection manager. Before it can be used, it needs to attached to a chart.

Method Detail

getChart

public final IlvChart getChart()

Returns the chart to which this selection manager is currently connected to, or null for none.

attach

public void attach(IlvChart chart)

Attaches this selection manager to a chart.

detach

public void detach()

Detaches this selection manager from its chart.

getRenderingMode

public int getRenderingMode()

Returns the rendering mode for the selection.

Returns:

One of SHOW_HANDLES, SHOW_HIGHLIGHT, USE_CSS.

See Also:

getRenderingHint(), getRenderingPseudoClass()

setRenderingMode

public void setRenderingMode(int mode)

Specifies the rendering mode for the selection.

When you call setRenderingMode(USE_CSS), you also need to call setRenderingPseudoClass(String) and provide a CSS style sheet that contains rules that are specific to that pseudo-class.

Parameters:

mode - One of SHOW_HANDLES, SHOW_HIGHLIGHT, USE_CSS.

See Also:

setHandlesSelectionStyle(IlvHandlesSelectionStyle), setRenderingHint(IlvDataRenderingHint), setRenderingPseudoClass(String)

getHandlesSelectionStyle

public IlvHandlesSelectionStyle getHandlesSelectionStyle()

Returns the graphic style parameters used for drawing a selection using handles.

See Also:

setHandlesSelectionStyle(IlvHandlesSelectionStyle)

setHandlesSelectionStyle

public void setHandlesSelectionStyle(IlvHandlesSelectionStyle style)

Sets the graphic style parameters used for drawing a selection using handles.

Note: This method has no effect as long as getRenderingMode() returns a value different from SHOW_HANDLES.

See Also:

getHandlesSelectionStyle(), setRenderingMode(int)

getRenderingHint

public IlvDataRenderingHint getRenderingHint()

Returns the rendering hint through which the selection is displayed.

See Also:

setRenderingHint(IlvDataRenderingHint)

setRenderingHint

public void setRenderingHint(IlvDataRenderingHint hint)

Sets the rendering hint through which the selection is displayed.

Note: This method has no effect as long as getRenderingMode() returns a value different from SHOW_HIGHLIGHT.

See Also:

getRenderingHint(), setRenderingMode(int)

getRenderingPseudoClass

public String getRenderingPseudoClass()

Returns the CSS pseudo-class through which the selection is displayed.

See Also:

setRenderingPseudoClass(String)

setRenderingPseudoClass

public void setRenderingPseudoClass(String pseudoClass)

Sets the CSS pseudo-class through which the selection is displayed.

Note: This method has no effect as long as getRenderingMode() returns a value different from USE_CSS.

See Also:

getRenderingPseudoClass(), setRenderingMode(int)

setRenderingAsSelected

protected void setRenderingAsSelected(IlvChartAreaAccessible elem,
                                      boolean enable)

Enables or disables the rendering of the given element as selected.

getSelection

public IlvChartAreaAccessible getSelection()

Returns the currently selected element, or null for none.

setSelection

public void setSelection(IlvChartAreaAccessible selection)

Determines which element shall be selected.

Parameters:

selection - An element, or null to deselect the previous selection.

dispose

public void dispose()

Detaches this selection manager from the chart and cleans it up, to help garbage collection.

Note: After calling this function, this selection manager is no longer functional.