Tree (domino-ui 1.0.0-RC13 API)

java.lang.Object
- org.dominokit.domino.ui.utils.BaseDominoElement<elemental2.dom.HTMLDivElement,Tree<T>>
- - org.dominokit.domino.ui.tree.Tree<T>

Type Parameters:: T - the type of the object

All Implemented Interfaces:: DominoStyle<elemental2.dom.HTMLDivElement,Tree<T>,Tree<T>>, HasChildren<Tree<T>>, HasWavesElement, IsCollapsible<Tree<T>>, IsReadOnly<Tree<T>>, ParentTreeItem<TreeItem<T>>, org.jboss.elemento.IsElement<elemental2.dom.HTMLDivElement>

public class Tree<T>
extends BaseDominoElement<elemental2.dom.HTMLDivElement,Tree<T>>
implements ParentTreeItem<TreeItem<T>>, org.jboss.elemento.IsElement<elemental2.dom.HTMLDivElement>

A component provides a tree representation of elements

Customize the component can be done by overwriting classes provided by TreeStyles

For example:

     Tree hardwareTree =
         Tree.create("HARDWARE")
             .setToggleTarget(ToggleTarget.ICON)
             .addItemClickListener((treeItem) -> DomGlobal.console.info(treeItem.getValue()))
             .appendChild(
                 TreeItem.create("Computer", Icons.ALL.laptop_mdi())
                     .addClickListener((evt) -> Notification.create("Computer").show()))
             .appendChild(
                 TreeItem.create("Headset", Icons.ALL.headset_mdi())
                     .addClickListener((evt) -> Notification.create("Headset").show()))
             .appendChild(
                 TreeItem.create("Keyboard", Icons.ALL.keyboard_mdi())
                     .addClickListener((evt) -> Notification.create("Keyboard").show()))
             .appendChild(
                 TreeItem.create("Mouse", Icons.ALL.mouse_mdi())
                     .addClickListener((evt) -> Notification.create("Mouse").show()))
             .addSeparator()
             .appendChild(
                 TreeItem.create("Laptop", Icons.ALL.laptop_mdi())
                     .addClickListener((evt) -> Notification.create("Laptop").show()))
             .appendChild(
                 TreeItem.create("Smart phone", Icons.ALL.cellphone_mdi())
                     .addClickListener((evt) -> Notification.create("Smart phone").show()))
             .appendChild(
                 TreeItem.create("Tablet", Icons.ALL.tablet_mdi())
                     .addClickListener((evt) -> Notification.create("Tablet").show()))
             .appendChild(
                 TreeItem.create("Speaker", Icons.ALL.speaker_mdi())
                     .addClickListener((evt) -> Notification.create("Speaker").show()));

See Also:: BaseDominoElement, ParentTreeItem

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface Tree.ItemClickListener<T>
A listener to be called when clicking on item
- Nested classes/interfaces inherited from class org.dominokit.domino.ui.utils.BaseDominoElement
  BaseDominoElement.ElementHandler<T>, BaseDominoElement.ResizeHandler<T>, BaseDominoElement.StyleEditor<E extends elemental2.dom.HTMLElement,T extends org.jboss.elemento.IsElement<E>>, BaseDominoElement.WavesStyler

Nested Classes
Modifier and Type	Class and Description
`static interface`	`Tree.ItemClickListener<T>` A listener to be called when clicking on item

Field Summary
- Fields inherited from class org.dominokit.domino.ui.utils.BaseDominoElement
  element

Constructor Summary

Constructors
Constructor and Description

Tree()

Tree(String treeTitle)

Tree(String treeTitle, T value)

Tree(T value)

