public interface

BrowserSettings

implements EnumBrowserType
com.microstrategy.web.app.BrowserSettings
Known Indirect Subclasses

Class Overview

This interface enables to access settings or preferences that have been defined outside the Preferences instance. Each setting may have been originated from one of several different sources (such as the URL query string, cookies, etc).

Summary

[Expand]
Inherited Constants
From interface com.microstrategy.web.objects.EnumBrowserType
Public Methods
abstract void clearHttpSessionValues()
Clear http session browser settings.
abstract void clearSessionBrowserSettings()
This method is deprecated. use clearSessionValues() or clearSessionValues(WebIServerSession).
abstract void clearSessionValues()
Clear the session browser settings for current Intelligence Server session.
abstract void clearSessionValues(WebIServerSession session)
Clear the session browser settings for the given session.
abstract void flush()
Prepare all required headers so browser settings are sent back to the client as cookies.
abstract String getBrowserCompatName()
Returns the name of the IE browser including its status to indicate whether it is requesitng in Compatibility Mode.
abstract String getBrowserName()
Returns the name of the browser that is being used for performing the request
abstract int getBrowserType()
Returns the type of the browser that is being used for performing the request being handled.
abstract int getBrowserTypeAndVersion()
Returns the type and the version of the browser that is being used for performing the request
abstract String getBrowserVersion()
Returns the numeric version of the browser that is being used.
abstract MarkupOutput getDebugOut()
Get the Debug Information into the output
abstract String getDefaultValue(String key)
Return the default value of a specific setting if not found for the current user.
abstract BrowserSettingDefinitionList getDefinitionList()
Return the default definition of the browser setting which will be use to determine the value of the browser settings in case the setting requested is not found for the user.
abstract String getHttpSessionValue(String keyName)
Returns the http session value of the key sent as parameter
abstract String getLocale()
This method is deprecated. Not used anymore. Use getSession() to get the display locale instead.
abstract Preferences getPreferences()
Get the Preferences instance currently assigned to this BrowserSettings
abstract WebIServerSession getSession()
Gets the session that is used as default when accessing session settings.
abstract String getSessionValue(String keyName, WebIServerSession session)
Returns the value of the key sent as parameter, related with the setting corresponding to the indicated session
abstract String getSessionValue(String keyName)
Returns the value of the key sent as parameter, related with the setting corresponding to the default session
abstract String getUserAgent()
Retrives the USER-AGENT string from the header of the browser.
abstract String getValue(String keyName)
Returns the value of the key sent as parameter
abstract boolean hasValueSet(String keyName)
Checks whether a value has been set for the given key name or not
abstract boolean isCSS2Supported()
Indicates if the browser currently used by the client can handle CSS 2 styles.
abstract boolean isDHTMLSupported()
Indicates if the browser currently used by the client can handle DHTML content or not.
abstract boolean isEdgeModeEnabled()
Get flag whether System Preference enables a tag or http header X-UA-COMPATIBLE to force IE browsers to render in highest Document Mode.
abstract void setDefinitionList(BrowserSettingDefinitionList bsDefinitionList)
Sets the default definition of the browser setting.
abstract void setHttpSessionValue(String keyName, String value)
Persists the specified http session value under the specified key
abstract void setIframeVisibility(String value)
Define a browser setting for allowing the IFrame to be shown on DHTML environments.
abstract void setPreferences(Preferences preferences)
Set the Preferences instance to use for this BrowserSettings instance
abstract void setSession(WebIServerSession currentSession)
Sets the session that will be used as default when accessing session settings.
abstract void setSessionValue(String keyName, String value)
Persists the specified value under the specified key for the default session
abstract void setSessionValue(String keyName, String value, WebIServerSession session)
Persists the specified value under the specified key for the indicated session
abstract void setValue(String keyName, String value)
Persists the specified value under the specified key

Public Methods

public abstract void clearHttpSessionValues ()

Clear http session browser settings.

public abstract void clearSessionBrowserSettings ()

This method is deprecated.
use clearSessionValues() or clearSessionValues(WebIServerSession).

Clear the session browser settings for current Intelligence Server session.

public abstract void clearSessionValues ()

Clear the session browser settings for current Intelligence Server session.

public abstract void clearSessionValues (WebIServerSession session)

Clear the session browser settings for the given session.

public abstract void flush ()

Prepare all required headers so browser settings are sent back to the client as cookies. This is an utility method that gives better performance, allowing to prepare these headers only once, instead of each time a browser setting value is changed. For best results, the automaticFlush flag should be off when creating the BrowserSettings instance.

public abstract String getBrowserCompatName ()

Returns the name of the IE browser including its status to indicate whether it is requesitng in Compatibility Mode.

Returns
  • a value depending on the type and version of browser used by the client. supported browser compat names: ie8c, ie9c, ie10c otherwise: ""

public abstract String getBrowserName ()

Returns the name of the browser that is being used for performing the request

Returns
  • a value depending on the type and version of browser used by the client. supported browser names: ie7, ie8, ie9, ie10, firefox, chrome, safari; otherwise: unsupported-browser.

