com.vaadin.fluent.api

Interface FluentTreeGrid<THIS extends FluentTreeGrid<THIS,ITEM>,ITEM>

Type Parameters:

THIS - Self-referential generic THIS

ITEM - the item object type in the listing

All Superinterfaces:

com.vaadin.server.ClientConnector, com.vaadin.ui.Component, com.vaadin.ui.Component.Focusable, com.vaadin.shared.Connector, com.vaadin.event.ContextClickEvent.ContextClickNotifier, FluentAbstractComponent<THIS>, FluentAbstractListing<THIS,ITEM>, FluentClientConnector<THIS>, FluentComponent<THIS>, FluentComponent.FluentFocusable<THIS>, FluentContextClickNotifier<THIS>, FluentGrid<THIS,ITEM>, FluentHasComponents<THIS>, FluentHasDataProvider<THIS,ITEM>, FluentHasHierarchicalDataProvider<THIS,ITEM>, FluentHasItems<THIS,ITEM>, FluentSizeable<THIS>, FluentSortNotifier<THIS,com.vaadin.data.provider.GridSortOrder<ITEM>>, com.vaadin.ui.HasComponents, com.vaadin.data.HasDataProvider<ITEM>, com.vaadin.data.HasHierarchicalDataProvider<ITEM>, com.vaadin.data.HasItems<ITEM>, Iterable<com.vaadin.ui.Component>, Serializable, com.vaadin.server.Sizeable, com.vaadin.event.SortEvent.SortNotifier<com.vaadin.data.provider.GridSortOrder<ITEM>>

All Known Implementing Classes:

FTreeGrid

public interface FluentTreeGrid<THIS extends FluentTreeGrid<THIS,ITEM>,ITEM>
extends FluentGrid<THIS,ITEM>, FluentHasHierarchicalDataProvider<THIS,ITEM>

The base interface for fluent versions of TreeGrid

See Also:

TreeGrid

Nested Class Summary

Nested classes/interfaces inherited from interface com.vaadin.fluent.api.FluentHasComponents

FluentHasComponents.FluentComponentAttachDetachNotifier<THIS extends FluentHasComponents<THIS>>

Nested classes/interfaces inherited from interface com.vaadin.ui.HasComponents

com.vaadin.ui.HasComponents.ComponentAttachDetachNotifier, com.vaadin.ui.HasComponents.ComponentAttachEvent, com.vaadin.ui.HasComponents.ComponentAttachListener, com.vaadin.ui.HasComponents.ComponentDetachEvent, com.vaadin.ui.HasComponents.ComponentDetachListener

Nested classes/interfaces inherited from interface com.vaadin.fluent.api.FluentComponent

FluentComponent.FluentFocusable<C extends FluentComponent.FluentFocusable<C>>

Nested classes/interfaces inherited from interface com.vaadin.ui.Component

com.vaadin.ui.Component.ErrorEvent, com.vaadin.ui.Component.Event, com.vaadin.ui.Component.Focusable, com.vaadin.ui.Component.Listener

Nested classes/interfaces inherited from interface com.vaadin.server.ClientConnector

com.vaadin.server.ClientConnector.AttachEvent, com.vaadin.server.ClientConnector.AttachListener, com.vaadin.server.ClientConnector.ConnectorErrorEvent, com.vaadin.server.ClientConnector.DetachEvent, com.vaadin.server.ClientConnector.DetachListener

Nested classes/interfaces inherited from interface com.vaadin.server.Sizeable

com.vaadin.server.Sizeable.Unit

Field Summary

Fields inherited from interface com.vaadin.server.Sizeable

SIZE_UNDEFINED, UNITS_CM, UNITS_EM, UNITS_EX, UNITS_INCH, UNITS_MM, UNITS_PERCENTAGE, UNITS_PICAS, UNITS_PIXELS, UNITS_POINTS

Method Summary

Modifier and Type	Method and Description
default THIS	withCollapseListener(com.vaadin.event.CollapseEvent.CollapseListener<ITEM> listener) Adds a CollapseListener to this TreeGrid.
default THIS	withDataProvider(com.vaadin.data.provider.DataProvider<ITEM,?> dataProvider) Sets the data provider for the tree grid.
default THIS	withExpandListener(com.vaadin.event.ExpandEvent.ExpandListener<ITEM> listener) Adds an ExpandListener to this TreeGrid.
default THIS	withHierarchyColumn(com.vaadin.ui.Grid.Column<ITEM,?> column) Set the column that displays the hierarchy of this grid's data.
default THIS	withHierarchyColumn(String id) Set the column that displays the hierarchy of this grid's data.
default THIS	withItemCollapseAllowedProvider(com.vaadin.ui.ItemCollapseAllowedProvider<ITEM> provider) Sets the item collapse allowed provider for this TreeGrid.

Methods inherited from interface com.vaadin.fluent.api.FluentGrid

withColumnOrder, withColumnOrder, withColumnReorderingAllowed, withColumnResizeMode, withColumns, withDataProvider, withDefaultHeaderRow, withDescriptionGenerator, withDetailsGenerator, withFooterVisible, withFrozenColumnCount, withHeaderVisible, withHeightByRows, withItemClickListener, withRowHeight, withSelectionListener, withSelectionMode, withSort, withSort, withSort, withSort, withSortOrder, withSortOrder, withStyleGenerator

Methods inherited from interface com.vaadin.fluent.api.FluentAbstractComponent

withCaption, withCaptionAsHtml, withComponentError, withData, withDescription, withDescription, withLocale, withResponsive, withShortcutListener, withStyleName

