com.vaadin.fluent.api

Interface FluentTree<THIS extends FluentTree<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.shared.Connector, com.vaadin.event.ContextClickEvent.ContextClickNotifier, FluentAbstractComponent<THIS>, FluentClientConnector<THIS>, FluentComponent<THIS>, FluentComposite<THIS>, FluentContextClickNotifier<THIS>, FluentHasComponents<THIS>, FluentHasDataProvider<THIS,ITEM>, FluentHasHierarchicalDataProvider<THIS,ITEM>, FluentHasItems<THIS,ITEM>, FluentSizeable<THIS>, 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

All Known Implementing Classes:

FTree

public interface FluentTree<THIS extends FluentTree<THIS,ITEM>,ITEM>
extends FluentComposite<THIS>, FluentHasHierarchicalDataProvider<THIS,ITEM>

The base interface for fluent versions of Tree

See Also:

Tree

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	withAutoRecalculateWidth(boolean autoRecalculateWidth) Sets the automatic width recalculation on or off.
default THIS	withCollapseListener(com.vaadin.event.CollapseEvent.CollapseListener<ITEM> listener) Adds a CollapseListener to this Tree.
default THIS	withContentMode(com.vaadin.shared.ui.ContentMode contentMode) Sets the content mode of the item caption.
default THIS	withDataProvider(com.vaadin.data.provider.DataProvider<ITEM,?> dataProvider) Sets the data provider for this listing.
default THIS	withExpandListener(com.vaadin.event.ExpandEvent.ExpandListener<ITEM> listener) Adds an ExpandListener to this Tree.
default THIS	withItemCaptionGenerator(com.vaadin.ui.ItemCaptionGenerator<ITEM> captionGenerator) Sets the item caption generator that is used to produce the strings shown as the text for each item.
default THIS	withItemClickListener(com.vaadin.ui.Tree.ItemClickListener<ITEM> listener) Adds an item click listener.
default THIS	withItemCollapseAllowedProvider(com.vaadin.ui.ItemCollapseAllowedProvider<ITEM> provider) Sets the item collapse allowed provider for this Tree.
default THIS	withItemIconGenerator(com.vaadin.ui.IconGenerator<ITEM> iconGenerator) Sets the item icon generator that is used to produce custom icons for items.
default THIS	withRowHeight(double rowHeight) Sets the height of a row.
default THIS	withSelectionListener(com.vaadin.event.selection.SelectionListener<ITEM> listener) Adds a selection listener to the current selection model.
default THIS	withSelectionMode(com.vaadin.ui.Grid.SelectionMode selectionMode) Sets the tree's selection mode.
default THIS	withStyleGenerator(com.vaadin.ui.StyleGenerator<ITEM> styleGenerator) Sets the style generator that is used for generating class names for items in this tree.

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

withCaption, withCaption, withCaptionAsHtml, withComponentError, withDescription, withDescription, withFullHeight, withFullSize, withFullWidth, withHeight, withHeight, withIcon, withId, withPrimaryStyleName, withSize, withStyleName, withStyleName, withUndefinedHeight, withUndefinedSize, withUndefinedWidth, withWidth, withWidth

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

withData, withLocale, withResponsive, withShortcutListener

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.ui.HasComponents

iterator

Methods inherited from interface java.lang.Iterable

forEach, spliterator

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

withEnabled, withParent, 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.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 Tree.

Parameters:

listener - the listener to add

Returns:

this for method chaining

See Also:

CollapseEvent, Tree.addCollapseListener(CollapseEvent.CollapseListener)

withExpandListener

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

Adds an ExpandListener to this Tree.

Parameters:

listener - the listener to add

Returns:

this for method chaining

See Also:

ExpandEvent, Tree.addExpandListener(ExpandEvent.ExpandListener)

withItemClickListener

default THIS withItemClickListener(com.vaadin.ui.Tree.ItemClickListener<ITEM> listener)

Adds an item click listener. The listener is called when an item of this Tree is clicked.

Parameters:

listener - the item click listener, not null

