HovingFlexDataset (Charba, GWT wrapper for CHART.JS)

java.lang.Object
- org.pepstock.charba.client.commons.NativeObjectContainer
- - org.pepstock.charba.client.data.Dataset
  - - org.pepstock.charba.client.data.HovingFlexDataset

All Implemented Interfaces:

HasDataset

Direct Known Subclasses:

BarDataset, HovingDataset
```
public abstract class HovingFlexDataset
extends Dataset
```
This dataset is managing some common properties related to background and border colors where every property can be set as a single value or an array.

Author:

Andrea "Stock" Stocchero

Nested Class Summary
- Nested classes/interfaces inherited from class org.pepstock.charba.client.data.Dataset
  Dataset.Property

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`applyGradient(Key key, List<CanvasGradient> canvasGradientsList)` Stores the canvas gradients into dataset object by property name passed as key.
`protected void`	`applyPattern(Key key, List<CanvasPattern> canvasPatternsList)` Stores the canvas patterns into dataset object by property name passed as key.
`List<IsColor>`	`getBackgroundColor()` Returns the fill colors of the elements.
`List<Gradient>`	`getBackgroundColorAsGradient()` Returns the fill gradient of elements.
`List<Pattern>`	`getBackgroundColorAsPatterns()` Returns the fill patters of elements.
`List<String>`	`getBackgroundColorAsString()` Returns the fill colors of the elements.
`List<IsColor>`	`getBorderColor()` Returns the color of the bar border
`List<Gradient>`	`getBorderColorAsGradient()` Returns the gradient of the bar border.
`List<String>`	`getBorderColorAsString()` Returns the color of the bar border
`List<Integer>`	`getBorderWidth()` Returns the stroke width of the bar in pixels.
`List<IsColor>`	`getHoverBackgroundColor()` Returns the fill color of the elements when hovered.
`List<Gradient>`	`getHoverBackgroundColorAsGradient()` Returns the fill gradients of elements when hovered.
`List<Pattern>`	`getHoverBackgroundColorAsPatterns()` Returns the fill patters of elements when hovered.
`List<String>`	`getHoverBackgroundColorAsString()` Returns the fill color of the elements when hovered.
`List<IsColor>`	`getHoverBorderColor()` Returns the stroke color of the elements when hovered
`List<Gradient>`	`getHoverBorderColorAsGradient()` Returns the stroke gradients of the elements when hovered.
`List<String>`	`getHoverBorderColorAsString()` Returns the stroke color of the elements when hovered.
`List<Integer>`	`getHoverBorderWidth()` Returns the stroke width of the elements when hovered.
`void`	`setBackgroundColor(Gradient... backgroundColor)` Sets the fill gradient of the elements.
`void`	`setBackgroundColor(IsColor... backgroundColor)` Sets the fill colors of the elements.
`void`	`setBackgroundColor(Pattern... backgroundColor)` Sets the fill pattern of the elements.
`void`	`setBackgroundColor(String... backgroundColor)` Sets the fill colors of the elements.
`void`	`setBorderColor(Gradient... borderColor)` Sets the gradient of the bar border as gradient.
`void`	`setBorderColor(IsColor... borderColor)` Sets the color of the bar border
`void`	`setBorderColor(String... borderColor)` Sets the color of the bar border
`void`	`setBorderWidth(int... borderWidth)` Sets the stroke width of the bar in pixels.
`void`	`setHoverBackgroundColor(Gradient... colors)` Sets the fill gradient of the elements when hovered.
`void`	`setHoverBackgroundColor(IsColor... colors)` Sets the fill color of the elements when hovered
`void`	`setHoverBackgroundColor(Pattern... colors)` Sets the fill pattern of the elements when hovered.
`void`	`setHoverBackgroundColor(String... colors)` Sets the fill color of the elements when hovered
`void`	`setHoverBorderColor(Gradient... colors)` Sets the stroke gradient of elements when hovered as gradient.
`void`	`setHoverBorderColor(IsColor... colors)` Sets the stroke color of the elements when hovered
`void`	`setHoverBorderColor(String... colors)` Sets the stroke color of the elements when hovered
`void`	`setHoverBorderWidth(int... widths)` Sets the stroke width of the elements when hovered.

Methods inherited from class org.pepstock.charba.client.data.Dataset
getBackgroundColorCallback, getBorderColorCallback, getBorderWidthCallback, getData, getData, getDataset, getDataType, getDefaultBackgroundColorAsString, getDefaultBorderColorAsString, getDefaultBorderWidth, getDefaultValues, getId, getLabel, getOptions, getType, hasOptions, isHidden, setBackgroundColor, setBorderColor, setBorderWidth, setData, setData, setHidden, setLabel, setOptions, setType

Methods inherited from class org.pepstock.charba.client.commons.NativeObjectContainer
checkValue, getArrayValue, getNativeObject, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValueOrArray, getValueOrArray, getValueOrArray, getValueOrArray, getValueOrArray, getValueOrArray, getValueOrArray, has, has, keys, remove, remove, removeIfExists, setArrayValue, setArrayValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValueOrArray, setValueOrArray, setValueOrArray, setValueOrArray, setValueOrArray, setValueOrArray, setValueOrArray, setValueOrArray, toJSON, type

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

