com.haulmont.cuba.gui.components

Interface Tree<E extends Entity>

All Superinterfaces:

ActionsHolder, Component, Component.BelongToFrame, Component.Focusable, Component.HasCaption, Component.HasDescription, Component.HasIcon, HasButtonsPanel, HasContextHelp, HasHtmlCaption, HasHtmlDescription, HasItemCaptionProvider<E>, HasSubParts, ListComponent<E>, LookupComponent<E>

public interface Tree<E extends Entity>
extends ListComponent<E>, HasButtonsPanel, Component.HasCaption, Component.HasIcon, LookupComponent<E>, Component.Focusable, HasContextHelp, HasItemCaptionProvider<E>, HasHtmlCaption, HasHtmlDescription

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	Tree.SelectionEvent<E extends Entity> Event sent when the selection changes.
static class	Tree.SelectionMode
static interface	Tree.StyleProvider<E extends Entity> Deprecated.

Nested classes/interfaces inherited from interface com.haulmont.cuba.gui.components.ListComponent

ListComponent.IconProvider<E extends Entity>

Nested classes/interfaces inherited from interface com.haulmont.cuba.gui.components.Component

Component.Alignment, Component.BelongToFrame, Component.Disposable, Component.Editable, Component.Focusable, Component.HasCaption, Component.HasDescription, Component.HasIcon, Component.HasXmlDescriptor, Component.OptionsStyleProvider, Component.Wrapper

Nested classes/interfaces inherited from interface com.haulmont.cuba.gui.components.LookupComponent

LookupComponent.LookupSelectionChangeEvent<T extends Entity>, LookupComponent.LookupSelectionChangeNotifier<T extends Entity>

Nested classes/interfaces inherited from interface com.haulmont.cuba.gui.components.HasContextHelp

HasContextHelp.ContextHelpIconClickEvent

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	NAME

Fields inherited from interface com.haulmont.cuba.gui.components.Component

AUTO_SIZE, AUTO_SIZE_PX, FULL_SIZE, UNITS_PERCENTAGE, UNITS_PIXELS

Method Summary

Modifier and Type	Method and Description
Subscription	addSelectionListener(java.util.function.Consumer<Tree.SelectionEvent<E>> listener) Registers a new selection listener
void	addStyleProvider(java.util.function.Function<? super E,java.lang.String> styleProvider) Add a style provider for tree items.
void	collapse(E item)
void	collapse(java.lang.Object itemId) Deprecated. Use collapse(Entity) instead
void	collapseTree()
void	expand(E item)
void	expand(java.lang.Object itemId) Deprecated. Use expand(Entity) instead
void	expandTree()
void	expandUpTo(int level) Expand tree including specified level
default HierarchicalDatasource	getDatasource() Deprecated.
Action	getEnterPressAction()
java.lang.String	getHierarchyProperty()
Action	getItemClickAction()
TreeItems<E>	getItems()
Tree.SelectionMode	getSelectionMode()
boolean	isExpanded(java.lang.Object itemId)
static <T extends Entity> com.google.common.reflect.TypeToken<Tree<T>>	of(java.lang.Class<T> itemClass)
void	refresh() Deprecated. refresh datasource instead
void	removeStyleProvider(java.util.function.Function<? super E,java.lang.String> styleProvider) Removes a previously added style provider.
void	repaint() Repaint UI representation of the tree including style providers and icon providers without refreshing the tree data.
default void	setDatasource(HierarchicalDatasource datasource) Deprecated.
void	setEnterPressAction(Action action) Set action to be executed on Enter key press.
void	setIconProvider(java.util.function.Function<? super E,java.lang.String> iconProvider) Set the icon provider for the tree.
void	setItemClickAction(Action action) Assign action to be executed on double click inside a tree node.
void	setItems(TreeItems<E> treeItems)
void	setMultiSelect(boolean multiselect) Deprecated. Use setSelectionMode(SelectionMode) instead
void	setSelectionMode(Tree.SelectionMode selectionMode) Sets the Tree's selection mode.
void	setStyleProvider(java.util.function.Function<? super E,java.lang.String> styleProvider) Sets a single style provider for tree items.

Methods inherited from interface com.haulmont.cuba.gui.components.ListComponent

getSelected, getSingleSelected, isMultiSelect, setSelected, setSelected

Methods inherited from interface com.haulmont.cuba.gui.components.Component.BelongToFrame

getFrame, setFrame

Methods inherited from interface com.haulmont.cuba.gui.components.ActionsHolder

addAction, addAction, getAction, getActionNN, getActions, getSubPart, removeAction, removeAction, removeAllActions

Methods inherited from interface com.haulmont.cuba.gui.components.Component

addStyleName, getAlignment, getHeight, getHeightSizeUnit, getHeightUnits, getId, getParent, getStyleName, getWidth, getWidthSizeUnit, getWidthUnits, isEnabled, isEnabledItself, isEnabledRecursive, isResponsive, isVisible, isVisibleItself, isVisibleRecursive, removeStyleName, requestFocus, setAlignment, setEnabled, setHeight, setHeightAuto, setHeightFull, setId, setParent, setResponsive, setSizeAuto, setSizeFull, setStyleName, setVisible, setWidth, setWidthAuto, setWidthFull, unwrap, unwrapComposition

