com.github.gwtbootstrap.timepicker.client.ui.base

Class TimeBoxBase

java.lang.Object

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

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

com.github.gwtbootstrap.timepicker.client.ui.base.TimeBoxBase

All Implemented Interfaces:

HasAlternateSize, HasId, HasPlaceholder, HasSize, HasStyle, IsResponsive, IsSearchQuery, HasVisibleHandlers, HasDefaultTime, HasDisableFocus, HasMeridian, HasMinuteStep, HasModalBackdrop, HasSecondStep, HasShowInputs, HasShowSeconds, HasTemplate, HasTimeFormat, HasAttachHandlers, HasValueChangeHandlers<Date>, HasHandlers, EventListener, TakesValue<Date>, HasEnabled, HasValue<Date>, HasVisibility, IsWidget

Direct Known Subclasses:

TimeBox

public class TimeBoxBase
extends Widget
implements HasVisibleHandlers, HasPlaceholder, HasTemplate, HasShowInputs, HasSecondStep, HasModalBackdrop, HasMinuteStep, HasDisableFocus, HasDefaultTime, HasShowSeconds, HasMeridian, HasAlternateSize, IsSearchQuery, HasSize, HasId, IsResponsive, HasStyle, HasValue<Date>, HasEnabled, HasValueChangeHandlers<Date>, HasVisibility, HasTimeFormat

Base TimePicker component.

Since:

2.3.2.0

Author:

Carlos Alexandro Becker, Joshua Godi

Nested Class Summary

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

UIObject.DebugIdImpl, UIObject.DebugIdImplEnabled

Nested classes/interfaces inherited from interface com.github.gwtbootstrap.timepicker.client.ui.base.HasTemplate

HasTemplate.Template

Nested classes/interfaces inherited from interface com.github.gwtbootstrap.timepicker.client.ui.base.HasDefaultTime

HasDefaultTime.DefaultTime

Field Summary

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

DEBUG_ID_PREFIX

Constructor Summary

Constructors

Constructor and Description
TimeBoxBase()

Method Summary

Methods

