com.haulmont.cuba.gui.components

Interface TabSheet

All Superinterfaces:

Component, Component.BelongToFrame, Component.Focusable, Component.HasCaption, Component.HasDescription, Component.HasIcon, ComponentContainer, HasContextHelp, HasHtmlCaption, HasHtmlDescription

public interface TabSheet
extends ComponentContainer, Component.BelongToFrame, Component.HasIcon, Component.HasCaption, Component.Focusable, HasContextHelp, HasHtmlCaption, HasHtmlDescription

TabSheet component interface.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	TabSheet.SelectedTabChangeEvent SelectedTabChangeEvents are fired when a selected tab is changed.
static interface	TabSheet.Tab Tab interface.
static interface	TabSheet.TabCloseHandler Handler that overrides the default behavior if TabSheet.Tab.isClosable() is true and a user clicks the close button.

Nested classes/interfaces inherited from interface com.haulmont.cuba.gui.components.Component

Component.Alignment, Component.BelongToFrame, Component.Disposable, Component.Editable, Component.Focusable, Component.HasCaption, Component.HasDescription, Component.HasIcon, Component.HasXmlDescriptor, Component.OptionsStyleProvider, Component.Wrapper

Nested classes/interfaces inherited from interface com.haulmont.cuba.gui.components.HasContextHelp

HasContextHelp.ContextHelpIconClickEvent

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	NAME

Fields inherited from interface com.haulmont.cuba.gui.components.Component

AUTO_SIZE, AUTO_SIZE_PX, FULL_SIZE, UNITS_PERCENTAGE, UNITS_PIXELS

Method Summary

Modifier and Type	Method and Description
TabSheet.Tab	addLazyTab(java.lang.String name, org.dom4j.Element descriptor, ComponentLoader loader) INTERNAL.
Subscription	addSelectedTabChangeListener(java.util.function.Consumer<TabSheet.SelectedTabChangeEvent> listener) Add a listener that will be notified when a selected tab is changed.
TabSheet.Tab	addTab(java.lang.String name, Component component) Add a new tab to the component.
TabSheet.Tab	getSelectedTab() Get selected tab.
default TabSheet.Tab	getTab() Deprecated. use getSelectedTab()
TabSheet.Tab	getTab(java.lang.String name) Get tab with the provided id.
Component	getTabComponent(java.lang.String name) Get a component that is a content of the tab.
java.util.Collection<TabSheet.Tab>	getTabs() Get all tabs.
boolean	isTabCaptionsAsHtml()
boolean	isTabsVisible()
void	removeAllTabs() Remove all tabs.
void	removeSelectedTabChangeListener(java.util.function.Consumer<TabSheet.SelectedTabChangeEvent> listener) Deprecated. Use Subscription instead
void	removeTab(java.lang.String name) Remove tab.
void	setSelectedTab(java.lang.String name) Set selected tab.
void	setSelectedTab(TabSheet.Tab tab) Set selected tab.
default void	setTab(java.lang.String name) Deprecated. Use setSelectedTab(String)
default void	setTab(TabSheet.Tab tab) Deprecated. Use setSelectedTab(Tab)
void	setTabCaptionsAsHtml(boolean tabCaptionsAsHtml) Sets whether HTML is allowed in the tab captions.
void	setTabsVisible(boolean tabsVisible) Sets whether the tab selection part should be shown in the UI.

Methods inherited from interface com.haulmont.cuba.gui.components.ComponentContainer

add, add, focusFirstComponent, getComponent, getComponentNN, getComponents, getOwnComponent, getOwnComponents, getOwnComponentsStream, remove, remove, removeAll

Methods inherited from interface com.haulmont.cuba.gui.components.Component.BelongToFrame

getFrame, setFrame

Methods inherited from interface com.haulmont.cuba.gui.components.Component.HasIcon

getIcon, setIcon, setIconFromSet

Methods inherited from interface com.haulmont.cuba.gui.components.Component.Focusable

focus, getTabIndex, isFocusable, setFocusable, setTabIndex

Methods inherited from interface com.haulmont.cuba.gui.components.Component

