Version: 2022.1
LanguageEnglish
  • C#

BaseTreeViewController

class in UnityEngine.UIElements

/

Inherits from:UIElements.CollectionViewController

/

Implemented in:UnityEngine.UIElementsModule

Suggest a change

Success!

Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.

Close

Submission failed

For some reason your suggested change could not be submitted. Please <a>try again</a> in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.

Close

Cancel

Description

Base collection tree view controller. View controllers of this type are meant to take care of data virtualized by any BaseTreeView inheritor.

Properties

baseTreeView View for this controller, cast as a BaseTreeView.
itemsSource Items for this tree. Contains items that are expanded in the tree.

Public Methods

CollapseAll Collapses all items in the tree and refreshes the view.
CollapseItem Collapses the item with the specified id, hiding its children. Allows to collapse the whole hierarchy under that item.
CollapseItemByIndex Collapses the item with the specified index, hiding its children. Allows to collapse the whole hierarchy under that item.
ExpandAll Expands all items in the tree and refreshes the view.
ExpandItem Expands the item with the specified id, making its children visible. Allows to expand the whole hierarchy under that item.
ExpandItemByIndex Expands the item with the specified index, making his children visible. Allows to expand the whole hierarchy under that item.
GetAllItemIds Returns all item ids that can be found in the tree, optionally specifying root ids from where to start.
GetChildIndexForId Gets the child index under the parent of the item with the specified id.
GetChildrenIds Get all children of a specific id in the tree.
GetChildrenIdsByIndex Gets the children ids of the item with the specified index.
GetIdForIndex Returns the id for a specified index in the visible items source.
GetIndexForId Returns the index in the source of the item, by id.
GetParentId Returns the parent id of an item, by id.
GetRootItemIds Returns the root items of the tree, by ids.
GetTreeItemsCount Get the number of items in the whole tree.
HasChildren Returns whether or not the item with the specified id has one or more child.
HasChildrenByIndex Returns whether or not the item with the specified index has one or more child.
IsExpanded Returns whether or not the item with the specified id is expanded in the tree.
IsExpandedByIndex Returns whether or not the item with the specified index is expanded in the tree.
Move Moves an item by id, to a new parent and child index.
RebuildTree Rebuilds the tree item data and regenerates wrappers to fill the source.
TryRemoveItem Removes an item by id.

Inherited Members

Properties

itemsSource The items source stored in a non-generic list.
view The view for this controller.

Public Methods

Dispose Called when this controller is not longer needed to provide a way to release resources.
GetItemForIndex Returns the item for the specified index.
GetItemsCount Returns the expected item count in the source.
SetView Sets the view for this controller.

Protected Methods

BindItem Binds a row to an item index.
DestroyItem Destroys a VisualElement when the view is rebuilt or cleared.
MakeItem Creates a VisualElement to use in the virtualization of the collection view.
PrepareView Initialization step once the view is set.
RaiseItemIndexChanged Invokes the itemIndexChanged event.
RaiseItemsSourceChanged Invokes the itemsSourceChanged event.
SetItemsSourceWithoutNotify Set the itemsSource without raising the itemsSourceChanged event.
UnbindItem Unbinds a row to an item index.

Events

itemIndexChanged Raised when an item in the source changes index. The first argument is source index, second is destination index.
itemsSourceChanged Raised when the itemsSource changes.