Package org.zkoss.chart

Class SeriesAccessibility

java.lang.Object

org.zkoss.chart.Optionable

org.zkoss.chart.SeriesAccessibility

All Implemented Interfaces:

Serializable, OptionDataListener, org.zkoss.json.JSONAware

public class SeriesAccessibility
extends Optionable

Accessibility options for a series.

Requires the accessibility module to be loaded. For example,

 Library.setProperty("org.zkoss.chart.modules.accessibility", "true");
 

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
SeriesAccessibility()

Method Summary

Modifier and Type	Method	Description
String	getDescription()	Returns a description of the series, announced to screen readers.
SeriesKeyboardNavigation	getKeyboardNavigation()	Returns the keyboard navigation for a series, if null, create a new one.
AccessibilityPoint	getPoint()	Returns the point accessibility options for a series, if null, create a new one.
Boolean	isEnabled()	Returns whether to enable/disable accessibility functionality for a specific series.
Boolean	isExposeAsGroupOnly()	Returns to expose only the series element to screen readers, not its points.
void	setDescription(String description)	Sets a description of the series, announced to screen readers.
void	setEnabled(boolean enabled)	Sets whether to enable/disable accessibility functionality for a specific series.
void	setExposeAsGroupOnly(boolean exposeAsGroupOnly)	Sets to expose only the series element to screen readers, not its points.
void	setKeyboardNavigation(SeriesKeyboardNavigation keyboardNavigation)	Sets the keyboard navigation for a series.
void	setPoint(AccessibilityPoint point)	Sets the point accessibility options for a series.

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

SeriesAccessibility

public SeriesAccessibility()

Method Detail

getDescription

public String getDescription()

Returns a description of the series, announced to screen readers.

Default: null

setDescription

public void setDescription(String description)

Sets a description of the series, announced to screen readers.

isEnabled

public Boolean isEnabled()

Returns whether to enable/disable accessibility functionality for a specific series.

Default: null

setEnabled

public void setEnabled(boolean enabled)

Sets whether to enable/disable accessibility functionality for a specific series.

isExposeAsGroupOnly

public Boolean isExposeAsGroupOnly()

Returns to expose only the series element to screen readers, not its points.

Default: null

setExposeAsGroupOnly

public void setExposeAsGroupOnly(boolean exposeAsGroupOnly)

Sets to expose only the series element to screen readers, not its points.

getKeyboardNavigation

public SeriesKeyboardNavigation getKeyboardNavigation()

Returns the keyboard navigation for a series, if null, create a new one.

Default: an instance of SeriesNavigation

setKeyboardNavigation

public void setKeyboardNavigation(SeriesKeyboardNavigation keyboardNavigation)

Sets the keyboard navigation for a series.

getPoint

public AccessibilityPoint getPoint()

Returns the point accessibility options for a series, if null, create a new one.

Default: an instance of AccessibilityPoint

setPoint

public void setPoint(AccessibilityPoint point)

Sets the point accessibility options for a series.