Class Tree | Apps Script | Google Developers

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

A standard hierarchical tree widget. The tree contains a hierarchy of TreeItems that the user can open, close, and select.

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

Deprecated methods

Method	Return type	Brief description
`add(widget)`	`Tree`	Add a widget to the `Tree`.
`addBlurHandler(handler)`	`Tree`	Add a handler for blur events (losing keyboard focus).
`addCloseHandler(handler)`	`Tree`	Add a handler for close events.
`addFocusHandler(handler)`	`Tree`	Add a handler for focus events (gaining keyboard focus).
`addItem(text)`	`Tree`	Adds a new child tree item containing the specified HTML.
`addItem(item)`	`Tree`	Adds a TreeItem as a child to this `Tree`.
`addItem(widget)`	`Tree`	Adds a new child tree item containing the specified widget.
`addKeyDownHandler(handler)`	`Tree`	Add a handler for key down events.
`addKeyPressHandler(handler)`	`Tree`	Add a handler for key press events.
`addKeyUpHandler(handler)`	`Tree`	Add a handler for key up events.
`addMouseDownHandler(handler)`	`Tree`	Add a handler for mouse down events.
`addMouseMoveHandler(handler)`	`Tree`	Add a handler for mouse move events.
`addMouseOutHandler(handler)`	`Tree`	Add a handler for mouse out events.
`addMouseOverHandler(handler)`	`Tree`	Add a handler for mouse move events.
`addMouseUpHandler(handler)`	`Tree`	Add a handler for mouse up events.
`addMouseWheelHandler(handler)`	`Tree`	Add a handler for mouse wheel events.
`addOpenHandler(handler)`	`Tree`	Add a handler for open events.
`addSelectionHandler(handler)`	`Tree`	Add a handler for selection events.
`addStyleDependentName(styleName)`	`Tree`	Sets the dependent style name of this `Tree`.
`addStyleName(styleName)`	`Tree`	Adds a style name to this `Tree`.
`clear()`	`Tree`	Removes all children.
`getId()`	`String`	Returns the id that has been assigned to this object.
`getTag()`	`String`	Gets the text tag of this `Tree`.
`getType()`	`String`	Gets the type of this object.
`setAccessKey(accessKey)`	`Tree`	Sets the widget's 'access key'.
`setAnimationEnabled(animationEnabled)`	`Tree`	Sets whether opening and closing the `Tree` is animated.
`setFocus(focus)`	`Tree`	Explicitly focus/unfocus this `Tree`.
`setHeight(height)`	`Tree`	Sets the height of this `Tree`.
`setId(id)`	`Tree`	Sets the id of this `Tree`.
`setLayoutData(layout)`	`Tree`	Set the layout for this `Tree`.
`setPixelSize(width, height)`	`Tree`	Sets the size of this `Tree` in pixels.
`setSelectedItem(item)`	`Tree`	Selects the given item.
`setSelectedItem(item, fireEvents)`	`Tree`	Selects the given item and optionally fire events.
`setSize(width, height)`	`Tree`	Sets the size of this `Tree`.
`setStyleAttribute(attribute, value)`	`Tree`	Sets one of this `Tree`'s style attributes to a new value.
`setStyleAttributes(attributes)`	`Tree`	Sets this `Tree`'s style attributes.
`setStyleName(styleName)`	`Tree`	Sets the style name of this `Tree`.
`setStylePrimaryName(styleName)`	`Tree`	Sets the primary style name of this `Tree`.
`setTabIndex(index)`	`Tree`	Sets the `Tree`'s position in the tab index.
`setTag(tag)`	`Tree`	Sets the text tag of this `Tree`.
`setTitle(title)`	`Tree`	Sets the hover title of this `Tree`.
`setVisible(visible)`	`Tree`	Sets whether this `Tree` is visible.
`setWidth(width)`	`Tree`	Sets the width of this `Tree`.

Deprecated methods

`add(widget)`

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

Add a widget to the Tree.

Parameters

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

Return

Tree — the Tree itself, useful for chaining.

`addBlurHandler(handler)`

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

Add a handler for blur events (losing keyboard focus).

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 button = app.createButton("a button");
  var handler = app.createServerHandler("handlerFunction");
  button.addBlurHandler(handler);
  app.add(button);
  return app;
}

function handlerFunction(eventInfo) {
  var parameter = eventInfo.parameter;
  // the type of event, in this case "blur".
  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

Tree — the Tree itself, useful for chaining.

`addCloseHandler(handler)`

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

Add a handler for close events.

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.addCloseHandler(handler)
  app.add(tree);
  return app;
}