Methods inherited from interface com.vaadin.fluent.api.FluentClientConnector

withAttachListener, withDetachListener

Methods inherited from interface com.vaadin.fluent.api.FluentContextClickNotifier

withContextClickListener

Methods inherited from interface com.vaadin.event.ContextClickEvent.ContextClickNotifier

addContextClickListener, removeContextClickListener

Methods inherited from interface com.vaadin.fluent.api.FluentComponent.FluentFocusable

withTabIndex

Methods inherited from interface com.vaadin.ui.Component.Focusable

focus, getTabIndex, setTabIndex

Methods inherited from interface com.vaadin.ui.HasComponents

iterator

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Methods inherited from interface com.vaadin.fluent.api.FluentSortNotifier

withSortListener

Methods inherited from interface com.vaadin.event.SortEvent.SortNotifier

addSortListener

Methods inherited from interface com.vaadin.fluent.api.FluentHasHierarchicalDataProvider

withItems, withItems, withItems, withItems, withItems, withTreeData

Methods inherited from interface com.vaadin.data.HasHierarchicalDataProvider

getTreeData, setItems, setItems, setItems, setItems, setItems, setTreeData

Methods inherited from interface com.vaadin.data.HasDataProvider

setDataProvider

Methods inherited from interface com.vaadin.data.HasItems

getDataProvider

Methods inherited from interface com.vaadin.fluent.api.FluentComponent

withCaption, withEnabled, withIcon, withId, withParent, withPrimaryStyleName, withStyleName, withStyleName, withVisible

Methods inherited from interface com.vaadin.ui.Component

addListener, addStyleName, addStyleNames, attach, getCaption, getDescription, getIcon, getId, getLocale, getParent, getPrimaryStyleName, getStyleName, getUI, isEnabled, isVisible, readDesign, removeListener, removeStyleName, removeStyleNames, setCaption, setEnabled, setIcon, setId, setParent, setPrimaryStyleName, setStyleName, setVisible, writeDesign

Methods inherited from interface com.vaadin.server.ClientConnector

addAttachListener, addDetachListener, beforeClientResponse, detach, encodeState, getErrorHandler, getExtensions, getRpcManager, getStateType, handleConnectorRequest, isAttached, isConnectorEnabled, markAsDirty, markAsDirtyRecursive, removeAttachListener, removeDetachListener, removeExtension, requestRepaint, requestRepaintAll, retrievePendingRpcCalls, setErrorHandler

Methods inherited from interface com.vaadin.shared.Connector

getConnectorId

Methods inherited from interface com.vaadin.fluent.api.FluentSizeable

withFullHeight, withFullSize, withFullWidth, withHeight, withHeight, withSize, withUndefinedHeight, withUndefinedSize, withUndefinedWidth, withWidth, withWidth

Methods inherited from interface com.vaadin.server.Sizeable

getHeight, getHeightUnits, getWidth, getWidthUnits, setHeight, setHeight, setHeightUndefined, setSizeFull, setSizeUndefined, setWidth, setWidth, setWidthUndefined

Method Detail

withCollapseListener

default THIS withCollapseListener(com.vaadin.event.CollapseEvent.CollapseListener<ITEM> listener)

Adds a CollapseListener to this TreeGrid.

Parameters:

listener - the listener to add

Returns:

this for method chaining

See Also:

CollapseEvent, TreeGrid.addCollapseListener(CollapseEvent.CollapseListener)

withExpandListener

default THIS withExpandListener(com.vaadin.event.ExpandEvent.ExpandListener<ITEM> listener)

Adds an ExpandListener to this TreeGrid.

Parameters:

listener - the listener to add

Returns:

this for method chaining

See Also:

ExpandEvent, TreeGrid.addExpandListener(ExpandEvent.ExpandListener)

withDataProvider

default THIS withDataProvider(com.vaadin.data.provider.DataProvider<ITEM,?> dataProvider)

Sets the data provider for the tree grid.

Specified by:

withDataProvider in interface FluentHasDataProvider<THIS extends FluentTreeGrid<THIS,ITEM>,ITEM>

Parameters:

dataProvider - the data provider, not null

Returns:

this for method chaining

See Also:

TreeGrid.setDataProvider(DataProvider)

withHierarchyColumn

default THIS withHierarchyColumn(com.vaadin.ui.Grid.Column<ITEM,?> column)

Set the column that displays the hierarchy of this grid's data. By default the hierarchy will be displayed in the first 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.

Parameters:

column - the column to use for displaying hierarchy

Returns:

this for method chaining

See Also:

TreeGrid.setHierarchyColumn(Grid.Column)

withHierarchyColumn

default THIS withHierarchyColumn(String id)

Set the column that displays the hierarchy of this grid's data. By default the hierarchy will be displayed in the first 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.

Parameters:

id - id of the column to use for displaying hierarchy

Returns:

this for method chaining

See Also:

Grid.Column.setId(String), TreeGrid.setHierarchyColumn(String)

withItemCollapseAllowedProvider

default THIS withItemCollapseAllowedProvider(com.vaadin.ui.ItemCollapseAllowedProvider<ITEM> provider)

Sets the item collapse allowed provider for this TreeGrid. The provider should return 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.

This method is a shortcut to method with the same name in HierarchicalDataCommunicator.

Parameters:

provider - the item collapse allowed provider, not null

Returns:

this for method chaining

See Also:

TreeGrid.setItemCollapseAllowedProvider(ItemCollapseAllowedProvider), HierarchicalDataCommunicator.setItemCollapseAllowedProvider(ItemCollapseAllowedProvider)