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
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
ServerHandler
s 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
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
Name | Type | Description |
---|---|---|
styleName | String | the 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
Name | Type | Description |
---|---|---|
styleName | String | the new style name. |
Return
DecoratedTabBar
— the DecoratedTabBar
itself, useful for chaining.
addTab(title)
Add a tab with the given title.
Parameters
Name | Type | Description |
---|---|---|
title | String | the new tab's title. |
Return
DecoratedTabBar
— the DecoratedTabBar
itself, useful for chaining.
addTab(title, asHtml)
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
DecoratedTabBar
— the DecoratedTabBar
itself, useful for chaining.
addTab(widget)
Add a tab with the given widget as its title.
Parameters
Name | Type | Description |
---|---|---|
widget | Widget | the 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
getType()
Gets the type of this object.
Return
String
— the object type
selectTab(index)
Select a tab by index.
Parameters
Name | Type | Description |
---|---|---|
index | Integer | the index of the tab to select. |
Return
DecoratedTabBar
— the DecoratedTabBar
itself, useful for chaining.
setHeight(height)
Sets the height of this DecoratedTabBar
.
Parameters
Name | Type | Description |
---|---|---|
height | String | the 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
Name | Type | Description |
---|---|---|
id | String | the 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
Name | Type | Description |
---|---|---|
width | Integer | the new width in pixels. |
height | Integer | the new height in pixels. |
Return
DecoratedTabBar
— the DecoratedTabBar
itself, useful for chaining.
setSize(width, height)
Sets the size of this DecoratedTabBar
.
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
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
Name | Type | Description |
---|---|---|
attribute | String | the CSS attribute, in camel-case ("fontSize", not "font-size"), as listed here |
value | String | the 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
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
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
Name | Type | Description |
---|---|---|
styleName | String | the 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
Name | Type | Description |
---|---|---|
styleName | String | the new style name. |
Return
DecoratedTabBar
— the DecoratedTabBar
itself, useful for chaining.
setTabEnabled(index, enabled)
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
DecoratedTabBar
— the DecoratedTabBar
itself, useful for chaining.
setTabText(index, text)
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
DecoratedTabBar
— the DecoratedTabBar
itself, useful for chaining.
setTag(tag)
Sets the text tag of this DecoratedTabBar
.
Parameters
Name | Type | Description |
---|---|---|
tag | String | the 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
Name | Type | Description |
---|---|---|
title | String | the hover title. |
Return
DecoratedTabBar
— the DecoratedTabBar
itself, useful for chaining.
setVisible(visible)
Sets whether this DecoratedTabBar
is visible.
Parameters
Name | Type | Description |
---|---|---|
visible | Boolean | whether this DecoratedTabBar should be visible or not. |
Return
DecoratedTabBar
— the DecoratedTabBar
itself, useful for chaining.
setWidth(width)
Sets the width of this DecoratedTabBar
.
Parameters
Name | Type | Description |
---|---|---|
width | String | the new width in any CSS unit such as "10px" or "50%". |
Return
DecoratedTabBar
— the DecoratedTabBar
itself, useful for chaining.