Package com.google.gwt.user.datepicker.client

Class DateBox

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.DateBox
All Implemented Interfaces:
IsEditor<LeafValueEditor<Date>>, HasAttachHandlers, HasValueChangeHandlers<Date>, HasHandlers, EventListener, TakesValue<Date>, HasEnabled, HasValue<Date>, HasVisibility, IsRenderable, IsWidget
public class DateBox extends Composite implements HasEnabled, HasValue<Date>, IsEditor<LeafValueEditor<Date>>
A text box that shows a DatePicker when the user focuses on it.

CSS Style Rules

.gwt-DateBox
default style name
.dateBoxPopup
Applied to the popup around the DatePicker
.dateBoxFormatError
Default style for when the date box has bad input. Applied by DateBox.DefaultFormat when the text does not represent a date that can be parsed

Example

public class DateBoxExample implements EntryPoint {

  public void onModuleLoad() {
    DateBox dateBox = new DateBox();
    dateBox.setValue(new Date());
    RootPanel.get().add(dateBox);
  }
}

  • Field Details

  • Constructor Details

    • DateBox

      public DateBox()
      Create a date box with a new DatePicker.

    • DateBox

      public DateBox(DatePicker picker, Date date, DateBox.Format format)
      Create a new date box.
      Parameters:
      date - the default date.
      picker - the picker to drop down from the date box
      format - to use to parse and format dates

  • Method Details

    • addValueChangeHandler

      public HandlerRegistration addValueChangeHandler(ValueChangeHandler<Date> handler)
      Description copied from interface: HasValueChangeHandlers
      Adds a ValueChangeEvent handler.
      Specified by:
      addValueChangeHandler in interface HasValueChangeHandlers<Date>
      Parameters:
      handler - the handler
      Returns:
      the registration for the event

    • asEditor

      public LeafValueEditor<Date> asEditor()
      Returns a TakesValueEditor backed by the DateBox.
      Specified by:
      asEditor in interface IsEditor<LeafValueEditor<Date>>
      Returns:
      an Editor of type E

    • getCursorPos

      public int getCursorPos()
      Gets the current cursor position in the date box.
      Returns:
      the cursor position

    • getDatePicker

      public DatePicker getDatePicker()
      Gets the date picker.
      Returns:
      the date picker

    • getFireNullValues

      public boolean getFireNullValues()
      Returns true iff the date box will fire ValueChangeEvents with a date value of null for invalid or empty string values.

    • getFormat

      public DateBox.Format getFormat()
      Gets the format instance used to control formatting and parsing of this DateBox.
      Returns:
      the format

    • getTabIndex

      public int getTabIndex()
      Gets the date box's position in the tab index.
      Returns:
      the date box's tab index

    • getTextBox

      public TextBox getTextBox()
      Get text box.
      Returns:
      the text box used to enter the formatted date

    • getValue

      public Date getValue()
      Get the date displayed, or null if the text box is empty, or cannot be interpreted.
      Specified by:
      getValue in interface HasValue<Date>
      Specified by:
      getValue in interface TakesValue<Date>
      Returns:
      the current date value
      See Also:

    • hideDatePicker

      public void hideDatePicker()
      Hide the date picker.

    • isDatePickerShowing

      public boolean isDatePickerShowing()
      Returns true if date picker is currently showing, false if not.

    • isEnabled

      public boolean isEnabled()
      Returns true if the date box is enabled, false if not.
      Specified by:
      isEnabled in interface HasEnabled

    • setAccessKey

      public void setAccessKey(char key)
      Sets the date box's 'access key'. This key is used (in conjunction with a browser-specific modifier key) to automatically focus the widget.
      Parameters:
      key - the date box's access key

    • setEnabled

      public void setEnabled(boolean enabled)
      Sets whether the date box is enabled.
      Specified by:
      setEnabled in interface HasEnabled
      Parameters:
      enabled - is the box enabled

    • setFireNullValues

      public void setFireNullValues(boolean fireNullValues)
      Sets whether or not the date box will fire ValueChangeEvents with a date value of null for invalid or empty string values.

    • setFocus

      public void setFocus(boolean focused)
      Explicitly focus/unfocus this widget. Only one widget can have focus at a time, and the widget that does will receive all keyboard events.
      Parameters:
      focused - whether this widget should take focus or release it

    • setFormat

      public void setFormat(DateBox.Format format)
      Sets the format used to control formatting and parsing of dates in this DateBox. If this DateBox is not empty, the contents of date box will be replaced with current contents in the new format.
      Parameters:
      format - the new date format

    • setTabIndex

      public void setTabIndex(int index)
      Sets the date box's position in the tab index. If more than one widget has the same tab index, each such widget will receive focus in an arbitrary order. Setting the tab index to -1 will cause this widget to be removed from the tab order.
      Parameters:
      index - the date box's tab index

    • setValue

      public void setValue(Date date)
      Set the date.
      Specified by:
      setValue in interface HasValue<Date>
      Specified by:
      setValue in interface TakesValue<Date>
      Parameters:
      date - the object's new value
      See Also:

    • setValue

      public void setValue(Date date, boolean fireEvents)
      Description copied from interface: HasValue
      Sets this object's value. Fires ValueChangeEvent when fireEvents is true and the new value does not equal the existing value.

      It is acceptable to fail assertions or throw (documented) unchecked exceptions in response to bad values.

      Specified by:
      setValue in interface HasValue<Date>
      Parameters:
      date - the object's new value
      fireEvents - fire events if true and value is new

    • showDatePicker

      public void showDatePicker()
      Parses the current date box's value and shows that date.