Class Pagination
java.lang.Object
org.patternfly.component.BaseComponent<elemental2.dom.HTMLElement, Pagination>
org.patternfly.component.pagination.Pagination
- All Implemented Interfaces:
ElementAttributeMethods<elemental2.dom.HTMLElement, Pagination>, ElementClassListMethods<elemental2.dom.HTMLElement, Pagination>, ElementConsumerMethods<elemental2.dom.HTMLElement, Pagination>, ElementContainerMethods<elemental2.dom.HTMLElement, Pagination>, ElementEventMethods<elemental2.dom.HTMLElement, Pagination>, ElementIdMethods<elemental2.dom.HTMLElement, Pagination>, ElementQueryMethods<elemental2.dom.HTMLElement>, HTMLElementAttributeMethods<elemental2.dom.HTMLElement, Pagination>, HTMLElementDataMethods<elemental2.dom.HTMLElement, Pagination>, HTMLElementStyleMethods<elemental2.dom.HTMLElement, Pagination>, HTMLElementVisibilityMethods<elemental2.dom.HTMLElement, Pagination>, IsElement<elemental2.dom.HTMLElement>, TypedBuilder<elemental2.dom.HTMLElement, Pagination>, Component, OuiaSupport<elemental2.dom.HTMLElement, Pagination>, Modifiers.Compact<elemental2.dom.HTMLElement, Pagination>, Modifiers.Disabled<elemental2.dom.HTMLElement, Pagination>, Modifiers.PageInsets<elemental2.dom.HTMLElement, Pagination>, Modifiers.Static<elemental2.dom.HTMLElement, Pagination>, Modifiers.Sticky<elemental2.dom.HTMLElement, Pagination>
public class Pagination
extends BaseComponent<elemental2.dom.HTMLElement, Pagination>
implements Modifiers.Compact<elemental2.dom.HTMLElement, Pagination>, Modifiers.Disabled<elemental2.dom.HTMLElement, Pagination>, Modifiers.PageInsets<elemental2.dom.HTMLElement, Pagination>, Modifiers.Static<elemental2.dom.HTMLElement, Pagination>, Modifiers.Sticky<elemental2.dom.HTMLElement, Pagination>
A pagination component allows users to navigate through large content views that have been split across multiple pages.
- See Also:
-
Method Summary
Modifier and TypeMethodDescriptionbottom()Same as bottom(true)bottom(boolean bottom) Adds/removes modifier(bottom).chars(int chars) Sets the width of the page number input field in characters.disabled(boolean disabled) Adds/removes modifier(disabled)Same asdisplay(breakpoints(default_, display))display(Breakpoints<Display> display) Controls which pagination elements are visible at various breakpoints.inset(Breakpoints<Inset> inset) Insets at various breakpoints.Same asinset(breakpoints(default_, inset))booleanonChange(PaginationHandler handler) Registers a handler called when the user changes anything related to pagination (combines all other handlers).onFirst(PaginationHandler handler) Registers a handler called when the user navigates to the first page.onLast(PaginationHandler handler) Registers a handler called when the user navigates to the last page.onNext(PaginationHandler handler) Registers a handler called when the user navigates to the next page.onPageInput(PaginationHandler handler) Registers a handler called when the user enters a page number in the input field.onPageSize(PaginationHandler handler) Registers a handler called when the user changes the page size.onPrevious(PaginationHandler handler) Registers a handler called when the user navigates to the previous page.pageInfo()Returns the current pagination state, including the current page, page size, and total item count.voidUpdates the pagination state and refreshes all UI elements (range text, button states, page input).static PaginationCreates a pagination with an indeterminate total (unknown number of items).static Paginationpagination(PageInfo pageInfo) Creates a pagination with the given page info.Same as stickyBase(true)stickyBase(boolean stickyBase) Flag indicating the pagination should have sticky positioning relative to its container.Same as stickyStuck(true)stickyStuck(boolean stickyStuck) Flag indicating the pagination should have stuck styling, when the pagination is not at the top (for top variant) or bottom (for bottom variant) of the scroll container.that()Methods inherited from class BaseComponent
componentType, element, ouiaComponentType, registerComponentMethods inherited from class Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface ElementAttributeMethods
aria, aria, aria, attr, attr, attr, role, roleMethods inherited from interface ElementClassListMethods
classList, classList, css, toggle, toggle, toggleMethods inherited from interface ElementConsumerMethods
apply, runMethods inherited from interface ElementContainerMethods
add, add, add, add, addAll, addAll, addAll, addAll, addAll, addAllMethods inherited from interface ElementEventMethods
on, on, onMethods inherited from interface ElementIdMethods
id, uniqueIdMethods inherited from interface ElementQueryMethods
closest, querySelector, querySelectorAllMethods inherited from interface HTMLElementAttributeMethods
titleMethods inherited from interface HTMLElementDataMethods
data, dataMethods inherited from interface HTMLElementVisibilityMethods
hiddenMethods inherited from interface Modifiers.Compact
compact, compactMethods inherited from interface Modifiers.Disabled
disabledMethods inherited from interface Modifiers.PageInsets
pageInsets, pageInsetsMethods inherited from interface Modifiers.Static
static_, static_Methods inherited from interface Modifiers.Sticky
sticky, stickyMethods inherited from interface OuiaSupport
initOuia, ouiaId, ouiaSafe, ouiaTransition
-
Method Details
-
pagination
Creates a pagination with an indeterminate total (unknown number of items). -
pagination
Creates a pagination with the given page info. -
bottom
Same as bottom(true) -
bottom
Adds/removes modifier(bottom). Bottom variant hides the range info text. -
chars
Sets the width of the page number input field in characters. -
disabled
Description copied from interface:Modifiers.DisabledAdds/removes modifier(disabled)- Specified by:
disabledin interfaceModifiers.Disabled<elemental2.dom.HTMLElement, Pagination>
-
display
Same asdisplay(breakpoints(default_, display)) -
display
Controls which pagination elements are visible at various breakpoints. -
inset
Same asinset(breakpoints(default_, inset)) -
inset
Insets at various breakpoints. -
stickyBase
Same as stickyBase(true) -
stickyBase
Flag indicating the pagination should have sticky positioning relative to its container. -
stickyStuck
Same as stickyStuck(true) -
stickyStuck
Flag indicating the pagination should have stuck styling, when the pagination is not at the top (for top variant) or bottom (for bottom variant) of the scroll container. -
that
- Specified by:
thatin interfaceTypedBuilder<elemental2.dom.HTMLElement, Pagination>
-
onFirst
Registers a handler called when the user navigates to the first page. -
onPrevious
Registers a handler called when the user navigates to the previous page. -
onNext
Registers a handler called when the user navigates to the next page. -
onLast
Registers a handler called when the user navigates to the last page. -
onPageSize
Registers a handler called when the user changes the page size. -
onPageInput
Registers a handler called when the user enters a page number in the input field. -
onChange
Registers a handler called when the user changes anything related to pagination (combines all other handlers). -
isDisabled
public boolean isDisabled()- Specified by:
isDisabledin interfaceModifiers.Disabled<elemental2.dom.HTMLElement, Pagination>
-
pageInfo
Updates the pagination state and refreshes all UI elements (range text, button states, page input). -
pageInfo
Returns the current pagination state, including the current page, page size, and total item count.- Returns:
- the current page information
-