org.dominokit.domino.ui.tabs

Class Tab

java.lang.Object

org.dominokit.domino.ui.utils.BaseDominoElement<elemental2.dom.HTMLLIElement,Tab>

org.dominokit.domino.ui.tabs.Tab

All Implemented Interfaces:

DominoStyle<elemental2.dom.HTMLLIElement,Tab,Tab>, HasChildren<Tab>, HasClickableElement, HasWavesElement, IsCollapsible<Tab>, IsReadOnly<Tab>, org.jboss.elemento.IsElement<elemental2.dom.HTMLLIElement>

public class Tab
extends BaseDominoElement<elemental2.dom.HTMLLIElement,Tab>
implements HasClickableElement

A component for a single Tab in the TabsPanel

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Tab.ActivationHandler A function to handle Tab activation state change
static interface	Tab.CloseHandler A function to handle closing of tab before the tab is closed, this could be used to confirm closing the Tab

Nested classes/interfaces inherited from class org.dominokit.domino.ui.utils.BaseDominoElement

BaseDominoElement.ElementHandler<T>, BaseDominoElement.ResizeHandler<T>, BaseDominoElement.StyleEditor<E extends elemental2.dom.HTMLElement,T extends org.jboss.elemento.IsElement<E>>, BaseDominoElement.WavesStyler

Field Summary

Fields inherited from class org.dominokit.domino.ui.utils.BaseDominoElement

element

Constructor Summary

Constructors

Constructor and Description
Tab(BaseIcon<?> icon)
Tab(BaseIcon<?> icon, String title)
Tab(BaseIcon<?> icon, String title, String key)
Tab(String title)

Method Summary

Modifier and Type	Method and Description
Tab	activate() make the tab active and show its content in the TabsPanel
Tab	activate(boolean silent) make the tab active and show its content in the TabsPanel
Tab	addActivationHandler(Tab.ActivationHandler activationHandler)
Tab	addCloseHandler(Consumer<Tab> closeHandler)
Tab	appendChild(org.jboss.elemento.IsElement<?> content)
Tab	appendChild(elemental2.dom.Node content)
Tab	closable() delegate to setClosable(boolean) with true
Tab	close() Remove the Tab from the TabsPanel
static Tab	create(BaseIcon<?> icon)
static Tab	create(BaseIcon<?> icon, String title)
static Tab	create(String title)
static Tab	create(String key, BaseIcon<?> icon)
static Tab	create(String key, BaseIcon<?> icon, String title)
static Tab	create(String key, String title)
Tab	deActivate() make the tab inactive and hide its content in the TabsPanel
Tab	deActivate(boolean silent) make the tab inactive and hides its content in the TabsPanel
elemental2.dom.HTMLLIElement	element()
elemental2.dom.HTMLAnchorElement	getClickableElement() by default this return the same component root element
DominoElement<elemental2.dom.HTMLDivElement>	getContentContainer()
String	getKey()
DominoElement<elemental2.dom.HTMLLIElement>	getTab()
boolean	isActive()
Tab	notClosable() delegate to setClosable(boolean) with false
Tab	removeActivationHandler(Tab.ActivationHandler activationHandler)
Tab	removeCloseHandler(Consumer<Tab> closeHandler)
void	removeTab() Removes the tab from the TabsPanel, this is different from closing the tab and wont trigger the close handlers
Tab	setClosable(boolean closable)
Tab	setContent(org.jboss.elemento.IsElement<?> element) this will replace the content of the tab contentContainer
Tab	setContent(elemental2.dom.Node content) this will replace the content of the tab contentContainer
Tab	setIcon(BaseIcon<?> icon)
Tab	setKey(String key)
Tab	setOnBeforeCloseHandler(Tab.CloseHandler closeHandler)
Tab	setTitle(String title)

Methods inherited from class org.dominokit.domino.ui.utils.BaseDominoElement

