com.microstrategy.web.app.EnumWebBrowserSettings |
This is an enumeration of browser setting names used by Microstrategy Web. Browser settings are values typically stored on cookies, and therefore represent those settings that are stored in the browser.
Notice this enumeration is not a comprehensive list of all possible browser settings.
In particular, Microstrategy Web persists the open/close state of a WebBean in browser settings,
and the name of such browser setting depends of the WebBean (typically it's the WebBean's name
itself although each WebBean may provide its own mechanism,
see isOpen()
). Clearly, the name
of these browser settings depend on the name of the WebBean as specified in the pageConfig.xml
The default value of a browser setting is null
. Classes using browser settings should
be aware of this and interpret null
accordingly. Administrator can assign a different
default value using the browserSettings.xml.
Constants | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
String | BROWSER_SETTING_CLOSED | Constant that represents the value of the browser setting indicating that a component (editor, toolbar, etc) is closed. | |||||||||
String | BROWSER_SETTING_DEFAULT_TAB | ||||||||||
String | BROWSER_SETTING_OPENED | Constant that represents the value of the browser setting indicating that a component (editor, toolbar, etc) is opened. | |||||||||
String | WebBroswerSettingObjBrowserDisplayFormat | ||||||||||
String | WebBrowserSettingAccessibility | Name of the browser setting that stores whether the last session was running in accessibility mode | |||||||||
String | WebBrowserSettingAccordionRWDesign | Name of the browser setting that indicates the accordion in the design mode in a RWD page. | |||||||||
String | WebBrowserSettingAccordionRWTab | ||||||||||
String | WebBrowserSettingAccordionRWView | Name of the browser setting that indicates the accordion in the view mode in a RWD page. | |||||||||
String | WebBrowserSettingAccordionReportTab | ||||||||||
String | WebBrowserSettingAccordionReportView | Name of the browser setting that indicates the accordion in the view mode in a report page. | |||||||||
String | WebBrowserSettingAccordionTabWidth | Name of the browser setting that represents the height of the left tab manager on the RWD page | |||||||||
String | WebBrowserSettingApplyViewFilter | Name of the browser setting that represents the auto apply filter option for the view filter editor | |||||||||
String | WebBrowserSettingApplyViewLimit | Name of the browser setting that represents the auto apply filter option for the metric filter editor | |||||||||
String | WebBrowserSettingBrowseVersion | Name of the browser setting that represents the web browser vendor | |||||||||
String | WebBrowserSettingBrowserType | Name of the browser setting that represents the web browser vendor | |||||||||
String | WebBrowserSettingCancelRequests | Name of the browser setting that represents the Cancel Request preference | |||||||||
String | WebBrowserSettingColorThemeName | Name of the browser setting that represents user's color theme preference | |||||||||
String | WebBrowserSettingDebugFlags | Name of the browser setting that saves the current debug flags | |||||||||
String | WebBrowserSettingDrillEditor | This constant is deprecated. Not used anymore. | |||||||||
String | WebBrowserSettingDrillFilterEditor | This constant is deprecated. Not used anymore. | |||||||||
String | WebBrowserSettingExcludeShortcut | Name of the browser setting that stores the flag to exclude Shortcut objects from All Objects Browser search results | |||||||||
String | WebBrowserSettingFormatToolbar | Name of the browser setting that controls whether to display the format toolbar. | |||||||||
String | WebBrowserSettingHelpSection | Name of the browser setting that controls whether to expand the inline help section. | |||||||||
String | WebBrowserSettingIFrameVisible | Name of the browser setting that represents the show IFrame feature | |||||||||
String | WebBrowserSettingLastFolder | Name of the browser setting that represents the last folder visited | |||||||||
String | WebBrowserSettingLastMessageId | Name of the browser setting that stores the last message id viewed | |||||||||
String | WebBrowserSettingLastPageName | Name of the browser setting that represents the last page name | |||||||||
String | WebBrowserSettingLastPageNameDesignMode | Name of the browser setting that represents the last page name visited for design mode | |||||||||
String | WebBrowserSettingLastPageState | Name of the browser setting that represents the last page state | |||||||||
String | WebBrowserSettingLastPageStateDesignMode | Name of the browser setting that represents the last page state visited for design mode | |||||||||
String | WebBrowserSettingLastProjectId | Name of the browser setting that stores the last page project ID | |||||||||
String | WebBrowserSettingLastSystemFolder | Name of the browser setting that represents the last system folder visited | |||||||||
String | WebBrowserSettingLeftToolbarHeight | Name of the browser setting that indicates the height of the left toolbar of all pages | |||||||||
String | WebBrowserSettingMergeColumnHeaders | This constant is deprecated. This value is not used by application anymore. Merge Column Headers is a report-level setting. | |||||||||
String | WebBrowserSettingNarrowcastSendNow | This constant is deprecated. Not used anymore. | |||||||||
String | WebBrowserSettingNarrowcastSubscriptions | This constant is deprecated. Not used anymore. | |||||||||
String | WebBrowserSettingObjBrowserContentsHeight | Name of the browser setting that indicates the height of the contents of the Dataset Objects in RWD and the object Browser in the report | |||||||||
String | WebBrowserSettingObjBrowserDesign | Name of the browser setting that indicates the accordion in the design mode in a RWD page.@deprecated | |||||||||
String | WebBrowserSettingObjBrowserHeight | Name of the browser setting that indicates the height of the Dataset Objects in RWD and the object Browser in the report | |||||||||
String | WebBrowserSettingObjBrowserView | Name of the browser setting that indicates the accordion in the view mode in a RWD page.@deprecated | |||||||||
String | WebBrowserSettingObjBrowserWidth | Name of the browser setting that indicates the width of the Dataset Objects in RWD and the object Browser in the report | |||||||||
String | WebBrowserSettingObjectBrowser | This constant is deprecated. This browser setting is not used anymore. | |||||||||
String | WebBrowserSettingPageBySection | Name of the browser setting that controls whether to display the page-by and group-by sections | |||||||||
String | WebBrowserSettingPageHistoryState | Name of the browser setting that represents the state of the page history list | |||||||||
String | WebBrowserSettingPivotButtons | This constant is deprecated. This setting is now controlled through preferences. | |||||||||
String | WebBrowserSettingRWDefaultDeleteMode | Name of the browser setting that represents the default delete mode in report writing document | |||||||||
String | WebBrowserSettingRWDefaultInsertMode | Name of the browser setting that represents the default insert mode in report writing document | |||||||||
String | WebBrowserSettingRelatedReportsSection |
This constant is deprecated.
Related reports is controlled by WebBrowserSettingReportLeftToolbar
|
|||||||||
String | WebBrowserSettingRemoveJobs | Name of the browser setting that represents the Remove Jobs preference | |||||||||
String | WebBrowserSettingReportFilter | This constant is deprecated. Not used anymore. | |||||||||
String | WebBrowserSettingReportLeftToolbar | Name of the browser setting that controls wheter to show the left dock section on the report, document and rw page. | |||||||||
String | WebBrowserSettingReportToolbar | Name of the browser setting that controls whether to display the report toolbar | |||||||||
String | WebBrowserSettingReturnToName | Name of the browser setting that represents the return to page name | |||||||||
String | WebBrowserSettingReturnToState | Name of the browser setting that represents the return to page state | |||||||||
String | WebBrowserSettingReturnToTitle | Name of the browser setting that represents the return to page title | |||||||||
String | WebBrowserSettingReturnToTitleID | Name of the browser setting that represents the descriptor id of the return to page title | |||||||||
String | WebBrowserSettingSaveFolderId | Name of the browser setting that represents the default folder ID where reports and documents are saved. | |||||||||
String | WebBrowserSettingSaveIPASessions | Name of the browser setting that represents IPA sessions | |||||||||
String | WebBrowserSettingServerLocale | Name of the browser setting that represents the Server Locale (date and number format) preference | |||||||||
String | WebBrowserSettingSnapToGrid | Name of the browser setting that represents the off state of the snap-to-grid in the rw page. | |||||||||
String | WebBrowserSettingSortButtons | This constant is deprecated. This setting is now controlled through preferences. | |||||||||
String | WebBrowserSettingSortEditor | This constant is deprecated. Not used anymore. | |||||||||
String | WebBrowserSettingThresholdsAutoApply | Name of the browser setting that represents whether we want to auto apply thresholds | |||||||||
String | WebBrowserSettingViewFilter | This constant is deprecated. Not used anymore. | |||||||||
String | WebBrowserSettingVisibleElements | Name of the browser setting that indicates which elements are visible. |
Constant that represents the value of the browser setting indicating that a component (editor, toolbar, etc) is closed.
Constant that represents the value of the browser setting indicating that a component (editor, toolbar, etc) is opened.
Name of the browser setting that stores whether the last session was running in accessibility mode
Name of the browser setting that indicates the accordion in the design mode in a RWD page.
Name of the browser setting that indicates the accordion in the view mode in a RWD page.
Name of the browser setting that indicates the accordion in the view mode in a report page.
Name of the browser setting that represents the height of the left tab manager on the RWD page
Name of the browser setting that represents the auto apply filter option for the view filter editor
Name of the browser setting that represents the auto apply filter option for the metric filter editor
Name of the browser setting that represents the web browser vendor
Name of the browser setting that represents the web browser vendor
Name of the browser setting that represents the Cancel Request preference
Name of the browser setting that represents user's color theme preference
Name of the browser setting that saves the current debug flags
This constant is deprecated.
Not used anymore.
Name of the browser setting that controls wheter to display the drill editor This constant is not used anymore as the open/close status of a WebBean now uses a generic mechanism based on the WebBean's name.
This constant is deprecated.
Not used anymore.
Name of the browser setting that controls wheter to display the filter on selections editor This constant is not used anymore as the open/close status of a WebBean now uses a generic mechanism based on the WebBean's name.
Name of the browser setting that stores the flag to exclude Shortcut objects from All Objects Browser search results
Name of the browser setting that controls whether to display the format toolbar.
Name of the browser setting that controls whether to expand the inline help section.
Name of the browser setting that represents the show IFrame feature
Name of the browser setting that represents the last folder visited
Name of the browser setting that stores the last message id viewed
Name of the browser setting that represents the last page name
Name of the browser setting that represents the last page name visited for design mode
Name of the browser setting that represents the last page state
Name of the browser setting that represents the last page state visited for design mode
Name of the browser setting that stores the last page project ID
Name of the browser setting that represents the last system folder visited
Name of the browser setting that indicates the height of the left toolbar of all pages
This constant is deprecated.
This value is not used by application anymore. Merge Column Headers is a report-level setting.
Name of the browser setting that represents the merge column headers feature
This constant is deprecated.
Not used anymore.
Name of the browser setting that controls wheter to display the send-now editor This constant is not used anymore as the open/close status of a WebBean now uses a generic mechanism based on the WebBean's name.
This constant is deprecated.
Not used anymore.
Name of the browser setting that controls wheter to display the Narrowcast subscriptions editor This constant is not used anymore as the open/close status of a WebBean now uses a generic mechanism based on the WebBean's name.
Name of the browser setting that indicates the height of the contents of the Dataset Objects in RWD and the object Browser in the report
Name of the browser setting that indicates the accordion in the design mode in a RWD page.@deprecated
Name of the browser setting that indicates the height of the Dataset Objects in RWD and the object Browser in the report
Name of the browser setting that indicates the accordion in the view mode in a RWD page.@deprecated
Name of the browser setting that indicates the width of the Dataset Objects in RWD and the object Browser in the report
This constant is deprecated.
This browser setting is not used anymore.
Name of the browser setting that controls whether to show the object browser.
This browser setting is not used anymore. The state of the object browser is now controlled by these other browser settings:
Name of the browser setting that controls whether to display the page-by and group-by sections
Name of the browser setting that represents the state of the page history list
This constant is deprecated.
This setting is now controlled through preferences.
Name of the browser setting that controls whether to show the pivot buttons in a grid.
This setting is not used anymore as this is now controlled by WebPreferenceGridShowPivot
preference.
Name of the browser setting that represents the default delete mode in report writing document
Name of the browser setting that represents the default insert mode in report writing document
This constant is deprecated.
Related reports is controlled by WebBrowserSettingReportLeftToolbar
Name of the browser setting that controls whether to display related reports.
Name of the browser setting that represents the Remove Jobs preference
This constant is deprecated.
Not used anymore.
Name of the browser setting that controls whether to display the report filter component. This constant is not used anymore as the open/close status of a WebBean now uses a generic mechanism based on the WebBean's name.
Name of the browser setting that controls wheter to show the left dock section on the report, document and rw page. This section typically includes the related reports.
Name of the browser setting that controls whether to display the report toolbar
Name of the browser setting that represents the return to page name
Name of the browser setting that represents the return to page state
Name of the browser setting that represents the return to page title
Name of the browser setting that represents the descriptor id of the return to page title
Name of the browser setting that represents the default folder ID where reports and documents are saved.
Name of the browser setting that represents IPA sessions
Name of the browser setting that represents the Server Locale (date and number format) preference
Name of the browser setting that represents the off state of the snap-to-grid in the rw page.
This constant is deprecated.
This setting is now controlled through preferences.
Name of the browser setting that controls whether the show the sort buttons in a grid.
This setting is not used anymore as this is now controlled by WebPreferenceGridShowSort
preference.
This constant is deprecated.
Not used anymore.
Name of the browser setting that controls wheter to display the sort editor This constant is not used anymore as the open/close status of a WebBean now uses a generic mechanism based on the WebBean's name.
Name of the browser setting that represents whether we want to auto apply thresholds
This constant is deprecated.
Not used anymore.
Name of the browser setting that controls wheter to display the view filter component This constant is not used anymore as the open/close status of a WebBean now uses a generic mechanism based on the WebBean's name.
Name of the browser setting that indicates which elements are visible.
Used for persisting state of which objects are shown or not. Used in Rulers and grids.
It is defined by a bit-wise flag. Each bit represents an element in RW document that could
be shown (1) or not (0).