Google Apps Script

Class DecoratedTabPanel

A TabPanel that uses a DecoratedTabBar with 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 DecoratedTabPanel documentation here.

Methods

MethodReturn typeBrief description
add(widget)DecoratedTabPanelAdd a widget to the DecoratedTabPanel.
add(widget, text)DecoratedTabPanelAdds a widget to the stack with the given header text.
add(widget, text, asHtml)DecoratedTabPanelAdds a widget to the stack with the given header text.
add(widget, tabWidget)DecoratedTabPanelAdd a widget to this DecoratedTabPanel with the given widget as its tab header.
addSelectionHandler(handler)DecoratedTabPanelAdd a handler for selection events.
addStyleDependentName(styleName)DecoratedTabPanelSets the dependent style name of this DecoratedTabPanel.
addStyleName(styleName)DecoratedTabPanelAdds a style name to this DecoratedTabPanel.
getId()StringReturns the id that has been assigned to this object.
getTag()StringGets the text tag of this DecoratedTabPanel.
getType()StringGets the type of this object.
selectTab(index)DecoratedTabPanelSelect a tab by index.
setAnimationEnabled(animationEnabled)DecoratedTabPanelSets whether changing tabs DecoratedTabPanel is animated.
setHeight(height)DecoratedTabPanelSets the height of this DecoratedTabPanel.
setId(id)DecoratedTabPanelSets the id of this DecoratedTabPanel.
setPixelSize(width, height)DecoratedTabPanelSets the size of this DecoratedTabPanel in pixels.
setSize(width, height)DecoratedTabPanelSets the size of this DecoratedTabPanel.
setStyleAttribute(attribute, value)DecoratedTabPanelSets one of this DecoratedTabPanel's style attributes to a new value.
setStyleAttributes(attributes)DecoratedTabPanelSets this DecoratedTabPanel's style attributes.
setStyleName(styleName)DecoratedTabPanelSets the style name of this DecoratedTabPanel.
setStylePrimaryName(styleName)DecoratedTabPanelSets the primary style name of this DecoratedTabPanel.
setTag(tag)DecoratedTabPanelSets the text tag of this DecoratedTabPanel.
setTitle(title)DecoratedTabPanelSets the hover title of this DecoratedTabPanel.
setVisible(visible)DecoratedTabPanelSets whether this DecoratedTabPanel is visible.
setWidth(width)DecoratedTabPanelSets the width of this DecoratedTabPanel.

Detailed documentation

add(widget)

Add a widget to the DecoratedTabPanel.

Parameters

NameTypeDescription
widgetWidgetthe widget to add.

Return

DecoratedTabPanel — the DecoratedTabPanel itself, useful for chaining.


add(widget, text)

Adds a widget to the stack with the given header text.

Parameters

NameTypeDescription
widgetWidgetthe widget to add.
textStringthe new header text.

Return

DecoratedTabPanel — the DecoratedTabPanel itself, useful for chaining.


add(widget, text, asHtml)

Adds a widget to the stack with the given header text.

Parameters

NameTypeDescription
widgetWidgetthe widget to add.
textStringthe new header text.
asHtmlBooleanwhether to treat the text as HTML.

Return

DecoratedTabPanel — the DecoratedTabPanel itself, useful for chaining.


add(widget, tabWidget)

Add a widget to this DecoratedTabPanel with the given widget as its tab header.

Parameters

NameTypeDescription
widgetWidgetthe widget to add.
tabWidgetWidgetthe header widget.

Return

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

DecoratedTabPanel — the DecoratedTabPanel itself, useful for chaining.


addStyleDependentName(styleName)

Sets the dependent style name of this DecoratedTabPanel.

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

DecoratedTabPanel — the DecoratedTabPanel itself, useful for chaining.


addStyleName(styleName)

Adds a style name to this DecoratedTabPanel.

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

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

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

DecoratedTabPanel — the DecoratedTabPanel itself, useful for chaining.


setAnimationEnabled(animationEnabled)

Sets whether changing tabs DecoratedTabPanel is animated.

Parameters

NameTypeDescription
animationEnabledBooleanwhether to animate changing tabs.

Return

DecoratedTabPanel — the DecoratedTabPanel itself, useful for chaining.


setHeight(height)

Sets the height of this DecoratedTabPanel.

Parameters

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

Return

DecoratedTabPanel — the DecoratedTabPanel itself, useful for chaining.


setId(id)

Sets the id of this DecoratedTabPanel.

Parameters

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

Return

DecoratedTabPanel — the DecoratedTabPanel itself, useful for chaining.


setPixelSize(width, height)

Sets the size of this DecoratedTabPanel in pixels.

Parameters

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

Return

DecoratedTabPanel — the DecoratedTabPanel itself, useful for chaining.


setSize(width, height)

Sets the size of this DecoratedTabPanel.

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

DecoratedTabPanel — the DecoratedTabPanel itself, useful for chaining.


setStyleAttribute(attribute, value)

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

DecoratedTabPanel — the DecoratedTabPanel itself, useful for chaining.


setStyleAttributes(attributes)

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

DecoratedTabPanel — the DecoratedTabPanel itself, useful for chaining.


setStyleName(styleName)

Sets the style name of this DecoratedTabPanel.

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

DecoratedTabPanel — the DecoratedTabPanel itself, useful for chaining.


setStylePrimaryName(styleName)

Sets the primary style name of this DecoratedTabPanel.

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

DecoratedTabPanel — the DecoratedTabPanel itself, useful for chaining.


setTag(tag)

Sets the text tag of this DecoratedTabPanel.

Parameters

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

Return

DecoratedTabPanel — the DecoratedTabPanel itself, useful for chaining.


setTitle(title)

Sets the hover title of this DecoratedTabPanel.

Not all browsers will show this.

Parameters

NameTypeDescription
titleStringthe hover title.

Return

DecoratedTabPanel — the DecoratedTabPanel itself, useful for chaining.


setVisible(visible)

Sets whether this DecoratedTabPanel is visible.

Parameters

NameTypeDescription
visibleBooleanwhether this DecoratedTabPanel should be visible or not.

Return

DecoratedTabPanel — the DecoratedTabPanel itself, useful for chaining.


setWidth(width)

Sets the width of this DecoratedTabPanel.

Parameters

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

Return

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