Class DateBox

DateBox

Deprecated. The UI service was deprecated on December 11, 2014. To create user interfaces, use the HTML service instead.

A text box that shows a DatePicker when the user focuses on it.

Here is an example of how to use this widget:

function doGet() {
  var app = UiApp.createApplication();
  var handler = app.createServerHandler("change");
  var dateBox = app.createDateBox().addValueChangeHandler(handler).setId("datebox");
  app.add(dateBox);
  return app;
}

function change(eventInfo) {
  var app = UiApp.getActiveApplication();
  app.add(app.createLabel("The value of the date box changed to " +
      eventInfo.parameter.datebox));
   return app;
 }

Internally, UiApp widgets are built on top of the Google Web Toolkit, and it can sometimes be helpful to look at the GWT documentation directly. You can find the DateBox documentation here.

Deprecated methods

Method	Return type	Brief description
addStyleDependentName(styleName)	DateBox	Sets the dependent style name of this DateBox.
addStyleName(styleName)	DateBox	Adds a style name to this DateBox.
addValueChangeHandler(handler)	DateBox	Add a handler for value change events.
getId()	String	Returns the id that has been assigned to this object.
getTag()	String	Gets the text tag of this DateBox.
getType()	String	Gets the type of this object.
hideDatePicker()	DateBox	Hide the date picker.
setAccessKey(accessKey)	DateBox	Sets the widget's 'access key'.
setEnabled(enabled)	DateBox	Sets whether the DateBox is enabled.
setFireEventsForInvalid(fireEvents)	DateBox	Sets whether value changed events are fired for invalid or empty input in the box.
setFocus(focus)	DateBox	Explicitly focus/unfocus this DateBox.
setFormat(dateTimeFormat)	DateBox	Sets the format used to control formatting and parsing of dates in this DateBox.
setHeight(height)	DateBox	Sets the height of this DateBox.
setId(id)	DateBox	Sets the id of this DateBox.
setLayoutData(layout)	DateBox	Set the layout for this DateBox.
setName(name)	DateBox	Sets the name of the DateBox, which is how it will be referred to when used in a FormPanel or as a callback element on an event handler.
setPixelSize(width, height)	DateBox	Sets the size of this DateBox in pixels.
setSize(width, height)	DateBox	Sets the size of this DateBox.
setStyleAttribute(attribute, value)	DateBox	Sets one of this DateBox's style attributes to a new value.
setStyleAttributes(attributes)	DateBox	Sets this DateBox's style attributes.
setStyleName(styleName)	DateBox	Sets the style name of this DateBox.
setStylePrimaryName(styleName)	DateBox	Sets the primary style name of this DateBox.
setTabIndex(index)	DateBox	Sets the DateBox's position in the tab index.
setTag(tag)	DateBox	Sets the text tag of this DateBox.
setTitle(title)	DateBox	Sets the hover title of this DateBox.
setValue(date)	DateBox	Sets the date shown by this DateBox.
setVisible(visible)	DateBox	Sets whether this DateBox is visible.
setWidth(width)	DateBox	Sets the width of this DateBox.
showDatePicker()	DateBox	Parses the current DateBox's value and shows that date.

Deprecated methods

addStyleDependentName(styleName)

Deprecated. This function is deprecated and should not be used in new scripts.

Sets the dependent style name of this DateBox.

This is useful for debugging but is otherwise of minimal use since there is no way to use custom stylesheets in UiApp.

Parameters

Name	Type	Description
styleName	String	the new style name.

Return

DateBox — the DateBox itself, useful for chaining.

---

addStyleName(styleName)

Deprecated. This function is deprecated and should not be used in new scripts.

Adds a style name to this DateBox.

This is useful for debugging but is otherwise of minimal use since there is no way to use custom stylesheets in UiApp.

Parameters

Name	Type	Description
styleName	String	the new style name.

Return

DateBox — the DateBox itself, useful for chaining.

---

addValueChangeHandler(handler)

Deprecated. This function is deprecated and should not be used in new scripts.

Add a handler for value change events.

Note that you can have multiple handlers for the same event on the same widget. They will be called in the order that they were added to the widget, although ServerHandlers may appear to happen simultaneously.

The handler passes back some information to the server about what happened. This information can be accessed as follows:

function doGet() {
  var app = UiApp.createApplication();
  var textBox = app.createTextBox();
  var handler = app.createServerHandler("handlerFunction");
  textBox.addValueChangeHandler(handler);
  app.add(textBox);
  return app;
}

