Uses of Interface
is.codion.common.model.component.tree.NodePath

Packages that use NodePath

Package	Description
is.codion.common.model.component.tree	A UI-agnostic tree model, with lazy loading, expansion, selection, filtering and sorting.
is.codion.framework.model	Package configuration values: EntityApplicationModel.USER_PREFERENCES EntityApplicationModel.PREFERENCES_KEY EntityEditor.PUBLISH_PERSISTENCE_EVENTS EntityEditor.PERSIST_FOREIGN_KEYS EntityQueryModel.LIMIT EntityTableModel.ON_INSERT EntityTableModel.ORDER_QUERY ForeignKeyModelLink.SET_CONDITION_ON_INSERT ForeignKeyModelLink.SET_VALUE_ON_INSERT ForeignKeyModelLink.REFRESH_ON_SELECTION ForeignKeyModelLink.CLEAR_CONDITION_ON_EMPTY_SELECTION ForeignKeyModelLink.CLEAR_VALUE_ON_EMPTY_SELECTION EntitySearchModel.DEFAULT_LIMIT EntitySearchModel.PERSISTENCE_AWARE EntitySearchModel.WILDCARD_PREFIX EntitySearchModel.WILDCARD_POSTFIX EntitySearchModel.SPACE_AS_WILDCARD EntitySearchModel.CASE_SENSITIVE EntityConditions.NEGATION_INCLUDES_NULL
is.codion.swing.common.model.component.tree	A Swing tree model based on FilterTreeModel.
is.codion.swing.common.ui.component.tree	Trees.

Uses of NodePath in is.codion.common.model.component.tree

Methods in is.codion.common.model.component.tree that return NodePath

Modifier and Type	Method	Description
NodePath<T>	NodePath.child(T item)
static <T> NodePath<T>	NodePath.nodePath()
static <T> NodePath<T>	NodePath.nodePath(List<T> items)
NodePath<T>	NodePath.parent()

Methods in is.codion.common.model.component.tree that return types with arguments of type NodePath

Modifier and Type	Method	Description
List<NodePath<T>>	FilterTreeModel.Nodes.children(NodePath<T> parent)
Observer<NodePath<T>>	FilterTreeModel.Expansion.collapsed()
Observer<NodePath<T>>	FilterTreeModel.Expansion.expanded()
Collection<NodePath<T>>	FilterTreeModel.Expansion.get()
List<NodePath<T>>	FilterTreeModel.VisibleNodes.get()
Value<NodePath<T>>	TreeSelection.path()	The path of the selected node, as TreeSelection.item() is its item.
List<NodePath<T>>	FilterTreeModel.Nodes.paths(T item)	Returns the paths of the nodes holding the given item, included or excluded, depth first, since the same item may appear in several places.
MultiSelection.Items<NodePath<T>>	TreeSelection.paths()	The paths of the selected nodes, in row order, as TreeSelection.items() are their items.
FilterModel.IncludePredicate<NodePath<T>>	FilterTreeModel.Nodes.predicate()	Controls which nodes are included.

Methods in is.codion.common.model.component.tree with parameters of type NodePath

Modifier and Type	Method	Description
boolean	FilterTreeModel.Loader.active(NodePath<T> path)
void	FilterTreeModel.Nodes.add(NodePath<T> parent, Collection<T> items)	Adds the given items as children of the given loaded parent, appended or at their sorted position when sorting.
void	FilterTreeModel.NodesListener.changed(NodePath<T> parent, List<Integer> indexes)	Called when children have changed, their item instances replaced, or their leaf status changed
List<NodePath<T>>	FilterTreeModel.Nodes.children(NodePath<T> parent)
void	FilterTreeModel.Expansion.collapse(NodePath<T> path)	Collapses the given path, the expansion of its descendants remembered.
boolean	FilterTreeModel.Nodes.contains(NodePath<T> path)
boolean	NodePath.contains(NodePath<T> path)
void	FilterTreeModel.Expansion.expand(NodePath<T> path)	Expands the given path, along with its ancestors, loading as needed.
boolean	FilterTreeModel.Expansion.expanded(NodePath<T> path)
boolean	FilterTreeModel.Nodes.included(NodePath<T> path)
void	FilterTreeModel.NodesListener.inserted(NodePath<T> parent, List<Integer> indexes)	Called when children have been inserted
boolean	FilterTreeModel.Nodes.leaf(NodePath<T> path)	Returns true if the given node is a leaf: a node not yet loaded which the leaves function reported as a leaf when last called for it, or a loaded node without any included children.
boolean	FilterTreeModel.Nodes.loaded(NodePath<T> path)
void	FilterTreeModel.Nodes.refresh(NodePath<T> path)	Reloads the children of the node identified by the given path, and below them every loaded node still present, so what was loaded stays loaded, calling the leaves function for the children not yet loaded, see FilterTreeModel.Builder.leaves(Function).
void	FilterTreeModel.NodesListener.removed(NodePath<T> parent, List<Integer> indexes, List<NodePath<T>> children)	Called when children have been removed
void	FilterTreeModel.Nodes.replace(NodePath<T> path, T item)	Replaces the item of the node identified by the given path, the leaves function called for the replacement off the UI thread when loading asynchronously, the node keeping its leaf status until it reports, otherwise on the calling thread.
void	TreeSelection.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.
void	FilterTreeModel.NodesListener.structureChanged(NodePath<T> path)	Called when the structure below the given node may have changed arbitrarily