Constructors
Constructor and Description
`Tree()`
`Tree(String treeTitle)`
`Tree(String treeTitle, T value)`
`Tree(T value)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`activate()` Activates the item
`void`	`activate(boolean activateParent)` Activates the item
`Tree<T>`	`addGap()` Adds spaces between items
`Tree<T>`	`addItemClickListener(Tree.ItemClickListener<T> itemClickListener)` Adds a click listener to be called when item is clicked
`Tree<T>`	`addSeparator()` Adds a new separator
`Tree<T>`	`appendChild(TreeItem<T> treeItem)` Adds a new tree item
`Tree<T>`	`autoExpandFound()` Expand the items found by the search automatically
`Tree<T>`	`autoHeight()` Sets the height of the tree to be automatic based on the content
`Tree<T>`	`autoHeight(int offset)` Sets the height of the tree to be automatic based on the content with an offset
`void`	`clearFilter()` Clears all the filters
`void`	`collapseAll()` Collapse all items
`static Tree<String>`	`create()`
`static Tree<String>`	`create(String title)`
`static <T> Tree<T>`	`create(String title, T value)`
`static <T> Tree<T>`	`create(T value)`
`void`	`deactivateAll()` Deactivate all items
`elemental2.dom.HTMLDivElement`	`element()`
`Tree<T>`	`enableFolding()` Adds the ability to expand/collapse all items
`Tree<T>`	`enableSearch()` Enables the search
`Tree<T>`	`expand()` Expands the tree item
`Tree<T>`	`expand(boolean expandParent)` Expands the tree item
`void`	`expandAll()` Expand all items
`void`	`filter(String searchToken)` Filter based on the search query
`TreeItem<T>`	`getActiveItem()`
`List<TreeItem<T>>`	`getActivePath()`
`List<T>`	`getActivePathValues()`
`Icon`	`getCollapseAllIcon()`
`CollapseStrategy`	`getCollapseStrategy()`
`Icon`	`getExpandAllIcon()`
`TreeItemFilter<TreeItem<T>>`	`getFilter()`
`DominoElement<elemental2.dom.HTMLLIElement>`	`getHeader()`
`Optional<TreeItem<T>>`	`getParent()`
`DominoElement<elemental2.dom.HTMLUListElement>`	`getRoot()`
`Search`	`getSearch()`
`Icon`	`getSearchIcon()`
`List<TreeItem<T>>`	`getSubItems()`
`DominoElement<elemental2.dom.HTMLElement>`	`getTitle()`
`Tree<T>`	`getTreeRoot()`
`T`	`getValue()`
`boolean`	`isAutoCollapse()`
`boolean`	`isAutoExpandFound()`
`void`	`removeItem(TreeItem<T> item)` Removes item
`Tree<T>`	`removeItemClickListener(Tree.ItemClickListener<T> itemClickListener)` Removes a click listener
`void`	`setActiveItem(TreeItem<T> activeItem)` Activates the item representing the value
`void`	`setActiveItem(TreeItem<T> activeItem, boolean silent)` Activates the item representing the value
`Tree<T>`	`setAutoCollapse(boolean autoCollapse)` Sets if item should be collapsed automatically when it is deactivated
`void`	`setAutoExpandFound(boolean autoExpandFound)` Sets if the items found by the search should be expanded automatically
`Tree<T>`	`setCollapseStrategy(CollapseStrategy collapseStrategy)` Change the `CollapseStrategy` for the element
`Tree<T>`	`setColorScheme(ColorScheme colorScheme)` Sets the color scheme for the tree
`Tree<T>`	`setFilter(TreeItemFilter<TreeItem<T>> filter)` Sets the filter that will be used when searching items, the default filter searches using the title of the items
`Tree<T>`	`setLevelPadding(int levelPadding)` Sets level padding for item
`Tree<T>`	`setTitle(String title)` Sets the title of the tree
`Tree<T>`	`setToggleTarget(ToggleTarget toggleTarget)` Sets what is the target for toggling an item
`void`	`setValue(T value)` Sets the value

Methods inherited from class org.dominokit.domino.ui.utils.BaseDominoElement
add, add, addClickListener, addCss, addCss, addEventListener, addEventListener, addEventsListener, addHideListener, addShowListener, alignCenter, alignRight, appendChild, appendChild, apply, attr, blur, childNodes, clearElement, contains, contains, contains, containsCss, css, css, cssClassByIndex, cssClassesCount, cssText, disable, elevate, elevate, enable, firstChild, getAttachObserver, getAttribute, getBoundingClientRect, getChildElementCount, getClickableElement, getCollapsible, getCollapsibleElement, getDetachObserver, getDominoId, getElementsCount, getElevation, getFirstChild, getId, getTextContent, getTooltip, getWavesElement, hasAttribute, hasChildNodes, hasDirectChild, hide, hideOn, id, init, insertAfter, insertAfter, insertAfter, insertAfter, insertBefore, insertBefore, insertBefore, insertBefore, insertFirst, insertFirst, insertFirst, isAttached, isCollapsed, isDisabled, isEmptyElement, isEqualNode, isForceHidden, isHidden, isReadOnly, item, lastChild, length, onAttached, onDetached, onResize, pullLeft, pullRight, querySelector, querySelectorAll, remove, removeAttachObserver, removeAttribute, removeChild, removeChild, removeCss, removeCss, removeCssProperty, removeDetachObserver, removeEventListener, removeEventListener, removeHideListener, removeHideOn, removeShowListener, removeShowOn, removeTooltip, removeWaves, replaceCss, setAlignItems, setAttribute, setAttribute, setAttribute, setBackgroundColor, setBackgroundColor, setBorder, setBorderColor, setBottom, setBottom, setBoxShadow, setColor, setColor, setContent, setContent, setCssProperty, setCssProperty, setCursor, setCursor, setDisabled, setDisplay, setDisplay, setDropMenu, setFlex, setFloat, setFloat, setFontSize, setFontSize, setForceHidden, setHeight, setHeight, setId, setInnerHtml, setLeft, setLeft, setLineHeight, setLineHeight, setMargin, setMargin, setMarginBottom, setMarginBottom, setMarginLeft, setMarginLeft, setMarginRight, setMarginRight, setMarginTop, setMarginTop, setMaxHeight, setMaxHeight, setMaxWidth, setMaxWidth, setMinHeight, setMinHeight, setMinWidth, setMinWidth, setOpacity, setOpacity, setOverFlow, setOverFlow, setOverFlowY, setPadding, setPadding, setPaddingBottom, setPaddingBottom, setPaddingLeft, setPaddingLeft, setPaddingRight, setPaddingRight, setPaddingTop, setPaddingTop, setPointerEvents, setPosition, setPosition, setReadOnly, setRight, setRight, setTabIndex, setTextAlign, setTextAlign, setTextContent, setTooltip, setTooltip, setTooltip, setTooltip, setTop, setTop, setTransitionDuration, setWidth, setWidth, setZIndex, show, showOn, style, style, styler, textContent, toggleDisplay, toggleDisplay, withWaves, withWaves

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

Methods inherited from interface org.dominokit.domino.ui.utils.IsCollapsible
isExpanded

Methods inherited from interface org.dominokit.domino.ui.style.DominoStyle
add, add, remove, remove, removeProperty, replace, setProperty, setProperty

- Constructor Detail
  - Tree
```
public Tree()
```
  - Tree
```
public Tree(String treeTitle)
```
  - Tree
```
public Tree(String treeTitle,
            T value)
