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

Class JmixDetailsSettingsBinder

java.lang.Object

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

All Implemented Interfaces:

ComponentSettingsBinder<JmixDetails,JmixDetailsSettings>

@Order(1000)
@Component("flowui_JmixDetailsSettingsBinder")
public class JmixDetailsSettingsBinder
extends Object
implements ComponentSettingsBinder<JmixDetails,JmixDetailsSettings>

Constructor Summary

Constructors

Constructor	Description
JmixDetailsSettingsBinder()

Method Summary

Modifier and Type	Method	Description
void	applySettings(JmixDetails component, JmixDetailsSettings settings)	Applies settings to the component.
protected JmixDetailsSettings	createSettings()
Class<? extends com.vaadin.flow.component.Component>	getComponentClass()
JmixDetailsSettings	getSettings(JmixDetails component)
Class<? extends Settings>	getSettingsClass()
boolean	saveSettings(JmixDetails component, JmixDetailsSettings 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

JmixDetailsSettingsBinder

public JmixDetailsSettingsBinder()

Method Details

getComponentClass

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

Specified by:

getComponentClass in interface ComponentSettingsBinder<JmixDetails,JmixDetailsSettings>

Returns:

component class, e.g. JmixDetails

getSettingsClass

public Class<? extends Settings> getSettingsClass()

Specified by:

getSettingsClass in interface ComponentSettingsBinder<JmixDetails,JmixDetailsSettings>

Returns:

component settings class, e.g. JmixDetailsSettings

applySettings

public void applySettings(JmixDetails component,
 JmixDetailsSettings settings)

Description copied from interface: ComponentSettingsBinder

Applies settings to the component.

Specified by:

applySettings in interface ComponentSettingsBinder<JmixDetails,JmixDetailsSettings>

Parameters:

component - component

settings - settings for the component

saveSettings

public boolean saveSettings(JmixDetails component,
 JmixDetailsSettings settings)

Description copied from interface: ComponentSettingsBinder

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

Specified by:

saveSettings in interface ComponentSettingsBinder<JmixDetails,JmixDetailsSettings>

Parameters:

component - component

settings - settings for the component

Returns:

true if settings were modified

getSettings

public JmixDetailsSettings getSettings(JmixDetails component)

Specified by:

getSettings in interface ComponentSettingsBinder<JmixDetails,JmixDetailsSettings>

Parameters:

component - component

Returns:

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

createSettings

protected JmixDetailsSettings createSettings()