io.jmix.ui.settings.component.binder

Interface ComponentSettingsBinder<V extends Component,S extends ComponentSettings>

All Known Subinterfaces:

DataLoadingSettingsBinder<V,S>

All Known Implementing Classes:

AbstractDataGridSettingsBinder, AbstractPaginationSettingsBinder, AbstractTableSettingsBinder, DataGridSettingsBinder, FilterSettingsBinder, GroupBoxSettingsBinder, GroupTableSettingsBinder, PaginationSettingsBinder, ResizableTextAreaSettingsBinder, SimplePaginationSettingsBinder, SplitPanelSettingsBinder, TableSettingsBinder, TreeDataGridSettingsBinder, TreeTableSettingsBinder

public interface ComponentSettingsBinder<V extends Component,S extends ComponentSettings>

Base interface for component settings registration. As an example see TableSettingsBinder.

Method Summary

Modifier and Type	Method and Description
void	applySettings(V component, SettingsWrapper wrapper) Applies settings to the component
java.lang.Class<? extends Component>	getComponentClass()
S	getSettings(V component)
java.lang.Class<? extends ComponentSettings>	getSettingsClass()
boolean	saveSettings(V component, SettingsWrapper wrapper)

Method Detail

getComponentClass

java.lang.Class<? extends Component> getComponentClass()

Returns:

component class, e.g. TableImpl

getSettingsClass

java.lang.Class<? extends ComponentSettings> getSettingsClass()

Returns:

component settings class, e.g. TableSettings

applySettings

void applySettings(V component,
                   SettingsWrapper wrapper)

Applies settings to the component

Parameters:

component - component

wrapper - settings wrapper contains settings for the component

saveSettings

boolean saveSettings(V component,
                     SettingsWrapper wrapper)

Parameters:

component - component

wrapper - settings wrapper contains settings for the component

Returns:

true if settings were modified

getSettings

S getSettings(V component)

Parameters:

component - component

Returns:

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