org.dominokit.domino.ui.tabs

Class TabsPanel

java.lang.Object

org.dominokit.domino.ui.utils.BaseDominoElement<elemental2.dom.HTMLDivElement,TabsPanel>

org.dominokit.domino.ui.tabs.TabsPanel

All Implemented Interfaces:

DominoStyle<elemental2.dom.HTMLDivElement,TabsPanel,TabsPanel>, HasChildren<TabsPanel>, HasWavesElement, IsCollapsible<TabsPanel>, IsReadOnly<TabsPanel>, org.jboss.elemento.IsElement<elemental2.dom.HTMLDivElement>

public class TabsPanel
extends BaseDominoElement<elemental2.dom.HTMLDivElement,TabsPanel>
implements org.jboss.elemento.IsElement<elemental2.dom.HTMLDivElement>

A component to create tabs where only one Tab can be active at a time

The tabs in this component will be always aligned horizontally

     TabsPanel.create()
         .appendChild(
                 Tab.create("HOME")
                         .appendChild(b().textContent("Home Content"))
                         .appendChild(Paragraph.create("SAMPLE_TEXT")))
         .appendChild(
                 Tab.create("PROFILE")
                         .appendChild(b().textContent("Profile Content"))
                         .appendChild(Paragraph.create("SAMPLE_TEXT")))
         .appendChild(
                 Tab.create("MESSAGES")
                         .appendChild(b().textContent("Messages Content"))
                         .appendChild(Paragraph.create("SAMPLE_TEXT"))
                         .activate())
         .appendChild(
                 Tab.create("SETTINGS")
                         .appendChild(b().textContent("Settings Content"))
                         .appendChild(Paragraph.create("SAMPLE_TEXT"))
         );
 

Nested Class Summary

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

Constructor Summary

Constructors

Constructor and Description
TabsPanel()

Method Summary

Modifier and Type	Method and Description
TabsPanel	activateByKey(String key)
TabsPanel	activateByKey(String key, boolean silent)
void	activateTab(int index)
void	activateTab(Tab tab)
void	activateTab(Tab tab, boolean silent)
TabsPanel	addActivationHandler(Tab.ActivationHandler activationHandler)
TabsPanel	addCloseHandler(Consumer<Tab> closeHandler)
TabsPanel	appendChild(Tab tab)
void	closeTab(Tab tab)
static TabsPanel	create()
void	deActivateTab(int index)
void	deActivateTab(Tab tab)
void	deActivateTab(Tab tab, boolean silent)
elemental2.dom.HTMLDivElement	element()
Tab	getActiveTab()
List<Tab>	getTabs()
DominoElement<elemental2.dom.HTMLElement>	getTabsContent()
TabsPanel	insertAt(int index, Tab tab) Inserts a Tab into the specified index
boolean	isAutoActivate()
TabsPanel	removeActivationHandler(Tab.ActivationHandler activationHandler)
TabsPanel	removeCloseHandler(Consumer<Tab> closeHandler)
TabsPanel	setAutoActivate(boolean autoActivate)
TabsPanel	setBackgroundColor(Color background)
TabsPanel	setColor(Color color)
TabsPanel	setContentContainer(elemental2.dom.HTMLElement contentContainer)
TabsPanel	setContentContainer(org.jboss.elemento.IsElement<?> contentContainer)
TabsPanel	setTabsAlign(TabsAlign align)
TabsPanel	setTransition(Transition transition)

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

add, add, addClickListener, addCss, addCss, addEventListener, addEventListener, addEventsListener, addHideListener, addShowListener, alignCenter, alignRight, appendChild, appendChild, apply, attr, blur, childNodes, clearElement, contains, contains, contains, containsCss, css, css, cssClassByIndex, cssClassesCount, cssText, disable, elevate, elevate, enable, firstChild, getAttachObserver, getAttribute, getBoundingClientRect, getChildElementCount, getClickableElement, 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, setContent, setContent, 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

TabsPanel

public TabsPanel()

Method Detail

create

public static TabsPanel create()

insertAt

public TabsPanel insertAt(int index,
                          Tab tab)

Inserts a Tab into the specified index

Parameters:

index - int

tab - Tab

Returns:

same TabsPanel

appendChild

public TabsPanel appendChild(Tab tab)

Parameters:

tab - Tab to be added to the TabsPanel, the tab will be added as the last Tab

