com.github.gwtbootstrap.datetimepicker.client.ui.base

Class DateTimeBoxBase

java.lang.Object

com.google.gwt.user.client.ui.UIObject

com.google.gwt.user.client.ui.Widget

com.github.gwtbootstrap.datetimepicker.client.ui.base.DateTimeBoxBase

All Implemented Interfaces:

HasAlternateSize, HasId, HasPlaceholder, HasSize, HasStyle, IsResponsive, IsSearchQuery, HasVisibleHandlers, HasAllDateTimePickerHandlers, HasAutoclose, HasDateFormat, HasDaysOfWeek, HasEndDate, HasLanguage, HasMinutes, HasStartDate, HasToday, HasViewMode, HasWeekStart, com.google.gwt.editor.client.IsEditor<com.google.gwt.editor.client.adapters.TakesValueEditor<Date>>, com.google.gwt.event.dom.client.HasChangeHandlers, com.google.gwt.event.logical.shared.HasAttachHandlers, com.google.gwt.event.logical.shared.HasValueChangeHandlers<Date>, com.google.gwt.event.shared.HasHandlers, com.google.gwt.user.client.EventListener, com.google.gwt.user.client.TakesValue<Date>, com.google.gwt.user.client.ui.HasEnabled, com.google.gwt.user.client.ui.HasValue<Date>, com.google.gwt.user.client.ui.HasVisibility, com.google.gwt.user.client.ui.IsWidget

Direct Known Subclasses:

DateTimeBox

public class DateTimeBoxBase
extends com.google.gwt.user.client.ui.Widget
implements com.google.gwt.user.client.ui.HasValue<Date>, com.google.gwt.user.client.ui.HasEnabled, com.google.gwt.event.logical.shared.HasValueChangeHandlers<Date>, HasVisibility, com.google.gwt.event.dom.client.HasChangeHandlers, HasVisibleHandlers, HasAllDateTimePickerHandlers, com.google.gwt.editor.client.IsEditor<com.google.gwt.editor.client.adapters.TakesValueEditor<Date>>, HasPlaceholder, HasAlternateSize, IsSearchQuery, HasSize, HasId, IsResponsive, HasStyle

Base DateTimePicker component.

Since:

2.1.1.0

Author:

Carlos Alexandro Becker, ohashi keisuke, Alain Penders

Nested Class Summary

Nested classes/interfaces inherited from class com.google.gwt.user.client.ui.UIObject

com.google.gwt.user.client.ui.UIObject.DebugIdImpl, com.google.gwt.user.client.ui.UIObject.DebugIdImplEnabled

Nested classes/interfaces inherited from interface com.github.gwtbootstrap.datetimepicker.client.ui.base.HasViewMode

HasViewMode.ViewMode

Field Summary

Fields inherited from class com.google.gwt.user.client.ui.UIObject

DEBUG_ID_PREFIX

Constructor Summary

Constructors

Constructor and Description
DateTimeBoxBase()

Method Summary

Methods

