org.dominokit.domino.ui.tabs

Class VerticalTab

java.lang.Object

org.dominokit.domino.ui.utils.BaseDominoElement<E,T>

org.dominokit.domino.ui.style.WavesElement<elemental2.dom.HTMLDivElement,VerticalTab>

org.dominokit.domino.ui.tabs.VerticalTab

All Implemented Interfaces:

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

public class VerticalTab
extends WavesElement<elemental2.dom.HTMLDivElement,VerticalTab>
implements HasClickableElement

A component for a single Tab in the VerticalTabsPanel

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	VerticalTab.ActivationHandler A function to handle tab activation/deactivation

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.style.WavesElement

wavesSupport

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
VerticalTab	activate() make the tab active and show its content in the TabsPanel
VerticalTab	addActivationHandler(VerticalTab.ActivationHandler activationHandler)
VerticalTab	appendChild(org.jboss.elemento.IsElement<?> content)
VerticalTab	appendChild(elemental2.dom.Node content)
static VerticalTab	create(BaseIcon<?> icon)
static VerticalTab	create(String title)
static VerticalTab	create(String title, BaseIcon<?> icon)
VerticalTab	deactivate() make the tab inactive and hide its content in the TabsPanel
elemental2.dom.HTMLDivElement	element()
elemental2.dom.HTMLAnchorElement	getClickableElement() by default this return the same component root element
DominoElement<elemental2.dom.HTMLDivElement>	getContentContainer()
String	getTitle()
DominoElement<elemental2.dom.HTMLElement>	getTitleElement()
elemental2.dom.HTMLElement	getWavesElement()
boolean	isActive()
VerticalTab	removeActivationHandler(VerticalTab.ActivationHandler activationHandler)
VerticalTab	resetColor() Restores the tab color to the default
VerticalTab	setColor(Color color)
VerticalTab	setIcon(BaseIcon<?> icon)
VerticalTab	setIconColor(Color iconColor)
VerticalTab	setIconColorOverride(Color iconColor) Override the tab icon color and prevent it from changing with setIconColor(Color)
VerticalTab	setTextColor(Color textColor)
VerticalTab	setTextColorOverride(Color textColor) Override the tab title text color and prevent it from changing with setTextColor(Color)
VerticalTab	setTitle(String title)

Methods inherited from class org.dominokit.domino.ui.style.WavesElement

applyWaveStyle, init, initWaves, removeWaves, setWaveColor

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, hasAttribute, hasChildNodes, hasDirectChild, hide, hideOn, id, 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, 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

VerticalTab

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

Parameters:

title - String tab header title

icon - icon BaseIcon for the tab header

VerticalTab

public VerticalTab(String title)

Parameters:

title - String title for the tab

VerticalTab

public VerticalTab(BaseIcon<?> icon)

Parameters:

icon - BaseIcon for the tab header

Method Detail

create

public static VerticalTab create(String title)

Parameters:

title - String tab header title

Returns:

new instance

create

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

Parameters:

title - String title for the tab header

icon - icon BaseIcon for the tab header

Returns:

new instance

create

public static VerticalTab create(BaseIcon<?> icon)

Parameters:

icon - icon BaseIcon for the tab header

Returns:

new instance

getContentContainer

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

Returns:

the HTMLDivElement that contains the VerticalTab content

activate

public VerticalTab activate()

make the tab active and show its content in the TabsPanel

Returns:

same instance

deactivate

public VerticalTab deactivate()

make the tab inactive and hide its content in the TabsPanel

Returns:

same instance

appendChild

public VerticalTab appendChild(elemental2.dom.Node content)

Specified by:

appendChild in interface HasChildren<VerticalTab>

Overrides:

appendChild in class BaseDominoElement<elemental2.dom.HTMLDivElement,VerticalTab>

Parameters:

content - Node to be appended to the tab contentContainer

Returns:

same instance

setTitle

public VerticalTab setTitle(String title)

Parameters:

title - String new tab header title

Returns:

same instance

appendChild

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

Specified by:

appendChild in interface HasChildren<VerticalTab>

Overrides:

appendChild in class BaseDominoElement<elemental2.dom.HTMLDivElement,VerticalTab>

Parameters:

content - IsElement to be appended to the tab contentContainer

Returns:

same instance

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.HTMLDivElement,VerticalTab>

Returns:

the HTMLElement that should receive and click listeners

setIcon

public VerticalTab setIcon(BaseIcon<?> icon)

Parameters:

icon - the new BaseIcon for the tab header

Returns:

same instance

getTitle

public String getTitle()

Returns:

String tab header title

isActive

public boolean isActive()

Returns:

boolean, true if the tab is currently active

getTitleElement

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

Returns:

the HTMLElement that contains the tab header title

getWavesElement

public elemental2.dom.HTMLElement getWavesElement()

Specified by:

getWavesElement in interface HasWavesElement

Overrides:

getWavesElement in class BaseDominoElement<elemental2.dom.HTMLDivElement,VerticalTab>

Returns:

the HTMLElement that has the waves effect

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

Returns:

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

setTextColor

public VerticalTab setTextColor(Color textColor)

Parameters:

textColor - Color of the tab title text

Returns:

same instance

setIconColor

public VerticalTab setIconColor(Color iconColor)

Parameters:

iconColor - Color of the tab header icon

Returns:

same instance

setTextColorOverride

public VerticalTab setTextColorOverride(Color textColor)

Override the tab title text color and prevent it from changing with setTextColor(Color)

Parameters:

textColor - Color

Returns:

same instance

setIconColorOverride

public VerticalTab setIconColorOverride(Color iconColor)

Override the tab icon color and prevent it from changing with setIconColor(Color)

Parameters:

iconColor - Color

Returns:

same instance

addActivationHandler

public VerticalTab addActivationHandler(VerticalTab.ActivationHandler activationHandler)

Parameters:

activationHandler - VerticalTab.ActivationHandler

Returns:

same instance

removeActivationHandler

public VerticalTab removeActivationHandler(VerticalTab.ActivationHandler activationHandler)

Parameters:

activationHandler - VerticalTab.ActivationHandler

Returns:

same instance

setColor

public VerticalTab setColor(Color color)

Parameters:

color - Color of the tab header

Returns:

same instance

resetColor

public VerticalTab resetColor()

Restores the tab color to the default

Returns:

same instance