TreeImpl (Jmix-ui 1.0 API)

java.lang.Object
- io.jmix.ui.component.impl.AbstractComponent<JmixTree<E>>
- - io.jmix.ui.component.impl.TreeImpl<E>

All Implemented Interfaces:

ActionsHolder, AttachNotifier, Component, Component.BelongToFrame, Component.Focusable, Component.HasCaption, Component.HasDescription, Component.HasIcon, Component.HasXmlDescriptor, Component.Wrapper, HasButtonsPanel, HasContextHelp, HasDebugId, HasHtmlCaption, HasHtmlDescription, HasHtmlSanitizer, HasInnerComponents, HasItemCaptionProvider<E>, HasSubParts, ListComponent<E>, LookupComponent<E>, LookupComponent.LookupSelectionChangeNotifier<E>, SecuredActionsHolder, Tree<E>, TreeSourceEventsDelegate<E>, org.springframework.beans.factory.InitializingBean
```
public class TreeImpl<E>
extends AbstractComponent<JmixTree<E>>
implements Tree<E>, LookupComponent.LookupSelectionChangeNotifier<E>, SecuredActionsHolder, HasInnerComponents, org.springframework.beans.factory.InitializingBean, TreeSourceEventsDelegate<E>
```

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

protected class TreeImpl.EmptyTreeDataProvider<T>

protected class TreeImpl.TreeComposition
- Nested classes/interfaces inherited from interface io.jmix.ui.component.Tree
  Tree.CollapseEvent<E>, Tree.ExpandEvent<E>, Tree.SelectionEvent<E>, Tree.SelectionMode
- Nested classes/interfaces inherited from interface io.jmix.ui.component.Component
  Component.Alignment, Component.BelongToFrame, Component.Disposable, Component.Editable, Component.Focusable, Component.HasCaption, Component.HasDescription, Component.HasIcon, Component.HasXmlDescriptor, Component.Wrapper
- Nested classes/interfaces inherited from interface io.jmix.ui.component.HasContextHelp
  HasContextHelp.ContextHelpIconClickEvent
- Nested classes/interfaces inherited from interface io.jmix.ui.component.LookupComponent
  LookupComponent.LookupSelectionChangeEvent<T>, LookupComponent.LookupSelectionChangeNotifier<T>

Nested Classes
Modifier and Type	Class and Description
`protected class`	`TreeImpl.EmptyTreeDataProvider<T>`
`protected class`	`TreeImpl.TreeComposition`

Field Summary

Fields
Modifier and Type	Field and Description
`protected io.jmix.core.AccessManager`	`accessManager`
`protected java.util.List<Action>`	`actionList`
`protected Actions`	`actions`
`protected ActionsPermissions`	`actionsPermissions`
`protected ButtonsPanel`	`buttonsPanel`
`protected com.vaadin.shared.Registration`	`collapseListener`
`protected TreeImpl.TreeComposition`	`componentComposition`
`protected TreeContextMenu<E>`	`contextMenu`
`protected java.util.List<AbstractDataGrid.ActionMenuItemWrapper>`	`contextMenuItems`
`protected TreeDataProvider<E>`	`dataBinding`
`protected java.util.function.Function<? super E,java.lang.String>`	`descriptionProvider`
`protected java.util.function.Function<E,Component>`	`detailsGenerator`
`protected Action`	`doubleClickAction`
`protected Action`	`enterPressAction`
`protected com.vaadin.shared.Registration`	`expandListener`
`protected java.lang.String`	`hierarchyProperty`
`protected java.util.function.Function<? super E,java.lang.String>`	`iconProvider`
`protected IconResolver`	`iconResolver`
`protected java.util.List<java.lang.String>`	`internalStyles`
`protected java.util.function.Function<? super E,java.lang.String>`	`itemCaptionProvider`
`protected com.vaadin.shared.Registration`	`itemClickListener`
`protected io.jmix.core.Metadata`	`metadata`
`protected io.jmix.core.MetadataTools`	`metadataTools`
`protected Tree.SelectionMode`	`selectionMode`
`protected ShortcutsDelegate<com.vaadin.event.ShortcutListener>`	`shortcutsDelegate`
`protected boolean`	`showIconsForPopupMenuActions`
`protected com.vaadin.ui.StyleGenerator<E>`	`styleGenerator`
`protected java.util.List<java.util.function.Function<? super E,java.lang.String>>`	`styleProviders`
`protected com.vaadin.ui.HorizontalLayout`	`topPanel`
`protected UiTestIdsSupport`	`uiTestIdsSupport`

Fields inherited from class io.jmix.ui.component.impl.AbstractComponent
alignment, applicationContext, component, contextHelpIconClickHandler, contextHelpIconClickListener, descriptionAsHtml, element, frame, htmlSanitizerEnabled, icon, ICON_STYLE, id, parent

Fields inherited from interface io.jmix.ui.component.Tree
NAME

Fields inherited from interface io.jmix.ui.component.Component
AUTO_SIZE, AUTO_SIZE_PX, FULL_SIZE

Constructor Summary

Constructors
Constructor and Description

TreeImpl()

