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
-
Method Summary
Modifier and TypeMethodDescriptionprotected 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 componentprotected DataGridSettings
protected List<DataGridSettings.ColumnSettings>
getColumnsSettings
(DataGrid dataGrid) protected com.vaadin.ui.Grid
getSettings
(DataGrid dataGrid) Class<? extends ComponentSettings>
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)
-
Constructor Details
-
AbstractDataGridSettingsBinder
public AbstractDataGridSettingsBinder()
-
-
Method Details
-
getComponentClass
- Specified by:
getComponentClass
in interfaceComponentSettingsBinder<DataGrid,
DataGridSettings> - Returns:
- component class, e.g.
TableImpl
-
getSettingsClass
- Specified by:
getSettingsClass
in interfaceComponentSettingsBinder<DataGrid,
DataGridSettings> - Returns:
- component settings class, e.g.
TableSettings
-
applySettings
Description copied from interface:ComponentSettingsBinder
Applies settings to the component- Specified by:
applySettings
in interfaceComponentSettingsBinder<DataGrid,
DataGridSettings> - Parameters:
dataGrid
- componentwrapper
- settings wrapper contains settings for the component
-
applyDataLoadingSettings
Description copied from interface:DataLoadingSettingsBinder
Applies data loading settings.- Specified by:
applyDataLoadingSettings
in interfaceDataLoadingSettingsBinder<DataGrid,
DataGridSettings> - Parameters:
dataGrid
- component to applywrapper
- settings wrapper
-
saveSettings
- Specified by:
saveSettings
in interfaceComponentSettingsBinder<DataGrid,
DataGridSettings> - Parameters:
dataGrid
- componentwrapper
- settings wrapper contains settings for the component- Returns:
- true if settings were modified
-
getSettings
- Specified by:
getSettings
in interfaceComponentSettingsBinder<DataGrid,
DataGridSettings> - Parameters:
dataGrid
- component- Returns:
- current component settings. It retrieves current property values from component and creates new settings instance.
-
getColumnsSettings
-
isApplyDataLoadingSettings
-
applyColumnSettings
protected void applyColumnSettings(DataGrid dataGrid, DataGridSettings settings, Collection<DataGrid.Column> oldColumns) -
isCommonDataGridSettingsChanged
-
isSortPropertySettingsChanged
protected boolean isSortPropertySettingsChanged(DataGrid dataGrid, @Nullable String settingsSortColumnId, @Nullable DataGrid.SortDirection settingsSort) -
createSettings
-
getGrid
-