ilog.views.chart.interactor

Class IlvChartCycleSelectInteractor

java.lang.Object

ilog.views.chart.IlvChartInteractor

ilog.views.chart.interactor.IlvChartCycleSelectInteractor

All Implemented Interfaces:

IlvChart3DSupport, Serializable

public class IlvChartCycleSelectInteractor
extends IlvChartInteractor

This class allows the user to navigate through the accessible elements of a chart area (scales, renderers, data sets, data points, and data objects).

This interactor can be instantiated in two modes:

• The TRAVERSE_ALL mode, which allows to navigate through all elements with two keys (forward and backward move).
• The BY_LEVEL mode, which allows to navigate through all elements with four keys (forward move, backward move, level down, and level up).

Since:

JViews 8.8

See Also:

IlvChartAreaAccessibleHierarchy, IlvChartAreaNavigationMode, IlvChartAreaSelectionManager, Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static IlvChartAreaNavigationMode	BY_LEVEL In this mode, the user navigates through all elements with four keys.
static IlvChartAreaNavigationMode	TRAVERSE_ALL In this mode, the user navigates through all elements with two keys: forward move and backward move.

Fields inherited from class ilog.views.chart.IlvChartInteractor

INTERNAL_HIGH, INTERNAL_LOW, NORMAL

Constructor Summary

Constructors

Constructor and Description
IlvChartCycleSelectInteractor() Creates an interactor in TRAVERSE_ALL mode with default keys.
IlvChartCycleSelectInteractor(IlvChartAreaNavigationMode mode) Creates an interactor with default keys: Tab and Shift-Tab for the TRAVERSE_ALL mode, or right arrow, left arrow, down arrow, up arrow for the BY_LEVEL mode.
IlvChartCycleSelectInteractor(IlvChartAreaNavigationMode mode, KeyStroke[] forwardKeys, KeyStroke[] backwardKeys, KeyStroke[] downKeys, KeyStroke[] upKeys) Creates an interactor with four keys.
IlvChartCycleSelectInteractor(IlvChartAreaNavigationMode mode, KeyStroke forwardKey, KeyStroke backwardKey) Creates an interactor with two keys, in TRAVERSE_ALL mode.
IlvChartCycleSelectInteractor(IlvChartAreaNavigationMode mode, KeyStroke forwardKey, KeyStroke backwardKey, KeyStroke downKey, KeyStroke upKey) Creates an interactor with four keys.

Method Summary

Modifier and Type	Method and Description
protected void	abort() Called when the interaction has been aborted.
protected void	chartConnected(IlvChart oldChart, IlvChart newChart) This method is overridden to initialize a new IlvDefaultChartAreaAccessibleHierarchy.
IlvChartAreaAccessibleHierarchy	createAccessibleHierarchy(IlvChart chart) Creates the hierarchy of accessible elements of a chart.
IlvChartAreaAccessibleHierarchy	getAccessibleHierarchy() Returns the hierarchy of accessible elements of a chart.
KeyStroke[]	getBackwardKeys() Returns the set of key designators for the "backward" action.
KeyStroke[]	getDownKeys() Returns the set of key designators for the "descend" action.
KeyStroke[]	getForwardKeys() Returns the set of key designators for the "forward" action.
static String	getLocalizedName(Locale locale) Returns a localized name for this interactor class.
IlvChartAreaNavigationMode	getMode() Returns the mode of this interactor.
IlvChartAreaSelectionManager	getSelectionManager() Returns the object that manages and renders the selection.
KeyStroke[]	getUpKeys() Returns the set of key designators for the "ascend back" action.
protected int	matches(KeyEvent event, KeyStroke key) Tests how closely the given event matches the given key designator.
void	moveBackward() Moves the selection backward, to the previous element, according to the mode.
void	moveDown() Moves the selection downward, that is, to a level with more details.
void	moveForward() Moves the selection forward, to the next element, according to the mode.
void	moveUp() Moves the selection upward, that is, to a level with less details.
void	processKeyEvent(KeyEvent event) Handles a keyboard event.
void	setSelectionManager(IlvChartAreaSelectionManager manager) Sets the object that manages and renders the selection.

Methods inherited from class ilog.views.chart.IlvChartInteractor

addChartInteractionListener, create, create, disableEvents, drawGhost, drawGhost, enableEvents, endOperation, fireChartInteractionEvent, getAWTEventMask, getChart, getCoordinateSystem, getData, getData, getEventMask, getEventMaskEx, getGhostBounds, getGhostColor, getInteractorClassByName, getLocalizedName, getPriority, getRegisteredInteractorsByName, getShortName, getXAxis, getXORColor, getYAxis, getYAxisIndex, handleExpose, has3DSupport, initGhostGraphics, interactionStarted, isAborted, isAllowDrawGhost, isConsumeEvents, isHandling, isInOperation, isXORGhost, processMouseEvent, processMouseMotionEvent, register, removeChartInteractionListener, setAborted, setAllowDrawGhost, setChart, setConsumeEvents, setCursor, setEventMask, setGhostColor, setInOperation, setPriority, setXORColor, setXORGhost, setYAxisIndex, startOperation, toDisplay

Methods inherited from class java.lang.Object

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

Field Detail

TRAVERSE_ALL

public static final IlvChartAreaNavigationMode TRAVERSE_ALL

In this mode, the user navigates through all elements with two keys: forward move and backward move.

See Also:

getMode()

BY_LEVEL

public static final IlvChartAreaNavigationMode BY_LEVEL

