Package io.jmix.flowui.facet.settings
Class ViewSettingsJson
java.lang.Object
io.jmix.flowui.facet.settings.AbstractViewSettings
io.jmix.flowui.facet.settings.ViewSettingsJson
- All Implemented Interfaces:
ViewSettings
View
settings that uses JSON structure.-
Field Summary
Modifier and TypeFieldDescriptionprotected com.google.gson.Gson
protected com.google.gson.JsonArray
Fields inherited from class io.jmix.flowui.facet.settings.AbstractViewSettings
modified, viewId
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionprotected void
checkNotNullGetConditions
(String id, String property) protected void
checkNotNullPutConditions
(String id, String key) Deletes component's settings by identifier if they exist.Deletes a key of object with provided identifier if it exists.getBoolean
(String id, String key) getInteger
(String id, String key) Optional<com.google.gson.JsonObject>
protected com.google.gson.JsonObject
protected com.google.gson.JsonObject
getSettings
(String id, Class<T> settingsClass) <T extends Settings>
TgetSettingsOrCreate
(String id, Class<T> settingsClass) protected void
initGson()
void
initialize
(String raw) Initializes current instance from serialized settings.protected void
initRoot()
protected boolean
isValueNull
(com.google.gson.JsonObject json, String key) protected void
put
(com.google.gson.JsonObject json) Puts component's settings, e.gJmixDetailsSettings
.Puts a value withBoolean
.Puts a value withDouble
type.Puts a value withInteger
type.Puts a value withLong
type.Puts a value withString
type.Methods inherited from class io.jmix.flowui.facet.settings.AbstractViewSettings
getViewId, isModified, setModified
-
Field Details
-
root
protected com.google.gson.JsonArray root -
gson
protected com.google.gson.Gson gson
-
-
Constructor Details
-
ViewSettingsJson
-
-
Method Details
-
initGson
protected void initGson() -
put
Description copied from interface:ViewSettings
Puts a value withString
type. Will replace value if the same key already exist.- Parameters:
id
- e.g. component idkey
- key with which associated provided value, e.g. component's width or some statevalue
-String
value- Returns:
- current instance of
ViewSettings
-
put
Description copied from interface:ViewSettings
Puts a value withInteger
type. Will replace value if the same key already exist.- Parameters:
id
- e.g. component idkey
- key with which associated provided value, e.g. component's property or some statevalue
-Integer
value- Returns:
- current instance of
ViewSettings
-
put
Description copied from interface:ViewSettings
Puts a value withLong
type. Will replace value if the same key already exist.- Parameters:
id
- e.g. component idkey
- key with which associated provided value, e.g. component's property or some statevalue
-Long
value- Returns:
- current instance of
ViewSettings
-
put
Description copied from interface:ViewSettings
Puts a value withDouble
type. Will replace value if the same key already exist.- Parameters:
id
- e.g. component idkey
- key with which associated provided value, e.g. component's property or some statevalue
-Double
value- Returns:
- current instance of
ViewSettings
-
put
Description copied from interface:ViewSettings
Puts a value withBoolean
. Will replace value if the same key already exist.- Parameters:
id
- e.g. component idkey
- key with which associated provided value, e.g. component's property or some statevalue
-Boolean
value- Returns:
- current instance of
ViewSettings
-
put
Description copied from interface:ViewSettings
Puts component's settings, e.gJmixDetailsSettings
. If setting with provided id already exist it will be replaced.- Parameters:
settings
- object of settings- Returns:
- current instance of
ViewSettings
-
put
- Parameters:
json
- json object that represents settings- Returns:
- current instance of
ViewSettings
-
delete
Description copied from interface:ViewSettings
Deletes component's settings by identifier if they exist.- Parameters:
id
- id to remove, e.g. component id- Returns:
- current instance of
ViewSettings
-
delete
Description copied from interface:ViewSettings
Deletes a key of object with provided identifier if it exists.- Parameters:
id
- e.g. component idkey
- object's key to remove- Returns:
- current instance of
ViewSettings
-
getJsonSettings
- Parameters:
id
- e.g. component id- Returns:
- json object that represents settings
-
getString
- Parameters:
id
- e.g. component idkey
- object's key- Returns:
String
value wrapped inOptional
-
getInteger
- Parameters:
id
- e.g. component idkey
- object's key- Returns:
Integer
value wrapped inOptional
-
getLong
- Parameters:
id
- e.g. component idkey
- object's key- Returns:
Long
value wrapped inOptional
-
getDouble
- Parameters:
id
- e.g. component idkey
- object's key- Returns:
Double
value wrapped inOptional
-
getBoolean
- Parameters:
id
- e.g. component idkey
- object's key- Returns:
Boolean
value wrapped inOptional
-
getSettings
- Type Parameters:
T
- type of settings class- Parameters:
id
- e.g. component idsettingsClass
- settings class- Returns:
- component settings wrapped in
Optional
-
getSettingsOrCreate
- Type Parameters:
T
- type of settings class- Parameters:
id
- e.g. component idsettingsClass
- settings class- Returns:
- object of settings if exists otherwise return created settings with corresponding id
-
initialize
Description copied from interface:ViewSettings
Initializes current instance from serialized settings.- Parameters:
raw
- serialized settings
-
serialize
- Returns:
- serialized settings
-
put
-
getObjectOrCreate
-
getObject
-
checkNotNullPutConditions
-
checkNotNullGetConditions
-
initRoot
protected void initRoot() -
isValueNull
-