Package org.patternfly.component.jumplinks

Class JumpLinks

java.lang.Object

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

org.patternfly.component.jumplinks.JumpLinks

All Implemented Interfaces:

Attachable, Finder<HTMLElement>, HasElement<HTMLElement,JumpLinks>, HasHTMLElement<HTMLElement,JumpLinks>, IsElement<HTMLElement>, TypedBuilder<HTMLElement,JumpLinks>, Component, Expandable<HTMLElement,JumpLinks>, Modifiers.Vertical<HTMLElement,JumpLinks>

public class JumpLinks
extends BaseComponentFlat<HTMLElement,JumpLinks>
implements Attachable, Expandable<HTMLElement,JumpLinks>, 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	addItem(JumpLinksItem item)
<T> JumpLinks	addItems(Iterable<T> items, Function<T,JumpLinksItem> display)
JumpLinks	ariaLabel(String label)
JumpLinks	ariaToggleLabel(String label)
void	attach(MutationRecord mutationRecord)
JumpLinks	center()	Same as center(true)
JumpLinks	center(boolean center)	Adds/removes modifier(center)
void	collapse(boolean fireEvent)
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).
static JumpLinks	jumpLinks()
static JumpLinks	jumpLinks(String label)
JumpLinks	label(String label)
JumpLinks	onSelect(SelectHandler<JumpLinksItem> selectHandler)
JumpLinks	onToggle(ToggleHandler<JumpLinks> toggleHandler)
JumpLinks	scrollableSelector(HTMLElement element)
JumpLinks	scrollableSelector(String selector)
JumpLinks	scrollableSelector(Supplier<HTMLElement> element)
JumpLinks	scrollableSelector(By selector)
void	select(String itemId)
void	select(String itemId, boolean fireEvent)
void	select(JumpLinksItem item)
void	select(JumpLinksItem item, boolean fireEvent)
void	select(JumpLinksItem item, boolean selected, boolean fireEvent)
JumpLinks	that()
JumpLinks	vertical(boolean vertical)

Methods inherited from class org.patternfly.component.BaseComponentFlat

componentType, element

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.patternfly.component.Expandable

collapse, expand, expanded, toggle, toggle

Methods inherited from interface org.jboss.elemento.Finder

closest, find, findAll

Methods inherited from interface org.jboss.elemento.HasElement

add, apply, aria, aria, aria, attr, attr, attr, classList, classList, css, id, id, innerHtml, on, run, textContent, textNode, toggle, toggle, toggle, uniqueId

Methods inherited from interface org.jboss.elemento.HasHTMLElement

data, hidden, style, style, style, style, style, style, title

Methods inherited from interface org.jboss.elemento.IsElement

element

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

vertical

Method Detail

jumpLinks

public static JumpLinks jumpLinks()

jumpLinks

public static JumpLinks jumpLinks(String label)

attach

public void attach(MutationRecord mutationRecord)

Specified by:

attach in interface Attachable

addItems

public <T> JumpLinks addItems(Iterable<T> items,
                              Function<T,JumpLinksItem> display)

addItem

public JumpLinks addItem(JumpLinksItem item)

add

public JumpLinks add(JumpLinksItem item)

center

public JumpLinks center()

Same as center(true)

center

public JumpLinks center(boolean center)

Adds/removes modifier(center)

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)

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)

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 itemId)

select

public void select(String itemId,
                   boolean fireEvent)

select

public void select(JumpLinksItem item)

select

public void select(JumpLinksItem item,
                   boolean fireEvent)

select

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