Package com.microstrategy.web.app

Interface EnumWebBrowserSettings

  • public interface 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 ReportFrameBeanImpl.isOpen(com.microstrategy.web.app.beans.FrameElement)). 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.

    Since:
    MicroStrategy Web 7.3.1 or earlier

    • Field Detail

      • BROWSER_SETTING_OPENED

        static final java.lang.String BROWSER_SETTING_OPENED
        Constant that represents the value of the browser setting indicating that a component (editor, toolbar, etc) is opened.
        See Also:
        Constant Field Values

      • BROWSER_SETTING_CLOSED

        static final java.lang.String BROWSER_SETTING_CLOSED
        Constant that represents the value of the browser setting indicating that a component (editor, toolbar, etc) is closed.
        See Also:
        Constant Field Values

      • BROWSER_SETTING_DEFAULT_TAB

        static final java.lang.String BROWSER_SETTING_DEFAULT_TAB
        Since:
        MicroStrategy Web 9.0.0
        See Also:
        Constant Field Values

      • WebBrowserSettingLastPageName

        static final java.lang.String WebBrowserSettingLastPageName
        Name of the browser setting that represents the last page name
        See Also:
        Constant Field Values

      • WebBrowserSettingBrowserType

        static final java.lang.String WebBrowserSettingBrowserType
        Name of the browser setting that represents the web browser vendor
        See Also:
        Constant Field Values

      • WebBrowserSettingBrowseVersion

        static final java.lang.String WebBrowserSettingBrowseVersion
        Name of the browser setting that represents the web browser vendor
        Since:
        MicroStrategy Web 9.0.0
        See Also:
        Constant Field Values

      • WebBrowserSettingLastPageState

        static final java.lang.String WebBrowserSettingLastPageState
        Name of the browser setting that represents the last page state
        See Also:
        Constant Field Values

      • WebBrowserSettingReturnToName

        static final java.lang.String WebBrowserSettingReturnToName
        Name of the browser setting that represents the return to page name
        See Also:
        Constant Field Values

      • WebBrowserSettingReturnToState

        static final java.lang.String WebBrowserSettingReturnToState
        Name of the browser setting that represents the return to page state
        See Also:
        Constant Field Values

      • WebBrowserSettingReturnToTitle

        static final java.lang.String WebBrowserSettingReturnToTitle
        Name of the browser setting that represents the return to page title
        See Also:
        Constant Field Values

      • WebBrowserSettingReturnToTitleID

        static final java.lang.String WebBrowserSettingReturnToTitleID
        Name of the browser setting that represents the descriptor id of the return to page title
        Since:
        MicroStrategy Web 8.0.0
        See Also:
        Constant Field Values

      • WebBrowserSettingReportLeftToolbar

        static final java.lang.String WebBrowserSettingReportLeftToolbar
        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.
        See Also:
        Constant Field Values

      • WebBrowserSettingRelatedReportsSection

        @Deprecated
static final java.lang.String WebBrowserSettingRelatedReportsSection
        Deprecated.
        Related reports is controlled by WebBrowserSettingReportLeftToolbar
        Name of the browser setting that controls whether to display related reports.
        See Also:
        Constant Field Values

      • WebBrowserSettingHelpSection

        static final java.lang.String WebBrowserSettingHelpSection
        Name of the browser setting that controls whether to expand the inline help section.
        See Also:
        Constant Field Values

      • WebBrowserSettingLastFolder

        static final java.lang.String WebBrowserSettingLastFolder
        Name of the browser setting that represents the last folder visited
        See Also:
        Constant Field Values

      • WebBrowserSettingLastSystemFolder

        static final java.lang.String WebBrowserSettingLastSystemFolder
        Name of the browser setting that represents the last system folder visited
        See Also:
        Constant Field Values

      • WebBrowserSettingLastPageNameDesignMode

        static final java.lang.String WebBrowserSettingLastPageNameDesignMode
        Name of the browser setting that represents the last page name visited for design mode
        See Also:
        Constant Field Values

      • WebBrowserSettingLastPageStateDesignMode

        static final java.lang.String WebBrowserSettingLastPageStateDesignMode
        Name of the browser setting that represents the last page state visited for design mode
        See Also:
        Constant Field Values

      • WebBrowserSettingSnapToGrid

        static final java.lang.String WebBrowserSettingSnapToGrid
        Name of the browser setting that represents the off state of the snap-to-grid in the rw page.
        Since:
        MicroStrategy Web 8.0.2
        See Also:
        Constant Field Values

      • WebBrowserSettingReportToolbar

        static final java.lang.String WebBrowserSettingReportToolbar
        Name of the browser setting that controls whether to display the report toolbar
        See Also:
        Constant Field Values

      • WebBrowserSettingPivotButtons

        @Deprecated
