public class

DatePicker

extends Composite
implements IsEditor<E extends Editor<?>> HasHighlightHandlers<V> HasShowRangeHandlers<V> HasValue<T>

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

Class Overview

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

{@example com.google.gwt.examples.DatePickerExample}

Summary

[Expand]

Inherited Constants

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

Public Constructors
	DatePicker() Create a new date picker.

Protected Constructors
	DatePicker(MonthSelector monthSelector, CalendarView view, CalendarModel model) Creates a new date picker.

Public Methods
HandlerRegistration	addHighlightHandler(HighlightHandler<Date> handler)
HandlerRegistration	addShowRangeHandler(ShowRangeHandler<Date> handler)
HandlerRegistration	addShowRangeHandlerAndFire(ShowRangeHandler<Date> handler) Adds a show range handler and immediately activate the handler on the current view.
void	addStyleToDates(String styleName, Iterable<Date> dates) Add a style name to the given dates.
void	addStyleToDates(String styleName, Date date, Date... moreDates) Add a style name to the given dates.
void	addStyleToDates(String styleName, Date date) Add a style name to the given dates.
final void	addTransientStyleToDates(String styleName, Date date, Date... moreDates) Adds the given style name to the specified dates, which must be visible.
void	addTransientStyleToDates(String styleName, Date date) Adds the given style name to the specified dates, which must be visible.
final void	addTransientStyleToDates(String styleName, Iterable<Date> dates) Adds the given style name to the specified dates, which must be visible.
HandlerRegistration	addValueChangeHandler(ValueChangeHandler<Date> handler)
LeafValueEditor<Date>	asEditor() Returns a `TakesValueEditor` backed by the DatePicker.
Date	getCurrentMonth() Gets the current month the date picker is showing.
final Date	getFirstDate() Returns the first shown date.
final Date	getHighlightedDate() Gets the highlighted date (the one the mouse is hovering over), if any.
final Date	getLastDate() Returns the last shown date.
String	getStyleOfDate(Date date) Gets the style associated with a date (does not include styles set via `addTransientStyleToDates(String, Iterable)`).
final Date	getValue() Returns the selected date, or null if none is selected.
boolean	isDateEnabled(Date date) Is the visible date enabled?
boolean	isDateVisible(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(String styleName, Date date, Date... moreDates) Removes the styleName from the given dates (even if it is transient).
void	removeStyleFromDates(String styleName, Date date) Removes the styleName from the given dates (even if it is transient).
void	removeStyleFromDates(String styleName, Iterable<Date> dates) Removes the styleName from the given dates (even if it is transient).
void	setCurrentMonth(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(String styleName) Sets the date picker style name.
final void	setTransientEnabledOnDates(boolean enabled, Iterable<Date> dates) Sets a group of visible dates to be enabled or disabled.
final void	setTransientEnabledOnDates(boolean enabled, Date date, Date... moreDates) Sets a visible date to be enabled or disabled.
final void	setTransientEnabledOnDates(boolean enabled, Date date) Sets a visible date to be enabled or disabled.
final void	setValue(Date newValue) Sets the `DatePicker`'s value.
final void	setValue(Date newValue, boolean fireEvents) Sets the `DatePicker`'s value.

Protected Methods
final CalendarModel	getModel() Gets the `CalendarModel` associated with this date picker.
final MonthSelector	getMonthSelector() Gets the `MonthSelector` associated with this date picker.
final CalendarView	getView() Gets the `CalendarView` associated with this date picker.
final void	refreshAll() Refreshes all components of this date picker.
void	setup() Sets up the date picker.

[Expand]

Inherited Methods

From class com.google.gwt.user.client.ui.Composite

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

HandlerRegistration	addAttachHandler(AttachEvent.Handler handler) Adds an `AttachEvent` handler.
final <H extends EventHandler> HandlerRegistration	addDomHandler(H handler, Type<H> type) Adds a native event handler to the widget and sinks the corresponding native event.
final <H extends EventHandler> HandlerRegistration	addHandler(H handler, Type<H> type) Adds this handler to the widget.
Widget	asWidget() Returns the `Widget` aspect of the receiver.
static Widget	asWidgetOrNull(IsWidget w) This convenience method makes a null-safe call to `asWidget()`.
HandlerManager	createHandlerManager() Creates the `HandlerManager` used by this Widget.
void	delegateEvent(Widget target, GwtEvent<?> event) Fires an event on a child widget.
void	doAttachChildren() If a widget contains one or more child widgets that are not in the logical widget hierarchy (the child is physically connected only on the DOM level), it must override this method and call `onAttach()` for each of its child widgets.
void	doDetachChildren() If a widget contains one or more child widgets that are not in the logical widget hierarchy (the child is physically connected only on the DOM level), it must override this method and call `onDetach()` for each of its child widgets.
void	fireEvent(GwtEvent<?> event) Fires the given event to the handlers listening to the event's type.
int	getHandlerCount(Type<?> type) Gets the number of handlers listening to the event type.
Object	getLayoutData() Gets the panel-defined layout data associated with this widget.
Widget	getParent() Gets this widget's parent panel.
boolean	isAttached() Determines whether this widget is currently attached to the browser's document (i.e., there is an unbroken chain of widgets between this widget and the underlying browser document).
final boolean	isOrWasAttached() Has this widget ever been attached?
void	onAttach() This method is called when a widget is attached to the browser's document.
void	onBrowserEvent(Event event) Fired whenever a browser event is received.
void	onDetach() This method is called when a widget is detached from the browser's document.
void	onLoad() This method is called immediately after a widget becomes attached to the browser's document.
void	onUnload() This method is called immediately before a widget will be detached from the browser's document.
void	removeFromParent() Removes this widget from its parent widget, if one exists.
void	setLayoutData(Object layoutData) Sets the panel-defined layout data associated with this widget.
void	sinkEvents(int eventBitsToAdd) Overridden to defer the call to super.sinkEvents until the first time this widget is attached to the dom, as a performance enhancement.

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

void	addStyleDependentName(String styleSuffix) Adds a dependent style name by specifying the style name's suffix.
void	addStyleName(String style) Adds a secondary or dependent style name to this object.
static void	ensureDebugId(Element elem, String baseID, String id) Set the debug id of a specific element.
final void	ensureDebugId(String id) Ensure that the main `Element` for this `UIObject` has an ID property set, which allows it to integrate with third-party libraries and test tools.
static void	ensureDebugId(Element elem, String id) Ensure that elem has an ID property set, which allows it to integrate with third-party libraries and test tools.
int	getAbsoluteLeft() Gets the object's absolute left position in pixels, as measured from the browser window's client area.
int	getAbsoluteTop() Gets the object's absolute top position in pixels, as measured from the browser window's client area.
Element	getElement() Gets a handle to the object's underlying DOM element.
int	getOffsetHeight() Gets the object's offset height in pixels.
int	getOffsetWidth() Gets the object's offset width in pixels.
Element	getStyleElement() Template method that returns the element to which style names will be applied.
String	getStyleName() Gets all of the object's style names, as a space-separated list.
static String	getStyleName(Element elem) Gets all of the element's style names, as a space-separated list.
String	getStylePrimaryName() Gets the primary style name associated with the object.
static String	getStylePrimaryName(Element elem) Gets the element's primary style name.
String	getTitle() Gets the title associated with this object.
boolean	isVisible() Determines whether or not this object is visible.
static boolean	isVisible(Element elem)
void	onEnsureDebugId(String baseID) Called when the user sets the id using the `ensureDebugId(String)` method.
void	removeStyleDependentName(String styleSuffix) Removes a dependent style name by specifying the style name's suffix.
void	removeStyleName(String style) Removes a style name.
final void	setElement(Element elem) Sets this object's browser element.
void	setElement(Element elem) Sets this object's browser element.
void	setHeight(String height) Sets the object's height.
void	setPixelSize(int width, int height) Sets the object's size, in pixels, not including decorations such as border, margin, and padding.
void	setSize(String width, String height) Sets the object's size.
void	setStyleDependentName(String styleSuffix, boolean add) Adds or removes a dependent style name by specifying the style name's suffix.
static void	setStyleName(Element elem, String styleName) Clears all of the element's style names and sets it to the given style.
static void	setStyleName(Element elem, String style, boolean add) This convenience method adds or removes a style name for a given element.
void	setStyleName(String style) Clears all of the object's style names and sets it to the given style.
void	setStyleName(String style, boolean add) Adds or removes a style name.
void	setStylePrimaryName(String style) Sets the object's primary style name and updates all dependent style names.
static void	setStylePrimaryName(Element elem, String style) Sets the element's primary style name and updates all dependent style names.
void	setTitle(String title) Sets the title associated with this object.
void	setVisible(boolean visible) Sets whether this object is visible.
static void	setVisible(Element elem, boolean visible)
void	setWidth(String width) Sets the object's width.
void	sinkEvents(int eventBitsToAdd) Adds a set of events to be sunk by this object.
String	toString() This method is overridden so that any object can be viewed in the debugger as an HTML snippet.
void	unsinkEvents(int eventBitsToRemove) Removes a set of events from this object's event list.

From class java.lang.Object

From interface com.google.gwt.editor.client.IsEditor

From interface com.google.gwt.event.logical.shared.HasAttachHandlers

From interface com.google.gwt.event.logical.shared.HasHighlightHandlers

From interface com.google.gwt.event.logical.shared.HasShowRangeHandlers

From interface com.google.gwt.event.logical.shared.HasValueChangeHandlers

From interface com.google.gwt.event.shared.HasHandlers

From interface com.google.gwt.user.client.EventListener

From interface com.google.gwt.user.client.TakesValue

From interface com.google.gwt.user.client.ui.HasValue

From interface com.google.gwt.user.client.ui.IsWidget

Public Constructors

public DatePicker ()

Create a new date picker.

Protected Constructors

protected DatePicker (MonthSelector monthSelector, CalendarView view, CalendarModel model)

Creates a new date picker.

Parameters

monthSelector	the month selector
view	the view
model	the model

Public Methods

public HandlerRegistration addHighlightHandler (HighlightHandler<Date> handler)

public HandlerRegistration addShowRangeHandler (ShowRangeHandler<Date> handler)

public HandlerRegistration addShowRangeHandlerAndFire (ShowRangeHandler<Date> handler)

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

Parameters

handler	the handler

Returns

the handler registration

public void addStyleToDates (String styleName, Iterable<Date> dates)

Add a style name to the given dates.

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

Add a style name to the given dates.

public void addStyleToDates (String styleName, Date date)

Add a style name to the given dates.

public final void addTransientStyleToDates (String styleName, Date date, 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.

public void addTransientStyleToDates (String styleName, 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.

public final void addTransientStyleToDates (String styleName, Iterable<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.

public HandlerRegistration addValueChangeHandler (ValueChangeHandler<Date> handler)

public LeafValueEditor<Date> asEditor ()

Returns a TakesValueEditor backed by the DatePicker.

Returns

an Editor of type E

public 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

public final Date getFirstDate ()

Returns the first shown date.

Returns

the first date.

public final Date getHighlightedDate ()

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

Returns

the highlighted date

public final Date getLastDate ()

Returns the last shown date.

Returns

the last date.

public String getStyleOfDate (Date date)

Gets the style associated with a date (does not include styles set via addTransientStyleToDates(String, Iterable)).

Parameters

date	the date

Returns

the styles associated with this date

public final Date getValue ()

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

Returns

the selected date, or null

public boolean isDateEnabled (Date date)

Is the visible date enabled?

Parameters

date	the date, which must be visible

Returns

is the date enabled?

public boolean isDateVisible (Date date)

Is the date currently shown in the date picker?

Returns

is the date currently shown

public void onLoad ()

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

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

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

public void removeStyleFromDates (String styleName, Date date)

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

public void removeStyleFromDates (String styleName, Iterable<Date> dates)

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

public void setCurrentMonth (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

public void setStyleName (String styleName)

Sets the date picker style name.

Parameters

styleName	the new style name

public final void setTransientEnabledOnDates (boolean enabled, Iterable<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.

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

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

public final void setTransientEnabledOnDates (boolean enabled, Date date)

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

public final void setValue (Date newValue)

Sets the DatePicker's value.

Parameters

newValue	the new value

public final void setValue (Date newValue, boolean fireEvents)

Sets the DatePicker's value.

Parameters

newValue	the new value for this date picker
fireEvents	should events be fired.

Protected Methods

protected final CalendarModel getModel ()

Gets the CalendarModel associated with this date picker.

Returns

the model

protected final MonthSelector getMonthSelector ()

Gets the MonthSelector associated with this date picker.

Returns

the month selector

protected final CalendarView getView ()

Gets the CalendarView associated with this date picker.

Returns

the view

protected final void refreshAll ()

Refreshes all components of this date picker.

protected void setup ()

Sets up the date picker.

Interfaces

Classes

DatePicker

Class Overview

CSS Style Rules

Example

Summary

Public Constructors

public DatePicker ()

Protected Constructors

protected DatePicker (MonthSelector monthSelector, CalendarView view, CalendarModel model)

Parameters

Public Methods

public HandlerRegistration addHighlightHandler (HighlightHandler<Date> handler)

public HandlerRegistration addShowRangeHandler (ShowRangeHandler<Date> handler)

public HandlerRegistration addShowRangeHandlerAndFire (ShowRangeHandler<Date> handler)

Parameters

Returns

public void addStyleToDates (String styleName, Iterable<Date> dates)

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

public void addStyleToDates (String styleName, Date date)

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

public void addTransientStyleToDates (String styleName, Date date)

public final void addTransientStyleToDates (String styleName, Iterable<Date> dates)

public HandlerRegistration addValueChangeHandler (ValueChangeHandler<Date> handler)

public LeafValueEditor<Date> asEditor ()

Returns

public Date getCurrentMonth ()

Returns

public final Date getFirstDate ()

Returns

public final Date getHighlightedDate ()

Returns

public final Date getLastDate ()

Returns

public String getStyleOfDate (Date date)

Parameters

Returns

public final Date getValue ()

Returns

public boolean isDateEnabled (Date date)

Parameters

Returns

public boolean isDateVisible (Date date)

Returns

public void onLoad ()

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

public void removeStyleFromDates (String styleName, Date date)

public void removeStyleFromDates (String styleName, Iterable<Date> dates)

public void setCurrentMonth (Date month)

Parameters

public void setStyleName (String styleName)

Parameters

public final void setTransientEnabledOnDates (boolean enabled, Iterable<Date> dates)

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

public final void setTransientEnabledOnDates (boolean enabled, Date date)

public final void setValue (Date newValue)

Parameters

public final void setValue (Date newValue, boolean fireEvents)

Parameters

Protected Methods

protected final CalendarModel getModel ()

Returns

protected final MonthSelector getMonthSelector ()

Returns

protected final CalendarView getView ()

Returns

protected final void refreshAll ()

protected void setup ()