public class

PreferenceBrowserSettings

extends AbstractBrowserSettings
java.lang.Object
   ↳ com.microstrategy.web.app.GenericBrowserSettings
     ↳ com.microstrategy.web.app.AbstractBrowserSettings
       ↳ com.microstrategy.web.app.PreferenceBrowserSettings

Class Overview

This class provides a user preference implementation of browser settings. The permanent browser settings are stored in user preference at user-project level. The temporary and project settings are stored in web session.

Summary

[Expand]
Inherited Constants
From class com.microstrategy.web.app.GenericBrowserSettings
From interface com.microstrategy.web.objects.EnumBrowserType
[Expand]
Inherited Fields
From class com.microstrategy.web.app.AbstractBrowserSettings
From class com.microstrategy.web.app.GenericBrowserSettings
Public Constructors
PreferenceBrowserSettings(BrowserSettingDefinitionList bsDefinitionList, Preferences adminPrefs, ContainerServices containerServices)
Class constructor
PreferenceBrowserSettings(BrowserSettingDefinitionList bsDefinitionList, Preferences preferences, ContainerServices containerServices, boolean processBrowserSettings)
This constructor is deprecated. processBrowserSettings is not supported. Use PreferenceBrowserSettings(BrowserSettingDefinitionList, Preferences, ContainerServices) instead.
Public Methods
void clearSessionBrowserSettings()
This method is deprecated. use clearSessionValues() instead.
void flush()
Store the browser settings windows to more persistent storage.
void setSession(WebIServerSession currentSession)
Sets the session that will be used as default when accessing session settings and also reloads session browser settings.
Protected Methods
BrowserSettingElement loadValues()
Load permanent browser settings from perference.
void storeValues(BrowserSettingElement bSet)
Store permanent browser settings to user preferences.
[Expand]
Inherited Methods
From class com.microstrategy.web.app.AbstractBrowserSettings
From class com.microstrategy.web.app.GenericBrowserSettings
From class java.lang.Object
From interface com.microstrategy.web.app.BrowserSettings

Public Constructors

public PreferenceBrowserSettings (BrowserSettingDefinitionList bsDefinitionList, Preferences adminPrefs, ContainerServices containerServices)

Class constructor

Parameters
bsDefinitionList an the BrowserSettingDefinitionList object from the PageManager object containing the default values of the spplication's browser settings.
adminPrefs valid instance of Preferences
containerServices valid instance of ContainerServices

public PreferenceBrowserSettings (BrowserSettingDefinitionList bsDefinitionList, Preferences preferences, ContainerServices containerServices, boolean processBrowserSettings)

This constructor is deprecated.
processBrowserSettings is not supported. Use PreferenceBrowserSettings(BrowserSettingDefinitionList, Preferences, ContainerServices) instead.

Class constructor

Parameters
bsDefinitionList an the BrowserSettingDefinitionList object from the PageManager object containing the default values of the spplication's browser settings.
preferences valid instance of Preferences
containerServices valid instance of ContainerServices
processBrowserSettings boolean value that indicates whether the browser settings included on the URL/Form Data should be automatically processed or not.

Public Methods

public void clearSessionBrowserSettings ()

This method is deprecated.
use clearSessionValues() instead.

Clear the value of the preference that holds the value of browser settings at the session level.

public void flush ()

Store the browser settings windows to more persistent storage.

public void setSession (WebIServerSession currentSession)

Sets the session that will be used as default when accessing session settings and also reloads session browser settings.

Parameters
currentSession an initialized WebIServerSession instance that represents the current session opened.

Protected Methods

protected BrowserSettingElement loadValues ()

Load permanent browser settings from perference.

protected void storeValues (BrowserSettingElement bSet)

Store permanent browser settings to user preferences.