Class AbstractGridSettingsBinder<V extends com.vaadin.flow.component.grid.Grid<?>,S extends DataGridSettings>
java.lang.Object
io.jmix.flowui.facet.settings.component.binder.AbstractGridSettingsBinder<V,S>
- All Implemented Interfaces:
ComponentSettingsBinder<V,
,S> DataLoadingSettingsBinder<V,
S>
- Direct Known Subclasses:
DataGridSettingsBinder
,TreeDataGridSettingsBinder
public abstract class AbstractGridSettingsBinder<V extends com.vaadin.flow.component.grid.Grid<?>,S extends DataGridSettings>
extends Object
implements DataLoadingSettingsBinder<V,S>
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionvoid
applyDataLoadingSettings
(V component, S settings) Applies data loading settings.void
applySettings
(V component, S settings) Applies settings to the component.protected abstract S
protected abstract List<? extends com.vaadin.flow.component.grid.Grid.Column<?>>
getAllColumns
(V grid) protected abstract DataGridItems<?>
getGridItems
(V grid) protected List<? extends com.vaadin.flow.component.grid.Grid.Column<?>>
getOrderedColumns
(V grid) getSettings
(V component) protected boolean
isColumnSettingsChanged
(List<? extends com.vaadin.flow.component.grid.Grid.Column<?>> componentColumns, List<DataGridSettings.Column> settingsColumns) protected boolean
isColumnSortOrderChanged
(List<? extends com.vaadin.flow.component.grid.GridSortOrder<?>> componentSortOrder, List<DataGridSettings.SortOrder> settingsSortOrder) protected boolean
boolean
saveSettings
(V component, S settings) Invoked when component properties or states should be saved to settings.protected void
setColumnsToSettings
(List<? extends com.vaadin.flow.component.grid.Grid.Column<?>> componentColumns, DataGridSettings settings) protected void
setSortOrderToSettings
(List<? extends com.vaadin.flow.component.grid.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
-
AbstractGridSettingsBinder
public AbstractGridSettingsBinder()
-
-
Method Details
-
applySettings
Description copied from interface:ComponentSettingsBinder
Applies settings to the component.- Specified by:
applySettings
in interfaceComponentSettingsBinder<V extends com.vaadin.flow.component.grid.Grid<?>,
S extends DataGridSettings> - Parameters:
component
- componentsettings
- settings for the component
-
applyDataLoadingSettings
Description copied from interface:DataLoadingSettingsBinder
Applies data loading settings.- Specified by:
applyDataLoadingSettings
in interfaceDataLoadingSettingsBinder<V extends com.vaadin.flow.component.grid.Grid<?>,
S extends DataGridSettings> - Parameters:
component
- component to applysettings
- settings for the component
-
saveSettings
Description copied from interface:ComponentSettingsBinder
Invoked when component properties or states should be saved to settings.- Specified by:
saveSettings
in interfaceComponentSettingsBinder<V extends com.vaadin.flow.component.grid.Grid<?>,
S extends DataGridSettings> - Parameters:
component
- componentsettings
- settings for the component- Returns:
true
if settings were modified
-
getSettings
- Specified by:
getSettings
in interfaceComponentSettingsBinder<V extends com.vaadin.flow.component.grid.Grid<?>,
S extends DataGridSettings> - Parameters:
component
- component- Returns:
- current component settings. It retrieves current property values from component and creates new settings instance.
-
createSettings
-
isDataLoadingSettingsEnabled
-
getGridItems
-
isColumnSortOrderChanged
protected boolean isColumnSortOrderChanged(@Nullable List<? extends com.vaadin.flow.component.grid.GridSortOrder<?>> componentSortOrder, @Nullable List<DataGridSettings.SortOrder> settingsSortOrder) -
setSortOrderToSettings
protected void setSortOrderToSettings(List<? extends com.vaadin.flow.component.grid.GridSortOrder<?>> sortOrder, DataGridSettings settings) -
isColumnSettingsChanged
protected boolean isColumnSettingsChanged(@Nullable List<? extends com.vaadin.flow.component.grid.Grid.Column<?>> componentColumns, @Nullable List<DataGridSettings.Column> settingsColumns) -
setColumnsToSettings
protected void setColumnsToSettings(@Nullable List<? extends com.vaadin.flow.component.grid.Grid.Column<?>> componentColumns, DataGridSettings settings) -
getOrderedColumns
-
getAllColumns
-