PreferencesBean

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

[Expand] Inherited Constants
From interface com.microstrategy.utils.serialization.EnumWebPersistableState int BARE_MINIMAL_STATE_INFO Specifies that only the bare minimal state information to save for scenarios where reducing data length matters. int MAXIMAL_STATE_INFO Specifies maximal state information to save This type of state (of a component) usually represents the complete definition of the component (including all the changes that may have been made to it) int MINIMAL_STATE_INFO Specifies that only the minimal state information to save int TYPICAL_STATE_INFO Specifies typical state information to save This type of state (of a component) usually represents information about its initialization and all the changes that have been made to the component.
From interface com.microstrategy.web.app.beans.AppComponent int COMPONENT_POSITION_NOT_INITIALIZED Constant indicating the value for the position of the bean has not been specified

[Expand] Inherited Methods
From interface com.microstrategy.utils.serialization.Persistable abstract boolean restoreState(SAXSupport parser, String uri, String localName, String qName, Attributes attrs) Restores a component from an embedded XML during a SAX parsing. abstract boolean restoreState(String state) Restores a component based on its saved state. abstract void saveState(StringBuffer buf, int howMuchState) Saves and stores a component's state into a StringBuffer. abstract String saveState() Returns a java.lang.String representation of a component. abstract void saveState(StringBuffer buf, int howMuchState, int stateFlag) Saves and stores a component's state into a StringBuffer. abstract String saveState(int howMuchState) Returns a java.lang.String representation of a component.
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.beans.RequestPersistable abstract boolean restoreStateFromRequest(RequestKeys rk, String keyName) Restores a WebComponent based on the RequestKeys instance. abstract boolean restoreStateFromRequest(RequestKeys rk) Restores a WebComponent based on the RequestKeys instance.
From interface com.microstrategy.web.beans.Transformable abstract TransformInstance addTransform(Transform transform) Adds a Transform object into the collection of transforms. abstract TransformInstance addTransformByClass(String transformClass) Adds into the collection of transforms a Transform object with the specified fully qualified class name. abstract TransformInstance addTransformByStyle(String styleName) Adds into the collection of transforms a Transform object with the specified style name. abstract TransformInstance addTransformByStyle(String styleName, StyleRequestContext context) Adds into the collection of transforms a Transform object with the specified style name. abstract void clearTransforms() Deletes all transforms added to the object abstract BeanContext getBeanContext() Returns the BeanContext instance. abstract String getMessageString(String key) Returns the string descriptor from a Messages instance, which is in turn retrieved from the BeanContext if any. abstract Enumeration getMyTransformInstances() abstract TransformInstance getTransformInstance(String key) Returns the TransformInstance object with the specified key. abstract TransformInstance getTransformInstance() Returns the default TransformInstance object abstract Enumeration getTransformInstances() Retuns a java.util.Enumeration over all the TransformInstance objects. abstract int getType() Returns the transformable type as in EnumWebTransformableType. abstract boolean hasTransform(String key) Returns a boolean value indicating whether there is such a TransformInstance object with the specified key. abstract boolean hasTransform() Returns a boolean value indicating whether there is a default TransformInstance object. abstract void invalidateTransformCache() This method is called by any transformable object after collecting data abstract void setBeanContext(BeanContext beanContext) Sets an instance of BeanContext on the current Transformable object. abstract MarkupOutput transform(String key) Performs transform on a component by the TransformInstance with the specified key. abstract MarkupOutput transform() Performs transform on a component by the default TransformInstance object.
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.