Package io.jmix.kanbanflowui.component.settings.binder

Class KanbanSettingsBinder

java.lang.Object

io.jmix.kanbanflowui.component.settings.binder.KanbanSettingsBinder

All Implemented Interfaces:

ComponentSettingsBinder<Kanban<?>,KanbanSettings>

@Order(1000)
@Component("kanban_KanbanSettingsBinder")
public class KanbanSettingsBinder
extends Object
implements ComponentSettingsBinder<Kanban<?>,KanbanSettings>

Kanban component settings registration.

Constructor Summary

Constructors

Constructor	Description
KanbanSettingsBinder()

Method Summary

Modifier and Type	Method	Description
void	applySettings(Kanban<?> component, KanbanSettings settings)	Applies settings to the component.
protected KanbanSettings.Column	convertToSettings(KanbanColumn column)
protected KanbanSettings	createSettings()
protected List<? extends KanbanColumn>	getColumns(Kanban<?> component)
Class<? extends com.vaadin.flow.component.Component>	getComponentClass()
KanbanSettings	getSettings(Kanban<?> component)
Class<? extends Settings>	getSettingsClass()
protected boolean	isColumnSettingsChanged(List<? extends KanbanColumn> componentColumns, List<KanbanSettings.Column> settingsColumns)
boolean	saveSettings(Kanban<?> component, KanbanSettings settings)	Invoked when component properties or states should be saved to settings.
protected void	setColumnsToSettings(List<? extends KanbanColumn> componentColumns, KanbanSettings settings)

Methods inherited from class java.lang.Object

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

Constructor Details

KanbanSettingsBinder

public KanbanSettingsBinder()

Method Details

getComponentClass

public Class<? extends com.vaadin.flow.component.Component> getComponentClass()

Specified by:

getComponentClass in interface ComponentSettingsBinder<Kanban<?>,KanbanSettings>

Returns:

component class, e.g. JmixDetails

getSettingsClass

public Class<? extends Settings> getSettingsClass()

Specified by:

getSettingsClass in interface ComponentSettingsBinder<Kanban<?>,KanbanSettings>

Returns:

component settings class, e.g. JmixDetailsSettings

applySettings

public void applySettings(Kanban<?> component,
 KanbanSettings settings)

Description copied from interface: ComponentSettingsBinder

Applies settings to the component.

Specified by:

applySettings in interface ComponentSettingsBinder<Kanban<?>,KanbanSettings>

Parameters:

component - component

settings - settings for the component

saveSettings

public boolean saveSettings(Kanban<?> component,
 KanbanSettings settings)

Description copied from interface: ComponentSettingsBinder

Invoked when component properties or states should be saved to settings.

Specified by:

saveSettings in interface ComponentSettingsBinder<Kanban<?>,KanbanSettings>

Parameters:

component - component

settings - settings for the component

Returns:

true if settings were modified

getSettings

public KanbanSettings getSettings(Kanban<?> component)

Specified by:

getSettings in interface ComponentSettingsBinder<Kanban<?>,KanbanSettings>

Parameters:

component - component

Returns:

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

isColumnSettingsChanged

protected boolean isColumnSettingsChanged(@Nullable
 List<? extends KanbanColumn> componentColumns,
 @Nullable
 List<KanbanSettings.Column> settingsColumns)

setColumnsToSettings

protected void setColumnsToSettings(@Nullable
 List<? extends KanbanColumn> componentColumns,
 KanbanSettings settings)

convertToSettings

protected KanbanSettings.Column convertToSettings(KanbanColumn column)

getColumns

protected List<? extends KanbanColumn> getColumns(Kanban<?> component)

createSettings

protected KanbanSettings createSettings()