Google Apps Script

Class SuggestBox

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

A SuggestBox is a text box or text area which displays a pre-configured set of selections that match the user's input.

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.

Methods

MethodReturn typeBrief description
addKeyDownHandler(handler)SuggestBoxAdd a handler for key down events.
addKeyPressHandler(handler)SuggestBoxAdd a handler for key press events.
addKeyUpHandler(handler)SuggestBoxAdd a handler for key up events.
addSelectionHandler(handler)SuggestBoxAdd a handler for selection events.
addStyleDependentName(styleName)SuggestBoxSets the dependent style name of this SuggestBox.
addStyleName(styleName)SuggestBoxAdds a style name to this SuggestBox.
addValueChangeHandler(handler)SuggestBoxAdd a handler for value change events.
getId()StringReturns the id that has been assigned to this object.
getTag()StringGets the text tag of this SuggestBox.
getType()StringGets the type of this object.
setAnimationEnabled(animationEnabled)SuggestBoxSets whether opening and closing the SuggestBox is animated.
setFocus(focus)SuggestBoxExplicitly focus/unfocus this SuggestBox.
setHeight(height)SuggestBoxSets the height of this SuggestBox.
setId(id)SuggestBoxSets the id of this SuggestBox.
setPixelSize(width, height)SuggestBoxSets the size of this SuggestBox in pixels.
setSize(width, height)SuggestBoxSets the size of this SuggestBox.
setStyleAttribute(attribute, value)SuggestBoxSets one of this SuggestBox's style attributes to a new value.
setStyleAttributes(attributes)SuggestBoxSets this SuggestBox's style attributes.
setStyleName(styleName)SuggestBoxSets the style name of this SuggestBox.
setStylePrimaryName(styleName)SuggestBoxSets the primary style name of this SuggestBox.
setTabIndex(index)SuggestBoxSets the SuggestBox's position in the tab index.
setTag(tag)SuggestBoxSets the text tag of this SuggestBox.
setText(text)SuggestBoxSet the display text of this SuggestBox.
setTitle(title)SuggestBoxSets the hover title of this SuggestBox.
setValue(value)SuggestBoxSets the value of this SuggestBox.
setVisible(visible)SuggestBoxSets whether this SuggestBox is visible.
setWidth(width)SuggestBoxSets the width of this SuggestBox.

Detailed documentation

addKeyDownHandler(handler)

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

NameTypeDescription
handlerHandlerthe handler to execute when the event occurs. This can be a ClientHandler or a ServerHandler.

Return

SuggestBox — the SuggestBox itself, useful for chaining.


addKeyPressHandler(handler)

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

NameTypeDescription
handlerHandlerthe handler to execute when the event occurs. This can be a ClientHandler or a ServerHandler.

Return

SuggestBox — the SuggestBox itself, useful for chaining.


addKeyUpHandler(handler)

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

NameTypeDescription
handlerHandlerthe handler to execute when the event occurs. This can be a ClientHandler or a ServerHandler.

Return

SuggestBox — the SuggestBox itself, useful for chaining.


addSelectionHandler(handler)

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

NameTypeDescription
handlerHandlerthe handler to execute when the event occurs. This can be a ClientHandler or a ServerHandler.

Return

SuggestBox — the SuggestBox itself, useful for chaining.


addStyleDependentName(styleName)

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

NameTypeDescription
styleNameStringthe new style name.

Return

SuggestBox — the SuggestBox itself, useful for chaining.


addStyleName(styleName)

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

NameTypeDescription
styleNameStringthe new style name.

Return

SuggestBox — the SuggestBox itself, useful for chaining.


addValueChangeHandler(handler)

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

NameTypeDescription
handlerHandlerthe handler to execute when the event occurs. This can be a ClientHandler or a ServerHandler.

Return

SuggestBox — the SuggestBox itself, useful for chaining.


getId()

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()

Gets the text tag of this SuggestBox.

Return

String — the text tag.


getType()

Gets the type of this object.

Return

