Package io.jmix.flowui.facet.settings.component.binder

Class SimplePaginationSettingsBinder

java.lang.Object

io.jmix.flowui.facet.settings.component.binder.SimplePaginationSettingsBinder

All Implemented Interfaces:

ComponentSettingsBinder<SimplePagination,SimplePaginationSettings>, DataLoadingSettingsBinder<SimplePagination,SimplePaginationSettings>

@Component("flowui_SimplePaginationSettingsBinder")
public class SimplePaginationSettingsBinder
extends Object
implements DataLoadingSettingsBinder<SimplePagination,SimplePaginationSettings>

Binder class for managing the settings of SimplePagination components. This class is responsible for applying and saving the data loading settings of a SimplePagination component, as well as creating and retrieving SimplePaginationSettings.

Constructor Summary

Constructors

Constructor	Description
SimplePaginationSettingsBinder()

Method Summary

Modifier and Type	Method	Description
void	applyDataLoadingSettings(SimplePagination component, SimplePaginationSettings settings)	Applies data loading settings.
void	applySettings(SimplePagination component, SimplePaginationSettings settings)	Applies settings to the component.
protected SimplePaginationSettings	createSettings()
Class<? extends com.vaadin.flow.component.Component>	getComponentClass()
protected Integer	getItemsPerPageValue(SimplePagination component)
SimplePaginationSettings	getSettings(SimplePagination component)
Class<? extends Settings>	getSettingsClass()
protected boolean	isItemsPerPageValueChanged(SimplePagination component, SimplePaginationSettings settings)
boolean	saveSettings(SimplePagination component, SimplePaginationSettings settings)	Invoked when component properties or states should be saved to settings.

Methods inherited from class java.lang.Object

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

Constructor Details

SimplePaginationSettingsBinder

public SimplePaginationSettingsBinder()

Method Details

getComponentClass

public Class<? extends com.vaadin.flow.component.Component> getComponentClass()

Specified by:

getComponentClass in interface ComponentSettingsBinder<SimplePagination,SimplePaginationSettings>

Returns:

component class, e.g. JmixDetails

getSettingsClass

public Class<? extends Settings> getSettingsClass()

Specified by:

getSettingsClass in interface ComponentSettingsBinder<SimplePagination,SimplePaginationSettings>

Returns:

component settings class, e.g. JmixDetailsSettings

applySettings

public void applySettings(SimplePagination component,
 SimplePaginationSettings settings)

Description copied from interface: ComponentSettingsBinder

Applies settings to the component.

Specified by:

applySettings in interface ComponentSettingsBinder<SimplePagination,SimplePaginationSettings>

Parameters:

component - component

settings - settings for the component

applyDataLoadingSettings

public void applyDataLoadingSettings(SimplePagination component,
 SimplePaginationSettings settings)

Description copied from interface: DataLoadingSettingsBinder

Applies data loading settings.

Specified by:

applyDataLoadingSettings in interface DataLoadingSettingsBinder<SimplePagination,SimplePaginationSettings>

Parameters:

component - component to apply

settings - settings for the component

saveSettings

public boolean saveSettings(SimplePagination component,
 SimplePaginationSettings settings)

Description copied from interface: ComponentSettingsBinder

Invoked when component properties or states should be saved to settings.

Specified by:

saveSettings in interface ComponentSettingsBinder<SimplePagination,SimplePaginationSettings>

Parameters:

component - component

settings - settings for the component

Returns:

true if settings were modified

isItemsPerPageValueChanged

protected boolean isItemsPerPageValueChanged(SimplePagination component,
 SimplePaginationSettings settings)

getSettings

public SimplePaginationSettings getSettings(SimplePagination component)

Specified by:

getSettings in interface ComponentSettingsBinder<SimplePagination,SimplePaginationSettings>

Parameters:

component - component

Returns:

current component settings. It retrieves current property values from component and creates new settings instance.

createSettings

protected SimplePaginationSettings createSettings()

getItemsPerPageValue

@Nullable
protected Integer getItemsPerPageValue(SimplePagination component)