public class

PreferencesBeanImpl

extends AbstractPersistableAppComponent
implements PreferencesBean

java.lang.Object
↳	com.microstrategy.utils.serialization.AbstractPersistable
	↳	com.microstrategy.web.beans.AbstractTransformable
		↳	com.microstrategy.web.beans.AbstractWebComponent
			↳	com.microstrategy.web.app.beans.AbstractAppComponent
				↳	com.microstrategy.web.app.beans.AbstractPersistableAppComponent
					↳	com.microstrategy.web.app.beans.PreferencesBeanImpl

Known Direct Subclasses

OptionsBeanImpl

This class is deprecated.
this class will be made non-public

Class Overview

The PreferencesBean is an application level bean that allows end users to set their preferences values. Preferences allows users to customize the application to their own settings.
Preferences are managed by the Preferences class, which is an application level object shared through the appContext class. The PreferencesBean is responsible to present the end-user graphical interface and to handle the events of updating the Preferences values.
Graphically, preferences are grouped based on the level and their usage. Usually for the level, we would have user and administrator preferences. User preferences apply only to the current user and project; administrator preferences are only available to administrator and are applied to all users. On the usage we have groups like General, Grid display, Graph display, etc. We have groups that only apply at the user level, such as History List; we also have groups that only apply at the admin level, such as Login.
The PreferencesBean extends the AppComponent (the base for all Application beans). It provides an initFromXml() method which receives a Node and creates the internal structures for groups and group-sets.
It provides methods to retrieve/set the current group/group-set based on its name.
It has an EventHandler, this event handler is the one responsible to receive the request, update the Preferences or set the current group/group-set from it.
Each group will define the transform it should use to render the preferences. The generateOutput() method (inherited from WebComponent) will check which is the current group, and will call its transform to generate the MarkupOutput.
The class also provides a method to return a MarkupOutput to use to render the groups list.
It implements Persistable. We would use this to save the state of the bean. On the state the current group and group-set are saved.

Summary

Nested Classes
class	PreferencesBeanImpl.GroupInfoImpl	This class stores the data structure necessary for each group/group-set.

Constants
String	PREFERENCE_CURRENT_GROUP
String	PREFERENCE_CURRENT_GROUP_SET
String	SEPARATOR

[Expand]

Inherited Constants

From class com.microstrategy.web.app.beans.AbstractPersistableAppComponent

From interface com.microstrategy.utils.serialization.EnumWebPersistableState

From interface com.microstrategy.web.app.beans.AppComponent

From interface com.microstrategy.web.app.beans.PreferencesBean

Fields
protected final String	TOKEN_DIV
protected String	_applyToAllProjects
protected String	_currentGroup
protected String	_currentGroupSet
protected String	_prevGroupName

[Expand]

Inherited Fields

From class com.microstrategy.web.beans.AbstractWebComponent

From class com.microstrategy.web.beans.AbstractTransformable

From class com.microstrategy.utils.serialization.AbstractPersistable