function handlerFunction(eventInfo) {
  var parameter = eventInfo.parameter;
  // the type of event, in this case "close".
  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

Tree — the Tree itself, useful for chaining.

`addFocusHandler(handler)`

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

Add a handler for focus events (gaining keyboard focus).

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 button = app.createButton("a button");
  var handler = app.createServerHandler("handlerFunction");
  button.addFocusHandler(handler);
  app.add(button);
  return app;
}

function handlerFunction(eventInfo) {
  var parameter = eventInfo.parameter;
  // the type of event, in this case "focus".
  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

Tree — the Tree itself, useful for chaining.

`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

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

Parameters

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

Return

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

Tree — the Tree itself, useful for chaining.

`addKeyDownHandler(handler)`

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

Add a handler for key down events.

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 button = app.createButton("a button");
  var handler = app.createServerHandler("handlerFunction");
  button.addKeyDownHandler(handler);
  app.add(button);
  return app;
}

function handlerFunction(eventInfo) {
  var parameter = eventInfo.parameter;
  // the type of event, in this case "keydown".
  var eventType = parameter.eventType;
  // the id of the widget that fired this event.
  var source = parameter.source;
  // what key was pressed. See below for a link explaining what these values mean.
  var charCode = parameter.charCode;
  var keyCode = parameter.keyCode;
  // whether the various modifier keys were also pressed (true or false)
  var shift = parameter.shift;
  var alt = parameter.alt;
  var ctrl = parameter.ctrl;
  var meta = parameter.meta;
}

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.

For an explanation of charCode and keyCode, including what to expect on different browsers, look here.

Parameters

Name	Type	Description
`handler`	`Handler`	the handler to execute when the event occurs. This can be a `ClientHandler` or a `ServerHandler`.

Return

Tree — the Tree itself, useful for chaining.

`addKeyPressHandler(handler)`

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

Add a handler for key press events.

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 button = app.createButton("a button");
  var handler = app.createServerHandler("handlerFunction");
  button.addKeyPressHandler(handler);
  app.add(button);
  return app;
}

function handlerFunction(eventInfo) {
  var parameter = eventInfo.parameter;
  // the type of event, in this case "keypress".
  var eventType = parameter.eventType;
  // the id of the widget that fired this event.
  var source = parameter.source;
  // what key was pressed. See below for a link explaining what these values mean.
  var charCode = parameter.charCode;
  var keyCode = parameter.keyCode;
  // whether the various modifier keys were also pressed (true or false)
  var shift = parameter.shift;
  var alt = parameter.alt;
  var ctrl = parameter.ctrl;
  var meta = parameter.meta;
}

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.

For an explanation of charCode and keyCode, including what to expect on different browsers, look here.

Parameters

Name	Type	Description
`handler`	`Handler`	the handler to execute when the event occurs. This can be a `ClientHandler` or a `ServerHandler`.

Return

Tree — the Tree itself, useful for chaining.

`addKeyUpHandler(handler)`

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

Add a handler for key up events.

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 button = app.createButton("a button");
  var handler = app.createServerHandler("handlerFunction");
  button.addKeyUpHandler(handler);
  app.add(button);
  return app;
}

function handlerFunction(eventInfo) {
  var parameter = eventInfo.parameter;
  // the type of event, in this case "keyup".
  var eventType = parameter.eventType;
  // the id of the widget that fired this event.
  var source = parameter.source;
  // what key was pressed. See below for a link explaining what these values mean.
  var charCode = parameter.charCode;
  var keyCode = parameter.keyCode;
  // whether the various modifier keys were also pressed (true or false)
  var shift = parameter.shift;
  var alt = parameter.alt;
  var ctrl = parameter.ctrl;
  var meta = parameter.meta;
}

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.

For an explanation of charCode and keyCode, including what to expect on different browsers, look here.

Parameters

Name	Type	Description
`handler`	`Handler`	the handler to execute when the event occurs. This can be a `ClientHandler` or a `ServerHandler`.

Return

Tree — the Tree itself, useful for chaining.

`addMouseDownHandler(handler)`

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

Add a handler for mouse down events.

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 button = app.createButton("a button");
  var handler = app.createServerHandler("handlerFunction");
  button.addMouseDownHandler(handler);
  app.add(button);
  return app;
}

function handlerFunction(eventInfo) {
  var parameter = eventInfo.parameter;
  // the type of event, in this case "mousedown".
  var eventType = parameter.eventType;
  // the id of the widget that fired this event.
  var source = parameter.source;
  // mouse x and y position relative to the widget that fired the event.
  var x = parameter.x;
  var y = parameter.y;
  // mouse x and y position within the browser window's client area.
  var clientX = parameter.clientX;
  var clientY = parameter.clientY;
  // mouse x and y position within the user's display.
  var screenX = parameter.screenX;
  var screenY = parameter.screenY;
  // the mouse button used. Left is 1, right is 2, and middle is 4.
  var button = parameter.button;
  // whether the various modifier keys were also pressed (true or false)
  var shift = parameter.shift;
  var alt = parameter.alt;
  var ctrl = parameter.ctrl;
  var meta = parameter.meta;
}

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

Tree — the Tree itself, useful for chaining.

`addMouseMoveHandler(handler)`

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

Add a handler for mouse move events.

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 button = app.createButton("a button");
  var handler = app.createServerHandler("handlerFunction");
  button.addMouseMoveHandler(handler);
  app.add(button);
  return app;
}

function handlerFunction(eventInfo) {
  var parameter = eventInfo.parameter;
  // the type of event, in this case "mousemove".
  var eventType = parameter.eventType;
  // the id of the widget that fired this event.
  var source = parameter.source;
  // mouse x and y position relative to the widget that fired the event.
  var x = parameter.x;
  var y = parameter.y;
  // mouse x and y position within the browser window's client area.
  var clientX = parameter.clientX;
  var clientY = parameter.clientY;
  // mouse x and y position within the user's display.
  var screenX = parameter.screenX;
  var screenY = parameter.screenY;
  // the mouse button used. Left is 1, right is 2, and middle is 4.
  var button = parameter.button;
  // whether the various modifier keys were also pressed (true or false)
  var shift = parameter.shift;
  var alt = parameter.alt;
  var ctrl = parameter.ctrl;
  var meta = parameter.meta;
}

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

Tree — the Tree itself, useful for chaining.

`addMouseOutHandler(handler)`

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

Add a handler for mouse out events.

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 button = app.createButton("a button");
  var handler = app.createServerHandler("handlerFunction");
  button.addMouseOutHandler(handler);
  app.add(button);
  return app;
}

function handlerFunction(eventInfo) {
  var parameter = eventInfo.parameter;
  // the type of event, in this case "mouseout".
  var eventType = parameter.eventType;
  // the id of the widget that fired this event.
  var source = parameter.source;
  // mouse x and y position relative to the widget that fired the event.
  var x = parameter.x;
  var y = parameter.y;
  // mouse x and y position within the browser window's client area.
  var clientX = parameter.clientX;
  var clientY = parameter.clientY;
  // mouse x and y position within the user's display.
  var screenX = parameter.screenX;
  var screenY = parameter.screenY;
  // the mouse button used. Left is 1, right is 2, and middle is 4.
  var button = parameter.button;
  // whether the various modifier keys were also pressed (true or false)
  var shift = parameter.shift;
  var alt = parameter.alt;
  var ctrl = parameter.ctrl;
  var meta = parameter.meta;
}

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

Tree — the Tree itself, useful for chaining.

`addMouseOverHandler(handler)`

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

Add a handler for mouse move events.

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 button = app.createButton("a button");
  var handler = app.createServerHandler("handlerFunction");
  button.addMouseOverHandler(handler);
  app.add(button);
  return app;
}

function handlerFunction(eventInfo) {
  var parameter = eventInfo.parameter;
  // the type of event, in this case "mousover".
  var eventType = parameter.eventType;
  // the id of the widget that fired this event.
  var source = parameter.source;
  // mouse x and y position relative to the widget that fired the event.
  var x = parameter.x;
  var y = parameter.y;
  // mouse x and y position within the browser window's client area.
  var clientX = parameter.clientX;
  var clientY = parameter.clientY;
  // mouse x and y position within the user's display.
  var screenX = parameter.screenX;
  var screenY = parameter.screenY;
  // the mouse button used. Left is 1, right is 2, and middle is 4.
  var button = parameter.button;
  // whether the various modifier keys were also pressed (true or false)
  var shift = parameter.shift;
  var alt = parameter.alt;
  var ctrl = parameter.ctrl;
  var meta = parameter.meta;
}

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

Tree — the Tree itself, useful for chaining.

`addMouseUpHandler(handler)`

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

Add a handler for mouse up events.

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 button = app.createButton("a button");
  var handler = app.createServerHandler("handlerFunction");
  button.addMouseUpHandler(handler);
  app.add(button);
  return app;
}

function handlerFunction(eventInfo) {
  var parameter = eventInfo.parameter;
  // the type of event, in this case "mouseup".
  var eventType = parameter.eventType;
  // the id of the widget that fired this event.
  var source = parameter.source;
  // mouse x and y position relative to the widget that fired the event.
  var x = parameter.x;
  var y = parameter.y;
  // mouse x and y position within the browser window's client area.
  var clientX = parameter.clientX;
  var clientY = parameter.clientY;
  // mouse x and y position within the user's display.
  var screenX = parameter.screenX;
  var screenY = parameter.screenY;
  // the mouse button used. Left is 1, right is 2, and middle is 4.
  var button = parameter.button;
  // whether the various modifier keys were also pressed (true or false)
  var shift = parameter.shift;
  var alt = parameter.alt;
  var ctrl = parameter.ctrl;
  var meta = parameter.meta;
}

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

Tree — the Tree itself, useful for chaining.

`addMouseWheelHandler(handler)`

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

Add a handler for mouse wheel events.

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 button = app.createButton("a button");
  var handler = app.createServerHandler("handlerFunction");
  button.addMouseWheelHandler(handler);
  app.add(button);
  return app;
}

function handlerFunction(eventInfo) {
  var parameter = eventInfo.parameter;
  // the type of event, in this case "mousewheel".
  var eventType = parameter.eventType;
  // the id of the widget that fired this event.
  var source = parameter.source;
  // mouse x and y position relative to the widget that fired the event.
  var x = parameter.x;
  var y = parameter.y;
  // mouse x and y position within the browser window's client area.
  var clientX = parameter.clientX;
  var clientY = parameter.clientY;
  // mouse x and y position within the user's display.
  var screenX = parameter.screenX;
  var screenY = parameter.screenY;
  // the mouse button used. Left is 1, right is 2, and middle is 4.
  var button = parameter.button;
  // whether the various modifier keys were also pressed (true or false)
  var shift = parameter.shift;
  var alt = parameter.alt;
  var ctrl = parameter.ctrl;
  var meta = parameter.meta;
}

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

Tree — the Tree itself, useful for chaining.

`addOpenHandler(handler)`

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

Add a handler for open events.

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.addOpenHandler(handler)
  app.add(tree);
  return app;
}

function handlerFunction(eventInfo) {
  var parameter = eventInfo.parameter;
  // the type of event, in this case "close".
  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

Tree — the Tree itself, useful for chaining.

`addSelectionHandler(handler)`

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

Add a handler for selection events.

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

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

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

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

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

Tree — the Tree itself, useful for chaining.

`clear()`

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

Removes all children.

Return

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

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

`setAccessKey(accessKey)`

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

Sets the widget's 'access key'. This key is used (in conjunction with a browser-specific modifier key) to automatically focus the widget.

Parameters

Name	Type	Description
`accessKey`	`Char`	the character to use for focus

Return

Tree — the Tree itself, useful for chaining.

`setAnimationEnabled(animationEnabled)`

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

Sets whether opening and closing the Tree is animated.

Parameters

Name	Type	Description
`animationEnabled`	`Boolean`	whether to animate opening and closing.

Return

Tree — the Tree itself, useful for chaining.

`setFocus(focus)`

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

Explicitly focus/unfocus this Tree.

Only one widget can have focus at a time, and the widget that does will receive all keyboard events.

Parameters

Name	Type	Description
`focus`	`Boolean`	whether the `Tree` should have the current focus.

Return

Tree — the Tree itself, useful for chaining.

`setHeight(height)`

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

Sets the height of this Tree.

Parameters

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

Return

Tree — the Tree itself, useful for chaining.

`setId(id)`

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

Sets the id of this Tree.

Parameters

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

Return

Tree — the Tree itself, useful for chaining.

`setLayoutData(layout)`

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

Set the layout for this Tree.

This is not currently functional.

Parameters

Name	Type	Description
`layout`	`Object`

Return

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

Parameters

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

Return

Tree — the Tree itself, useful for chaining.

`setSelectedItem(item)`

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

Selects the given item.

This does not fire any events.

Parameters

Name	Type	Description
`item`	`TreeItem`	the item to select.

Return

Tree — the Tree itself, useful for chaining.

`setSelectedItem(item, fireEvents)`

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

Selects the given item and optionally fire events.

Parameters

Name	Type	Description
`item`	`TreeItem`	the item to select.
`fireEvents`	`Boolean`	whether to fire events.

Return

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

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

Tree — the Tree itself, useful for chaining.

`setStyleAttribute(attribute, value)`

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

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

Tree — the Tree itself, useful for chaining.

`setStyleAttributes(attributes)`

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

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

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

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

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

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

Tree — the Tree itself, useful for chaining.

`setTabIndex(index)`

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

Sets the Tree's position in the tab index.

If more than one widget has the same tab index, each such widget will receive focus in an arbitrary order. Setting the tab index to -1 will cause this widget to be removed from the tab order.

Parameters

Name	Type	Description
`index`	`Integer`	the new tab index.

Return

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

Parameters

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

Return

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

Not all browsers will show this.

Parameters

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

Return

Tree — the Tree itself, useful for chaining.

`setVisible(visible)`

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

Sets whether this Tree is visible.

Parameters

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

Return

Tree — the Tree itself, useful for chaining.

`setWidth(width)`

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

Sets the width of this Tree.

Parameters

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

Return

Tree — the Tree itself, useful for chaining.