Time (Charba, GWT wrapper for CHART.JS)

java.lang.Object
- org.pepstock.charba.client.commons.NativeObjectContainer
- - org.pepstock.charba.client.options.Time

All Implemented Interfaces:

IsDefaultTime
```
public final class Time
extends NativeObjectContainer
implements IsDefaultTime
```
The following display formats are used to configure how different time units are formed into strings for the axis tick marks.

Author:

Andrea "Stock" Stocchero

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`checkAndAddToParent()` Called recursively when a property has been set in the item. This is mandatory because it could happen that the parent item is not present, therefore it must be added.
`protected Key`	`getChildKey()` Returns the property name to use to add this element to its parent.
`protected D`	`getDefaultValues()` Returns the default provider instance.
`DisplayFormats`	`getDisplayFormats()` Returns the displayFormats element.
`TimeUnit`	`getMinUnit()` The minimum display format to be used for a time unit.
`protected P`	`getParent()` Returns the parent element.
`String`	`getParser()` Defined as a string, it is interpreted as a custom format to be used by moment to parse the date.
`TimeUnit`	`getRound()` If defined, dates will be rounded to the start of this unit.
`double`	`getStepSize()` The number of units between grid lines.
`String`	`getTooltipFormat()` The format string to use for the tooltip.
`TimeUnit`	`getUnit()` If defined, will force the unit to be a certain type.
`boolean`	`isIsoWeekday()` If `true` and the unit is set to 'week', then the first day of the week will be Monday.
`protected void`	`setCallbackToModel(org.pepstock.charba.client.options.AbstractModel<?,?> model, Key key, CallbackProxy.Proxy proxy)` Adds a proxy function (for callbacks) to a model at the specific key.
`protected void`	`setEventToModel(org.pepstock.charba.client.options.AbstractModel<?,?> model, Key key, CallbackProxy.Proxy proxy)` Adds a proxy function (for events) to a model at the specific key.
`void`	`setIsoWeekday(boolean isoWeekday)` If `true` and the unit is set to 'week', then the first day of the week will be Monday.
`void`	`setMinUnit(TimeUnit unit)` The minimum display format to be used for a time unit.
`void`	`setParser(String parser)` Defined as a string, it is interpreted as a custom format to be used by moment to parse the date.
`void`	`setRound(boolean round)` If defined, dates will be rounded to the start of this unit.
`void`	`setRound(TimeUnit round)` If defined, dates will be rounded to the start of this unit.
`void`	`setStepSize(double stepSize)` The number of units between grid lines.
`void`	`setTooltipFormat(String tooltipFormat)` The format string to use for the tooltip.
`void`	`setUnit(boolean unit)` If defined, will force the unit to be a certain type.
`void`	`setUnit(TimeUnit unit)` If defined, will force the unit to be a certain type.

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
  - getDisplayFormats
```
public DisplayFormats getDisplayFormats()
```
    Returns the displayFormats element.
    
    Returns:
    
    the displayFormats
  - setIsoWeekday
```
public void setIsoWeekday(boolean isoWeekday)
```
    If true and the unit is set to 'week', then the first day of the week will be Monday. Otherwise, it will be Sunday.
    
    Parameters:
    
    isoWeekday - if true and the unit is set to 'week', then the first day of the week will be Monday. Otherwise, it will be Sunday.
  - isIsoWeekday
```
public boolean isIsoWeekday()
```
    If true and the unit is set to 'week', then the first day of the week will be Monday. Otherwise, it will be Sunday.
    
    Specified by:
    
    isIsoWeekday in interface IsDefaultTime
    
    Returns:
    
    if true and the unit is set to 'week', then the first day of the week will be Monday. Otherwise, it will be Sunday.
  - setRound
```
public void setRound(boolean round)
```
    If defined, dates will be rounded to the start of this unit.
    
    Parameters:
    
    round - if defined, this will override the data minimum.
  - setRound
```
public void setRound(TimeUnit round)
```
    If defined, dates will be rounded to the start of this unit.
    
    Parameters:
    
    round - if defined, this will override the data minimum.
  - getRound
```
public TimeUnit getRound()
```
    If defined, dates will be rounded to the start of this unit.
    
    Specified by:
    
    getRound in interface IsDefaultTime
    
    Returns:
    
    if defined, dates will be rounded to the start of this unit.
  - setTooltipFormat