Public Methods
void	afterUpdate(Map pValues, PreferencesException ex)
void	collectData() Triggers execution to the back end no matter whether it is synchronous or asynchronous.
MarkupOutput	generateOutput() Uses a transform to generate the output.
String	getApplyToAllProjects() Whether to apply the changes to all projects
String	getCurrentGroup() Returns the current group's title.
PreferencesBean.GroupInfo	getCurrentGroupInfo() Returns the current group info structure:
String	getCurrentGroupName() Returns the current group's name.
String	getCurrentGroupSet() Returns which is the current groupset
PreferencesBean.GroupInfo	getCurrentGroupSetInfo()
PreferenceLevel	getCurrentLevel() Returns the preferences level of the current preferences group
FeatureInfos	getFeatureInfos()
PreferencesBean.GroupInfo	getGroupSetInfo(String groupSetName)
String	getPrevGroupName() Returns the previous group's name.
boolean	getSettingVisibility(String settingDiv) Retrieves the boolean value indicating whether we should render the advanced setting Div with Id as setting Div as visible.
Map	getTemporalValues()
int	getType() Returns the transformable type as in `EnumWebTransformableType`.
PreferencesException	getValidationErrors()
String	getValidationMessage(String name)
Map	getValues()
int	getXMLStatus() Returns the EnumRequestStatus status of the bean.
boolean	hasValidationErrors()
boolean	havePreferencesChanged() Determines if the user has attemped to change the preferences on a page.
boolean	initFromXML(Element root) Initialize the groups/group-sets from the information of the root
boolean	isLoginRequired()
boolean	isValidLevel(String level) Determine if the user has all the privileges required for accessing the preferences under the specified level.
boolean	isValidPreference(String name)
MarkupOutput	renderGroupsList() Returns the output to render the groups list.
MarkupOutput	renderGroupsList(boolean ignoreCurrent) Returns the output to render the groups list.
void	setApplyToAllProjects(String applyToAllProjects) Sets whether to apply the changes to all projects
void	setBeanContext(BeanContext beanContext) Extends setBeanContext by auto-initializing this bean.
void	setCurrentGroup(String currentGroup) Sets the current group.
void	setCurrentGroupSet(String currentGroupSet) Sets the current groupset.
void	setIsLoginRequired(boolean value) This method is deprecated. `isLoginRequired()` can be determined automatically
void	setPrevGroupName(String prevGroupName) Set the previous group's name.
void	setSettingVisibility(String settingDiv, String visible) Set the value in the Hashmap _advSettingsVisibility.
void	setXMLStatus(int status) Set the `EnumRequestStatus` status of the bean.
void	toggleSettingsVisibility(String settingDiv) Toggle the value in the Hashmap _advSettingsVisibility.

Protected Methods
void	doFlatState(FlatStateSerializer serializer, int howMuchState, FlatStateTokenizer tokenizer) Proceses the save/restore state opperation of the AppComponent
int	getVisibleGroupSetCount()
WebEventHandler	newDefaultEventHandler()

[Expand]

Inherited Methods

From class com.microstrategy.web.app.beans.AbstractPersistableAppComponent

From class com.microstrategy.web.app.beans.AbstractAppComponent