addStyleName, getAlignment, getHeight, getHeightSizeUnit, getHeightUnits, getId, getParent, getStyleName, getWidth, getWidthSizeUnit, getWidthUnits, isEnabled, isEnabledItself, isEnabledRecursive, isResponsive, isVisible, isVisibleItself, isVisibleRecursive, removeStyleName, requestFocus, setAlignment, setEnabled, setHeight, setHeightAuto, setHeightFull, setId, setParent, setResponsive, setSizeAuto, setSizeFull, setStyleName, setVisible, setWidth, setWidthAuto, setWidthFull, unwrap, unwrapComposition

Methods inherited from interface com.haulmont.cuba.gui.components.HasContextHelp

getContextHelpIconClickHandler, getContextHelpText, isContextHelpTextHtmlEnabled, setContextHelpIconClickHandler, setContextHelpText, setContextHelpTextHtmlEnabled

Methods inherited from interface com.haulmont.cuba.gui.components.HasHtmlCaption

isCaptionAsHtml, setCaptionAsHtml

Methods inherited from interface com.haulmont.cuba.gui.components.Component.HasCaption

getCaption, setCaption

Methods inherited from interface com.haulmont.cuba.gui.components.Component.HasDescription

getDescription, setDescription

Methods inherited from interface com.haulmont.cuba.gui.components.HasHtmlDescription

isDescriptionAsHtml, setDescriptionAsHtml

Field Detail

NAME

static final java.lang.String NAME

See Also:

Constant Field Values

Method Detail

addTab

TabSheet.Tab addTab(java.lang.String name,
                    Component component)

Add a new tab to the component.

Parameters:

name - id of the new tab

component - a component that will be the content of the new tab

Returns:

the new tab

addLazyTab

TabSheet.Tab addLazyTab(java.lang.String name,
                        org.dom4j.Element descriptor,
                        ComponentLoader loader)

INTERNAL. Add a new lazy tab to the component.

removeTab

void removeTab(java.lang.String name)

Remove tab.

Parameters:

name - id of the tab to remove

removeAllTabs

void removeAllTabs()

Remove all tabs.

getSelectedTab

TabSheet.Tab getSelectedTab()

Get selected tab. May be null if the tabsheet does not contain tabs at all.

setSelectedTab

void setSelectedTab(TabSheet.Tab tab)

Set selected tab.

Parameters:

tab - tab instance

setSelectedTab

void setSelectedTab(java.lang.String name)

Set selected tab.

Parameters:

name - tab id

getTab

@Deprecated
default TabSheet.Tab getTab()

Deprecated. use getSelectedTab()

Get selected tab. May be null if the tabsheet does not contain tabs at all.

setTab

@Deprecated
default void setTab(TabSheet.Tab tab)

Deprecated. Use setSelectedTab(Tab)

Set selected tab.

Parameters:

tab - tab instance

setTab

@Deprecated
default void setTab(java.lang.String name)

Deprecated. Use setSelectedTab(String)

Set selected tab.

Parameters:

name - tab id

getTab

TabSheet.Tab getTab(java.lang.String name)

Get tab with the provided id.

Parameters:

name - tab id

Returns:

tab instance

getTabComponent

Component getTabComponent(java.lang.String name)

Get a component that is a content of the tab.

Parameters:

name - tab id

Returns:

tab content

getTabs

java.util.Collection<TabSheet.Tab> getTabs()

Get all tabs.

isTabCaptionsAsHtml

boolean isTabCaptionsAsHtml()

Returns:

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

setTabCaptionsAsHtml

void setTabCaptionsAsHtml(boolean tabCaptionsAsHtml)

Sets whether HTML is allowed in the tab captions.

Parameters:

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

isTabsVisible

boolean isTabsVisible()

Returns:

true if the tabs are shown in the UI, false otherwise

setTabsVisible

void setTabsVisible(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

addSelectedTabChangeListener

Subscription addSelectedTabChangeListener(java.util.function.Consumer<TabSheet.SelectedTabChangeEvent> listener)

Add a listener that will be notified when a selected tab is changed.

removeSelectedTabChangeListener

@Deprecated
void removeSelectedTabChangeListener(java.util.function.Consumer<TabSheet.SelectedTabChangeEvent> listener)

Deprecated. Use Subscription instead

Remove previously added SelectedTabChangeListener.

Parameters:

listener - a listener to remove