Package io.jmix.ui.component

Interface Pagination

All Superinterfaces:

Component, Component.BelongToFrame, PaginationComponent

All Known Implementing Classes:

PaginationImpl

@StudioComponent(caption="Pagination",
                 category="Components",
                 xmlElement="pagination",
                 icon="io/jmix/ui/icon/component/pagination.svg",
                 canvasBehaviour=BOX,
                 documentationURL="https://docs.jmix.io/jmix/%VERSION%/ui/vcl/components/pagination.html",
                 unsupportedProperties={"responsive","enable"})
public interface Pagination
extends PaginationComponent

Component that makes a data binding to load data by pages. It contains page numbers that enable the user to select a specific page.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	Pagination.PageChangeEvent	The event that is fired when the user selects another page or clicks on navigation buttons (next, previous, etc).

Nested classes/interfaces inherited from interface io.jmix.ui.component.Component

Component.Alignment, Component.BelongToFrame, Component.Disposable, Component.Editable, Component.Focusable, Component.HasCaption, Component.HasDescription, Component.HasIcon, Component.HasXmlDescriptor, Component.Wrapper

Nested classes/interfaces inherited from interface io.jmix.ui.component.PaginationComponent

PaginationComponent.AfterRefreshEvent, PaginationComponent.BeforeRefreshEvent

Field Summary

Fields

Modifier and Type	Field	Description
static final String	NAME

Fields inherited from interface io.jmix.ui.component.Component

AUTO_SIZE, AUTO_SIZE_PX, FULL_SIZE

Method Summary

Modifier and Type	Method	Description
Subscription	addPageChangeListener(Consumer<Pagination.PageChangeEvent> listener)	Adds page change listener.
int	getMaxVisiblePages()
void	setMaxVisiblePages(int maxVisiblePages)	Sets the maximum number of visible pages.

Methods inherited from interface io.jmix.ui.component.Component

addStyleName, getAlignment, getHeight, getHeightSizeUnit, getId, getParent, getStyleName, getWidth, getWidthSizeUnit, isEnabled, isEnabledRecursive, isResponsive, isVisible, isVisibleRecursive, removeStyleName, setAlignment, setEnabled, setHeight, setHeightAuto, setHeightFull, setId, setParent, setResponsive, setSizeAuto, setSizeFull, setStyleName, setVisible, setWidth, setWidthAuto, setWidthFull, unwrap, unwrapComposition, unwrapCompositionOrNull, unwrapOrNull, withUnwrapped, withUnwrappedComposition

Methods inherited from interface io.jmix.ui.component.Component.BelongToFrame

getFrame, setFrame

Methods inherited from interface io.jmix.ui.component.PaginationComponent

addAfterRefreshListener, addBeforeRefreshListener, getDataBinder, getItemsPerPageDefaultValue, getItemsPerPageOptions, getTotalCountDelegate, isItemsPerPageUnlimitedOptionVisible, isItemsPerPageVisible, setDataBinder, setItemsPerPageDefaultValue, setItemsPerPageOptions, setItemsPerPageUnlimitedOptionVisible, setItemsPerPageVisible, setTotalCountDelegate

Field Details

NAME

static final String NAME

See Also:

• Constant Field Values

Method Details

getMaxVisiblePages

int getMaxVisiblePages()

Returns:

maximum number of visible pages.

setMaxVisiblePages

@StudioProperty(defaultValue="5")
void setMaxVisiblePages(int maxVisiblePages)

Sets the maximum number of visible pages. The component can have a lot of pages, but users will see a number of pages at once that corresponds to the maximum number of visible pages. For instance, the component has 10 pages and the maximum number of visible pages is 3, so users will see only 3 pages at once. The default value is 5.

addPageChangeListener

Subscription addPageChangeListener(Consumer<Pagination.PageChangeEvent> listener)

Adds page change listener. It will be invoked when the user selects another page or clicks on navigation buttons (next, previous, etc).

Parameters:

listener - listener to add

Returns:

a registration object for removing an event listener