com.vaadin.fluent.api

Interface FluentTabSheet<THIS extends FluentTabSheet<THIS>>

Type Parameters:

THIS - Self-referential generic THIS

All Superinterfaces:

com.vaadin.server.ClientConnector, com.vaadin.ui.Component, com.vaadin.ui.Component.Focusable, com.vaadin.ui.ComponentContainer, com.vaadin.shared.Connector, com.vaadin.event.ContextClickEvent.ContextClickNotifier, com.vaadin.event.FieldEvents.BlurNotifier, com.vaadin.event.FieldEvents.FocusNotifier, FluentAbstractComponent<THIS>, FluentAbstractComponentContainer<THIS>, FluentClientConnector<THIS>, FluentComponent<THIS>, FluentComponent.FluentFocusable<THIS>, FluentComponentContainer<THIS>, FluentContextClickNotifier<THIS>, FluentFieldEvents.FluentBlurNotifier<THIS>, FluentFieldEvents.FluentFocusNotifier<THIS>, FluentHasComponents<THIS>, FluentHasComponents.FluentComponentAttachDetachNotifier<THIS>, FluentSizeable<THIS>, com.vaadin.ui.HasComponents, com.vaadin.ui.HasComponents.ComponentAttachDetachNotifier, Iterable<com.vaadin.ui.Component>, Serializable, com.vaadin.server.Sizeable

All Known Implementing Classes:

FAccordion, FTabSheet

public interface FluentTabSheet<THIS extends FluentTabSheet<THIS>>
extends FluentComponent.FluentFocusable<THIS>, FluentFieldEvents.FluentFocusNotifier<THIS>, FluentFieldEvents.FluentBlurNotifier<THIS>, FluentAbstractComponentContainer<THIS>

The base interface for fluent versions of TabSheet

See Also:

TabSheet

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	withCloseHandler(com.vaadin.ui.TabSheet.CloseHandler handler) Provide a custom TabSheet.CloseHandler for this TabSheet if you wish to perform some additional tasks when a user clicks on a tabs close button, e.g. show a confirmation dialogue before removing the tab.
default THIS	withSelectedTab(com.vaadin.ui.Component component) Sets the selected tab.
default THIS	withSelectedTab(com.vaadin.ui.Component component, boolean userOriginated) Sets the selected tab.
default THIS	withSelectedTab(int index) Sets the selected tab, identified by its index.
default THIS	withSelectedTab(com.vaadin.ui.TabSheet.Tab tab) Sets the selected tab.
default THIS	withSelectedTabChangeListener(com.vaadin.ui.TabSheet.SelectedTabChangeListener listener) Adds a tab selection listener.
default THIS	withTab(com.vaadin.ui.Component c) Adds a new tab into TabSheet.
default THIS	withTab(com.vaadin.ui.Component component, int position) Adds a new tab into TabSheet.
default THIS	withTab(com.vaadin.ui.Component c, String caption) Adds a new tab into TabSheet.
default THIS	withTab(com.vaadin.ui.Component c, String caption, com.vaadin.server.Resource icon) Adds a new tab into TabSheet.
default THIS	withTab(com.vaadin.ui.Component tabComponent, String caption, com.vaadin.server.Resource icon, int position) Adds a new tab into TabSheet.
default THIS	withTabCaptionsAsHtml(boolean tabCaptionsAsHtml) Sets whether HTML is allowed in the tab captions.
default THIS	withTabPosition(com.vaadin.ui.TabSheet.Tab tab, int position) Sets the position of the tab.
default THIS	withTabsVisible(boolean tabsVisible) Sets whether the tab selection part should be shown in the UI

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.fluent.api.FluentFieldEvents.FluentFocusNotifier

withFocusListener

Methods inherited from interface com.vaadin.event.FieldEvents.FocusNotifier

addFocusListener

Methods inherited from interface com.vaadin.fluent.api.FluentFieldEvents.FluentBlurNotifier

withBlurListener

Methods inherited from interface com.vaadin.event.FieldEvents.BlurNotifier

addBlurListener

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.FluentComponentContainer

withComponent, withComponents

Methods inherited from interface com.vaadin.ui.ComponentContainer

addComponent, addComponents, getComponentCount, getComponentIterator, moveComponentsFrom, removeAllComponents, removeComponent, replaceComponent

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

Methods inherited from interface com.vaadin.fluent.api.FluentHasComponents.FluentComponentAttachDetachNotifier

withComponentAttachListener, withComponentDetachListener

Methods inherited from interface com.vaadin.ui.HasComponents.ComponentAttachDetachNotifier

addComponentAttachListener, addComponentDetachListener, removeComponentAttachListener, removeComponentDetachListener

Method Detail

withSelectedTabChangeListener

default THIS withSelectedTabChangeListener(com.vaadin.ui.TabSheet.SelectedTabChangeListener listener)

Adds a tab selection listener.

Parameters:

listener - the Listener to be added, not null

Returns:

this for method chaining

See Also:

Registration, TabSheet.addSelectedTabChangeListener(SelectedTabChangeListener)

withTab

default THIS withTab(com.vaadin.ui.Component c)

Adds a new tab into TabSheet. Component caption and icon are copied to the tab metadata at creation time. If the tab sheet already contains the component, it does nothing. If you want the returned TabSheet.Tab instead, use TabSheet.addTab(Component)

Parameters:

c - the component to be added onto tab - should not be null.

Returns:

this for method chaining

See Also:

TabSheet.addTab(Component)

withTab

default THIS withTab(com.vaadin.ui.Component component,
                     int position)

