io.jmix.ui.component.impl

Class SimplePaginationImpl

java.lang.Object

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

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

io.jmix.ui.component.impl.SimplePaginationImpl

All Implemented Interfaces:

AttachNotifier, Component, Component.BelongToFrame, Component.HasCaption, Component.HasDescription, Component.HasIcon, Component.HasXmlDescriptor, Component.Wrapper, HasContextHelp, HasDebugId, HasHtmlCaption, HasHtmlDescription, HasHtmlSanitizer, PaginationComponent, SimplePagination, VisibilityChangeNotifier, org.springframework.beans.factory.InitializingBean

public class SimplePaginationImpl
extends AbstractPagination<JmixSimplePagination>
implements SimplePagination, VisibilityChangeNotifier, org.springframework.beans.factory.InitializingBean

Nested Class Summary

Nested classes/interfaces inherited from class io.jmix.ui.component.impl.AbstractPagination

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.VisibilityChangeNotifier

VisibilityChangeNotifier.VisibilityChangeEvent

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

HasContextHelp.ContextHelpIconClickEvent

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	autoLoad
protected BackgroundWorker	backgroundWorker
protected io.jmix.core.metamodel.datatype.Datatype	countDatatype
protected io.jmix.core.security.CurrentAuthentication	currentAuthentication
protected BackgroundTaskHandler<java.lang.Integer>	itemsCountTaskHandler
protected boolean	lastPage
protected AbstractPagination.State	lastState
protected com.vaadin.shared.Registration	onFirstClickRegistration
protected com.vaadin.shared.Registration	onLastClickRegistration
protected com.vaadin.shared.Registration	onLinkClickRegistration
protected com.vaadin.shared.Registration	onNextClickRegistration
protected com.vaadin.shared.Registration	onPrevClickRegistration
protected boolean	refreshing
protected boolean	samePage
protected int	size
protected int	start
protected AbstractPagination.State	state

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

componentProperties, dataBinder, itemsPerPageDefaultValue, itemsPerPageOptions, itemsPerPageValueChangeRegistration, messages, processedOptions, themeConstantsManager, totalCountDelegate, 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.SimplePagination

NAME

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

AUTO_SIZE, AUTO_SIZE_PX, FULL_SIZE

Constructor Summary

Constructors

Constructor and Description
SimplePaginationImpl()

Method Summary

Modifier and Type	Method and Description
io.jmix.core.common.event.Subscription	addVisibilityChangeListener(java.util.function.Consumer<VisibilityChangeNotifier.VisibilityChangeEvent> listener)
void	afterPropertiesSet()
protected JmixSimplePagination	createComponent()
protected com.vaadin.ui.Button	getCountButton()
protected com.vaadin.ui.Label	getLabel()
protected java.lang.String	getLabelCountValue()
protected java.lang.String	getLabelMessageKey()
protected BackgroundTask<java.lang.Long,java.lang.Integer>	getLoadCountTask()
protected void	initComponent()
protected void	initListeners()
boolean	isAutoLoad()
protected void	loadItemsCount()
protected void	onCollectionChanged()
protected void	onFirstClick(com.vaadin.ui.Button.ClickEvent event)
protected void	onItemsPerPageValueChange(com.vaadin.data.HasValue.ValueChangeEvent<java.lang.Integer> event)
protected void	onLastClick(com.vaadin.ui.Button.ClickEvent event)
protected void	onLinkClick(com.vaadin.ui.Button.ClickEvent event)
protected void	onNextClick(com.vaadin.ui.Button.ClickEvent event)
protected void	onPrevClick(com.vaadin.ui.Button.ClickEvent event)
protected void	onRefreshItems(CollectionChangeType changeType)
protected boolean	refreshData()
protected void	removeListeners()
void	setAutoLoad(boolean autoLoad) Sets whether items count should be loaded automatically.
void	setBackgroundWorker(BackgroundWorker backgroundWorker)
void	setCurrentAuthentication(io.jmix.core.security.CurrentAuthentication currentAuthentication)
void	setDataBinder(PaginationDataBinder dataBinder) Sets a data binder.
void	setDatatypeRegistry(io.jmix.core.metamodel.datatype.DatatypeRegistry datatypeRegistry)
void	setVisible(boolean visible) Sets visibility value for the component.
protected void	showItemsCountValue(int count)
protected void	updateItemsPerPageAvailability()
protected void	updateNavigationButtonsAvailability()
protected void	updateTotalCountButton()

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

addAfterRefreshListener, addBeforeRefreshListener, canSetUnlimitedValue, checkDataBound, dataBinderContainsItems, findClosestValue, fireAfterRefreshEvent, fireBeforeRefreshEvent, getDataBinder, getDefaultOptionValue, getEntityMaxFetchSize, getEntityPageSize, getFirstButton, getItemsCountToDisplay, getItemsPerPageComboBox, getItemsPerPageDefaultValue, getItemsPerPageOptions, getItemsPerPageValue, getLastButton, getNextButton, getPrevButton, getTotalCount, getTotalCountDelegate, initItemsPerPageLayout, initItemsPerPageOptions, initMaxResultValue, isEmptyOrNullDataBinder, isItemsPerPageUnlimitedOptionVisible, isItemsPerPageVisible, processOptions, removeItemsPerPageValueChangeSubscription, setItemsPerPageDefaultValue, setItemsPerPageOptions, setItemsPerPageUnlimitedOptionVisible, setItemsPerPageValue, setItemsPerPageVisible, setMessages, setSilentlyItemsPerPageValue, setThemeConstantsManager, setTotalCountDelegate, setUiComponentProperties, setUiProperties, 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, 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.PaginationComponent

