org.pepstock.charba.client.annotation.AnnotationOptions Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of charba Show documentation
Show all versions of charba Show documentation
Charba - J2CL and GWT charts library based on CHART.JS
/**
Copyright 2017 Andrea "Stock" Stocchero
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
package org.pepstock.charba.client.annotation;
import java.util.List;
import org.pepstock.charba.client.IsChart;
import org.pepstock.charba.client.annotation.enums.DrawTime;
import org.pepstock.charba.client.annotation.enums.Event;
import org.pepstock.charba.client.commons.ArrayListHelper;
import org.pepstock.charba.client.commons.ArrayObjectContainerList;
import org.pepstock.charba.client.commons.ArrayString;
import org.pepstock.charba.client.commons.Key;
import org.pepstock.charba.client.plugins.AbstractPluginCachedOptions;
/**
* This is the {@link AnnotationPlugin#ID} plugin options where to set all configuration items needed to the plugin.
*
* @author Andrea "Stock" Stocchero
*
*/
public final class AnnotationOptions extends AbstractPluginCachedOptions {
/**
* Default double click speed in milliseconds, {@value DEFAULT_DOUBLE_CLICK_SPEED}.
*/
public static final int DEFAULT_DOUBLE_CLICK_SPEED = 350;
/**
* Default draw time, {@link DrawTime#AFTER_DATASETS_DRAW}.
*/
public static final DrawTime DEFAULT_DRAW_TIME = DrawTime.AFTER_DATASETS_DRAW;
// maintains the list of annotations because needs to preserve the annotation type
private final ArrayObjectContainerList currentAnnotations = new ArrayObjectContainerList<>();
/**
* Name of properties of native object.
*/
enum Property implements Key
{
DRAW_TIME("drawTime"),
EVENTS("events"),
DOUBLE_CLICK_SPEED("dblClickSpeed"),
ANNOTATIONS("annotations");
// name value of property
private final String value;
/**
* Creates with the property value to use into native object.
*
* @param value value of property name
*/
private Property(String value) {
this.value = value;
}
/*
* (non-Javadoc)
*
* @see org.pepstock.charba.client.commons.Key#value()
*/
@Override
public String value() {
return value;
}
}
// defaults global options instance
private DefaultsOptions defaultsOptions;
/**
* Creates new {@link AnnotationPlugin#ID} plugin options.
*/
public AnnotationOptions() {
this((DefaultsOptions) null);
}
/**
* Creates new {@link AnnotationPlugin#ID} plugin options, relating to chart instance for default.
*
* @param chart chart instance related to the plugin options
*/
public AnnotationOptions(IsChart chart) {
this(IsChart.isConsistent(chart) ? chart.getDefaultChartOptions().getPlugins().getOptions(AnnotationPlugin.ID, AnnotationPlugin.DEFAULTS_FACTORY) : null);
}
/**
* Creates new {@link AnnotationPlugin#ID} plugin options.
*
* @param defaultsOptions default options stored into defaults global
*/
AnnotationOptions(DefaultsOptions defaultsOptions) {
// creates an empty native object
super(AnnotationPlugin.ID, AnnotationPlugin.FACTORY, false);
// checks if defaults options are consistent
if (defaultsOptions == null) {
// reads the default default global options
this.defaultsOptions = loadGlobalsPluginOptions(AnnotationPlugin.DEFAULTS_FACTORY);
} else {
// stores default options
this.defaultsOptions = defaultsOptions;
}
}
/**
* Sets the draw time which defines when the annotations are drawn.
*
* @param drawTime the draw time which defines when the annotations are drawn
*/
public void setDrawTime(DrawTime drawTime) {
setValue(Property.DRAW_TIME, drawTime);
}
/**
* Returns the draw time which defines when the annotations are drawn.
*
* @return the draw time which defines when the annotations are drawn
*/
public DrawTime getDrawTime() {
return getValue(Property.DRAW_TIME, DrawTime.values(), defaultsOptions.getDrawTime());
}
/**
* Sets the double-click speed in milliseconds used to distinguish single-clicks from double-clicks whenever you need to capture both.
* When listening for both {@link Event#CLICK} and {@link Event#DOUBLE_CLICK}, click events will be delayed by this amount.
*
* @param speed the double-click speed in milliseconds
*/
public void setDoubleClickSpeed(int speed) {
setValue(Property.DOUBLE_CLICK_SPEED, speed);
}
/**
* Returns the double-click speed in milliseconds used to distinguish single-clicks from double-clicks whenever you need to capture both.
* When listening for both {@link Event#CLICK} and {@link Event#DOUBLE_CLICK}, click events will be delayed by this amount.
*
* @return the double-click speed in milliseconds
*/
public int getDoubleClickSpeed() {
return getValue(Property.DOUBLE_CLICK_SPEED, defaultsOptions.getDoubleClickSpeed());
}
/**
* Sets the browser events to enable on each annotation.
*
* @param events the browser events to enable on each annotation.
*/
public void setEvents(Event... events) {
// sets the array of events
setArrayValue(Property.EVENTS, ArrayString.fromOrNull(events));
}
/**
* Returns the browser events to enable on each annotation.
*
* @return the browser events to enable on each annotation
*/
public List getEvents() {
// gets array for events
ArrayString array = getArrayValue(Property.EVENTS);
// if the arrays is consistent...
if (array != null && !array.isEmpty()) {
// ...then returns as list of events
return ArrayListHelper.list(Event.values(), array);
}
// ... otherwise returns the default
return defaultsOptions.getEvents();
}
/**
* Sets a set of annotations for plugin. If argument is null, removes all annotations.
*
* @param annotations set of anotation. If null, removes all annotations
*/
public void setAnnotations(AbstractAnnotation... annotations) {
// clear buffer
this.currentAnnotations.clear();
// checks if arguments is consistent
if (annotations != null) {
// adds all annotations
this.currentAnnotations.addAll(annotations);
// sets annotations to native object
setArrayValue(Property.ANNOTATIONS, this.currentAnnotations);
} else {
// removes the existing property
removeIfExists(Property.ANNOTATIONS);
}
}
/**
* Returns the list of annotations.
*
* @return the list of annotations
*/
public List getAnnotations() {
return getAnnotations(false);
}
/**
* Returns the list of annotations.
*
* @param binding if true binds the new array list into container
* @return the list of annotations
*/
public List getAnnotations(boolean binding) {
// there is not the property and the binding is requested
// then adds array to container
if (!has(Property.ANNOTATIONS) && binding) {
// sets annotations to native object
setArrayValue(Property.ANNOTATIONS, this.currentAnnotations);
}
// returns annotations
return this.currentAnnotations;
}
}