Constructors
Constructor and Description
`TreeImpl()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addAction(Action action)` Add an action to the component
`void`	`addAction(Action action, int index)` Add an action to the component with index.
`io.jmix.core.common.event.Subscription`	`addCollapseListener(java.util.function.Consumer<Tree.CollapseEvent<E>> listener)` Registers a new collapse listener.
`io.jmix.core.common.event.Subscription`	`addExpandListener(java.util.function.Consumer<Tree.ExpandEvent<E>> listener)` Registers a new expand listener.
`io.jmix.core.common.event.Subscription`	`addLookupValueChangeListener(java.util.function.Consumer<LookupComponent.LookupSelectionChangeEvent<E>> listener)` Adds a listener that invoked when lookup selected items set is changed.
`io.jmix.core.common.event.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)` Adds a style provider for tree items.
`void`	`afterPropertiesSet()`
`protected void`	`attachAction(Action action)`
`void`	`collapse(E item)` Collapses all tree nodes that are lower in level than a given item.
`void`	`collapseTree()` Collapses tree nodes.
`protected JmixTree<E>`	`createComponent()`
`protected TreeImpl.TreeComposition`	`createComponentComposition()`
`protected AbstractDataGrid.ActionMenuItemWrapper`	`createContextMenuItem(Action action)`
`protected TreeDataProvider<E>`	`createDataGridDataProvider(TreeItems<E> treeItems)`
`protected com.vaadin.data.provider.DataProvider<E,?>`	`createEmptyDataProvider()`
`protected ShortcutListenerDelegate`	`createEnterShortcutListener()`
`protected ShortcutsDelegate<com.vaadin.event.ShortcutListener>`	`createShortcutsDelegate()`
`protected com.vaadin.ui.HorizontalLayout`	`createTopPanel()`
`void`	`expand(E item)` Expands all tree nodes that are higher in level that a given item.
`void`	`expandTree()` Expands all tree nodes.
`void`	`expandUpTo(int level)` Expands tree including specified level
`protected void`	`fireSelectionEvent(com.vaadin.event.selection.SelectionEvent<E> e)`
`void`	`focus()` Sets focus to this component
`protected java.lang.String`	`generateItemCaption(E item)`
`Action`	`getAction(java.lang.String id)`
`java.util.Collection<Action>`	`getActions()`
`ActionsPermissions`	`getActionsPermissions()`
`ButtonsPanel`	`getButtonsPanel()`
`java.lang.String`	`getCaption()`
`com.vaadin.ui.Component`	`getComposition()`
`ContentMode`	`getContentMode()`
`java.lang.String`	`getDescription()`
`java.util.function.Function<E,java.lang.String>`	`getDescriptionProvider()` Gets the item description generator.
`java.util.function.Function<E,Component>`	`getDetailsGenerator()`
`Action`	`getEnterPressAction()`
`protected java.lang.String`	`getGeneratedStyle(E item)`
`java.lang.String`	`getHierarchyProperty()`
`java.util.Collection<Component>`	`getInnerComponents()`
`java.util.function.Function<? super E,java.lang.String>`	`getItemCaptionProvider()`
`Action`	`getItemClickAction()`
`protected com.vaadin.ui.Component`	`getItemDetails(E entity)`
`protected com.vaadin.server.Resource`	`getItemIcon(E item)`
`TreeItems<E>`	`getItems()`
`java.util.Collection<E>`	`getLookupSelectedItems()`
`protected java.lang.String`	`getRowDescription(E item)`
`java.util.Set<E>`	`getSelected()` Returns a set of entity instances corresponding to the selected rows of the list component.
`Tree.SelectionMode`	`getSelectionMode()`
`E`	`getSingleSelected()` Returns an instance of entity corresponding to the selected row of the list component.
`java.lang.String`	`getStyleName()` Styles implementation is client-type-specific.
`int`	`getTabIndex()` Gets the tabulator index of the `HasTabIndex` component.
`protected void`	`handleClickAction()`
`protected void`	`initComponent(JmixTree<E> component)`
`protected void`	`initComponentComposition(TreeImpl.TreeComposition composition)`
`protected void`	`initContextMenu()`
`boolean`	`isCaptionAsHtml()`
`boolean`	`isContextMenuEnabled()`
`boolean`	`isDetailsVisible(E entity)` Checks whether details are visible for the given item.
`boolean`	`isExpanded(java.lang.Object itemId)` Returns whether an item with given itemId is expanded or collapsed.
`boolean`	`isMultiSelect()`
`protected void`	`onItemClick(com.vaadin.ui.Tree.ItemClick<E> event)`
`protected void`	`onItemCollapse(com.vaadin.event.CollapseEvent<E> e)`
`protected void`	`onItemExpand(com.vaadin.event.ExpandEvent<E> e)`
`protected void`	`onSelectionChange(com.vaadin.event.selection.SelectionEvent<E> event)`
`protected void`	`refreshActionsState()`
`void`	`removeAction(Action action)` Remove the action from the component
`void`	`removeAction(java.lang.String id)` Remove the action by its ID.
`void`	`removeAllActions()` Remove all actions from the component
`void`	`removeStyleProvider(java.util.function.Function<? super E,java.lang.String> styleProvider)` Removes a previously added style provider.
`void`	`repaint()` Repaints UI representation of the tree including style providers and icon providers without refreshing the tree data.
`void`	`setAccessManager(io.jmix.core.AccessManager accessManager)`
`void`	`setActions(Actions actions)`
`void`	`setButtonsPanel(ButtonsPanel panel)` Sets a `ButtonsPanel` component.
`void`	`setCaption(java.lang.String caption)` Sets the component's caption.
`void`	`setCaptionAsHtml(boolean captionAsHtml)` Sets whether the caption is rendered as HTML.
`void`	`setContentMode(ContentMode contentMode)` Sets the content mode of the item captions.
`void`	`setContextMenuEnabled(boolean contextMenuEnabled)` Sets whether or not context menu is enabled.
`void`	`setDebugId(java.lang.String id)` INTERNAL.
`void`	`setDescription(java.lang.String description)` Sets the component's description.
`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(java.util.function.Function<E,Component> 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)` Sets the action to be executed on Enter key press.
`void`	`setIconProvider(java.util.function.Function<? super E,java.lang.String> iconProvider)` Sets the icon provider for the tree.
`void`	`setIconResolver(IconResolver iconResolver)`
`void`	`setId(java.lang.String id)` Set component ID
`void`	`setItemCaptionProvider(java.util.function.Function<? super E,java.lang.String> itemCaptionProvider)` Sets function that provides caption for component item.
`void`	`setItemClickAction(Action action)` Sets the action to be executed when double-clicking inside a tree node.
`void`	`setItems(TreeItems<E> treeItems)` Sets a `DataUnit` supported by the Tree.
`void`	`setLookupSelectHandler(java.util.function.Consumer<java.util.Collection<E>> selectHandler)`
`void`	`setMetadata(io.jmix.core.Metadata metadata)`
`void`	`setMetadataTools(io.jmix.core.MetadataTools metadataTools)`
`void`	`setRowHeight(double rowHeight)` Sets the height of a row.
`void`	`setSelected(java.util.Collection<E> items)` Selects the rows of the list component for a given collection of entity instances.
`void`	`setSelected(E item)` Selects a row of the list component for a given entity instance.
`protected void`	`setSelectedInternal(java.util.Collection<E> items)`
`void`	`setSelectionMode(Tree.SelectionMode selectionMode)` Sets the Tree's selection mode.
`void`	`setStyleName(java.lang.String name)` Sets one or more style names of the component, replacing any previous styles.
`void`	`setStyleProvider(java.util.function.Function<? super E,java.lang.String> styleProvider)` Sets a single style provider for tree items.
`void`	`setTabIndex(int tabIndex)` Sets the tabulator index of the `Focusable` component.
`void`	`setThemeConstantsManager(ThemeConstantsManager themeConstantsManager)`
`protected void`	`setUiTestId(TreeItems<E> items)`
`void`	`setUiTestIdsSupport(UiTestIdsSupport uiTestIdsSupport)`
`void`	`treeSourceItemSetChanged(TreeItems.ItemSetChangeEvent<E> event)`
`void`	`treeSourcePropertyValueChanged(TreeItems.ValueChangeEvent<E> event)`
`void`	`treeSourceSelectedItemChanged(TreeItems.SelectedItemChangeEvent<E> event)`
`void`	`treeSourceStateChanged(DataUnit.StateChangeEvent event)`
`protected void`	`updateCompositionStylesTopPanelVisible()`
`protected void`	`updateStyleGenerator()`

