TreeViewState<T> class

The state management class for the TreeView widget.

This class handles the internal logic and state of the tree view, including:

  • Node selection and deselection
  • Expansion and collapse of nodes
  • Filtering and sorting of nodes
  • Handling of "Select All" functionality
  • Managing the overall tree structure

It also provides methods for external manipulation of the tree, such as:

This class is not intended to be used directly by users of the TreeView widget, but rather serves as the internal state management mechanism.

Inheritance

Constructors

TreeViewState.new()

Properties

context → BuildContext
The location in the tree where this widget builds.
no setterinherited
hashCode → int
The hash code for this object.
no setterinherited
mounted → bool
Whether this State object is currently in a tree.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
widget → TreeView<T>
The current configuration.
no setterinherited

Methods

activate() → void
Called when this object is reinserted into the tree after having been removed via deactivate.
inherited
build(BuildContext context) → Widget
Describes the part of the user interface represented by this widget.
override
collapseAll() → void
Collapses all nodes in the tree.
deactivate() → void
Called when this object is removed from the tree.
inherited
debugFillProperties(DiagnosticPropertiesBuilder properties) → void
Add additional properties associated with the node.
inherited
didChangeDependencies() → void
Called when a dependency of this State object changes.
inherited
didUpdateWidget(covariant TreeView<T> oldWidget) → void
Called whenever the widget configuration changes.
inherited
dispose() → void
Called when this object is removed from the tree permanently.
override
expandAll() → void
Expands all nodes in the tree.
filter(bool filterFunction(TreeNode<T>)) → void
Filters the tree nodes based on the provided filter function.
getChildSelectedNodes(TreeNode<T> node) → List<TreeNode<T>>
Returns a list of all selected child nodes of the given node.
getChildSelectedValues(TreeNode<T> node) → List<T?>
Returns a list of all selected child nodes values of the given node.
getSelectedNodes() → List<TreeNode<T>>
Returns a list of all selected nodes in the tree.
getSelectedValues() → List<T?>
Returns a list of all selected values in the tree.
initState() → void
Called when this object is inserted into the tree.
override
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
reassemble() → void
Called whenever the application is reassembled during debugging, for example during hot reload.
inherited
setSelectAll(bool isSelected) → void
Sets the selection state of all nodes.
setSelectedValues(List<T> selectedValues) → void
Sets the selected values in the tree.
setState(VoidCallback fn) → void
Notify the framework that the internal state of this object has changed.
inherited
sort(int compareFunction(TreeNode<T>, TreeNode<T>)?) → void
Sorts the tree nodes based on the provided compare function.
toDiagnosticsNode({String? name, DiagnosticsTreeStyle? style}) → DiagnosticsNode
Returns a debug representation of the object that is used by debugging tools and by DiagnosticsNode.toStringDeep.
inherited
toString({DiagnosticLevel minLevel = DiagnosticLevel.info}) → String
A string representation of this object.
inherited
toStringShort() → String
A brief description of this object, usually just the runtimeType and the hashCode.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited