com.haulmont.cuba.gui.components

Interface Tree<E extends Entity>

All Superinterfaces:

Component, Component.ActionsHolder, Component.BelongToFrame, Component.Editable, Component.Focusable, Component.HasButtonsPanel, Component.HasCaption, Component.HasIcon, ListComponent<E>, LookupComponent

All Known Subinterfaces:

WidgetsTree<E>

public interface Tree<E extends Entity>
extends ListComponent<E>, Component.Editable, Component.HasButtonsPanel, Component.HasCaption, Component.HasIcon, LookupComponent, Component.Focusable

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	Tree.StyleProvider<E extends Entity> Allows to define different styles for tree items.

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.ActionOwner, Component.ActionsHolder, Component.Alignment, Component.BelongToFrame, Component.Buffered, Component.ChildEditableController, Component.Collapsable, Component.Container, Component.ContextHelpIconClickEvent, Component.Disposable, Component.Editable, Component.EditableChangeEvent, Component.EditableChangeListener, Component.EditableChangeNotifier, Component.ExpandedStateChangeEvent, Component.ExpandedStateChangeListener, Component.Focusable, Component.HasBorder, Component.HasButtonsPanel, Component.HasCaption, Component.HasContextHelp, Component.HasFormatter, Component.HasIcon, Component.HasInputPrompt, Component.HasNamedComponents, Component.HasOptionsStyleProvider, Component.HasPresentations, Component.HasRowsCount, Component.HasSettings, Component.HasValue, Component.HasXmlDescriptor, Component.LayoutClickEvent, Component.LayoutClickListener, Component.LayoutClickNotifier, Component.Margin, Component.MouseEventDetails, Component.OptionsStyleProvider, Component.OrderedContainer, Component.OuterMargin, Component.SecuredActionsHolder, Component.ShortcutAction, Component.ShortcutNotifier, Component.ShortcutTriggeredEvent, Component.Spacing, Component.UiPermissionAware, Component.Validatable, Component.ValueChangeEvent, Component.ValueChangeListener, Component.Wrapper

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

LookupComponent.LookupSelectionChangeEvent, LookupComponent.LookupSelectionChangeListener, LookupComponent.LookupSelectionChangeNotifier

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, UNITS_PERCENTAGE, UNITS_PIXELS

Method Summary

Modifier and Type	Method and Description
void	addStyleProvider(Tree.StyleProvider<? super E> styleProvider)
void	collapse(java.lang.Object itemId)
void	collapseTree()
void	expand(java.lang.Object itemId)
void	expandTree()
void	expandUpTo(int level) Expand tree including specified level
CaptionMode	getCaptionMode()
java.lang.String	getCaptionProperty()
HierarchicalDatasource	getDatasource()
Action	getEnterPressAction()
java.lang.String	getHierarchyProperty()
Action	getItemClickAction()
boolean	isExpanded(java.lang.Object itemId)
void	refresh() Deprecated. refresh datasource instead
void	removeStyleProvider(Tree.StyleProvider<? super E> styleProvider)
void	repaint() Repaint UI representation of the tree including style providers and icon providers without refreshing the tree data.
void	setCaptionMode(CaptionMode captionMode)
void	setCaptionProperty(java.lang.String captionProperty)
void	setDatasource(HierarchicalDatasource datasource)
void	setEnterPressAction(Action action) Set action to be executed on Enter key press.
void	setIconProvider(ListComponent.IconProvider<? super E> 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	setMultiSelect(boolean multiselect)
void	setStyleProvider(Tree.StyleProvider<? super E> styleProvider)

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.Component.ActionsHolder

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

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

addStyleName, getAlignment, getDebugId, getHeight, getHeightUnits, getId, getParent, getStyleName, getWidth, getWidthUnits, isEnabled, isEnabledItself, isResponsive, isVisible, isVisibleItself, removeStyleName, requestFocus, setAlignment, setDebugId, 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.Component.Editable

isEditable, isEditableWithParent, setEditable

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

getButtonsPanel, setButtonsPanel

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

getCaption, getDescription, setCaption, setDescription

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

getTabIndex, isFocusable, setFocusable, setTabIndex

Field Detail

NAME

static final java.lang.String NAME

See Also:

Constant Field Values

Method Detail

expandTree

void expandTree()

expand

void expand(java.lang.Object itemId)

collapseTree

void collapseTree()

collapse

void collapse(java.lang.Object itemId)

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)

getCaptionMode

CaptionMode getCaptionMode()

setCaptionMode

void setCaptionMode(CaptionMode captionMode)

getCaptionProperty

java.lang.String getCaptionProperty()

setCaptionProperty

void setCaptionProperty(java.lang.String captionProperty)

getHierarchyProperty

java.lang.String getHierarchyProperty()

setDatasource

void setDatasource(HierarchicalDatasource datasource)

getDatasource

HierarchicalDatasource getDatasource()

Specified by:

getDatasource in interface ListComponent<E extends Entity>

setItemClickAction

void setItemClickAction(Action action)

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

getItemClickAction

Action getItemClickAction()

setStyleProvider

void setStyleProvider(@Nullable
                      Tree.StyleProvider<? super E> styleProvider)

addStyleProvider

void addStyleProvider(Tree.StyleProvider<? super E> styleProvider)

removeStyleProvider

void removeStyleProvider(Tree.StyleProvider<? super E> styleProvider)

setIconProvider

void setIconProvider(ListComponent.IconProvider<? super E> 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

void setMultiSelect(boolean multiselect)

refresh

@Deprecated
void refresh()

Deprecated. refresh datasource instead