static final java.lang.String WebBrowserSettingPivotButtons
        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 EnumWebPreferences.WebPreferenceGridShowPivot preference.
        See Also:
        Constant Field Values

      • WebBrowserSettingSortButtons

        @Deprecated
static final java.lang.String WebBrowserSettingSortButtons
        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 EnumWebPreferences.WebPreferenceGridShowSort preference.
        See Also:
        Constant Field Values

      • WebBrowserSettingApplyViewFilter

        static final java.lang.String WebBrowserSettingApplyViewFilter
        Name of the browser setting that represents the auto apply filter option for the view filter editor
        See Also:
        Constant Field Values

      • WebBrowserSettingApplyViewLimit

        static final java.lang.String WebBrowserSettingApplyViewLimit
        Name of the browser setting that represents the auto apply filter option for the metric filter editor
        Since:
        MicroStrategy Web 9.0.0
        See Also:
        Constant Field Values

      • WebBrowserSettingPageBySection

        static final java.lang.String WebBrowserSettingPageBySection
        Name of the browser setting that controls whether to display the page-by and group-by sections
        See Also:
        Constant Field Values

      • WebBrowserSettingReportFilter

        @Deprecated
static final java.lang.String WebBrowserSettingReportFilter
        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.
        See Also:
        EnumWebBrowserSettings, Constant Field Values

      • WebBrowserSettingViewFilter

        @Deprecated
static final java.lang.String WebBrowserSettingViewFilter
        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.
        See Also:
        EnumWebBrowserSettings, Constant Field Values

      • WebBrowserSettingObjectBrowser

        @Deprecated
static final java.lang.String WebBrowserSettingObjectBrowser
        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:

        See Also:
        Constant Field Values

      • WebBrowserSettingIFrameVisible

        static final java.lang.String WebBrowserSettingIFrameVisible
        Name of the browser setting that represents the show IFrame feature
        See Also:
        Constant Field Values

      • WebBrowserSettingSortEditor

        @Deprecated
static final java.lang.String WebBrowserSettingSortEditor
        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.
        See Also:
        EnumWebBrowserSettings, Constant Field Values

      • WebBrowserSettingDrillEditor

        @Deprecated
static final java.lang.String WebBrowserSettingDrillEditor
        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.
        See Also:
        EnumWebBrowserSettings, Constant Field Values

      • WebBrowserSettingDrillFilterEditor

        @Deprecated
static final java.lang.String WebBrowserSettingDrillFilterEditor
        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.
        See Also:
        EnumWebBrowserSettings, Constant Field Values

      • WebBrowserSettingMergeColumnHeaders

        @Deprecated
static final java.lang.String WebBrowserSettingMergeColumnHeaders
        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
        See Also:
        Constant Field Values

      • WebBrowserSettingNarrowcastSubscriptions

        @Deprecated
static final java.lang.String WebBrowserSettingNarrowcastSubscriptions
        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.
        See Also:
        EnumWebBrowserSettings, Constant Field Values

      • WebBrowserSettingNarrowcastSendNow

        @Deprecated