Methods inherited from class io.jmix.ui.component.impl.AbstractComponent
addAttachListener, addDetachListener, addStyleName, assignDebugId, attached, detached, getAlignment, getComponent, getContextHelpIconClickHandler, getContextHelpText, getDebugId, getEventHub, getFrame, getHeight, getHeightSizeUnit, getHtmlSanitizer, getIcon, getIconName, getIconResource, getId, getParent, getUiComponentProperties, getUiProperties, getWidth, getWidthSizeUnit, getXmlDescriptor, hasSubscriptions, hasValidationError, isAttached, isContextHelpTextHtmlEnabled, isDescriptionAsHtml, isEnabled, isEnabledRecursive, isHtmlSanitizerEnabled, isResponsive, isVisible, isVisibleRecursive, onContextHelpIconClick, publish, removeStyleName, sanitize, setAlignment, setApplicationContext, setContextHelpIconClickHandler, setContextHelpText, setContextHelpTextHtmlEnabled, setDescriptionAsHtml, setEnabled, setFrame, setHeight, setHtmlSanitizerEnabled, setIcon, setIconFromSet, setParent, setResponsive, setValidationError, setVisible, setWidth, setXmlDescriptor, unsubscribe, unwrap, unwrapComposition, unwrapCompositionOrNull, unwrapOrNull, withUnwrapped, withUnwrappedComposition

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface io.jmix.ui.component.Tree
of

Methods inherited from interface io.jmix.ui.component.Component.BelongToFrame
getFrame, setFrame

Methods inherited from interface io.jmix.ui.component.ActionsHolder
getActionNN, getSubPart

Methods inherited from interface io.jmix.ui.component.Component
addStyleName, getAlignment, getHeight, getHeightSizeUnit, getId, getParent, getWidth, getWidthSizeUnit, isEnabled, isEnabledRecursive, isResponsive, isVisible, isVisibleRecursive, removeStyleName, setAlignment, setEnabled, setHeight, setHeightAuto, setHeightFull, setParent, setResponsive, setSizeAuto, setSizeFull, setVisible, setWidth, setWidthAuto, setWidthFull, unwrap, unwrapComposition, unwrapCompositionOrNull, unwrapOrNull, withUnwrapped, withUnwrappedComposition

Methods inherited from interface io.jmix.ui.component.Component.HasIcon
getIcon, setIcon, setIconFromSet

Methods inherited from interface io.jmix.ui.component.Component.Focusable
isFocusable, setFocusable

Methods inherited from interface io.jmix.ui.component.HasContextHelp
getContextHelpIconClickHandler, getContextHelpText, isContextHelpTextHtmlEnabled, setContextHelpIconClickHandler, setContextHelpText, setContextHelpTextHtmlEnabled

Methods inherited from interface io.jmix.ui.component.HasHtmlDescription
isDescriptionAsHtml, setDescriptionAsHtml

Methods inherited from interface io.jmix.ui.component.HasHtmlSanitizer
isHtmlSanitizerEnabled, setHtmlSanitizerEnabled

- Field Detail
  - internalStyles
```
protected java.util.List<java.lang.String> internalStyles
```
  - styleProviders
```
protected java.util.List<java.util.function.Function<? super E,java.lang.String>> styleProviders
```
  - styleGenerator
```
protected com.vaadin.ui.StyleGenerator<E> styleGenerator
```
  - contextMenu
```
protected TreeContextMenu<E> contextMenu
```
  - contextMenuItems
```
protected final java.util.List<AbstractDataGrid.ActionMenuItemWrapper> contextMenuItems
```
  - buttonsPanel
```
protected ButtonsPanel buttonsPanel
```
  - topPanel
```
protected com.vaadin.ui.HorizontalLayout topPanel
```
  - componentComposition
```
protected TreeImpl.TreeComposition componentComposition
```
  - enterPressAction
```
protected Action enterPressAction
```
  - iconProvider
```
protected java.util.function.Function<? super E,java.lang.String> iconProvider
```
  - metadata
```
protected io.jmix.core.Metadata metadata
```
  - accessManager
```
protected io.jmix.core.AccessManager accessManager
```
  - iconResolver
```
protected IconResolver iconResolver
```
  - metadataTools
```
protected io.jmix.core.MetadataTools metadataTools
```
  - actions
