ClearSelection (Charba, GWT wrapper for CHART.JS)

java.lang.Object
- org.pepstock.charba.client.commons.NativeObjectContainer
- - org.pepstock.charba.client.impl.plugins.ClearSelection

```
public final class ClearSelection
extends NativeObjectContainer
```
DatasetsItemsSelector.ID plugin configuration element in order to have into the chart a clickable element to clear the selection.

Author:

Andrea "Stock" Stocchero

Field Summary

Fields
Modifier and Type	Field and Description
`static Align`	`DEFAULT_ALIGN` Default clear selection box alignment, `Align.RIGHT`.
`static boolean`	`DEFAULT_DISPLAY` Default flag if clear selection must be showed into chart, value is false.
`static ImageElement`	`DEFAULT_IMAGE` Default image for clear selection element, , value is `Resources.clearSelection18()`}.
`static String`	`DEFAULT_LABEL` Default label for clear selection element, value is "Clear selection".
`static int`	`DEFAULT_MARGIN` Default margin from canvas for clear selection element, value is 2.
`static int`	`DEFAULT_PADDING` Default padding for clear selection element, value is 4.
`static Position`	`DEFAULT_POSITION` Default clear selection box position, `Position.BOTTOM`.
`static Render`	`DEFAULT_RENDER` Default clear selection rendering, `Render.IMAGE_LABEL`.
`static int`	`DEFAULT_SPACING` Default spacing between label and image for clear selection element, value is 3.
`static boolean`	`DEFAULT_USE_SELECTION_STYLE` Default flag if clear selection will use selection area style, value is false.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Align`	`getAlign()` Returns the clear selection align.
`IsColor`	`getFontColor()` Returns the the clear selection label font color.
`String`	`getFontColorAsString()` Returns the the clear selection label font color.
`String`	`getFontFamily()` Returns the font family, follows CSS font-family options.
`int`	`getFontSize()` Returns the font size.
`FontStyle`	`getFontStyle()` Returns the font style, follows CSS font-style options (i.e.
`ImageElement`	`getImage()` Returns the clear selection image.
`String`	`getLabel()` Returns the clear selection label.
`int`	`getMargin()` Returns the margin from canvas border.
`int`	`getPadding()` Returns the padding of clear selection element.
`Position`	`getPosition()` Returns the clear selection label position.
`Render`	`getRender()` Returns the clear selection render.
`int`	`getSpacing()` Returns the spacing between label and image for clear selection element.
`boolean`	`isDisplay()` Returns `true` if clear of selection label will be applied into chart, otherwise `false`.
`boolean`	`isUseSelectionStyle()` Returns `true` if clear selection element will apply style of selection area, otherwise `false`.
`void`	`setAlign(Align align)` Sets the clear selection align.
`void`	`setDisplay(boolean display)` Sets `true` if clear of selection label will e applied into chart, otherwise `false`.
`void`	`setFontColor(IsColor color)` Set the clear selection label font color.
`void`	`setFontColor(String color)` Sets the clear selection label font color.
`void`	`setFontFamily(String fontFamily)` Sets the font family, follows CSS font-family options.
`void`	`setFontSize(int fontSize)` Sets the font size.
`void`	`setFontStyle(FontStyle fontStyle)` Sets the font style, follows CSS font-style options (i.e.
`void`	`setImage(Image image)` Sets the clear selection image.
`void`	`setImage(ImageElement image)` Sets the clear selection image.
`void`	`setImage(ImageResource image)` Sets the clear selection image.
`void`	`setLabel(String label)` Sets the clear selection label.
`void`	`setMargin(int margin)` Sets the margin from canvas border.
`void`	`setPadding(int padding)` Sets the padding of clear selection element.
`void`	`setPosition(Position position)` Sets the clear selection label position.
`void`	`setRender(Render render)` Sets the clear selection render.
`void`	`setSpacing(int spacing)` Sets the spacing between label and image for clear selection element.
`void`	`setUseSelectionStyle(boolean useSelectionStyle)` Sets `true` if clear of selection label will e applied into chart, otherwise `false`.

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

- Field Detail
  - DEFAULT_DISPLAY
```
public static final boolean DEFAULT_DISPLAY
```
    Default flag if clear selection must be showed into chart, value is false.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_LABEL
```
public static final String DEFAULT_LABEL
```
    Default label for clear selection element, value is "Clear selection".
    
    See Also:
    
    Constant Field Values
  - DEFAULT_MARGIN
```
public static final int DEFAULT_MARGIN
```
    Default margin from canvas for clear selection element, value is 2.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_PADDING
```
public static final int DEFAULT_PADDING
```
    Default padding for clear selection element, value is 4.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_SPACING
```
public static final int DEFAULT_SPACING
```
    Default spacing between label and image for clear selection element, value is 3.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_IMAGE
```
public static final ImageElement DEFAULT_IMAGE
```
    Default image for clear selection element, , value is Resources.clearSelection18()}.
  - DEFAULT_USE_SELECTION_STYLE
```
public static final boolean DEFAULT_USE_SELECTION_STYLE
```
    Default flag if clear selection will use selection area style, value is false.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_ALIGN
```
public static final Align DEFAULT_ALIGN
```
    Default clear selection box alignment, Align.RIGHT.
  - DEFAULT_RENDER
```
public static final Render DEFAULT_RENDER
```
    Default clear selection rendering, Render.IMAGE_LABEL.
  - DEFAULT_POSITION
```
public static final Position DEFAULT_POSITION
```
    Default clear selection box position, Position.BOTTOM.
- Method Detail
  - setDisplay
```
public void setDisplay(boolean display)
```
    Sets true if clear of selection label will e applied into chart, otherwise false.
    
    Parameters:
    
    display - true if clear of selection label will e applied into chart, otherwise false
  - isDisplay
```
public boolean isDisplay()
```
    Returns true if clear of selection label will be applied into chart, otherwise false.
    
    Returns:
    
    true if clear of selection label will be applied into chart, otherwise false
  - setLabel
```
public void setLabel(String label)
```
    Sets the clear selection label.
    
    Parameters:
    
    label - the clear selection label
  - getLabel
```
public String getLabel()
```
    Returns the clear selection label.
    
    Returns:
    
    the clear selection label
  - setFontSize
```
public void setFontSize(int fontSize)
```
    Sets the font size.
    
    Parameters:
    
    fontSize - the font size.
  - getFontSize
```
public int getFontSize()
```
    Returns the font size.
    
    Returns:
    
    the font size.
  - setFontStyle
```
public void setFontStyle(FontStyle fontStyle)
```
    Sets the font style, follows CSS font-style options (i.e. normal, italic, oblique, initial, inherit).
    
    Parameters:
    
    fontStyle - Font style, follows CSS font-style options (i.e. normal, italic, oblique, initial, inherit).
  - getFontStyle
```
public FontStyle getFontStyle()
```
    Returns the font style, follows CSS font-style options (i.e. normal, italic, oblique, initial, inherit).
    
    Returns:
    
    the font style, follows CSS font-style options (i.e. normal, italic, oblique, initial, inherit).
  - setFontFamily
```
public void setFontFamily(String fontFamily)
```
    Sets the font family, follows CSS font-family options.
    
    Parameters:
    
    fontFamily - Font family, follows CSS font-family options.
  - getFontFamily
```
public String getFontFamily()
```
    Returns the font family, follows CSS font-family options.
    
    Returns:
    
    Font family, follows CSS font-family options.
  - getFontColorAsString
```
public String getFontColorAsString()
```
    Returns the the clear selection label font color.
    
    Returns:
    
    the the clear selection label font color.
  - getFontColor
```
public IsColor getFontColor()
```
    Returns the the clear selection label font color.
    
    Returns:
    
    the the clear selection label font color.
  - setFontColor
```
public void setFontColor(String color)
```
    Sets the clear selection label font color.
    
    Parameters:
    
    color - the clear selection label font color.
  - setFontColor
```
public void setFontColor(IsColor color)
```
    Set the clear selection label font color.
    
    Parameters:
    
    color - the clear selection label font color.
  - setAlign
```
public void setAlign(Align align)
```
    Sets the clear selection align.
    
    Parameters:
    
    align - the clear selection align
  - getAlign
```
public Align getAlign()
```
    Returns the clear selection align.
    
    Returns:
    
    the clear selection align
  - setRender
```
public void setRender(Render render)
```
    Sets the clear selection render.
    
    Parameters:
    
    render - the clear selection render
  - getRender
```
public Render getRender()
```
    Returns the clear selection render.
    
    Returns:
    
    the clear selection render
  - setPosition
```
public void setPosition(Position position)
```
    Sets the clear selection label position.
    
    Parameters:
    
    position - the clear selection label position
  - getPosition
```
public Position getPosition()
```
    Returns the clear selection label position.
    
    Returns:
    
    the clear selection label position
  - setImage
```
public void setImage(ImageResource image)
```
    Sets the clear selection image.
    
    Parameters:
    
    image - the clear selection image
  - setImage
```
public void setImage(Image image)
```
    Sets the clear selection image.
    
    Parameters:
    
    image - the clear selection image
  - setImage
```
public void setImage(ImageElement image)
```
    Sets the clear selection image.
    
    Parameters:
    
    image - the clear selection image
  - getImage
```
public ImageElement getImage()
```
    Returns the clear selection image.
    
    Returns:
    
    the clear selection image or null if not set
  - setMargin
```
public void setMargin(int margin)
```
    Sets the margin from canvas border.
    
    Parameters:
    
    margin - margin from canvas border
  - getMargin
```
public int getMargin()
```
    Returns the margin from canvas border.
    
    Returns:
    
    the margin from canvas border
  - setPadding
```
public void setPadding(int padding)
```
    Sets the padding of clear selection element.
    
    Parameters:
    
    padding - padding of clear selection element
  - getPadding
```
public int getPadding()
```
    Returns the padding of clear selection element.
    
    Returns:
    
    the padding of clear selection element
  - setSpacing
```
public void setSpacing(int spacing)
```
    Sets the spacing between label and image for clear selection element.
    
    Parameters:
    
    spacing - spacing between label and image for clear selection element
  - getSpacing
```
public int getSpacing()
```
    Returns the spacing between label and image for clear selection element.
    
    Returns:
    
    the spacing between label and image for clear selection element
  - setUseSelectionStyle
```
public void setUseSelectionStyle(boolean useSelectionStyle)
```
    Sets true if clear of selection label will e applied into chart, otherwise false.
    
    Parameters:
    
    useSelectionStyle - true if clear of selection label will e applied into chart, otherwise false
  - isUseSelectionStyle
```
public boolean isUseSelectionStyle()
```
    Returns true if clear selection element will apply style of selection area, otherwise false.
    
    Returns:
    
    true if clear selection element will apply style of selection area, otherwise false

Class ClearSelection

Field Summary

Method Summary

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

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_DISPLAY

DEFAULT_LABEL

DEFAULT_MARGIN

DEFAULT_PADDING

DEFAULT_SPACING

DEFAULT_IMAGE

DEFAULT_USE_SELECTION_STYLE

DEFAULT_ALIGN

DEFAULT_RENDER

DEFAULT_POSITION

Method Detail

setDisplay

isDisplay

setLabel

getLabel

setFontSize

getFontSize

setFontStyle

getFontStyle

setFontFamily

getFontFamily

getFontColorAsString

getFontColor

setFontColor

setFontColor

setAlign

getAlign

setRender

getRender

setPosition

getPosition

setImage

setImage

setImage

getImage

setMargin

getMargin

setPadding

getPadding

setSpacing

getSpacing

setUseSelectionStyle

isUseSelectionStyle