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
Detailed documentation
add(widget)
Add a widget to the DecoratedTabPanel.
Parameters
| Name | Type | Description |
|---|---|---|
widget | Widget | the 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
| Name | Type | Description |
|---|---|---|
widget | Widget | the widget to add. |
text | String | the 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
| Name | Type | Description |
|---|---|---|
widget | Widget | the widget to add. |
text | String | the new header text. |
asHtml | Boolean | whether 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
| Name | Type | Description |
|---|---|---|
widget | Widget | the widget to add. |
tabWidget | Widget | the 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
| Name | Type | Description |
|---|---|---|
handler | Handler | the 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
| Name | Type | Description |
|---|---|---|
styleName | String | the 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
| Name | Type | Description |
|---|---|---|
styleName | String | the 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
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
DecoratedTabPanel — the DecoratedTabPanel itself, useful for chaining.
setAnimationEnabled(animationEnabled)
Sets whether changing tabs DecoratedTabPanel is animated.
Parameters
| Name | Type | Description |
|---|---|---|
animationEnabled | Boolean | whether to animate changing tabs. |
Return
DecoratedTabPanel — the DecoratedTabPanel itself, useful for chaining.
setHeight(height)
Sets the height of this DecoratedTabPanel.
Parameters
| Name | Type | Description |
|---|---|---|
height | String | the 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
| Name | Type | Description |
|---|---|---|
id | String | the 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
| Name | Type | Description |
|---|---|---|
width | Integer | the new width in pixels. |
height | Integer | the new height in pixels. |
Return
DecoratedTabPanel — the DecoratedTabPanel itself, useful for chaining.
setSize(width, height)
Sets the size of this DecoratedTabPanel.
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
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
| Name | Type | Description |
|---|---|---|
attribute | String | the CSS attribute, in camel-case ("fontSize", not "font-size"), as listed here |
value | String | the 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
| 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
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
| Name | Type | Description |
|---|---|---|
styleName | String | the 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
| Name | Type | Description |
|---|---|---|
styleName | String | the new style name. |
Return
DecoratedTabPanel — the DecoratedTabPanel itself, useful for chaining.
setTag(tag)
Sets the text tag of this DecoratedTabPanel.
Parameters
| Name | Type | Description |
|---|---|---|
tag | String | the 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
| Name | Type | Description |
|---|---|---|
title | String | the hover title. |
Return
DecoratedTabPanel — the DecoratedTabPanel itself, useful for chaining.
setVisible(visible)
Sets whether this DecoratedTabPanel is visible.
Parameters
| Name | Type | Description |
|---|---|---|
visible | Boolean | whether this DecoratedTabPanel should be visible or not. |
Return
DecoratedTabPanel — the DecoratedTabPanel itself, useful for chaining.
setWidth(width)
Sets the width of this DecoratedTabPanel.
Parameters
| Name | Type | Description |
|---|---|---|
width | String | the new width in any CSS unit such as "10px" or "50%". |
Return
DecoratedTabPanel — the DecoratedTabPanel itself, useful for chaining.