Class TreeItem

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

An item that can be contained within a Tree.

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

Deprecated methods

Method	Return type	Brief description
`addItem(text)`	`TreeItem`	Adds a new child tree item containing the specified HTML.
`addItem(item)`	`TreeItem`	Adds a TreeItem as a child to this `TreeItem`.
`addItem(widget)`	`TreeItem`	Adds a new child tree item containing the specified widget.
`addStyleDependentName(styleName)`	`TreeItem`	Sets the dependent style name of this `TreeItem`.
`addStyleName(styleName)`	`TreeItem`	Adds a style name to this `TreeItem`.
`clear()`	`TreeItem`	Removes all children.
`getId()`	`String`	Returns the id that has been assigned to this object.
`getTag()`	`String`	Gets the text tag of this `TreeItem`.
`getType()`	`String`	Gets the type of this object.
`setHTML(html)`	`TreeItem`	Sets the HTML content of this `TreeItem`.
`setHeight(height)`	`TreeItem`	Sets the height of this `TreeItem`.
`setId(id)`	`TreeItem`	Sets the id of this `TreeItem`.
`setPixelSize(width, height)`	`TreeItem`	Sets the size of this `TreeItem` in pixels.
`setSelected(selected)`	`TreeItem`	Set whether this item is selected.
`setSize(width, height)`	`TreeItem`	Sets the size of this `TreeItem`.
`setState(open)`	`TreeItem`	Sets whether this `TreeItem` is open or closed.
`setState(open, fireEvents)`	`TreeItem`	Sets whether this `TreeItem` is open or closed and optionally fire events.
`setStyleAttribute(attribute, value)`	`TreeItem`	Sets one of this `TreeItem`'s style attributes to a new value.
`setStyleAttributes(attributes)`	`TreeItem`	Sets this `TreeItem`'s style attributes.
`setStyleName(styleName)`	`TreeItem`	Sets the style name of this `TreeItem`.
`setStylePrimaryName(styleName)`	`TreeItem`	Sets the primary style name of this `TreeItem`.
`setTag(tag)`	`TreeItem`	Sets the text tag of this `TreeItem`.
`setText(text)`	`TreeItem`	Set the display text of this `TreeItem`.
`setTitle(title)`	`TreeItem`	Sets the hover title of this `TreeItem`.
`setUserObject(a)`	`TreeItem`	A deprecated function that has no effect.
`setVisible(visible)`	`TreeItem`	Sets whether this `TreeItem` is visible.
`setWidget(widget)`	`TreeItem`	Sets the widget to be shown inside this `TreeItem`.
`setWidth(width)`	`TreeItem`	Sets the width of this `TreeItem`.

Deprecated methods

`addItem(text)`

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

Adds a new child tree item containing the specified HTML.

Parameters

Name	Type	Description
`text`	`String`	the new item's text, treated as HTML.

Return

TreeItem — the TreeItem itself, useful for chaining.

`addItem(item)`

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

Adds a TreeItem as a child to this TreeItem.

Parameters

Name	Type	Description
`item`	`TreeItem`	the child item.

Return

TreeItem — the TreeItem itself, useful for chaining.

`addItem(widget)`

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

Adds a new child tree item containing the specified widget.

Parameters

Name	Type	Description
`widget`	`Widget`	the widget to put inside the new item.

Return

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

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

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

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

TreeItem — the TreeItem itself, useful for chaining.

`clear()`

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

Removes all children.

Return

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

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

`setHTML(html)`

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

Sets the HTML content of this TreeItem.

Parameters

Name	Type	Description
`html`	`String`	the new HTML

Return

TreeItem — the TreeItem itself, useful for chaining.

`setHeight(height)`

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

Sets the height of this TreeItem.

Parameters

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

Return

TreeItem — the TreeItem itself, useful for chaining.

`setId(id)`

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

Sets the id of this TreeItem.

Parameters

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

Return

TreeItem — the TreeItem 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 TreeItem in pixels.

Parameters

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

Return

TreeItem — the TreeItem itself, useful for chaining.

`setSelected(selected)`

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

Set whether this item is selected.

Parameters

Name	Type	Description
`selected`	`Boolean`	whether this item is selected.

Return

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

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

TreeItem — the TreeItem itself, useful for chaining.

`setState(open)`

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

Sets whether this TreeItem is open or closed.

This does not fire events if the state changes.

Parameters

Name	Type	Description
`open`	`Boolean`	whether it's open or closed.

Return

TreeItem — the TreeItem itself, useful for chaining.

`setState(open, fireEvents)`

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

Sets whether this TreeItem is open or closed and optionally fire events.

This does not fire events if the state changes.

Parameters

Name	Type	Description
`open`	`Boolean`	whether it's open or closed.
`fireEvents`	`Boolean`	whether to fire events if the state changes.

Return

TreeItem — the TreeItem itself, useful for chaining.

`setStyleAttribute(attribute, value)`

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

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

TreeItem — the TreeItem itself, useful for chaining.

`setStyleAttributes(attributes)`

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

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

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

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

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

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

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

Parameters

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

Return

TreeItem — the TreeItem itself, useful for chaining.

`setText(text)`

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

Set the display text of this TreeItem.

Parameters

Name	Type	Description
`text`	`String`	the new text.

Return

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

Not all browsers will show this.

Parameters

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

Return

TreeItem — the TreeItem itself, useful for chaining.

`setUserObject(a)`

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

A deprecated function that has no effect.

Parameters

Name	Type	Description
`a`	`Object`

Return

TreeItem — the TreeItem itself, useful for chaining.

`setVisible(visible)`

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

Sets whether this TreeItem is visible.

Parameters

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

Return

TreeItem — the TreeItem itself, useful for chaining.

`setWidget(widget)`

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

Sets the widget to be shown inside this TreeItem.

Parameters

Name	Type	Description
`widget`	`Widget`	the widget to put inside this `TreeItem`.

Return

TreeItem — the TreeItem itself, useful for chaining.

`setWidth(width)`

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

Sets the width of this TreeItem.

Parameters

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

Return

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