Method parameters in is.codion.common.model.component.tree with type arguments of type NodePath

Modifier and Type	Method	Description
FilterTreeModel.Builder<T,?>	FilterTreeModel.Builder.ChildrenStep.children(Function<NodePath<T>,Collection<T>> children)	The children function is never called for the root, and on a background thread when loading asynchronously.
final B	AbstractFilterTreeModelBuilder.comparators(Function<NodePath<T>,@Nullable Comparator<T>> comparators)
B	FilterTreeModel.Builder.comparators(Function<NodePath<T>,@Nullable Comparator<T>> comparators)	Specifies the comparator to use when sorting the children of each parent, given the path of the parent, the root path for the top level, a null comparator leaving the children in the order the children function returned them in.
final B	AbstractFilterTreeModelBuilder.included(Predicate<NodePath<T>> included)
B	FilterTreeModel.Builder.included(Predicate<NodePath<T>> included)
final B	AbstractFilterTreeModelBuilder.leaf(Predicate<NodePath<T>> leaf)
B	FilterTreeModel.Builder.leaf(Predicate<NodePath<T>> leaf)	The leaves function, node by node, for when a node can tell whether it is a leaf on its own, from its item for example, see FilterTreeModel.Builder.leaves(Function).
final B	AbstractFilterTreeModelBuilder.leaves(Function<List<NodePath<T>>,Collection<NodePath<T>>> leaves)
final B	AbstractFilterTreeModelBuilder.leaves(Function<List<NodePath<T>>,Collection<NodePath<T>>> leaves)
B	FilterTreeModel.Builder.leaves(Function<List<NodePath<T>>,Collection<NodePath<T>>> leaves)	The leaves function decides which nodes not yet loaded are leaves, a loaded node being a leaf when it has no included children.
B	FilterTreeModel.Builder.leaves(Function<List<NodePath<T>>,Collection<NodePath<T>>> leaves)	The leaves function decides which nodes not yet loaded are leaves, a loaded node being a leaf when it has no included children.
final B	AbstractFilterTreeModelBuilder.onSelectedPath(Consumer<NodePath<T>> path)
B	FilterTreeModel.Builder.onSelectedPath(Consumer<NodePath<T>> path)
final B	AbstractFilterTreeModelBuilder.onSelectedPaths(Consumer<List<NodePath<T>>> paths)
B	FilterTreeModel.Builder.onSelectedPaths(Consumer<List<NodePath<T>>> paths)
final B	AbstractFilterTreeModelBuilder.path(Function<T,@Nullable NodePath<T>> path)
B	FilterTreeModel.Builder.path(Function<T,@Nullable NodePath<T>> path)	The path function, the inverse of the children function, providing the path of the node holding an item, so that an item not yet in the model, its parent not loaded, can be selected via TreeSelection.item() or TreeSelection.items(), which expand its ancestors, loading them, as for an item below a collapsed ancestor.
void	FilterTreeModel.Nodes.remove(Collection<NodePath<T>> paths)	Removes the nodes identified by the given paths, along with their subtrees and expansion.
void	FilterTreeModel.Expansion.set(Collection<NodePath<T>> paths)	Replaces the expanded paths, loading as needed, for restoring the expansion.
TreeSelection<T>	AbstractFilterTreeModelBuilder.SelectionContext.treeSelection(MultiSelection<NodePath<T>> selection)	Returns a TreeSelection based on the given selection of paths, adding the tree behaviour: the items of the selected nodes, expanding the ancestors of the hidden nodes selected, and TreeSelection.set(NodePath).

