com.google.gwt.user.datepicker.client
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.Composite
              com.google.gwt.user.datepicker.client.DatePicker

All Implemented Interfaces:

HasHighlightHandlers<java.util.Date>, HasShowRangeHandlers<java.util.Date>, HasValueChangeHandlers<java.util.Date>, HasHandlers, EventListener, HasValue<java.util.Date>, TakesValue<java.util.Date>

public class DatePicker
extends Composite
implements HasHighlightHandlers<java.util.Date>, HasShowRangeHandlers<java.util.Date>, HasValue<java.util.Date>

Standard GWT date picker.

CSS Style Rules

• .gwt-DatePicker { }
• .datePickerMonthSelector { the month selector widget }
• .datePickerMonth { the month in the month selector widget }
• .datePickerPreviousButton { the previous month button }
• .datePickerNextButton { the next month button }
• .datePickerDays { the portion of the picker that shows the days }
• .datePickerWeekdayLabel { the label over weekdays }
• .datePickerWeekendLabel { the label over weekends }
• .datePickerDay { a single day }
• .datePickerDayIsToday { today's date }
• .datePickerDayIsWeekend { a weekend day }
• .datePickerDayIsFiller { a day in another month }
• .datePickerDayIsValue { the selected day }
• .datePickerDayIsDisabled { a disabled day }
• .datePickerDayIsHighlighted { the currently highlighted day }
• .datePickerDayIsValueAndHighlighted { the highlighted day if it is also selected }

Example

Nested Class Summary

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

UIObject.DebugIdImpl, UIObject.DebugIdImplEnabled

Field Summary

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

DEBUG_ID_PREFIX

Constructor Summary

DatePicker()
Create a new date picker.

Method Summary

HandlerRegistration	addHighlightHandler(HighlightHandler<java.util.Date> handler) Adds a HighlightEvent handler.
HandlerRegistration	addShowRangeHandler(ShowRangeHandler<java.util.Date> handler) Adds a ShowRangeEvent handler.
HandlerRegistration	addShowRangeHandlerAndFire(ShowRangeHandler<java.util.Date> handler) Adds a show range handler and immediately activate the handler on the current view.
void	addStyleToDates(java.lang.String styleName, java.util.Date date) Add a style name to the given dates.
void	addStyleToDates(java.lang.String styleName, java.util.Date date, java.util.Date... moreDates) Add a style name to the given dates.
void	addStyleToDates(java.lang.String styleName, java.lang.Iterable<java.util.Date> dates) Add a style name to the given dates.
void	addTransientStyleToDates(java.lang.String styleName, java.util.Date date) Adds the given style name to the specified dates, which must be visible.
void	addTransientStyleToDates(java.lang.String styleName, java.util.Date date, java.util.Date... moreDates) Adds the given style name to the specified dates, which must be visible.
void	addTransientStyleToDates(java.lang.String styleName, java.lang.Iterable<java.util.Date> dates) Adds the given style name to the specified dates, which must be visible.
HandlerRegistration	addValueChangeHandler(ValueChangeHandler<java.util.Date> handler) Adds a ValueChangeEvent handler.
java.util.Date	getCurrentMonth() Gets the current month the date picker is showing.
java.util.Date	getFirstDate() Returns the first shown date.
java.util.Date	getHighlightedDate() Gets the highlighted date (the one the mouse is hovering over), if any.
java.util.Date	getLastDate() Returns the last shown date.
java.lang.String	getStyleOfDate(java.util.Date date) Gets the style associated with a date (does not include styles set via addTransientStyleToDates(java.lang.String, java.util.Date)).
java.util.Date	getValue() Returns the selected date, or null if none is selected.
boolean	isDateEnabled(java.util.Date date) Is the visible date enabled?
boolean	isDateVisible(java.util.Date date) Is the date currently shown in the date picker?
void	onLoad() This method is called immediately after a widget becomes attached to the browser's document.
void	removeStyleFromDates(java.lang.String styleName, java.util.Date date) Removes the styleName from the given dates (even if it is transient).
void	removeStyleFromDates(java.lang.String styleName, java.util.Date date, java.util.Date... moreDates) Removes the styleName from the given dates (even if it is transient).
void	removeStyleFromDates(java.lang.String styleName, java.lang.Iterable<java.util.Date> dates) Removes the styleName from the given dates (even if it is transient).
void	setCurrentMonth(java.util.Date month) Sets the date picker to show the given month, use getFirstDate() and getLastDate() to access the exact date range the date picker chose to display.
void	setStyleName(java.lang.String styleName) Sets the date picker style name.
void	setTransientEnabledOnDates(boolean enabled, java.util.Date date) Sets a visible date to be enabled or disabled.
void	setTransientEnabledOnDates(boolean enabled, java.util.Date date, java.util.Date... moreDates) Sets a visible date to be enabled or disabled.
void	setTransientEnabledOnDates(boolean enabled, java.lang.Iterable<java.util.Date> dates) Sets a group of visible dates to be enabled or disabled.
void	setValue(java.util.Date newValue) Sets the DatePicker's value.
void	setValue(java.util.Date newValue, boolean fireEvents) Sets the DatePicker's value.

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

isAttached, onBrowserEvent

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

fireEvent, getLayoutData, getParent, removeFromParent, setLayoutData, sinkEvents

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

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

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

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

fireEvent

Constructor Detail

DatePicker

public DatePicker()

Create a new date picker.

Method Detail

addHighlightHandler

public HandlerRegistration addHighlightHandler(HighlightHandler<java.util.Date> handler)

Description copied from interface: HasHighlightHandlers

Adds a HighlightEvent handler.

Specified by:

addHighlightHandler in interface HasHighlightHandlers<java.util.Date>

Parameters:

handler - the handler

Returns:

the registration for the event

addShowRangeHandler

public HandlerRegistration addShowRangeHandler(ShowRangeHandler<java.util.Date> handler)

Description copied from interface: HasShowRangeHandlers

Adds a ShowRangeEvent handler.

Specified by:

addShowRangeHandler in interface HasShowRangeHandlers<java.util.Date>

Parameters:

handler - the handler

Returns:

the registration for the event

addShowRangeHandlerAndFire

public HandlerRegistration addShowRangeHandlerAndFire(ShowRangeHandler<java.util.Date> handler)

Adds a show range handler and immediately activate the handler on the current view.

Parameters:

handler - the handler

Returns:

the handler registration

addStyleToDates

public void addStyleToDates(java.lang.String styleName,
                            java.util.Date date)

Add a style name to the given dates.

addStyleToDates

public void addStyleToDates(java.lang.String styleName,
                            java.util.Date date,
                            java.util.Date... moreDates)

Add a style name to the given dates.

addStyleToDates

public void addStyleToDates(java.lang.String styleName,
                            java.lang.Iterable<java.util.Date> dates)

Add a style name to the given dates.

addTransientStyleToDates

public void addTransientStyleToDates(java.lang.String styleName,
                                     java.util.Date date)

Adds the given style name to the specified dates, which must be visible. This is only set until the next time the DatePicker is refreshed.

addTransientStyleToDates

public final void addTransientStyleToDates(java.lang.String styleName,
                                           java.util.Date date,
                                           java.util.Date... moreDates)

Adds the given style name to the specified dates, which must be visible. This is only set until the next time the DatePicker is refreshed.

addTransientStyleToDates

public final void addTransientStyleToDates(java.lang.String styleName,
                                           java.lang.Iterable<java.util.Date> dates)

Adds the given style name to the specified dates, which must be visible. This is only set until the next time the DatePicker is refreshed.

addValueChangeHandler

public HandlerRegistration addValueChangeHandler(ValueChangeHandler<java.util.Date> handler)

Description copied from interface: HasValueChangeHandlers

Adds a ValueChangeEvent handler.

Specified by:

addValueChangeHandler in interface HasValueChangeHandlers<java.util.Date>

Parameters:

handler - the handler

Returns:

the registration for the event

getCurrentMonth

public java.util.Date getCurrentMonth()

Gets the current month the date picker is showing.

A datepicker may show days not in the current month. It must show all days in the current month.

Returns:

the current month

getFirstDate

public final java.util.Date getFirstDate()

Returns the first shown date.

Returns:

the first date.

getHighlightedDate

public final java.util.Date getHighlightedDate()

Gets the highlighted date (the one the mouse is hovering over), if any.

Returns:

the highlighted date

getLastDate

public final java.util.Date getLastDate()

Returns the last shown date.

Returns:

the last date.

getStyleOfDate

public java.lang.String getStyleOfDate(java.util.Date date)

Gets the style associated with a date (does not include styles set via addTransientStyleToDates(java.lang.String, java.util.Date)).

Parameters:

date - the date

Returns:

the styles associated with this date

getValue

public final java.util.Date getValue()

Returns the selected date, or null if none is selected.

Specified by:

getValue in interface HasValue<java.util.Date>

Specified by:

getValue in interface TakesValue<java.util.Date>

Returns:

the selected date, or null

isDateEnabled

public boolean isDateEnabled(java.util.Date date)

Is the visible date enabled?

Parameters:

date - the date, which must be visible

Returns:

is the date enabled?

isDateVisible

public boolean isDateVisible(java.util.Date date)

Is the date currently shown in the date picker?

Parameters:

date -

Returns:

is the date currently shown

onLoad

public void onLoad()

Description copied from class: Widget

This method is called immediately after a widget becomes attached to the browser's document.

removeStyleFromDates

public void removeStyleFromDates(java.lang.String styleName,
                                 java.util.Date date)

Removes the styleName from the given dates (even if it is transient).

removeStyleFromDates

public void removeStyleFromDates(java.lang.String styleName,
                                 java.util.Date date,
                                 java.util.Date... moreDates)

Removes the styleName from the given dates (even if it is transient).

removeStyleFromDates

public void removeStyleFromDates(java.lang.String styleName,
                                 java.lang.Iterable<java.util.Date> dates)

Removes the styleName from the given dates (even if it is transient).

setCurrentMonth

public void setCurrentMonth(java.util.Date month)

Sets the date picker to show the given month, use getFirstDate() and getLastDate() to access the exact date range the date picker chose to display.

A datepicker may show days not in the current month. It must show all days in the current month.

Parameters:

month - the month to show

setStyleName

public void setStyleName(java.lang.String styleName)

Sets the date picker style name.

Overrides:

setStyleName in class UIObject

Parameters:

styleName - the new style name

See Also:

UIObject.setStylePrimaryName(String)

setTransientEnabledOnDates

public final void setTransientEnabledOnDates(boolean enabled,
                                             java.util.Date date)

Sets a visible date to be enabled or disabled. This is only set until the next time the DatePicker is refreshed.

setTransientEnabledOnDates

public final void setTransientEnabledOnDates(boolean enabled,
                                             java.util.Date date,
                                             java.util.Date... moreDates)

Sets a visible date to be enabled or disabled. This is only set until the next time the DatePicker is refreshed.

setTransientEnabledOnDates

public final void setTransientEnabledOnDates(boolean enabled,
                                             java.lang.Iterable<java.util.Date> dates)

Sets a group of visible dates to be enabled or disabled. This is only set until the next time the DatePicker is refreshed.

setValue

public final void setValue(java.util.Date newValue)

Sets the DatePicker's value.

Specified by:

setValue in interface HasValue<java.util.Date>

Specified by:

setValue in interface TakesValue<java.util.Date>

Parameters:

newValue - the new value

setValue

public final void setValue(java.util.Date newValue,
                           boolean fireEvents)

Sets the DatePicker's value.

Specified by:

setValue in interface HasValue<java.util.Date>

Parameters:

newValue - the new value for this date picker

fireEvents - should events be fired.