Package io.jmix.ui.settings.component.binder

Class AbstractDataGridSettingsBinder

java.lang.Object

io.jmix.ui.settings.component.binder.AbstractDataGridSettingsBinder

All Implemented Interfaces:

ComponentSettingsBinder<DataGrid,DataGridSettings>, DataLoadingSettingsBinder<DataGrid,DataGridSettings>

Direct Known Subclasses:

DataGridSettingsBinder, TreeDataGridSettingsBinder

public abstract class AbstractDataGridSettingsBinder
extends Object
implements DataLoadingSettingsBinder<DataGrid,DataGridSettings>

Constructor Summary

Constructors

Constructor	Description
AbstractDataGridSettingsBinder()

Method Summary

Modifier and Type	Method	Description
protected void	applyColumnSettings(DataGrid dataGrid, DataGridSettings settings, Collection<DataGrid.Column> oldColumns)
void	applyDataLoadingSettings(DataGrid dataGrid, SettingsWrapper wrapper)	Applies data loading settings.
void	applySettings(DataGrid dataGrid, SettingsWrapper wrapper)	Applies settings to the component
protected DataGridSettings	createSettings()
protected List<DataGridSettings.ColumnSettings>	getColumnsSettings(DataGrid dataGrid)
Class<? extends Component>	getComponentClass()
protected com.vaadin.ui.Grid	getGrid(DataGrid dataGrid)
DataGridSettings	getSettings(DataGrid dataGrid)
Class<? extends ComponentSettings>	getSettingsClass()
protected boolean	isApplyDataLoadingSettings(DataGrid dataGrid)
protected boolean	isCommonDataGridSettingsChanged(DataGrid dataGrid, DataGridSettings settings)
protected boolean	isSortPropertySettingsChanged(DataGrid dataGrid, String settingsSortColumnId, DataGrid.SortDirection settingsSort)
boolean	saveSettings(DataGrid dataGrid, SettingsWrapper wrapper)

Methods inherited from class java.lang.Object

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

Constructor Details

AbstractDataGridSettingsBinder

public AbstractDataGridSettingsBinder()

Method Details

getComponentClass

public Class<? extends Component> getComponentClass()

Specified by:

getComponentClass in interface ComponentSettingsBinder<DataGrid,DataGridSettings>

Returns:

component class, e.g. TableImpl

getSettingsClass

public Class<? extends ComponentSettings> getSettingsClass()

Specified by:

getSettingsClass in interface ComponentSettingsBinder<DataGrid,DataGridSettings>

Returns:

component settings class, e.g. TableSettings

applySettings

public void applySettings(DataGrid dataGrid,
 SettingsWrapper wrapper)

Description copied from interface: ComponentSettingsBinder

Applies settings to the component

Specified by:

applySettings in interface ComponentSettingsBinder<DataGrid,DataGridSettings>

Parameters:

dataGrid - component

wrapper - settings wrapper contains settings for the component

applyDataLoadingSettings

public void applyDataLoadingSettings(DataGrid dataGrid,
 SettingsWrapper wrapper)

Description copied from interface: DataLoadingSettingsBinder

Applies data loading settings.

Specified by:

applyDataLoadingSettings in interface DataLoadingSettingsBinder<DataGrid,DataGridSettings>

Parameters:

dataGrid - component to apply

wrapper - settings wrapper

saveSettings

public boolean saveSettings(DataGrid dataGrid,
 SettingsWrapper wrapper)

Specified by:

saveSettings in interface ComponentSettingsBinder<DataGrid,DataGridSettings>

Parameters:

dataGrid - component

wrapper - settings wrapper contains settings for the component

Returns:

true if settings were modified

getSettings

public DataGridSettings getSettings(DataGrid dataGrid)

Specified by:

getSettings in interface ComponentSettingsBinder<DataGrid,DataGridSettings>

Parameters:

dataGrid - component

Returns:

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

getColumnsSettings

protected List<DataGridSettings.ColumnSettings> getColumnsSettings(DataGrid dataGrid)

isApplyDataLoadingSettings

protected boolean isApplyDataLoadingSettings(DataGrid dataGrid)

applyColumnSettings

protected void applyColumnSettings(DataGrid dataGrid,
 DataGridSettings settings,
 Collection<DataGrid.Column> oldColumns)

isCommonDataGridSettingsChanged

protected boolean isCommonDataGridSettingsChanged(DataGrid dataGrid,
 DataGridSettings settings)

isSortPropertySettingsChanged

protected boolean isSortPropertySettingsChanged(DataGrid dataGrid,
 @Nullable
 String settingsSortColumnId,
 @Nullable
 DataGrid.SortDirection settingsSort)

createSettings

protected DataGridSettings createSettings()

getGrid

protected com.vaadin.ui.Grid getGrid(DataGrid dataGrid)