Class BackToTop

java.lang.Object

org.patternfly.component.BaseComponent<elemental2.dom.HTMLElement, BackToTop>

org.patternfly.component.backtotop.BackToTop

All Implemented Interfaces:

Attachable, ElementAttributeMethods<elemental2.dom.HTMLElement, BackToTop>, ElementClassListMethods<elemental2.dom.HTMLElement, BackToTop>, ElementConsumerMethods<elemental2.dom.HTMLElement, BackToTop>, ElementContainerMethods<elemental2.dom.HTMLElement, BackToTop>, ElementEventMethods<elemental2.dom.HTMLElement, BackToTop>, ElementIdMethods<elemental2.dom.HTMLElement, BackToTop>, ElementQueryMethods<elemental2.dom.HTMLElement>, ElementTextMethods<elemental2.dom.HTMLElement, BackToTop>, HTMLElementAttributeMethods<elemental2.dom.HTMLElement, BackToTop>, HTMLElementDataMethods<elemental2.dom.HTMLElement, BackToTop>, HTMLElementStyleMethods<elemental2.dom.HTMLElement, BackToTop>, HTMLElementVisibilityMethods<elemental2.dom.HTMLElement, BackToTop>, IsElement<elemental2.dom.HTMLElement>, TypedBuilder<elemental2.dom.HTMLElement, BackToTop>, Component, OuiaSupport<elemental2.dom.HTMLElement, BackToTop>

public class BackToTop
extends BaseComponent<elemental2.dom.HTMLElement, BackToTop>
implements Attachable, ElementTextMethods<elemental2.dom.HTMLElement, BackToTop>

The back to top component is a shortcut that allows users to quickly navigate to the top of a lengthy content page.

See Also:

• https://www.patternfly.org/components/back-to-top

Method Summary

Modifier and Type	Method	Description
BackToTop	alwaysVisible()	Same as alwaysVisible(true)
BackToTop	alwaysVisible(boolean alwaysVisible)	Flag to indicate Accordion content is alwaysVisible
void	attach(elemental2.dom.MutationRecord mutationRecord)
static BackToTop	backToTop()
static BackToTop	backToTop(String text)
void	detach(elemental2.dom.MutationRecord mutationRecord)
BackToTop	scrollableSelector(elemental2.dom.HTMLElement element)
BackToTop	scrollableSelector(String selector)
BackToTop	scrollableSelector(Supplier<elemental2.dom.HTMLElement> element)
BackToTop	scrollableSelector(By selector)
String	text()
BackToTop	text(String text)
BackToTop	that()

Methods inherited from class BaseComponent

componentType, element, ouiaComponentType, registerComponent

Methods inherited from class Object

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

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 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 OuiaSupport

initOuia, ouiaId, ouiaSafe, ouiaTransition

Method Details

backToTop

public static BackToTop backToTop()

backToTop

public static BackToTop backToTop(String text)

attach

public void attach(elemental2.dom.MutationRecord mutationRecord)

Specified by:

attach in interface Attachable

detach

public void detach(elemental2.dom.MutationRecord mutationRecord)

Specified by:

detach in interface Attachable

text

public BackToTop text(String text)

Specified by:

text in interface ElementTextMethods<elemental2.dom.HTMLElement, BackToTop>

alwaysVisible

public BackToTop alwaysVisible()

Same as alwaysVisible(true)

alwaysVisible

public BackToTop alwaysVisible(boolean alwaysVisible)

Flag to indicate Accordion content is alwaysVisible

scrollableSelector

public BackToTop scrollableSelector(String selector)

scrollableSelector

public BackToTop scrollableSelector(By selector)

scrollableSelector

public BackToTop scrollableSelector(elemental2.dom.HTMLElement element)

scrollableSelector

public BackToTop scrollableSelector(Supplier<elemental2.dom.HTMLElement> element)

that

public BackToTop that()

Specified by:

that in interface TypedBuilder<elemental2.dom.HTMLElement, BackToTop>

text

public String text()

Specified by:

text in interface ElementTextMethods<elemental2.dom.HTMLElement, BackToTop>