io.jmix.ui.component.impl

Class AbstractPagination<T extends JmixAbstractPagination>

java.lang.Object

io.jmix.ui.component.impl.AbstractComponent<T>

io.jmix.ui.component.impl.AbstractPagination<T>

All Implemented Interfaces:

AttachNotifier, Component, Component.BelongToFrame, Component.HasCaption, Component.HasDescription, Component.HasIcon, Component.HasXmlDescriptor, Component.Wrapper, HasContextHelp, HasDebugId, HasHtmlCaption, HasHtmlDescription, HasHtmlSanitizer, PaginationComponent

Direct Known Subclasses:

PaginationImpl, SimplePaginationImpl

public abstract class AbstractPagination<T extends JmixAbstractPagination>
extends AbstractComponent<T>
implements PaginationComponent

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	AbstractPagination.State

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

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

HasContextHelp.ContextHelpIconClickEvent

Field Summary

Fields

Modifier and Type	Field and Description
protected UiComponentProperties	componentProperties
protected PaginationDataBinder	dataBinder
protected java.lang.Integer	itemsPerPageDefaultValue
protected java.util.List<java.lang.Integer>	itemsPerPageOptions
protected com.vaadin.shared.Registration	itemsPerPageValueChangeRegistration
protected io.jmix.core.Messages	messages
protected java.util.List<java.lang.Integer>	processedOptions
protected ThemeConstantsManager	themeConstantsManager
protected java.util.function.Supplier<java.lang.Integer>	totalCountDelegate
protected UiProperties	uiProperties

Fields inherited from class io.jmix.ui.component.impl.AbstractComponent

alignment, applicationContext, component, contextHelpIconClickHandler, contextHelpIconClickListener, descriptionAsHtml, element, frame, htmlSanitizerEnabled, icon, ICON_STYLE, id, parent

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

AUTO_SIZE, AUTO_SIZE_PX, FULL_SIZE

Constructor Summary

Constructors

Constructor and Description
AbstractPagination()

Method Summary

Modifier and Type	Method and Description
io.jmix.core.common.event.Subscription	addAfterRefreshListener(java.util.function.Consumer<PaginationComponent.AfterRefreshEvent> listener) Adds after refresh listener.
io.jmix.core.common.event.Subscription	addBeforeRefreshListener(java.util.function.Consumer<PaginationComponent.BeforeRefreshEvent> listener) Adds before refresh listener.
protected boolean	canSetUnlimitedValue(java.lang.Integer value)
protected void	checkDataBound()
protected boolean	dataBinderContainsItems()
protected int	findClosestValue(int maxResults, java.util.List<java.lang.Integer> optionsList)
protected void	fireAfterRefreshEvent()
protected PaginationComponent.BeforeRefreshEvent	fireBeforeRefreshEvent()
PaginationDataBinder	getDataBinder()
protected java.lang.Integer	getDefaultOptionValue(java.util.List<java.lang.Integer> options, io.jmix.core.metamodel.model.MetaClass metaClass)
protected int	getEntityMaxFetchSize(io.jmix.core.metamodel.model.MetaClass metaClass)
protected int	getEntityPageSize(io.jmix.core.metamodel.model.MetaClass metaClass)
protected com.vaadin.ui.Button	getFirstButton()
protected int	getItemsCountToDisplay()
protected com.vaadin.ui.ComboBox<java.lang.Integer>	getItemsPerPageComboBox()
java.lang.Integer	getItemsPerPageDefaultValue()
java.util.List<java.lang.Integer>	getItemsPerPageOptions()
java.lang.Integer	getItemsPerPageValue() INTERNAL.
protected com.vaadin.ui.Button	getLastButton()
protected com.vaadin.ui.Button	getNextButton()
protected com.vaadin.ui.Button	getPrevButton()
protected int	getTotalCount()
java.util.function.Supplier<java.lang.Integer>	getTotalCountDelegate()
protected void	initItemsPerPageLayout()
protected void	initItemsPerPageOptions()
protected void	initMaxResultValue() Setup MaxResult value to data binder and to items per page ComboBox if it's visible.
protected boolean	isEmptyOrNullDataBinder()
boolean	isItemsPerPageUnlimitedOptionVisible()
boolean	isItemsPerPageVisible()
protected void	onItemsPerPageValueChange(com.vaadin.data.HasValue.ValueChangeEvent<java.lang.Integer> event)
protected java.util.List<java.lang.Integer>	processOptions(java.util.List<java.lang.Integer> options, io.jmix.core.metamodel.model.MetaClass metaClass) Sorts options.
protected void	removeItemsPerPageValueChangeSubscription()
void	setDataBinder(PaginationDataBinder dataBinder) Sets a data binder.
void	setItemsPerPageDefaultValue(java.lang.Integer defaultValue) Sets default value for the items per page ComboBox.
void	setItemsPerPageOptions(java.util.List<java.lang.Integer> options) Sets items per page options which should be used in the ComboBox.
void	setItemsPerPageUnlimitedOptionVisible(boolean unlimitedOptionVisible) Sets visibility of unlimited (null) option value in the items per page ComboBox.
void	setItemsPerPageValue(java.lang.Integer value) INTERNAL.
void	setItemsPerPageVisible(boolean itemsPerPageVisible) Sets visibility of items per page ComboBox.
void	setMessages(io.jmix.core.Messages messages)
protected void	setSilentlyItemsPerPageValue(java.lang.Integer value)
void	setThemeConstantsManager(ThemeConstantsManager themeConstantsManager)
void	setTotalCountDelegate(java.util.function.Supplier<java.lang.Integer> delegate) Sets delegate which is used to get the total count of items.
void	setUiComponentProperties(UiComponentProperties componentProperties)
void	setUiProperties(UiProperties uiProperties)
protected void	setupItemsPerPageValueChangeListener()

