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)	Adds an item to the component.
JumpLinks	ariaLabel(String label)
JumpLinks	ariaToggleLabel(String label)
void	attach(MutationRecord mutationRecord)
void	clear()	Clears all items from the component.
void	collapse(boolean fireEvent)
boolean	contains(String identifier)	Checks whether the component contains an item associated with the given 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()	Checks whether the collection of items in the component is empty.
JumpLinksItem	item(String identifier)	Retrieves the item associated with the specified identifier from the component.
Iterator<JumpLinksItem>	iterator()
static JumpLinks	jumpLinks()
static JumpLinks	jumpLinks(String label)
JumpLinks	label(String label)
JumpLinks	onAdd(AddItemHandler<JumpLinks, JumpLinksItem> onAdd)	Registers a callback to be invoked whenever a new item is added to the component.
JumpLinks	onRemove(RemoveItemHandler<JumpLinks, JumpLinksItem> onRemove)	Registers a callback to be invoked whenever an item is removed from the component.
JumpLinks	onSelect(SelectHandler<JumpLinksItem> selectHandler)
JumpLinks	onToggle(ToggleHandler<JumpLinks> toggleHandler)
JumpLinks	onUpdate(UpdateItemHandler<JumpLinks, JumpLinksItem> onUpdate)	Registers a callback to be invoked whenever an item is updated in the component.
void	removeItem(String identifier)	Removes an item from the component based on the provided 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()	Retrieves the total number of items currently contained in the component.
JumpLinks	that()
void	updateItem(JumpLinksItem item)	Updates an existing item in the component.
JumpLinks	vertical(boolean vertical)	Adds/removes modifier(vertical)

Methods inherited from class BaseComponent

componentType, element, registerComponent

Methods inherited from class Object

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

Methods inherited from interface Attachable

detach

Methods inherited from interface ElementAttributeMethods

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

Methods inherited from interface ElementClassListMethods

classList, classList, css, toggle, toggle, toggle

Methods inherited from interface ElementConsumerMethods

apply, run

Methods inherited from interface ElementContainerMethods

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

Methods inherited from interface ElementEventMethods

on, on, on

Methods inherited from interface ElementIdMethods

id, uniqueId

Methods inherited from interface ElementQueryMethods

closest, querySelector, querySelectorAll

Methods inherited from interface Expandable

collapse, expand, expanded, toggle, toggle

Methods inherited from interface HasItems

addItem, addItems, items, replaceItemElement, updateItem, updateItem

Methods inherited from interface HTMLElementAttributeMethods

title

Methods inherited from interface HTMLElementDataMethods

data, data

Methods inherited from interface HTMLElementStyleMethods

style, style, style, style, style, style

Methods inherited from interface HTMLElementVisibilityMethods

hidden

Methods inherited from interface IsElement

element

Methods inherited from interface Iterable

forEach, spliterator

Methods inherited from interface Modifiers.Center

center, center

Methods inherited from interface 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)

Description copied from interface: HasItems

Adds an item to the component.

Specified by:

add in interface HasItems<HTMLElement, JumpLinks, JumpLinksItem>

Parameters:

item - the item to be added to the component

Returns:

the builder instance after the item has been added

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(AddItemHandler<JumpLinks, JumpLinksItem> onAdd)

Description copied from interface: HasItems

Registers a callback to be invoked whenever a new item is added to the component.

Specified by:

onAdd in interface HasItems<HTMLElement, JumpLinks, JumpLinksItem>

Parameters:

onAdd - a AddItemHandler that takes the builder instance and the item being added as arguments

Returns:

the builder instance after adding the callback

onUpdate

public JumpLinks onUpdate(UpdateItemHandler<JumpLinks, JumpLinksItem> onUpdate)

Description copied from interface: HasItems

Registers a callback to be invoked whenever an item is updated in the component.

Specified by:

onUpdate in interface HasItems<HTMLElement, JumpLinks, JumpLinksItem>

Parameters:

onUpdate - a UpdateItemHandler that takes the component, the previous state of the item, and the updated state of the item as arguments

Returns:

the builder instance after adding the callback

onRemove

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

Description copied from interface: HasItems

Registers a callback to be invoked whenever an item is removed from the component.

Specified by:

onRemove in interface HasItems<HTMLElement, JumpLinks, JumpLinksItem>

Parameters:

onRemove - a RemoveItemHandler that takes the component and the item being removed as arguments

Returns:

the builder instance after adding the callback

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

Description copied from interface: HasItems

Retrieves the total number of items currently contained in the component.

Specified by:

size in interface HasItems<HTMLElement, JumpLinks, JumpLinksItem>

Returns:

the number of items contained in the component

isEmpty

public boolean isEmpty()

Description copied from interface: HasItems

Checks whether the collection of items in the component is empty.

Specified by:

isEmpty in interface HasItems<HTMLElement, JumpLinks, JumpLinksItem>

Returns:

true if the component contains no items; false otherwise

contains

public boolean contains(String identifier)

Description copied from interface: HasItems

Checks whether the component contains an item associated with the given identifier.

Specified by:

contains in interface HasItems<HTMLElement, JumpLinks, JumpLinksItem>

Parameters:

identifier - the identifier of the item to be checked

Returns:

true if the component contains an item associated with the provided identifier, false otherwise

item

public JumpLinksItem item(String identifier)

Description copied from interface: HasItems

Retrieves the item associated with the specified identifier from the component.

Specified by:

item in interface HasItems<HTMLElement, JumpLinks, JumpLinksItem>

Parameters:

identifier - the identifier of the item to be retrieved

Returns:

the item associated with the given identifier, or null if no item is found

updateItem

public void updateItem(JumpLinksItem item)

Description copied from interface: HasItems

Updates an existing item in the component.

Specified by:

updateItem in interface HasItems<HTMLElement, JumpLinks, JumpLinksItem>

Parameters:

item - the item to be updated

removeItem

public void removeItem(String identifier)

Description copied from interface: HasItems

Removes an item from the component based on the provided identifier.

Specified by:

removeItem in interface HasItems<HTMLElement, JumpLinks, JumpLinksItem>

Parameters:

identifier - the identifier of the item to be removed

clear

public void clear()

Description copied from interface: HasItems

Clears all items from the component. This method removes any existing items within the component, leaving it empty. Any associated or registered callbacks related to the removal of items may be invoked as part of this operation.

Specified by:

clear in interface HasItems<HTMLElement, JumpLinks, JumpLinksItem>