ilog.views.chart.accessibility

Class IlvDefaultChartAreaAccessibleHierarchy

java.lang.Object

ilog.views.chart.accessibility.IlvChartAreaAccessibleHierarchy

ilog.views.chart.accessibility.IlvDefaultChartAreaAccessibleHierarchy

All Implemented Interfaces:

Serializable

public class IlvDefaultChartAreaAccessibleHierarchy
extends IlvChartAreaAccessibleHierarchy
implements Serializable

This class describes how the accessible elements of a chart area (scales, renderers, data sets, data points, and data objects) are grouped together, allowing a user to navigate among them.

The accessible elements are managed in a tree of rows:

• The top-most row consists of the x and y scales, followed by the leaf renderers of the chart.
• Under each renderer, a row is attached that consists of the data sets that are displayed by the renderer. For high-low renderers, the row contains only the first of each pair of data sets.
• Under each data set, a row is attached that consists of the data points of the data set. Data points with undefined values are omitted.
• Under an IlvTreemapChartRenderer, the rows follow the structure of the data model.

Scales, renderers, and data sets can be marked unselectable. All are selectable by default.

Since:

JViews 8.8

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
IlvDefaultChartAreaAccessibleHierarchy(IlvChart chart) Creates a selection manager attached to a given chart.

Method Summary

Modifier and Type	Method and Description
boolean	areScalesSelectable() Returns true if scales are selectable in general.
boolean	areSingleRenderersSelectable() Returns true if renderers with at most one data set are selectable in general.
IlvChartAreaAccessible	getChildRowFirstSelectable(IlvChartAreaAccessible elem) Returns the first selectable element in the row attached under elem.
IlvChartAreaAccessible	getFirstSelectable(IlvChartAreaAccessible inRow) Returns the first selectable element of the row of inRow, or of the topmost row if inRow is null.
IlvChartAreaAccessible	getLastSelectable(IlvChartAreaAccessible inRow) Returns the last selectable element of the row of inRow, or of the topmost row if inRow is null.
IlvChartAreaAccessible	getNextSelectable(IlvChartAreaAccessible elem) Returns the next selectable element in the same row as elem.
IlvChartAreaAccessible	getParentRowSelectable(IlvChartAreaAccessible elem) Returns the selectable element in the row above elem.
IlvChartAreaAccessible	getPreviousSelectable(IlvChartAreaAccessible elem) Returns the previous selectable element in the same row as elem.
boolean	isSelectable(IlvChartRenderer renderer) Returns true if the given renderer is selectable.
boolean	isSelectable(IlvDataSet dataSet) Returns true if the given data set is selectable.
boolean	isSelectable(IlvScale scale) Returns true if the given scale is selectable.
void	setScalesSelectable(boolean selectable) Specifies whether scales are selectable in general.
void	setSelectable(IlvChartRenderer renderer, boolean selectable) Specifies whether a given renderer shall be selectable or not.
void	setSelectable(IlvDataSet dataSet, boolean selectable) Specifies whether a given data set shall be selectable or not.
void	setSelectable(IlvScale scale, boolean selectable) Specifies whether a given scale shall be selectable or not.
void	setSingleRenderersSelectable(boolean selectable) Specifies whether renderers with at most one data set are selectable in general.

Methods inherited from class java.lang.Object

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

Constructor Detail

IlvDefaultChartAreaAccessibleHierarchy

public IlvDefaultChartAreaAccessibleHierarchy(IlvChart chart)

Creates a selection manager attached to a given chart.

Method Detail

areScalesSelectable

public boolean areScalesSelectable()

Returns true if scales are selectable in general.

See Also:

setScalesSelectable(boolean)

setScalesSelectable

public void setScalesSelectable(boolean selectable)

Specifies whether scales are selectable in general. The default value is true.

See Also:

areScalesSelectable(), setSelectable(IlvScale, boolean)

areSingleRenderersSelectable

public boolean areSingleRenderersSelectable()

Returns true if renderers with at most one data set are selectable in general.