Methods inherited from class io.jmix.ui.component.impl.AbstractComponent

addAttachListener, addDetachListener, addStyleName, assignDebugId, attached, detached, getAlignment, getCaption, getComponent, getComposition, getContextHelpIconClickHandler, getContextHelpText, getDebugId, getDescription, getEventHub, getFrame, getHeight, getHeightSizeUnit, getHtmlSanitizer, getIcon, getIconName, getIconResource, getId, getParent, getStyleName, getUiComponentProperties, getUiProperties, getWidth, getWidthSizeUnit, getXmlDescriptor, hasSubscriptions, hasValidationError, isAttached, isCaptionAsHtml, isContextHelpTextHtmlEnabled, isDescriptionAsHtml, isEnabled, isEnabledRecursive, isHtmlSanitizerEnabled, isResponsive, isVisible, isVisibleRecursive, onContextHelpIconClick, publish, removeStyleName, sanitize, setAlignment, setApplicationContext, setCaption, setCaptionAsHtml, setContextHelpIconClickHandler, setContextHelpText, setContextHelpTextHtmlEnabled, setDebugId, setDescription, setDescriptionAsHtml, setEnabled, setFrame, setHeight, setHtmlSanitizerEnabled, setIcon, setIconFromSet, setId, setParent, setResponsive, setStyleName, setValidationError, setVisible, setWidth, setXmlDescriptor, unsubscribe, unwrap, unwrapComposition, unwrapCompositionOrNull, unwrapOrNull, withUnwrapped, withUnwrappedComposition

Methods inherited from class java.lang.Object

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

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

themeConstantsManager

protected ThemeConstantsManager themeConstantsManager

messages

protected io.jmix.core.Messages messages

componentProperties

protected UiComponentProperties componentProperties

uiProperties

protected UiProperties uiProperties

dataBinder

protected PaginationDataBinder dataBinder

totalCountDelegate

protected java.util.function.Supplier<java.lang.Integer> totalCountDelegate

itemsPerPageOptions

protected java.util.List<java.lang.Integer> itemsPerPageOptions

processedOptions

protected java.util.List<java.lang.Integer> processedOptions

itemsPerPageDefaultValue

protected java.lang.Integer itemsPerPageDefaultValue

itemsPerPageValueChangeRegistration

protected com.vaadin.shared.Registration itemsPerPageValueChangeRegistration

Constructor Detail

AbstractPagination