Modifier and Type	Method and Description
com.google.gwt.event.shared.HandlerRegistration	addChangeHandler(com.google.gwt.event.dom.client.ChangeHandler handler)
com.google.gwt.event.shared.HandlerRegistration	addHiddenHandler(HiddenHandler handler) Adds a HiddenEvent handler.
com.google.gwt.event.shared.HandlerRegistration	addHideHandler(HideHandler handler) Adds a HideEvent handler.
com.google.gwt.event.shared.HandlerRegistration	addShowHandler(ShowHandler handler) Adds a ShowEvent handler.
com.google.gwt.event.shared.HandlerRegistration	addShownHandler(ShownHandler handler) Adds a ShownEvent handler.
void	addStyle(Style style) Adds the provided style to the widget.
com.google.gwt.event.shared.HandlerRegistration	addValueChangeHandler(com.google.gwt.event.logical.shared.ValueChangeHandler<Date> dateValueChangeHandler)
com.google.gwt.editor.client.adapters.TakesValueEditor<Date>	asEditor() Return Editor
protected void	configure() configure this datetimepicker.
protected void	configure(com.google.gwt.dom.client.Element e, boolean autoclose, int minuteStep, boolean todayButton, boolean highlightToday, String minViewMode, String startViewMode, String maxViewMode, String pickerPosition) call jquery datetimepicker plugin in a element.
protected void	configure(com.google.gwt.user.client.ui.Widget w) Configure the elements for a specific widget.
protected TextBox	getBox() Returns the internal instance of textbox element.
String	getId() Get ID
String	getOriginalValue() Get un-transformed text
PickerPosition	getPickerPosition()
String	getPlaceholder() Get a placeholder attribute (HTML5).
Date	getValue()
void	hide() Hides the widget if it was previously shown.
boolean	isEnabled()
boolean	isReadOnly()
boolean	isSearchQuery() is the element search-query style?
void	onChange() dateChange event handler.
void	onHide(com.google.gwt.user.client.Event e)
protected void	onLoad()
void	onShow(com.google.gwt.user.client.Event e)
protected void	onUnload()
void	reconfigure()
protected void	removeDataIfExists(com.google.gwt.dom.client.Element e)
void	removeStyle(Style style) Removes the provided style from the widget.
void	setAlignment(com.google.gwt.user.client.ui.ValueBoxBase.TextAlignment align)
void	setAlternateSize(AlternateSize size)
void	setAutoClose(boolean autoclose) Determine if the element will autoclose in some events.
void	setDaysOfWeekDisabled(String value) Disable days of week view.
void	setEnabled(boolean enabled)
void	setEndDate_(Date endDate) Set the max date in the component.
void	setEndDate(String endDate) Set the max date in the component.
void	setFormat(String format) Set the format in the component.
void	setHideOn(Device device) Sets the kind of device, this widget is hidden on.
void	setHighlightToday(boolean highlight)
void	setId(String id) Set ID
void	setLanguage(String language) Setup the language of the component.
void	setMaxView(HasViewMode.ViewMode mode) Set the Max ViewMode
void	setMaxView(String mode) Set the Max ViewMode
void	setMinuteStep(int minutes)
void	setMinView(HasViewMode.ViewMode mode) Set the Min ViewMode
void	setMinView(String mode) Set the Min ViewMode
void	setPickerPosition(PickerPosition pickerPosition)
void	setPlaceholder(String placeholder) Set a placeholder attribute (HTML5).
void	setReadOnly(boolean readonly)
void	setSearchQuery(boolean searchQuery) Set search-query style to the element.
void	setShowOn(Device device) Sets the kind of device, this widget is shown on.
void	setShowTodayButton(boolean show)
void	setSize(int size) Sets the widget's size.
void	setStartDate_(Date startDate) Set the min date in the component.
void	setStartDate(String startDate) Set the min date in the component.
void	setStartView(HasViewMode.ViewMode mode) Set the Start ViewMode
void	setStartView(String mode) Set the Start ViewMode
void	setStyle(Style style) Replaces the widet's style with the provided one.
void	setValue(Date value)
void	setValue(Date value, boolean fireEvents)
void	setWeekStart(int start) Define the first day of week in the datepicker.
void	show() Shows the widget if it was previously hidden.
void	toggle() Toggles the view state of the widget.
protected void	updateValue(com.google.gwt.dom.client.Element e)

Methods inherited from class com.google.gwt.user.client.ui.Widget

addAttachHandler, addBitlessDomHandler, addDomHandler, addHandler, asWidget, asWidgetOrNull, createHandlerManager, delegateEvent, doAttachChildren, doDetachChildren, fireEvent, getHandlerCount, getLayoutData, getParent, isAttached, isOrWasAttached, onAttach, onBrowserEvent, onDetach, removeFromParent, setLayoutData, setParent, sinkEvents

Methods inherited from class com.google.gwt.user.client.ui.UIObject

