Package org.zkoss.chart

Class KeyboardNavigation

java.lang.Object

org.zkoss.chart.Optionable

org.zkoss.chart.KeyboardNavigation

All Implemented Interfaces:

Serializable, OptionDataListener, org.zkoss.json.JSONAware

public class KeyboardNavigation
extends Optionable

An options for keyboard navigation.

Since:

10.2.1.0

Author:

jumperchen

See Also:

Serialized Form

Field Summary

Fields inherited from class org.zkoss.chart.Optionable

NOT_NULL_VALUE, options

Constructor Summary

Constructors

Constructor	Description
KeyboardNavigation()

Method Summary

Modifier and Type	Method	Description
FocusBorder	getFocusBorder()	Returns an options for the focus border drawn around elements while navigating through them, or create a new one.
List<String>	getOrder()	Returns the order of tab navigation in the chart.
SeriesNavigation	getSeriesNavigation()	Returns an options for the keyboard navigation of data points and series, or create a new one.
boolean	isEnabled()	Returns whether to enable keyboard navigation for the chart.
boolean	isWrapAround()	Return whether or not to wrap around when reaching the end of arrow-key navigation for an element in the chart.
void	setEnabled(boolean enabled)	Sets whether to enable keyboard navigation for the chart.
void	setFocusBorder(FocusBorder focusBorder)	Sets an options for the focus border drawn around elements while navigating through them, or create a new one.
void	setOrder(List<String> order)	Sets the order of tab navigation in the chart.
void	setSeriesNavigation(SeriesNavigation seriesNavigation)	Sets an options for the keyboard navigation of data points and series, or create a new one.
void	setWrapAround(boolean wrapAround)	Sets whether or not to wrap around when reaching the end of arrow-key navigation for an element in the chart.

Methods inherited from class org.zkoss.chart.Optionable

addExtraAttr, addOptionDataListener, clearOptonDataListener, clone, containsKey, fireEvent, fireEvent, fireEvent, fireEvent, fireEvent, getAttr, getAttr, getClientState, getExtraAttr, merge, onChange, removeExtraAttr, removeKey, removeOptionDataListener, setAttr, setAttr, setAttr, setAttr, toJSONString, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

KeyboardNavigation

public KeyboardNavigation()

Method Detail

isEnabled

public boolean isEnabled()

Returns whether to enable keyboard navigation for the chart.

Default: true

setEnabled

public void setEnabled(boolean enabled)

Sets whether to enable keyboard navigation for the chart.

Default: true

getFocusBorder

public FocusBorder getFocusBorder()

Returns an options for the focus border drawn around elements while navigating through them, or create a new one.

Default: an instance of FocusBorder

setFocusBorder

public void setFocusBorder(FocusBorder focusBorder)

Sets an options for the focus border drawn around elements while navigating through them, or create a new one.

getOrder

public List<String> getOrder()

Returns the order of tab navigation in the chart. Determines which elements are tabbed to first.

Available elements are: series, zoom, rangeSelector, chartMenu, legend and container. In addition, any custom components can be added here. Adding container first in order will make the keyboard focus stop on the chart container first, requiring the user to tab again to enter the chart.

Default: null

setOrder

public void setOrder(List<String> order)

Sets the order of tab navigation in the chart. Determines which elements are tabbed to first.

Available elements are: series, zoom, rangeSelector, chartMenu, legend and container. In addition, any custom components can be added here. Adding container first in order will make the keyboard focus stop on the chart container first, requiring the user to tab again to enter the chart.

getSeriesNavigation

public SeriesNavigation getSeriesNavigation()

Returns an options for the keyboard navigation of data points and series, or create a new one.

Default: an instance of SeriesNavigation

setSeriesNavigation

public void setSeriesNavigation(SeriesNavigation seriesNavigation)

Sets an options for the keyboard navigation of data points and series, or create a new one.

isWrapAround

public boolean isWrapAround()

Return whether or not to wrap around when reaching the end of arrow-key navigation for an element in the chart.

Default: true

setWrapAround

public void setWrapAround(boolean wrapAround)

Sets whether or not to wrap around when reaching the end of arrow-key navigation for an element in the chart.