Class TabBar

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

A horizontal bar of folder-style tabs, most commonly used as part of a TabPanel.

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 TabBar documentation here.

Deprecated methods

Method	Return type	Brief description
`addBeforeSelectionHandler(handler)`	`TabBar`	Add a handler that fires before the selection occurs.
`addSelectionHandler(handler)`	`TabBar`	Add a handler for selection events.
`addStyleDependentName(styleName)`	`TabBar`	Sets the dependent style name of this `TabBar`.
`addStyleName(styleName)`	`TabBar`	Adds a style name to this `TabBar`.
`addTab(title)`	`TabBar`	Add a tab with the given title.
`addTab(title, asHtml)`	`TabBar`	Add a tab with the given title.
`addTab(widget)`	`TabBar`	Add a tab with the given widget as its title.
`getId()`	`String`	Returns the id that has been assigned to this object.
`getTag()`	`String`	Gets the text tag of this `TabBar`.
`getType()`	`String`	Gets the type of this object.
`selectTab(index)`	`TabBar`	Select a tab by index.
`setHeight(height)`	`TabBar`	Sets the height of this `TabBar`.
`setId(id)`	`TabBar`	Sets the id of this `TabBar`.
`setLayoutData(layout)`	`TabBar`	Set the layout for this `TabBar`.
`setPixelSize(width, height)`	`TabBar`	Sets the size of this `TabBar` in pixels.
`setSize(width, height)`	`TabBar`	Sets the size of this `TabBar`.
`setStyleAttribute(attribute, value)`	`TabBar`	Sets one of this `TabBar`'s style attributes to a new value.
`setStyleAttributes(attributes)`	`TabBar`	Sets this `TabBar`'s style attributes.
`setStyleName(styleName)`	`TabBar`	Sets the style name of this `TabBar`.
`setStylePrimaryName(styleName)`	`TabBar`	Sets the primary style name of this `TabBar`.
`setTabEnabled(index, enabled)`	`TabBar`	Set whether the given tab is enabled.
`setTabText(index, text)`	`TabBar`	Set the header text of a given tab.
`setTag(tag)`	`TabBar`	Sets the text tag of this `TabBar`.
`setTitle(title)`	`TabBar`	Sets the hover title of this `TabBar`.
`setVisible(visible)`	`TabBar`	Sets whether this `TabBar` is visible.
`setWidth(width)`	`TabBar`	Sets the width of this `TabBar`.

Deprecated methods

`addBeforeSelectionHandler(handler)`

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

Add a handler that fires before the selection occurs.

This is deprecated in favor of addSelectionHandler, because there is no way to cancel the selection so they are functionally identical.

Parameters

Name	Type	Description
`handler`	`Handler`	the handler to invoke.

Return

TabBar — the TabBar itself, useful for chaining.

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

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

Return

TabBar — the TabBar itself, useful for chaining.

`addStyleDependentName(styleName)`

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

Sets the dependent style name of this TabBar.

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

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

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

TabBar — the TabBar itself, useful for chaining.

`addTab(title)`

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

Add a tab with the given title.

Parameters

Name	Type	Description
`title`	`String`	the new tab's title.

Return

TabBar — the TabBar itself, useful for chaining.

`addTab(title, asHtml)`

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

Add a tab with the given title.

Parameters

Name	Type	Description
`title`	`String`	the new tab's title.
`asHtml`	`Boolean`	whether to treat the title as HTML.

Return

TabBar — the TabBar itself, useful for chaining.

`addTab(widget)`

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

Add a tab with the given widget as its title.

Parameters

Name	Type	Description
`widget`	`Widget`	the new tab's title widget.

Return

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

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

`selectTab(index)`

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

Select a tab by index.

Parameters

Name	Type	Description
`index`	`Integer`	the index of the tab to select.

Return

TabBar — the TabBar itself, useful for chaining.

`setHeight(height)`

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

Sets the height of this TabBar.

Parameters

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

Return

TabBar — the TabBar itself, useful for chaining.

`setId(id)`

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

Sets the id of this TabBar.

Parameters

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

Return

TabBar — the TabBar itself, useful for chaining.

`setLayoutData(layout)`

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

Set the layout for this TabBar.

This is not currently functional.

Parameters

Name	Type	Description
`layout`	`Object`

Return

TabBar — the TabBar 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 TabBar in pixels.

Parameters

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

Return

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

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

TabBar — the TabBar itself, useful for chaining.

`setStyleAttribute(attribute, value)`

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

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

TabBar — the TabBar itself, useful for chaining.

`setStyleAttributes(attributes)`

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

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

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

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

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

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

TabBar — the TabBar itself, useful for chaining.

`setTabEnabled(index, enabled)`

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

Set whether the given tab is enabled.

Parameters

Name	Type	Description
`index`	`Integer`	the tab index.
`enabled`	`Boolean`	whether the tab should be enabled.

Return

TabBar — the TabBar itself, useful for chaining.

`setTabText(index, text)`

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

Set the header text of a given tab.

Parameters

Name	Type	Description
`index`	`Integer`	the index of the tab.
`text`	`String`	the new header text.

Return

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

Parameters

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

Return

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

Not all browsers will show this.

Parameters

Name	Type	Description
`title`	`String`	the hover title.

Return

TabBar — the TabBar itself, useful for chaining.

`setVisible(visible)`

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

Sets whether this TabBar is visible.

Parameters

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

Return

TabBar — the TabBar itself, useful for chaining.

`setWidth(width)`

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

Sets the width of this TabBar.

Parameters

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

Return

TabBar — the TabBar itself, useful for chaining.

Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 3.0 License, and code samples are licensed under the Apache 2.0 License. For details, see our Site Policies.

Last updated February 26, 2015.