public AbstractPagination()

Method Detail

setThemeConstantsManager

@Autowired
public void setThemeConstantsManager(ThemeConstantsManager themeConstantsManager)

setMessages

@Autowired
public void setMessages(io.jmix.core.Messages messages)

setUiComponentProperties

@Autowired
public void setUiComponentProperties(UiComponentProperties componentProperties)

setUiProperties

@Autowired
public void setUiProperties(UiProperties uiProperties)

getTotalCountDelegate

@Nullable
public java.util.function.Supplier<java.lang.Integer> getTotalCountDelegate()

Specified by:

getTotalCountDelegate in interface PaginationComponent

Returns:

delegate which is used to get the total count of items.

setTotalCountDelegate

public void setTotalCountDelegate(@Nullable
                                  java.util.function.Supplier<java.lang.Integer> delegate)

Description copied from interface: PaginationComponent

Sets delegate which is used to get the total count of items. For instance:

 @Autowired
 private DataManager dataManager;

 @Install(to = "pagination", subject = "totalCountDelegate")
 private Integer paginationTotalCountDelegate() {
     return dataManager.loadValue("select count(e) from demo_User e", Integer.class).one();
 }
 

Specified by:

setTotalCountDelegate in interface PaginationComponent

getDataBinder

@Nullable
public PaginationDataBinder getDataBinder()

Specified by:

getDataBinder in interface PaginationComponent

Returns:

a data binder

addBeforeRefreshListener

public io.jmix.core.common.event.Subscription addBeforeRefreshListener(java.util.function.Consumer<PaginationComponent.BeforeRefreshEvent> listener)

Description copied from interface: PaginationComponent

Adds before refresh listener. It is invoked when data should be refreshed after user actions: click on navigation buttons (next, last etc), change items per page value.

Specified by:

addBeforeRefreshListener in interface PaginationComponent

Returns:

a registration object for removing an event listener

getItemsPerPageValue

@Nullable
public java.lang.Integer getItemsPerPageValue()

INTERNAL.

Returns:

items per page value

setItemsPerPageValue

public void setItemsPerPageValue(@Nullable
                                 java.lang.Integer value)

INTERNAL.

Parameters:

value - items per page value

canSetUnlimitedValue

protected boolean canSetUnlimitedValue(@Nullable
                                       java.lang.Integer value)

fireBeforeRefreshEvent

protected PaginationComponent.BeforeRefreshEvent fireBeforeRefreshEvent()

addAfterRefreshListener

public io.jmix.core.common.event.Subscription addAfterRefreshListener(java.util.function.Consumer<PaginationComponent.AfterRefreshEvent> listener)

Description copied from interface: PaginationComponent

Adds after refresh listener. It is invoked when data is refreshed.

Specified by:

addAfterRefreshListener in interface PaginationComponent

Returns:

a registration object for removing an event listener

fireAfterRefreshEvent

protected void fireAfterRefreshEvent()

isItemsPerPageVisible

public boolean isItemsPerPageVisible()

Specified by:

isItemsPerPageVisible in interface PaginationComponent

Returns:

true if items per page ComboBox is visible

setItemsPerPageVisible

public void setItemsPerPageVisible(boolean itemsPerPageVisible)

Description copied from interface: PaginationComponent

Sets visibility of items per page ComboBox. This ComboBox contains options to limit the number of items for one page. If custom options are not set component will use UiComponentProperties.getPaginationItemsPerPageOptions(). The default value is false.

Specified by:

setItemsPerPageVisible in interface PaginationComponent

isItemsPerPageUnlimitedOptionVisible

public boolean isItemsPerPageUnlimitedOptionVisible()

Specified by:

isItemsPerPageUnlimitedOptionVisible in interface PaginationComponent

Returns:

true if unlimited (null) option should be visible in the items per page ComboBox.

setItemsPerPageUnlimitedOptionVisible

public void setItemsPerPageUnlimitedOptionVisible(boolean unlimitedOptionVisible)

Description copied from interface: PaginationComponent

Sets visibility of unlimited (null) option value in the items per page ComboBox. If unlimited (null) option is selected component will try to load data with UiProperties.getEntityMaxFetchSize(String) limitation. The default value is true.

