Interface Handler

Handler

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

Base interface for client and server handlers.

Implementing classes

Name	Brief description
ClientHandler	An event handler that runs in the user's browser without needing a call back to the server.
ServerHandler	An event handler that runs on the server.

Deprecated methods

Method	Return type	Brief description
getId()	String	Returns the id that has been assigned to this object.
getTag()	String	Gets the text tag of this Handler.
getType()	String	Gets the type of this object.
setId(id)	Handler	Sets the id of this Handler.
setTag(tag)	Handler	Sets the text tag of this Handler.
validateEmail(widget)	Handler	Sets this handler to fire only if the given widget's value is a valid email address.
validateInteger(widget)	Handler	Sets this handler to fire only if the given widget's value can be interpreted as an integer.
validateLength(widget, min, max)	Handler	Sets this handler to fire only if the given widget's value is a string whose length is between min and max.
validateMatches(widget, pattern)	Handler	Sets this handler to fire only if the given widget's value matches this regular expression.
validateMatches(widget, pattern, flags)	Handler	Sets this handler to fire only if the given widget's value matches this regular expression.
validateNotEmail(widget)	Handler	Sets this handler to fire only if the given widget's value is not a valid email address.
validateNotInteger(widget)	Handler	Sets this handler to fire only if the given widget's value cannot be interpreted as an integer.
validateNotLength(widget, min, max)	Handler	Sets this handler to fire only if the given widget's value is a string whose length is less than min or greater than max.
validateNotMatches(widget, pattern)	Handler	Sets this handler to fire only if the given widget's value does not match this regular expression.
validateNotMatches(widget, pattern, flags)	Handler	Sets this handler to fire only if the given widget's value does not match this regular expression.
validateNotNumber(widget)	Handler	Sets this handler to fire only if the given widget's value cannot be interpreted as an number.
validateNotOptions(widget, options)	Handler	Sets this handler to fire only if the given widget's value is not one of the strings given in the options parameter.
validateNotRange(widget, min, max)	Handler	Sets this handler to fire only if the given widget's value cannot be interpreted as a number that is between min and max.
validateNotSum(widgets, sum)	Handler	Sets this handler to fire only if the given widgets have values that are not numbers, or that do not sum up to the given value.
validateNumber(widget)	Handler	Sets this handler to fire only if the given widget's value can be interpreted as a number.
validateOptions(widget, options)	Handler	Sets this handler to fire only if the given widget's value is one of the strings given in the options parameter.
validateRange(widget, min, max)	Handler	Sets this handler to fire only if the given widget's value can be interpreted as a number and is between min and max.
validateSum(widgets, sum)	Handler	Sets this handler to fire only if the given widgets have values that are numbers and sum up to the given value.

Deprecated methods

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 Handler.

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

---

setId(id)

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

Sets the id of this Handler.

Parameters

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

Return

Handler — the Handler 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 Handler.

Parameters

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

Return

Handler — the Handler itself, useful for chaining.

---

validateEmail(widget)

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

Sets this handler to fire only if the given widget's value is a valid email address.

This will cause an error if the widget does not have a text property.

Parameters

Name	Type	Description
widget	Widget	the widget to validate on.

Return

Handler — the Handler itself, useful for chaining.

---

validateInteger(widget)

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

Sets this handler to fire only if the given widget's value can be interpreted as an integer.

This will cause an error if the widget does not have a text property.

Parameters

Name	Type	Description
widget	Widget	the widget to validate on.

Return

Handler — the Handler itself, useful for chaining.

---

validateLength(widget, min, max)

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

Sets this handler to fire only if the given widget's value is a string whose length is between min and max.

This will cause an error if the widget does not have a text property.

Parameters

Name	Type	Description
widget	Widget	the widget to validate on.
min	Integer	the minimum length. If null, no minimum is enforced.
max	Integer	the maximum length. If null, no maximum is enforced.

Return

Handler — the Handler itself, useful for chaining.

---

validateMatches(widget, pattern)

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

Sets this handler to fire only if the given widget's value matches this regular expression.

This will cause an error if the widget does not have a text property.

Parameters

Name	Type	Description
widget	Widget	the widget to validate on.
pattern	String	the regex to test, as a string.

Return

Handler — the Handler itself, useful for chaining.

---

validateMatches(widget, pattern, flags)

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

Sets this handler to fire only if the given widget's value matches this regular expression.

This will cause an error if the widget does not have a text property.

Parameters

Name	Type	Description
widget	Widget	the widget to validate on.
pattern	String	the regex to test, as a string.
flags	String	regex flags. The only valid characters in this string are 'g', 'm', and 'i'.

Return

Handler — the Handler itself, useful for chaining.