```
protected Actions actions
```
  - uiTestIdsSupport
```
protected UiTestIdsSupport uiTestIdsSupport
```
  - selectionMode
```
protected Tree.SelectionMode selectionMode
```
  - doubleClickAction
```
protected Action doubleClickAction
```
  - itemClickListener
```
protected com.vaadin.shared.Registration itemClickListener
```
  - actionList
```
protected final java.util.List<Action> actionList
```
  - shortcutsDelegate
```
protected final ShortcutsDelegate<com.vaadin.event.ShortcutListener> shortcutsDelegate
```
  - actionsPermissions
```
protected final ActionsPermissions actionsPermissions
```
  - showIconsForPopupMenuActions
```
protected boolean showIconsForPopupMenuActions
```
  - hierarchyProperty
```
protected java.lang.String hierarchyProperty
```
  - dataBinding
```
protected TreeDataProvider<E> dataBinding
```
  - itemCaptionProvider
```
protected java.util.function.Function<? super E,java.lang.String> itemCaptionProvider
```
  - descriptionProvider
```
protected java.util.function.Function<? super E,java.lang.String> descriptionProvider
```
  - detailsGenerator
```
protected java.util.function.Function<E,Component> detailsGenerator
```
  - expandListener
```
protected com.vaadin.shared.Registration expandListener
```
  - collapseListener
```
protected com.vaadin.shared.Registration collapseListener
```
- Constructor Detail
  - TreeImpl
```
public TreeImpl()
```
- Method Detail
  - createComponent
```
protected JmixTree<E> createComponent()
```
  - createShortcutsDelegate
```
protected ShortcutsDelegate<com.vaadin.event.ShortcutListener> createShortcutsDelegate()
```
  - afterPropertiesSet
```
public void afterPropertiesSet()
```
    Specified by:
    
    afterPropertiesSet in interface org.springframework.beans.factory.InitializingBean
  - initComponentComposition
```
protected void initComponentComposition(TreeImpl.TreeComposition composition)
```
  - initComponent
```
protected void initComponent(JmixTree<E> component)
```
  - createComponentComposition
```
protected TreeImpl.TreeComposition createComponentComposition()
```
  - createEnterShortcutListener
```
protected ShortcutListenerDelegate createEnterShortcutListener()
```
  - generateItemCaption
```
protected java.lang.String generateItemCaption(E item)
```
  - initContextMenu
```
protected void initContextMenu()
```
  - setAccessManager
```
@Autowired
public void setAccessManager(io.jmix.core.AccessManager accessManager)
```
  - setIconResolver
```
@Autowired
public void setIconResolver(IconResolver iconResolver)
```
  - setMetadata
```
@Autowired
public void setMetadata(io.jmix.core.Metadata metadata)
```
  - setMetadataTools
```
@Autowired
public void setMetadataTools(io.jmix.core.MetadataTools metadataTools)
```
  - setThemeConstantsManager
```
@Autowired
public void setThemeConstantsManager(ThemeConstantsManager themeConstantsManager)
```
  - setActions
```
@Autowired
public void setActions(Actions actions)
```
  - setUiTestIdsSupport
```
@Autowired
public void setUiTestIdsSupport(UiTestIdsSupport uiTestIdsSupport)
```
  - getItems
```
@Nullable
public TreeItems<E> getItems()
```
    Specified by:
    
    getItems in interface ListComponent<E>
    
    Specified by:
    
    getItems in interface Tree<E>
    
    Returns:
    
    a DataUnit supported by the Tree
  - setItems
```
public void setItems(@Nullable
                     TreeItems<E> treeItems)
```
    Description copied from interface: Tree
    
    Sets a DataUnit supported by the Tree.
    
    Specified by:
    
    setItems in interface Tree<E>
    
    Parameters:
    
    treeItems - DataUnit supported by the Tree
  - setUiTestId
```
protected void setUiTestId(TreeItems<E> items)
```
  - setDebugId
```
public void setDebugId(@Nullable
                       java.lang.String id)
```
    Description copied from interface: HasDebugId
    
    INTERNAL. Managed by debug Id system.
    
    Specified by:
    
    setDebugId in interface HasDebugId
    
    Overrides:
    
    setDebugId in class AbstractComponent<JmixTree<E>>
  - setId
```
public void setId(@Nullable
                  java.lang.String id)
```
    Description copied from interface: Component
    
    Set component ID
    
    Specified by:
    
    setId in interface Component
    
    Overrides:
    
    setId in class AbstractComponent<JmixTree<E>>
  - createEmptyDataProvider
```
protected com.vaadin.data.provider.DataProvider<E,?> createEmptyDataProvider()
```
  - getHierarchyProperty
```
public java.lang.String getHierarchyProperty()
```
    Specified by:
    
    getHierarchyProperty in interface Tree<E>
    
    Returns:
    
    the name of the property which forms the hierarchy
  - getItemClickAction
```
@Nullable
public Action getItemClickAction()
```
    Specified by:
    
    getItemClickAction in interface Tree<E>
    
    Returns:
    
    an item double-click action
  - setItemClickAction
```
public void setItemClickAction(@Nullable
                               Action action)
```
    Description copied from interface: Tree
    
    Sets the action to be executed when double-clicking inside a tree node.
    
    Specified by:
    
    setItemClickAction in interface Tree<E>
    
    Parameters:
    
    action - a new action
  - onItemClick
```
protected void onItemClick(com.vaadin.ui.Tree.ItemClick<E> event)
```
  - setItemCaptionProvider
```
public void setItemCaptionProvider(@Nullable
                                   java.util.function.Function<? super E,java.lang.String> itemCaptionProvider)
```
    Description copied from interface: HasItemCaptionProvider
    
    Sets function that provides caption for component item.
    
    Specified by:
    
    setItemCaptionProvider in interface HasItemCaptionProvider<E>
    
    Parameters:
    
    itemCaptionProvider - caption provider for item
  - getItemCaptionProvider