```
  - Tree
```
public Tree(T value)
```
- Method Detail
  - create
```
public static Tree<String> create(String title)
```
    Parameters:
    
    title - the title of the tree
    
    Returns:
    
    new instance
  - create
```
public static Tree<String> create()
```
    Returns:
    
    new instance without title
  - create
```
public static <T> Tree<T> create(String title,
                                 T value)
```
    Type Parameters:
    
    T - the type of the object
    
    Parameters:
    
    title - the title of the tree
    
    value - the default selected value
    
    Returns:
    
    new instance
  - create
```
public static <T> Tree<T> create(T value)
```
    Type Parameters:
    
    T - the type of the object
    
    Parameters:
    
    value - the default selected value
    
    Returns:
    
    new instance
  - appendChild
```
public Tree<T> appendChild(TreeItem<T> treeItem)
```
    Adds a new tree item
    
    Parameters:
    
    treeItem - a new TreeItem
    
    Returns:
    
    same instance
  - addSeparator
```
public Tree<T> addSeparator()
```
    Adds a new separator
    
    Returns:
    
    same instance
  - addGap
```
public Tree<T> addGap()
```
    Adds spaces between items
    
    Returns:
    
    same instance
  - setToggleTarget
```
public Tree<T> setToggleTarget(ToggleTarget toggleTarget)
```
    Sets what is the target for toggling an item
    
    Parameters:
    
    toggleTarget - the ToggleTarget
    
    Returns:
    
    same instance
  - setLevelPadding
```
public Tree<T> setLevelPadding(int levelPadding)
```
    Sets level padding for item
    
    Parameters:
    
    levelPadding - string with padding for item
    
    Returns:
    
    same instance
  - setColorScheme
```
public Tree<T> setColorScheme(ColorScheme colorScheme)
```
    Sets the color scheme for the tree
    
    Parameters:
    
    colorScheme - the ColorScheme
    
    Returns:
    
    same instance
  - getActiveItem
```
public TreeItem<T> getActiveItem()
```
    Specified by:
    
    getActiveItem in interface ParentTreeItem<TreeItem<T>>
    
    Returns:
    
    The current active value
  - setActiveItem
```
public void setActiveItem(TreeItem<T> activeItem)
```
    Activates the item representing the value
    
    Specified by:
    
    setActiveItem in interface ParentTreeItem<TreeItem<T>>
    
    Parameters:
    
    activeItem - the value of the item to activate
  - setActiveItem
```
public void setActiveItem(TreeItem<T> activeItem,
                          boolean silent)
