Class JumpLinks

java.lang.Object

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

org.patternfly.component.jumplinks.JumpLinks

All Implemented Interfaces:

Iterable<JumpLinksItem>, Attachable, ElementAttributeMethods<HTMLElement, JumpLinks>, ElementClassListMethods<HTMLElement, JumpLinks>, ElementConsumerMethods<HTMLElement, JumpLinks>, ElementContainerMethods<HTMLElement, JumpLinks>, ElementEventMethods<HTMLElement, JumpLinks>, ElementIdMethods<HTMLElement, JumpLinks>, ElementQueryMethods<HTMLElement>, HTMLElementAttributeMethods<HTMLElement, JumpLinks>, HTMLElementDataMethods<HTMLElement, JumpLinks>, HTMLElementStyleMethods<HTMLElement, JumpLinks>, HTMLElementVisibilityMethods<HTMLElement, JumpLinks>, IsElement<HTMLElement>, TypedBuilder<HTMLElement, JumpLinks>, Component, Expandable<HTMLElement, JumpLinks>, HasItems<HTMLElement, JumpLinks, JumpLinksItem>, Modifiers.Center<HTMLElement, JumpLinks>, Modifiers.Vertical<HTMLElement, JumpLinks>

public class JumpLinks
extends BaseComponent<HTMLElement, JumpLinks>
implements Attachable, Modifiers.Center<HTMLElement, JumpLinks>, Expandable<HTMLElement, JumpLinks>, HasItems<HTMLElement, JumpLinks, JumpLinksItem>, Modifiers.Vertical<HTMLElement, JumpLinks>

Jump links allow users to navigate to sections within a page.

See Also:

• https://www.patternfly.org/components/jump-links

Method Summary

Modifier and Type	Method	Description
JumpLinks	add(JumpLinksItem item)
JumpLinks	ariaLabel(String label)
JumpLinks	ariaToggleLabel(String label)
void	attach(MutationRecord mutationRecord)
void	clear()
void	collapse(boolean fireEvent)
boolean	contains(String identifier)
void	expand(boolean fireEvent)
JumpLinks	expandable(Breakpoints<ExpandableModifier> expandable)	When to collapse/expand at different breakpoints (Modifiers.Vertical.vertical() should be set to true for this to work).
JumpLinks	expandable(ExpandableModifier expandable)	Same as expandable(breakpoints(default_, expandable))
boolean	isEmpty()
JumpLinksItem	item(String identifier)
Iterator<JumpLinksItem>	iterator()
static JumpLinks	jumpLinks()
static JumpLinks	jumpLinks(String label)
JumpLinks	label(String label)
JumpLinks	onAdd(BiConsumer<JumpLinks, JumpLinksItem> onAdd)
JumpLinks	onRemove(BiConsumer<JumpLinks, JumpLinksItem> onRemove)
JumpLinks	onSelect(SelectHandler<JumpLinksItem> selectHandler)
JumpLinks	onToggle(ToggleHandler<JumpLinks> toggleHandler)
void	removeItem(String identifier)
JumpLinks	scrollableSelector(HTMLElement element)
JumpLinks	scrollableSelector(String selector)
JumpLinks	scrollableSelector(Supplier<HTMLElement> element)
JumpLinks	scrollableSelector(By selector)
void	select(String identifier)
void	select(String identifier, boolean selected)
void	select(String identifier, boolean selected, boolean fireEvent)
void	select(JumpLinksItem item)
void	select(JumpLinksItem item, boolean selected)
void	select(JumpLinksItem item, boolean fireEvent, boolean selected)
int	size()
JumpLinks	that()
JumpLinks	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.Attachable

detach

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, expanded, toggle, toggle

Methods inherited from interface org.patternfly.component.HasItems

addItem, addItems, 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.Center

center, center

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

vertical

Method Details

jumpLinks

public static JumpLinks jumpLinks()

jumpLinks

public static JumpLinks jumpLinks(String label)

attach

public void attach(MutationRecord mutationRecord)

Specified by:

attach in interface Attachable

add

public JumpLinks add(JumpLinksItem item)

Specified by:

add in interface HasItems<HTMLElement, JumpLinks, JumpLinksItem>

expandable

public JumpLinks expandable(ExpandableModifier expandable)

Same as expandable(breakpoints(default_, expandable))

expandable

public JumpLinks expandable(Breakpoints<ExpandableModifier> expandable)

When to collapse/expand at different breakpoints (Modifiers.Vertical.vertical() should be set to true for this to work).

label

public JumpLinks label(String label)

scrollableSelector

public JumpLinks scrollableSelector(String selector)

scrollableSelector

public JumpLinks scrollableSelector(By selector)

scrollableSelector

public JumpLinks scrollableSelector(HTMLElement element)

scrollableSelector

public JumpLinks scrollableSelector(Supplier<HTMLElement> element)

vertical

public JumpLinks vertical(boolean vertical)

Description copied from interface: Modifiers.Vertical

Adds/removes modifier(vertical)

Specified by:

vertical in interface Modifiers.Vertical<HTMLElement, JumpLinks>

that

public JumpLinks that()

Specified by:

that in interface TypedBuilder<HTMLElement, JumpLinks>

ariaLabel

public JumpLinks ariaLabel(String label)

ariaToggleLabel

public JumpLinks ariaToggleLabel(String label)

onAdd

public JumpLinks onAdd(BiConsumer<JumpLinks, JumpLinksItem> onAdd)

Specified by:

onAdd in interface HasItems<HTMLElement, JumpLinks, JumpLinksItem>

onRemove

public JumpLinks onRemove(BiConsumer<JumpLinks, JumpLinksItem> onRemove)

Specified by:

onRemove in interface HasItems<HTMLElement, JumpLinks, JumpLinksItem>

onSelect

public JumpLinks onSelect(SelectHandler<JumpLinksItem> selectHandler)

onToggle

public JumpLinks onToggle(ToggleHandler<JumpLinks> toggleHandler)

collapse

public void collapse(boolean fireEvent)

Specified by:

collapse in interface Expandable<HTMLElement, JumpLinks>

expand

public void expand(boolean fireEvent)

Specified by:

expand in interface Expandable<HTMLElement, JumpLinks>

select

public void select(String identifier)

select

public void select(String identifier,
 boolean selected)

select

public void select(String identifier,
 boolean selected,
 boolean fireEvent)

select

public void select(JumpLinksItem item)

select

public void select(JumpLinksItem item,
 boolean selected)

select

public void select(JumpLinksItem item,
 boolean fireEvent,
 boolean selected)

iterator

public Iterator<JumpLinksItem> iterator()

Specified by:

iterator in interface Iterable<JumpLinksItem>

size

public int size()

Specified by:

size in interface HasItems<HTMLElement, JumpLinks, JumpLinksItem>

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface HasItems<HTMLElement, JumpLinks, JumpLinksItem>

contains

public boolean contains(String identifier)

Specified by:

contains in interface HasItems<HTMLElement, JumpLinks, JumpLinksItem>

item

public JumpLinksItem item(String identifier)

Specified by:

item in interface HasItems<HTMLElement, JumpLinks, JumpLinksItem>

removeItem

public void removeItem(String identifier)

Specified by:

removeItem in interface HasItems<HTMLElement, JumpLinks, JumpLinksItem>

clear

public void clear()

Specified by:

clear in interface HasItems<HTMLElement, JumpLinks, JumpLinksItem>