add, add, addClickListener, addCss, addCss, addEventListener, addEventListener, addEventsListener, addHideListener, addShowListener, alignCenter, alignRight, apply, attr, blur, childNodes, clearElement, contains, contains, contains, containsCss, css, css, cssClassByIndex, cssClassesCount, cssText, disable, elevate, elevate, enable, firstChild, getAttachObserver, getAttribute, getBoundingClientRect, getChildElementCount, getCollapsible, getCollapsibleElement, getDetachObserver, getDominoId, getElementsCount, getElevation, getFirstChild, getId, getTextContent, getTooltip, getWavesElement, hasAttribute, hasChildNodes, hasDirectChild, hide, hideOn, id, init, insertAfter, insertAfter, insertAfter, insertAfter, insertBefore, insertBefore, insertBefore, insertBefore, insertFirst, insertFirst, insertFirst, isAttached, isCollapsed, isDisabled, isEmptyElement, isEqualNode, isForceHidden, isHidden, isReadOnly, item, lastChild, length, onAttached, onDetached, onResize, pullLeft, pullRight, querySelector, querySelectorAll, remove, removeAttachObserver, removeAttribute, removeChild, removeChild, removeCss, removeCss, removeCssProperty, removeDetachObserver, removeEventListener, removeEventListener, removeHideListener, removeHideOn, removeShowListener, removeShowOn, removeTooltip, removeWaves, replaceCss, setAlignItems, setAttribute, setAttribute, setAttribute, setBackgroundColor, setBackgroundColor, setBorder, setBorderColor, setBottom, setBottom, setBoxShadow, setCollapseStrategy, setColor, setColor, setCssProperty, setCssProperty, setCursor, setCursor, setDisabled, setDisplay, setDisplay, setDropMenu, setFlex, setFloat, setFloat, setFontSize, setFontSize, setForceHidden, setHeight, setHeight, setId, setInnerHtml, setLeft, setLeft, setLineHeight, setLineHeight, setMargin, setMargin, setMarginBottom, setMarginBottom, setMarginLeft, setMarginLeft, setMarginRight, setMarginRight, setMarginTop, setMarginTop, setMaxHeight, setMaxHeight, setMaxWidth, setMaxWidth, setMinHeight, setMinHeight, setMinWidth, setMinWidth, setOpacity, setOpacity, setOverFlow, setOverFlow, setOverFlowY, setPadding, setPadding, setPaddingBottom, setPaddingBottom, setPaddingLeft, setPaddingLeft, setPaddingRight, setPaddingRight, setPaddingTop, setPaddingTop, setPointerEvents, setPosition, setPosition, setReadOnly, setRight, setRight, setTabIndex, setTextAlign, setTextAlign, setTextContent, setTooltip, setTooltip, setTooltip, setTooltip, setTop, setTop, setTransitionDuration, setWidth, setWidth, setZIndex, show, showOn, style, style, styler, textContent, toggleDisplay, toggleDisplay, withWaves, withWaves

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.dominokit.domino.ui.utils.IsCollapsible

isExpanded

Methods inherited from interface org.dominokit.domino.ui.style.DominoStyle

add, add, remove, remove, removeProperty, replace, setProperty, setProperty

Constructor Detail

Tab

public Tab(String title)

Parameters:

title - String title for the tab

Tab

public Tab(BaseIcon<?> icon)

Parameters:

icon - BaseIcon for the tab header

Tab

public Tab(BaseIcon<?> icon,
           String title,
           String key)

Parameters:

icon - icon BaseIcon for the tab header

title - String tab header title

key - String unique identifier for the tab

Tab

public Tab(BaseIcon<?> icon,
           String title)

Parameters:

icon - icon BaseIcon for the tab header

title - String tab header title

Method Detail

create

public static Tab create(String title)

Parameters:

title - String tab header title

Returns:

new Tab instance

create

public static Tab create(String key,
                         String title)

Parameters:

key - String unique identifier for the tab

title - String tab header title

Returns:

new Tab instance

create

public static Tab create(BaseIcon<?> icon)

Parameters:

icon - icon BaseIcon for the tab header

Returns:

new Tab instance

create

public static Tab create(String key,
                         BaseIcon<?> icon)

Parameters:

key - String unique identifier for the tab

icon - icon BaseIcon for the tab header

Returns:

new Tab instance

create

public static Tab create(BaseIcon<?> icon,
                         String title)

Parameters:

icon - icon BaseIcon for the tab header

title - String title for the tab header

Returns:

new Tab instance

create

public static Tab create(String key,
                         BaseIcon<?> icon,
                         String title)

Parameters:

key - String unique identifier for the tab

icon - icon BaseIcon for the tab header

title - String title for the tab header

Returns:

new Tab instance

getTab

public DominoElement<elemental2.dom.HTMLLIElement> getTab()

Returns:

the Tab HTMLLIElement wrapped as DominoElement

getContentContainer

public DominoElement<elemental2.dom.HTMLDivElement> getContentContainer()

Returns:

the HTMLDivElement that contains the Tab content

appendChild

public Tab appendChild(elemental2.dom.Node content)

Specified by:

appendChild in interface HasChildren<Tab>

Overrides:

