Class Tabs

java.lang.Object

org.patternfly.component.BaseComponent<HTMLElement, Tabs>

org.patternfly.component.tabs.Tabs

All Implemented Interfaces:

Iterable<Tab>, Attachable, ElementAttributeMethods<HTMLElement, Tabs>, ElementClassListMethods<HTMLElement, Tabs>, ElementConsumerMethods<HTMLElement, Tabs>, ElementContainerMethods<HTMLElement, Tabs>, ElementEventMethods<HTMLElement, Tabs>, ElementIdMethods<HTMLElement, Tabs>, ElementQueryMethods<HTMLElement>, HTMLElementAttributeMethods<HTMLElement, Tabs>, HTMLElementDataMethods<HTMLElement, Tabs>, HTMLElementStyleMethods<HTMLElement, Tabs>, HTMLElementVisibilityMethods<HTMLElement, Tabs>, IsElement<HTMLElement>, TypedBuilder<HTMLElement, Tabs>, Component, Expandable<HTMLElement, Tabs>, HasItems<HTMLElement, Tabs, Tab>, Modifiers.Box<HTMLElement, Tabs>, Modifiers.Fill<HTMLElement, Tabs>, Modifiers.PageInsets<HTMLElement, Tabs>, Modifiers.Secondary<HTMLElement, Tabs>, Modifiers.Vertical<HTMLElement, Tabs>

public class Tabs
extends BaseComponent<HTMLElement, Tabs>
implements Attachable, Modifiers.Box<HTMLElement, Tabs>, Expandable<HTMLElement, Tabs>, Modifiers.Fill<HTMLElement, Tabs>, HasItems<HTMLElement, Tabs, Tab>, Modifiers.PageInsets<HTMLElement, Tabs>, Modifiers.Secondary<HTMLElement, Tabs>, Modifiers.Vertical<HTMLElement, Tabs>

Tabs allow users to navigate between views within the same page or context.

See Also:

• https://www.patternfly.org/components/tabs

Method Summary

Modifier and Type	Method	Description
Tabs	add(Tab tab)
<T> Tabs	addItems(Iterable<T> items, Function<T,Tab> display)
Tabs	ariaAddLabel(String label)	Aria-label for the add button.
Tabs	ariaLabel(String label)	Provides an accessible label for the tabs.
Tabs	ariaOverflowLabel(String label)	The aria label applied to the button which toggles the tab overflow menu
Tabs	ariaScrollBackLabel(String label)	Aria-label for the back scroll button
Tabs	ariaScrollForwardLabel(String label)	Aria-label for the forward scroll button
Tabs	ariaToggleLabel(String label)	Aria-label for the expandable toggle
void	attach(MutationRecord mutationRecord)
Tabs	box(boolean box)	Adds/removes modifier(box)
void	clear()
void	close(String identifier)
void	close(Tab tab)
Tabs	closeable()
Tabs	closeable(CloseHandler<Tab> closeHandler)
void	collapse(boolean fireEvent)
boolean	contains(String identifier)
Tab	currentTab()
void	detach(MutationRecord mutationRecord)
void	expand(boolean fireEvent)
Tabs	expandable(Breakpoints<ExpandableModifier> expandable)	Enable expandable vertical tabs at various breakpoints (Modifiers.Vertical.vertical() should be set to true for this to work).
Tabs	expandable(ExpandableModifier expandable)	Same as expandable(breakpoints(default_, expandable))
boolean	expanded()
Tabs	fill(boolean fill)	Adds/removes modifier(fill)
Tabs	initialSelection(String identifier)
Tabs	inset(Breakpoints<Inset> inset)	Insets at various breakpoints.
Tabs	inset(Inset inset)	Same as inset(breakpoints(default_, inset))
boolean	isEmpty()
Tab	item(String identifier)
Iterator<Tab>	iterator()
Tabs	noBorderBottom()	Same as noBorderBottom(true)
Tabs	noBorderBottom(boolean noBorderBottom)	Disables border bottom tab styling on tabs.
Tabs	noInitialSelection()	By default, the first tab is selected initially.
Tabs	onAdd(BiConsumer<Tabs,Tab> onAdd)
Tabs	onAdd(Function<Tabs,Tab> addHandler)	Callback for the 'add' button.
Tabs	onClose(CloseHandler<Tab> closeHandler)
Tabs	onRemove(BiConsumer<Tabs,Tab> onRemove)
Tabs	onSelect(SelectHandler<Tab> selectHandler)
Tabs	onToggle(ToggleHandler<Tabs> toggleHandler)
Tabs	overflowHorizontal()	Flag which places overflowing tabs into a menu triggered by the last tab.
Tabs	overflowHorizontal(String overflowText)	Flag which places overflowing tabs into a menu triggered by the last tab.
Tabs	pageInsets(boolean pageInsets)	Adds/removes modifier(pageInsets)
void	removeItem(String identifier)
Tabs	secondary(boolean secondary)	Enables secondary styling to the tab component
void	select(String identifier)
void	select(String identifier, boolean fireEvent)
void	select(Tab tab)
void	select(Tab tab, boolean fireEvent)
Tabs	showTabCount()	Same as showTabCount(true)
Tabs	showTabCount(boolean showTabCount)	Flag which shows the count of overflowing tabs when enabled
int	size()
Tabs	subtab()	Same as subtab(true)
Tabs	subtab(boolean subtab)	Adds/removes modifier(subtab)
Tab	tab(String id)
static Tabs	tabs()
static <E extends HTMLElement> Tabs	tabs(HTMLContainerBuilder<E> builder)
Tabs	that()
Tabs	toggleText(String text)	Text that appears in the expandable toggle.
Tabs	vertical(boolean vertical)	Adds/removes modifier(vertical)

