Google Apps Script

Class ListBox

A widget that presents a list of choices to the user, either as a list box or as a drop-down list.

Here is an example usage, which should be executed from within a spreadsheet bound script.

 
// execute this in a spreadsheet
 function show() {
   var doc = SpreadsheetApp.getActiveSpreadsheet();
   var app = UiApp.createApplication().setTitle('My Application');
   var panel = app.createVerticalPanel();
   var lb = app.createListBox(true).setId('myId').setName('myLbName');

   // add items to ListBox
   lb.setVisibleItemCount(3);
   lb.addItem('first');
   lb.addItem('second');
   lb.addItem('third');
   lb.addItem('fourth');
   lb.addItem('fifth');
   lb.addItem('sixth');

   panel.add(lb);
   var button = app.createButton('press me');
   var handler = app.createServerClickHandler('click').addCallbackElement(panel);
   button.addClickHandler(handler);
   panel.add(button);
   app.add(panel);
   doc.show(app);
 }


 function click(eventInfo) {
   var app = UiApp.getActiveApplication();
   // get values of ListBox
   var value = eventInfo.parameter.myLbName;
   // multi select box returns a comma separated string
   var n = value.split(',');

   var doc = SpreadsheetApp.getActiveSpreadsheet();
   doc.getRange('a1').setValue(value);
   doc.getRange('b1').setValue('there are ' + n.length + ' items selected');
   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 ListBox documentation here.

Methods

MethodReturn typeBrief description
addBlurHandler(handler)ListBoxAdd a handler for blur events (losing keyboard focus).
addChangeHandler(handler)ListBoxAdd a handler for change events.
addClickHandler(handler)ListBoxAdd a handler for click events.
addFocusHandler(handler)ListBoxAdd a handler for focus events (gaining keyboard focus).
addItem(text)ListBoxAdds an item to the list box.
addItem(text, value)ListBoxAdds an item to the list box, specifying its value.
addKeyDownHandler(handler)ListBoxAdd a handler for key down events.
addKeyPressHandler(handler)ListBoxAdd a handler for key press events.
addKeyUpHandler(handler)ListBoxAdd a handler for key up events.
addMouseDownHandler(handler)ListBoxAdd a handler for mouse down events.
addMouseMoveHandler(handler)ListBoxAdd a handler for mouse move events.
addMouseOutHandler(handler)ListBoxAdd a handler for mouse out events.
addMouseOverHandler(handler)ListBoxAdd a handler for mouse move events.
addMouseUpHandler(handler)ListBoxAdd a handler for mouse up events.
addMouseWheelHandler(handler)ListBoxAdd a handler for mouse wheel events.
addStyleDependentName(styleName)ListBoxSets the dependent style name of this ListBox.
addStyleName(styleName)ListBoxAdds a style name to this ListBox.
clear()ListBoxRemoves all items from the list box.
getId()StringReturns the id that has been assigned to this object.
getTag()StringGets the text tag of this ListBox.
getType()StringGets the type of this object.
removeItem(index)ListBoxRemoves the item at the specified index.
setEnabled(enabled)ListBoxSets whether the ListBox is enabled.
setFocus(focus)ListBoxExplicitly focus/unfocus this ListBox.
setHeight(height)ListBoxSets the height of this ListBox.
setId(id)ListBoxSets the id of this ListBox.
setItemSelected(index, selected)ListBoxSelects the item at the specified index.
setItemText(index, text)ListBoxSets the text associated with the item at a given index.
setName(name)ListBoxSets the name of the ListBox, 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)ListBoxSets the size of this ListBox in pixels.
setSelectedIndex(index)ListBoxSelects the item at the specified index.
setSize(width, height)ListBoxSets the size of this ListBox.
setStyleAttribute(attribute, value)ListBoxSets one of this ListBox's style attributes to a new value.
setStyleAttributes(attributes)ListBoxSets this ListBox's style attributes.
setStyleName(styleName)ListBoxSets the style name of this ListBox.
setStylePrimaryName(styleName)ListBoxSets the primary style name of this ListBox.
setTabIndex(index)ListBoxSets the ListBox's position in the tab index.
setTag(tag)ListBoxSets the text tag of this ListBox.
setTitle(title)ListBoxSets the hover title of this ListBox.
setValue(index, value)ListBoxSets the value associated with the item at a given index.
setVisible(visible)ListBoxSets whether this ListBox is visible.
setVisibleItemCount(count)ListBoxSets the number of items that are visible.
setWidth(width)ListBoxSets the width of this ListBox.