function handlerFunction(eventInfo) {
  var parameter = eventInfo.parameter;
  // the type of event, in this case "valueChange".
  var eventType = parameter.eventType;
  // the id of the widget that fired this event.
  var source = parameter.source;
}

In addition, the values of certain widgets can be sent up with the event as well as "callback elements." See the documentation of ServerHandler for more information.

Parameters

Name	Type	Description
handler	Handler	the handler to execute when the event occurs. This can be a ClientHandler or a ServerHandler.

Return

DateBox — the DateBox itself, useful for chaining.

---

getId()

Deprecated. This function is deprecated and should not be used in new scripts.

Returns the id that has been assigned to this object.

This can be used in conjunction with app.getElementById() to retrieve a reference to this object.

Return

String — the id that has been assigned to this object

---

getTag()

Deprecated. This function is deprecated and should not be used in new scripts.

Gets the text tag of this DateBox.

Return

String — the text tag.

---

getType()

Deprecated. This function is deprecated and should not be used in new scripts.

Gets the type of this object.

Return

String — the object type

---

hideDatePicker()

Deprecated. This function is deprecated and should not be used in new scripts.

Hide the date picker.

Return

DateBox — the DateBox itself, useful for chaining.

---

setAccessKey(accessKey)

Deprecated. This function is deprecated and should not be used in new scripts.

Sets the widget's 'access key'. This key is used (in conjunction with a browser-specific modifier key) to automatically focus the widget.

Parameters

Name	Type	Description
accessKey	Char	the character to use for focus

Return

DateBox — the DateBox itself, useful for chaining.

---

setEnabled(enabled)

Deprecated. This function is deprecated and should not be used in new scripts.

Sets whether the DateBox is enabled.

Parameters

Name	Type	Description
enabled	Boolean	whether the DateBox should be enabled or disabled.

Return

DateBox — the DateBox itself, useful for chaining.

---

setFireEventsForInvalid(fireEvents)

Deprecated. This function is deprecated and should not be used in new scripts.

Sets whether value changed events are fired for invalid or empty input in the box.

If this is false, which is the default, value change events will only be fired for valid dates selected from the picker or typed into the box. If this is true, a value change event will be fired when the box is changed from a valid date string to an invalid or empty string, with the date value in the event set to null. No value change event will be fired if the box is changed from one invalid string to another, since all invalid or empty dates are equivalently treated as null dates.

Parameters

Name	Type	Description
fireEvents	Boolean	if set to true, value change events will be fired when the box is changed from a valid date string to an invalid or empty string, with the date value in the event set to null.

Return

DateBox — the DateBox itself, useful for chaining.

---

setFocus(focus)

Deprecated. This function is deprecated and should not be used in new scripts.

Explicitly focus/unfocus this DateBox.

Only one widget can have focus at a time, and the widget that does will receive all keyboard events.

Parameters

Name	Type	Description
focus	Boolean	whether the DateBox should have the current focus.

Return

DateBox — the DateBox itself, useful for chaining.

---

setFormat(dateTimeFormat)

Deprecated. This function is deprecated and should not be used in new scripts.

Sets the format used to control formatting and parsing of dates in this DateBox.

If this DateBox is not empty, the contents will be replaced with current contents in the new format.

Parameters

Name	Type	Description
dateTimeFormat	DateTimeFormat	the desired format such as UiApp.DateTimeFormat.DATE_TIME_FULL.

Return

DateBox — the DateBox itself, useful for chaining.

---

setHeight(height)

Deprecated. This function is deprecated and should not be used in new scripts.

Sets the height of this DateBox.

Parameters

Name	Type	Description
height	String	the new height in any CSS unit such as "10px" or "50%".

Return

DateBox — the DateBox itself, useful for chaining.

---

setId(id)

Deprecated. This function is deprecated and should not be used in new scripts.

Sets the id of this DateBox.

Parameters

Name	Type	Description
id	String	the new id, which can be used to retrieve the DateBox from app.getElementById(id).

Return

DateBox — the DateBox itself, useful for chaining.

---

setLayoutData(layout)

Deprecated. This function is deprecated and should not be used in new scripts.

Set the layout for this DateBox.

This is not currently functional.

Parameters

Name	Type	Description
layout	Object

Return

DateBox — the DateBox itself, useful for chaining.

---

setName(name)

Deprecated. This function is deprecated and should not be used in new scripts.

Sets the name of the DateBox, which is how it will be referred to when used in a FormPanel or as a callback element on an event handler.

Parameters

