E - row item type@StudioComponent(caption="TreeDataGrid", category="Components", xmlElement="treeDataGrid", icon="io/jmix/ui/icon/component/treeDataGrid.svg", canvasBehaviour=TABLE, documentationURL="https://docs.jmix.io/jmix/%VERSION%/backoffice-ui/vcl/components/tree-data-grid.html") public interface TreeDataGrid<E> extends DataGrid<E>
| Modifier and Type | Interface and Description |
|---|---|
static class |
TreeDataGrid.CollapseEvent<E>
An event that is fired when an item is collapsed.
|
static class |
TreeDataGrid.ExpandEvent<E>
An event that is fired when an item is expanded.
|
DataGrid.AbstractDataGridEditorEvent<E>, DataGrid.AbstractDataGridEvent, DataGrid.AggregationPosition, DataGrid.ButtonRenderer<T>, DataGrid.CheckBoxRenderer, DataGrid.ClickableTextRenderer<T>, DataGrid.Column<E>, DataGrid.ColumnCollapsingChangeEvent, DataGrid.ColumnGeneratorEvent<E>, DataGrid.ColumnReorderEvent, DataGrid.ColumnResizeEvent, DataGrid.ColumnResizeMode, DataGrid.ComponentRenderer, DataGrid.ContextClickEvent, DataGrid.DataGridClickEvent, DataGrid.DataGridStaticCellType, DataGrid.DateRenderer, DataGrid.EditorCloseEvent<E>, DataGrid.EditorFieldGenerationContext<T>, DataGrid.EditorOpenEvent<E>, DataGrid.EditorPostCommitEvent<E>, DataGrid.EditorPreCommitEvent<E>, DataGrid.EmptyStateClickEvent<E>, DataGrid.FooterCell, DataGrid.FooterRow, DataGrid.HasDateTimeFormatter, DataGrid.HasFormatString, DataGrid.HasLocale, DataGrid.HasNullRepresentation, DataGrid.HasRendererClickListener<T>, DataGrid.HeaderCell, DataGrid.HeaderRow, DataGrid.HtmlRenderer, DataGrid.IconRenderer<T>, DataGrid.ImageRenderer<T>, DataGrid.ItemClickEvent<E>, DataGrid.LocalDateRenderer, DataGrid.LocalDateTimeRenderer, DataGrid.NumberRenderer, DataGrid.ProgressBarRenderer, DataGrid.Renderer, DataGrid.RendererClickEvent<T>, DataGrid.ScrollDestination, DataGrid.SelectionEvent<E>, DataGrid.SelectionMode, DataGrid.SortDirection, DataGrid.SortEvent, DataGrid.SortOrder, DataGrid.StaticCell, DataGrid.StaticRow<T extends DataGrid.StaticCell>, DataGrid.TextRendererComponent.Alignment, Component.BelongToFrame, Component.Disposable, Component.Editable, Component.Focusable, Component.HasCaption, Component.HasDescription, Component.HasIcon, Component.HasXmlDescriptor, Component.WrapperHasContextHelp.ContextHelpIconClickEventLookupComponent.LookupSelectionChangeEvent<T>, LookupComponent.LookupSelectionChangeNotifier<T>| Modifier and Type | Field and Description |
|---|---|
static java.lang.String |
NAME |
AUTO_SIZE, AUTO_SIZE_PX, FULL_SIZE| Modifier and Type | Method and Description |
|---|---|
io.jmix.core.common.event.Subscription |
addCollapseListener(java.util.function.Consumer<TreeDataGrid.CollapseEvent<E>> listener)
Registers a new collapse listener.
|
io.jmix.core.common.event.Subscription |
addExpandListener(java.util.function.Consumer<TreeDataGrid.ExpandEvent<E>> listener)
Registers a new expand listener.
|
void |
collapse(java.util.Collection<E> items)
Collapse the given items.
|
default void |
collapse(E... items)
Collapse the given items.
|
void |
collapseAll()
Collapses all items.
|
default void |
collapseRecursively(java.util.Collection<E> items,
int depth)
Collapse the given items and their children recursively until the given depth.
|
void |
collapseRecursively(java.util.stream.Stream<E> items,
int depth)
Collapse the given items and their children recursively until the given depth.
|
void |
expand(java.util.Collection<E> items)
Expands the given items.
|
default void |
expand(E... items)
Expands the given items.
|
void |
expandAll()
Expands all items.
|
default void |
expandRecursively(java.util.Collection<E> items,
int depth)
Expands the given items and their children recursively until the given depth.
|
void |
expandRecursively(java.util.stream.Stream<E> items,
int depth)
Expands the given items and their children recursively until the given depth.
|
DataGrid.Column<E> |
getHierarchyColumn()
Get the currently set hierarchy column.
|
java.util.function.Predicate<E> |
getItemCollapseAllowedProvider() |
TreeDataGridItems<E> |
getItems() |
int |
getLevel(E item)
Returns the hierarchy level of an item.
|
boolean |
isExpanded(E item)
Returns whether a given item is expanded or collapsed.
|
static <T> org.springframework.core.ParameterizedTypeReference<TreeDataGrid<T>> |
of(java.lang.Class<T> itemClass) |
void |
setHierarchyColumn(DataGrid.Column<E> column)
Set the column that displays the hierarchy of this DataGrid's data.
|
void |
setHierarchyColumn(java.lang.String id)
Set the column that displays the hierarchy of this DataGrid's data.
|
void |
setItemCollapseAllowedProvider(java.util.function.Predicate<E> provider)
Sets the item collapse allowed provider for this TreeDataGrid.
|
addColumn, addColumn, addColumn, addColumn, addColumnCollapsingChangeListener, addColumnReorderListener, addColumnResizeListener, addContextClickListener, addEditorCloseListener, addEditorOpenListener, addEditorPostCommitListener, addEditorPreCommitListener, addFooterRowAt, addGeneratedColumn, addGeneratedColumn, addHeaderRowAt, addItemClickListener, addRowStyleProvider, addSelectionListener, addSortListener, appendFooterRow, appendHeaderRow, deselect, deselectAll, edit, getAggregationPosition, getAggregationResults, getBodyRowHeight, getColumn, getColumnGenerator, getColumnNN, getColumnResizeMode, getColumns, getDefaultHeaderRow, getDetailsGenerator, getEditedItem, getEditorCancelCaption, getEditorSaveCaption, getEmptyStateLinkClickHandler, getEmptyStateLinkMessage, getEmptyStateMessage, getEnterPressAction, getFooterRow, getFooterRowCount, getFooterRowHeight, getFrozenColumnCount, getHeaderRow, getHeaderRowCount, getHeaderRowHeight, getItemClickAction, getRowDescriptionProvider, getSelectionMode, getSortOrder, getSubPart, getVisibleColumns, isAggregatable, isColumnReorderingAllowed, isColumnsCollapsingAllowed, isContextMenuEnabled, isDetailsVisible, isEditorActive, isEditorBuffered, isEditorCrossFieldValidate, isEditorEnabled, isFooterVisible, isHeaderVisible, isSortable, isTextSelectionEnabled, prependFooterRow, prependHeaderRow, removeColumn, removeColumn, removeFooterRow, removeFooterRow, removeHeaderRow, removeHeaderRow, removeRowStyleProvider, repaint, scrollTo, scrollTo, scrollToEnd, scrollToStart, selectAll, setAggregatable, setAggregationPosition, setBodyRowHeight, setColumnReorderingAllowed, setColumnResizeMode, setColumnsCollapsingAllowed, setContextMenuEnabled, setDefaultHeaderRow, setDetailsGenerator, setDetailsVisible, setEditorBuffered, setEditorCancelCaption, setEditorCrossFieldValidate, setEditorEnabled, setEditorSaveCaption, setEmptyStateLinkClickHandler, setEmptyStateLinkMessage, setEmptyStateMessage, setEnterPressAction, setFooterRowHeight, setFooterVisible, setFrozenColumnCount, setHeaderRowHeight, setHeaderVisible, setItemClickAction, setItems, setRowDescriptionProvider, setRowDescriptionProvider, setSelectionMode, setSortable, setTextSelectionEnabled, sortgetSelected, getSingleSelected, isMultiSelect, setSelected, setSelectedgetFrame, setFrameaddAction, addAction, getAction, getActionNN, getActions, removeAction, removeAction, removeAllActionsaddStyleName, getAlignment, getHeight, getHeightSizeUnit, getId, getParent, getStyleName, getWidth, getWidthSizeUnit, isEnabled, isEnabledRecursive, isResponsive, isVisible, isVisibleRecursive, removeStyleName, setAlignment, setEnabled, setHeight, setHeightAuto, setHeightFull, setId, setParent, setResponsive, setSizeAuto, setSizeFull, setStyleName, setVisible, setWidth, setWidthAuto, setWidthFull, unwrap, unwrapComposition, unwrapCompositionOrNull, unwrapOrNull, withUnwrapped, withUnwrappedCompositiongetButtonsPanel, setButtonsPanelgetIcon, setIcon, setIconFromSetgetContextHelpIconClickHandler, getContextHelpText, isContextHelpTextHtmlEnabled, setContextHelpIconClickHandler, setContextHelpText, setContextHelpTextHtmlEnabledisCaptionAsHtml, setCaptionAsHtmlgetCaption, setCaptiongetDescription, setDescriptionisDescriptionAsHtml, setDescriptionAsHtmlgetLookupSelectedItems, setLookupSelectHandlerfocus, getTabIndex, isFocusable, setFocusable, setTabIndexisHtmlSanitizerEnabled, setHtmlSanitizerEnabledgetPagination, setPaginationstatic final java.lang.String NAME
static <T> org.springframework.core.ParameterizedTypeReference<TreeDataGrid<T>> of(java.lang.Class<T> itemClass)
int getLevel(E item)
item - the item to get level@Nullable TreeDataGridItems<E> getItems()
@Nullable DataGrid.Column<E> getHierarchyColumn()
null if no column has been explicitly setvoid setHierarchyColumn(java.lang.String id)
Setting a hierarchy column by calling this method also sets the column to be visible and not hidable.
Note: Changing the Renderer of the hierarchy column is not supported.
id - the column id to use for displaying hierarchyvoid setHierarchyColumn(DataGrid.Column<E> column)
Setting a hierarchy column by calling this method also sets the column to be visible and not hidable.
Note: Changing the Renderer of the hierarchy column is not supported.
column - the column to use for displaying hierarchyjava.util.function.Predicate<E> getItemCollapseAllowedProvider()
void setItemCollapseAllowedProvider(java.util.function.Predicate<E> provider)
true for any item that the user can collapse.
Note: This callback will be accessed often when sending data to the client. The callback should not do any costly operations.
provider - the item collapse allowed provider, not nulldefault void expand(E... items)
If an item is currently expanded, does nothing. If an item does not have any children, does nothing.
items - the items to expandexpand(Collection)void expand(java.util.Collection<E> items)
If an item is currently expanded, does nothing. If an item does not have any children, does nothing.
items - the items to expandexpand(Object[])default void expandRecursively(java.util.Collection<E> items, int depth)
depth describes the maximum distance between a given item and its descendant,
meaning that expandRecursively(items, 0) expands only the given items
while expandRecursively(items, 2) expands the given items as well as their
children and grandchildren.
This method will not fire events for expanded nodes.
items - the items to expand recursivelydepth - the maximum depth of recursionexpandRecursively(Stream, int)void expandAll()
This method will not fire events for expanded nodes.
void expandRecursively(java.util.stream.Stream<E> items, int depth)
depth describes the maximum distance between a given item and its descendant,
meaning that expandRecursively(items, 0) expands only the given items
while expandRecursively(items, 2) expands the given items as well as their
children and grandchildren.
This method will not fire events for expanded nodes.
items - the items to expand recursivelydepth - the maximum depth of recursionexpandRecursively(Collection, int)default void collapse(E... items)
For items that are already collapsed, does nothing.
items - the items to collapsecollapse(Collection)void collapse(java.util.Collection<E> items)
For items that are already collapsed, does nothing.
items - the items to collapsecollapse(Object[])default void collapseRecursively(java.util.Collection<E> items, int depth)
depth describes the maximum distance between a given item and its
descendant, meaning that collapseRecursively(items, 0) collapses
only the given items while collapseRecursively(items, 2)
collapses the given items as well as their children and grandchildren.
This method will not fire events for collapsed nodes.
items - the items to collapse recursivelydepth - the maximum depth of recursioncollapseRecursively(Stream, int)void collapseRecursively(java.util.stream.Stream<E> items, int depth)
depth describes the maximum distance between a given item and its
descendant, meaning that collapseRecursively(items, 0) collapses
only the given items while collapseRecursively(items, 2)
collapses the given items as well as their children and grandchildren.
This method will not fire events for collapsed nodes.
items - the items to collapse recursivelydepth - the maximum depth of recursioncollapseRecursively(Collection, int)void collapseAll()
This method will not fire events for expanded nodes.
boolean isExpanded(E item)
item - the item to checktrue if the item is expanded, false otherwiseio.jmix.core.common.event.Subscription addExpandListener(java.util.function.Consumer<TreeDataGrid.ExpandEvent<E>> listener)
listener - the listener to be addedio.jmix.core.common.event.Subscription addCollapseListener(java.util.function.Consumer<TreeDataGrid.CollapseEvent<E>> listener)
listener - the listener to be added