io.jmix.ui.settings

Class ScreenSettingsJson

java.lang.Object

io.jmix.ui.settings.AbstractScreenSettings

io.jmix.ui.settings.ScreenSettingsJson

All Implemented Interfaces:

ScreenSettings

@Component(value="ui_ScreenSettings")
 @Scope(value="prototype")
public class ScreenSettingsJson
extends AbstractScreenSettings

Screen settings that use JSON structure for stored settings.

Field Summary

Fields

Modifier and Type	Field and Description
protected com.google.gson.Gson	gson
protected com.google.gson.JsonArray	root
protected UiSettingsCache	settingsCache

Fields inherited from class io.jmix.ui.settings.AbstractScreenSettings

modified, screenId

Constructor Summary

Constructors

Constructor and Description
ScreenSettingsJson(java.lang.String screenId)

Method Summary

Modifier and Type	Method and Description
protected void	checkNotNullGetConditions(java.lang.String id, java.lang.String property)
protected void	checkNotNullPutConditions(java.lang.String id, java.lang.String property)
void	commit() INTERNAL.
java.util.Optional<java.lang.Boolean>	getBoolean(java.lang.String componentId, java.lang.String property)
protected com.google.gson.JsonObject	getComponent(java.lang.String componentId)
protected com.google.gson.JsonObject	getComponentOrCreate(java.lang.String componentId)
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<com.google.gson.JsonObject>	getJsonSettings(java.lang.String componentId)
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)
protected void	initGson()
protected boolean	isValueNull(com.google.gson.JsonObject json, java.lang.String property)
protected void	loadSettings()
ScreenSettingsJson	put(ComponentSettings settings) Puts component's settings, e.g TableSettings.
protected void	put(com.google.gson.JsonElement json, java.lang.String componentId)
ScreenSettingsJson	put(com.google.gson.JsonObject json)
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.
ScreenSettingsJson	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.

Methods inherited from class io.jmix.ui.settings.AbstractScreenSettings

isModified, setModified

Methods inherited from class java.lang.Object

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

Field Detail

settingsCache

@Autowired(required=false)
protected UiSettingsCache settingsCache

root

protected com.google.gson.JsonArray root

gson

protected com.google.gson.Gson gson

Constructor Detail

ScreenSettingsJson

public ScreenSettingsJson(java.lang.String screenId)

Method Detail

put

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

Description copied from interface: ScreenSettings

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

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

Description copied from interface: ScreenSettings

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

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

Description copied from interface: ScreenSettings

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

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

Description copied from interface: ScreenSettings

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

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

Description copied from interface: ScreenSettings

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

public ScreenSettingsJson put(ComponentSettings settings)

Description copied from interface: ScreenSettings

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

put

public ScreenSettingsJson put(com.google.gson.JsonObject json)

Parameters:

json - json object that represents component settings

Returns:

current instance of ScreenSettings

getString

public 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

public 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

public 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

public 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

public 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

public <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

public <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

remove

public ScreenSettings remove(java.lang.String componentId)

Description copied from interface: ScreenSettings

Removes component's settings if they exist.

Parameters:

componentId - component id to remove

Returns:

current instance of screen settings

remove

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

Description copied from interface: ScreenSettings

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

getJsonSettings

public java.util.Optional<com.google.gson.JsonObject> getJsonSettings(java.lang.String componentId)

Parameters:

componentId - component id

Returns:

json object that represents component settings

put

protected void put(com.google.gson.JsonElement json,
                   java.lang.String componentId)

initGson

protected void initGson()

loadSettings

protected void loadSettings()

commit

public void commit()

Description copied from class: AbstractScreenSettings

INTERNAL. Used by the framework.

Commits screen settings to the store.

Specified by:

commit in class AbstractScreenSettings

getComponentOrCreate

protected com.google.gson.JsonObject getComponentOrCreate(java.lang.String componentId)

getComponent

@Nullable
protected com.google.gson.JsonObject getComponent(java.lang.String componentId)

checkNotNullPutConditions

protected void checkNotNullPutConditions(java.lang.String id,
                                         java.lang.String property)

checkNotNullGetConditions

protected void checkNotNullGetConditions(java.lang.String id,
                                         java.lang.String property)

isValueNull

protected boolean isValueNull(com.google.gson.JsonObject json,
                              java.lang.String property)