static final java.lang.String WebBrowserSettingNarrowcastSendNow
        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.
        See Also:
        EnumWebBrowserSettings, Constant Field Values

      • WebBrowserSettingDebugFlags

        static final java.lang.String WebBrowserSettingDebugFlags
        Name of the browser setting that saves the current debug flags
        See Also:
        Constant Field Values

      • WebBrowserSettingVisibleElements

        static final java.lang.String WebBrowserSettingVisibleElements
        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).
        Since:
        MicroStrategy Web 8.0.0
        See Also:
        Constant Field Values

      • WebBrowserSettingObjBrowserWidth

        static final java.lang.String WebBrowserSettingObjBrowserWidth
        Name of the browser setting that indicates the width of the Dataset Objects in RWD and the object Browser in the report
        Since:
        MicroStrategy Web 8.0.0
        See Also:
        Constant Field Values

      • WebBrowserSettingObjBrowserHeight

        static final java.lang.String WebBrowserSettingObjBrowserHeight
        Name of the browser setting that indicates the height of the Dataset Objects in RWD and the object Browser in the report
        Since:
        MicroStrategy Web 8.0.0
        See Also:
        Constant Field Values

      • WebBrowserSettingLeftToolbarHeight

        static final java.lang.String WebBrowserSettingLeftToolbarHeight
        Name of the browser setting that indicates the height of the left toolbar of all pages
        Since:
        MicroStrategy Web 9.0.0
        See Also:
        Constant Field Values

      • WebBrowserSettingLeftToolbarWidth

        static final java.lang.String WebBrowserSettingLeftToolbarWidth
        Name of the browser setting that indicates the width of the left toolbar of all pages
        Since:
        MicroStrategy Web 11.2.0
        See Also:
        Constant Field Values

      • WebBrowserSettingObjBrowserContentsHeight

        static final java.lang.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
        Since:
        MicroStrategy Web 8.0.0
        See Also:
        Constant Field Values

      • WebBroswerSettingObjBrowserDisplayFormat

        static final java.lang.String WebBroswerSettingObjBrowserDisplayFormat
        Since:
        MicroStrategy Web 9.0.0
        See Also:
        Constant Field Values

      • WebBrowserSettingAccordionReportView

        static final java.lang.String WebBrowserSettingAccordionReportView
        Name of the browser setting that indicates the accordion in the view mode in a report page.
        Since:
        MicroStrategy Web 9.0.0
        See Also:
        Constant Field Values

      • WebBrowserSettingAccordionReportTab

        static final java.lang.String WebBrowserSettingAccordionReportTab
        Since:
        MicroStrategy Web 9.0.0
        See Also:
        Constant Field Values

      • WebBrowserSettingObjBrowserView

        @Deprecated
static final java.lang.String WebBrowserSettingObjBrowserView
        Deprecated.
        Name of the browser setting that indicates the accordion in the view mode in a RWD page.
        Since:
        MicroStrategy Web 8.0.0
        See Also:
        WebBrowserSettingAccordionRWView, Constant Field Values

      • WebBrowserSettingAccordionRWView

        static final java.lang.String WebBrowserSettingAccordionRWView
        Name of the browser setting that indicates the accordion in the view mode in a RWD page.
        Since:
        MicroStrategy Web 9.0.0
        See Also:
        Constant Field Values

      • WebBrowserSettingAccordionRWTab

        static final java.lang.String WebBrowserSettingAccordionRWTab
        Since:
        MicroStrategy Web 9.0.0
        See Also:
        Constant Field Values

      • WebBrowserSettingObjBrowserDesign

        @Deprecated
