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

Class AbstractGroupGridSettingsBinder<V extends JmixGroupGrid<?>,S extends DataGridSettings>

java.lang.Object

io.jmix.groupgridflowui.facet.settings.component.binder.AbstractGroupGridSettingsBinder<V,S>

Type Parameters:

V - the type of the grid component extending Grid

S - the type of the grid settings extending DataGridSettings

All Implemented Interfaces:

ComponentSettingsBinder<V,S>, DataLoadingSettingsBinder<V,S>

Direct Known Subclasses:

GroupDataGridSettingsBinder

public abstract class AbstractGroupGridSettingsBinder<V extends JmixGroupGrid<?>,S extends DataGridSettings>
extends Object
implements DataLoadingSettingsBinder<V,S>

Abstract implementation of the DataLoadingSettingsBinder interface for handling settings binding and persistence in a Grid.

Constructor Summary

Constructors

Constructor	Description
AbstractGroupGridSettingsBinder()

Method Summary

Modifier and Type	Method	Description
void	applyDataLoadingSettings(V component, S settings)	Applies data loading settings.
void	applySettings(V component, S settings)	Applies settings to the component.
protected void	applySorting(V component, S settings)
protected abstract S	createSettings()
protected int	findFirstLeftNeighborIndex(List<? extends Grid.Column<?>> componentColumns, List<Grid.Column<?>> newColumnsOrder, Grid.Column<?> notIncludedColumn)
protected abstract List<? extends Grid.Column<?>>	getAllColumns(V grid)
protected List<? extends Grid.Column<?>>	getApplicableColumns(V component)
protected abstract GroupDataGridItems<?>	getGridItems(V grid)
protected List<? extends Grid.Column<?>>	getOrderedColumns(V grid)
S	getSettings(V component)
protected boolean	isCollectionPropertyContainer(DataGridItems<?> items)
protected boolean	isColumnSettingsChanged(List<? extends Grid.Column<?>> componentColumns, List<DataGridSettings.Column> settingsColumns)
protected boolean	isColumnSortOrderChanged(List<? extends GridSortOrder<?>> componentSortOrder, List<DataGridSettings.SortOrder> settingsSortOrder)
protected boolean	isDataLoadingSettingsEnabled(V grid)
boolean	saveSettings(V component, S settings)	Invoked when component properties or states should be saved to settings.
protected void	setColumnsToSettings(List<? extends Grid.Column<?>> componentColumns, DataGridSettings settings)
protected void	setSortOrderToSettings(List<? extends GridSortOrder<?>> sortOrder, DataGridSettings settings)

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.jmix.flowui.facet.settings.component.binder.ComponentSettingsBinder

getComponentClass, getSettingsClass

Constructor Details

AbstractGroupGridSettingsBinder

public AbstractGroupGridSettingsBinder()

Method Details

applySettings

public void applySettings(V component,
 S settings)

Description copied from interface: ComponentSettingsBinder

Applies settings to the component.

Specified by:

applySettings in interface ComponentSettingsBinder<V extends JmixGroupGrid<?>,S extends DataGridSettings>

Parameters:

component - component

settings - settings for the component

findFirstLeftNeighborIndex

protected int findFirstLeftNeighborIndex(List<? extends Grid.Column<?>> componentColumns,
 List<Grid.Column<?>> newColumnsOrder,
 Grid.Column<?> notIncludedColumn)

applyDataLoadingSettings

public void applyDataLoadingSettings(V component,
 S settings)

Description copied from interface: DataLoadingSettingsBinder

Applies data loading settings.

Specified by:

applyDataLoadingSettings in interface DataLoadingSettingsBinder<V extends JmixGroupGrid<?>,S extends DataGridSettings>

Parameters:

component - component to apply

settings - settings for the component

applySorting

protected void applySorting(V component,
 S settings)

getApplicableColumns

protected List<? extends Grid.Column<?>> getApplicableColumns(V component)

saveSettings

public boolean saveSettings(V component,
 S settings)

Description copied from interface: ComponentSettingsBinder

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

Specified by:

saveSettings in interface ComponentSettingsBinder<V extends JmixGroupGrid<?>,S extends DataGridSettings>

Parameters:

component - component

settings - settings for the component

Returns:

true if settings were modified

getSettings

public S getSettings(V component)

Specified by:

getSettings in interface ComponentSettingsBinder<V extends JmixGroupGrid<?>,S extends DataGridSettings>

Parameters:

component - component

Returns:

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

createSettings

protected abstract S createSettings()

isDataLoadingSettingsEnabled

protected boolean isDataLoadingSettingsEnabled(V grid)

isCollectionPropertyContainer

protected boolean isCollectionPropertyContainer(@Nullable
 DataGridItems<?> items)

getGridItems

@Nullable
protected abstract GroupDataGridItems<?> getGridItems(V grid)

isColumnSortOrderChanged

protected boolean isColumnSortOrderChanged(@Nullable
 List<? extends GridSortOrder<?>> componentSortOrder,
 @Nullable
 List<DataGridSettings.SortOrder> settingsSortOrder)

setSortOrderToSettings

protected void setSortOrderToSettings(List<? extends GridSortOrder<?>> sortOrder,
 DataGridSettings settings)

isColumnSettingsChanged

protected boolean isColumnSettingsChanged(@Nullable
 List<? extends Grid.Column<?>> componentColumns,
 @Nullable
 List<DataGridSettings.Column> settingsColumns)

setColumnsToSettings

protected void setColumnsToSettings(@Nullable
 List<? extends Grid.Column<?>> componentColumns,
 DataGridSettings settings)

getOrderedColumns

protected List<? extends Grid.Column<?>> getOrderedColumns(V grid)

getAllColumns

protected abstract List<? extends Grid.Column<?>> getAllColumns(V grid)