Package com.microstrategy.web.app
Class PreferenceBrowserSettings
- java.lang.Object
-
- com.microstrategy.web.app.GenericBrowserSettings
-
- com.microstrategy.web.app.AbstractBrowserSettings
-
- com.microstrategy.web.app.PreferenceBrowserSettings
-
- All Implemented Interfaces:
BrowserSettings
,EnumBrowserType
public class PreferenceBrowserSettings extends AbstractBrowserSettings
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.- Since:
- MicroStrategy Web 7.3.1 or earlier
-
-
Field Summary
-
Fields inherited from class com.microstrategy.web.app.AbstractBrowserSettings
_bSet, _bSetHttpSession, _bSetSession
-
Fields inherited from class com.microstrategy.web.app.GenericBrowserSettings
_containerServices, _session, GENERIC_HTTP_SESSION_KEY, GENERIC_KEY, GENERIC_PROJECT_KEY_PREFIX
-
Fields inherited from interface com.microstrategy.web.objects.EnumBrowserType
BROWSER_TYPE_ANDROID, BROWSER_TYPE_CHROME, BROWSER_TYPE_EDGE, BROWSER_TYPE_FIREFOX, BROWSER_TYPE_FIREFOX_2, BROWSER_TYPE_FIREFOX_3, BROWSER_TYPE_FIREFOX_3_5, BROWSER_TYPE_IE, BROWSER_TYPE_IE_W3C, BROWSER_TYPE_IE10, BROWSER_TYPE_IE11, BROWSER_TYPE_IE6, BROWSER_TYPE_IE7, BROWSER_TYPE_IE8, BROWSER_TYPE_IE9, BROWSER_TYPE_NETSCAPE, BROWSER_TYPE_OTHER, BROWSER_TYPE_SAFARI, BROWSER_TYPE_UNKNOWN
-
-
Constructor Summary
Constructors Constructor Description PreferenceBrowserSettings(BrowserSettingDefinitionList bsDefinitionList, Preferences adminPrefs, ContainerServices containerServices)
Class constructorPreferenceBrowserSettings(BrowserSettingDefinitionList bsDefinitionList, Preferences preferences, ContainerServices containerServices, boolean processBrowserSettings)
Deprecated.processBrowserSettings is not supported.
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description void
clearSessionBrowserSettings()
Deprecated.useAbstractBrowserSettings.clearSessionValues()
instead.void
flush()
Store the browser settings windows to more persistent storage.protected com.microstrategy.web.app.BrowserSettingElement
loadValues()
Load permanent browser settings from perference.void
setSession(WebIServerSession currentSession)
Sets the session that will be used as default when accessing session settings and also reloads session browser settings.protected void
storeValues(com.microstrategy.web.app.BrowserSettingElement bSet)
Store permanent browser settings to user preferences.-
Methods inherited from class com.microstrategy.web.app.AbstractBrowserSettings
canStore, clearHttpSessionValues, clearSessionValues, clearSessionValues, getHttpSessionValue, getProjectKey, getSessionValue, getSessionValue, getValue, getValue, hasValueSet, loadHttpSessionValues, loadSessionValues, setHttpSessionValue, setSessionValue, setSessionValue, setValue, storeHttpSessionValues, storeSessionValues
-
Methods inherited from class com.microstrategy.web.app.GenericBrowserSettings
addCacheValue, addCacheValue, getBrowserCompatName, getBrowserName, getBrowserType, getBrowserTypeAndVersion, getBrowserVersion, getCacheNames, getCacheValue, getCacheValue, getDebugOut, getDefaultValue, getDefinitionList, getLocale, getPreferences, getSession, getUserAgent, getValueFromQueryString, isCacheValueModified, isCacheValuePersistable, isCSS2Supported, isDHTMLSupported, isEdgeModeEnabled, isValueCached, isValueSafeForXSS, setCacheValuePersistable, setDefinitionList, setIframeVisibility, setPreferences, updateCacheValue
-
-
-
-
Constructor Detail
-
PreferenceBrowserSettings
public PreferenceBrowserSettings(BrowserSettingDefinitionList bsDefinitionList, Preferences adminPrefs, ContainerServices containerServices)
Class constructor- Parameters:
bsDefinitionList
- an theBrowserSettingDefinitionList
object from thePageManager
object containing the default values of the spplication's browser settings.adminPrefs
- valid instance ofPreferences
containerServices
- valid instance ofContainerServices
-
PreferenceBrowserSettings
public PreferenceBrowserSettings(BrowserSettingDefinitionList bsDefinitionList, Preferences preferences, ContainerServices containerServices, boolean processBrowserSettings)
Deprecated.processBrowserSettings is not supported. UsePreferenceBrowserSettings(BrowserSettingDefinitionList, Preferences, ContainerServices)
instead.Class constructor- Parameters:
bsDefinitionList
- an theBrowserSettingDefinitionList
object from thePageManager
object containing the default values of the spplication's browser settings.preferences
- valid instance ofPreferences
containerServices
- valid instance ofContainerServices
processBrowserSettings
-boolean
value that indicates whether the browser settings included on the URL/Form Data should be automatically processed or not.
-
-
Method Detail
-
setSession
public void setSession(WebIServerSession currentSession)
Description copied from class:AbstractBrowserSettings
Sets the session that will be used as default when accessing session settings and also reloads session browser settings.- Specified by:
setSession
in interfaceBrowserSettings
- Overrides:
setSession
in classAbstractBrowserSettings
- Parameters:
currentSession
- an initializedWebIServerSession
instance that represents the current session opened.- Since:
- MicroStrategy Web 8.0.2
-
clearSessionBrowserSettings
public void clearSessionBrowserSettings()
Deprecated.useAbstractBrowserSettings.clearSessionValues()
instead.Clear the value of the preference that holds the value of browser settings at the session level.
-
flush
public void flush()
Description copied from class:AbstractBrowserSettings
Store the browser settings windows to more persistent storage.- Specified by:
flush
in interfaceBrowserSettings
- Overrides:
flush
in classAbstractBrowserSettings
-
loadValues
protected com.microstrategy.web.app.BrowserSettingElement loadValues()
Load permanent browser settings from perference.- Specified by:
loadValues
in classAbstractBrowserSettings
- Since:
- MicroStrategy Web 8.0.2
-
storeValues
protected void storeValues(com.microstrategy.web.app.BrowserSettingElement bSet)
Store permanent browser settings to user preferences.- Specified by:
storeValues
in classAbstractBrowserSettings
- Since:
- MicroStrategy Web 8.0.2
-
-