---

validateNotEmail(widget)

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

Sets this handler to fire only if the given widget's value is not a valid email address.

This will cause an error if the widget does not have a text property.

Parameters

Name	Type	Description
widget	Widget	the widget to validate on.

Return

Handler — the Handler itself, useful for chaining.

---

validateNotInteger(widget)

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

Sets this handler to fire only if the given widget's value cannot be interpreted as an integer.

This will cause an error if the widget does not have a text property.

Parameters

Name	Type	Description
widget	Widget	the widget to validate on.

Return

Handler — the Handler itself, useful for chaining.

---

validateNotLength(widget, min, max)

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

Sets this handler to fire only if the given widget's value is a string whose length is less than min or greater than max.

This will cause an error if the widget does not have a text property.

Parameters

Name	Type	Description
widget	Widget	the widget to validate on.
min	Integer	the minimum length. If null, no minimum is enforced.
max	Integer	the maximum length. If null, no maximum is enforced.

Return

Handler — the Handler itself, useful for chaining.

---

validateNotMatches(widget, pattern)

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

Sets this handler to fire only if the given widget's value does not match this regular expression.

This will cause an error if the widget does not have a text property.

Parameters

Name	Type	Description
widget	Widget	the widget to validate on.
pattern	String	the regex to test, as a string.

Return

Handler — the Handler itself, useful for chaining.

---

validateNotMatches(widget, pattern, flags)

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

Sets this handler to fire only if the given widget's value does not match this regular expression.

This will cause an error if the widget does not have a text property.

Parameters

Name	Type	Description
widget	Widget	the widget to validate on.
pattern	String	the regex to test, as a string.
flags	String	regex flags. The only valid characters in this string are 'g', 'm', and 'i'.

Return

Handler — the Handler itself, useful for chaining.

---

validateNotNumber(widget)

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

Sets this handler to fire only if the given widget's value cannot be interpreted as an number.

This will cause an error if the widget does not have a text property.

Parameters

Name	Type	Description
widget	Widget	the widget to validate on.

Return

Handler — the Handler itself, useful for chaining.

---

validateNotOptions(widget, options)

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

Sets this handler to fire only if the given widget's value is not one of the strings given in the options parameter.

This will cause an error if the widget does not have a text property.

Parameters

Name	Type	Description
widget	Widget	the widget to validate on.
options	String[]	the list of unacceptable values

Return

Handler — the Handler itself, useful for chaining.

---

validateNotRange(widget, min, max)

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

Sets this handler to fire only if the given widget's value cannot be interpreted as a number that is between min and max.

This will cause an error if the widget does not have a text property.

Parameters

Name	Type	Description
widget	Widget	the widget to validate on.
min	Number	the minimum length. If null, no minimum is enforced.
max	Number	the maximum length. If null, no maximum is enforced.

Return

Handler — the Handler itself, useful for chaining.

---

validateNotSum(widgets, sum)

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

Sets this handler to fire only if the given widgets have values that are not numbers, or that do not sum up to the given value.

This will cause an error if any of the widgets do not have a text property.

Parameters

Name	Type	Description
widgets	Widget[]	an array of the widgets to validate on.
sum	Integer	the sum to validate with

Return

Handler — the Handler itself, useful for chaining.

---

validateNumber(widget)

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

Sets this handler to fire only if the given widget's value can be interpreted as a number.

This will cause an error if the widget does not have a text property.

Parameters

Name	Type	Description
widget	Widget	the widget to validate on.

Return

Handler — the Handler itself, useful for chaining.

---

validateOptions(widget, options)

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

Sets this handler to fire only if the given widget's value is one of the strings given in the options parameter.

This will cause an error if the widget does not have a text property.

Parameters

Name	Type	Description
widget	Widget	the widget to validate on.
options	String[]	the list of acceptable values

Return

Handler — the Handler itself, useful for chaining.

---

validateRange(widget, min, max)

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

Sets this handler to fire only if the given widget's value can be interpreted as a number and is between min and max.

This will cause an error if the widget does not have a text property.

Parameters

Name	Type	Description
widget	Widget	the widget to validate on.
min	Number	the minimum length. If null, no minimum is enforced.
max	Number	the maximum length. If null, no maximum is enforced.

Return

Handler — the Handler itself, useful for chaining.

---

validateSum(widgets, sum)

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

Sets this handler to fire only if the given widgets have values that are numbers and sum up to the given value.

This will cause an error if any of the widgets do not have a text property.

Parameters

Name	Type	Description
widgets	Widget[]	an array of the widgets to validate on.
sum	Integer	the sum to validate with

Return

Handler — the Handler itself, useful for chaining.