Module is.codion.common.model
Package is.codion.common.model.component.tree

Interface TreeSelection.Pending<T>

Type Parameters:
T - the item type
Enclosing interface:
TreeSelection<T>
public static interface TreeSelection.Pending<T>
The pending selection, selecting nodes by path once they are visible, expanding their ancestors and loading as needed.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    set(NodePath<T> path)
    Selects the node identified by the given path once it is visible, replacing the selection, expanding its ancestors and loading as needed.

  • Method Details

    • set

      void set(NodePath<T> path)

      Selects the node identified by the given path once it is visible, replacing the selection, expanding its ancestors and loading as needed. The node itself is not expanded. Where TreeSelection.path() takes effect right away, on a node in the model, this takes effect once the nodes on the path have been loaded, before this method returns when loading synchronously.

      A node which exists but is not visible, being excluded or below a node collapsed since, is replaced by its nearest visible ancestor. In case the path turns out not to exist, or can not be loaded further, a load failing or a node being a leaf according to the leaves function, the deepest node on the path which does exist is selected, or its nearest visible ancestor. The selection is left as is in case no node on the path is in the model.

      A pending selection is cancelled by a selection change from outside, by the application or the user, and replaced by another one, while loading and refreshing do not cancel it. A selection change vetoed via MultiSelection.changing() ends it unselected.

      Parameters:
      path - the path of the node to select
      Throws:
      IllegalArgumentException - in case of the root path
      See Also: