Package com.vaadin.componentfactory.explorer

Class ExplorerTreeGrid<T>

java.lang.Object
com.vaadin.flow.component.Component
com.vaadin.flow.component.grid.Grid<T>
com.vaadin.flow.component.treegrid.TreeGrid<T>
com.vaadin.componentfactory.explorer.ExplorerTreeGrid<T>
Type Parameters:
T - the grid bean type
All Implemented Interfaces:
com.vaadin.flow.component.AttachNotifier, com.vaadin.flow.component.BlurNotifier<com.vaadin.flow.component.grid.Grid<T>>, com.vaadin.flow.component.DetachNotifier, com.vaadin.flow.component.Focusable<com.vaadin.flow.component.grid.Grid<T>>, com.vaadin.flow.component.FocusNotifier<com.vaadin.flow.component.grid.Grid<T>>, com.vaadin.flow.component.HasElement, com.vaadin.flow.component.HasEnabled, com.vaadin.flow.component.HasSize, com.vaadin.flow.component.HasStyle, com.vaadin.flow.component.HasTheme, com.vaadin.flow.data.event.SortEvent.SortNotifier<com.vaadin.flow.component.grid.Grid<T>,com.vaadin.flow.component.grid.GridSortOrder<T>>, com.vaadin.flow.data.provider.HasDataGenerators<T>, com.vaadin.flow.data.provider.HasDataView<T,Void,com.vaadin.flow.component.grid.dataview.GridDataView<T>>, com.vaadin.flow.data.provider.HasLazyDataView<T,Void,com.vaadin.flow.component.grid.dataview.GridLazyDataView<T>>, com.vaadin.flow.data.provider.HasListDataView<T,com.vaadin.flow.component.grid.dataview.GridListDataView<T>>, com.vaadin.flow.data.provider.hierarchy.HasHierarchicalDataProvider<T>, Serializable
@Uses(com.vaadin.flow.component.icon.Icon.class) @JsModule("./src/explorer-tree-toggle.js") @JsModule("./src/explorer-grid-connector.js") public class ExplorerTreeGrid<T> extends com.vaadin.flow.component.treegrid.TreeGrid<T>
A grid component for displaying hierarchical tabular data and displaying connectors between parent and children
See Also:

  • Nested Class Summary

    Nested classes/interfaces inherited from class com.vaadin.flow.component.grid.Grid

    com.vaadin.flow.component.grid.Grid.AbstractGridExtension<T>, com.vaadin.flow.component.grid.Grid.Column<T>, com.vaadin.flow.component.grid.Grid.DataCommunicatorBuilder<T,U extends com.vaadin.flow.data.provider.ArrayUpdater>, com.vaadin.flow.component.grid.Grid.MultiSortPriority, com.vaadin.flow.component.grid.Grid.NestedNullBehavior, com.vaadin.flow.component.grid.Grid.SelectionMode, com.vaadin.flow.component.grid.Grid.SpringData, com.vaadin.flow.component.grid.Grid.UpdateQueue

    Nested classes/interfaces inherited from interface com.vaadin.flow.component.BlurNotifier

    com.vaadin.flow.component.BlurNotifier.BlurEvent<C extends com.vaadin.flow.component.Component>

    Nested classes/interfaces inherited from interface com.vaadin.flow.component.FocusNotifier

    com.vaadin.flow.component.FocusNotifier.FocusEvent<C extends com.vaadin.flow.component.Component>

  • Constructor Summary

    Constructors
    Constructor
    Description
    ExplorerTreeGrid()
     
    ExplorerTreeGrid(com.vaadin.flow.data.provider.hierarchy.HierarchicalDataProvider<T,?> dataProvider)
     
    ExplorerTreeGrid(Class<T> beanType)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    <V extends com.vaadin.flow.component.Component>
    com.vaadin.flow.component.grid.Grid.Column<T>
    addComponentHierarchyColumn(com.vaadin.flow.function.ValueProvider<T,V> componentProvider)
     
    com.vaadin.flow.component.grid.Grid.Column<T>
    addHierarchyColumn(com.vaadin.flow.function.ValueProvider<T,?> labelProvider)
    To update with prefix icon, suffix icon
    com.vaadin.flow.component.grid.Grid.Column<T>
    addHierarchyColumn(com.vaadin.flow.function.ValueProvider<T,?> labelProvider, com.vaadin.flow.function.ValueProvider<T,?> iconProvider)
    To update with prefix icon, suffix icon
    protected void
    collapse(Collection<T> items, boolean userOriginated)
     
    protected void
    expand(Collection<T> items, boolean userOriginated)
     
    protected Collection<T>
    getChildrenRecursively(Collection<T> items, int depth)
     
    protected void
    initConnector()
     
    com.vaadin.flow.component.grid.GridSelectionModel<T>
    setHierarchicalSelectionMode(com.vaadin.flow.component.grid.Grid.SelectionMode selectionMode)
     

    Methods inherited from class com.vaadin.flow.component.treegrid.TreeGrid

    addCollapseListener, addExpandListener, collapse, collapse, collapseRecursively, collapseRecursively, expand, expand, expandRecursively, expandRecursively, getDataCommunicator, getDataProvider, getGenericDataView, getItemsWithChildrenRecursively, getLazyDataView, getListDataView, isExpanded, scrollToEnd, scrollToIndex, scrollToIndex, scrollToItem, setColumns, setDataProvider, setDataProvider, setHierarchyColumn, setHierarchyColumn, setItems, setItems, setItems, setItems, setItems, setUniqueKeyDataGenerator

    Methods inherited from class com.vaadin.flow.component.grid.Grid

    addCellFocusListener, addColumn, addColumn, addColumn, addColumn, addColumn, addColumn, addColumn, addColumnReorderListener, addColumnResizeListener, addColumns, addComponentColumn, addContextMenu, addDataGenerator, addDragEndListener, addDragStartListener, addDropListener, addFirstHeaderRow, addItemClickListener, addItemDoubleClickListener, addSelectionListener, addSortListener, addThemeVariants, addValueProvider, appendFooterRow, appendHeaderRow, asMultiSelect, asSingleSelect, compareMaybeComparables, configureBeanType, createColumn, createColumnId, createDefaultArrayUpdater, createEditor, createSortingComparator, deselect, deselectAll, getAriaLabel, getArrayUpdater, getBeanType, getColumnByInternalId, getColumnByKey, getColumnLayers, getColumnRendering, getColumns, getDefaultColumnFactory, getDefaultHeaderRow, getDragFilter, getDropFilter, getDropMode, getEditor, getEmptyStateComponent, getEmptyStateText, getFooterRows, getHeaderRows, getNestedNullBehavior, getPageSize, getPartNameGenerator, getPropertySet, getSelectedItems, getSelectionMode, getSelectionModel, getSelectionPreservationMode, getSortOrder, getTooltipPosition, getUniqueKeyProperty, getUniqueKeyProvider, insertColumnLayer, isAllRowsVisible, isColumnReorderingAllowed, isDetailsVisible, isDetailsVisibleOnClick, isMultiSort, isRowsDraggable, isTooltipMarkdownEnabled, onAttach, onDataProviderChange, onDetach, onEnabledStateChanged, prependFooterRow, prependHeaderRow, recalculateColumnWidths, removeAllColumns, removeAllFooterRows, removeAllHeaderRows, removeColumn, removeColumnByKey, removeColumnLayer, removeColumns, removeFooterRow, removeHeaderRow, removeThemeVariants, scrollToStart, select, setAllRowsVisible, setAriaLabel, setColumnKey, setColumnOrder, setColumnOrder, setColumnRendering, setColumnReorderingAllowed, setColumns, setDefaultMultiSortPriority, setDetailsVisible, setDetailsVisibleOnClick, setDragDataGenerator, setDragFilter, setDropFilter, setDropMode, setEmptyStateComponent, setEmptyStateText, setItemDetailsRenderer, setItems, setItems, setItemSelectableProvider, setItemsPageable, setItemsPageable, setMultiSort, setMultiSort, setMultiSort, setMultiSort, setNestedNullBehavior, setPageSize, setPartNameGenerator, setRowsDraggable, setSelectionDragDetails, setSelectionMode, setSelectionModel, setSelectionPreservationMode, setSortableColumns, setTooltipGenerator, setTooltipMarkdownEnabled, setTooltipPosition, setUniqueKeyProperty, setUniqueKeyProvider, sort, updateSelectionModeOnClient

    Methods inherited from class com.vaadin.flow.component.Component

    addListener, findAncestor, fireEvent, from, get, getChildren, getElement, getEventBus, getId, getListeners, getLocale, getParent, getTranslation, getTranslation, getTranslation, getTranslation, getTranslation, getTranslation, getUI, hasListener, isAttached, isTemplateMapped, isVisible, removeFromParent, scrollIntoView, scrollIntoView, set, setElement, setId, setVisible

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    Methods inherited from interface com.vaadin.flow.component.AttachNotifier

    addAttachListener

    Methods inherited from interface com.vaadin.flow.component.BlurNotifier

    addBlurListener

    Methods inherited from interface com.vaadin.flow.component.DetachNotifier

    addDetachListener

    Methods inherited from interface com.vaadin.flow.component.Focusable

    addFocusShortcut, blur, focus, focus, getTabIndex, setTabIndex

    Methods inherited from interface com.vaadin.flow.component.FocusNotifier

    addFocusListener

    Methods inherited from interface com.vaadin.flow.component.HasElement

    getElement

    Methods inherited from interface com.vaadin.flow.component.HasEnabled

    isEnabled, setEnabled

    Methods inherited from interface com.vaadin.flow.data.provider.hierarchy.HasHierarchicalDataProvider

    getTreeData, setItems, setItems, setTreeData

    Methods inherited from interface com.vaadin.flow.data.provider.HasLazyDataView

    setItems

    Methods inherited from interface com.vaadin.flow.component.HasSize

    getHeight, getHeightUnit, getMaxHeight, getMaxWidth, getMinHeight, getMinWidth, getWidth, getWidthUnit, setHeight, setHeight, setHeightFull, setMaxHeight, setMaxHeight, setMaxWidth, setMaxWidth, setMinHeight, setMinHeight, setMinWidth, setMinWidth, setSizeFull, setSizeUndefined, setWidth, setWidth, setWidthFull

    Methods inherited from interface com.vaadin.flow.component.HasStyle

    addClassName, addClassNames, getClassName, getClassNames, getStyle, hasClassName, removeClassName, removeClassNames, setClassName, setClassName

    Methods inherited from interface com.vaadin.flow.component.HasTheme

    addThemeName, addThemeNames, getThemeName, getThemeNames, hasThemeName, removeThemeName, removeThemeNames, setThemeName, setThemeName

  • Constructor Details

    • ExplorerTreeGrid

      public ExplorerTreeGrid()

    • ExplorerTreeGrid

      public ExplorerTreeGrid(Class<T> beanType)

    • ExplorerTreeGrid

      public ExplorerTreeGrid(com.vaadin.flow.data.provider.hierarchy.HierarchicalDataProvider<T,?> dataProvider)

  • Method Details

    • initConnector

      protected void initConnector()
      Overrides:
      initConnector in class com.vaadin.flow.component.treegrid.TreeGrid<T>

    • addHierarchyColumn

      public com.vaadin.flow.component.grid.Grid.Column<T> addHierarchyColumn(com.vaadin.flow.function.ValueProvider<T,?> labelProvider)
      To update with prefix icon, suffix icon
      Overrides:
      addHierarchyColumn in class com.vaadin.flow.component.treegrid.TreeGrid<T>
      Parameters:
      labelProvider -
      Returns:

    • addHierarchyColumn

      public com.vaadin.flow.component.grid.Grid.Column<T> addHierarchyColumn(com.vaadin.flow.function.ValueProvider<T,?> labelProvider, com.vaadin.flow.function.ValueProvider<T,?> iconProvider)
      To update with prefix icon, suffix icon
      Parameters:
      labelProvider -
      iconProvider -
      Returns:

    • collapse

      protected void collapse(Collection<T> items, boolean userOriginated)
      Overrides:
      collapse in class com.vaadin.flow.component.treegrid.TreeGrid<T>

    • expand

      protected void expand(Collection<T> items, boolean userOriginated)
      Overrides:
      expand in class com.vaadin.flow.component.treegrid.TreeGrid<T>

    • addComponentHierarchyColumn

      public <V extends com.vaadin.flow.component.Component> com.vaadin.flow.component.grid.Grid.Column<T> addComponentHierarchyColumn(com.vaadin.flow.function.ValueProvider<T,V> componentProvider)
      Overrides:
      addComponentHierarchyColumn in class com.vaadin.flow.component.treegrid.TreeGrid<T>

    • setHierarchicalSelectionMode

      public com.vaadin.flow.component.grid.GridSelectionModel<T> setHierarchicalSelectionMode(com.vaadin.flow.component.grid.Grid.SelectionMode selectionMode)

    • getChildrenRecursively

      protected Collection<T> getChildrenRecursively(Collection<T> items, int depth)