public abstract int getBrowserType ()

Returns the type of the browser that is being used for performing the request being handled.

Returns
  • a value depending on the type of browser used by the client:
  • BROWSER_TYPE_NETSCAPE
  • BROWSER_TYPE_IE
  • BROWSER_TYPE_OTHER

public abstract int getBrowserTypeAndVersion ()

Returns the type and the version of the browser that is being used for performing the request

Returns
  • a value depending on the type of browser used by the client. For example:
  • BROWSER_TYPE_IE6
  • BROWSER_TYPE_FIREFOX_3
  • BROWSER_TYPE_SAFARI_4

public abstract String getBrowserVersion ()

Returns the numeric version of the browser that is being used. ie. 1.5, 6, 7

public abstract MarkupOutput getDebugOut ()

Get the Debug Information into the output

Returns

public abstract String getDefaultValue (String key)

Return the default value of a specific setting if not found for the current user. Returns an empty string if the definition of the setting was not found on the definition list.

Parameters
key the name of the browser setting.
Returns
  • the default value of a specific setting

public abstract BrowserSettingDefinitionList getDefinitionList ()

Return the default definition of the browser setting which will be use to determine the value of the browser settings in case the setting requested is not found for the user.

Returns

public abstract String getHttpSessionValue (String keyName)

Returns the http session value of the key sent as parameter

Parameters
keyName the name associated with the value to return
Returns
  • the value found under the specified key

public abstract String getLocale ()

This method is deprecated.
Not used anymore. Use getSession() to get the display locale instead.

Get the locale value saved as browser setting

Returns
  • the localeId available for this BrowserSettings instance.

public abstract Preferences getPreferences ()

Get the Preferences instance currently assigned to this BrowserSettings

Returns

public abstract WebIServerSession getSession ()

Gets the session that is used as default when accessing session settings.

Returns
  • currentSession an initialized WebIServerSession instance that represents the current session opened. Returns null if none has been assigned to this BrowserSettings instance.

public abstract String getSessionValue (String keyName, WebIServerSession session)

Returns the value of the key sent as parameter, related with the setting corresponding to the indicated session

Parameters
keyName the name associated with the value to return
session an initialized WebIServerSession instance
Returns
  • the value found under the specified key, for the specified session

public abstract String getSessionValue (String keyName)

Returns the value of the key sent as parameter, related with the setting corresponding to the default session

Parameters
keyName the name associated with the value to return
Returns
  • the value found under the specified key

public abstract String getUserAgent ()

Retrives the USER-AGENT string from the header of the browser.

Returns
  • a String value indicating USER-AGENT string from the header of the browser

public abstract String getValue (String keyName)

Returns the value of the key sent as parameter

Parameters
keyName the name associated with the value to return
Returns
  • the value found under the specified key

public abstract boolean hasValueSet (String keyName)

Checks whether a value has been set for the given key name or not

Parameters
keyName the name associated with the setting
Returns
  • true if there is a value been set already (other than the default)

public abstract boolean isCSS2Supported ()

Indicates if the browser currently used by the client can handle CSS 2 styles.

Returns
  • a boolean value indicating if the client browser can display and handle CSS 2 styles.

public abstract boolean isDHTMLSupported ()

Indicates if the browser currently used by the client can handle DHTML content or not.

Returns
  • a boolean value indicating if the client browser can display and handle DHTML code.

public abstract boolean isEdgeModeEnabled ()

Get flag whether System Preference enables a tag or http header X-UA-COMPATIBLE to force IE browsers to render in highest Document Mode.

Returns
  • boolean

public abstract void setDefinitionList (BrowserSettingDefinitionList bsDefinitionList)

Sets the default definition of the browser setting. This definition object will be use to determine the value of the browser settings in case the setting requested is not found for the user.

Parameters
bsDefinitionList the default definition of the browser settings

public abstract void setHttpSessionValue (String keyName, String value)

Persists the specified http session value under the specified key

Parameters
keyName name under to which the new setting will be saved
value value of the setting to be saved

public abstract void setIframeVisibility (String value)

Define a browser setting for allowing the IFrame to be shown on DHTML environments. A request for hidding the IFrame has precedence over one for showing it.

Parameters
value String value of a boolean indicating if the IFrame should be shown.

public abstract void setPreferences (Preferences preferences)

Set the Preferences instance to use for this BrowserSettings instance

Parameters
preferences a valid Preferences instance

public abstract void setSession (WebIServerSession currentSession)

Sets the session that will be used as default when accessing session settings.

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

public abstract void setSessionValue (String keyName, String value)

Persists the specified value under the specified key for the default session

Parameters
keyName name under to which the new setting will be saved
value value of the setting to be saved

public abstract void setSessionValue (String keyName, String value, WebIServerSession session)

Persists the specified value under the specified key for the indicated session

Parameters
keyName name under to which the new setting will be saved
value value of the setting to be saved
session an initialized WebIServerSession instance

public abstract void setValue (String keyName, String value)

Persists the specified value under the specified key

Parameters
keyName name under to which the new setting will be saved
value value of the setting to be saved