```
@Nullable
public java.util.function.Function<? super E,java.lang.String> getItemCaptionProvider()
```
    Specified by:
    
    getItemCaptionProvider in interface HasItemCaptionProvider<E>
    
    Returns:
    
    caption provider for item
  - refreshActionsState
```
protected void refreshActionsState()
```
  - createDataGridDataProvider
```
protected TreeDataProvider<E> createDataGridDataProvider(TreeItems<E> treeItems)
```
  - addAction
```
public void addAction(Action action)
```
    Description copied from interface: ActionsHolder
    
    Add an action to the component
    
    Specified by:
    
    addAction in interface ActionsHolder
  - addAction
```
public void addAction(Action action,
                      int index)
```
    Description copied from interface: ActionsHolder
    
    Add an action to the component with index.
    
    Specified by:
    
    addAction in interface ActionsHolder
  - createContextMenuItem
```
protected AbstractDataGrid.ActionMenuItemWrapper createContextMenuItem(Action action)
```
  - attachAction
```
protected void attachAction(Action action)
```
  - removeAction
```
public void removeAction(Action action)
```
    Description copied from interface: ActionsHolder
    
    Remove the action from the component
    
    Specified by:
    
    removeAction in interface ActionsHolder
  - removeAction
```
public void removeAction(java.lang.String id)
```
    Description copied from interface: ActionsHolder
    
    Remove the action by its ID. If there is no action with that ID, nothing happens.
    
    Specified by:
    
    removeAction in interface ActionsHolder
  - removeAllActions
```
public void removeAllActions()
```
    Description copied from interface: ActionsHolder
    
    Remove all actions from the component
    
    Specified by:
    
    removeAllActions in interface ActionsHolder
  - getActions
```
public java.util.Collection<Action> getActions()
```
    Specified by:
    
    getActions in interface ActionsHolder
    
    Returns:
    
    unmodifiable collection of actions
  - getAction
```
@Nullable
public Action getAction(java.lang.String id)
```
    Specified by:
    
    getAction in interface ActionsHolder
    
    Returns:
    
    an action by its ID, or null if not found
  - getActionsPermissions
```
public ActionsPermissions getActionsPermissions()
```
    Specified by:
    
    getActionsPermissions in interface SecuredActionsHolder
    
    Returns:
    
    permissions container
  - treeSourceItemSetChanged
```
public void treeSourceItemSetChanged(TreeItems.ItemSetChangeEvent<E> event)
```
    Specified by:
    
    treeSourceItemSetChanged in interface TreeSourceEventsDelegate<E>
  - treeSourcePropertyValueChanged
```
public void treeSourcePropertyValueChanged(TreeItems.ValueChangeEvent<E> event)
```
    Specified by:
    
    treeSourcePropertyValueChanged in interface TreeSourceEventsDelegate<E>
  - treeSourceStateChanged
```
public void treeSourceStateChanged(DataUnit.StateChangeEvent event)
```
    Specified by:
    
    treeSourceStateChanged in interface TreeSourceEventsDelegate<E>
  - treeSourceSelectedItemChanged
```
public void treeSourceSelectedItemChanged(TreeItems.SelectedItemChangeEvent<E> event)
```
    Specified by:
    
    treeSourceSelectedItemChanged in interface TreeSourceEventsDelegate<E>
  - collapseTree
```
public void collapseTree()
```
    Description copied from interface: Tree
    
    Collapses tree nodes.
    
    Specified by:
    
    collapseTree in interface Tree<E>
  - expandTree
```
public void expandTree()
```
    Description copied from interface: Tree
    
    Expands all tree nodes.
    
    Specified by:
    
    expandTree in interface Tree<E>
  - collapse
```
public void collapse(E item)
```
    Description copied from interface: Tree
    
    Collapses all tree nodes that are lower in level than a given item.
    
    Specified by:
    
    collapse in interface Tree<E>
    
    Parameters:
    
    item - an item
  - expand
```
public void expand(E item)
```
    Description copied from interface: Tree
    
    Expands all tree nodes that are higher in level that a given item.
    
    Specified by:
    
    expand in interface Tree<E>
    
    Parameters:
    
    item - an item
  - expandUpTo
```
public void expandUpTo(int level)
```
    Description copied from interface: Tree
    
    Expands tree including specified level
    
    Specified by:
    
    expandUpTo in interface Tree<E>
    
    Parameters:
    
    level - level of Tree nodes to expand, if passed level = 1 then root items will be expanded
  - isExpanded
```
public boolean isExpanded(java.lang.Object itemId)
```
    Description copied from interface: Tree
    
    Returns whether an item with given itemId is expanded or collapsed.
    
    Specified by:
    
    isExpanded in interface Tree<E>
    
    Parameters:
    
    itemId - item id to check
    
    Returns:
    
    true if the item with itemId is expanded, false if collapsed
  - getCaption
```
@Nullable
public java.lang.String getCaption()
```
    Specified by:
    
    getCaption in interface Component.HasCaption
    
    Overrides:
    
    getCaption in class AbstractComponent<JmixTree<E>>
    
    Returns:
    
    the caption of the component
  - setCaption
```
public void setCaption(@Nullable
                       java.lang.String caption)
```
    Description copied from interface: Component.HasCaption
    
    Sets the component's caption.
    
    Specified by:
    
    setCaption in interface Component.HasCaption
    
    Overrides:
    
    setCaption in class AbstractComponent<JmixTree<E>>
    
    Parameters:
    
    caption - the new component's caption
  - isCaptionAsHtml
```
public boolean isCaptionAsHtml()
```
    Specified by:
    
    isCaptionAsHtml in interface HasHtmlCaption
    
    Overrides:
    
    isCaptionAsHtml in class AbstractComponent<JmixTree<E>>
    
    Returns:
    
    true if the caption is rendered as HTML, false if rendered as plain text
  - setCaptionAsHtml