Adds a new tab into TabSheet. Component caption and icon are copied to the tab metadata at creation time. If the tab sheet already contains the component, its tab is returned. If you want the returned TabSheet.Tab instead, use TabSheet.addTab(Component, int)

Parameters:

component - the component to be added onto tab - should not be null.

position - The position where the tab should be added

Returns:

this for method chaining

See Also:

TabSheet.addTab(Component, int)

withTab

default THIS withTab(com.vaadin.ui.Component c,
                     String caption)

Adds a new tab into TabSheet. The first tab added to a tab sheet is automatically selected and a tab selection event is fired. If the component is already present in the tab sheet, it only changes its caption preserving other tab metadata. If you want the returned TabSheet.Tab instead, use TabSheet.addTab(Component, String).

Parameters:

c - the component to be added onto tab - should not be null.

caption - the caption to be set for the component and used rendered in tab bar

Returns:

this for method chaining

See Also:

TabSheet.addTab(Component, String)

withTab

default THIS withTab(com.vaadin.ui.Component c,
                     String caption,
                     com.vaadin.server.Resource icon)

Adds a new tab into TabSheet. The first tab added to a tab sheet is automatically selected and a tab selection event is fired. If the component is already present in the tab sheet, it only changes its caption and icon, preserving other tab metadata. If you want the returned TabSheet.Tab instead, use TabSheet.addTab(Component, String, Resource).

Parameters:

c - the component to be added onto tab - should not be null.

caption - the caption to be set for the component and used rendered in tab bar

icon - the icon to be set for the component and used rendered in tab bar

Returns:

this for method chaining

See Also:

TabSheet.addTab(Component, String, Resource)

withTab

default THIS withTab(com.vaadin.ui.Component tabComponent,
                     String caption,
                     com.vaadin.server.Resource icon,
                     int position)

Adds a new tab into TabSheet. The first tab added to a tab sheet is automatically selected and a tab selection event is fired. If the component is already present in the tab sheet, it only changes its caption and icon, preserving other tab metadata like the position. If you want the returned TabSheet.Tab instead, use TabSheet.addTab(Component, String, Resource, int).

Parameters:

tabComponent - the component to be added onto tab - should not be null.

caption - the caption to be set for the component and used rendered in tab bar

icon - the icon to be set for the component and used rendered in tab bar

position - the position at where the the tab should be added.

Returns:

this for method chaining

See Also:

TabSheet.addTab(Component, String, Resource, int)

withCloseHandler

default THIS withCloseHandler(com.vaadin.ui.TabSheet.CloseHandler handler)

Provide a custom TabSheet.CloseHandler for this TabSheet if you wish to perform some additional tasks when a user clicks on a tabs close button, e.g. show a confirmation dialogue before removing the tab. To remove the tab, if you provide your own close handler, you must call ComponentContainer.removeComponent(Component) yourself. The default CloseHandler for TabSheet will only remove the tab.

Parameters:

handler - the close handler

Returns:

this for method chaining

See Also:

TabSheet.setCloseHandler(CloseHandler)

withSelectedTab

default THIS withSelectedTab(com.vaadin.ui.Component component)

Sets the selected tab. The tab is identified by the tab content component. Does nothing if the tabsheet doesn't contain the component.

Parameters:

component - the component of the tab to select

Returns:

this for method chaining

See Also:

TabSheet.setSelectedTab(Component)

withSelectedTab

default THIS withSelectedTab(com.vaadin.ui.Component component,
                             boolean userOriginated)

Sets the selected tab. The tab is identified by the tab content component. Does nothing if the tabsheet doesn't contain the component.

Parameters:

component - the component of the tab to select

userOriginated - true if the event originates from the client side, false otherwise

Returns:

this for method chaining

See Also:

TabSheet.setSelectedTab(Component, boolean)

withSelectedTab

default THIS withSelectedTab(com.vaadin.ui.TabSheet.Tab tab)

Sets the selected tab. The tab is identified by the corresponding Tab instance. Does nothing if the tabsheet doesn't contain the given tab.

Parameters:

tab - the tab to select

Returns:

this for method chaining

See Also:

TabSheet.setSelectedTab(Tab)

withSelectedTab

default THIS withSelectedTab(int index)

Sets the selected tab, identified by its index. Does nothing if the position is out of bounds.

Parameters:

index - the index of the tab to select

Returns:

this for method chaining

See Also:

TabSheet.setSelectedTab(int)

withTabCaptionsAsHtml

default THIS withTabCaptionsAsHtml(boolean tabCaptionsAsHtml)

Sets whether HTML is allowed in the tab captions.

If set to true, the captions are rendered in the browser as HTML and the developer is responsible for ensuring no harmful HTML is used. If set to false, the content is rendered in the browser as plain text.

The default is false, i.e. render tab captions as plain text

Parameters:

tabCaptionsAsHtml - true if the tab captions are rendered as HTML, false if rendered as plain text

Returns:

this for method chaining

See Also:

TabSheet.setTabCaptionsAsHtml(boolean)

withTabPosition

default THIS withTabPosition(com.vaadin.ui.TabSheet.Tab tab,
                             int position)

Sets the position of the tab.

Parameters:

tab - The tab

position - The new position of the tab

Returns:

this for method chaining

See Also:

TabSheet.setTabPosition(Tab, int)

withTabsVisible

default THIS withTabsVisible(boolean tabsVisible)

Sets whether the tab selection part should be shown in the UI

Parameters:

tabsVisible - true if the tabs should be shown in the UI, false otherwise

Returns:

this for method chaining

See Also:

TabSheet.setTabsVisible(boolean)