Methods inherited from class org.patternfly.component.BaseComponent

componentType, element, registerComponent

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.jboss.elemento.ElementAttributeMethods

aria, aria, aria, attr, attr, attr, role, role

Methods inherited from interface org.jboss.elemento.ElementClassListMethods

classList, classList, css, toggle, toggle, toggle

Methods inherited from interface org.jboss.elemento.ElementConsumerMethods

apply, run

Methods inherited from interface org.jboss.elemento.ElementContainerMethods

add, add, add, add, addAll, addAll, addAll, addAll, addAll, addAll

Methods inherited from interface org.jboss.elemento.ElementEventMethods

on, on, on

Methods inherited from interface org.jboss.elemento.ElementIdMethods

id, uniqueId

Methods inherited from interface org.jboss.elemento.ElementQueryMethods

closest, querySelector, querySelectorAll

Methods inherited from interface org.patternfly.component.Expandable

collapse, expand, toggle, toggle

Methods inherited from interface org.patternfly.component.HasItems

addItem, items

Methods inherited from interface org.jboss.elemento.HTMLElementAttributeMethods

title

Methods inherited from interface org.jboss.elemento.HTMLElementDataMethods

data

Methods inherited from interface org.jboss.elemento.HTMLElementStyleMethods

style, style, style, style, style, style

Methods inherited from interface org.jboss.elemento.HTMLElementVisibilityMethods

hidden

Methods inherited from interface org.jboss.elemento.IsElement

element

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Methods inherited from interface org.patternfly.style.Modifiers.Box

box

Methods inherited from interface org.patternfly.style.Modifiers.Fill

fill

Methods inherited from interface org.patternfly.style.Modifiers.PageInsets

pageInsets

Methods inherited from interface org.patternfly.style.Modifiers.Secondary

secondary

Methods inherited from interface org.patternfly.style.Modifiers.Vertical

vertical

Method Details

tabs

public static Tabs tabs()

tabs

public static <E extends HTMLElement> Tabs tabs(HTMLContainerBuilder<E> builder)

attach

public void attach(MutationRecord mutationRecord)

Specified by:

attach in interface Attachable

detach

public void detach(MutationRecord mutationRecord)

Specified by:

detach in interface Attachable

addItems

public <T> Tabs addItems(Iterable<T> items,
 Function<T,Tab> display)

Specified by:

addItems in interface HasItems<HTMLElement, Tabs, Tab>

add

public Tabs add(Tab tab)

Specified by:

add in interface HasItems<HTMLElement, Tabs, Tab>

box

public Tabs box(boolean box)

Description copied from interface: Modifiers.Box

Adds/removes modifier(box)

Specified by:

box in interface Modifiers.Box<HTMLElement, Tabs>

closeable

public Tabs closeable()

closeable

public Tabs closeable(CloseHandler<Tab> closeHandler)

expandable

public Tabs expandable(ExpandableModifier expandable)

Same as expandable(breakpoints(default_, expandable))

expandable

public Tabs expandable(Breakpoints<ExpandableModifier> expandable)

Enable expandable vertical tabs at various breakpoints (Modifiers.Vertical.vertical() should be set to true for this to work).

fill

public Tabs fill(boolean fill)

Description copied from interface: Modifiers.Fill

Adds/removes modifier(fill)

Specified by:

fill in interface Modifiers.Fill<HTMLElement, Tabs>

inset

public Tabs inset(Inset inset)

Same as inset(breakpoints(default_, inset))

inset

public Tabs inset(Breakpoints<Inset> inset)

Insets at various breakpoints.

noBorderBottom

public Tabs noBorderBottom()

Same as noBorderBottom(true)

noBorderBottom

public Tabs noBorderBottom(boolean noBorderBottom)

Disables border bottom tab styling on tabs. Defaults to false. To remove the bottom border, set this prop to true.

pageInsets

public Tabs pageInsets(boolean pageInsets)

