org.dominokit.domino.ui.tabs

Class VerticalTabsPanel

java.lang.Object

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

org.dominokit.domino.ui.tabs.VerticalTabsPanel

All Implemented Interfaces:

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

public class VerticalTabsPanel
extends BaseDominoElement<elemental2.dom.HTMLDivElement,VerticalTabsPanel>

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

The tabs in this component will be always aligned vertically

     VerticalTabsPanel.create()
         .apply((element) -> element.getTabsContent().css(Styles.p_l_10))
         .appendChild(
                 VerticalTab.create("HOME")
                         .appendChild(b().textContent("Home Content"))
                         .appendChild(Paragraph.create("SAMPLE_TEXT")))
         .appendChild(
                 VerticalTab.create("PROFILE")
                         .appendChild(b().textContent("Profile Content"))
                         .appendChild(Paragraph.create("SAMPLE_TEXT")))
         .appendChild(
                 VerticalTab.create("MESSAGES")
                         .appendChild(b().textContent("Messages Content"))
                         .appendChild(Paragraph.create("SAMPLE_TEXT"))
                         .activate())
         .appendChild(
                 VerticalTab.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
VerticalTabsPanel()

Method Summary

Modifier and Type	Method and Description
void	activateTab(int index)
void	activateTab(VerticalTab tab)
VerticalTabsPanel	addActivationHandler(VerticalTab.ActivationHandler activationHandler)
VerticalTabsPanel	appendChild(FillItem fillItem)
VerticalTabsPanel	appendChild(VerticalTab tab)
static VerticalTabsPanel	create()
void	deactivateTab(VerticalTab tab)
elemental2.dom.HTMLDivElement	element()
VerticalTab	getActiveTab()
Color	getIconColor()
List<VerticalTab>	getTabs()
VTabsContainer	getTabsContainer()
DominoElement<elemental2.dom.HTMLElement>	getTabsContent()
FlexItem	getTabsHeadersContainer()
Color	getTextColor()
boolean	isActiveTabColored()
VerticalTabsPanel	removeActivationHandler(VerticalTab.ActivationHandler activationHandler)
VerticalTabsPanel	setActiveTabColored(boolean activeTabColored)
VerticalTabsPanel	setBackgroundColor(Color background)
VerticalTabsPanel	setColor(Color color)
VerticalTabsPanel	setContentContainer(elemental2.dom.HTMLElement contentContainer)
VerticalTabsPanel	setContentContainer(org.jboss.elemento.IsElement<?> contentContainer)
VerticalTabsPanel	setIconColor(Color iconColor)
VerticalTabsPanel	setTextColor(Color textColor)
VerticalTabsPanel	setTransition(Transition transition)
VerticalTabsPanel	textBelowIcon() render the tab header title under the tab head icon
VerticalTabsPanel	textBesideIcon() render the tab header title horizontally with the tab header icon

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

VerticalTabsPanel

public VerticalTabsPanel()

Method Detail

create

public static VerticalTabsPanel create()

appendChild

public VerticalTabsPanel appendChild(FillItem fillItem)

Parameters:

fillItem - FillItem to be added between tabs to make more space between them

Returns:

same VerticalTabsPanel instance

appendChild

public VerticalTabsPanel appendChild(VerticalTab tab)

Parameters:

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

Returns:

same VerticalTabsPanel instance

getTextColor

public Color getTextColor()

Returns:

the Color of the tab header text

setTextColor

public VerticalTabsPanel setTextColor(Color textColor)

Parameters:

textColor - Color of the Tab header title

Returns:

same VerticalTabsPanel instance

getIconColor

public Color getIconColor()

Returns:

the Color of the tab header icon

setIconColor

public VerticalTabsPanel setIconColor(Color iconColor)

Parameters:

iconColor - Color of the tab header icon

Returns:

same VerticalTabsPanel instance

activateTab

public void activateTab(int index)

Parameters:

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

activateTab

public void activateTab(VerticalTab tab)

Parameters:

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

deactivateTab

public void deactivateTab(VerticalTab tab)

Parameters:

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

setColor

public VerticalTabsPanel setColor(Color color)

Parameters:

color - Color of the Tabs headers

Returns:

same VerticalTabsPanel instance

isActiveTabColored

public boolean isActiveTabColored()

Returns:

boolean, true if the active tab will have the color from setColor(Color)

setActiveTabColored

public VerticalTabsPanel setActiveTabColored(boolean activeTabColored)

Parameters:

activeTabColored - boolean, if true the active tab will have the color from setColor(Color)

Returns:

same VerticalTabsPanel instance

setBackgroundColor

public VerticalTabsPanel setBackgroundColor(Color background)

Parameters:

background - Color of tabs panel header

Returns:

same VerticalTabsPanel instance

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,VerticalTabsPanel>

Returns:

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

setTransition

public VerticalTabsPanel setTransition(Transition transition)

Parameters:

transition - Transition for activating/deactivating tabs animations

Returns:

same VerticalTabsPanel instance

setContentContainer

public VerticalTabsPanel setContentContainer(elemental2.dom.HTMLElement contentContainer)

Parameters:

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

Returns:

same VerticalTabsPanel instance

setContentContainer

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

Parameters:

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

Returns:

same VerticalTabsPanel 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 VerticalTab getActiveTab()

Returns:

the current active VerticalTab

getTabs

public List<VerticalTab> getTabs()

Returns:

List of all VerticalTabs

textBelowIcon

public VerticalTabsPanel textBelowIcon()

render the tab header title under the tab head icon

Returns:

same VerticalTabsPanel instance

textBesideIcon

public VerticalTabsPanel textBesideIcon()

render the tab header title horizontally with the tab header icon

Returns:

same VerticalTabsPanel instance

getTabsContainer

public VTabsContainer getTabsContainer()

Returns:

the VTabsContainer

getTabsHeadersContainer

public FlexItem getTabsHeadersContainer()

Returns:

the FlexItem that contains the Tabs headers

addActivationHandler

public VerticalTabsPanel addActivationHandler(VerticalTab.ActivationHandler activationHandler)

Parameters:

activationHandler - VerticalTab.ActivationHandler

Returns:

same instance

removeActivationHandler

public VerticalTabsPanel removeActivationHandler(VerticalTab.ActivationHandler activationHandler)

Parameters:

activationHandler - VerticalTab.ActivationHandler

Returns:

same instance