io.jmix.ui.component

Interface SimplePagination

All Superinterfaces:

Component, Component.BelongToFrame, PaginationComponent

All Known Implementing Classes:

SimplePaginationImpl

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

Component that makes a data binding to load data by pages. It contains label with current items count and navigation buttons (next, last etc).

Nested Class Summary

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

PaginationComponent.AfterRefreshEvent, PaginationComponent.BeforeRefreshEvent

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

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	NAME

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

AUTO_SIZE, AUTO_SIZE_PX, FULL_SIZE

Method Summary

Modifier and Type	Method and Description
boolean	isAutoLoad()
void	setAutoLoad(boolean autoLoad) Sets whether items count should be loaded automatically.

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

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

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

getFrame, setFrame

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

Field Detail

NAME

static final java.lang.String NAME

See Also:

Constant Field Values

Method Detail

isAutoLoad

boolean isAutoLoad()

Returns:

whether items count should be loaded automatically

setAutoLoad

@StudioProperty(defaultValue="false")
void setAutoLoad(boolean autoLoad)

Sets whether items count should be loaded automatically. When the autoload is disabled the component doesn't know the total count of items and shows a button with [?]. When it's enabled the component makes a query to get the total count of items and shows it. The default value is false.

Parameters:

autoLoad - pass true to enable auto load, or false otherwise