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

Class AbstractTableSettingsBinder

java.lang.Object

io.jmix.ui.settings.component.binder.AbstractTableSettingsBinder

All Implemented Interfaces:

ComponentSettingsBinder<Table,TableSettings>, DataLoadingSettingsBinder<Table,TableSettings>

Direct Known Subclasses:

GroupTableSettingsBinder, TableSettingsBinder, TreeTableSettingsBinder

public abstract class AbstractTableSettingsBinder
extends Object
implements DataLoadingSettingsBinder<Table,TableSettings>

Constructor Summary

Constructors

Constructor	Description
AbstractTableSettingsBinder()

Method Summary

Modifier and Type	Method	Description
protected void	applyColumnSettings(TableSettings tableSettings, Table table)
void	applyDataLoadingSettings(Table table, SettingsWrapper wrapper)	Applies data loading settings.
void	applySettings(Table table, SettingsWrapper wrapper)	Applies settings to the component
protected TableSettings	createTableSettings()
Class<? extends Component>	getComponentClass()
protected JmixEnhancedTable	getEnhancedTable(Table table)
TableSettings	getSettings(Table table)
Class<? extends ComponentSettings>	getSettingsClass()
protected List<TableSettings.ColumnSettings>	getTableColumnSettings(Table table)
protected com.vaadin.v7.ui.Table	getVTable(Table table)
protected boolean	isApplyDataLoadingSettings(Table table)
protected boolean	isCommonTableSettingsChanged(TableSettings tableSettings, Table table)
protected boolean	isSettingsSortPropertyChanged(String settingsSortProperty, Boolean settingsSortAscending, Table.SortInfo sortInfo)
boolean	saveSettings(Table table, SettingsWrapper wrapper)

Methods inherited from class java.lang.Object

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

Constructor Details

AbstractTableSettingsBinder

public AbstractTableSettingsBinder()

Method Details

getComponentClass

public Class<? extends Component> getComponentClass()

Specified by:

getComponentClass in interface ComponentSettingsBinder<Table,TableSettings>

Returns:

component class, e.g. TableImpl

getSettingsClass

public Class<? extends ComponentSettings> getSettingsClass()

Specified by:

getSettingsClass in interface ComponentSettingsBinder<Table,TableSettings>

Returns:

component settings class, e.g. TableSettings

applySettings

public void applySettings(Table table,
 SettingsWrapper wrapper)

Description copied from interface: ComponentSettingsBinder

Applies settings to the component

Specified by:

applySettings in interface ComponentSettingsBinder<Table,TableSettings>

Parameters:

table - component

wrapper - settings wrapper contains settings for the component

applyDataLoadingSettings

public void applyDataLoadingSettings(Table table,
 SettingsWrapper wrapper)

Description copied from interface: DataLoadingSettingsBinder

Applies data loading settings.

Specified by:

applyDataLoadingSettings in interface DataLoadingSettingsBinder<Table,TableSettings>

Parameters:

table - component to apply

wrapper - settings wrapper

saveSettings

public boolean saveSettings(Table table,
 SettingsWrapper wrapper)

Specified by:

saveSettings in interface ComponentSettingsBinder<Table,TableSettings>

Parameters:

table - component

wrapper - settings wrapper contains settings for the component

Returns:

true if settings were modified

getSettings

public TableSettings getSettings(Table table)

Specified by:

getSettings in interface ComponentSettingsBinder<Table,TableSettings>

Parameters:

table - component

Returns:

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

createTableSettings

protected TableSettings createTableSettings()

getTableColumnSettings

protected List<TableSettings.ColumnSettings> getTableColumnSettings(Table table)

isCommonTableSettingsChanged

protected boolean isCommonTableSettingsChanged(TableSettings tableSettings,
 Table table)

isSettingsSortPropertyChanged

protected boolean isSettingsSortPropertyChanged(@Nullable
 String settingsSortProperty,
 @Nullable
 Boolean settingsSortAscending,
 @Nullable
 Table.SortInfo sortInfo)

applyColumnSettings

protected void applyColumnSettings(TableSettings tableSettings,
 Table table)

isApplyDataLoadingSettings

protected boolean isApplyDataLoadingSettings(Table table)

getEnhancedTable

protected JmixEnhancedTable getEnhancedTable(Table table)

getVTable

protected com.vaadin.v7.ui.Table getVTable(Table table)