```
public void setTooltipFormat(String tooltipFormat)
```
    The format string to use for the tooltip.
    
    Parameters:
    
    tooltipFormat - format string to use for the tooltip.
  - getTooltipFormat
```
public String getTooltipFormat()
```
    The format string to use for the tooltip.
    
    Specified by:
    
    getTooltipFormat in interface IsDefaultTime
    
    Returns:
    
    the format string to use for the tooltip.
  - setUnit
```
public void setUnit(boolean unit)
```
    If defined, will force the unit to be a certain type.
    
    Parameters:
    
    unit - If defined, will force the unit to be a certain type.
  - setUnit
```
public void setUnit(TimeUnit unit)
```
    If defined, will force the unit to be a certain type.
    
    Parameters:
    
    unit - if defined, will force the unit to be a certain type.
  - getUnit
```
public TimeUnit getUnit()
```
    If defined, will force the unit to be a certain type.
    
    Specified by:
    
    getUnit in interface IsDefaultTime
    
    Returns:
    
    if defined, will force the unit to be a certain type.
  - setStepSize
```
public void setStepSize(double stepSize)
```
    The number of units between grid lines.
    
    Parameters:
    
    stepSize - number of units between grid lines.
  - getStepSize
```
public double getStepSize()
```
    The number of units between grid lines.
    
    Specified by:
    
    getStepSize in interface IsDefaultTime
    
    Returns:
    
    number of units between grid lines.
  - setMinUnit
```
public void setMinUnit(TimeUnit unit)
```
    The minimum display format to be used for a time unit.
    
    Parameters:
    
    unit - minimum display format to be used for a time unit.
  - getMinUnit
```
public TimeUnit getMinUnit()
```
    The minimum display format to be used for a time unit.
    
    Specified by:
    
    getMinUnit in interface IsDefaultTime
    
    Returns:
    
    minimum display format to be used for a time unit.
  - setParser
```
public void setParser(String parser)
```
    Defined as a string, it is interpreted as a custom format to be used by moment to parse the date.
    
    Parameters:
    
    parser - defined as a string, it is interpreted as a custom format to be used by moment to parse the date.
  - getParser
```
public String getParser()
```
    Defined as a string, it is interpreted as a custom format to be used by moment to parse the date.
    
    Specified by:
    
    getParser in interface IsDefaultTime
    
    Returns:
    
    defined as a string, it is interpreted as a custom format to be used by moment to parse the date.
  - getChildKey
```
protected final Key getChildKey()
```
    Returns the property name to use to add this element to its parent.
    
    Returns:
    
    the childKey or null if is a root element.
  - getParent
```
protected final P getParent()
```
    Returns the parent element.
    
    Returns:
    
    the parent or null if is a root element.
  - getDefaultValues
```
protected final D getDefaultValues()
```
    Returns the default provider instance.
    
    Returns:
    
    the default provider instance.
  - setEventToModel
```
protected final void setEventToModel(org.pepstock.charba.client.options.AbstractModel<?,?> model,
                                     Key key,
                                     CallbackProxy.Proxy proxy)
```
    Adds a proxy function (for events) to a model at the specific key.
    
    Parameters:
    
    model - element where adding the function proxy
    
    key - property name to use to add the function proxy
    
    proxy - the function proxy instance to add
  - setCallbackToModel
```
protected final void setCallbackToModel(org.pepstock.charba.client.options.AbstractModel<?,?> model,
                                        Key key,
                                        CallbackProxy.Proxy proxy)
```
    Adds a proxy function (for callbacks) to a model at the specific key.
    
    Parameters:
    
    model - element where adding the function proxy
    
    key - property name to use to add the function proxy
    
    proxy - the function proxy instance to add
  - checkAndAddToParent
```
protected final void checkAndAddToParent()
```
    Called recursively when a property has been set in the item.
    This is mandatory because it could happen that the parent item is not present, therefore it must be added.

Class Time

Method Summary

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

Methods inherited from class java.lang.Object

Method Detail

getDisplayFormats

setIsoWeekday

isIsoWeekday

setRound

setRound

getRound

setTooltipFormat

getTooltipFormat

setUnit

setUnit

getUnit

setStepSize

getStepSize

setMinUnit

getMinUnit

setParser

getParser

getChildKey

getParent

getDefaultValues

setEventToModel

setCallbackToModel

checkAndAddToParent