addStyleDependentName, addStyleName, ensureDebugId, ensureDebugId, ensureDebugId, getAbsoluteLeft, getAbsoluteTop, getElement, getOffsetHeight, getOffsetWidth, getStyleElement, getStyleName, getStyleName, getStylePrimaryName, getStylePrimaryName, getTitle, isVisible, isVisible, onEnsureDebugId, removeStyleDependentName, removeStyleName, resolvePotentialElement, setElement, setHeight, setPixelSize, setSize, setStyleDependentName, setStyleName, setStyleName, setStyleName, setStyleName, setStylePrimaryName, setStylePrimaryName, setTitle, setVisible, setVisible, setWidth, sinkBitlessEvent, toString, unsinkEvents

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.gwt.event.shared.HasHandlers

fireEvent

Constructor Detail

DateTimeBoxBase

public DateTimeBoxBase()

Method Detail

setAlignment

public void setAlignment(com.google.gwt.user.client.ui.ValueBoxBase.TextAlignment align)

isReadOnly

public boolean isReadOnly()

See Also:

ValueBoxBase.isReadOnly()

setReadOnly

public void setReadOnly(boolean readonly)

See Also:

ValueBoxBase.setReadOnly(boolean)

setFormat

public void setFormat(String format)

Set the format in the component. (In DPGlobal format!)

Specified by:

setFormat in interface HasDateFormat

setLanguage

public void setLanguage(String language)

Description copied from interface: HasLanguage

Setup the language of the component. Depend on the JS plugin behavior, it can not work after the widget is already visible.

Specified by:

setLanguage in interface HasLanguage

getBox

protected TextBox getBox()

Returns the internal instance of textbox element. Use only if know what you are doing.

Returns:

internal textbox intance.

getValue

public Date getValue()

Specified by:

getValue in interface com.google.gwt.user.client.TakesValue<Date>

Specified by:

getValue in interface com.google.gwt.user.client.ui.HasValue<Date>

getOriginalValue

public String getOriginalValue()

Get un-transformed text

Returns:

text box value

setValue

public void setValue(Date value)

Specified by:

setValue in interface com.google.gwt.user.client.TakesValue<Date>

Specified by:

setValue in interface com.google.gwt.user.client.ui.HasValue<Date>

setValue

public void setValue(Date value,
            boolean fireEvents)

Specified by:

setValue in interface com.google.gwt.user.client.ui.HasValue<Date>

updateValue

protected void updateValue(com.google.gwt.dom.client.Element e)

addValueChangeHandler

public com.google.gwt.event.shared.HandlerRegistration addValueChangeHandler(com.google.gwt.event.logical.shared.ValueChangeHandler<Date> dateValueChangeHandler)

Specified by:

addValueChangeHandler in interface com.google.gwt.event.logical.shared.HasValueChangeHandlers<Date>

onLoad

protected void onLoad()

Overrides:

onLoad in class com.google.gwt.user.client.ui.Widget

onUnload

protected void onUnload()

Overrides:

onUnload in class com.google.gwt.user.client.ui.Widget

configure

protected void configure(com.google.gwt.user.client.ui.Widget w)

Configure the elements for a specific widget. Use only if you know what you are doing.

Parameters:

w: - the widget to configure.

onChange

public void onChange()

dateChange event handler.

onShow

public void onShow(com.google.gwt.user.client.Event e)

onHide

public void onHide(com.google.gwt.user.client.Event e)

reconfigure

public void reconfigure()

configure

protected void configure()

configure this datetimepicker.

removeDataIfExists

protected void removeDataIfExists(com.google.gwt.dom.client.Element e)

configure

protected void configure(com.google.gwt.dom.client.Element e,
             boolean autoclose,
             int minuteStep,
             boolean todayButton,
             boolean highlightToday,
             String minViewMode,
             String startViewMode,
             String maxViewMode,
             String pickerPosition)

call jquery datetimepicker plugin in a element.

Parameters:

e: - Element that will be transformed in a datetimepicker.

autoclose - is autoclose?

show

public void show()

Shows the widget if it was previously hidden.