Description copied from interface: Modifiers.PageInsets

Adds/removes modifier(pageInsets)

Specified by:

pageInsets in interface Modifiers.PageInsets<HTMLElement, Tabs>

overflowHorizontal

public Tabs overflowHorizontal()

Flag which places overflowing tabs into a menu triggered by the last tab. Unlike other flags, this can only be turned on, but not off.

overflowHorizontal

public Tabs overflowHorizontal(String overflowText)

Flag which places overflowing tabs into a menu triggered by the last tab. Unlike other flags, this can only be turned on, but not off.

noInitialSelection

public Tabs noInitialSelection()

By default, the first tab is selected initially. Call this method to disable thi default behaviour.

initialSelection

public Tabs initialSelection(String identifier)

secondary

public Tabs secondary(boolean secondary)

Enables secondary styling to the tab component

Specified by:

secondary in interface Modifiers.Secondary<HTMLElement, Tabs>

showTabCount

public Tabs showTabCount()

Same as showTabCount(true)

showTabCount

public Tabs showTabCount(boolean showTabCount)

Flag which shows the count of overflowing tabs when enabled

subtab

public Tabs subtab()

Same as subtab(true)

subtab

public Tabs subtab(boolean subtab)

Adds/removes modifier(subtab)

toggleText

public Tabs toggleText(String text)

Text that appears in the expandable toggle. If not set, the text of the selected tab is used.

vertical

public Tabs vertical(boolean vertical)

Description copied from interface: Modifiers.Vertical

Adds/removes modifier(vertical)

Specified by:

vertical in interface Modifiers.Vertical<HTMLElement, Tabs>

that

public Tabs that()

Specified by:

that in interface TypedBuilder<HTMLElement, Tabs>

ariaLabel

public Tabs ariaLabel(String label)

Provides an accessible label for the tabs. Labels should be unique for each set of tabs that are present on a page. When component is set to nav, this prop should be defined to differentiate the tabs from other navigation regions on the page.

ariaAddLabel

public Tabs ariaAddLabel(String label)

Aria-label for the add button.

ariaScrollBackLabel

public Tabs ariaScrollBackLabel(String label)

Aria-label for the back scroll button

ariaScrollForwardLabel

public Tabs ariaScrollForwardLabel(String label)

Aria-label for the forward scroll button

ariaOverflowLabel

public Tabs ariaOverflowLabel(String label)

The aria label applied to the button which toggles the tab overflow menu

ariaToggleLabel

public Tabs ariaToggleLabel(String label)

Aria-label for the expandable toggle

onAdd

public Tabs onAdd(BiConsumer<Tabs,Tab> onAdd)

Specified by:

onAdd in interface HasItems<HTMLElement, Tabs, Tab>

onAdd

public Tabs onAdd(Function<Tabs,Tab> addHandler)

Callback for the 'add' button. Passing this property inserts the 'add' button.

onClose

public Tabs onClose(CloseHandler<Tab> closeHandler)

onRemove

public Tabs onRemove(BiConsumer<Tabs,Tab> onRemove)

Specified by:

onRemove in interface HasItems<HTMLElement, Tabs, Tab>

onSelect

public Tabs onSelect(SelectHandler<Tab> selectHandler)

onToggle

public Tabs onToggle(ToggleHandler<Tabs> toggleHandler)

expanded

public boolean expanded()

Specified by:

expanded in interface Expandable<HTMLElement, Tabs>

Returns:

true if the element's class list has the modifier Classes.expanded, false otherwise.

collapse

public void collapse(boolean fireEvent)

Specified by:

collapse in interface Expandable<HTMLElement, Tabs>

expand

public void expand(boolean fireEvent)

Specified by:

expand in interface Expandable<HTMLElement, Tabs>

close

public void close(String identifier)

close

public void close(Tab tab)

select

public void select(String identifier)

select

public void select(String identifier,
 boolean fireEvent)

select

public void select(Tab tab)

select

public void select(Tab tab,
 boolean fireEvent)

currentTab

public Tab currentTab()

tab

public Tab tab(String id)

iterator

public Iterator<Tab> iterator()

Specified by:

iterator in interface Iterable<Tab>

size

public int size()

Specified by:

size in interface HasItems<HTMLElement, Tabs, Tab>

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface HasItems<HTMLElement, Tabs, Tab>

contains

public boolean contains(String identifier)

Specified by:

contains in interface HasItems<HTMLElement, Tabs, Tab>

item

public Tab item(String identifier)

Specified by:

item in interface HasItems<HTMLElement, Tabs, Tab>

removeItem

public void removeItem(String identifier)

Specified by:

removeItem in interface HasItems<HTMLElement, Tabs, Tab>

clear

public void clear()

Specified by:

clear in interface HasItems<HTMLElement, Tabs, Tab>