Returns:

this for method chaining

See Also:

Tree.addItemClickListener(ItemClickListener)

withSelectionListener

default THIS withSelectionListener(com.vaadin.event.selection.SelectionListener<ITEM> listener)
                            throws UnsupportedOperationException

Adds a selection listener to the current selection model.

NOTE: If selection mode is switched with Tree.setSelectionMode(Grid.SelectionMode), then this listener is not triggered anymore when selection changes!

Parameters:

listener - the listener to add

Returns:

this for method chaining

Throws:

UnsupportedOperationException - if selection has been disabled with Grid.SelectionMode.NONE

See Also:

Tree.addSelectionListener(SelectionListener)

withAutoRecalculateWidth

default THIS withAutoRecalculateWidth(boolean autoRecalculateWidth)

Sets the automatic width recalculation on or off. This feature is on by default.

Parameters:

autoRecalculateWidth - true to enable recalculation; false to turn it off

Returns:

this for method chaining

See Also:

Tree.setAutoRecalculateWidth(boolean)

withContentMode

default THIS withContentMode(com.vaadin.shared.ui.ContentMode contentMode)

Sets the content mode of the item caption.

Parameters:

contentMode - the content mode

Returns:

this for method chaining

See Also:

Tree.setContentMode(ContentMode)

withDataProvider

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

Description copied from interface: FluentHasDataProvider

Sets the data provider for this listing. The data provider is queried for displayed items as needed.

Specified by:

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

Parameters:

dataProvider - the data provider, not null

Returns:

this for method chaining

See Also:

HasDataProvider.setDataProvider(DataProvider)

withItemCaptionGenerator

default THIS withItemCaptionGenerator(com.vaadin.ui.ItemCaptionGenerator<ITEM> captionGenerator)

Sets the item caption generator that is used to produce the strings shown as the text for each item. By default, String.valueOf(Object) is used.

Parameters:

captionGenerator - the item caption provider to use, not null

Returns:

this for method chaining

See Also:

Tree.setItemCaptionGenerator(ItemCaptionGenerator)

withItemCollapseAllowedProvider

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

Sets the item collapse allowed provider for this Tree. 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.

Parameters:

provider - the item collapse allowed provider, not null

Returns:

this for method chaining

See Also:

Tree.setItemCollapseAllowedProvider(ItemCollapseAllowedProvider)

withItemIconGenerator

default THIS withItemIconGenerator(com.vaadin.ui.IconGenerator<ITEM> iconGenerator)

Sets the item icon generator that is used to produce custom icons for items. The generator can return null for items with no icon.

Parameters:

iconGenerator - the item icon generator to set, not null

Returns:

this for method chaining

Throws:

NullPointerException - if itemIconGenerator is null

See Also:

IconGenerator, Tree.setItemIconGenerator(IconGenerator)

withRowHeight

default THIS withRowHeight(double rowHeight)

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.

Parameters:

rowHeight - The height of a row in pixels or -1 for automatic calculation

Returns:

this for method chaining

See Also:

Tree.setRowHeight(double)

withSelectionMode

default THIS withSelectionMode(com.vaadin.ui.Grid.SelectionMode selectionMode)

Sets the tree's selection mode.

The built-in selection modes are:

• Grid.SelectionMode.SINGLE the default model
• Grid.SelectionMode.MULTI
• Grid.SelectionMode.NONE preventing selection

Parameters:

selectionMode - the selection mode to switch to, not null

Returns:

this for method chaining

See Also:

Tree.setSelectionMode(Grid.SelectionMode), Grid.SelectionMode

withStyleGenerator

default THIS withStyleGenerator(com.vaadin.ui.StyleGenerator<ITEM> styleGenerator)

Sets the style generator that is used for generating class names for items in this tree. Returning null from the generator results in no custom style name being set.

Parameters:

styleGenerator - the item style generator to set, not null

Returns:

this for method chaining

Throws:

NullPointerException - if styleGenerator is null

See Also:

StyleGenerator, Tree.setStyleGenerator(StyleGenerator)