Class StackPanel

Deprecated. The UI service was deprecated on December 11, 2014. To create user interfaces, use the HTML service instead.

A panel that stacks its children vertically, displaying only one at a time, with a header for each child which the user can click to display.

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

Deprecated methods

Method	Return type	Brief description
`add(widget)`	`StackPanel`	Add a widget to the `StackPanel`.
`add(widget, text)`	`StackPanel`	Adds a widget to the stack with the given header text.
`add(widget, text, asHtml)`	`StackPanel`	Adds a widget to the stack with the given header text.
`addStyleDependentName(styleName)`	`StackPanel`	Sets the dependent style name of this `StackPanel`.
`addStyleName(styleName)`	`StackPanel`	Adds a style name to this `StackPanel`.
`clear()`	`StackPanel`	Remove all widgets from the `StackPanel`.
`getId()`	`String`	Returns the id that has been assigned to this object.
`getTag()`	`String`	Gets the text tag of this `StackPanel`.
`getType()`	`String`	Gets the type of this object.
`remove(index)`	`StackPanel`	Remove the widget with the given index from the `StackPanel`.
`remove(widget)`	`StackPanel`	Remove the given widget from the `StackPanel`.
`setHeight(height)`	`StackPanel`	Sets the height of this `StackPanel`.
`setId(id)`	`StackPanel`	Sets the id of this `StackPanel`.
`setLayoutData(layout)`	`StackPanel`	Set the layout for this `StackPanel`.
`setPixelSize(width, height)`	`StackPanel`	Sets the size of this `StackPanel` in pixels.
`setSize(width, height)`	`StackPanel`	Sets the size of this `StackPanel`.
`setStackText(index, text)`	`StackPanel`	Sets the text associated with a child by its index.
`setStackText(index, text, asHtml)`	`StackPanel`	Sets the text associated with a child by its index.
`setStyleAttribute(attribute, value)`	`StackPanel`	Sets one of this `StackPanel`'s style attributes to a new value.
`setStyleAttributes(attributes)`	`StackPanel`	Sets this `StackPanel`'s style attributes.
`setStyleName(styleName)`	`StackPanel`	Sets the style name of this `StackPanel`.
`setStylePrimaryName(styleName)`	`StackPanel`	Sets the primary style name of this `StackPanel`.
`setTag(tag)`	`StackPanel`	Sets the text tag of this `StackPanel`.
`setTitle(title)`	`StackPanel`	Sets the hover title of this `StackPanel`.
`setVisible(visible)`	`StackPanel`	Sets whether this `StackPanel` is visible.
`setWidth(width)`	`StackPanel`	Sets the width of this `StackPanel`.

Deprecated methods

`add(widget)`

Deprecated. This function is deprecated and should not be used in new scripts.

Add a widget to the StackPanel.

Parameters

Name	Type	Description
`widget`	`Widget`	the widget to add.

Return

StackPanel — the StackPanel itself, useful for chaining.

`add(widget, text)`

Deprecated. This function is deprecated and should not be used in new scripts.

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

StackPanel — the StackPanel itself, useful for chaining.

`add(widget, text, asHtml)`

Deprecated. This function is deprecated and should not be used in new scripts.

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

StackPanel — the StackPanel itself, useful for chaining.

`addStyleDependentName(styleName)`

Deprecated. This function is deprecated and should not be used in new scripts.

Sets the dependent style name of this StackPanel.

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

StackPanel — the StackPanel itself, useful for chaining.

`addStyleName(styleName)`

Deprecated. This function is deprecated and should not be used in new scripts.

Adds a style name to this StackPanel.

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

StackPanel — the StackPanel itself, useful for chaining.

`clear()`

Deprecated. This function is deprecated and should not be used in new scripts.

Remove all widgets from the StackPanel.

Return

StackPanel — the StackPanel itself, useful for chaining.

`getId()`