Constructor parameters in is.codion.common.model.component.tree with type arguments of type NodePath

Modifier	Constructor	Description
protected	AbstractFilterTreeModelBuilder(Supplier<Collection<T>> roots, Function<NodePath<T>,Collection<T>> children)

Uses of NodePath in is.codion.framework.model

Method parameters in is.codion.framework.model with type arguments of type NodePath

Modifier and Type	Method	Description
M	AbstractEntityTableTreeModel.TreeModelBuilder.build(Supplier<Collection<Entity>> roots, Function<NodePath<Entity>,Collection<Entity>> children, Consumer<FilterTreeModel.Builder<Entity,?>> options)	Builds the tree model, given the roots supplier and children function, the tree model builder being configured via the given options before it builds the model.
M	AbstractEntityTreeModel.TreeModelBuilder.build(Supplier<Collection<Entity>> roots, Function<NodePath<Entity>,Collection<Entity>> children, Consumer<FilterTreeModel.Builder<Entity,?>> options)	Builds the tree model, given the roots supplier and children function, the tree model builder being configured via the given options before it builds the model.
final B	AbstractEntityTreeModelBuilder.comparators(Function<NodePath<Entity>,@Nullable Comparator<Entity>> comparators)
B	EntityTreeModel.Builder.comparators(Function<NodePath<Entity>,@Nullable Comparator<Entity>> comparators)	Replaces the ordering of siblings entirely, the roots, the foreign key comparators and order bys, and the entity type comparators.
final B	AbstractEntityTreeModelBuilder.included(Predicate<NodePath<Entity>> included)
final B	AbstractEntityTreeModelBuilder.leaf(Predicate<NodePath<Entity>> leaf)
B	EntityTreeModel.Builder.leaf(Predicate<NodePath<Entity>> leaf)	Replaces the default leaf detection, see EntityTreeModel.Builder.leaves(Function), with a function deciding node by node, based on a domain attribute for example.
final B	AbstractEntityTreeModelBuilder.leaves(Function<List<NodePath<Entity>>,Collection<NodePath<Entity>>> leaves)
final B	AbstractEntityTreeModelBuilder.leaves(Function<List<NodePath<Entity>>,Collection<NodePath<Entity>>> leaves)
B	EntityTreeModel.Builder.leaves(Function<List<NodePath<Entity>>,Collection<NodePath<Entity>>> leaves)	Replaces the default leaf detection, which queries for the siblings referenced via the configured foreign keys, a node of an entity type no configured foreign key references always being a leaf.
B	EntityTreeModel.Builder.leaves(Function<List<NodePath<Entity>>,Collection<NodePath<Entity>>> leaves)	Replaces the default leaf detection, which queries for the siblings referenced via the configured foreign keys, a node of an entity type no configured foreign key references always being a leaf.
final B	AbstractEntityTreeModelBuilder.onSelectedPath(Consumer<NodePath<Entity>> path)
final B	AbstractEntityTreeModelBuilder.onSelectedPaths(Consumer<List<NodePath<Entity>>> paths)
final B	AbstractEntityTreeModelBuilder.path(Function<Entity,@Nullable NodePath<Entity>> path)

Uses of NodePath in is.codion.swing.common.model.component.tree

Methods in is.codion.swing.common.model.component.tree that return NodePath

Modifier and Type	Method	Description
NodePath<T>	SwingFilterTreeModel.getRoot()

Methods in is.codion.swing.common.model.component.tree with parameters of type NodePath

Modifier and Type	Method	Description
TreePath	SwingFilterTreeModel.treePath(NodePath<T> path)

Method parameters in is.codion.swing.common.model.component.tree with type arguments of type NodePath

Modifier and Type	Method	Description
SwingFilterTreeModel.Builder<T>	SwingFilterTreeModel.Builder.ChildrenStep.children(Function<NodePath<T>,Collection<T>> children)
void	SwingFilterTreeModel.fireNodesChanged(Collection<NodePath<T>> paths)	Notifies all listeners that the given nodes have changed, for when external state changes how they are rendered.

Uses of NodePath in is.codion.swing.common.ui.component.tree

Methods in is.codion.swing.common.ui.component.tree with parameters of type NodePath

Modifier and Type	Method	Description
void	FilterTree.ScrollTo.path(NodePath<T> path)	Scrolls to the node identified by the given path, expanding its ancestors if required.