```
    Activates the item representing the value
    
    Specified by:
    
    setActiveItem in interface ParentTreeItem<TreeItem<T>>
    
    Parameters:
    
    activeItem - the value of the item to activate
    
    silent - true to not notify listeners
  - getHeader
```
public DominoElement<elemental2.dom.HTMLLIElement> getHeader()
```
    Returns:
    
    the header element
  - getRoot
```
public DominoElement<elemental2.dom.HTMLUListElement> getRoot()
```
    Returns:
    
    the root element
  - getTitle
```
public DominoElement<elemental2.dom.HTMLElement> getTitle()
```
    Returns:
    
    the title element
  - autoHeight
```
public Tree<T> autoHeight()
```
    Sets the height of the tree to be automatic based on the content
    
    Returns:
    
    same instance
  - autoHeight
```
public Tree<T> autoHeight(int offset)
```
    Sets the height of the tree to be automatic based on the content with an offset
    
    Parameters:
    
    offset - the offset value
    
    Returns:
    
    same instance
  - enableSearch
```
public Tree<T> enableSearch()
```
    Enables the search
    
    Returns:
    
    same instance
  - enableFolding
```
public Tree<T> enableFolding()
```
    Adds the ability to expand/collapse all items
    
    Returns:
    
    same instance
  - expandAll
```
public void expandAll()
```
    Expand all items
  - collapseAll
```
public void collapseAll()
```
    Collapse all items
  - deactivateAll
```
public void deactivateAll()
```
    Deactivate all items
  - autoExpandFound
```
public Tree<T> autoExpandFound()
```
    Expand the items found by the search automatically
    
    Returns:
    
    same instance
  - isAutoExpandFound
```
public boolean isAutoExpandFound()
```
    Specified by:
    
    isAutoExpandFound in interface ParentTreeItem<TreeItem<T>>
    
    Returns:
    
    true if automatic expanding is enabled when finding items in search
  - setAutoExpandFound
```
public void setAutoExpandFound(boolean autoExpandFound)
```
    Sets if the items found by the search should be expanded automatically
    
    Parameters:
    
    autoExpandFound - true to expand automatically, false otherwise
  - clearFilter
```
public void clearFilter()
```
    Clears all the filters
  - filter
```
public void filter(String searchToken)
```
    Filter based on the search query
    
    Parameters:
    
    searchToken - the query
  - getTreeRoot
```
public Tree<T> getTreeRoot()
```
    Specified by:
    
    getTreeRoot in interface ParentTreeItem<TreeItem<T>>
    
    Returns:
    
    The Tree
  - setAutoCollapse
```
public Tree<T> setAutoCollapse(boolean autoCollapse)
```
    Sets if item should be collapsed automatically when it is deactivated
    
    Parameters:
    
    autoCollapse - true to collapse automatically, false otherwise
    
    Returns:
    
    same instance
  - setTitle
```
public Tree<T> setTitle(String title)
```
    Sets the title of the tree
    
    Parameters:
    
    title - the title text
    
    Returns:
    
    same instance
  - isAutoCollapse
```
public boolean isAutoCollapse()
```
    Returns:
    
    true if deactivated items should be collapsed automatically
  - getSubItems
```
public List<TreeItem<T>> getSubItems()
```
    Specified by:
    
    getSubItems in interface ParentTreeItem<TreeItem<T>>
    
    Returns:
    
    the children of this item
  - expand
```
public Tree<T> expand(boolean expandParent)
```
    Expands the tree item
    
    Specified by:
    
    expand in interface ParentTreeItem<TreeItem<T>>
    
    Parameters:
    
    expandParent - true to expand the parent of the item
    
    Returns:
    
    same instance
  - expand
```
public Tree<T> expand()
```
    Expands the tree item
    
    Specified by:
    
    expand in interface ParentTreeItem<TreeItem<T>>
    
    Returns:
    
    same instance
  - getParent
```
public Optional<TreeItem<T>> getParent()
```
    Specified by:
    
    getParent in interface ParentTreeItem<TreeItem<T>>
    
    Returns:
    
    the parent item
  - activate
```
public void activate()
```
    Activates the item
    
    Specified by:
    
    activate in interface ParentTreeItem<TreeItem<T>>
  - activate
```
public void activate(boolean activateParent)
```
    Activates the item
    
    Specified by:
    
    activate in interface ParentTreeItem<TreeItem<T>>
    
    Parameters:
    
    activateParent - true to activate parent
  - getSearch
```
public Search getSearch()
```
    Returns:
    
    the search element
  - getSearchIcon
```
public Icon getSearchIcon()
```
    Returns:
    
    the search icon
  - getCollapseAllIcon
```
public Icon getCollapseAllIcon()
```
    Returns:
    
    the collapse all icon
  - getExpandAllIcon
```
public Icon getExpandAllIcon()
```
    Returns:
    
    the expand all icon
  - getValue
```
public T getValue()
```
    Returns:
    
    the current value
  - setValue
```
public void setValue(T value)
```
    Sets the value
    
    Parameters:
    
    value - the new value
  - addItemClickListener
```
public Tree<T> addItemClickListener(Tree.ItemClickListener<T> itemClickListener)
```
    Adds a click listener to be called when item is clicked
    
    Parameters:
    
    itemClickListener - a Tree.ItemClickListener
    
    Returns:
    
    same instance
  - removeItemClickListener
```
public Tree<T> removeItemClickListener(Tree.ItemClickListener<T> itemClickListener)
```
    Removes a click listener
    
    Parameters:
    
    itemClickListener - a Tree.ItemClickListener to be removed
    
    Returns:
    
    same instance
  - getActivePath
```
public List<TreeItem<T>> getActivePath()
```
    Returns:
    
    the list of the items in the current active path
  - getActivePathValues
```
public List<T> getActivePathValues()
```
    Returns:
    
    the list of values in the current active path
  - removeItem
```
public void removeItem(TreeItem<T> item)
```
    Removes item
    
    Specified by:
    
    removeItem in interface ParentTreeItem<TreeItem<T>>
    
    Parameters:
    
    item - the item value
  - setFilter
```
public Tree<T> setFilter(TreeItemFilter<TreeItem<T>> filter)
```
    Sets the filter that will be used when searching items, the default filter searches using the title of the items
    
    Parameters:
    
    filter - a TreeItemFilter
    
    Returns:
    
    same instance
  - getFilter
```
public TreeItemFilter<TreeItem<T>> getFilter()
```
    Specified by:
    
    getFilter in interface ParentTreeItem<TreeItem<T>>
    
    Returns:
    
    the TreeItemFilter
  - setCollapseStrategy
```
public Tree<T> setCollapseStrategy(CollapseStrategy collapseStrategy)
```
    Description copied from class: BaseDominoElement
    
    Change the CollapseStrategy for the element
    
    Overrides:
    
    setCollapseStrategy in class BaseDominoElement<elemental2.dom.HTMLDivElement,Tree<T>>
    
    Parameters:
    
    collapseStrategy - the CollapseStrategy
    
    Returns:
    
    same component
  - getCollapseStrategy
```
public CollapseStrategy getCollapseStrategy()
```
  - element
```
public elemental2.dom.HTMLDivElement element()
```
    Specified by:
    
    element in interface org.jboss.elemento.IsElement<elemental2.dom.HTMLDivElement>
    
    Specified by:
    
    element in class BaseDominoElement<elemental2.dom.HTMLDivElement,Tree<T>>
    
    Returns:
    
    the HTML element of type E which is the root element of the component

Class Tree<T>

Nested Class Summary

Nested classes/interfaces inherited from class org.dominokit.domino.ui.utils.BaseDominoElement

Field Summary

Fields inherited from class org.dominokit.domino.ui.utils.BaseDominoElement

Constructor Summary

Method Summary

Methods inherited from class org.dominokit.domino.ui.utils.BaseDominoElement

Methods inherited from class java.lang.Object

Methods inherited from interface org.dominokit.domino.ui.utils.IsCollapsible

Methods inherited from interface org.dominokit.domino.ui.style.DominoStyle

Constructor Detail

Tree

Tree

Tree

Tree

Method Detail

create

create

create

create

appendChild

addSeparator

addGap

setToggleTarget

setLevelPadding

setColorScheme

getActiveItem

setActiveItem

setActiveItem

getHeader

getRoot

getTitle

autoHeight

autoHeight

enableSearch

enableFolding

expandAll

collapseAll

deactivateAll

autoExpandFound

isAutoExpandFound

setAutoExpandFound

clearFilter

filter

getTreeRoot

setAutoCollapse

setTitle

isAutoCollapse

getSubItems

expand

expand

getParent

activate

activate

getSearch

getSearchIcon

getCollapseAllIcon

getExpandAllIcon

getValue

setValue

addItemClickListener

removeItemClickListener

getActivePath

getActivePathValues

removeItem

setFilter

getFilter

setCollapseStrategy

getCollapseStrategy

element