void	addChildStateInfo(ParameterBuilder paramBldr) Adds children state information into an existing `ParameterBuilder` instance.
void	collectData() Triggers execution to the back end no matter whether it is synchronous or asynchronous.
void	collectMinimalData() Triggers execution to the back end no matter whether it is synchronous or asynchronous.
boolean	compareChildsTargetWithCurrent() The implementing class should implement this method to return true if it wants to always call the current object's targetBean#hasChanged method in #hasTargetBeanChanged method.
TransformInstance	createTransformInstance(Transform transform)
void	doCollectData() Call the required methods so the data is collected for this instance
void	doCollectMinimalData() By default this method simply invokes `doCollectData()`, i.e.
MarkupOutput	generateOutput() Generates the output of a bean.
AppContext	getAppContext() This method returns the application context object associated with this component.
String	getContactInfo() This method is deprecated. Use Preferences.getValue(EnumWebPreferences.WebPreferenceAdminInfo) instead.
ContainerServices	getContainerServices() Convenience method to retrieve the connected Container Services object.
String	getDescriptor(int key) Retrieve the descriptor when the key is an integer value...
String	getDescriptor(String key) Retrieve the descriptor when the key is a string
EventManager	getEventManager() This method returns the application EventManager used to generates events.
String	getExtraInput() Get any extra input form information to be used when generating form information on the transforms associated with this instance.
String	getExtraUrl() Get any extra url information to be used when generating link information on the transforms associated with this instance.
WebFeatures	getFeaturesManager() Return the WebFeatures implementation associated with this WebComponent
int	getLeft() Get the left position where the bean should be displayed by the transform if applicable
WebObjectSource	getObjectSource()
int	getResultFilterMode()
WebIServerSession	getSession()
WebComponent	getTargetBean() Get the target bean associated with this instance
int	getTop() Get the top position where the bean should be displayed by the transform if applicable
int	getType() Returns the transformable type as in `EnumWebTransformableType`.
static WebObjectsFactory	getWebObjectsFactory(WebBean wb) Utility method for obtaining a `WebObjectsFactory` instance
WebObjectsFactory	getWebObjectsFactory()
int	getXMLStatus() Returns the `EnumRequestStatus` status of the component.
boolean	hasChanged() Verifies the state of the component has changed
boolean	hasTargetBeanChanged() When this method is called, we have already checked the children and each of the children has returned with hasChanged() as false.
boolean	haveChildrenChanged()
WebComponent	initComponent(WebComponent bean, String suffix) Initialize a WebComponent as child of this FrameBean.
void	internalCollectData() This method is called internally by the transform() method to ensure collectData has been triggered and the bean is ready to transform.
boolean	isDialog() Returns true if this bean should be treated as a dialog
boolean	isForcedChildrenStateSaving() Return wheter the bean's children will be save their states or not despite it's open or closed state.
boolean	isIFrameRequest() Utility method that determines if it's an IFrame type of request.
boolean	isModal() The property is used to determine wheter the component will be displayed as a floating (popup) dialog with modal property.
boolean	isModalOpen() indicates whether there is a Modal AppComponent open in the hierarchy
boolean	isOpen() Returns a boolean value indicating if the instance is marked as opened or closed.
BeanContext	newDefaultBeanContext() This method is called by getBeanContext() to automatically create an instance of a BeanContext if one has not been explicitly set.
ParameterBuilder	newHiddenInputBuilder() Convenience method to retrieve a new instance of a Hidden Input Builder from the connected Container Services object.
NamespaceEncoder	newNamespaceEncoder() Convenience method to retrieve a new instance of a Namespace Encoder from the connected Container Services object.
StyleRequestContext	newStyleRequestContext()
ParameterBuilder	newURIBuilder() Convenience method to retrieve a new instance of a URI Builder from the connected Container Services object.
void	setExtraInput(String newValue) Set any extra input form information to be used when generating form information on the transforms associated with this instance.
void	setExtraUrl(String newValue) Set any extra url information to be used when generating link information on the transforms associated with this instance.
void	setForcedChildrenStateSaving(boolean value) Forces the bean to propagate its children to save state despite it's open or closed state.
void	setHasJustOpened(boolean value) Sets whether the component has just been opened.
void	setIsDialog(boolean value) Set method for defining if the instance is to be defined as a Dialog or not.
void	setIsModal(boolean value) Set method for defining if the instance is to be defined as a Modal interface or not.
void	setIsOpen(boolean value) Set the current instance as opened.
void	setLeft(int x) Set the left position where the bean should be displayed by the transform if applicable.
void	setOutputFormat(int outputFormat) Sets the output format of `EnumBeanOutputFormat` for the current WebComponent.
void	setTop(int y) Set the top osition where the bean should be displayed by the transform if applicable.

From class com.microstrategy.web.beans.AbstractWebComponent

From class com.microstrategy.web.beans.AbstractTransformable

From class com.microstrategy.utils.serialization.AbstractPersistable

void	doFlatState(FlatStateSerializer ser, int howMuchState, FlatStateTokenizer tok, int stateFlag)
void	doFlatState(FlatStateSerializer ser, int howMuchState, FlatStateTokenizer tok)
AbstractHandler	getStateHandler()
boolean	isXMLStateZipped()
boolean	restoreState(SAXSupport parser, String uri, String localName, String qName, Attributes attrs) Restores a component from an embedded XML during a SAX parsing.
boolean	restoreState(String state) Restores a component based on its saved state.
void	restoreXMLState(String state)
String	saveState() Returns a `java.lang.String` representation of a component.
void	saveState(StringBuffer buf, int howMuchState, int stateFlag) Saves and stores a component's state into a `StringBuffer`.
void	saveState(StringBuffer buf, int howMuchState) Saves and stores a component's state into a `StringBuffer`.
String	saveState(int howMuchState) Returns a `java.lang.String` representation of a component.
void	saveXMLState(StringBuffer buf, int howMuchState, int stateFlag)
void	saveXMLState(StringBuffer buf, int howMuchState)

