public abstract class AbstractPluginOptions extends AbstractNode
Modifier and Type | Class and Description |
---|---|
protected static class |
AbstractPluginOptions.Property
Name of properties of native object.
|
Modifier | Constructor and Description |
---|---|
protected |
AbstractPluginOptions(String pluginId,
AbstractNode parent,
Key childKey,
NativeObject nativeObject)
Creates the object with the parent, the key of this element, default values and native object to map java script properties.
|
protected |
AbstractPluginOptions(String pluginId,
NativeObject nativeObject)
Creates new plugin options with plugin ID, using a native object instance.
|
Modifier and Type | Method and Description |
---|---|
protected void |
applyingDefaults()
This is invoked before storing the plugins options as default.
|
void |
applyingDefaults(ChartEnvelop<String> envelop)
This is invoked before storing the plugins options as default.
This is called set the options of plugin are stored as default, see GlobalOptions.getPlugins() . |
Set<Event> |
getEvents()
Returns the browser events that the plugins should listen to.
|
String |
getId()
Returns the unique ID of the options.
|
String |
getPluginId()
Returns the plugin id related to this options.
|
protected <T extends AbstractPluginOptions> |
loadGlobalsPluginOptions(AbstractPluginOptionsFactory<T> factory)
Loads the default plugin options from defaults.
|
void |
setEvents(Event... events)
Sets the browser events that the plugins should listen to.
|
void |
setEvents(Set<Event> events)
Sets the browser events that the legend should listen to.
|
void |
store()
Stores this options in the default global plugins options.
|
void |
store(Dataset dataset)
Stores this options in the dataset options.
|
void |
store(IsChart chart)
Stores this options in the chart plugins options.
|
void |
store(Type type)
Stores this options in the global chart plugins options.
|
checkAndAddToParent, getChildKey, getParentNode, getRootNode, retrieveRoot, setArrayValueAndAddToParent, setArrayValueAndAddToParent, setArrayValueAndAddToParent, setElementAndAddToParent, setInternalCallbackToModel, setInternalCallbackToModel, setValueAndAddToParent, setValueAndAddToParent, setValueAndAddToParent, setValueAndAddToParent, setValueAndAddToParent, setValueAndAddToParent, setValueAndAddToParent, setValueAndAddToParent, setValueAndAddToParent, setValueAndAddToParent, setValueAndAddToParent, setValueAndAddToParent, setValueAndAddToParent, setValueAndAddToParent, setValueAndAddToParent, setValueAndAddToParent, setValueAndAddToParent, setValueOrArrayAndAddToParent, setValueOrArrayAndAddToParent, setValueOrArrayAndAddToParent, setValueOrArrayAndAddToParent, setValueOrArrayAndAddToParent, setValueOrArrayAndAddToParent, setValueOrArrayAndAddToParent, setValueOrArrayAndAddToParent, setValueOrArrayAndAddToParent, setValueOrArrayAndAddToParent
checkDefaultValuesArgument, empty, getArrayValue, getElement, getIncrementalId, getNativeChart, getNativeEvent, getNativeObject, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValueForMultipleKeyTypes, getValueForMultipleKeyTypes, getValueForMultipleKeyTypes, getValueOrArray, getValueOrArray, getValueOrArray, getValueOrArray, getValueOrArray, getValueOrArray, getValueOrArray, getValueOrArray, has, has, isType, keys, loadNativeObject, remove, remove, setArrayValue, setArrayValue, setArrayValue, setElement, setEmptyValue, setNewIncrementalId, setNewIncrementalId, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValueOrArray, setValueOrArray, setValueOrArray, setValueOrArray, setValueOrArray, setValueOrArray, setValueOrArray, setValueOrArray, setValueOrArray, setValueOrArray, toJSON, type
protected AbstractPluginOptions(String pluginId, NativeObject nativeObject)
pluginId
- plugin IDnativeObject
- native object which represents the plugin options as native objectprotected AbstractPluginOptions(String pluginId, AbstractNode parent, Key childKey, NativeObject nativeObject)
pluginId
- plugin IDparent
- parent node to use to add this element where changedchildKey
- the property name of this element to use to add it to the parent.nativeObject
- native object to map java script propertiespublic final String getId()
public final String getPluginId()
public final void setEvents(Event... events)
events
- the browser events that the plugins should listen to.public void setEvents(Set<Event> events)
events
- the browser events that the legend should listen to.public final Set<Event> getEvents()
protected final <T extends AbstractPluginOptions> T loadGlobalsPluginOptions(AbstractPluginOptionsFactory<T> factory)
null
, returns null
.T
- type of native object containerfactory
- factory to load optionsnull
, returns null
.public final void applyingDefaults(ChartEnvelop<String> envelop)
GlobalOptions.getPlugins()
.envelop
- envelop needed to ensure that this public method can be called only by GlobalOptions
protected void applyingDefaults()
public void store()
public final void store(IsChart chart)
chart
- chart instancepublic final void store(Type type)
type
- chart type to store options in the global chart optionspublic final void store(Dataset dataset)
dataset
- dataset instance to store options