org.gwt.advanced.client.ui.widget

Class DatePicker

java.lang.Object

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

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

com.google.gwt.user.client.ui.Panel

com.google.gwt.user.client.ui.SimplePanel

org.gwt.advanced.client.ui.widget.TextButtonPanel<Date>

org.gwt.advanced.client.ui.widget.DatePicker

All Implemented Interfaces:

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.AcceptsOneWidget, com.google.gwt.user.client.ui.HasOneWidget, com.google.gwt.user.client.ui.HasValue<Date>, com.google.gwt.user.client.ui.HasVisibility, com.google.gwt.user.client.ui.HasWidgets, com.google.gwt.user.client.ui.HasWidgets.ForIsWidget, com.google.gwt.user.client.ui.IsWidget, Iterable<com.google.gwt.user.client.ui.Widget>, AdvancedWidget, CalendarListener<Calendar>

public class DatePicker
extends TextButtonPanel<Date>
implements CalendarListener<Calendar>, com.google.gwt.event.dom.client.HasChangeHandlers

This is a date picker widget.

Since:

1.0.0

Author:

Sergey Skladchikov

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	DatePicker.OpenCalendarClickHandler This is an open calendar evbent handler implementation.

Nested classes/interfaces inherited from class org.gwt.advanced.client.ui.widget.TextButtonPanel

TextButtonPanel.EnterAction

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.google.gwt.user.client.ui.HasWidgets

com.google.gwt.user.client.ui.HasWidgets.ForIsWidget

Field Summary

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

DEBUG_ID_PREFIX

Constructor Summary

Constructors

Constructor and Description
DatePicker() Creates an instance of this class and does nothing else.
DatePicker(Date initialDate) Creates an instance of this class.

Method Summary

Methods

Modifier and Type	Method and Description
com.google.gwt.event.shared.HandlerRegistration	addChangeHandler(com.google.gwt.event.dom.client.ChangeHandler handler)
protected void	addComponentListeners() This method adds different listeners to elements of the widget.
com.google.gwt.event.shared.HandlerRegistration	addValueChangeHandler(com.google.gwt.event.logical.shared.ValueChangeHandler<Date> handler) Adds a value change handler to the component that will be invoked only if HasValue.setValue(Object, boolean) has the second parameter = true.
void	display() Deprecated. you don't have to invoke this method any more
protected Calendar	getCalendar() Getter for property 'calendar'.
protected com.google.gwt.user.client.ui.PopupPanel	getCalendarPanel() Getter for property 'calendarPanel'.
Date	getDate() Deprecated. use getValue() instead.
protected String	getDefaultImageName() This method should returns a default button image name.
protected com.google.gwt.i18n.client.DateTimeFormat	getFormat() Getter for property 'format'.
String	getTextualDate() Gets a textual representation of the date using format properties.
Date	getValue() Similar to getDate()
boolean	isTimeVisible() Getter for property 'timeVisible'.
void	onCancel(Calendar sender) This method is invoked on cancel.
void	onChange(Calendar sender, Date oldValue) This method is invoked when a user chooses a date.
protected void	prepareSelectedValue() Prepares the selected value box for displaying.
void	setDate(Date date) Deprecated. use setValue(Date) instead.
void	setFormat(String format) Sets a format string for the displaying date and time.
void	setTimeVisible(boolean timeVisible) Setter for property 'timeVisible'.
void	setValue(Date value) Similar to setDate(Date) and doesn't send any event
void	setValue(Date value, boolean fireEvents) Similar to setDate(Date) and sends ValueChangeEvent if fireEvents = true

Methods inherited from class org.gwt.advanced.client.ui.widget.TextButtonPanel

cleanSelection, getChoiceButton, getChoiceButtonImage, getEnterAction, getHeight, getLayout, getLockingPanel, getMaxLength, getSelectedValue, getWidth, isChoiceButtonVisible, isCustomTextAllowed, isEnabled, isLocked, lock, prepareChoiceButton, setChoiceButtonImage, setChoiceButtonVisible, setCustomTextAllowed, setEnabled, setEnterAction, setHeight, setLocked, setMaxLength, setTabIndex, setWidth, unlock

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