- Method Detail
  - setBackgroundColor
```
public void setBackgroundColor(IsColor... backgroundColor)
```
    Sets the fill colors of the elements.
    
    Parameters:
    
    backgroundColor - the fill colors of the elements.
  - setBackgroundColor
```
public void setBackgroundColor(String... backgroundColor)
```
    Sets the fill colors of the elements.
    
    Parameters:
    
    backgroundColor - the fill colors of the elements.
  - setBackgroundColor
```
public void setBackgroundColor(Pattern... backgroundColor)
```
    Sets the fill pattern of the elements.
    
    Parameters:
    
    backgroundColor - the fill pattern of element.
  - setBackgroundColor
```
public void setBackgroundColor(Gradient... backgroundColor)
```
    Sets the fill gradient of the elements.
    
    Parameters:
    
    backgroundColor - the fill gradient of the elements.
  - getBackgroundColorAsString
```
public List<String> getBackgroundColorAsString()
```
    Returns the fill colors of the elements. If property is missing or not a color, returns an empty list.
    
    Returns:
    
    list of the fill colors of the elements. If property is missing or not a color, returns an empty list.
  - getBackgroundColor
```
public List<IsColor> getBackgroundColor()
```
    Returns the fill colors of the elements. If property is missing or not a color, returns an empty list.
    
    Returns:
    
    list of the fill colors of the elements. If property is missing or not a color, returns an empty list.
  - getBackgroundColorAsPatterns
```
public List<Pattern> getBackgroundColorAsPatterns()
```
    Returns the fill patters of elements. If property is missing or not a pattern, returns an empty list.
    
    Returns:
    
    list of the fill patterns of elements. If property is missing or not a pattern, returns an empty list.
  - getBackgroundColorAsGradient
```
public List<Gradient> getBackgroundColorAsGradient()
```
    Returns the fill gradient of elements. If property is missing or not a gradient, returns an empty list.
    
    Returns:
    
    the fill gradient of elements. If property is missing or not a gradient, returns an empty list.
  - setBorderColor
```
public void setBorderColor(IsColor... borderColor)
```
    Sets the color of the bar border
    
    Parameters:
    
    borderColor - the color of the bar border
  - setBorderColor
```
public void setBorderColor(String... borderColor)
```
    Sets the color of the bar border
    
    Parameters:
    
    borderColor - the color of the bar border
  - setBorderColor
```
public void setBorderColor(Gradient... borderColor)
```
    Sets the gradient of the bar border as gradient.
    
    Parameters:
    
    borderColor - the gradient of the bar border as gradient.
  - getBorderColorAsString
```
public List<String> getBorderColorAsString()
```
    Returns the color of the bar border
    
    Returns:
    
    list of the color of the bar border
  - getBorderColor
```
public List<IsColor> getBorderColor()
```
    Returns the color of the bar border
    
    Returns:
    
    list of the color of the bar border
  - getBorderColorAsGradient
```
public List<Gradient> getBorderColorAsGradient()
```
    Returns the gradient of the bar border. If property is missing or not a gradient, returns an empty list.
    
    Returns:
    
    the gradient of the bar border. If property is missing or not a gradient, returns an empty list.
  - setBorderWidth
```
public void setBorderWidth(int... borderWidth)
```
    Sets the stroke width of the bar in pixels.
    
    Parameters:
    
    borderWidth - the stroke width of the bar in pixels.
  - getBorderWidth
```
public List<Integer> getBorderWidth()
```
    Returns the stroke width of the bar in pixels. If a callback has been set, returns an empty list.
    
    Returns:
    
    list of the stroke width of the bar in pixels. If a callback has been set, returns an empty list.
  - setHoverBackgroundColor
```
public void setHoverBackgroundColor(IsColor... colors)
```
    Sets the fill color of the elements when hovered
    
    Parameters:
    
    colors - the fill color of the elements when hovered
  - setHoverBackgroundColor
```
public void setHoverBackgroundColor(String... colors)
```
    Sets the fill color of the elements when hovered
    
    Parameters:
    
    colors - the fill color of the elements when hovered
  - setHoverBackgroundColor
```
public void setHoverBackgroundColor(Pattern... colors)
```
    Sets the fill pattern of the elements when hovered.
    
    Parameters:
    
    colors - the fill pattern of element when hovered.
  - setHoverBackgroundColor
```
public void setHoverBackgroundColor(Gradient... colors)
```
    Sets the fill gradient of the elements when hovered.
    
    Parameters:
    
    colors - the fill gradient of the elements when hovered.
  - getHoverBackgroundColorAsString
```
public List<String> getHoverBackgroundColorAsString()
```
    Returns the fill color of the elements when hovered. If property is missing or not a color, returns an empty list.
    
    Returns:
    
    list of the fill color of the elements when hovered. If property is missing or not a color, returns an empty list.
  - getHoverBackgroundColor