appendChild in class BaseDominoElement<elemental2.dom.HTMLLIElement,Tab>

Parameters:

content - Node to be appended to the tab contentContainer

Returns:

same Tab instance

appendChild

public Tab appendChild(org.jboss.elemento.IsElement<?> content)

Specified by:

appendChild in interface HasChildren<Tab>

Overrides:

appendChild in class BaseDominoElement<elemental2.dom.HTMLLIElement,Tab>

Parameters:

content - IsElement to be appended to the tab contentContainer

Returns:

same Tab instance

setContent

public Tab setContent(org.jboss.elemento.IsElement<?> element)

this will replace the content of the tab contentContainer

Overrides:

setContent in class BaseDominoElement<elemental2.dom.HTMLLIElement,Tab>

Parameters:

element - the IsElement content to replace the current content

Returns:

same component

setContent

public Tab setContent(elemental2.dom.Node content)

this will replace the content of the tab contentContainer

Overrides:

setContent in class BaseDominoElement<elemental2.dom.HTMLLIElement,Tab>

Parameters:

content - the Node content to replace the current content

Returns:

same component

setTitle

public Tab setTitle(String title)

Parameters:

title - String new tab header title

Returns:

same Tab instance

setIcon

public Tab setIcon(BaseIcon<?> icon)

Parameters:

icon - the new BaseIcon for the tab header

Returns:

same Tab instance

activate

public Tab activate()

make the tab active and show its content in the TabsPanel

Returns:

same Tab instance

activate

public Tab activate(boolean silent)

make the tab active and show its content in the TabsPanel

Parameters:

silent - boolean, if true then activate the tab without triggering the Tab.ActivationHandlers

Returns:

same Tab instance

deActivate

public Tab deActivate()

make the tab inactive and hide its content in the TabsPanel

Returns:

same Tab instance

deActivate

public Tab deActivate(boolean silent)

make the tab inactive and hides its content in the TabsPanel

Parameters:

silent - boolean, if true then activate the tab without triggering the Tab.ActivationHandlers

Returns:

same Tab instance

setClosable

public Tab setClosable(boolean closable)

Parameters:

closable - boolean, if true it adds a close element to the tab header that when clicked it removes the tab from the TabsPanel

Returns:

same Tab instance

close

public Tab close()

Remove the Tab from the TabsPanel

Returns:

same Tab instance

closable

public Tab closable()

delegate to setClosable(boolean) with true

Returns:

same Tab instance

notClosable

public Tab notClosable()

delegate to setClosable(boolean) with false

Returns:

same Tab instance

setOnBeforeCloseHandler

public Tab setOnBeforeCloseHandler(Tab.CloseHandler closeHandler)

Parameters:

closeHandler - Tab.CloseHandler

Returns:

same Tab instance

addCloseHandler

public Tab addCloseHandler(Consumer<Tab> closeHandler)

Parameters:

closeHandler - Consumer of Tab to be called when the tab is closed

Returns:

same Tab instance

removeCloseHandler

public Tab removeCloseHandler(Consumer<Tab> closeHandler)

Parameters:

closeHandler - Consumer of Tab to be called when the tab is closed

Returns:

same Tab instance

addActivationHandler

public Tab addActivationHandler(Tab.ActivationHandler activationHandler)

Parameters:

activationHandler - Tab.ActivationHandler

Returns:

same Tab instance

removeActivationHandler

public Tab removeActivationHandler(Tab.ActivationHandler activationHandler)

Parameters:

activationHandler - Tab.ActivationHandler

Returns:

same Tab instance

isActive

public boolean isActive()

Returns:

boolean, true if the tab is currently active

getClickableElement

public elemental2.dom.HTMLAnchorElement getClickableElement()

by default this return the same component root element

Specified by:

getClickableElement in interface HasClickableElement

Overrides:

getClickableElement in class BaseDominoElement<elemental2.dom.HTMLLIElement,Tab>

Returns:

the HTMLElement that should receive and click listeners

element

public elemental2.dom.HTMLLIElement element()

Specified by:

element in interface org.jboss.elemento.IsElement<elemental2.dom.HTMLLIElement>

Specified by:

element in class BaseDominoElement<elemental2.dom.HTMLLIElement,Tab>

Returns:

the HTML element of type E which is the root element of the component

getKey

public String getKey()

Returns:

String unique identifier of this Tab

setKey

public Tab setKey(String key)

Parameters:

key - String unique identifier of this Tab

Returns:

same Tab instance

removeTab

public void removeTab()

Removes the tab from the TabsPanel, this is different from closing the tab and wont trigger the close handlers