Specified by:

setItemsPerPageUnlimitedOptionVisible in interface PaginationComponent

getItemsPerPageOptions

public java.util.List<java.lang.Integer> getItemsPerPageOptions()

Specified by:

getItemsPerPageOptions in interface PaginationComponent

Returns:

items per page options.

setItemsPerPageOptions

public void setItemsPerPageOptions(java.util.List<java.lang.Integer> options)

Description copied from interface: PaginationComponent

Sets items per page options which should be used in the ComboBox. Options less than or equal to 0 are ignored, options greater than entity's max fetch size will be replaced by it.

Specified by:

setItemsPerPageOptions in interface PaginationComponent

Parameters:

options - items per page options

See Also:

UiProperties.getEntityMaxFetchSize(String)

getItemsPerPageDefaultValue

@Nullable
public java.lang.Integer getItemsPerPageDefaultValue()

Specified by:

getItemsPerPageDefaultValue in interface PaginationComponent

Returns:

items per page default value or null

setItemsPerPageDefaultValue

public void setItemsPerPageDefaultValue(@Nullable
                                        java.lang.Integer defaultValue)

Description copied from interface: PaginationComponent

Sets default value for the items per page ComboBox.

Specified by:

setItemsPerPageDefaultValue in interface PaginationComponent

setDataBinder

public void setDataBinder(PaginationDataBinder dataBinder)

Description copied from interface: PaginationComponent

Sets a data binder. It is used for managing data loading and dividing data to pages.

Specified by:

setDataBinder in interface PaginationComponent

removeItemsPerPageValueChangeSubscription

protected void removeItemsPerPageValueChangeSubscription()

setupItemsPerPageValueChangeListener

protected void setupItemsPerPageValueChangeListener()

onItemsPerPageValueChange

protected void onItemsPerPageValueChange(com.vaadin.data.HasValue.ValueChangeEvent<java.lang.Integer> event)

setSilentlyItemsPerPageValue

protected void setSilentlyItemsPerPageValue(@Nullable
                                            java.lang.Integer value)

initItemsPerPageLayout

protected void initItemsPerPageLayout()

initItemsPerPageOptions

protected void initItemsPerPageOptions()

initMaxResultValue

protected void initMaxResultValue()

Setup MaxResult value to data binder and to items per page ComboBox if it's visible.

getTotalCount

protected int getTotalCount()

getItemsCountToDisplay

protected int getItemsCountToDisplay()

Returns:

current items count for page

checkDataBound

protected void checkDataBound()

isEmptyOrNullDataBinder

protected boolean isEmptyOrNullDataBinder()

dataBinderContainsItems

protected boolean dataBinderContainsItems()

getFirstButton

protected com.vaadin.ui.Button getFirstButton()

getPrevButton

protected com.vaadin.ui.Button getPrevButton()

getNextButton

protected com.vaadin.ui.Button getNextButton()

getLastButton

protected com.vaadin.ui.Button getLastButton()

getItemsPerPageComboBox

protected com.vaadin.ui.ComboBox<java.lang.Integer> getItemsPerPageComboBox()

getEntityMaxFetchSize

protected int getEntityMaxFetchSize(io.jmix.core.metamodel.model.MetaClass metaClass)

getEntityPageSize

protected int getEntityPageSize(io.jmix.core.metamodel.model.MetaClass metaClass)

getDefaultOptionValue

protected java.lang.Integer getDefaultOptionValue(java.util.List<java.lang.Integer> options,
                                                  io.jmix.core.metamodel.model.MetaClass metaClass)

findClosestValue

protected int findClosestValue(int maxResults,
                               java.util.List<java.lang.Integer> optionsList)

processOptions

protected java.util.List<java.lang.Integer> processOptions(java.util.List<java.lang.Integer> options,
                                                           io.jmix.core.metamodel.model.MetaClass metaClass)

Sorts options. Options less than or equal 0 are ignored. Values greater than MaxFetchSize are replaced by MaxFetchSize.

Parameters:

options - items per page options

metaClass - entity's MetaClass

Returns:

sorted options