In this mode, the user navigates through all elements with four keys. Two keys, forward move and backward move, allow to move inside a certain level. The "level down" key allows to descend from the current element to its details, one level below. The "level up" key allows to get back from a detail level to the next level.

Constructor Detail

IlvChartCycleSelectInteractor

public IlvChartCycleSelectInteractor()

Creates an interactor in TRAVERSE_ALL mode with default keys.

IlvChartCycleSelectInteractor

public IlvChartCycleSelectInteractor(IlvChartAreaNavigationMode mode)

Creates an interactor with default keys: Tab and Shift-Tab for the TRAVERSE_ALL mode, or right arrow, left arrow, down arrow, up arrow for the BY_LEVEL mode.

Parameters:

mode - One of TRAVERSE_ALL, BY_LEVEL.

IlvChartCycleSelectInteractor

public IlvChartCycleSelectInteractor(IlvChartAreaNavigationMode mode,
                                     KeyStroke forwardKey,
                                     KeyStroke backwardKey)

Creates an interactor with two keys, in TRAVERSE_ALL mode.

Parameters:

mode - Must be TRAVERSE_ALL.

forwardKey - A key designator, or null.

backwardKey - A key designator, or null.

IlvChartCycleSelectInteractor

public IlvChartCycleSelectInteractor(IlvChartAreaNavigationMode mode,
                                     KeyStroke forwardKey,
                                     KeyStroke backwardKey,
                                     KeyStroke downKey,
                                     KeyStroke upKey)

Creates an interactor with four keys.

Parameters:

mode - Must be BY_LEVEL.

forwardKey - A key designator, or null.

backwardKey - A key designator, or null.

downKey - A key designator, or null.

upKey - A key designator, or null.

IlvChartCycleSelectInteractor

public IlvChartCycleSelectInteractor(IlvChartAreaNavigationMode mode,
                                     KeyStroke[] forwardKeys,
                                     KeyStroke[] backwardKeys,
                                     KeyStroke[] downKeys,
                                     KeyStroke[] upKeys)

Creates an interactor with four keys.

Parameters:

mode - Must be BY_LEVEL.

forwardKeys - A set of key designators, or null.

backwardKeys - A set of key designators, or null.

downKeys - A set of key designators, or null.

upKeys - A set of key designators, or null.

Method Detail

getLocalizedName

public static String getLocalizedName(Locale locale)

Returns a localized name for this interactor class.

getMode

public IlvChartAreaNavigationMode getMode()

Returns the mode of this interactor.

Returns:

One of TRAVERSE_ALL, BY_LEVEL.

getForwardKeys

public KeyStroke[] getForwardKeys()

Returns the set of key designators for the "forward" action.

Returns:

An array of key designators, or null.

getBackwardKeys

public KeyStroke[] getBackwardKeys()

Returns the set of key designators for the "backward" action.

Returns:

An array of key designators, or null.

getDownKeys

public KeyStroke[] getDownKeys()

Returns the set of key designators for the "descend" action.

Returns:

An array of key designators, or null.

getUpKeys

public KeyStroke[] getUpKeys()

Returns the set of key designators for the "ascend back" action.

Returns:

An array of key designators, or null.

createAccessibleHierarchy

public IlvChartAreaAccessibleHierarchy createAccessibleHierarchy(IlvChart chart)

Creates the hierarchy of accessible elements of a chart. This method is invoked when this interactor is connected to a chart.

The default implementation returns an instance of IlvDefaultChartAreaAccessibleHierarchy.

getAccessibleHierarchy

public IlvChartAreaAccessibleHierarchy getAccessibleHierarchy()

Returns the hierarchy of accessible elements of a chart.

Returns:

An object describing the hierarchy of the accessible elements of the chart to which this interactor is attached, or null if this interactor is currently not attached.

getSelectionManager

public IlvChartAreaSelectionManager getSelectionManager()

Returns the object that manages and renders the selection.

setSelectionManager

public void setSelectionManager(IlvChartAreaSelectionManager manager)

Sets the object that manages and renders the selection.

chartConnected

protected void chartConnected(IlvChart oldChart,
                              IlvChart newChart)

This method is overridden to initialize a new IlvDefaultChartAreaAccessibleHierarchy.

Overrides:

chartConnected in class IlvChartInteractor

Parameters:

oldChart - The previous attached chart.

newChart - The new attached chart.

See Also:

IlvChart.addInteractor(ilog.views.chart.IlvChartInteractor)

abort

protected void abort()

Called when the interaction has been aborted.

Overrides:

abort in class IlvChartInteractor

processKeyEvent

public void processKeyEvent(KeyEvent event)

Handles a keyboard event.

This method compares the event against the given keystrokes getForwardKeys(), getBackwardKeys(), getDownKeys(), getUpKeys(), and if one of them matches, it invokes one of the methods moveForward(), moveBackward(), moveDown(), moveUp().

Overrides:

processKeyEvent in class IlvChartInteractor

matches

protected int matches(KeyEvent event,
                      KeyStroke key)

Tests how closely the given event matches the given key designator.

Parameters:

event - A keyboard event.

key - A key designator.

Returns:

2 when the event matches exactly, 1 when it matches modulo "loosely", or 0 if it does not match.

moveForward

public void moveForward()

Moves the selection forward, to the next element, according to the mode.

moveBackward

public void moveBackward()

Moves the selection backward, to the previous element, according to the mode.

moveDown

public void moveDown()

Moves the selection downward, that is, to a level with more details. This method does nothing in TRAVERSE_ALL mode.

moveUp

public void moveUp()

Moves the selection upward, that is, to a level with less details. This method does nothing in TRAVERSE_ALL mode.