hide

public void hide()

Hides the widget if it was previously shown.

toggle

public void toggle()

Toggles the view state of the widget.

It will be hidden if it was previously shown and shown if it was previously hidden.

addHideHandler

public com.google.gwt.event.shared.HandlerRegistration addHideHandler(HideHandler handler)

Adds a HideEvent handler.

Specified by:

addHideHandler in interface HasVisibleHandlers

Parameters:

handler - the hide handler

Returns:

HandlerRegistration used to remove this handler

addHiddenHandler

public com.google.gwt.event.shared.HandlerRegistration addHiddenHandler(HiddenHandler handler)

Adds a HiddenEvent handler.

Specified by:

addHiddenHandler in interface HasVisibleHandlers

Parameters:

handler - the hidden handler

Returns:

HandlerRegistration used to remove this handler

addShowHandler

public com.google.gwt.event.shared.HandlerRegistration addShowHandler(ShowHandler handler)

Adds a ShowEvent handler.

Specified by:

addShowHandler in interface HasVisibleHandlers

Parameters:

handler - the show handler

Returns:

HandlerRegistration used to remove this handler

addShownHandler

public com.google.gwt.event.shared.HandlerRegistration addShownHandler(ShownHandler handler)

Adds a ShownEvent handler.

Specified by:

addShownHandler in interface HasVisibleHandlers

Parameters:

handler - the shown handler

Returns:

HandlerRegistration used to remove this handler

setWeekStart

public void setWeekStart(int start)

Define the first day of week in the datepicker.

Specified by:

setWeekStart in interface HasWeekStart

setStartDate

public void setStartDate(String startDate)

Set the min date in the component.

Specified by:

setStartDate in interface HasStartDate

setStartDate_

public void setStartDate_(Date startDate)

Set the min date in the component.

Specified by:

setStartDate_ in interface HasStartDate

setEndDate

public void setEndDate(String endDate)

Set the max date in the component.

Specified by:

setEndDate in interface HasEndDate

setEndDate_

public void setEndDate_(Date endDate)

Set the max date in the component.

Specified by:

setEndDate_ in interface HasEndDate

setAutoClose

public void setAutoClose(boolean autoclose)

Determine if the element will autoclose in some events.

Specified by:

setAutoClose in interface HasAutoclose

setMinView

public void setMinView(HasViewMode.ViewMode mode)

Set the Min ViewMode

Specified by:

setMinView in interface HasViewMode

Parameters:

mode - ViewMode.{HOUR,DAY,MONTH,YEAR,DECADE}

setMinView

public void setMinView(String mode)

Set the Min ViewMode

Specified by:

setMinView in interface HasViewMode

Parameters:

mode - One of (HOUR,DAY,MONTH,YEAR,DECADE), case-insensitive

setStartView

public void setStartView(HasViewMode.ViewMode mode)

Set the Start ViewMode

Specified by:

setStartView in interface HasViewMode

Parameters:

mode - ViewMode.{HOUR,DAY,MONTH,YEAR,DECADE}

setStartView

public void setStartView(String mode)

Set the Start ViewMode

Specified by:

setStartView in interface HasViewMode

Parameters:

mode - One of (HOUR,DAY,MONTH,YEAR,DECADE), case-insensitive

setMaxView

public void setMaxView(HasViewMode.ViewMode mode)

Set the Max ViewMode

Specified by:

setMaxView in interface HasViewMode

Parameters:

mode - ViewMode.{HOUR,DAY,MONTH,YEAR,DECADE}

setMaxView

public void setMaxView(String mode)

Set the Max ViewMode

Specified by:

setMaxView in interface HasViewMode

Parameters:

mode - One of (HOUR,DAY,MONTH,YEAR,DECADE), case-insensitive

asEditor

public com.google.gwt.editor.client.adapters.TakesValueEditor<Date> asEditor()

Return Editor

Specified by:

asEditor in interface com.google.gwt.editor.client.IsEditor<com.google.gwt.editor.client.adapters.TakesValueEditor<Date>>