```
public void setCaptionAsHtml(boolean captionAsHtml)
```
    Description copied from interface: HasHtmlCaption
    
    Sets whether the caption is rendered as HTML.
    
    Specified by:
    
    setCaptionAsHtml in interface HasHtmlCaption
    
    Overrides:
    
    setCaptionAsHtml in class AbstractComponent<JmixTree<E>>
    
    Parameters:
    
    captionAsHtml - true if the caption is rendered as HTML, false if rendered as plain text
    
    See Also:
    
    Component.HasCaption.setCaption(String)
  - getDescription
```
@Nullable
public java.lang.String getDescription()
```
    Specified by:
    
    getDescription in interface Component.HasDescription
    
    Overrides:
    
    getDescription in class AbstractComponent<JmixTree<E>>
    
    Returns:
    
    the components description, used in tooltips
  - setDescription
```
public void setDescription(@Nullable
                           java.lang.String description)
```
    Description copied from interface: Component.HasDescription
    
    Sets the component's description.
    
    Specified by:
    
    setDescription in interface Component.HasDescription
    
    Overrides:
    
    setDescription in class AbstractComponent<JmixTree<E>>
    
    Parameters:
    
    description - the new description to set
  - getInnerComponents
```
public java.util.Collection<Component> getInnerComponents()
```
    Specified by:
    
    getInnerComponents in interface HasInnerComponents
  - getButtonsPanel
```
@Nullable
public ButtonsPanel getButtonsPanel()
```
    Specified by:
    
    getButtonsPanel in interface HasButtonsPanel
    
    Returns:
    
    a buttons panel component.
  - getComposition
```
public com.vaadin.ui.Component getComposition()
```
    Specified by:
    
    getComposition in interface Component.Wrapper
    
    Overrides:
    
    getComposition in class AbstractComponent<JmixTree<E>>
  - setButtonsPanel
```
public void setButtonsPanel(@Nullable
                            ButtonsPanel panel)
```
    Description copied from interface: HasButtonsPanel
    
    Sets a ButtonsPanel component.
    
    Specified by:
    
    setButtonsPanel in interface HasButtonsPanel
    
    Parameters:
    
    panel - a buttons panel component
  - createTopPanel
```
protected com.vaadin.ui.HorizontalLayout createTopPanel()
```
  - updateCompositionStylesTopPanelVisible
```
protected void updateCompositionStylesTopPanelVisible()
```
  - handleClickAction
```
protected void handleClickAction()
```
  - setLookupSelectHandler
```
public void setLookupSelectHandler(java.util.function.Consumer<java.util.Collection<E>> selectHandler)
```
    Specified by:
    
    setLookupSelectHandler in interface LookupComponent<E>
    
    Parameters:
    
    selectHandler - handler that should be executed when a user select an item in the lookup screen
  - getLookupSelectedItems
```
public java.util.Collection<E> getLookupSelectedItems()
```
    Specified by:
    
    getLookupSelectedItems in interface LookupComponent<E>
    
    Returns:
    
    items selected in lookup component
  - setStyleName
```
public void setStyleName(@Nullable
                         java.lang.String name)
```
    Description copied from interface: Component
    
    Sets one or more style names of the component, replacing any previous styles. Multiple styles can be specified as a space-separated list of style names. Styles implementation is client-type-specific.
    
    Specified by:
    
    setStyleName in interface Component
    
    Overrides:
    
    setStyleName in class AbstractComponent<JmixTree<E>>
    
    Parameters:
    
    name - one or more style names separated by space.
  - getStyleName
```
public java.lang.String getStyleName()
```
    Description copied from interface: Component
    
    Styles implementation is client-type-specific.
    
    Specified by:
    
    getStyleName in interface Component
    
    Overrides:
    
    getStyleName in class AbstractComponent<JmixTree<E>>
    
    Returns:
    
    current style name.
  - setStyleProvider
```
public void setStyleProvider(@Nullable
                             java.util.function.Function<? super E,java.lang.String> styleProvider)
```
    Description copied from interface: Tree
    
    Sets a single style provider for tree items.
    
    Specified by:
    
    setStyleProvider in interface Tree<E>
    
    Parameters:
    
    styleProvider - a style provider to set
  - addStyleProvider
```
public void addStyleProvider(java.util.function.Function<? super E,java.lang.String> styleProvider)
```
    Description copied from interface: Tree
    
    Adds a style provider for tree items.
    
    Specified by:
    
    addStyleProvider in interface Tree<E>
    
    Parameters:
    
    styleProvider - a style provider to add
  - removeStyleProvider
```
public void removeStyleProvider(java.util.function.Function<? super E,java.lang.String> styleProvider)
```
    Description copied from interface: Tree
    
    Removes a previously added style provider.
    
    Specified by:
    
    removeStyleProvider in interface Tree<E>
    
    Parameters:
    
    styleProvider - a style provider to remove
  - updateStyleGenerator
```
protected void updateStyleGenerator()
```
  - getGeneratedStyle
```
@Nullable
protected java.lang.String getGeneratedStyle(E item)
```
  - repaint
```
public void repaint()
```
    Description copied from interface: Tree
    
    Repaints UI representation of the tree including style providers and icon providers without refreshing the tree data.
    
    Specified by:
    
    repaint in interface Tree<E>
  - setIconProvider
```
public void setIconProvider(@Nullable
                            java.util.function.Function<? super E,java.lang.String> iconProvider)
```
    Description copied from interface: Tree
    
    Sets the icon provider for the tree.
    
    Specified by:
    
    setIconProvider in interface Tree<E>
    
    Parameters:
    
    iconProvider - an icon provider to set
  - getItemIcon
```
@Nullable
protected com.vaadin.server.Resource getItemIcon(@Nullable
                                                           E item)
```
  - setEnterPressAction
```
public void setEnterPressAction(@Nullable
                                Action action)
```
    Description copied from interface: Tree
    
    Sets the action to be executed on Enter key press.
    
    Specified by:
    
    setEnterPressAction in interface Tree<E>
    
    Parameters:
    
    action - a new action
  - getEnterPressAction
```
@Nullable
public Action getEnterPressAction()
```
    Specified by:
    
    getEnterPressAction in interface Tree<E>
    
    Returns:
    
    an Enter key press action
  - isContextMenuEnabled