addAfterRefreshListener, addBeforeRefreshListener, getDataBinder, getItemsPerPageDefaultValue, getItemsPerPageOptions, getTotalCountDelegate, isItemsPerPageUnlimitedOptionVisible, isItemsPerPageVisible, 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, setWidth, setWidthAuto, setWidthFull, unwrap, unwrapComposition, unwrapCompositionOrNull, unwrapOrNull, withUnwrapped, withUnwrappedComposition

Field Detail

backgroundWorker

protected BackgroundWorker backgroundWorker

currentAuthentication

protected io.jmix.core.security.CurrentAuthentication currentAuthentication

autoLoad

protected boolean autoLoad

onLinkClickRegistration

protected com.vaadin.shared.Registration onLinkClickRegistration

onPrevClickRegistration

protected com.vaadin.shared.Registration onPrevClickRegistration

onNextClickRegistration

protected com.vaadin.shared.Registration onNextClickRegistration

onFirstClickRegistration

protected com.vaadin.shared.Registration onFirstClickRegistration

onLastClickRegistration

protected com.vaadin.shared.Registration onLastClickRegistration

countDatatype

protected io.jmix.core.metamodel.datatype.Datatype countDatatype

lastPage

protected boolean lastPage

samePage

protected boolean samePage

refreshing

protected boolean refreshing

state

protected AbstractPagination.State state

lastState

protected AbstractPagination.State lastState

start

protected int start

size

protected int size

itemsCountTaskHandler

protected BackgroundTaskHandler<java.lang.Integer> itemsCountTaskHandler

Constructor Detail

SimplePaginationImpl

public SimplePaginationImpl()

Method Detail

createComponent

protected JmixSimplePagination createComponent()

setBackgroundWorker

@Autowired
public void setBackgroundWorker(BackgroundWorker backgroundWorker)

setCurrentAuthentication

@Autowired
public void setCurrentAuthentication(io.jmix.core.security.CurrentAuthentication currentAuthentication)

setDatatypeRegistry

@Autowired
public void setDatatypeRegistry(io.jmix.core.metamodel.datatype.DatatypeRegistry datatypeRegistry)

afterPropertiesSet

public void afterPropertiesSet()

Specified by:

afterPropertiesSet in interface org.springframework.beans.factory.InitializingBean

initComponent

protected void initComponent()

updateItemsPerPageAvailability

protected void updateItemsPerPageAvailability()

isAutoLoad

public boolean isAutoLoad()

Specified by:

isAutoLoad in interface SimplePagination

Returns:

whether items count should be loaded automatically

setAutoLoad

public void setAutoLoad(boolean autoLoad)

Description copied from interface: SimplePagination

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.

Specified by:

setAutoLoad in interface SimplePagination

Parameters:

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

addVisibilityChangeListener

public io.jmix.core.common.event.Subscription addVisibilityChangeListener(java.util.function.Consumer<VisibilityChangeNotifier.VisibilityChangeEvent> listener)

Specified by:

addVisibilityChangeListener in interface VisibilityChangeNotifier

setVisible

public void setVisible(boolean visible)

Description copied from interface: Component

Sets visibility value for the component.
Visible components are drawn in the user interface, while invisible ones are not. The effect is not a cosmetic CSS change - no information about an invisible component will be sent to the client. The effect is thus the same as removing the component from its parent.

Specified by:

setVisible in interface Component

Overrides:

setVisible in class AbstractComponent<JmixSimplePagination>

Parameters:

visible - visible flag

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

Overrides:

setDataBinder in class AbstractPagination<JmixSimplePagination>

initListeners

protected void initListeners()

removeListeners

protected void removeListeners()

onRefreshItems

protected void onRefreshItems(CollectionChangeType changeType)

onFirstClick

protected void onFirstClick(com.vaadin.ui.Button.ClickEvent event)

onPrevClick

protected void onPrevClick(com.vaadin.ui.Button.ClickEvent event)

onNextClick

protected void onNextClick(com.vaadin.ui.Button.ClickEvent event)

onLastClick

protected void onLastClick(com.vaadin.ui.Button.ClickEvent event)

onLinkClick

protected void onLinkClick(com.vaadin.ui.Button.ClickEvent event)

onItemsPerPageValueChange

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

Overrides:

onItemsPerPageValueChange in class AbstractPagination<JmixSimplePagination>

refreshData

protected boolean refreshData()

onCollectionChanged

protected void onCollectionChanged()

updateTotalCountButton

protected void updateTotalCountButton()

getLabelMessageKey

protected java.lang.String getLabelMessageKey()

getLabelCountValue

protected java.lang.String getLabelCountValue()

updateNavigationButtonsAvailability

protected void updateNavigationButtonsAvailability()

loadItemsCount

protected void loadItemsCount()

getLoadCountTask

protected BackgroundTask<java.lang.Long,java.lang.Integer> getLoadCountTask()

showItemsCountValue

protected void showItemsCountValue(int count)

getCountButton

protected com.vaadin.ui.Button getCountButton()

getLabel

protected com.vaadin.ui.Label getLabel()