Modifier and Type	Method and Description
HandlerRegistration	addHiddenHandler(HiddenHandler handler) Adds a HiddenEvent handler.
HandlerRegistration	addHideHandler(HideHandler handler) Adds a HideEvent handler.
HandlerRegistration	addShowHandler(ShowHandler handler) Adds a ShowEvent handler.
HandlerRegistration	addShownHandler(ShownHandler handler) Adds a ShownEvent handler.
void	addStyle(Style style) Adds the provided style to the widget.
HandlerRegistration	addValueChangeHandler(ValueChangeHandler<Date> handler)
protected void	configure() configure this timepicker
protected void	configure(Element e, String template, String defaultTime, int minuteStep, boolean showSeconds, int secondStep, boolean showMeridian, boolean showInputs, boolean disableFocus, boolean modalBackdrop) call jquery timepicker plugin in a element.
protected void	configure(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
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?
protected void	onLoad()
protected void	onUnload() This method is called immediately before a widget will be detached from the browser's document.
void	reconfigure() Removes any data in the time picker and reconfigures it
protected void	removeDataIfExists(Element e) Safely removes data
void	removeStyle(Style style) Removes the provided style from the widget.
void	setAlternateSize(AlternateSize size)
void	setDefaultTime(HasDefaultTime.DefaultTime defaultTime) Set the defaultTime of the component.
void	setDefaultTime(String defaultTime) Set the defaultTime of the component.
void	setDisableFocus(boolean disableFocus) Sets the disableFocus property component
void	setEnabled(boolean enabled)
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	setId(String id) Set ID
void	setMeridian(boolean meridian) Determine if the element will meridian in some events.
void	setMinuteStep(int minuteStep) Sets the minuteStep property on the component
void	setModalBackdrop(boolean modalBackdrop) Sets the hasModalBackdrop property component
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	setSecondStep(int secondStep) Sets the secondStep property on the component
void	setShowInputs(boolean showInputs) Sets the showInputs property component
void	setShowOn(Device device) Sets the kind of device, this widget is shown on.
void	setShowSeconds(boolean showSeconds) Sets the showSeconds property component
void	setSize(int size) Sets the widget's size.
void	setStyle(Style style) Replaces the widet's style with the provided one.
void	setTemplate(HasTemplate.Template template) Set the template of the timepicker.
void	setTemplate(String template) Set the template of the timepicker.
void	setValue(Date value)
void	setValue(Date value, boolean fireEvents)
void	show() Shows the widget if it was previously hidden.
void	toggle() Toggles the view state of the widget.
protected void	updateValue(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, 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, 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

TimeBoxBase

public TimeBoxBase()

Method Detail

isReadOnly

public boolean isReadOnly()

See Also:

ValueBoxBase.isReadOnly()

setReadOnly

public void setReadOnly(boolean readonly)

See Also:

ValueBoxBase.setReadOnly(boolean)

getBox

protected TextBox getBox()

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

Returns:

internal textbox intance.

getOriginalValue

public String getOriginalValue()

Get un-transformed text

Returns:

text box value

getValue

public Date getValue()

Specified by:

getValue in interface TakesValue<Date>

Specified by:

getValue in interface HasValue<Date>

setValue

public void setValue(Date value)

Specified by:

setValue in interface TakesValue<Date>

Specified by:

setValue in interface HasValue<Date>

updateValue

protected void updateValue(Element e)

setValue

public void setValue(Date value,
            boolean fireEvents)

Specified by:

setValue in interface HasValue<Date>

configure

protected void configure()

configure this timepicker

configure

protected void configure(Widget w)

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

Parameters:

w: - the widget to configure.

configure

protected void configure(Element e,
             String template,
             String defaultTime,
             int minuteStep,
             boolean showSeconds,
             int secondStep,
             boolean showMeridian,
             boolean showInputs,
             boolean disableFocus,
             boolean modalBackdrop)

call jquery timepicker plugin in a element.

Parameters:

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

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()

Description copied from interface: HasVisibility

Toggles the view state of the widget.

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

removeDataIfExists

protected void removeDataIfExists(Element e)

Safely removes data

Parameters:

e: - Element that will be cleared

reconfigure

public void reconfigure()

Removes any data in the time picker and reconfigures it

onLoad

protected void onLoad()

Overrides:

onLoad in class Widget

onUnload

protected void onUnload()

This method is called immediately before a widget will be detached from the browser's document.

Overrides:

onUnload in class Widget

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.

setTemplate

public void setTemplate(HasTemplate.Template template)

Set the template of the timepicker.

Specified by:

setTemplate in interface HasTemplate

setTemplate

public void setTemplate(String template)

Set the template of the timepicker.

Specified by:

setTemplate in interface HasTemplate

setMeridian

public void setMeridian(boolean meridian)

Determine if the element will meridian in some events.

Specified by:

setMeridian in interface HasMeridian

setAlternateSize

public void setAlternateSize(AlternateSize size)

Specified by:

setAlternateSize in interface HasAlternateSize

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

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

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.

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)

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.

isEnabled

public boolean isEnabled()

Specified by:

isEnabled in interface HasEnabled

setEnabled

public void setEnabled(boolean enabled)

Specified by:

setEnabled in interface HasEnabled

setShowSeconds

public void setShowSeconds(boolean showSeconds)

Sets the showSeconds property component

Specified by:

setShowSeconds in interface HasShowSeconds

setDisableFocus

public void setDisableFocus(boolean disableFocus)

Sets the disableFocus property component

Specified by:

setDisableFocus in interface HasDisableFocus

setModalBackdrop

public void setModalBackdrop(boolean modalBackdrop)

Sets the hasModalBackdrop property component

Specified by:

setModalBackdrop in interface HasModalBackdrop

setShowInputs

public void setShowInputs(boolean showInputs)

Sets the showInputs property component

Specified by:

setShowInputs in interface HasShowInputs

setMinuteStep

public void setMinuteStep(int minuteStep)

Sets the minuteStep property on the component

Specified by:

setMinuteStep in interface HasMinuteStep

setSecondStep

public void setSecondStep(int secondStep)

Sets the secondStep property on the component

Specified by:

setSecondStep in interface HasSecondStep

setDefaultTime

public void setDefaultTime(HasDefaultTime.DefaultTime defaultTime)

Set the defaultTime of the component.

Specified by:

setDefaultTime in interface HasDefaultTime

setDefaultTime

public void setDefaultTime(String defaultTime)

Set the defaultTime of the component.

Specified by:

setDefaultTime in interface HasDefaultTime

addHideHandler

public 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 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 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 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

addValueChangeHandler

public HandlerRegistration addValueChangeHandler(ValueChangeHandler<Date> handler)

Specified by:

addValueChangeHandler in interface HasValueChangeHandlers<Date>

setFormat

public void setFormat(String format)

Description copied from interface: HasTimeFormat

Set the format in the component.

Specified by:

setFormat in interface HasTimeFormat