Detailed documentation

addBlurHandler(handler)

Add a handler for blur events (losing keyboard focus).

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.addBlurHandler(handler);
   app.add(button);
   return app;
 }

 function handlerFunction(eventInfo) {
   var parameter = eventInfo.parameter;
   // the type of event, in this case "blur".
   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

ListBox — the ListBox itself, useful for chaining.


addChangeHandler(handler)

Add a handler for 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.addChangeHandler(handler);
   app.add(textBox);
   return app;
 }

 function handlerFunction(eventInfo) {
   var parameter = eventInfo.parameter;
   // the type of event, in this case "change".
   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

ListBox — the ListBox itself, useful for chaining.


addClickHandler(handler)

Add a handler for click 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.addClickHandler(handler);
   app.add(button);
   return app;
 }

 function handlerFunction(eventInfo) {
   var parameter = eventInfo.parameter;
   // the type of event, in this case "click".
   var eventType = parameter.eventType;
   // the id of the widget that fired this event.
   var source = parameter.source;
   // mouse x and y position relative to the widget that fired the event.
   var x = parameter.x;
   var y = parameter.y;
   // mouse x and y position within the browser window's client area.
   var clientX = parameter.clientX;
   var clientY = parameter.clientY;
   // mouse x and y position within the user's display.
   var screenX = parameter.screenX;
   var screenY = parameter.screenY;
   // the mouse button used. Left is 1, right is 2, and middle is 4.
   var button = parameter.button;
   // 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.

Parameters

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

Return

ListBox — the ListBox itself, useful for chaining.


addFocusHandler(handler)

Add a handler for focus events (gaining keyboard focus).

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.addFocusHandler(handler);
   app.add(button);
   return app;
 }

 function handlerFunction(eventInfo) {
   var parameter = eventInfo.parameter;
   // the type of event, in this case "focus".
   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

ListBox — the ListBox itself, useful for chaining.


addItem(text)

Adds an item to the list box.

The item's value will be the same as its text.

Parameters

NameTypeDescription
textStringthe new item's text.

Return

ListBox — the ListBox itself, useful for chaining.


addItem(text, value)

Adds an item to the list box, specifying its value.

Parameters

NameTypeDescription
textStringthe new item's text.
valueStringthe new item's value.

Return

ListBox — the ListBox itself, useful for chaining.


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

ListBox — the ListBox 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

ListBox — the ListBox 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

ListBox — the ListBox itself, useful for chaining.


addMouseDownHandler(handler)

Add a handler for mouse 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.addMouseDownHandler(handler);
   app.add(button);
   return app;
 }

 function handlerFunction(eventInfo) {
   var parameter = eventInfo.parameter;
   // the type of event, in this case "mousedown".
   var eventType = parameter.eventType;
   // the id of the widget that fired this event.
   var source = parameter.source;
   // mouse x and y position relative to the widget that fired the event.
   var x = parameter.x;
   var y = parameter.y;
   // mouse x and y position within the browser window's client area.
   var clientX = parameter.clientX;
   var clientY = parameter.clientY;
   // mouse x and y position within the user's display.
   var screenX = parameter.screenX;
   var screenY = parameter.screenY;
   // the mouse button used. Left is 1, right is 2, and middle is 4.
   var button = parameter.button;
   // 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.

Parameters

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

Return

ListBox — the ListBox itself, useful for chaining.


addMouseMoveHandler(handler)

Add a handler for mouse move 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.addMouseMoveHandler(handler);
   app.add(button);
   return app;
 }

 function handlerFunction(eventInfo) {
   var parameter = eventInfo.parameter;
   // the type of event, in this case "mousemove".
   var eventType = parameter.eventType;
   // the id of the widget that fired this event.
   var source = parameter.source;
   // mouse x and y position relative to the widget that fired the event.
   var x = parameter.x;
   var y = parameter.y;
   // mouse x and y position within the browser window's client area.
   var clientX = parameter.clientX;
   var clientY = parameter.clientY;
   // mouse x and y position within the user's display.
   var screenX = parameter.screenX;
   var screenY = parameter.screenY;
   // the mouse button used. Left is 1, right is 2, and middle is 4.
   var button = parameter.button;
   // 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.

Parameters

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

Return

ListBox — the ListBox itself, useful for chaining.


addMouseOutHandler(handler)

Add a handler for mouse out 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.addMouseOutHandler(handler);
   app.add(button);
   return app;
 }

 function handlerFunction(eventInfo) {
   var parameter = eventInfo.parameter;
   // the type of event, in this case "mouseout".
   var eventType = parameter.eventType;
   // the id of the widget that fired this event.
   var source = parameter.source;
   // mouse x and y position relative to the widget that fired the event.
   var x = parameter.x;
   var y = parameter.y;
   // mouse x and y position within the browser window's client area.
   var clientX = parameter.clientX;
   var clientY = parameter.clientY;
   // mouse x and y position within the user's display.
   var screenX = parameter.screenX;
   var screenY = parameter.screenY;
   // the mouse button used. Left is 1, right is 2, and middle is 4.
   var button = parameter.button;
   // 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.

Parameters

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

Return

ListBox — the ListBox itself, useful for chaining.


addMouseOverHandler(handler)

Add a handler for mouse move 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.addMouseOverHandler(handler);
   app.add(button);
   return app;
 }

 function handlerFunction(eventInfo) {
   var parameter = eventInfo.parameter;
   // the type of event, in this case "mousover".
   var eventType = parameter.eventType;
   // the id of the widget that fired this event.
   var source = parameter.source;
   // mouse x and y position relative to the widget that fired the event.
   var x = parameter.x;
   var y = parameter.y;
   // mouse x and y position within the browser window's client area.
   var clientX = parameter.clientX;
   var clientY = parameter.clientY;
   // mouse x and y position within the user's display.
   var screenX = parameter.screenX;
   var screenY = parameter.screenY;
   // the mouse button used. Left is 1, right is 2, and middle is 4.
   var button = parameter.button;
   // 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.

Parameters

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

Return

ListBox — the ListBox itself, useful for chaining.


addMouseUpHandler(handler)

Add a handler for mouse 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.addMouseUpHandler(handler);
   app.add(button);
   return app;
 }

 function handlerFunction(eventInfo) {
   var parameter = eventInfo.parameter;
   // the type of event, in this case "mouseup".
   var eventType = parameter.eventType;
   // the id of the widget that fired this event.
   var source = parameter.source;
   // mouse x and y position relative to the widget that fired the event.
   var x = parameter.x;
   var y = parameter.y;
   // mouse x and y position within the browser window's client area.
   var clientX = parameter.clientX;
   var clientY = parameter.clientY;
   // mouse x and y position within the user's display.
   var screenX = parameter.screenX;
   var screenY = parameter.screenY;
   // the mouse button used. Left is 1, right is 2, and middle is 4.
   var button = parameter.button;
   // 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.

Parameters

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

Return

ListBox — the ListBox itself, useful for chaining.


addMouseWheelHandler(handler)

Add a handler for mouse wheel 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.addMouseWheelHandler(handler);
   app.add(button);
   return app;
 }

 function handlerFunction(eventInfo) {
   var parameter = eventInfo.parameter;
   // the type of event, in this case "mousewheel".
   var eventType = parameter.eventType;
   // the id of the widget that fired this event.
   var source = parameter.source;
   // mouse x and y position relative to the widget that fired the event.
   var x = parameter.x;
   var y = parameter.y;
   // mouse x and y position within the browser window's client area.
   var clientX = parameter.clientX;
   var clientY = parameter.clientY;
   // mouse x and y position within the user's display.
   var screenX = parameter.screenX;
   var screenY = parameter.screenY;
   // the mouse button used. Left is 1, right is 2, and middle is 4.
   var button = parameter.button;
   // 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.

Parameters

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

Return

ListBox — the ListBox itself, useful for chaining.


addStyleDependentName(styleName)

Sets the dependent style name of this ListBox.

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

ListBox — the ListBox itself, useful for chaining.


addStyleName(styleName)

Adds a style name to this ListBox.

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

ListBox — the ListBox itself, useful for chaining.


clear()

Removes all items from the list box.

Return

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

Return

String — the text tag.


getType()

Gets the type of this object.

Return

String — the object type


removeItem(index)

Removes the item at the specified index.

Parameters

NameTypeDescription
indexIntegerthe index of the item to be removed.

Return

ListBox — the ListBox itself, useful for chaining.


setEnabled(enabled)

Sets whether the ListBox is enabled.

Parameters

NameTypeDescription
enabledBooleanwhether the ListBox should be enabled or disabled.

Return

ListBox — the ListBox itself, useful for chaining.


setFocus(focus)

Explicitly focus/unfocus this ListBox.

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

Parameters

NameTypeDescription
focusBooleanwhether the ListBox should have the current focus.

Return

ListBox — the ListBox itself, useful for chaining.


setHeight(height)

Sets the height of this ListBox.

Parameters

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

Return

ListBox — the ListBox itself, useful for chaining.


setId(id)

Sets the id of this ListBox.

Parameters

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

Return

ListBox — the ListBox itself, useful for chaining.


setItemSelected(index, selected)

Selects the item at the specified index.

In a ListBox with multiple selection enabled, this will alter whether the given item is selected but will not alter any other items. In a ListBox with multiple selection disabled, selecting an item will cause all other items to be deselected. Note that setting the selection programmatically does not cause a change event to be fired.

Parameters

NameTypeDescription
indexIntegerthe index of the item to be selected.
selectedBooleanwhether the item should be selected or not.

Return

ListBox — the ListBox itself, useful for chaining.


setItemText(index, text)

Sets the text associated with the item at a given index.

Parameters

NameTypeDescription
indexIntegerthe index of the item to be changed.
textStringthe item's new text.

Return

ListBox — the ListBox itself, useful for chaining.


setName(name)

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

Parameters

NameTypeDescription
nameStringthe new name.

Return

ListBox — the ListBox itself, useful for chaining.


setPixelSize(width, height)

Sets the size of this ListBox in pixels.

Parameters

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

Return

ListBox — the ListBox itself, useful for chaining.


setSelectedIndex(index)

Selects the item at the specified index.

After calling this method, only the specified item in the list will remain selected. For a ListBox with multiple selection enabled, see setItemSelected to select multiple items at a time. Note that setting the selection programmatically does not cause a change event to be fired.

Parameters

NameTypeDescription
indexIntegerthe index of the item to be selected.

Return

ListBox — the ListBox itself, useful for chaining.


setSize(width, height)

Sets the size of this ListBox.

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

ListBox — the ListBox itself, useful for chaining.


setStyleAttribute(attribute, value)

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

ListBox — the ListBox itself, useful for chaining.


setStyleAttributes(attributes)

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

ListBox — the ListBox itself, useful for chaining.


setStyleName(styleName)

Sets the style name of this ListBox.

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

ListBox — the ListBox itself, useful for chaining.


setStylePrimaryName(styleName)

Sets the primary style name of this ListBox.

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

ListBox — the ListBox itself, useful for chaining.


setTabIndex(index)

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

ListBox — the ListBox itself, useful for chaining.


setTag(tag)

Sets the text tag of this ListBox.

Parameters

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

Return

ListBox — the ListBox itself, useful for chaining.


setTitle(title)

Sets the hover title of this ListBox.

Not all browsers will show this.

Parameters

NameTypeDescription
titleStringthe hover title.

Return

ListBox — the ListBox itself, useful for chaining.


setValue(index, value)

Sets the value associated with the item at a given index.

This is passed to the server when the list box is submitted as part of a FormPanel.

Parameters

NameTypeDescription
indexIntegerthe index of the item to be changed.
valueStringthe item's new value.

Return

ListBox — the ListBox itself, useful for chaining.


setVisible(visible)

Sets whether this ListBox is visible.

Parameters

NameTypeDescription
visibleBooleanwhether this ListBox should be visible or not.

Return

ListBox — the ListBox itself, useful for chaining.


setVisibleItemCount(count)

Sets the number of items that are visible.

If only one item is visible, then the box will be displayed as a drop-down list.

Parameters

NameTypeDescription
countIntegerthe number of items to show.

Return

ListBox — the ListBox itself, useful for chaining.


setWidth(width)

Sets the width of this ListBox.

Parameters

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

Return

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