```
public List<IsColor> getHoverBackgroundColor()
```
    Returns the fill color of the elements when hovered. If property is missing or not a color, returns an empty list.
    
    Returns:
    
    list of the fill color of the elements when hovered.If property is missing or not a color, returns an empty list.
  - getHoverBackgroundColorAsPatterns
```
public List<Pattern> getHoverBackgroundColorAsPatterns()
```
    Returns the fill patters of elements when hovered. If property is missing or not a pattern, returns an empty list.
    
    Returns:
    
    list of the fill patterns of elements when hovered. If property is missing or not a pattern, returns an empty list.
  - getHoverBackgroundColorAsGradient
```
public List<Gradient> getHoverBackgroundColorAsGradient()
```
    Returns the fill gradients of elements when hovered. If property is missing or not a gradient, returns an empty list.
    
    Returns:
    
    list of the fill gradients of elements when hovered. If property is missing or not a gradient, returns an empty list.
  - setHoverBorderColor
```
public void setHoverBorderColor(IsColor... colors)
```
    Sets the stroke color of the elements when hovered
    
    Parameters:
    
    colors - the stroke color of the elements when hovered
  - setHoverBorderColor
```
public void setHoverBorderColor(String... colors)
```
    Sets the stroke color of the elements when hovered
    
    Parameters:
    
    colors - the stroke color of the elements when hovered
  - setHoverBorderColor
```
public void setHoverBorderColor(Gradient... colors)
```
    Sets the stroke gradient of elements when hovered as gradient.
    
    Parameters:
    
    colors - the stroke gradient of elements when hovered as gradient.
  - getHoverBorderColorAsString
```
public List<String> getHoverBorderColorAsString()
```
    Returns the stroke color of the elements when hovered.
    
    Returns:
    
    list of the stroke color of the elements when hovered.
  - getHoverBorderColor
```
public List<IsColor> getHoverBorderColor()
```
    Returns the stroke color of the elements when hovered
    
    Returns:
    
    list of the stroke color of the elements when hovered
  - getHoverBorderColorAsGradient
```
public List<Gradient> getHoverBorderColorAsGradient()
```
    Returns the stroke gradients of the elements when hovered. If property is missing or not a pattern, returns an empty list.
    
    Returns:
    
    list of the stroke gradients of the elements when hovered. If property is missing or not a pattern, returns an empty list.
  - setHoverBorderWidth
```
public void setHoverBorderWidth(int... widths)
```
    Sets the stroke width of the elements when hovered.
    
    Parameters:
    
    widths - the stroke width of the elements when hovered.
  - getHoverBorderWidth
```
public List<Integer> getHoverBorderWidth()
```
    Returns the stroke width of the elements when hovered.
    
    Returns:
    
    list of the stroke width of the elements when hovered.
  - applyPattern
```
protected void applyPattern(Key key,
                            List<CanvasPattern> canvasPatternsList)
```
    Description copied from class: Dataset
    
    Stores the canvas patterns into dataset object by property name passed as key.
    
    Specified by:
    
    applyPattern in class Dataset
    
    Parameters:
    
    key - key property name to use to store canvas patterns into dataset object.
    
    canvasPatternsList - list of canvas patterns
  - applyGradient
```
protected void applyGradient(Key key,
                             List<CanvasGradient> canvasGradientsList)
```
    Description copied from class: Dataset
    
    Stores the canvas gradients into dataset object by property name passed as key.
    
    Specified by:
    
    applyGradient in class Dataset
    
    Parameters:
    
    key - key property name to use to store canvas gradients into dataset object.
    
    canvasGradientsList - list of canvas gradients

Class HovingFlexDataset

Nested Class Summary

Nested classes/interfaces inherited from class org.pepstock.charba.client.data.Dataset

Method Summary

Methods inherited from class org.pepstock.charba.client.data.Dataset

Methods inherited from class org.pepstock.charba.client.commons.NativeObjectContainer

Methods inherited from class java.lang.Object

Method Detail

setBackgroundColor

setBackgroundColor

setBackgroundColor

setBackgroundColor

getBackgroundColorAsString

getBackgroundColor

getBackgroundColorAsPatterns

getBackgroundColorAsGradient

setBorderColor

setBorderColor

setBorderColor

getBorderColorAsString

getBorderColor

getBorderColorAsGradient

setBorderWidth

getBorderWidth

setHoverBackgroundColor

setHoverBackgroundColor

setHoverBackgroundColor

setHoverBackgroundColor

getHoverBackgroundColorAsString

getHoverBackgroundColor

getHoverBackgroundColorAsPatterns

getHoverBackgroundColorAsGradient

setHoverBorderColor

setHoverBorderColor

setHoverBorderColor

getHoverBorderColorAsString

getHoverBorderColor

getHoverBorderColorAsGradient

setHoverBorderWidth

getHoverBorderWidth

applyPattern

applyGradient