static final java.lang.String WebBrowserSettingObjBrowserDesign
        Deprecated.
        Name of the browser setting that indicates the accordion in the design mode in a RWD page.
        Since:
        MicroStrategy Web 8.0.0
        See Also:
        WebBrowserSettingAccordionRWDesign, Constant Field Values

      • WebBrowserSettingAccordionRWDesign

        static final java.lang.String WebBrowserSettingAccordionRWDesign
        Name of the browser setting that indicates the accordion in the design mode in a RWD page.
        Since:
        MicroStrategy Web 9.0.0
        See Also:
        Constant Field Values

      • WebBrowserSettingReportLastSrcId

        static final java.lang.String WebBrowserSettingReportLastSrcId
        Name of the browser setting that stores the last report source ID
        See Also:
        Constant Field Values

      • WebBrowserSettingCancelRequests

        static final java.lang.String WebBrowserSettingCancelRequests
        Name of the browser setting that represents the Cancel Request preference
        See Also:
        Constant Field Values

      • WebBrowserSettingRemoveJobs

        static final java.lang.String WebBrowserSettingRemoveJobs
        Name of the browser setting that represents the Remove Jobs preference
        See Also:
        Constant Field Values

      • WebBrowserSettingServerLocale

        static final java.lang.String WebBrowserSettingServerLocale
        Name of the browser setting that represents the Server Locale (date and number format) preference
        See Also:
        Constant Field Values

      • WebBrowserSettingPageHistoryState

        static final java.lang.String WebBrowserSettingPageHistoryState
        Name of the browser setting that represents the state of the page history list
        Since:
        MicroStrategy Web 9.0.0
        See Also:
        Constant Field Values

      • WebBrowserSettingAccordionTabWidth

        static final java.lang.String WebBrowserSettingAccordionTabWidth
        Name of the browser setting that represents the height of the left tab manager on the RWD page
        Since:
        MicroStrategy Web 9.0.0
        See Also:
        Constant Field Values

      • WebBrowserSettingThresholdsAutoApply

        static final java.lang.String WebBrowserSettingThresholdsAutoApply
        Name of the browser setting that represents whether we want to auto apply thresholds
        Since:
        MicroStrategy Web 9.0.0
        See Also:
        Constant Field Values

      • WebBrowserSettingColorThemeName

        static final java.lang.String WebBrowserSettingColorThemeName
        Name of the browser setting that represents user's color theme preference
        Since:
        MicroStrategy Web 9.0.0
        See Also:
        Constant Field Values

      • WebBrowserSettingSaveFolderId

        static final java.lang.String WebBrowserSettingSaveFolderId
        Name of the browser setting that represents the default folder ID where reports and documents are saved.
        Since:
        MicroStrategy Web 9.0.0
        See Also:
        Constant Field Values

      • WebBrowserSettingRWDefaultInsertMode

        static final java.lang.String WebBrowserSettingRWDefaultInsertMode
        Name of the browser setting that represents the default insert mode in report writing document
        Since:
        MicroStrategy Web 9.2.1m
        See Also:
        Constant Field Values

      • WebBrowserSettingRWDefaultDeleteMode

        static final java.lang.String WebBrowserSettingRWDefaultDeleteMode
        Name of the browser setting that represents the default delete mode in report writing document
        Since:
        MicroStrategy Web 9.2.1m
        See Also:
        Constant Field Values

      • WebBrowserSettingSaveIPASessions

        static final java.lang.String WebBrowserSettingSaveIPASessions
        Name of the browser setting that represents IPA sessions
        Since:
        MicroStrategy Web 9.2.2
        See Also:
        Constant Field Values

      • WebBrowserSettingLastMessageId

        static final java.lang.String WebBrowserSettingLastMessageId
        Name of the browser setting that stores the last message id viewed
        See Also:
        Constant Field Values

      • WebBrowserSettingExcludeShortcut

        static final java.lang.String WebBrowserSettingExcludeShortcut
        Name of the browser setting that stores the flag to exclude Shortcut objects from All Objects Browser search results
        See Also:
        Constant Field Values

      • WebBrowserSettingAccessibility

        static final java.lang.String WebBrowserSettingAccessibility
        Name of the browser setting that stores whether the last session was running in accessibility mode
        See Also:
        Constant Field Values

      • WebBrowserSettingLastProjectId

        static final java.lang.String WebBrowserSettingLastProjectId
        Name of the browser setting that stores the last page project ID
        See Also:
        Constant Field Values

      • WebBrowserSettingPromptIndex

        static final java.lang.String WebBrowserSettingPromptIndex
        Display Prompt index section in DHTML mode
        Since:
        MicroStrategy Web 11.2
        See Also:
        Constant Field Values

      • WebBrowserSettingSearchIndex

        static final java.lang.String WebBrowserSettingSearchIndex
        Search Page Current Tab Index
        Since:
        MicroStrategy Web 11.2
        See Also:
        Constant Field Values