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, HasHtmlSanitizer, 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, HasHtmlSanitizer

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	Tree.CollapseEvent<E extends Entity> An event that is fired when an item is collapsed.
static interface	Tree.DetailsGenerator<E extends Entity> A callback interface for generating details for a particular item in Tree.
static class	Tree.ExpandEvent<E extends Entity> An event that is fired when an item is expanded.
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	addCollapseListener(java.util.function.Consumer<Tree.CollapseEvent<E>> listener) Registers a new collapse listener.
Subscription	addExpandListener(java.util.function.Consumer<Tree.ExpandEvent<E>> listener) Registers a new expand listener.
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
ContentMode	getContentMode()
default HierarchicalDatasource	getDatasource() Deprecated.
java.util.function.Function<E,java.lang.String>	getDescriptionProvider() Gets the item description generator.
Tree.DetailsGenerator<E>	getDetailsGenerator()
Action	getEnterPressAction()
java.lang.String	getHierarchyProperty()
Action	getItemClickAction()
TreeItems<E>	getItems()
Tree.SelectionMode	getSelectionMode()
boolean	isContextMenuEnabled()
boolean	isDetailsVisible(E entity) Checks whether details are visible for the given item.
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.
void	setContentMode(ContentMode contentMode) Sets the content mode of the item captions.
void	setContextMenuEnabled(boolean contextMenuEnabled) Sets whether or not context menu is enabled.
default void	setDatasource(HierarchicalDatasource datasource) Deprecated.
void	setDescriptionProvider(java.util.function.Function<? super E,java.lang.String> provider) Sets the description generator that is used for generating tooltip descriptions for items.
void	setDescriptionProvider(java.util.function.Function<? super E,java.lang.String> provider, ContentMode contentMode) Sets the description generator that is used for generating HTML tooltip descriptions for items.
void	setDetailsGenerator(Tree.DetailsGenerator<? super E> generator) Sets a new details generator for item details.
void	setDetailsVisible(E entity, boolean visible) Shows or hides the details for a specific item.
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	setRowHeight(double rowHeight) Sets the height of a row.
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, unwrapCompositionOrNull, unwrapOrNull, withUnwrapped, withUnwrappedComposition

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

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

isHtmlSanitizerEnabled, setHtmlSanitizerEnabled

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

isContextMenuEnabled

boolean isContextMenuEnabled()

Returns:

true if context menu is enabled, false otherwise

setContextMenuEnabled

void setContextMenuEnabled(boolean contextMenuEnabled)

Sets whether or not context menu is enabled. Default value is true.

Parameters:

contextMenuEnabled - specifies whether context menu is enabled

setDescriptionProvider

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

Sets the description generator that is used for generating tooltip descriptions for items.

Parameters:

provider - the description generator to use or null to remove a previously set provider if any

setDescriptionProvider

void setDescriptionProvider(java.util.function.Function<? super E,java.lang.String> provider,
                            ContentMode contentMode)

Sets the description generator that is used for generating HTML tooltip descriptions for items.

Parameters:

provider - the description generator to use or null to remove a previously set provider if any

contentMode - the content mode for row tooltips

getDescriptionProvider

java.util.function.Function<E,java.lang.String> getDescriptionProvider()

Gets the item description generator.

Returns:

the item description generator

getDetailsGenerator

@Nullable
Tree.DetailsGenerator<E> getDetailsGenerator()

Returns:

the current details generator for item details or null if not set

setDetailsGenerator

void setDetailsGenerator(Tree.DetailsGenerator<? super E> generator)

Sets a new details generator for item details.

The currently opened item details will be re-rendered.

Parameters:

generator - the details generator to set

isDetailsVisible

boolean isDetailsVisible(E entity)

Checks whether details are visible for the given item.

Parameters:

entity - the item for which to check details visibility

Returns:

true if the details are visible

setDetailsVisible

void setDetailsVisible(E entity,
                       boolean visible)

Shows or hides the details for a specific item.

Parameters:

entity - the item for which to set details visibility

visible - true to show the details, or false to hide them

addExpandListener

Subscription addExpandListener(java.util.function.Consumer<Tree.ExpandEvent<E>> listener)

Registers a new expand listener.

Parameters:

listener - the listener to be added

Returns:

a registration object for removing an event listener added to a source

addCollapseListener

Subscription addCollapseListener(java.util.function.Consumer<Tree.CollapseEvent<E>> listener)

Registers a new collapse listener.

Parameters:

listener - the listener to be added

Returns:

a registration object for removing an event listener added to a source

setRowHeight

void setRowHeight(double rowHeight)

Sets the height of a row. If -1 (default), the row height is calculated based on the theme for an empty row before the Tree is displayed.

Parameters:

rowHeight - The height of a row in pixels or -1 for automatic calculation

getContentMode

ContentMode getContentMode()

Returns:

the content mode of the item captions

setContentMode

void setContentMode(ContentMode contentMode)

Sets the content mode of the item captions.

Parameters:

contentMode - the content mode

addSelectionListener

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

Registers a new selection listener

Parameters:

listener - the listener to register