See Also:

setSingleRenderersSelectable(boolean)

setSingleRenderersSelectable

public void setSingleRenderersSelectable(boolean selectable)

Specifies whether renderers with at most one data set are selectable in general. The default value is false.

See Also:

areSingleRenderersSelectable(), setSelectable(IlvChartRenderer, boolean)

isSelectable

public boolean isSelectable(IlvScale scale)

Returns true if the given scale is selectable.

See Also:

setSelectable(IlvScale, boolean)

setSelectable

public void setSelectable(IlvScale scale,
                          boolean selectable)

Specifies whether a given scale shall be selectable or not. The default value is true for every scale.

See Also:

isSelectable(IlvScale), setScalesSelectable(boolean)

isSelectable

public boolean isSelectable(IlvChartRenderer renderer)

Returns true if the given renderer is selectable.

See Also:

setSelectable(IlvChartRenderer, boolean)

setSelectable

public void setSelectable(IlvChartRenderer renderer,
                          boolean selectable)

Specifies whether a given renderer shall be selectable or not. The default value is true for every renderer.

See Also:

isSelectable(IlvChartRenderer), setSingleRenderersSelectable(boolean)

isSelectable

public boolean isSelectable(IlvDataSet dataSet)

Returns true if the given data set is selectable.

See Also:

setSelectable(IlvDataSet, boolean)

setSelectable

public void setSelectable(IlvDataSet dataSet,
                          boolean selectable)

Specifies whether a given data set shall be selectable or not. The default value is true for every data set.

See Also:

isSelectable(IlvDataSet)

getFirstSelectable

public IlvChartAreaAccessible getFirstSelectable(IlvChartAreaAccessible inRow)

Returns the first selectable element of the row of inRow, or of the topmost row if inRow is null.

Specified by:

getFirstSelectable in class IlvChartAreaAccessibleHierarchy

Parameters:

inRow - An accessible element of the chart area, or null.

Returns:

The first selectable accessible element in the same row, or null if there is none.

getLastSelectable

public IlvChartAreaAccessible getLastSelectable(IlvChartAreaAccessible inRow)

Returns the last selectable element of the row of inRow, or of the topmost row if inRow is null.

Specified by:

getLastSelectable in class IlvChartAreaAccessibleHierarchy

Parameters:

inRow - An accessible element of the chart area, or null.

Returns:

The last selectable accessible element in the same row, or null if there is none.

getNextSelectable

public IlvChartAreaAccessible getNextSelectable(IlvChartAreaAccessible elem)

Returns the next selectable element in the same row as elem.

Specified by:

getNextSelectable in class IlvChartAreaAccessibleHierarchy

Parameters:

elem - An accessible element of the chart area.

Returns:

The next selectable accessible element in the same row, or null if there is none.

getPreviousSelectable

public IlvChartAreaAccessible getPreviousSelectable(IlvChartAreaAccessible elem)

Returns the previous selectable element in the same row as elem.

Specified by:

getPreviousSelectable in class IlvChartAreaAccessibleHierarchy

Parameters:

elem - An accessible element of the chart area.

Returns:

The previous selectable accessible element in the same row, or null if there is none.

getParentRowSelectable

public IlvChartAreaAccessible getParentRowSelectable(IlvChartAreaAccessible elem)

Returns the selectable element in the row above elem.

Specified by:

getParentRowSelectable in class IlvChartAreaAccessibleHierarchy

Parameters:

elem - An accessible element of the chart area.

Returns:

The selectable accessible element in the parent row, or null if there is no parent row.

getChildRowFirstSelectable

public IlvChartAreaAccessible getChildRowFirstSelectable(IlvChartAreaAccessible elem)

Returns the first selectable element in the row attached under elem.

Specified by:

getChildRowFirstSelectable in class IlvChartAreaAccessibleHierarchy

Parameters:

elem - An accessible element of the chart area.

Returns:

The first selectable accessible element in the row below elem, or null if there is no such row or none of its elements is selectable.