Package io.jmix.flowui.facet.settings.component.binder

Class SidePanelLayoutSettingsBinder

java.lang.Object

io.jmix.flowui.facet.settings.component.binder.SidePanelLayoutSettingsBinder

All Implemented Interfaces:

ComponentSettingsBinder<SidePanelLayout,SidePanelLayoutSettings>

@Order(1000)
@Component("flowui_SidePanelLayoutSettingsBinder")
public class SidePanelLayoutSettingsBinder
extends Object
implements ComponentSettingsBinder<SidePanelLayout,SidePanelLayoutSettings>

Binder that applies and saves SidePanelLayoutSettings for a SidePanelLayout. Only active when the panel is resizable; fixed panels are left untouched by user settings.

Constructor Summary

Constructors

Constructor	Description
SidePanelLayoutSettingsBinder()

Method Summary

Modifier and Type	Method	Description
void	applySettings(SidePanelLayout component, SidePanelLayoutSettings settings)	Applies settings to the component.
protected SidePanelLayoutSettings	createSettings()
Class<? extends com.vaadin.flow.component.Component>	getComponentClass()
SidePanelLayoutSettings	getSettings(SidePanelLayout component)
Class<? extends Settings>	getSettingsClass()
boolean	saveSettings(SidePanelLayout component, SidePanelLayoutSettings settings)	Invoked when component properties or states should be saved to settings.

Methods inherited from class java.lang.Object

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

Constructor Details

SidePanelLayoutSettingsBinder

public SidePanelLayoutSettingsBinder()

Method Details

getComponentClass

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

Specified by:

getComponentClass in interface ComponentSettingsBinder<SidePanelLayout,SidePanelLayoutSettings>

Returns:

component class, e.g. JmixDetails

getSettingsClass

public Class<? extends Settings> getSettingsClass()

Specified by:

getSettingsClass in interface ComponentSettingsBinder<SidePanelLayout,SidePanelLayoutSettings>

Returns:

component settings class, e.g. JmixDetailsSettings

applySettings

public void applySettings(SidePanelLayout component,
 SidePanelLayoutSettings settings)

Description copied from interface: ComponentSettingsBinder

Applies settings to the component.

Specified by:

applySettings in interface ComponentSettingsBinder<SidePanelLayout,SidePanelLayoutSettings>

Parameters:

component - component

settings - settings for the component

saveSettings

public boolean saveSettings(SidePanelLayout component,
 SidePanelLayoutSettings settings)

Description copied from interface: ComponentSettingsBinder

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

Specified by:

saveSettings in interface ComponentSettingsBinder<SidePanelLayout,SidePanelLayoutSettings>

Parameters:

component - component

settings - settings for the component

Returns:

true if settings were modified

getSettings

public SidePanelLayoutSettings getSettings(SidePanelLayout component)

Specified by:

getSettings in interface ComponentSettingsBinder<SidePanelLayout,SidePanelLayoutSettings>

Parameters:

component - component

Returns:

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

createSettings

protected SidePanelLayoutSettings createSettings()