From class java.lang.Object

From interface com.microstrategy.utils.serialization.Persistable

From interface com.microstrategy.web.app.beans.AppComponent

abstract AppContext	getAppContext() This method returns the application context object associated with this component.
abstract String	getDescriptor(String key) Retrieve the descriptor when the key is a string
abstract String	getDescriptor(int key) Retrieve the descriptor when the key is an integer value...
abstract EventManager	getEventManager() This method returns the application EventManager used to generates events.
abstract String	getExtraInput() Get any extra input form information to be used when generating form information on the transforms associated with this instance.
abstract String	getExtraUrl() Get any extra url information to be used when generating link information on the transforms associated with this instance.
abstract int	getLeft() Get the left position where the bean should be displayed by the transform if applicable
abstract int	getResultFilterMode()
abstract int	getTop() Get the top position where the bean should be displayed by the transform if applicable
abstract boolean	isDialog() Returns true if this bean should be treated as a dialog
abstract boolean	isForcedChildrenStateSaving() Return whether the state will be save despite it's open or closed state.
abstract boolean	isModal() Retrieves the modal state of the bean
abstract boolean	isModalOpen() indicates whether there is a Modal AppComponent open in the hierarchy
abstract boolean	isOpen() Retrieves the open/close state of the bean
abstract void	setExtraInput(String newValue) Set any extra input form information to be used when generating form information on the transforms associated with this instance.
abstract void	setExtraUrl(String newValue) Set any extra url information to be used when generating link information on the transforms associated with this instance.
abstract void	setForcedChildrenStateSaving(boolean value) Forces the bean state to be save despite it's open or closed state.
abstract void	setHasJustOpened(boolean value) Sets whether the component has just been opened.
abstract void	setIsDialog(boolean value) Sets the bean to its dialog mode.
abstract void	setIsModal(boolean value) Sets the bean to its modal mode.
abstract void	setIsOpen(boolean value) Sets the bean to its enabled mode, meaning the editor will be visible to the user
abstract void	setLeft(int x) Set the left position where the bean should be displayed by the transform if applicable.
abstract void	setTop(int y) Set the top position where the bean should be displayed by the transform if applicable.

From interface com.microstrategy.web.app.beans.PreferencesBean

From interface com.microstrategy.web.beans.RequestPersistable

From interface com.microstrategy.web.beans.Transformable

From interface com.microstrategy.web.beans.WebComponent