Methods inherited from interface com.haulmont.cuba.gui.components.HasButtonsPanel

getButtonsPanel, setButtonsPanel

Methods inherited from interface com.haulmont.cuba.gui.components.Component.HasIcon

getIcon, setIcon, setIconFromSet

Methods inherited from interface com.haulmont.cuba.gui.components.LookupComponent

getLookupSelectedItems, setLookupSelectHandler

Methods inherited from interface com.haulmont.cuba.gui.components.Component.Focusable

focus, getTabIndex, isFocusable, setFocusable, setTabIndex

Methods inherited from interface com.haulmont.cuba.gui.components.HasContextHelp

getContextHelpIconClickHandler, getContextHelpText, isContextHelpTextHtmlEnabled, setContextHelpIconClickHandler, setContextHelpText, setContextHelpTextHtmlEnabled

Methods inherited from interface com.haulmont.cuba.gui.components.HasItemCaptionProvider

getCaptionMode, getCaptionProperty, getItemCaptionProvider, setCaptionMode, setCaptionProperty, setItemCaptionProvider

Methods inherited from interface com.haulmont.cuba.gui.components.HasHtmlCaption

isCaptionAsHtml, setCaptionAsHtml

Methods inherited from interface com.haulmont.cuba.gui.components.Component.HasCaption

getCaption, setCaption

Methods inherited from interface com.haulmont.cuba.gui.components.Component.HasDescription

getDescription, setDescription

Methods inherited from interface com.haulmont.cuba.gui.components.HasHtmlDescription

isDescriptionAsHtml, setDescriptionAsHtml

Field Detail

NAME

static final java.lang.String NAME

See Also:

Constant Field Values

Method Detail

of

static <T extends Entity> com.google.common.reflect.TypeToken<Tree<T>> of(java.lang.Class<T> itemClass)

expandTree

void expandTree()

expand

@Deprecated
void expand(java.lang.Object itemId)

Deprecated. Use expand(Entity) instead

Parameters:

itemId - the id of item to expand

expand

void expand(E item)

collapseTree

void collapseTree()

collapse

@Deprecated
void collapse(java.lang.Object itemId)

Deprecated. Use collapse(Entity) instead

Parameters:

itemId - the id of item to collapse

collapse

void collapse(E item)

expandUpTo

void expandUpTo(int level)

Expand tree including specified level

Parameters:

level - level of Tree nodes to expand, if passed level = 1 then root items will be expanded

Throws:

java.lang.IllegalArgumentException - if level < 1

isExpanded

boolean isExpanded(java.lang.Object itemId)

getHierarchyProperty

java.lang.String getHierarchyProperty()

setDatasource

@Deprecated
default void setDatasource(HierarchicalDatasource datasource)

Deprecated.

getDatasource

@Deprecated
default HierarchicalDatasource getDatasource()

Deprecated.

Specified by:

getDatasource in interface ListComponent<E extends Entity>

getItems

TreeItems<E> getItems()

Specified by:

getItems in interface ListComponent<E extends Entity>

setItems

void setItems(TreeItems<E> treeItems)

setItemClickAction

void setItemClickAction(Action action)

Assign action to be executed on double click inside a tree node.

getItemClickAction

Action getItemClickAction()

setStyleProvider

void setStyleProvider(@Nullable
                      java.util.function.Function<? super E,java.lang.String> styleProvider)

Sets a single style provider for tree items.

Parameters:

styleProvider - a style provider to set

addStyleProvider

void addStyleProvider(java.util.function.Function<? super E,java.lang.String> styleProvider)

Add a style provider for tree items.

Parameters:

styleProvider - a style provider to add

removeStyleProvider

void removeStyleProvider(java.util.function.Function<? super E,java.lang.String> styleProvider)

Removes a previously added style provider.

Parameters:

styleProvider - a style provider to remove

setIconProvider

void setIconProvider(java.util.function.Function<? super E,java.lang.String> iconProvider)

Set the icon provider for the tree.

repaint

void repaint()

Repaint UI representation of the tree including style providers and icon providers without refreshing the tree data.

setEnterPressAction

void setEnterPressAction(Action action)

Set action to be executed on Enter key press.

getEnterPressAction

Action getEnterPressAction()

Returns:

Enter key press action.

setMultiSelect

@Deprecated
void setMultiSelect(boolean multiselect)

Deprecated. Use setSelectionMode(SelectionMode) instead

Parameters:

multiselect - true for multiselect, false otherwise

refresh

@Deprecated
void refresh()

Deprecated. refresh datasource instead

getSelectionMode

Tree.SelectionMode getSelectionMode()

Returns:

the currently used Tree.SelectionMode

setSelectionMode

void setSelectionMode(Tree.SelectionMode selectionMode)

Sets the Tree's selection mode.

Parameters:

selectionMode - the selection mode to use

addSelectionListener

Subscription addSelectionListener(java.util.function.Consumer<Tree.SelectionEvent<E>> listener)

Registers a new selection listener

Parameters:

listener - the listener to register