public interface TabSheet extends ComponentContainer, Component.BelongToFrame, Component.HasIcon, Component.HasCaption, Component.Focusable, HasContextHelp, HasHtmlCaption, HasHtmlDescription
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. |
Component.Alignment, Component.BelongToFrame, Component.Disposable, Component.Editable, Component.Focusable, Component.HasCaption, Component.HasDescription, Component.HasIcon, Component.HasXmlDescriptor, Component.OptionsStyleProvider, Component.Wrapper
HasContextHelp.ContextHelpIconClickEvent
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
NAME |
AUTO_SIZE, AUTO_SIZE_PX, FULL_SIZE, UNITS_PERCENTAGE, UNITS_PIXELS
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.
|
default void |
setTab(TabSheet.Tab tab)
Deprecated.
|
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.
|
add, add, focusFirstComponent, getComponent, getComponentNN, getComponents, getOwnComponent, getOwnComponents, getOwnComponentsStream, remove, remove, removeAll
getFrame, setFrame
getIcon, setIcon, setIconFromSet
focus, getTabIndex, isFocusable, setFocusable, setTabIndex
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
getContextHelpIconClickHandler, getContextHelpText, isContextHelpTextHtmlEnabled, setContextHelpIconClickHandler, setContextHelpText, setContextHelpTextHtmlEnabled
isCaptionAsHtml, setCaptionAsHtml
getCaption, setCaption
getDescription, setDescription
isDescriptionAsHtml, setDescriptionAsHtml
static final java.lang.String NAME
TabSheet.Tab addTab(java.lang.String name, Component component)
name
- id of the new tabcomponent
- a component that will be the content of the new tabTabSheet.Tab addLazyTab(java.lang.String name, org.dom4j.Element descriptor, ComponentLoader loader)
void removeTab(java.lang.String name)
name
- id of the tab to removevoid removeAllTabs()
TabSheet.Tab getSelectedTab()
void setSelectedTab(TabSheet.Tab tab)
tab
- tab instancevoid setSelectedTab(java.lang.String name)
name
- tab id@Deprecated default TabSheet.Tab getTab()
getSelectedTab()
@Deprecated default void setTab(TabSheet.Tab tab)
setSelectedTab(Tab)
tab
- tab instance@Deprecated default void setTab(java.lang.String name)
setSelectedTab(String)
name
- tab idTabSheet.Tab getTab(java.lang.String name)
name
- tab idComponent getTabComponent(java.lang.String name)
name
- tab idjava.util.Collection<TabSheet.Tab> getTabs()
boolean isTabCaptionsAsHtml()
void setTabCaptionsAsHtml(boolean tabCaptionsAsHtml)
tabCaptionsAsHtml
- true if the tab captions are rendered as HTML, false if rendered as plain textboolean isTabsVisible()
void setTabsVisible(boolean tabsVisible)
tabsVisible
- true if the tabs should be shown in the UI, false otherwiseSubscription addSelectedTabChangeListener(java.util.function.Consumer<TabSheet.SelectedTabChangeEvent> listener)
@Deprecated void removeSelectedTabChangeListener(java.util.function.Consumer<TabSheet.SelectedTabChangeEvent> listener)
Subscription
insteadlistener
- a listener to remove