java.lang.Object
- org.zkoss.chart.Optionable

All Implemented Interfaces:

Serializable, OptionDataListener, org.zkoss.json.JSONAware

Direct Known Subclasses:

Accessibility, AccessibilityPoint, AccessibilitySeries, ActiveWhen, Animation, Annotation, Annotation.Point, AnnotationLabelAccessibility, AnnotationLabelOptions, AnnotationShapeOptions, AnnounceNewData, Axis, AxisAccessibility, AxisLabels, AxisTitle, Breadcrumbs, Break, BubbleLegend, BubbleLegend.Labels, BubbleLegend.Range, Caption, Chart, Cluster, ClusterLayoutAlgorithm, CollapseButton, Color, ColorVariation, ConnectorOptions, Credits, Crosshair, Data, DataClass, DataLabels, DataLabelsFilter, DataLabelsTextPath, DataSorting, DateTimeLabelFormats, DefaultSpeechOptions, DragDrop, DragDrop.DragHandle, DragDrop.GuideBox, Drilldown, DrillUpButton, Exporting, ExportingAccessibility, ExportingButton, FocusBorder, Frame3D, Frequency, GaugeDialPlotOptions, GaugePivotPlotOptions, Global, GlobalTrack, Halo, HaloAttributes, Highpass, Jitter, KeyboardNavigation, Labels, LabelsItem, Lang, LangAccessibility, LangAnnounceNewData, LangAxis, LangChartTypes, LangExporting, LangLegend, LangRangeSelector, LangScreenReaderSection, LangScreenReaderSectionAnnotations, LangSeries, LangSeriesSummary, LangSeriesTypeDescriptions, LangSonification, LangTable, LangZoom, Legend, LegendAccessibility, LegendKeyboardNavigation, LegendNavigation, LegendTitle, Level, LevelSize, LinearGradient, Loading, Mapping, Marker, MenuItem, Navigation, NavigationButton, NetworkGraphLayoutAlgorithm, NetworkGraphLink, NoData, Node, OnPoint, Options, Options3D, PackedBubbleLayoutAlgorithm, PackedBubbleParentNode, PackedBubbleParentNodeOptions, Pane, PaneBackground, Panel3D, Path, PDFFont, Pitch, PlotBand, PlotLabel, PlotLine, PlotOptions, Point, PointAccessibility, PointGrouping, Position, RadialGradient, ResetZoomButton, Responsive, Responsive.Condition, Responsive.Rule, ScreenReaderSection, ScrollablePlotArea, Separator, Series, SeriesAccessibility, SeriesKeyboardNavigation, SeriesLabel, SeriesNavigation, SeriesPlotOptions, SeriesSonification, Shadow, Sonification, StackLabels, StackShadow, State, States, Subtitle, TargetOptions, Title, Tooltip, TooltipPlotOptions, TraverseUpButton, TreeGraphLink, Tremolo, WindBarbDataGrouping, WordCloudRotation, XRangePartialFill, Zone
```
public abstract class Optionable
extends Object
implements org.zkoss.json.JSONAware, OptionDataListener
```
A skeletal implementation for Highcharts's optionable data.

Author:

jumperchen

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field	Description
`protected static String`	`NOT_NULL_VALUE`	An instance for setAttr to check the default is not a null value.
`protected Map<String,AnyVal<Object>>`	`options`

Constructor Summary

Constructors
Constructor Description

Optionable()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`Object`	`addExtraAttr(String key, org.zkoss.json.JSONAware value)`	Adds an extra attribute to client side, if any.
`<T extends Optionable> T`	`addOptionDataListener(OptionDataListener l)`	Adds the option data listener
`<T extends Optionable> T`	`clearOptonDataListener()`	Clear up all the option data listeners
`Object`	`clone()`
`protected boolean`	`containsKey(PlotAttribute key)`	Returns `true` if this options contains a mapping for the specified key.
`protected <T extends Optionable> T`	`fireEvent(OptionDataEvent event)`	Triggers the option change event.
`protected <T extends Optionable> T`	`fireEvent(OptionDataEvent.EventType type, String key, Object value, String key2, Object value2, Object... pairs)`	Triggers the option change event.
`protected <T extends Optionable> T`	`fireEvent(OptionDataEvent.EventType type, String key, Object value, DeferredCall call)`	Triggers the option change event.
`protected <T extends Optionable> T`	`fireEvent(OptionDataEvent.EventType type, PlotAttribute key, Object value)`	Triggers the option change event.
`protected <T extends Optionable> T`	`fireEvent(OptionDataEvent.EventType type, PlotAttribute key, Object value, DeferredCall call)`	Triggers the option change event.
`protected Object`	`getAttr(PlotAttribute key)`	Returns the value of the element according to the attribute name.
`protected <T> AnyVal<T>`	`getAttr(PlotAttribute key, T defaultValue)`	Returns the `AnyVal` object of the element according to the attribute name.
`void`	`getClientState(String attr, org.zkoss.zk.ui.event.EventListener<org.zkoss.zk.ui.event.Event> listener)`	Returns a client state after a client callback in the event listener.
`Object`	`getExtraAttr(String key)`	Get an attribute by key, if any.
`protected Optionable`	`merge(Optionable other)`	Merges the all value from the given object, if the key is the same, the value will be overridden.
`void`	`onChange(OptionDataEvent event)`	Sent when the contents of the chart option has changed.
`Object`	`removeExtraAttr(String key)`	Removes the extra attribute to client side from the given key, if any.
`protected Object`	`removeKey(PlotAttribute key, boolean triggerEvent)`	Removes the mapping for a key from this options if it is present.
`<T extends Optionable> T`	`removeOptionDataListener(OptionDataListener l)`	Removes the option data listener
`protected <T> boolean`	`setAttr(String strKey, Object value, T defaultValue)`
`protected boolean`	`setAttr(PlotAttribute key, Object value)`	Sets the value of the attribute name.
`protected <T> boolean`	`setAttr(PlotAttribute key, Object value, T defaultValue)`	Sets the value of the attribute name with the given default value, which is used for comparing the null value case when the default value is not null.
`protected <T> boolean`	`setAttr(PlotAttribute key, Color value, T defaultValue)`	Sets the color value of the attribute name with the given default value, which is used for comparing the null value case when the default value is not null.
`String`	`toJSONString()`	Encodes this object to a JSON string.
`String`	`toString()`	Encodes this object to a JSON string.

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail
- options
```
protected Map<String,AnyVal<Object>> options
```
- NOT_NULL_VALUE
```
protected static String NOT_NULL_VALUE
```
  An instance for setAttr to check the default is not a null value.

Constructor Detail
- Optionable
```
public Optionable()
```