Deprecated. This function is deprecated and should not be used in new scripts.

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()`

Deprecated. This function is deprecated and should not be used in new scripts.

Gets the text tag of this StackPanel.

Return

String — the text tag.

`getType()`

Deprecated. This function is deprecated and should not be used in new scripts.

Gets the type of this object.

Return

String — the object type

`remove(index)`

Deprecated. This function is deprecated and should not be used in new scripts.

Remove the widget with the given index from the StackPanel. Indexes begin from 0. This will fail if the index is greater than or equal to the number of elements in the StackPanel.

Parameters

Name	Type	Description
`index`	`Integer`	the index of the widget to remove.

Return

StackPanel — the StackPanel itself, useful for chaining.

`remove(widget)`

Deprecated. This function is deprecated and should not be used in new scripts.

Remove the given widget from the StackPanel. This will fail if the widget is not actually a child of the StackPanel.

Parameters

Name	Type	Description
`widget`	`Widget`	the widget to remove.

Return

StackPanel — the StackPanel itself, useful for chaining.

`setHeight(height)`

Deprecated. This function is deprecated and should not be used in new scripts.

Sets the height of this StackPanel.

Parameters

Name	Type	Description
`height`	`String`	the new height in any CSS unit such as "10px" or "50%".

Return

StackPanel — the StackPanel itself, useful for chaining.

`setId(id)`

Deprecated. This function is deprecated and should not be used in new scripts.

Sets the id of this StackPanel.

Parameters

Name	Type	Description
`id`	`String`	the new id, which can be used to retrieve the `StackPanel` from app.getElementById(id).

Return

StackPanel — the StackPanel itself, useful for chaining.

`setLayoutData(layout)`

Deprecated. This function is deprecated and should not be used in new scripts.

Set the layout for this StackPanel.

This is not currently functional.

Parameters

Name	Type	Description
`layout`	`Object`

Return

StackPanel — the StackPanel itself, useful for chaining.

`setPixelSize(width, height)`

Deprecated. This function is deprecated and should not be used in new scripts.

Sets the size of this StackPanel in pixels.

Parameters

Name	Type	Description
`width`	`Integer`	the new width in pixels.
`height`	`Integer`	the new height in pixels.

Return

StackPanel — the StackPanel itself, useful for chaining.

`setSize(width, height)`

Deprecated. This function is deprecated and should not be used in new scripts.

Sets the size of this StackPanel.

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

StackPanel — the StackPanel itself, useful for chaining.

`setStackText(index, text)`

Deprecated. This function is deprecated and should not be used in new scripts.

Sets the text associated with a child by its index.

Parameters

Name	Type	Description
`index`	`Integer`	the index of the stack element whose text we want to change.
`text`	`String`	the new text.

Return

StackPanel — the StackPanel itself, useful for chaining.

`setStackText(index, text, asHtml)`

Deprecated. This function is deprecated and should not be used in new scripts.

Sets the text associated with a child by its index.

Parameters

Name	Type	Description
`index`	`Integer`	the index of the stack element whose text we want to change.
`text`	`String`	the new text.
`asHtml`	`Boolean`	whether to treat the text as HTML.

Return

StackPanel — the StackPanel itself, useful for chaining.

`setStyleAttribute(attribute, value)`

Deprecated. This function is deprecated and should not be used in new scripts.

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

StackPanel — the StackPanel itself, useful for chaining.

`setStyleAttributes(attributes)`

Deprecated. This function is deprecated and should not be used in new scripts.

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

StackPanel — the StackPanel itself, useful for chaining.

`setStyleName(styleName)`

Deprecated. This function is deprecated and should not be used in new scripts.

Sets the style name of this StackPanel.

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

StackPanel — the StackPanel itself, useful for chaining.

`setStylePrimaryName(styleName)`

Deprecated. This function is deprecated and should not be used in new scripts.

Sets the primary style name of this StackPanel.

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

StackPanel — the StackPanel itself, useful for chaining.

`setTag(tag)`

Deprecated. This function is deprecated and should not be used in new scripts.

Sets the text tag of this StackPanel.

Parameters

Name	Type	Description
`tag`	`String`	the new text tag, which can be anything you wish to store with the widget.

Return

StackPanel — the StackPanel itself, useful for chaining.

`setTitle(title)`

Deprecated. This function is deprecated and should not be used in new scripts.

Sets the hover title of this StackPanel.

Not all browsers will show this.

Parameters

Name	Type	Description
`title`	`String`	the hover title.

Return

StackPanel — the StackPanel itself, useful for chaining.

`setVisible(visible)`

Deprecated. This function is deprecated and should not be used in new scripts.

Sets whether this StackPanel is visible.

Parameters

Name	Type	Description
`visible`	`Boolean`	whether this `StackPanel` should be visible or not.

Return

StackPanel — the StackPanel itself, useful for chaining.

`setWidth(width)`

Deprecated. This function is deprecated and should not be used in new scripts.

Sets the width of this StackPanel.

Parameters

Name	Type	Description
`width`	`String`	the new width in any CSS unit such as "10px" or "50%".

Return

StackPanel — the StackPanel itself, useful for chaining.

Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 3.0 License, and code samples are licensed under the Apache 2.0 License. For details, see our Site Policies.

Last updated February 26, 2015.