Name	Type	Description
name	String	the new name.

Return

DateBox — the DateBox itself, useful for chaining.

---

setPixelSize(width, height)

Deprecated. This function is deprecated and should not be used in new scripts.

Sets the size of this DateBox in pixels.

Parameters

Name	Type	Description
width	Integer	the new width in pixels.
height	Integer	the new height in pixels.

Return

DateBox — the DateBox itself, useful for chaining.

---

setSize(width, height)

Deprecated. This function is deprecated and should not be used in new scripts.

Sets the size of this DateBox.

Parameters

Name	Type	Description
width	String	the new width in any CSS unit such as "10px" or "50%".
height	String	the new height in any CSS unit such as "10px" or "50%".

Return

DateBox — the DateBox itself, useful for chaining.

---

setStyleAttribute(attribute, value)

Deprecated. This function is deprecated and should not be used in new scripts.

Sets one of this DateBox's style attributes to a new value. Valid attributes are listed here; the values for each attribute are the same as those available in CSS style sheets.

// Change the widget's background to black and text color to green.
widget.setStyleAttribute("background", "black")
    .setStyleAttribute("color", "green");

Parameters

Name	Type	Description
attribute	String	the CSS attribute, in camel-case ("fontSize", not "font-size"), as listed here
value	String	the CSS value

Return

DateBox — the DateBox itself, useful for chaining.

---

setStyleAttributes(attributes)

Deprecated. This function is deprecated and should not be used in new scripts.

Sets this DateBox's style attributes. This is a convenience method that is equivalent to calling setStyleAttribute with every key/value pair in the attributes object. Valid attributes are listed here; the values for each attribute are the same as those available in CSS style sheets.

// Change the widget's background to black and text color to green.
widget.setStyleAttributes({background: "black", color: "green"});

Parameters

Name	Type	Description
attributes	Object	an object of key/value pairs for the CSS attributes and values to set; valid attributes are listed here

Return

DateBox — the DateBox itself, useful for chaining.

---

setStyleName(styleName)

Deprecated. This function is deprecated and should not be used in new scripts.

Sets the style name of this DateBox.

This is useful for debugging but is otherwise of minimal use since there is no way to use custom stylesheets in UiApp.

Parameters

Name	Type	Description
styleName	String	the new style name.

Return

DateBox — the DateBox itself, useful for chaining.

---

setStylePrimaryName(styleName)

Deprecated. This function is deprecated and should not be used in new scripts.

Sets the primary style name of this DateBox.

This is useful for debugging but is otherwise of minimal use since there is no way to use custom stylesheets in UiApp.

Parameters

Name	Type	Description
styleName	String	the new style name.

Return

DateBox — the DateBox itself, useful for chaining.

---

setTabIndex(index)

Deprecated. This function is deprecated and should not be used in new scripts.

Sets the DateBox'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

Name	Type	Description
index	Integer	the new tab index.

Return

DateBox — the DateBox itself, useful for chaining.

---

setTag(tag)

Deprecated. This function is deprecated and should not be used in new scripts.

Sets the text tag of this DateBox.

Parameters

Name	Type	Description
tag	String	the new text tag, which can be anything you wish to store with the widget.

Return

DateBox — the DateBox itself, useful for chaining.

---

setTitle(title)

Deprecated. This function is deprecated and should not be used in new scripts.

Sets the hover title of this DateBox.

Not all browsers will show this.

Parameters

Name	Type	Description
title	String	the hover title.

Return

DateBox — the DateBox itself, useful for chaining.

---

setValue(date)

Deprecated. This function is deprecated and should not be used in new scripts.

Sets the date shown by this DateBox.

Parameters

Name	Type	Description
date	Date	the new date value.

Return

DateBox — the DateBox itself, useful for chaining.

---

setVisible(visible)

Deprecated. This function is deprecated and should not be used in new scripts.

Sets whether this DateBox is visible.

Parameters

Name	Type	Description
visible	Boolean	whether this DateBox should be visible or not.

Return

DateBox — the DateBox itself, useful for chaining.

---

setWidth(width)

Deprecated. This function is deprecated and should not be used in new scripts.

Sets the width of this DateBox.

Parameters

Name	Type	Description
width	String	the new width in any CSS unit such as "10px" or "50%".

Return

DateBox — the DateBox itself, useful for chaining.

---

showDatePicker()

Deprecated. This function is deprecated and should not be used in new scripts.

Parses the current DateBox's value and shows that date.

Return

DateBox — the DateBox itself, useful for chaining.