io.jmix.ui.settings

Interface ScreenSettings

All Known Implementing Classes:

AbstractScreenSettings, ScreenSettingsJson

public interface ScreenSettings

Base interface for screen settings container. It provides API for putting, getting, removing component settings.

Method Summary

Modifier and Type	Method and Description
java.util.Optional<java.lang.Boolean>	getBoolean(java.lang.String componentId, java.lang.String property)
java.util.Optional<java.lang.Double>	getDouble(java.lang.String componentId, java.lang.String property)
java.util.Optional<java.lang.Integer>	getInteger(java.lang.String componentId, java.lang.String property)
java.util.Optional<java.lang.Long>	getLong(java.lang.String componentId, java.lang.String property)
<T extends ComponentSettings> java.util.Optional<T>	getSettings(java.lang.String componentId, java.lang.Class<T> settingsClass)
<T extends ComponentSettings> T	getSettingsOrCreate(java.lang.String componentId, java.lang.Class<T> settingsClass)
java.util.Optional<java.lang.String>	getString(java.lang.String componentId, java.lang.String property)
boolean	isModified()
ScreenSettings	put(ComponentSettings settings) Puts component's settings, e.g TableSettings.
ScreenSettings	put(java.lang.String componentId, java.lang.String property, java.lang.Boolean value) Puts a Boolean value.
ScreenSettings	put(java.lang.String componentId, java.lang.String property, java.lang.Double value) Puts a Double value.
ScreenSettings	put(java.lang.String componentId, java.lang.String property, java.lang.Integer value) Puts an Integer value.
ScreenSettings	put(java.lang.String componentId, java.lang.String property, java.lang.Long value) Puts a Long value.
ScreenSettings	put(java.lang.String componentId, java.lang.String property, java.lang.String value) Puts a String value.
ScreenSettings	remove(java.lang.String componentId) Removes component's settings if they exist.
ScreenSettings	remove(java.lang.String componentId, java.lang.String property) Removes property of component's settings if it exists.
void	setModified(boolean modified) Set to true if screen settings changed manually.

Method Detail

setModified

void setModified(boolean modified)

Set to true if screen settings changed manually. It will guarantee that settings will be persisted.

Parameters:

modified - whether settings were modified

isModified

boolean isModified()

Returns:

true if screen setting were modified

put

ScreenSettings put(java.lang.String componentId,
                   java.lang.String property,
                   @Nullable
                   java.lang.String value)

Puts a String value. Will replace value if property already exist.

Parameters:

componentId - component id

property - component's property

value - String value

Returns:

current instance of screen settings

put

ScreenSettings put(java.lang.String componentId,
                   java.lang.String property,
                   @Nullable
                   java.lang.Integer value)

Puts an Integer value. Will replace value if property already exist.

Parameters:

componentId - component id

property - component's property

value - Integer value

Returns:

current instance of screen settings

put

ScreenSettings put(java.lang.String componentId,
                   java.lang.String property,
                   @Nullable
                   java.lang.Long value)

Puts a Long value. Will replace value if property already exist.

Parameters:

componentId - component id

property - component's property

value - Long value

Returns:

current instance of screen settings

put

ScreenSettings put(java.lang.String componentId,
                   java.lang.String property,
                   @Nullable
                   java.lang.Double value)

Puts a Double value. Will replace value if property already exist.

Parameters:

componentId - component id

property - component's property

value - Double value

Returns:

current instance of screen settings

put

ScreenSettings put(java.lang.String componentId,
                   java.lang.String property,
                   @Nullable
                   java.lang.Boolean value)

Puts a Boolean value. Will replace value if property already exist.

Parameters:

componentId - component id

property - component's property

value - Boolean value

Returns:

current instance of screen settings

put

ScreenSettings put(ComponentSettings settings)

Puts component's settings, e.g TableSettings. If settings with provided id already exist they will be replaced.

Parameters:

settings - component settings

Returns:

current instance of screen settings

remove

ScreenSettings remove(java.lang.String componentId)

Removes component's settings if they exist.

Parameters:

componentId - component id to remove

Returns:

current instance of screen settings

remove

ScreenSettings remove(java.lang.String componentId,
                      java.lang.String property)

Removes property of component's settings if it exists.

Parameters:

componentId - component id

property - component's property to remove

Returns:

current instance of screen settings

getString

java.util.Optional<java.lang.String> getString(java.lang.String componentId,
                                               java.lang.String property)

Parameters:

componentId - component id

property - component's property

Returns:

String value wrapped in Optional

getInteger

java.util.Optional<java.lang.Integer> getInteger(java.lang.String componentId,
                                                 java.lang.String property)

Parameters:

componentId - component id

property - component's property

Returns:

Integer value wrapped in Optional

getLong

java.util.Optional<java.lang.Long> getLong(java.lang.String componentId,
                                           java.lang.String property)

Parameters:

componentId - component id

property - component's property

Returns:

Long value wrapped in Optional

getDouble

java.util.Optional<java.lang.Double> getDouble(java.lang.String componentId,
                                               java.lang.String property)

Parameters:

componentId - component id

property - component's property

Returns:

Double value wrapped in Optional

getBoolean

java.util.Optional<java.lang.Boolean> getBoolean(java.lang.String componentId,
                                                 java.lang.String property)

Parameters:

componentId - component id

property - component's property

Returns:

Boolean value wrapped in Optional

getSettings

<T extends ComponentSettings> java.util.Optional<T> getSettings(java.lang.String componentId,
                                                                java.lang.Class<T> settingsClass)

Type Parameters:

T - type of component settings class

Parameters:

componentId - component id

settingsClass - settings class

Returns:

component settings wrapped in Optional

getSettingsOrCreate

<T extends ComponentSettings> T getSettingsOrCreate(java.lang.String componentId,
                                                    java.lang.Class<T> settingsClass)

Type Parameters:

T - type of component settings class

Parameters:

componentId - component id

settingsClass - settings class

Returns:

component settings if exist otherwise return created settings with corresponding id