```
public boolean isContextMenuEnabled()
```
    Specified by:
    
    isContextMenuEnabled in interface Tree<E>
    
    Returns:
    
    true if context menu is enabled, false otherwise
  - setContextMenuEnabled
```
public void setContextMenuEnabled(boolean contextMenuEnabled)
```
    Description copied from interface: Tree
    
    Sets whether or not context menu is enabled. Default value is true.
    
    Specified by:
    
    setContextMenuEnabled in interface Tree<E>
    
    Parameters:
    
    contextMenuEnabled - specifies whether context menu is enabled
  - getTabIndex
```
public int getTabIndex()
```
    Description copied from interface: Component.Focusable
    
    Gets the tabulator index of the HasTabIndex component.
    
    Specified by:
    
    getTabIndex in interface Component.Focusable
    
    Returns:
    
    tab index set for the HasTabIndex component
  - setTabIndex
```
public void setTabIndex(int tabIndex)
```
    Description copied from interface: Component.Focusable
    
    Sets the tabulator index of the Focusable component. The tab index property is used to specify the order in which the fields are focused when the user presses the Tab key. Components with a defined tab index are focused sequentially first, and then the components with no tab index.
    
    Specified by:
    
    setTabIndex in interface Component.Focusable
    
    Parameters:
    
    tabIndex - tab index
  - getSelectionMode
```
public Tree.SelectionMode getSelectionMode()
```
    Specified by:
    
    getSelectionMode in interface Tree<E>
    
    Returns:
    
    the currently used Tree.SelectionMode
  - setSelectionMode
```
public void setSelectionMode(Tree.SelectionMode selectionMode)
```
    Description copied from interface: Tree
    
    Sets the Tree's selection mode.
    
    Specified by:
    
    setSelectionMode in interface Tree<E>
    
    Parameters:
    
    selectionMode - the selection mode to use
  - setRowHeight
```
public void setRowHeight(double rowHeight)
```
    Description copied from interface: Tree
    
    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.
    
    Specified by:
    
    setRowHeight in interface Tree<E>
    
    Parameters:
    
    rowHeight - The height of a row in pixels or -1 for automatic calculation
  - setDescriptionProvider
```
public void setDescriptionProvider(@Nullable
                                   java.util.function.Function<? super E,java.lang.String> provider)
```
    Description copied from interface: Tree
    
    Sets the description generator that is used for generating tooltip descriptions for items.
    
    Specified by:
    
    setDescriptionProvider in interface Tree<E>
    
    Parameters:
    
    provider - the description generator to use or null to remove a previously set provider if any
  - setDescriptionProvider
```
public void setDescriptionProvider(@Nullable
                                   java.util.function.Function<? super E,java.lang.String> provider,
                                   ContentMode contentMode)
```
    Description copied from interface: Tree
    
    Sets the description generator that is used for generating HTML tooltip descriptions for items.
    
    Specified by:
    
    setDescriptionProvider in interface Tree<E>
    
    Parameters:
    
    provider - the description generator to use or null to remove a previously set provider if any
    
    contentMode - the content mode for row tooltips
  - getRowDescription
```
@Nullable
protected java.lang.String getRowDescription(E item)
```
  - getDescriptionProvider
```
@Nullable
public java.util.function.Function<E,java.lang.String> getDescriptionProvider()
```
    Description copied from interface: Tree
    
    Gets the item description generator.
    
    Specified by:
    
    getDescriptionProvider in interface Tree<E>
    
    Returns:
    
    the item description generator
  - getContentMode
```
public ContentMode getContentMode()
```
    Specified by:
    
    getContentMode in interface Tree<E>
    
    Returns:
    
    the content mode of the item captions
  - setContentMode
```
public void setContentMode(ContentMode contentMode)
```
    Description copied from interface: Tree
    
    Sets the content mode of the item captions.
    
    Specified by:
    
    setContentMode in interface Tree<E>
    
    Parameters:
    
    contentMode - the content mode
  - getDetailsGenerator
```
@Nullable
public java.util.function.Function<E,Component> getDetailsGenerator()
```
    Specified by:
    
    getDetailsGenerator in interface Tree<E>
    
    Returns:
    
    the current details generator for item details or null if not set
  - setDetailsGenerator
```
public void setDetailsGenerator(@Nullable
                                java.util.function.Function<E,Component> generator)
```
    Description copied from interface: Tree
    
    Sets a new details generator for item details.
    The currently opened item details will be re-rendered.
    
    Specified by:
    
    setDetailsGenerator in interface Tree<E>
    
    Parameters:
    
    generator - the details generator to set
  - getItemDetails
```
@Nullable
protected com.vaadin.ui.Component getItemDetails(E entity)
```
  - isDetailsVisible
```
public boolean isDetailsVisible(E entity)
```
    Description copied from interface: Tree
    
    Checks whether details are visible for the given item.
    
    Specified by:
    
    isDetailsVisible in interface Tree<E>
    
    Parameters:
    
    entity - the item for which to check details visibility
    
    Returns:
    
    true if the details are visible
  - setDetailsVisible
```
public void setDetailsVisible(E entity,
                              boolean visible)
```
    Description copied from interface: Tree
    
    Shows or hides the details for a specific item.
    
    Specified by:
    
    setDetailsVisible in interface Tree<E>
    
    Parameters:
    
    entity - the item for which to set details visibility
    
    visible - true to show the details, or false to hide them
  - addExpandListener
```
public io.jmix.core.common.event.Subscription addExpandListener(java.util.function.Consumer<Tree.ExpandEvent<E>> listener)
```
    Description copied from interface: Tree
    
    Registers a new expand listener.
    
    Specified by:
    
    addExpandListener in interface Tree<E>
    
    Parameters:
    
    listener - the listener to be added
    
    Returns:
    
    a registration object for removing an event listener added to a source
  - onItemExpand
```
protected void onItemExpand(com.vaadin.event.ExpandEvent<E> e)
```
  - addCollapseListener
