Google Apps Script

Class TabBar

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.

Methods

MethodReturn typeBrief description
addSelectionHandler(handler)TabBarAdd a handler for selection events.
addStyleDependentName(styleName)TabBarSets the dependent style name of this TabBar.
addStyleName(styleName)TabBarAdds a style name to this TabBar.
addTab(title)TabBarAdd a tab with the given title.
addTab(title, asHtml)TabBarAdd a tab with the given title.
addTab(widget)TabBarAdd a tab with the given widget as its title.
getId()StringReturns the id that has been assigned to this object.
getTag()StringGets the text tag of this TabBar.
getType()StringGets the type of this object.
selectTab(index)TabBarSelect a tab by index.
setHeight(height)TabBarSets the height of this TabBar.
setId(id)TabBarSets the id of this TabBar.
setPixelSize(width, height)TabBarSets the size of this TabBar in pixels.
setSize(width, height)TabBarSets the size of this TabBar.
setStyleAttribute(attribute, value)TabBarSets one of this TabBar's style attributes to a new value.
setStyleAttributes(attributes)TabBarSets this TabBar's style attributes.
setStyleName(styleName)TabBarSets the style name of this TabBar.
setStylePrimaryName(styleName)TabBarSets the primary style name of this TabBar.
setTabEnabled(index, enabled)TabBarSet whether the given tab is enabled.
setTabText(index, text)TabBarSet the header text of a given tab.
setTag(tag)TabBarSets the text tag of this TabBar.
setTitle(title)TabBarSets the hover title of this TabBar.
setVisible(visible)TabBarSets whether this TabBar is visible.
setWidth(width)TabBarSets the width of this TabBar.

Detailed documentation

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

TabBar — the TabBar itself, useful for chaining.


addStyleDependentName(styleName)

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

NameTypeDescription
styleNameStringthe new style name.

Return

TabBar — the TabBar itself, useful for chaining.


addStyleName(styleName)

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

NameTypeDescription
styleNameStringthe new style name.

Return

TabBar — the TabBar itself, useful for chaining.


addTab(title)

Add a tab with the given title.

Parameters

NameTypeDescription
titleStringthe new tab's title.

Return

TabBar — the TabBar itself, useful for chaining.


addTab(title, asHtml)

Add a tab with the given title.

Parameters

NameTypeDescription
titleStringthe new tab's title.
asHtmlBooleanwhether to treat the title as HTML.

Return

TabBar — the TabBar itself, useful for chaining.


addTab(widget)

Add a tab with the given widget as its title.

Parameters

NameTypeDescription
widgetWidgetthe new tab's title widget.

Return

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

Return

String — the text tag.


getType()

Gets the type of this object.

Return

String — the object type


selectTab(index)

Select a tab by index.

Parameters

NameTypeDescription
indexIntegerthe index of the tab to select.

Return

TabBar — the TabBar itself, useful for chaining.


setHeight(height)

Sets the height of this TabBar.

Parameters

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

Return

TabBar — the TabBar itself, useful for chaining.


setId(id)

Sets the id of this TabBar.

Parameters

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

Return

TabBar — the TabBar itself, useful for chaining.


setPixelSize(width, height)

Sets the size of this TabBar in pixels.

Parameters

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

Return

TabBar — the TabBar itself, useful for chaining.


setSize(width, height)

Sets the size of this TabBar.

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

TabBar — the TabBar itself, useful for chaining.


setStyleAttribute(attribute, value)

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

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

Return

TabBar — the TabBar itself, useful for chaining.


setStyleAttributes(attributes)

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

NameTypeDescription
attributesObjectan 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)

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

NameTypeDescription
styleNameStringthe new style name.

Return

TabBar — the TabBar itself, useful for chaining.


setStylePrimaryName(styleName)

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

NameTypeDescription
styleNameStringthe new style name.

Return

TabBar — the TabBar itself, useful for chaining.


setTabEnabled(index, enabled)

Set whether the given tab is enabled.

Parameters

NameTypeDescription
indexIntegerthe tab index.
enabledBooleanwhether the tab should be enabled.

Return

TabBar — the TabBar itself, useful for chaining.


setTabText(index, text)

Set the header text of a given tab.

Parameters

NameTypeDescription
indexIntegerthe index of the tab.
textStringthe new header text.

Return

TabBar — the TabBar itself, useful for chaining.


setTag(tag)

Sets the text tag of this TabBar.

Parameters

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

Return

TabBar — the TabBar itself, useful for chaining.


setTitle(title)

Sets the hover title of this TabBar.

Not all browsers will show this.

Parameters

NameTypeDescription
titleStringthe hover title.

Return

TabBar — the TabBar itself, useful for chaining.


setVisible(visible)

Sets whether this TabBar is visible.

Parameters

NameTypeDescription
visibleBooleanwhether this TabBar should be visible or not.

Return

TabBar — the TabBar itself, useful for chaining.


setWidth(width)

Sets the width of this TabBar.

Parameters

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

Return

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