Module is.codion.framework.model

Package is.codion.framework.model

Class AbstractEntityTableTreeModel<M extends FilterTreeModel<Entity>>

java.lang.Object

is.codion.framework.model.AbstractEntityTableTreeModel<M>

Type Parameters:

M - the type of the underlying tree model

All Implemented Interfaces:

FilterTreeModel<Entity>, EntityTableTreeModel

public abstract class AbstractEntityTableTreeModel<M extends FilterTreeModel<Entity>>
extends Object
implements EntityTableTreeModel

A base class for EntityTableTreeModel implementations, based on a tree model built by a toolkit, a javax.swing.tree.TreeModel based one for example, the logic, arranging the rows and keeping the selections in sync, living here.

The FilterTreeModel methods delegate to the tree model, see treeModel().

See Also:

• AbstractEntityTableTreeModelBuilder

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static interface	AbstractEntityTableTreeModel.TreeModelBuilder<M extends FilterTreeModel<Entity>>	Builds the underlying tree model of an EntityTableTreeModel.

Nested classes/interfaces inherited from interface is.codion.framework.model.EntityTableTreeModel

EntityTableTreeModel.Builder<B extends EntityTableTreeModel.Builder<B>>, EntityTableTreeModel.UnreachableItems

Nested classes/interfaces inherited from interface is.codion.common.model.component.tree.FilterTreeModel

FilterTreeModel.Expansion<T>, FilterTreeModel.Loader<T>, FilterTreeModel.Nodes<T>, FilterTreeModel.NodesListener<T>, FilterTreeModel.VisibleNodes<T>

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractEntityTableTreeModel(AbstractEntityTableTreeModelBuilder<?> builder, AbstractEntityTableTreeModel.TreeModelBuilder<M> treeModel)

Method Summary

Modifier and Type	Method	Description
final FilterTreeModel.Expansion<Entity>	expansion()
final FilterTreeModel.Nodes<Entity>	nodes()
final State	orphansAsRoots()	Controls whether entities whose parent is not among the included items are shown as roots, otherwise they are hidden, along with everything below them, false by default.
final State	parentsFirst()	Controls whether siblings with children come before those without, in the order of the rows within each group, otherwise the siblings are in the order of the rows, false by default.
TreeSelection<Entity>	selection()	The selection, over the FilterTreeModel.visible() nodes, by item, with TreeSelection.paths() addressing particular nodes, the same item appearing in several places.
final FilterTreeSort<Entity>	sort()
String	toString()
protected final M	treeModel()
final EntityTableTreeModel.UnreachableItems	unreachable()
final FilterTreeModel.VisibleNodes<Entity>	visible()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

AbstractEntityTableTreeModel

protected AbstractEntityTableTreeModel(AbstractEntityTableTreeModelBuilder<?> builder,
 AbstractEntityTableTreeModel.TreeModelBuilder<M> treeModel)

Parameters:

builder - the builder

treeModel - builds the underlying tree model

Method Details

orphansAsRoots

public final State orphansAsRoots()

Description copied from interface: EntityTableTreeModel

Controls whether entities whose parent is not among the included items are shown as roots, otherwise they are hidden, along with everything below them, false by default.

Specified by:

orphansAsRoots in interface EntityTableTreeModel

Returns:

the State controlling whether orphans are shown as roots

parentsFirst

public final State parentsFirst()

Description copied from interface: EntityTableTreeModel

Controls whether siblings with children come before those without, in the order of the rows within each group, otherwise the siblings are in the order of the rows, false by default.

Specified by:

parentsFirst in interface EntityTableTreeModel

Returns:

the State controlling whether parents come first

unreachable

public final EntityTableTreeModel.UnreachableItems unreachable()

Specified by:

unreachable in interface EntityTableTreeModel

Returns:

the EntityTableTreeModel.UnreachableItems, the included items reachable from no root, so not in the tree

nodes

public final FilterTreeModel.Nodes<Entity> nodes()

Specified by:

nodes in interface FilterTreeModel<M extends FilterTreeModel<Entity>>

Returns:

the FilterTreeModel.Nodes providing the structure, loading, mutation and filtering

expansion

public final FilterTreeModel.Expansion<Entity> expansion()

Specified by:

expansion in interface FilterTreeModel<M extends FilterTreeModel<Entity>>

Returns:

the FilterTreeModel.Expansion controlling the expanded nodes

visible

public final FilterTreeModel.VisibleNodes<Entity> visible()

Specified by:

visible in interface FilterTreeModel<M extends FilterTreeModel<Entity>>

Returns:

the FilterTreeModel.VisibleNodes, the rows a view displays

selection

public TreeSelection<Entity> selection()

Description copied from interface: FilterTreeModel

The selection, over the FilterTreeModel.visible() nodes, by item, with TreeSelection.paths() addressing particular nodes, the same item appearing in several places. Selecting a node hidden below a collapsed ancestor expands its ancestors, and a node not yet loaded is selected via TreeSelection.set(NodePath).

The selection is kept by path, through refreshes, filtering, sorting and expansion. A selected node hidden by collapsing one of its ancestors is replaced by its nearest visible ancestor, and one removed or excluded is dropped from the selection.

Specified by:

selection in interface FilterTreeModel<M extends FilterTreeModel<Entity>>

Returns:

the selection

sort

public final FilterTreeSort<Entity> sort()

Specified by:

sort in interface FilterTreeModel<M extends FilterTreeModel<Entity>>

Returns:

the FilterTreeSort instance used by this model

toString

public String toString()

Overrides:

toString in class Object

treeModel

protected final M treeModel()

Returns:

the underlying tree model