```
public io.jmix.core.common.event.Subscription addCollapseListener(java.util.function.Consumer<Tree.CollapseEvent<E>> listener)
```
    Description copied from interface: Tree
    
    Registers a new collapse listener.
    
    Specified by:
    
    addCollapseListener in interface Tree<E>
    
    Parameters:
    
    listener - the listener to be added
    
    Returns:
    
    a registration object for removing an event listener added to a source
  - onItemCollapse
```
protected void onItemCollapse(com.vaadin.event.CollapseEvent<E> e)
```
  - onSelectionChange
```
protected void onSelectionChange(com.vaadin.event.selection.SelectionEvent<E> event)
```
  - fireSelectionEvent
```
protected void fireSelectionEvent(com.vaadin.event.selection.SelectionEvent<E> e)
```
  - isMultiSelect
```
public boolean isMultiSelect()
```
    Specified by:
    
    isMultiSelect in interface ListComponent<E>
    
    Returns:
    
    true if multiple selection mode is enabled
  - getSingleSelected
```
@Nullable
public E getSingleSelected()
```
    Description copied from interface: ListComponent
    
    Returns an instance of entity corresponding to the selected row of the list component. If nothing is selected, the method returns null. If multiple selection mode is enabled, returns the first selected instance.
    
    Specified by:
    
    getSingleSelected in interface ListComponent<E>
    
    Returns:
    
    an instance of entity corresponding to the selected row of the list component
  - getSelected
```
public java.util.Set<E> getSelected()
```
    Description copied from interface: ListComponent
    
    Returns a set of entity instances corresponding to the selected rows of the list component. If nothing is selected, the method returns a Collections.emptySet().
    
    Specified by:
    
    getSelected in interface ListComponent<E>
    
    Returns:
    
    a set of entity instances corresponding to the selected rows of the list component
  - setSelected
```
public void setSelected(@Nullable
                        E item)
```
    Description copied from interface: ListComponent
    
    Selects a row of the list component for a given entity instance.
    
    Specified by:
    
    setSelected in interface ListComponent<E>
    
    Parameters:
    
    item - entity instance to select the row, null to reset the selection
  - setSelected
```
public void setSelected(java.util.Collection<E> items)
```
    Description copied from interface: ListComponent
    
    Selects the rows of the list component for a given collection of entity instances.
    
    Specified by:
    
    setSelected in interface ListComponent<E>
    
    Parameters:
    
    items - collection of entity instances to select rows
  - setSelectedInternal
```
protected void setSelectedInternal(java.util.Collection<E> items)
```
  - addSelectionListener
```
public io.jmix.core.common.event.Subscription addSelectionListener(java.util.function.Consumer<Tree.SelectionEvent<E>> listener)
```
    Description copied from interface: Tree
    
    Registers a new selection listener.
    
    Specified by:
    
    addSelectionListener in interface Tree<E>
    
    Parameters:
    
    listener - the listener to register
  - addLookupValueChangeListener
```
public io.jmix.core.common.event.Subscription addLookupValueChangeListener(java.util.function.Consumer<LookupComponent.LookupSelectionChangeEvent<E>> listener)
```
    Description copied from interface: LookupComponent.LookupSelectionChangeNotifier
    
    Adds a listener that invoked when lookup selected items set is changed.
    
    Specified by:
    
    addLookupValueChangeListener in interface LookupComponent.LookupSelectionChangeNotifier<E>
    
    Parameters:
    
    listener - a listener to add
    
    Returns:
    
    Subscription
  - focus
```
public void focus()
```
    Description copied from interface: Component.Focusable
    
    Sets focus to this component
    
    Specified by:
    
    focus in interface Component.Focusable

Class TreeImpl<E>

Nested Class Summary

Nested classes/interfaces inherited from interface io.jmix.ui.component.Tree

Nested classes/interfaces inherited from interface io.jmix.ui.component.Component

Nested classes/interfaces inherited from interface io.jmix.ui.component.HasContextHelp

Nested classes/interfaces inherited from interface io.jmix.ui.component.LookupComponent

Field Summary

Fields inherited from class io.jmix.ui.component.impl.AbstractComponent

Fields inherited from interface io.jmix.ui.component.Tree

Fields inherited from interface io.jmix.ui.component.Component

Constructor Summary

Method Summary

Methods inherited from class io.jmix.ui.component.impl.AbstractComponent

Methods inherited from class java.lang.Object

Methods inherited from interface io.jmix.ui.component.Tree

Methods inherited from interface io.jmix.ui.component.Component.BelongToFrame

Methods inherited from interface io.jmix.ui.component.ActionsHolder

Methods inherited from interface io.jmix.ui.component.Component

Methods inherited from interface io.jmix.ui.component.Component.HasIcon

Methods inherited from interface io.jmix.ui.component.Component.Focusable

Methods inherited from interface io.jmix.ui.component.HasContextHelp

Methods inherited from interface io.jmix.ui.component.HasHtmlDescription

Methods inherited from interface io.jmix.ui.component.HasHtmlSanitizer

Field Detail

internalStyles

styleProviders

styleGenerator

contextMenu

contextMenuItems

buttonsPanel

topPanel

componentComposition

enterPressAction

iconProvider

metadata

accessManager

iconResolver

metadataTools

actions

uiTestIdsSupport

selectionMode

doubleClickAction

itemClickListener

actionList

shortcutsDelegate

actionsPermissions

showIconsForPopupMenuActions

hierarchyProperty

dataBinding

itemCaptionProvider

descriptionProvider

detailsGenerator

expandListener

collapseListener

Constructor Detail

TreeImpl

Method Detail

createComponent

createShortcutsDelegate

afterPropertiesSet

initComponentComposition

initComponent

createComponentComposition

createEnterShortcutListener

generateItemCaption

initContextMenu

setAccessManager

setIconResolver

setMetadata

setMetadataTools

setThemeConstantsManager

setActions

setUiTestIdsSupport

getItems

setItems

setUiTestId

setDebugId

setId

createEmptyDataProvider

getHierarchyProperty