Package org.opencms.gwt.shared
Class CmsUserSettingsBean
- java.lang.Object
-
- org.opencms.gwt.shared.CmsUserSettingsBean
-
- All Implemented Interfaces:
com.google.gwt.user.client.rpc.IsSerializable
public class CmsUserSettingsBean extends java.lang.Object implements com.google.gwt.user.client.rpc.IsSerializable
Bean for transferring user preference information between the client and the server.
-
-
Constructor Summary
Constructors Constructor Description CmsUserSettingsBean()
Default constructor.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
addSetting(java.lang.String value, CmsXmlContentProperty config, boolean basic)
Adds a user setting.java.util.Map<java.lang.String,CmsXmlContentProperty>
getConfiguration()
Gets the map with the configurations for the individual user settings.java.lang.String
getValue(java.lang.String key)
Gets the value for a given user setting.boolean
isBasic(java.lang.String name)
Returns true if the user setting with the given name is a basic setting
-
-
-
Constructor Detail
-
CmsUserSettingsBean
public CmsUserSettingsBean()
Default constructor.
-
-
Method Detail
-
addSetting
public void addSetting(java.lang.String value, CmsXmlContentProperty config, boolean basic)
Adds a user setting.- Parameters:
value
- the current value of the user settingconfig
- the configuration for the user settingbasic
- true if this is a basic user setting
-
getConfiguration
public java.util.Map<java.lang.String,CmsXmlContentProperty> getConfiguration()
Gets the map with the configurations for the individual user settings.- Returns:
- the user setting configurations, indexed by user setting name
-
getValue
public java.lang.String getValue(java.lang.String key)
Gets the value for a given user setting.- Parameters:
key
- the user setting key- Returns:
- the current value of the user setting
-
isBasic
public boolean isBasic(java.lang.String name)
Returns true if the user setting with the given name is a basic setting- Parameters:
name
- the user setting name- Returns:
- true if this is a basic setting
-
-