Returns:

editor

addChangeHandler

public com.google.gwt.event.shared.HandlerRegistration addChangeHandler(com.google.gwt.event.dom.client.ChangeHandler handler)

Specified by:

addChangeHandler in interface com.google.gwt.event.dom.client.HasChangeHandlers

setPlaceholder

public void setPlaceholder(String placeholder)

Set a placeholder attribute (HTML5).

Specified by:

setPlaceholder in interface HasPlaceholder

Parameters:

placeholder - the String to show. Use a empty string or null to remove the attribute.

getPlaceholder

public String getPlaceholder()

Get a placeholder attribute (HTML5).

Specified by:

getPlaceholder in interface HasPlaceholder

Returns:

placeholder attribute.

setSearchQuery

public void setSearchQuery(boolean searchQuery)

Set search-query style to the element.

Specified by:

setSearchQuery in interface IsSearchQuery

Parameters:

searchQuery - true:add search-query css-class/false:remove search-query css-class

isSearchQuery

public boolean isSearchQuery()

is the element search-query style?

Specified by:

isSearchQuery in interface IsSearchQuery

Returns:

true:has search-query css-class/false:has no search-query cass-class.

setAlternateSize

public void setAlternateSize(AlternateSize size)

Specified by:

setAlternateSize in interface HasAlternateSize

setSize

public void setSize(int size)

Sets the widget's size.

Specified by:

setSize in interface HasSize

Parameters:

size - the size of the widget in the Bootstrap grid system

getId

public String getId()

Get ID

Specified by:

getId in interface HasId

Returns:

ID

setId

public void setId(String id)

Set ID

Specified by:

setId in interface HasId

Parameters:

id - set id

setShowOn

public void setShowOn(Device device)

Sets the kind of device, this widget is shown on.

The widget is not shown on any other device.

Only works if responsive design is turned on!

Specified by:

setShowOn in interface IsResponsive

See Also:

Configurator.hasResponsiveDesign(), IsResponsive.setHideOn(Device)

setHideOn

public void setHideOn(Device device)

Sets the kind of device, this widget is hidden on.

The widget is not hidden on any other device.

Only works if responsive design is turned on!

Specified by:

setHideOn in interface IsResponsive

See Also:

Configurator.hasResponsiveDesign(), IsResponsive.setShowOn(Device)

setStyle

public void setStyle(Style style)

Replaces the widet's style with the provided one.

Specified by:

setStyle in interface HasStyle

Parameters:

style - the style to be applied to the Widget.

addStyle

public void addStyle(Style style)

Adds the provided style to the widget.

Specified by:

addStyle in interface HasStyle

Parameters:

style - the style to be added to the Widget.

removeStyle

public void removeStyle(Style style)

Removes the provided style from the widget.

Specified by:

removeStyle in interface HasStyle

Parameters:

style - the style to be removed from the Widget.

isEnabled

public boolean isEnabled()

Specified by:

isEnabled in interface com.google.gwt.user.client.ui.HasEnabled

setEnabled

public void setEnabled(boolean enabled)

Specified by:

setEnabled in interface com.google.gwt.user.client.ui.HasEnabled

setDaysOfWeekDisabled

public void setDaysOfWeekDisabled(String value)

Description copied from interface: HasDaysOfWeek

Disable days of week view.

Specified by:

setDaysOfWeekDisabled in interface HasDaysOfWeek

Parameters:

value - Days of week which are disabled: "0,6"

setMinuteStep

public void setMinuteStep(int minutes)

Specified by:

setMinuteStep in interface HasMinutes

setShowTodayButton

public void setShowTodayButton(boolean show)

Specified by:

setShowTodayButton in interface HasToday

setHighlightToday

public void setHighlightToday(boolean highlight)

Specified by:

setHighlightToday in interface HasToday

getPickerPosition

public PickerPosition getPickerPosition()

setPickerPosition

public void setPickerPosition(PickerPosition pickerPosition)