abstract void	addChild(String key, WebComponent child) adds a child WebComponent instance on the current WebComponent.
abstract void	addChildStateInfo(ParameterBuilder paramBldr) Adds children state information into an existing `ParameterBuilder` instance.
abstract void	addChildStateInfo(ParameterBuilder paramBldr, int howMuchState) Adds children state information into an existing `ParameterBuilder` instance.
abstract void	collectData() Triggers execution to the back end no matter whether it is synchronous or asynchronous.
abstract void	collectMinimalData() This is similar to `collectData()` except data collected is minimal.
abstract MarkupOutput	generateOutput() This is the generic method to ask the WebComponent to generate some output for the client.
abstract BeanContext	getBeanContext() Returns an instance of `BeanContext`.
abstract WebComponent	getChild(String key) Returns the child WebComponent instance specified by the key.
abstract WebComponent	getChild(int index) Returns the child WebComponent instance specified by the index.
abstract WebComponent	getChildByClass(Class className) Returns the child WebComponent instance specified by the class.
abstract WebComponent	getChildByType(int childType) Returns the child WebComponent instance specified by the component type(`EnumWebTransformableType`).
abstract int	getChildCount() Returns the total number of children on the current WebComponent.
abstract void	getChildrenByClass(Class className, HashList retList, boolean recursive) Returns a collection of children specified by the class name
abstract int	getDefaultStateLevel() Returns the default state level for the WebComponent.
abstract WebFeatures	getFeaturesManager() Return the WebFeatures implementation associated with this WebComponent
abstract int	getMaximumStateLevel() Returns the maximum state level that is supported by the WebComponent.
abstract String	getName() Returns the name of the current WebComponent.
abstract int	getOutputFormat() Returns the output format of `EnumBeanOutputFormat` of the current WebComponent.
abstract WebComponent	getParent() Returns the parent WebComponent of the current WebComponent.
abstract String	getPath() Returns the path from the root WebComponent to the current WebComponent.
abstract int	getPersistMode() Returns the persist flag (`EnumBeanPersistMode`) of the current WebComponent.
abstract Set	getRenderingFilter() returns the rendering filter.
abstract WebComponent	getRoot() Returns the root of the current WebComponent.
abstract WebComponent	getTargetBean() Get the target bean associated with this instance
abstract String	getTargetBeanPath()
abstract WebEvent	getWebEvent(int event, boolean recurse) Returns the `WebEvent` instance with the specified event ID.
abstract WebEvent	getWebEvent(int event) Returns the `WebEvent` instance with the specified event ID.
abstract WebEventHandler	getWebEventHandler() Returns the `WebEventHandler` instance associated with the current WebComponent.
abstract int	getXMLStatus() This method returns the `EnumRequestStatus` status of the current Component.
abstract boolean	handleRequest(RequestKeys keys) Handles a request.
abstract boolean	hasChanged() Verifies the state of the component has changed
abstract boolean	hasJustOpened() Verifies if the component has just been opened.
abstract void	initBean() Initialize the component after it's created and its properties initialized
abstract void	invalidateChildrenState() Invalidates the cached URL and hidden INPUT states of all the components, including the current component, along the path to the root component.
abstract boolean	isBeanContextEmpty() Verifies if a bean context exists for the current WebComponent.
abstract boolean	isFeatureAvailable(String featureID) Verifies the feature provided is accesible based on the properties of this WebComponent
abstract void	prepareForReuse() If a Web Component instance is going to be reused across different requests, this API serves as a notifier to the component to do the necessary cleanup.
abstract WebComponent	removeChild(String key) removes a child WebComponent instance on the current WebComponent.
abstract WebComponent	removeChild(WebComponent component) removes a child WebComponent instance on the current WebComponent.
abstract WebComponent	searchChild(String key) Returns the child WebComponent instance specified by the key.
abstract void	setBeanContext(BeanContext beanContext, boolean propagate) Sets an instance of `BeanContext` on the current WebBean.
abstract void	setBeanContext(BeanContext beanContext) Sets an instance of `BeanContext` on the current WebBean.
abstract void	setChanged(boolean value) Sets the changed state of the component.
abstract void	setChanged(boolean value, boolean forceRecurse) Sets the changed state of the component
abstract void	setDefaultStateLevel(int stateLevel) Sets the default state level for the WebComponent.
abstract void	setFeaturesManager(WebFeatures featuresManager) Associate a WebFeatures implementation with this WebComponent
abstract void	setName(String name) Sets the name on the current WebComponent.
abstract void	setOutputFormat(int outputFormat) Sets the output format of `EnumBeanOutputFormat` of the current WebComponent.
abstract void	setParent(WebComponent parent) Sets the parent WebComponent of the current WebComponent.
abstract void	setPersistMode(int persistFlag) Sets the persist flag (`EnumBeanPersistMode`) of the current WebComponent.
abstract void	setRenderingFilter(Set renderingFilter) Sets the list of beans to render.
abstract void	setTargetBean(WebComponent bean) Set the target bean that will be associated with this instance.
abstract void	setTargetBeanPath(String beanName) Define the base bean for this instance.
abstract void	setWebEventHandler(WebEventHandler handler) Sets a `WebEventHandler` on this component.

Constants

protected static final String PREFERENCE_CURRENT_GROUP

Constant Value: "cg"

protected static final String PREFERENCE_CURRENT_GROUP_SET

Constant Value: "cgs"

protected static final String SEPARATOR

Constant Value: ":"

Fields

protected final String TOKEN_DIV

Constant Value: ";"

protected String _applyToAllProjects

protected String _currentGroup

protected String _currentGroupSet

