Deprecated. This class is deprecated and should not be used in new scripts.
A
is a text box or text area which displays a pre-configured set of selections
that match the user's input.
SuggestBox
This widget is not currently functional.
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 SuggestBox documentation here.
Deprecated methods
Deprecated methods
addKeyDownHandler(handler)
addKeyDownHandler(handler)
Deprecated. This function is deprecated and should not be used in new scripts.
Add a handler for key down 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
s may appear to happen
simultaneously.
ServerHandler
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 button = app.createButton("a button");
var handler = app.createServerHandler("handlerFunction");
button.addKeyDownHandler(handler);
app.add(button);
return app;
}
function handlerFunction(eventInfo) {
var parameter = eventInfo.parameter;
// the type of event, in this case "keydown".
var eventType = parameter.eventType;
// the id of the widget that fired this event.
var source = parameter.source;
// what key was pressed. See below for a link explaining what these values mean.
var charCode = parameter.charCode;
var keyCode = parameter.keyCode;
// whether the various modifier keys were also pressed (true or false)
var shift = parameter.shift;
var alt = parameter.alt;
var ctrl = parameter.ctrl;
var meta = parameter.meta;
}
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.
For an explanation of charCode and keyCode, including what to expect on different browsers, look here.
Parameters
Name | Type | Description |
---|---|---|
handler |
| the handler to execute when the event occurs. This can be a or a . |
Return
— the SuggestBox
itself, useful for chaining.SuggestBox
addKeyPressHandler(handler)
addKeyPressHandler(handler)
Deprecated. This function is deprecated and should not be used in new scripts.
Add a handler for key press 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
s may appear to happen
simultaneously.
ServerHandler
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 button = app.createButton("a button");
var handler = app.createServerHandler("handlerFunction");
button.addKeyPressHandler(handler);
app.add(button);
return app;
}
function handlerFunction(eventInfo) {
var parameter = eventInfo.parameter;
// the type of event, in this case "keypress".
var eventType = parameter.eventType;
// the id of the widget that fired this event.
var source = parameter.source;
// what key was pressed. See below for a link explaining what these values mean.
var charCode = parameter.charCode;
var keyCode = parameter.keyCode;
// whether the various modifier keys were also pressed (true or false)
var shift = parameter.shift;
var alt = parameter.alt;
var ctrl = parameter.ctrl;
var meta = parameter.meta;
}
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.
For an explanation of charCode and keyCode, including what to expect on different browsers, look here.
Parameters
Name | Type | Description |
---|---|---|
handler |
| the handler to execute when the event occurs. This can be a or a . |
Return
— the SuggestBox
itself, useful for chaining.SuggestBox
addKeyUpHandler(handler)
addKeyUpHandler(handler)
Deprecated. This function is deprecated and should not be used in new scripts.
Add a handler for key up 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
s may appear to happen
simultaneously.
ServerHandler
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 button = app.createButton("a button");
var handler = app.createServerHandler("handlerFunction");
button.addKeyUpHandler(handler);
app.add(button);
return app;
}
function handlerFunction(eventInfo) {
var parameter = eventInfo.parameter;
// the type of event, in this case "keyup".
var eventType = parameter.eventType;
// the id of the widget that fired this event.
var source = parameter.source;
// what key was pressed. See below for a link explaining what these values mean.
var charCode = parameter.charCode;
var keyCode = parameter.keyCode;
// whether the various modifier keys were also pressed (true or false)
var shift = parameter.shift;
var alt = parameter.alt;
var ctrl = parameter.ctrl;
var meta = parameter.meta;
}
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.
For an explanation of charCode and keyCode, including what to expect on different browsers, look here.
Parameters
Name | Type | Description |
---|---|---|
handler |
| the handler to execute when the event occurs. This can be a or a . |
Return
— the SuggestBox
itself, useful for chaining.SuggestBox
addSelectionHandler(handler)
addSelectionHandler(handler)
Deprecated. This function is deprecated and should not be used in new scripts.
Add a handler for selection 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
s may appear to happen
simultaneously.
ServerHandler
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 item1 = app.createTreeItem("item1");
item1.addItem(app.createTreeItem("item2"));
var tree = app.createTree();
tree.addItem(item1);
var handler = app.createServerHandler("handlerFunction");
tree.addSelectionHandler(handler)
app.add(tree);
return app;
}
function handlerFunction(eventInfo) {
var parameter = eventInfo.parameter;
// the type of event, in this case "selection".
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 |
| the handler to execute when the event occurs. This can be a or a . |
Return
— the SuggestBox
itself, useful for chaining.SuggestBox
addStyleDependentName(styleName)
addStyleDependentName(styleName)
Deprecated. This function is deprecated and should not be used in new scripts.
Sets the dependent style name of this
.
SuggestBox
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
— the SuggestBox
itself, useful for chaining.SuggestBox
addStyleName(styleName)
addStyleName(styleName)
Deprecated. This function is deprecated and should not be used in new scripts.
Adds a style name to this
.
SuggestBox
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
— the SuggestBox
itself, useful for chaining.SuggestBox
addValueChangeHandler(handler)
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
s may appear to happen
simultaneously.
ServerHandler
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 |
| the handler to execute when the event occurs. This can be a or a . |
Return
— the SuggestBox
itself, useful for chaining.SuggestBox
getId()
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()
getTag()
Deprecated. This function is deprecated and should not be used in new scripts.
Gets the text tag of this
.SuggestBox
Return
String
— the text tag.
getType()
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
setAccessKey(accessKey)
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
— the SuggestBox
itself, useful for chaining.SuggestBox
setAnimationEnabled(animationEnabled)
setAnimationEnabled(animationEnabled)
Deprecated. This function is deprecated and should not be used in new scripts.
Sets whether opening and closing the
is animated.SuggestBox
Parameters
Name | Type | Description |
---|---|---|
animationEnabled | Boolean | whether to animate opening and closing. |
Return
— the SuggestBox
itself, useful for chaining.SuggestBox
setAutoSelectEnabled(autoSelectEnabled)
setAutoSelectEnabled(autoSelectEnabled)
Deprecated. This function is deprecated and should not be used in new scripts.
Sets the auto-select behavior.
Parameters
Name | Type | Description |
---|---|---|
autoSelectEnabled | Boolean | whether auto-select is enabled. |
Return
— the SuggestBox
itself, useful for chaining.SuggestBox
setFocus(focus)
setFocus(focus)
Deprecated. This function is deprecated and should not be used in new scripts.
Explicitly focus/unfocus this
.
SuggestBox
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 should have the current focus. |
Return
— the SuggestBox
itself, useful for chaining.SuggestBox
setHeight(height)
setHeight(height)
Deprecated. This function is deprecated and should not be used in new scripts.
Sets the height of this
.SuggestBox
Parameters
Name | Type | Description |
---|---|---|
height | String | the new height in any CSS unit such as "10px" or "50%". |
Return
— the SuggestBox
itself, useful for chaining.SuggestBox
setId(id)
setId(id)
Deprecated. This function is deprecated and should not be used in new scripts.
Sets the id of this
.SuggestBox
Parameters
Name | Type | Description |
---|---|---|
id | String | the new id, which can be used to retrieve the from
app.getElementById(id). |
Return
— the SuggestBox
itself, useful for chaining.SuggestBox
setLayoutData(layout)
setLayoutData(layout)
Deprecated. This function is deprecated and should not be used in new scripts.
Set the layout for this
.
SuggestBox
This is not currently functional.
Parameters
Name | Type | Description |
---|---|---|
layout | Object |
Return
— the SuggestBox
itself, useful for chaining.SuggestBox
setLimit(limit)
setLimit(limit)
Deprecated. This function is deprecated and should not be used in new scripts.
Sets the suggest limit
Parameters
Name | Type | Description |
---|---|---|
limit | Integer | max number of suggestions |
Return
— the SuggestBox
itself, useful for chaining.SuggestBox
setPixelSize(width, height)
setPixelSize(width, height)
Deprecated. This function is deprecated and should not be used in new scripts.
Sets the size of this
in pixels.SuggestBox
Parameters
Name | Type | Description |
---|---|---|
width | Integer | the new width in pixels. |
height | Integer | the new height in pixels. |
Return
— the SuggestBox
itself, useful for chaining.SuggestBox
setPopupStyleName(styleName)
setPopupStyleName(styleName)
Deprecated. This function is deprecated and should not be used in new scripts.
Sets the popup style name.
Parameters
Name | Type | Description |
---|---|---|
styleName | String | the new style name. |
Return
— the SuggestBox
itself, useful for chaining.SuggestBox
setSize(width, height)
setSize(width, height)
Deprecated. This function is deprecated and should not be used in new scripts.
Sets the size of this
.SuggestBox
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
— the SuggestBox
itself, useful for chaining.SuggestBox
setStyleAttribute(attribute, value)
setStyleAttribute(attribute, value)
Deprecated. This function is deprecated and should not be used in new scripts.
Sets one of this
'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.
SuggestBox
// 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
— the SuggestBox
itself, useful for chaining.SuggestBox
setStyleAttributes(attributes)
setStyleAttributes(attributes)
Deprecated. This function is deprecated and should not be used in new scripts.
Sets this
'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.
SuggestBox
// 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
— the SuggestBox
itself, useful for chaining.SuggestBox
setStyleName(styleName)
setStyleName(styleName)
Deprecated. This function is deprecated and should not be used in new scripts.
Sets the style name of this
.
SuggestBox
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
— the SuggestBox
itself, useful for chaining.SuggestBox
setStylePrimaryName(styleName)
setStylePrimaryName(styleName)
Deprecated. This function is deprecated and should not be used in new scripts.
Sets the primary style name of this
.
SuggestBox
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
— the SuggestBox
itself, useful for chaining.SuggestBox
setTabIndex(index)
setTabIndex(index)
Deprecated. This function is deprecated and should not be used in new scripts.
Sets the
's position in the tab index.
SuggestBox
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
— the SuggestBox
itself, useful for chaining.SuggestBox
setTag(tag)
setTag(tag)
Deprecated. This function is deprecated and should not be used in new scripts.
Sets the text tag of this
.SuggestBox
Parameters
Name | Type | Description |
---|---|---|
tag | String | the new text tag, which can be anything you wish to store with the widget. |
Return
— the SuggestBox
itself, useful for chaining.SuggestBox
setText(text)
setText(text)
Deprecated. This function is deprecated and should not be used in new scripts.
Set the display text of this
.SuggestBox
Parameters
Name | Type | Description |
---|---|---|
text | String | the new text. |
Return
— the SuggestBox
itself, useful for chaining.SuggestBox
setTitle(title)
setTitle(title)
Deprecated. This function is deprecated and should not be used in new scripts.
Sets the hover title of this
.
SuggestBox
Not all browsers will show this.
Parameters
Name | Type | Description |
---|---|---|
title | String | the hover title. |
Return
— the SuggestBox
itself, useful for chaining.SuggestBox
setValue(value)
setValue(value)
Deprecated. This function is deprecated and should not be used in new scripts.
Sets the value of this
.SuggestBox
Parameters
Name | Type | Description |
---|---|---|
value | String | the new value. |
Return
— the SuggestBox
itself, useful for chaining.SuggestBox
setValue(value, fireEvents)
setValue(value, fireEvents)
Deprecated. This function is deprecated and should not be used in new scripts.
Sets the
's value.SuggestBox
Parameters
Name | Type | Description |
---|---|---|
value | String | the new value. |
fireEvents | Boolean | whether to fire change events. |
Return
— the SuggestBox
itself, useful for chaining.SuggestBox
setVisible(visible)
setVisible(visible)
Deprecated. This function is deprecated and should not be used in new scripts.
Sets whether this
is visible.SuggestBox
Parameters
Name | Type | Description |
---|---|---|
visible | Boolean | whether this should be visible or not. |
Return
— the SuggestBox
itself, useful for chaining.SuggestBox
setWidth(width)
setWidth(width)
Deprecated. This function is deprecated and should not be used in new scripts.
Sets the width of this
.SuggestBox
Parameters
Name | Type | Description |
---|---|---|
width | String | the new width in any CSS unit such as "10px" or "50%". |
Return
— the SuggestBox
itself, useful for chaining.SuggestBox