add, getContainerElement, getWidget, iterator, remove, setWidget, setWidget

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

add, adopt, adopt, clear, disown, doAttachChildren, doDetachChildren, orphan, remove

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

addAttachHandler, addBitlessDomHandler, addDomHandler, addHandler, asWidget, asWidgetOrNull, createHandlerManager, delegateEvent, fireEvent, getHandlerCount, getLayoutData, getParent, isAttached, isOrWasAttached, onAttach, onBrowserEvent, onDetach, onLoad, onUnload, 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, setPixelSize, setSize, setStyleDependentName, setStyleName, setStyleName, setStyleName, setStyleName, setStylePrimaryName, setStylePrimaryName, setTitle, setVisible, setVisible, 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

DatePicker

public DatePicker()

Creates an instance of this class and does nothing else.

DatePicker

public DatePicker(Date initialDate)

Creates an instance of this class.

Parameters:

initialDate - is an initial date.

Method Detail

isTimeVisible

public boolean isTimeVisible()

Getter for property 'timeVisible'.

Returns:

Value for property 'timeVisible'.

setTimeVisible

public void setTimeVisible(boolean timeVisible)

Setter for property 'timeVisible'.

Parameters:

timeVisible - Value to set for property 'timeVisible'.

onChange

public void onChange(Calendar sender,
            Date oldValue)

This method is invoked when a user chooses a date.

Specified by:

onChange in interface CalendarListener<Calendar>

Parameters:

sender - is a calendar which sent the event.

oldValue - is an old date value.

onCancel

public void onCancel(Calendar sender)

This method is invoked on cancel.

Specified by:

onCancel in interface CalendarListener<Calendar>

Parameters:

sender - is a calendar which sent the event.

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

getDate

public Date getDate()

Deprecated. use getValue() instead.

Getter for property 'date'.

Returns:

Value for property 'date'.

setDate

public void setDate(Date date)

Deprecated. use setValue(Date) instead.

Sets a date for this date picker.

Parameters:

date - is a date to set.

display

public void display()

Deprecated. you don't have to invoke this method any more

This method displayes a widget.

Specified by:

display in interface AdvancedWidget

Overrides:

display in class TextButtonPanel<Date>

getTextualDate

public String getTextualDate()

Gets a textual representation of the date using format properties.

Returns:

textual representation.

setFormat

public void setFormat(String format)

Sets a format string for the displaying date and time.

It overrides the format specified in the resource file. For more details see docs for the DateTimeFormat class.

Parameters:

format - is a format string.

getValue

public Date getValue()

Similar to getDate()

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>

setValue

public void setValue(Date value)

Similar to setDate(Date) and doesn't send any event

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)

Similar to setDate(Date) and sends ValueChangeEvent if fireEvents = true

Specified by:

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

addValueChangeHandler

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

Adds a value change handler to the component that will be invoked only if HasValue.setValue(Object, boolean) has the second parameter = true.

Note that the widget doesn't fire the event if you don't use the method specified above.

Specified by:

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

prepareSelectedValue

protected void prepareSelectedValue()

Prepares the selected value box for displaying.

Overrides:

prepareSelectedValue in class TextButtonPanel<Date>

getDefaultImageName

protected String getDefaultImageName()

This method should returns a default button image name.

Specified by:

getDefaultImageName in class TextButtonPanel<Date>

Returns:

an image name.

addComponentListeners

protected void addComponentListeners()

This method adds different listeners to elements of the widget.

Specified by:

addComponentListeners in class TextButtonPanel<Date>

getCalendar

protected Calendar getCalendar()

Getter for property 'calendar'.

Returns:

Value for property 'calendar'.

getCalendarPanel

protected com.google.gwt.user.client.ui.PopupPanel getCalendarPanel()

Getter for property 'calendarPanel'.

Returns:

Value for property 'calendarPanel'.

getFormat

protected com.google.gwt.i18n.client.DateTimeFormat getFormat()

Getter for property 'format'.

Returns:

Value for property 'format'.