protected String _prevGroupName

Public Methods

public void afterUpdate (Map pValues, PreferencesException ex)

public void collectData ()

Triggers execution to the back end no matter whether it is synchronous or asynchronous. If this method fails to collect data, an exception is raised and saved in a WebBeanError instance.

public MarkupOutput generateOutput ()

Uses a transform to generate the output. The transform used will be the one of the current group.

Returns

the dialog for the current Preferences group

public String getApplyToAllProjects ()

Whether to apply the changes to all projects

Returns

whether to apply the changes to all projects

public String getCurrentGroup ()

Returns the current group's title.

Returns

the current group's title

public PreferencesBean.GroupInfo getCurrentGroupInfo ()

Returns the current group info structure:

Returns

the current GroupInfo

public String getCurrentGroupName ()

Returns the current group's name.

Returns

the current group's name

public String getCurrentGroupSet ()

Returns which is the current groupset

Returns

the current groupSet's title

public PreferencesBean.GroupInfo getCurrentGroupSetInfo ()

Returns

a GroupInfo instance corresponding to the current group set selected

public PreferenceLevel getCurrentLevel ()

Returns the preferences level of the current preferences group

Returns

the current groupSet's level

public FeatureInfos getFeatureInfos ()

public PreferencesBean.GroupInfo getGroupSetInfo (String groupSetName)

Parameters

groupSetName	name of the `GroupInfo` to search for.

Returns

a GroupInfo instance corresponding to the group set name sent in as parameter

public String getPrevGroupName ()

Returns the previous group's name.

Returns

the previous group's name

public boolean getSettingVisibility (String settingDiv)

Retrieves the boolean value indicating whether we should render the advanced setting Div with Id as setting Div as visible.

Parameters

settingDiv	The Id of the controlled setting Div.

Returns

boolean value indicating whether the Div should be visible or not

public Map getTemporalValues ()

public int getType ()

Returns the transformable type as in EnumWebTransformableType.

Returns

the transformable type.

public PreferencesException getValidationErrors ()

public String getValidationMessage (String name)

public Map getValues ()

public int getXMLStatus ()

Returns the EnumRequestStatus status of the bean. By default the status of this bean is WebBeanRequestWaitingForUserInput. When the method is invoked with true, then the status changes to be Succesfull.

Returns

the EnumRequestStatus of the component.

public boolean hasValidationErrors ()

public boolean havePreferencesChanged ()

Determines if the user has attemped to change the preferences on a page.

Returns

true if the user has attemped to change the preferences on a page.

public boolean initFromXML (Element root)

Initialize the groups/group-sets from the information of the root

Parameters

root	the XML Element with the structure information

Returns

true if the root contained valid information

public boolean isLoginRequired ()

Returns

boolean value indicating if the user is required to log out and log back in in order to have the new preference values applied.

public boolean isValidLevel (String level)

Determine if the user has all the privileges required for accessing the preferences under the specified level.

Parameters

level	String value with the level the user is trying to access

Returns

boolean value indicating if the user is enabled to access this preference level or not.

public boolean isValidPreference (String name)

public MarkupOutput renderGroupsList ()

Returns the output to render the groups list.

Returns

the output to display the groups list information.

public MarkupOutput renderGroupsList (boolean ignoreCurrent)

Returns the output to render the groups list.

Parameters

ignoreCurrent	ignores which group and group set are currently selected. Displays them all as links

Returns

the output to display the groups list information.

public void setApplyToAllProjects (String applyToAllProjects)

Sets whether to apply the changes to all projects

Parameters

applyToAllProjects	whether to apply the changes to all projects

public void setBeanContext (BeanContext beanContext)

Extends setBeanContext by auto-initializing this bean. The bean will check in the appContext for a "preferencesGroupsFile" config parameter, if found, it will initialize itself from the path specified.
If this parameter is not present the user will need to manually call initFromXml.
If the user wants to use this bean with a different set of preferences groups, he can call initFromXml and the values will be overwritten.

Parameters

beanContext	`BeanContext` instance to assign to this bean

