Google Apps Script

Class DecoratedTabBar

A TabBar that wraps each tab in a 2x3 grid (six box), which allows users to add rounded corners.

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

Methods

MethodReturn typeBrief description
addSelectionHandler(handler)DecoratedTabBarAdd a handler for selection events.
addStyleDependentName(styleName)DecoratedTabBarSets the dependent style name of this DecoratedTabBar.
addStyleName(styleName)DecoratedTabBarAdds a style name to this DecoratedTabBar.
addTab(title)DecoratedTabBarAdd a tab with the given title.
addTab(title, asHtml)DecoratedTabBarAdd a tab with the given title.
addTab(widget)DecoratedTabBarAdd 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 DecoratedTabBar.
getType()StringGets the type of this object.
selectTab(index)DecoratedTabBarSelect a tab by index.
setHeight(height)DecoratedTabBarSets the height of this DecoratedTabBar.
setId(id)DecoratedTabBarSets the id of this DecoratedTabBar.
setPixelSize(width, height)DecoratedTabBarSets the size of this DecoratedTabBar in pixels.
setSize(width, height)DecoratedTabBarSets the size of this DecoratedTabBar.
setStyleAttribute(attribute, value)DecoratedTabBarSets one of this DecoratedTabBar's style attributes to a new value.
setStyleAttributes(attributes)DecoratedTabBarSets this DecoratedTabBar's style attributes.
setStyleName(styleName)DecoratedTabBarSets the style name of this DecoratedTabBar.
setStylePrimaryName(styleName)DecoratedTabBarSets the primary style name of this DecoratedTabBar.
setTabEnabled(index, enabled)DecoratedTabBarSet whether the given tab is enabled.
setTabText(index, text)DecoratedTabBarSet the header text of a given tab.
setTag(tag)DecoratedTabBarSets the text tag of this DecoratedTabBar.
setTitle(title)DecoratedTabBarSets the hover title of this DecoratedTabBar.
setVisible(visible)DecoratedTabBarSets whether this DecoratedTabBar is visible.
setWidth(width)DecoratedTabBarSets the width of this DecoratedTabBar.

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

DecoratedTabBar — the DecoratedTabBar itself, useful for chaining.


addStyleDependentName(styleName)

Sets the dependent style name of this DecoratedTabBar.

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

DecoratedTabBar — the DecoratedTabBar itself, useful for chaining.


addStyleName(styleName)

Adds a style name to this DecoratedTabBar.

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

DecoratedTabBar — the DecoratedTabBar itself, useful for chaining.


addTab(title)

Add a tab with the given title.

Parameters

NameTypeDescription
titleStringthe new tab's title.

Return

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

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

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

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

DecoratedTabBar — the DecoratedTabBar itself, useful for chaining.


setHeight(height)

Sets the height of this DecoratedTabBar.

Parameters

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

Return

DecoratedTabBar — the DecoratedTabBar itself, useful for chaining.


setId(id)

Sets the id of this DecoratedTabBar.

Parameters

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

Return

DecoratedTabBar — the DecoratedTabBar itself, useful for chaining.


setPixelSize(width, height)

Sets the size of this DecoratedTabBar in pixels.

Parameters

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

Return

DecoratedTabBar — the DecoratedTabBar itself, useful for chaining.


setSize(width, height)

Sets the size of this DecoratedTabBar.

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

DecoratedTabBar — the DecoratedTabBar itself, useful for chaining.


setStyleAttribute(attribute, value)

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

DecoratedTabBar — the DecoratedTabBar itself, useful for chaining.


setStyleAttributes(attributes)

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

DecoratedTabBar — the DecoratedTabBar itself, useful for chaining.


setStyleName(styleName)

Sets the style name of this DecoratedTabBar.

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

DecoratedTabBar — the DecoratedTabBar itself, useful for chaining.


setStylePrimaryName(styleName)

Sets the primary style name of this DecoratedTabBar.

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

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

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

DecoratedTabBar — the DecoratedTabBar itself, useful for chaining.


setTag(tag)

Sets the text tag of this DecoratedTabBar.

Parameters

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

Return

DecoratedTabBar — the DecoratedTabBar itself, useful for chaining.


setTitle(title)

Sets the hover title of this DecoratedTabBar.

Not all browsers will show this.

Parameters

NameTypeDescription
titleStringthe hover title.

Return

DecoratedTabBar — the DecoratedTabBar itself, useful for chaining.


setVisible(visible)

Sets whether this DecoratedTabBar is visible.

Parameters

NameTypeDescription
visibleBooleanwhether this DecoratedTabBar should be visible or not.

Return

DecoratedTabBar — the DecoratedTabBar itself, useful for chaining.


setWidth(width)

Sets the width of this DecoratedTabBar.

Parameters

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

Return

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