Returns:

same TabsPanel instance

activateTab

public void activateTab(int index)

Parameters:

index - int index of the Tab to be activated, this will show the tab content

deActivateTab

public void deActivateTab(int index)

Parameters:

index - int index of the tab to be deactivated, this will hide the tab content

activateTab

public void activateTab(Tab tab)

Parameters:

tab - Tab to be activated, this will show the tab content

activateTab

public void activateTab(Tab tab,
                        boolean silent)

Parameters:

tab - Tab to be activated, this will show the tab content

silent - boolean, if true the tab will be activated without triggering the Tab.ActivationHandlers

deActivateTab

public void deActivateTab(Tab tab)

Parameters:

tab - Tab to be deactivated, this will hide the tab content

deActivateTab

public void deActivateTab(Tab tab,
                          boolean silent)

Parameters:

tab - Tab to be deactivated, this will hide the tab content

silent - boolean, if true the tab will be deactivated without triggering the Tab.ActivationHandlers

setColor

public TabsPanel setColor(Color color)

Parameters:

color - Color of the focus/active color of the tab

Returns:

same TabsPanel instance

setBackgroundColor

public TabsPanel setBackgroundColor(Color background)

Parameters:

background - Color of the TabsPanel header

Returns:

same TabsPanel

element

public elemental2.dom.HTMLDivElement element()

Specified by:

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

Specified by:

element in class BaseDominoElement<elemental2.dom.HTMLDivElement,TabsPanel>

Returns:

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

setTransition

public TabsPanel setTransition(Transition transition)

Parameters:

transition - Transition for activating/deactivating tabs animations

Returns:

same TabsPanel instance

setContentContainer

public TabsPanel setContentContainer(elemental2.dom.HTMLElement contentContainer)

Parameters:

contentContainer - HTMLElement to used as a container element to render active tab content

Returns:

same TabsPanel instance

setContentContainer

public TabsPanel setContentContainer(org.jboss.elemento.IsElement<?> contentContainer)

Parameters:

contentContainer - IsElement to used as a container element to render active tab content

Returns:

same TabsPanel instance

getTabsContent

public DominoElement<elemental2.dom.HTMLElement> getTabsContent()

Returns:

the HTMLElement that is used to as a container element to render active tab content wrapped as DominoElement

getActiveTab

public Tab getActiveTab()

Returns:

the current active Tab

getTabs

public List<Tab> getTabs()

Returns:

List of all Tabs

closeTab

public void closeTab(Tab tab)

Parameters:

tab - Tab to be closed and removed from the TabsPanel

addCloseHandler

public TabsPanel addCloseHandler(Consumer<Tab> closeHandler)

Parameters:

closeHandler - Consumer of Tab to be called when ever a Tab is closed

Returns:

same TabsPanel

removeCloseHandler

public TabsPanel removeCloseHandler(Consumer<Tab> closeHandler)

Parameters:

closeHandler - Consumer of Tab to be called when ever a Tab is closed to be removed

Returns:

same TabsPanel

addActivationHandler

public TabsPanel addActivationHandler(Tab.ActivationHandler activationHandler)

Parameters:

activationHandler - Tab.ActivationHandler

Returns:

same TabsPanel instance

removeActivationHandler

public TabsPanel removeActivationHandler(Tab.ActivationHandler activationHandler)

Parameters:

activationHandler - Tab.ActivationHandler

Returns:

same TabsPanel instance

activateByKey

public TabsPanel activateByKey(String key)

Parameters:

key - String unique key of the currently active tab

Returns:

same TabsPanel instance

activateByKey

public TabsPanel activateByKey(String key,
                               boolean silent)

Parameters:

key - String unique key of the Tab to be activated

silent - boolean, if true the tab will be activated without triggering the Tab.ActivationHandlers

Returns:

isAutoActivate

public boolean isAutoActivate()

Returns:

boolean, if auto-activating is enabled

setAutoActivate

public TabsPanel setAutoActivate(boolean autoActivate)

Parameters:

autoActivate - boolean, if true then the first tab will be automatically activated when the TabsPanel is attached to the DOM

Returns:

same TabsPanel instance

setTabsAlign

public TabsPanel setTabsAlign(TabsAlign align)

Parameters:

align - TabsAlign

Returns:

same TabsPanel instance