public void setCurrentGroup (String currentGroup)

Sets the current group. If the new group doesn't exist, it is ignored.

Parameters

currentGroup	the name of the new current group

public void setCurrentGroupSet (String currentGroupSet)

Sets the current groupset. If there is no group-set with currentGroupSet the value is ignored.
If the current group exist in the new group-set, the group is kept as current group, if not, the first group of the group-set is used.

Parameters

currentGroupSet	the name of the new current group set

public void setIsLoginRequired (boolean value)

This method is deprecated.
isLoginRequired() can be determined automatically

Parameters

value	boolean flag indicating if the user is required to log out and log back in in order to have the new preference values applied.

public void setPrevGroupName (String prevGroupName)

Set the previous group's name.

Parameters

prevGroupName	the previous group's name

public void setSettingVisibility (String settingDiv, String visible)

Set the value in the Hashmap _advSettingsVisibility.

Parameters

settingDiv	The key to the value stored in Hashmap.

public void setXMLStatus (int status)

Set the EnumRequestStatus status of the bean. By default the status of this bean is WebBeanRequestWaitingForUserInput.

Parameters

status	`int` value with the status of this bean

public void toggleSettingsVisibility (String settingDiv)

Toggle the value in the Hashmap _advSettingsVisibility.

Parameters

settingDiv	The key to the value stored in Hashmap.

Protected Methods

protected void doFlatState (FlatStateSerializer serializer, int howMuchState, FlatStateTokenizer tokenizer)

Proceses the save/restore state opperation of the AppComponent

Parameters

serializer	an instance of the `FlatStateSerializer` object to use
howMuchState	defines how much information needs to be saved
tokenizer	an instance of the `FlatStateTokenizer` object to use

protected int getVisibleGroupSetCount ()

Returns

integer value with the count of visible group sets available

Interfaces

Classes

Exceptions

PreferencesBeanImpl

Class Overview

Summary

Constants

protected static final String PREFERENCE_CURRENT_GROUP

protected static final String PREFERENCE_CURRENT_GROUP_SET

protected static final String SEPARATOR

Fields

protected final String TOKEN_DIV

protected String _applyToAllProjects

protected String _currentGroup

protected String _currentGroupSet

protected String _prevGroupName

Public Methods

public void afterUpdate (Map pValues, PreferencesException ex)

public void collectData ()

public MarkupOutput generateOutput ()

Returns

public String getApplyToAllProjects ()

Returns

public String getCurrentGroup ()

Returns

public PreferencesBean.GroupInfo getCurrentGroupInfo ()

Returns

public String getCurrentGroupName ()

Returns

public String getCurrentGroupSet ()

Returns

public PreferencesBean.GroupInfo getCurrentGroupSetInfo ()

Returns

public PreferenceLevel getCurrentLevel ()

Returns

public FeatureInfos getFeatureInfos ()

public PreferencesBean.GroupInfo getGroupSetInfo (String groupSetName)

Parameters

Returns

public String getPrevGroupName ()

Returns

public boolean getSettingVisibility (String settingDiv)

Parameters

Returns

public Map getTemporalValues ()

public int getType ()

Returns

public PreferencesException getValidationErrors ()

public String getValidationMessage (String name)

public Map getValues ()

public int getXMLStatus ()

Returns

public boolean hasValidationErrors ()

public boolean havePreferencesChanged ()

Returns

See Also

public boolean initFromXML (Element root)

Parameters

Returns

public boolean isLoginRequired ()

Returns

public boolean isValidLevel (String level)

Parameters

Returns

public boolean isValidPreference (String name)

public MarkupOutput renderGroupsList ()

Returns

public MarkupOutput renderGroupsList (boolean ignoreCurrent)

Parameters

Returns

public void setApplyToAllProjects (String applyToAllProjects)

Parameters

public void setBeanContext (BeanContext beanContext)

Parameters

public void setCurrentGroup (String currentGroup)

Parameters

public void setCurrentGroupSet (String currentGroupSet)

Parameters

public void setIsLoginRequired (boolean value)

Parameters