ilog.views.chart.interactor

Interface IlvChartAreaNavigationMode

public interface IlvChartAreaNavigationMode

Instances of this interface define ways to navigate through a hierarchy of accessible elements in a chart area.

Since:

JViews 8.8

See Also:

IlvChartCycleSelectInteractor, IlvChartAreaAccessibleHierarchy

Method Summary

Modifier and Type	Method and Description
IlvChartAreaAccessible	goBackward(IlvChartAreaAccessibleHierarchy hierarchy, boolean mayLeave, IlvChartAreaAccessible sel) Performs a move "backward" in the hierarchy.
IlvChartAreaAccessible	goDown(IlvChartAreaAccessibleHierarchy hierarchy, boolean mayLeave, IlvChartAreaAccessible sel) Performs a move "down" in the hierarchy.
IlvChartAreaAccessible	goForward(IlvChartAreaAccessibleHierarchy hierarchy, boolean mayLeave, IlvChartAreaAccessible sel) Performs a move "forward" in the hierarchy.
IlvChartAreaAccessible	goUp(IlvChartAreaAccessibleHierarchy hierarchy, boolean mayLeave, IlvChartAreaAccessible sel) Performs a move "up" in the hierarchy.

Method Detail

goForward

IlvChartAreaAccessible goForward(IlvChartAreaAccessibleHierarchy hierarchy,
                                 boolean mayLeave,
                                 IlvChartAreaAccessible sel)

Performs a move "forward" in the hierarchy.

Parameters:

hierarchy - A hierarchy of accessible elements.

mayLeave - If true, the selection may escape from the hierarchy.

sel - The currently selected element, or null.

Returns:

The element that should be selected afterwards, possibly sel if the selection should not change, or null if the selection should leave the hierarchy.

goBackward

IlvChartAreaAccessible goBackward(IlvChartAreaAccessibleHierarchy hierarchy,
                                  boolean mayLeave,
                                  IlvChartAreaAccessible sel)

Performs a move "backward" in the hierarchy.

Parameters:

hierarchy - A hierarchy of accessible elements.

mayLeave - If true, the selection may escape from the hierarchy.

sel - The currently selected element, or null.

Returns:

The element that should be selected afterwards, possibly sel if the selection should not change, or null if the selection should leave the hierarchy.

goDown

IlvChartAreaAccessible goDown(IlvChartAreaAccessibleHierarchy hierarchy,
                              boolean mayLeave,
                              IlvChartAreaAccessible sel)

Performs a move "down" in the hierarchy.

Parameters:

hierarchy - A hierarchy of accessible elements.

mayLeave - If true, the selection may escape from the hierarchy.

sel - The currently selected element, or null.

Returns:

The element that should be selected afterwards, possibly sel if the selection should not change, or null if the selection should leave the hierarchy.

goUp

IlvChartAreaAccessible goUp(IlvChartAreaAccessibleHierarchy hierarchy,
                            boolean mayLeave,
                            IlvChartAreaAccessible sel)

Performs a move "up" in the hierarchy.

Parameters:

hierarchy - A hierarchy of accessible elements.

mayLeave - If true, the selection may escape from the hierarchy.

sel - The currently selected element, or null.

Returns:

The element that should be selected afterwards, possibly sel if the selection should not change, or null if the selection should leave the hierarchy.