io.jmix.ui.component.impl

Class TabSheetImpl.Tab

java.lang.Object

io.jmix.ui.component.impl.TabSheetImpl.Tab

All Implemented Interfaces:

Component.HasCaption, Component.HasDescription, Component.HasIcon, TabSheet.Tab

Enclosing class:

TabSheetImpl

protected class TabSheetImpl.Tab
extends java.lang.Object
implements TabSheet.Tab

Constructor Summary

Constructors

Constructor and Description
Tab(java.lang.String name, Component tabComponent)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getCaption()
TabSheet.TabCloseHandler	getCloseHandler()
Component	getComponent()
java.lang.String	getDescription()
java.lang.String	getIcon() Get icon source: "font-icon:ADD", "icons/myicon.png", "theme://createIcon", etc.
java.lang.String	getName()
java.lang.String	getStyleName() Returns the style for UI element that represents the tab header.
protected com.vaadin.ui.TabSheet.Tab	getVaadinTab()
boolean	isClosable() Returns the closability status for the tab.
boolean	isEnabled() Returns the availability status for the tab.
boolean	isVisible() Returns the visibility status for the tab.
void	setCaption(java.lang.String caption) Sets the component's caption.
void	setClosable(boolean closable) Sets the closability status for the tab.
void	setCloseHandler(TabSheet.TabCloseHandler tabCloseHandler) Sets a handler that can override the close behavior if TabSheet.Tab.isClosable() is true.
void	setDescription(java.lang.String description) Sets the component's description.
void	setEnabled(boolean enabled) Sets the availability status for the tab.
void	setIcon(java.lang.String icon) Set an icon by its source: "font-icon:ADD", "icons/myicon.png", "theme://createIcon", etc.
void	setIconFromSet(Icons.Icon icon) Set an icon from an icon set.
void	setName(java.lang.String name) INTERNAL.
void	setStyleName(java.lang.String styleName) Sets style for UI element that represents the tab header.
void	setVisible(boolean visible) Sets the visibility status for the tab.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Tab

public Tab(java.lang.String name,
           Component tabComponent)

Method Detail

getVaadinTab

protected com.vaadin.ui.TabSheet.Tab getVaadinTab()

getComponent

public Component getComponent()

getName

public java.lang.String getName()

Specified by:

getName in interface TabSheet.Tab

Returns:

tab id.

setName

public void setName(java.lang.String name)

Description copied from interface: TabSheet.Tab

INTERNAL. Sets tab id.

Specified by:

setName in interface TabSheet.Tab

getCaption

@Nullable
public java.lang.String getCaption()

Specified by:

getCaption in interface Component.HasCaption

Returns:

the caption of the component

setCaption

public void setCaption(@Nullable
                       java.lang.String caption)

Description copied from interface: Component.HasCaption

Sets the component's caption.

Specified by:

setCaption in interface Component.HasCaption

Parameters:

caption - the new component's caption

isEnabled

public boolean isEnabled()

Description copied from interface: TabSheet.Tab

Returns the availability status for the tab. A disabled tab is shown as such in the tab bar and cannot be selected.

Specified by:

isEnabled in interface TabSheet.Tab

Returns:

true if tab is enabled, false otherwise

setEnabled

public void setEnabled(boolean enabled)

Description copied from interface: TabSheet.Tab

Sets the availability status for the tab. A disabled tab is shown as such in the tab bar and cannot be selected.

Specified by:

setEnabled in interface TabSheet.Tab

Parameters:

enabled - true if tab is enabled, false otherwise

isVisible

public boolean isVisible()

Description copied from interface: TabSheet.Tab

Returns the visibility status for the tab. An invisible tab is not shown in the tab bar and cannot be selected.

Specified by:

isVisible in interface TabSheet.Tab

Returns:

true if tab is visible, false otherwise

setVisible

public void setVisible(boolean visible)

Description copied from interface: TabSheet.Tab

Sets the visibility status for the tab. An invisible tab is not shown in the tab bar and cannot be selected, selection is changed automatically when there is an attempt to select an invisible tab.

Specified by:

setVisible in interface TabSheet.Tab

Parameters:

visible - true if tab is visible, false otherwise

isClosable

public boolean isClosable()

Description copied from interface: TabSheet.Tab

Returns the closability status for the tab.

Specified by:

isClosable in interface TabSheet.Tab

Returns:

true if the tab should be closable from the UI, false otherwise

setClosable

public void setClosable(boolean closable)

Description copied from interface: TabSheet.Tab

Sets the closability status for the tab. It controls if a close button is shown to the user or not. A closable tab can be closed by the user through the user interface.

Specified by:

setClosable in interface TabSheet.Tab

Parameters:

closable - true if the tab should be closable from the UI, false otherwise

getCloseHandler

@Nullable
public TabSheet.TabCloseHandler getCloseHandler()

Specified by:

getCloseHandler in interface TabSheet.Tab

Returns:

a tab close handler

setCloseHandler

public void setCloseHandler(@Nullable
                            TabSheet.TabCloseHandler tabCloseHandler)

Description copied from interface: TabSheet.Tab

Sets a handler that can override the close behavior if TabSheet.Tab.isClosable() is true. Default action just removes the tab.

Specified by:

setCloseHandler in interface TabSheet.Tab

Parameters:

tabCloseHandler - tab close handler

setStyleName

public void setStyleName(java.lang.String styleName)

Description copied from interface: TabSheet.Tab

Sets style for UI element that represents the tab header.

Specified by:

setStyleName in interface TabSheet.Tab

Parameters:

styleName - style name

getStyleName

public java.lang.String getStyleName()

Description copied from interface: TabSheet.Tab

Returns the style for UI element that represents the tab header.

Specified by:

getStyleName in interface TabSheet.Tab

Returns:

the style name or null if no style name has been set

getIcon

@Nullable
public java.lang.String getIcon()

Description copied from interface: Component.HasIcon

Get icon source: "font-icon:ADD", "icons/myicon.png", "theme://createIcon", etc.

Specified by:

getIcon in interface Component.HasIcon

setIcon

public void setIcon(@Nullable
                    java.lang.String icon)

Description copied from interface: Component.HasIcon

Set an icon by its source: "font-icon:ADD", "icons/myicon.png", "theme://createIcon", etc.

Specified by:

setIcon in interface Component.HasIcon

setIconFromSet

public void setIconFromSet(@Nullable
                           Icons.Icon icon)

Description copied from interface: Component.HasIcon

Set an icon from an icon set.

Specified by:

setIconFromSet in interface Component.HasIcon

setDescription

public void setDescription(@Nullable
                           java.lang.String description)

Description copied from interface: Component.HasDescription

Sets the component's description.

Specified by:

setDescription in interface Component.HasDescription

Parameters:

description - the new description to set

getDescription

@Nullable
public java.lang.String getDescription()

Specified by:

getDescription in interface Component.HasDescription

Returns:

the components description, used in tooltips