String — the object type


setAnimationEnabled(animationEnabled)

Sets whether opening and closing the SuggestBox is animated.

Parameters

NameTypeDescription
animationEnabledBooleanwhether to animate opening and closing.

Return

SuggestBox — the SuggestBox itself, useful for chaining.


setFocus(focus)

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

NameTypeDescription
focusBooleanwhether the SuggestBox should have the current focus.

Return

SuggestBox — the SuggestBox itself, useful for chaining.


setHeight(height)

Sets the height of this SuggestBox.

Parameters

NameTypeDescription
heightStringthe new height in any CSS unit such as "10px" or "50%".

Return

SuggestBox — the SuggestBox itself, useful for chaining.


setId(id)

Sets the id of this SuggestBox.

Parameters

NameTypeDescription
idStringthe new id, which can be used to retrieve the SuggestBox from app.getElementById(id).

Return

SuggestBox — the SuggestBox itself, useful for chaining.


setPixelSize(width, height)

Sets the size of this SuggestBox in pixels.

Parameters

NameTypeDescription
widthIntegerthe new width in pixels.
heightIntegerthe new height in pixels.

Return

SuggestBox — the SuggestBox itself, useful for chaining.


setSize(width, height)

Sets the size of this SuggestBox.

Parameters

NameTypeDescription
widthStringthe new width in any CSS unit such as "10px" or "50%".
heightStringthe new height in any CSS unit such as "10px" or "50%".

Return

SuggestBox — the SuggestBox itself, useful for chaining.


setStyleAttribute(attribute, value)

Sets one of this SuggestBox'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

NameTypeDescription
attributeStringthe CSS attribute, in camel-case ("fontSize", not "font-size"), as listed here
valueStringthe CSS value

Return

SuggestBox — the SuggestBox itself, useful for chaining.


setStyleAttributes(attributes)

Sets this SuggestBox'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

NameTypeDescription
attributesObjectan object of key/value pairs for the CSS attributes and values to set; valid attributes are listed here

Return

SuggestBox — the SuggestBox itself, useful for chaining.


setStyleName(styleName)

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

NameTypeDescription
styleNameStringthe new style name.

Return

SuggestBox — the SuggestBox itself, useful for chaining.


setStylePrimaryName(styleName)

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

NameTypeDescription
styleNameStringthe new style name.

Return

SuggestBox — the SuggestBox itself, useful for chaining.


setTabIndex(index)

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

NameTypeDescription
indexIntegerthe new tab index.

Return

SuggestBox — the SuggestBox itself, useful for chaining.


setTag(tag)

Sets the text tag of this SuggestBox.

Parameters

NameTypeDescription
tagStringthe new text tag, which can be anything you wish to store with the widget.

Return

SuggestBox — the SuggestBox itself, useful for chaining.


setText(text)

Set the display text of this SuggestBox.

Parameters

NameTypeDescription
textStringthe new text.

Return

SuggestBox — the SuggestBox itself, useful for chaining.


setTitle(title)

Sets the hover title of this SuggestBox.

Not all browsers will show this.

Parameters

NameTypeDescription
titleStringthe hover title.

Return

SuggestBox — the SuggestBox itself, useful for chaining.


setValue(value)

Sets the value of this SuggestBox.

Parameters

NameTypeDescription
valueStringthe new value.

Return

SuggestBox — the SuggestBox itself, useful for chaining.


setVisible(visible)

Sets whether this SuggestBox is visible.

Parameters

NameTypeDescription
visibleBooleanwhether this SuggestBox should be visible or not.

Return

SuggestBox — the SuggestBox itself, useful for chaining.


setWidth(width)

Sets the width of this SuggestBox.

Parameters

NameTypeDescription
widthStringthe new width in any CSS unit such as "10px" or "50%".

Return

SuggestBox — the SuggestBox itself, useful for chaining.

Deprecated methods






Authentication required

You need to be signed in with Google+ to do that.

Signing you in...

Google Developers needs your permission to do that.