Package com.microstrategy.web.app.transforms

Class PreferencesGeneralTransform

    • Field Detail

      • folderBeanName

        protected FormalParameter folderBeanName
        Specifies the name of the bean that displays the folders' contents. Used on the 'Default start page' section of the preferences.
        The value defined here has to be the same name assigned to the folder bean defined on the Page Configuration File page definition that will be showing the contents.

      • reportBeanName

        protected FormalParameter reportBeanName
        Specifies the name of the bean that displays the reports' content. Used on the 'Default start page' section of the preferences.
        The value defined here has to be the same name assigned to the report bean defined on the Page Configuration File page definition that will be running the report.

      • reportFrameBeanName

        protected FormalParameter reportFrameBeanName
        Specifies the name of the bean that contains the report bean and other editor/toolbar beans. Used on the 'Default start page' section of the preferences.
        The value defined here has to be the same name assigned to the report frame bean defined on the Page Configuration File page definition that will be running the report.

      • documentBeanName

        protected FormalParameter documentBeanName
        Specifies the name of the bean that displays the documents' content. Used on the 'Default start page' section of the preferences.
        The value defined here has to be the same name assigned to the document bean defined on the Page Configuration File page definition that will be running the document.

      • rwDocumentBeanName

        protected FormalParameter rwDocumentBeanName
        Specifies the name of the bean that displays the report writing documents' content. Used on the 'Default start page' section of the preferences.
        The value defined here has to be the same name assigned to the report writing document bean defined on the Page Configuration File page definition that will be running the document.
        Since:
        MicroStrategy Web 8.0.0

      • sharedPageName

        protected FormalParameter sharedPageName
        Specifies the name of the page that displays the contents of Shared Reports, as defined on the Page Configuration File. Used on the 'Default start page' section of the preferences.

      • createPageName

        protected FormalParameter createPageName
        Specifies the name of the page that displays the contents of Create Reports, as defined on the Page Configuration File. Used on the 'Default start page' section of the preferences.

      • myPageName

        protected FormalParameter myPageName
        Specifies the name of the page that displays the contents of My Reports, as defined on the Page Configuration File. Used on the 'Default start page' section of the preferences.

      • reportPageName

        protected FormalParameter reportPageName
        Specifies the name of the page that displays the reports' contents, as defined on the Page Configuration File. Used on the 'Default start page' section of the preferences.

      • documentPageName

        protected FormalParameter documentPageName
        Specifies the name of the page that displays the documents' contents, as defined on the Page Configuration File. Used on the 'Default start page' section of the preferences.

      • rwDocumentPageName

        protected FormalParameter rwDocumentPageName
        Specifies the name of the page that displays the report writing documents' contents, as defined on the Page Configuration File. Used on the 'Default start page' section of the preferences.
        Since:
        MicroStrategy Web 8.0.0

      • availableSize

        protected FormalParameter availableSize
        Specifies the size of the Available listbox of the shopping cart used to select the application's fonts. Used on the 'Font style' section of the preferences.
        Usage: This may be changed to customize the size of the listboxes on the shopping cart.

      • selectedSize

        protected FormalParameter selectedSize
        Specifies the size of the Selected listbox of the shopping cart used to select the application's fonts. Used on the 'Font style' section of the preferences.
        Usage: This may be changed to customize the size of the listboxes on the shopping cart.

      • addImage

        protected FormalParameter addImage
        Deprecated.
        The image is now defined with a CSS style (add), which should be updated if another image is to be used
        Image to add elements to the Selected listbox of the shopping cart used to select the application's fonts. Used on the 'Font style' section of the preferences.
        Allowed Values:
        The value to indicate should be a valid image file name, with any necessary path information not included already on the resourcesFolderImage application configuration parameter.
        Usage:This may be changed to customize the shopping cart displayed on the 'Font style' section of the preferences.

      • _addImage

        protected java.lang.String _addImage
        Deprecated.
        The formal parameter this property is related to has been deprecated
        Property to keep the value assigned to the {!link PreferencesGeneralTransform#FP_ADD_IMAGE} formal parameter

      • removeImage

        protected FormalParameter removeImage
        Deprecated.
        The image is now defined with a CSS style (remove), which should be updated if another image is to be used
        Image to remove elements from the Selected listbox of the shopping cart used to select the application's fonts. Used on the 'Font style' section of the preferences.
        Allowed Values:
        The value to indicate should be a valid image file name, with any necessary path information not included already on the resourcesFolderImage application configuration parameter.
        Usage:This may be changed to customize the shopping cart displayed on the 'Font style' section of the preferences.

      • _removeImage

        protected java.lang.String _removeImage
        Deprecated.
        The formal parameter this property is related to has been deprecated
        Property to keep the value assigned to the {!link PreferencesGeneralTransform#FP_REMOVE_IMAGE} formal parameter

      • upImage

        protected FormalParameter upImage
        Deprecated.
        The image is now defined with a CSS style (up), which should be updated if another image is to be used
        Image to move elements up on the Selected listbox of the shopping cart used to select the application's fonts. Used on the 'Font style' section of the preferences.
        Allowed Values:
        The value to indicate should be a valid image file name, with any necessary path information not included already on the resourcesFolderImage application configuration parameter.
        Usage:This may be changed to customize the shopping cart displayed on the 'Font style' section of the preferences.

      • _upImage

        protected java.lang.String _upImage
        Deprecated.
        The formal parameter this property is related to has been deprecated
        Property to keep the value assigned to the {!link PreferencesGeneralTransform#FP_UP_IMAGE} formal parameter

      • downImage

        protected FormalParameter downImage
        Deprecated.
        The image is now defined with a CSS style (down), which should be updated if another image is to be used
        Image to move elements down on the Selected listbox of the shopping cart used to select the application's fonts. Used on the 'Font style' section of the preferences.
        Allowed Values:
        The value to indicate should be a valid image file name, with any necessary path information not included already on the resourcesFolderImage application configuration parameter.
        Usage:This may be changed to customize the shopping cart displayed on the 'Font style' section of the preferences.

      • _downImage

        protected java.lang.String _downImage
        Deprecated.
        The formal parameter this property is related to has been deprecated
        Property to keep the value assigned to the {!link PreferencesGeneralTransform#FP_DOWN_IMAGE} formal parameter

      • fontNamePickerName

        protected FormalParameter fontNamePickerName
        Indicates the name of the system picker that contains the font names that shall be displayed to the user as possible options for fonts to use on the application.
        Since:
        MicroStrategy Web 8.0.0

      • startPagesPickerName

        protected FormalParameter startPagesPickerName
        Indicates the name of the system picker that contains the start pages that shall be displayed to the user as possible start pages in the application.
        Since:
        MicroStrategy Web 8.0.0

      • timeZonesPickerName

        protected FormalParameter timeZonesPickerName
        Indicates the name of the system picker that contains the time zones that shall be displayed to the user as possible options for time zones in preferences section of the application.
        Since:
        MicroStrategy Web 8.0.0

      • colorThemePickerName

        protected FormalParameter colorThemePickerName
        Indicates the name of the system picker that contains the color themes that shall be displayed to the user as possible options for color theme in preferences section of the application.
        Since:
        MicroStrategy Web 9.0.0

      • searchObjectTypesPickerName

        protected FormalParameter searchObjectTypesPickerName
        Indicates the name of the system picker that contains the all search object types that shall be displayed to the Admin user as available options for search object types in preferences section of the application.
        Since:
        MicroStrategy Web 9.4.0

      • html5VIPageName

        protected FormalParameter html5VIPageName
        Indicates the name of the html5vi dashboard
        Since:
        MicroStrategy Web 10.0

      • oivmPageName

        protected FormalParameter oivmPageName
        Indicates the name of the oivm document
        Since:
        MicroStrategy Web 10.0

      • FP_FOLDER_BEAN_NAME

        public static final java.lang.String FP_FOLDER_BEAN_NAME
        Constant specifying the name of the formal parameter for defining the name of the folder bean. Value is folderBeanName.
        See Also:
        Constant Field Values

      • FP_REPORT_BEAN_NAME

        public static final java.lang.String FP_REPORT_BEAN_NAME
        Constant specifying the name of the formal parameter for defining the name of the report bean. Value is reportBeanName.
        See Also:
        Constant Field Values

      • FP_REPORT_FRAME_BEAN_NAME

        public static final java.lang.String FP_REPORT_FRAME_BEAN_NAME
        Constant specifying the name of the formal parameter for defining the name of the report frame bean. Value is reportFrameBeanName.
        See Also:
        Constant Field Values

      • FP_DOCUMENT_BEAN_NAME

        public static final java.lang.String FP_DOCUMENT_BEAN_NAME
        Constant specifying the name of the formal parameter for defining the name of the document bean. Value is documentBeanName.
        See Also:
        Constant Field Values

      • FP_RW_DOCUMENT_BEAN_NAME

        public static final java.lang.String FP_RW_DOCUMENT_BEAN_NAME
        Constant specifying the name of the formal parameter for defining the name of the report writing document bean. Value is rwDocumentBeanName.
        Since:
        MicroStrategy Web 8.0.0
        See Also:
        Constant Field Values

      • FP_SHARED_PAGE_NAME

        public static final java.lang.String FP_SHARED_PAGE_NAME
        Constant specifying the name of the formal parameter for defining the name of the Shared Reports folder page, as specified on the Page Configuration file. Value is sharedPageName.
        See Also:
        Constant Field Values

      • FP_CREATE_PAGE_NAME

        public static final java.lang.String FP_CREATE_PAGE_NAME
        Constant specifying the name of the formal parameter for defining the name of the Create Reports folder page, as specified on the Page Configuration file. Value is createPageName.
        See Also:
        Constant Field Values

      • FP_MY_PAGE_NAME

        public static final java.lang.String FP_MY_PAGE_NAME
        Constant specifying the name of the formal parameter for defining the name of the My Reports folder page, as specified on the Page Configuration file. Value is myPageName.
        See Also:
        Constant Field Values

      • FP_REPORT_PAGE_NAME

        public static final java.lang.String FP_REPORT_PAGE_NAME
        Constant specifying the name of the formal parameter for defining the name of the Report page, as specified on the Page Configuration file. Value is reportPageName.
        See Also:
        Constant Field Values

      • FP_DOCUMENT_PAGE_NAME

        public static final java.lang.String FP_DOCUMENT_PAGE_NAME
        Constant specifying the name of the formal parameter for defining the name of the Document page, as specified on the Page Configuration file. Value is documentPageName.
        See Also:
        Constant Field Values

      • FP_RW_DOCUMENT_PAGE_NAME

        public static final java.lang.String FP_RW_DOCUMENT_PAGE_NAME
        Constant specifying the name of the formal parameter for defining the name of the Report Writing Document page, as specified on the Page Configuration file. Value is rwDocumentPageName.
        Since:
        MicroStrategy Web 8.0.0
        See Also:
        Constant Field Values

      • FP_AVAILABLE_SIZE

        public static final java.lang.String FP_AVAILABLE_SIZE
        Constant specifying the name of the formal parameter for defining the size of the available list box shopping cart for selecting fonts. Value is availableSize.
        See Also:
        Constant Field Values

      • FP_SELECTED_SIZE

        public static final java.lang.String FP_SELECTED_SIZE
        Constant specifying the name of the formal parameter for defining the size of the selected list box shopping cart for selecting fonts. Value is selectedSelectSize.
        See Also:
        Constant Field Values

      • FP_ADD_IMAGE

        public static final java.lang.String FP_ADD_IMAGE
        Constant specifying the name of the formal parameter for defining the add image on the shopping cart. Value is addImage.
        See Also:
        Constant Field Values

      • FP_REMOVE_IMAGE

        public static final java.lang.String FP_REMOVE_IMAGE
        Constant specifying the name of the formal parameter for defining the remove image on the shopping cart. Value is removeImage.
        See Also:
        Constant Field Values

      • FP_UP_IMAGE

        public static final java.lang.String FP_UP_IMAGE
        Constant specifying the name of the formal parameter for defining the up image on the shopping cart. Value is upImage.
        See Also:
        Constant Field Values

      • FP_DOWN_IMAGE

        public static final java.lang.String FP_DOWN_IMAGE
        Constant specifying the name of the formal parameter for defining the down image on the shopping cart. Value is downImage.
        See Also:
        Constant Field Values

      • FP_FONT_NAME_PICKER_NAME

        public static final java.lang.String FP_FONT_NAME_PICKER_NAME
        Constant specifying the name of the formal parameter for defining the name of the system picker that provides the font name options. Value is fontNamePickerName.
        Since:
        MicroStrategy Web 8.0.0
        See Also:
        Constant Field Values

      • FP_START_PAGES_PICKER_NAME

        public static final java.lang.String FP_START_PAGES_PICKER_NAME
        Constant specifying the name of the formal parameter for defining the name of the system picker that provides the start page options. Value is startPagesPickerName.
        Since:
        MicroStrategy Web 8.0.0
        See Also:
        Constant Field Values

      • FP_TIME_ZONES_PICKER_NAME

        public static final java.lang.String FP_TIME_ZONES_PICKER_NAME
        Constant specifying the name of the formal parameter for defining the name of the system picker that provides the time zone options. Value is timeZonesPickerName.
        Since:
        MicroStrategy Web 8.0.0
        See Also:
        Constant Field Values

      • FP_COLOR_THEME_PICKER_NAME

        public static final java.lang.String FP_COLOR_THEME_PICKER_NAME
        Constant specifying the name of the formal parameter for defining the name of the Color Theme picker that provides the color theme options. Value is colorThemePickerName.
        Since:
        MicroStrategy Web 9.0.0
        See Also:
        Constant Field Values

      • FP_SEARCH_OBJECT_TYPES_PICKER_NAME

        public static final java.lang.String FP_SEARCH_OBJECT_TYPES_PICKER_NAME
        Constant specifying the name of the formal parameter for defining the name of the search object types picker that provides the search object types. Value is searchObjectTypesPickerName.
        Since:
        MicroStrategy Web 9.0.0
        See Also:
        Constant Field Values

      • PREFERENCE_ALLOW_OVERWRITE_WITHOUT_WARNING

        public static final java.lang.String PREFERENCE_ALLOW_OVERWRITE_WITHOUT_WARNING
        Since:
        MicroStrategy Web 8.0.0
        See Also:
        Constant Field Values

      • PREFERENCE_ALLOW_OVERWRITE_WITH_WARNING

        public static final java.lang.String PREFERENCE_ALLOW_OVERWRITE_WITH_WARNING
        Since:
        MicroStrategy Web 8.0.0
        See Also:
        Constant Field Values

      • PREFERENCE_DISALLOW_OVERWRITE

        public static final java.lang.String PREFERENCE_DISALLOW_OVERWRITE
        Since:
        MicroStrategy Web 8.0.0
        See Also:
        Constant Field Values

      • FP_HTML5_VI_PAGE_NAME

        public static final java.lang.String FP_HTML5_VI_PAGE_NAME
        Constant specifying the name of the formal parameter for defining the name of the HTML5 VI page, as specified on the Page Configuration file. Value is Html5Vi.
        Since:
        MicroStrategy Web 10.0.0
        See Also:
        Constant Field Values

      • FP_OIVM_PAGE_NAME

        public static final java.lang.String FP_OIVM_PAGE_NAME
        Constant specifying the name of the formal parameter for defining the name of the oivm page, as specified on the Page Configuration file. Value is oivmPageName.
        Since:
        MicroStrategy Web 10.0.0
        See Also:
        Constant Field Values

    • Constructor Detail

      • PreferencesGeneralTransform

        public PreferencesGeneralTransform()
        Default no-args constructor

    • Method Detail

      • renderKeepInCart

        public void renderKeepInCart​(MarkupOutput out)
        Parameters:
        out - MarkupOutput
        Since:
        MicroStrategy Web 8.0.1

      • renderStartSection

        public void renderStartSection​(MarkupOutput out)
        Renders 'Start page' section.
        Parameters:
        out - the output object

      • renderDataDisplaySection

        public void renderDataDisplaySection​(MarkupOutput out)
        Renders 'Data Display' section.
        Parameters:
        out - the output object
        Since:
        MicroStrategy Web 7.5.1

      • renderStart

        public void renderStart​(MarkupOutput out)
        Renders 'Start page' preference.
        Parameters:
        out - the output object
        Since:
        MicroStrategy Web 7.5.1

      • renderColorTheme

        public void renderColorTheme​(MarkupOutput out)
        Deprecated.
        call renderColorThemeDropDownList( ) instead
        Render 'Color Theme' preference.
        Parameters:
        out -
        Since:
        MicroStrategy Web 9.0.0

      • renderColorThemeDropDownList

        public void renderColorThemeDropDownList​(MarkupOutput out)
        Render the dropdown list of available Color Themes
        Parameters:
        out -
        Since:
        MicroStrategy Web 9.0.0

      • renderColorThemePreview

        public void renderColorThemePreview​(MarkupOutput out)
        Render color theme preview DIV This preview shows the look & feel of theme basic element: shortcut bar, path bar, accordion, panel, editor.
        Parameters:
        out -
        Since:
        MicroStrategy Web 9.0.0

      • renderColorThemePreviewZoom

        public Tag renderColorThemePreviewZoom​(MarkupOutput out,
                                       Tag previewDiv)
        Render color theme preview DIV with Zooming This preview shows the zoomed in version of the color theme preview
        Parameters:
        out -
        previewDiv - theme preview DIV to add more children and attributes to
        Since:
        MicroStrategy Web 9.0.0

      • generateOpenFolderEvent

        public WebEvent generateOpenFolderEvent​(FolderBean fb,
                                        java.lang.String folderPageName)
        Method that will generate the event for opening a folder, to be saved as part of the Start Page preference, if a custom folder other than the default ones is selected.
        Parameters:
        fb - a valid FolderBean instance, intialized with at least its object ID information, for the event to be generated correctly
        folderPageName - name of the page that will take care of opening the requested folder, compared against the values of the myPageName, createPageName and sharedPageName formal parameters.
        Returns:
        an event for opening the folder, initialized with the information passed as parameters. If no event could be created, it will return null.

      • generateOpenReportEvent

        public WebEvent generateOpenReportEvent​(ReportBean rb,
                                        ReportFrameBean rfb)
        Method that will generate the event for running a report, to be saved as part of the Start Page preference, when the Last Report Run is selected.
        Parameters:
        rb - a valid ReportBean instance, intialized, for the event to be generated correctly
        rfb - a valid ReportFrameBean instance, intialized, for the event to be generated correctly
        Returns:
        an event for opening the folder, initialized with the information passed as parameters. If no event could be created, it will return null.

      • generateOpenDocumentEvent

        public WebEvent generateOpenDocumentEvent​(DocumentBean db)
        Method that will generate the event for running a document, to be saved as part of the Start Page preference, when the Last Document Run is selected.
        Parameters:
        db - a valid DocumentBean instance, intialized with at least its object ID information, for the event to be generated correctly
        Returns:
        an event for running the document, initialized with the information passed as parameters. If no event could be created, it will return null.

      • generateOpenRWDocumentEvent

        public WebEvent generateOpenRWDocumentEvent​(RWBean rw)
        Method that will generate the event for running a report writing document, to be saved as part of the Start Page preference, when the Last Document Run is selected.
        Parameters:
        rw - a valid RWBean instance, intialized with at least its object ID information, for the event to be generated correctly
        Returns:
        an event for running the document, initialized with the information passed as parameters. If no event could be created, it will return null.
        Since:
        MicroStrategy Web 8.0.0

      • generateOpenHTML5VIDashboardEvent

        public WebEvent generateOpenHTML5VIDashboardEvent​(RWBean rw)
        Method that will generate the event for running a html5 vi dashboard, to be saved as part of the Start Page preference, when the Last Document Run is selected.
        Parameters:
        rw - a valid RWBean instance, intialized with at least its object ID information, for the event to be generated correctly
        Returns:
        an event for running the html5 vi dashboard, initialized with the information passed as parameters. If no event could be created, it will return null.
        Since:
        MicroStrategy Web 8.0.0

      • renderSharedReportsSection

        public void renderSharedReportsSection​(MarkupOutput out)
        Deprecated.
        This preference has been moved to the Folder Browsing Group
        Renders 'Shared Reports' section.
        Parameters:
        out - the output object

      • renderSharedReports

        public void renderSharedReports​(MarkupOutput out)
        Deprecated.
        This preference has been moved to the Folder Browsing Group
        Renders 'Shared Reports' preference.
        Parameters:
        out - the output object
        Since:
        MicroStrategy Web 7.5.1

      • renderLocaleSection

        public void renderLocaleSection​(MarkupOutput out)
        Renders 'Locale' section.
        Parameters:
        out - the output object

      • renderLocale

        public void renderLocale​(MarkupOutput out)
        Renders 'Locale' preference.
        Parameters:
        out - the output object
        Since:
        MicroStrategy Web 7.5.1

      • renderLanguageDropDownList

        public void renderLanguageDropDownList​(MarkupOutput out)
        Renders the drop down list of the language options
        Parameters:
        out -
        Since:
        MicroStrategy Web 8.0.1

      • renderLanguageHeader

        public void renderLanguageHeader​(MarkupOutput out)
        Renders the description for the language section
        Parameters:
        out -
        Since:
        MicroStrategy Web 8.0.1

      • renderUnits

        public void renderUnits​(MarkupOutput out)
        Renders 'Units' preference.
        Parameters:
        out - the output object
        Since:
        MicroStrategy Web 8.0.0

      • renderUnitsDropDownList

        public void renderUnitsDropDownList​(MarkupOutput out)
        Renders the drop down list of the units section
        Parameters:
        out -
        Since:
        MicroStrategy Web 8.0.1

      • renderUnitsHeader

        public void renderUnitsHeader​(MarkupOutput out)
        Renders the description of the units section
        Parameters:
        out -
        Since:
        MicroStrategy Web 8.0.1

      • renderServerLocale

        public void renderServerLocale​(MarkupOutput out)
        Renders 'Server Locale' preference.
        Parameters:
        out - the output object
        Since:
        MicroStrategy Web 7.5.1

      • renderServerLocaleDropDownList

        public void renderServerLocaleDropDownList​(MarkupOutput out)
        Renders the drop down list for the number and date format section
        Parameters:
        out -
        Since:
        MicroStrategy Web 8.0.1

      • renderMessagesLocaleHeader

        public void renderMessagesLocaleHeader​(MarkupOutput out)
        Since:
        MicroStrategy Web 9.0.0

      • renderMessagesLocaleDropDownList

        public void renderMessagesLocaleDropDownList​(MarkupOutput out)
        Since:
        MicroStrategy Web 9.0.0

      • renderMetadataLocaleDropDownList

        public void renderMetadataLocaleDropDownList​(MarkupOutput out)
        Since:
        MicroStrategy Web 9.0.0

      • renderWarehouseDataLocaleDropDownList

        public void renderWarehouseDataLocaleDropDownList​(MarkupOutput out)
        Since:
        MicroStrategy Web 9.0.0

      • renderDynamicControlButton

        public void renderDynamicControlButton​(MarkupOutput out,
                                       java.lang.String controlledDiv,
                                       java.lang.String labelHiddenID,
                                       java.lang.String labelShowID)
        Deprecated.
        Renders a control button which switchs the visibility of specific Div depending the DHTML or static HTML mode. It works hand-in-hand with getControlledDivAttr(String controlledDiv) to switch the visiblity of Div with ID as controlledDiv.
        Parameters:
        out - MarkupOutput
        controlledDiv - The ID of controlled Div
        labelShowID - The label for this button when Div is visible
        labelHiddenID - The label for this button when Div is hidden
        Since:
        MicroStrategy Web 9.0.0

      • renderDynamicControlButton

        public void renderDynamicControlButton​(MarkupOutput out,
                                       java.lang.String controlledDiv,
                                       java.lang.String labelHiddenID,
                                       java.lang.String labelShowID,
                                       int eventId)
        Renders a control button which switchs the visibility of specific Div depending the DHTML or static HTML mode. It works hand-in-hand with getControlledDivAttr(String controlledDiv) to switch the visiblity of Div with ID as controlledDiv. Note - This function is an overload of the original renderDynamicControlButton by adding an additional argument of eventId since the page now has multiple dynamic buttons.
        Parameters:
        out - MarkupOutput
        controlledDiv - The ID of controlled Div
        labelShowID - The label for this button when Div is visible
        labelHiddenID - The label for this button when Div is hidden

      • getControlledDivAttr

        public java.util.Map getControlledDivAttr​(java.lang.String controlledDiv)
        Render the attribute list for the container.
        Parameters:
        controlledDiv - The id for the container.
        Returns:
        list of attributes in Map structure.
        Since:
        MicroStrategy Web 9.0.0

      • renderServerLocaleHeader

        public void renderServerLocaleHeader​(MarkupOutput out)
        Renders the description for the number and date format section
        Parameters:
        out -
        Since:
        MicroStrategy Web 8.0.1

      • renderMetadataLocaleHeader

        public void renderMetadataLocaleHeader​(MarkupOutput out)
        Since:
        MicroStrategy Web 9.0.0

      • renderWarehouseDataLocaleHeader

        public void renderWarehouseDataLocaleHeader​(MarkupOutput out)
        Since:
        MicroStrategy Web 9.0.0

      • renderSaveMessageText

        public void renderSaveMessageText​(MarkupOutput out)
        Render the save message text that should be presented to the user once the saving has been successful.
        Overrides:
        renderSaveMessageText in class AbstractPreferencesTransform
        Parameters:
        out - MarkupOutput where to write the output of the method
        Since:
        MicroStrategy Web 8.0.0

      • renderTimeZone

        public void renderTimeZone​(MarkupOutput out)
        Renders the renderTimeZone preference
        Parameters:
        out - the output object
        Since:
        MicroStrategy Web 7.5.1

      • renderTimeZoneDropDownList

        public void renderTimeZoneDropDownList​(MarkupOutput out)
        Renders the drop down list for the time zone
        Parameters:
        out -
        Since:
        MicroStrategy Web 8.0.1

      • renderTimeZoneHeader

        public void renderTimeZoneHeader​(MarkupOutput out)
        Renders the description for the time zone
        Parameters:
        out -
        Since:
        MicroStrategy Web 8.0.1

      • renderDhtmlSection

        public void renderDhtmlSection​(MarkupOutput out)
        Renders 'Dynamic HTML' section.
        Parameters:
        out - the output object

      • canDisplayUserDhtml

        public boolean canDisplayUserDhtml()
        Checks if the administrator has enabled modifying the DHTML preference to end users.
        Returns:
        true if the WebPreferenceAllowDHTML is set to true.
        Since:
        MicroStrategy Web 8.0.1

      • renderUseDhtml

        public void renderUseDhtml​(MarkupOutput out)
        Renders 'Use Dynamic HTML' preference.
        Parameters:
        out - the output object
        Since:
        MicroStrategy Web 7.5.1

      • renderAllowDhtml

        public void renderAllowDhtml​(MarkupOutput out)
        Renders 'Allow Dynamic HTML' preference.
        Parameters:
        out - the output object
        Since:
        MicroStrategy Web 7.5.1

      • render508Section

        public void render508Section​(MarkupOutput out)
        Renders 'Accessibility mode' section.
        Parameters:
        out - the output object

      • render508

        public void render508​(MarkupOutput out)
        Renders 'Accessibility mode' preference.
        Parameters:
        out - the output object
        Since:
        MicroStrategy Web 7.5.1

      • renderTrimWarehouseData

        public void renderTrimWarehouseData​(MarkupOutput out)
        Renders ' Trim Warehouse Datae' preference.
        Parameters:
        out - the output object
        Since:
        MicroStrategy Web 7.5.1

      • renderDropDownMenusSection

        public void renderDropDownMenusSection​(MarkupOutput out)
        Renders 'Drop down menu' section.
        Parameters:
        out - the output object

      • canDisplayDropDownMenus

        public boolean canDisplayDropDownMenus()
        Checks if the Dropdown menus sections should be disabled. This section is not available if the DHTML preference is not on, or if the Accessibility preference is on.
        Returns:
        true if accessibility is off and DHTML is turned on.
        Since:
        MicroStrategy Web 8.0.1

      • renderDropDownMenus

        public void renderDropDownMenus​(MarkupOutput out)
        Renders 'Drop down menu' preferecence.
        Parameters:
        out - the output object
        Since:
        MicroStrategy Web 7.5.1

      • renderHideMyReportsSection

        public void renderHideMyReportsSection​(MarkupOutput out)
        Deprecated.
        This preference has been moved to the Folder Browsing group
        Renders 'My Reports' section.
        Parameters:
        out - the output object

      • renderHideMyReports

        public void renderHideMyReports​(MarkupOutput out)
        Deprecated.
        This preference has been moved to the Folder Browsing group
        Renders 'My Reports' preference.
        Parameters:
        out - the output object
        Since:
        MicroStrategy Web 7.5.1

      • renderMaxSort

        public void renderMaxSort​(MarkupOutput out)
        Renders 'Max Sort keys' preference
        Parameters:
        out - the output object
        Since:
        MicroStrategy Web 9.0.0

      • renderSearchSection

        public void renderSearchSection​(MarkupOutput out)
        Renders 'Search' section.
        Parameters:
        out - the output object

      • renderWorkingSet

        public void renderWorkingSet​(MarkupOutput out)
        Renders 'Working Set' preference.
        Parameters:
        out - the output object
        Since:
        MicroStrategy Web 7.5.1

      • renderMaxSearch

        public void renderMaxSearch​(MarkupOutput out)
        Renders 'Max Search Preference' preference.
        Parameters:
        out - the output object
        Since:
        MicroStrategy Web 7.5.1

      • renderQuickSearch

        public void renderQuickSearch​(MarkupOutput out)
        Renders 'AutoComplete Search Preference' preference.
        Parameters:
        out - MarkupOutput
        Since:
        MicroStrategy Web 9.2.2

      • renderAutoComplete

        public void renderAutoComplete​(MarkupOutput out)
        Renders 'AutoComplete Search Preference' preference.
        Parameters:
        out - MarkupOutput
        Since:
        MicroStrategy Web 9.2.2

      • renderEnableGridViewSearch

        public void renderEnableGridViewSearch​(MarkupOutput out)
        Renders 'enable Grid View Search' preference.
        Parameters:
        out - MarkupOutput
        Since:
        MicroStrategy Web 9.3

      • renderSearchObjectTypes

        public void renderSearchObjectTypes​(MarkupOutput out)
        Render search object types section This section will be available only in DHTML mode and apply to Quick Search UI (even QuickSearch is disabled).
        Parameters:
        out - MarkupOutput
        Since:
        MicroStrategy Web 9.3

      • renderGridSearchObjectTypes

        public void renderGridSearchObjectTypes​(MarkupOutput out)
        Render Grid Search allowed object types section This section will be available only in DHTML mode
        Parameters:
        out - MarkupOutput
        Since:
        MicroStrategy Web 10.1

      • renderRefreshReportSection

        public void renderRefreshReportSection​(MarkupOutput out)
        Renders 'Refresh Report' section.
        Parameters:
        out - the output object

      • renderRefreshReport

        public void renderRefreshReport​(MarkupOutput out)
        Renders 'Refresh Report' preference.
        Parameters:
        out - the output object
        Since:
        MicroStrategy Web 7.5.1

      • renderReportCreation

        public void renderReportCreation​(MarkupOutput out)
        Renders 'Report Creation' preference.
        Parameters:
        out - the output object

      • renderConnectorWebBaseURL

        public void renderConnectorWebBaseURL​(MarkupOutput out)
        Renders 'Connector Url' preference.
        Parameters:
        out - the output object

      • renderLibraryWebBaseURL

        public void renderLibraryWebBaseURL​(MarkupOutput out)
        Renders 'Dossier Url' preference.
        Parameters:
        out - the output object

      • renderIncrementalFetchSection

        public void renderIncrementalFetchSection​(MarkupOutput out)
        Renders 'Incremental fetch' section.
        Parameters:
        out - the output object

      • renderElementsIncrementalFetch

        public void renderElementsIncrementalFetch​(MarkupOutput out)
        Renders 'Elements Incremental fetch' preference.
        Parameters:
        out - the output object
        Since:
        MicroStrategy Web 7.5.1

      • renderObjectsIncrementalFetch

        public void renderObjectsIncrementalFetch​(MarkupOutput out)
        Renders 'Objects Incremental fetch' preference.
        Parameters:
        out - the output object
        Since:
        MicroStrategy Web 7.5.1

      • renderWaitSection

        public void renderWaitSection​(MarkupOutput out)
        Renders 'Wait' section.
        Parameters:
        out - the output object

      • renderWait

        public void renderWait​(MarkupOutput out)
        Renders 'Wait' preference.
        Parameters:
        out - the output object
        Since:
        MicroStrategy Web 7.5.1

      • renderContactSection

        public void renderContactSection​(MarkupOutput out)
        Renders 'Administrator contact info' section.
        Parameters:
        out - the output object

      • renderContact

        public void renderContact​(MarkupOutput out)
        Renders 'Administrator contact info' preference.
        Parameters:
        out - the output object
        Since:
        MicroStrategy Web 7.5.1

      • renderFilterEditorSection

        public void renderFilterEditorSection​(MarkupOutput out)
        Renders 'Filter Editor' section.
        Parameters:
        out - the output object

      • renderUseEmbeddedFilters

        public void renderUseEmbeddedFilters​(MarkupOutput out)
        Renders the 'Use Embedded Filter' preference.
        Parameters:
        out - the output object
        Since:
        MicroStrategy Web 8.0.1

      • renderFontStyleSection

        public void renderFontStyleSection​(MarkupOutput out)
        Renders 'Font style' section.
        Parameters:
        out - the output object

      • renderFontStyleOption

        public void renderFontStyleOption​(MarkupOutput out)
        Renders 'Font style' preference.
        Parameters:
        out - the output object
        Since:
        MicroStrategy Web 8.0.0

      • renderFontStyle

        public void renderFontStyle​(MarkupOutput out)
        Renders 'Font style' preference.
        Parameters:
        out - the output object
        Since:
        MicroStrategy Web 7.5.1

      • renderFontSize

        public void renderFontSize​(MarkupOutput out)
        Renders 'Font size' preference.
        Parameters:
        out - the output object
        Since:
        MicroStrategy Web 7.5.1

      • renderOutputFormatsSection

        public void renderOutputFormatsSection​(MarkupOutput out)
        Renders 'Output Formats' section.
        Parameters:
        out - the output object
        Since:
        MicroStrategy Web 8.0.0

      • renderFullScreenModeDescriptorReports

        public void renderFullScreenModeDescriptorReports​(MarkupOutput out)
        Since:
        MicroStrategy Web 8.1.0

      • renderFullScreenModeBehaviorReports

        public void renderFullScreenModeBehaviorReports​(MarkupOutput out)
        Since:
        MicroStrategy Web 8.1.0

      • renderFullScreenModeDescriptorDocuments

        public void renderFullScreenModeDescriptorDocuments​(MarkupOutput out)
        Since:
        MicroStrategy Web 8.1.0

      • renderFullScreenModeBehaviorDocuments

        public void renderFullScreenModeBehaviorDocuments​(MarkupOutput out)
        Since:
        MicroStrategy Web 8.1.0

      • renderPDFPrint

        public void renderPDFPrint​(MarkupOutput out)
        Since:
        MicroStrategy Web 8.0.0

      • renderExportReuseNewWindow

        public void renderExportReuseNewWindow​(MarkupOutput out)
        Renders "Re-use new window for each export, print, PDF action" preference
        Since:
        MicroStrategy Web 8.0.0

      • renderNCSEnableSection

        public void renderNCSEnableSection​(MarkupOutput out)
        Renders 'Narrowcast Server' section.
        Parameters:
        out - the output object
        Since:
        MicroStrategy Web 8.0.0

      • isNCConfigured

        public boolean isNCConfigured()
        Checks if integration with Narrowcast Server is enabled.
        Returns:
        true if integration is enable.d
        Since:
        MicroStrategy Web 8.0.1

      • renderNCS

        public void renderNCS​(MarkupOutput out)
        Renders 'Narrowcast Server' preference.
        Parameters:
        out - the output object
        Since:
        MicroStrategy Web 8.0.0

      • renderSaveAs8iWarningSection

        public void renderSaveAs8iWarningSection​(MarkupOutput out)
        Renders 'Narrowcast Server' section.
        Parameters:
        out - the output object
        Since:
        MicroStrategy Web 8.0.0

      • renderSaveAsVersionWarningSection

        public void renderSaveAsVersionWarningSection​(MarkupOutput out)
        Since:
        MicroStrategy Web 8.1.2

      • renderSaveAs8iWarning

        public void renderSaveAs8iWarning​(MarkupOutput out)
        Renders the 'Save as 8i Warning' preference to know whether to prompt users to save reports using new features in MIcrostrategy 8.
        Parameters:
        out - the output object
        Since:
        MicroStrategy Web 8.0.1

      • renderSaveAsVersionWarning

        public void renderSaveAsVersionWarning​(MarkupOutput out)
        Since:
        MicroStrategy Web 8.1.2

      • renderKeepInCartSection

        public void renderKeepInCartSection​(MarkupOutput out)
        Renders Keep in Cart Section.
        Parameters:
        out - the output object
        Since:
        MicroStrategy Web 8.0.1

      • renderMMTAccessSection

        public void renderMMTAccessSection​(MarkupOutput out)
        Deprecated.
        not used anymore
        Renders MMT Section section.
        Parameters:
        out - the output object
        Since:
        MicroStrategy Web 8.0.0

      • hasMMTAccess

        public boolean hasMMTAccess()
        Deprecated.
        not used anymore
        Checks if the application can be integrated with Microstrategy e-Trainer.
        Returns:
        trueif EnumAppWebFeatures.WebFeatureMMTAccess is enabled.
        Since:
        MicroStrategy Web 8.0.1

      • renderMMTAccessOption

        public void renderMMTAccessOption​(MarkupOutput out)
        Deprecated.
        not used anymore
        Renders MMT Section preference.
        Parameters:
        out - the output object
        Since:
        MicroStrategy Web 8.0.0

      • renderMMTAddress

        public void renderMMTAddress​(MarkupOutput out)
        Deprecated.
        not used anymore
        Renders MMT address preference.
        Parameters:
        out - the output object
        Since:
        MicroStrategy Web 8.0.0

      • setFontNamePicker

        public void setFontNamePicker​(ShortcutList fontNamePicker)
        Parameters:
        fontNamePicker - The fontNamePicker to set.
        Since:
        MicroStrategy Web 8.0.0

      • setStartPagesPicker

        public void setStartPagesPicker​(ShortcutList startPagesPicker)
        Parameters:
        startPagesPicker - The startPagesPicker to set.
        Since:
        MicroStrategy Web 8.0.0

      • setTimeZonePicker

        public void setTimeZonePicker​(ShortcutList timeZonePicker)
        Parameters:
        timeZonePicker - The timeZonePicker to set.
        Since:
        MicroStrategy Web 8.0.0

      • renderSingleLastObjectRun

        public void renderSingleLastObjectRun​(MarkupOutput lastObjectOption,
                                      java.lang.StringBuffer lastObjectLabel,
                                      WebEvent event,
                                      java.lang.String pageTitle,
                                      java.lang.String descriptor)
        Since:
        MicroStrategy Web 8.0.1

      • renderLastObjectRunOption

        public void renderLastObjectRunOption​(MarkupOutput lastObjectOption,
                                      java.lang.StringBuffer lastObjectLabel)
        Since:
        MicroStrategy Web 8.0.1

      • renderFontShoppingCart

        public void renderFontShoppingCart​(MarkupOutput out)

      • renderEnableVisEditor

        public void renderEnableVisEditor​(MarkupOutput out)
        Renders preference that allows users to open the Custom Visualizations Editor
        Parameters:
        out - MarkupOutput
        Since:
        MicroStrategy Web 8.1.0

      • renderSaveAsOptions

        public void renderSaveAsOptions​(MarkupOutput out)

      • renderSavePromptedReportAs

        public void renderSavePromptedReportAs​(MarkupOutput out,
                                       java.lang.String preferenceEnumName,
                                       java.lang.String controlledDiv)

      • renderAskBeforeSaveChanges

        public void renderAskBeforeSaveChanges​(MarkupOutput out,
                                       java.lang.String preferenceEnumName)
        Renders the drop down list of ask before saving changes
        Parameters:
        out -

      • enableAutomaticSessionRecovery

        public boolean enableAutomaticSessionRecovery()
        Check the hidden preference that controls the session recovery feature
        Returns:
        boolean

      • renderWarningSessionTimeout

        public void renderWarningSessionTimeout​(MarkupOutput out)
        Renders 'enable warning before Web user session timeout' preference.
        Parameters:
        out - MarkupOutput
        Since:
        MicroStrategy Web Polaris

      • renderMaxSessionIdleTime

        public void renderMaxSessionIdleTime​(MarkupOutput out)
        Renders maximum session idle time
        Parameters:
        out - MarkupOutput
        Since:
        MicroStrategy Web Polaris

      • renderHierarchicalSort

        public void renderHierarchicalSort​(MarkupOutput out)
        Renders 'Sort metrics hierarchically' preference
        Parameters:
        out - the output object
        Since:
        MicroStrategy Web Polaris

      • renderFeatureInfoList

        public void renderFeatureInfoList​(MarkupOutput out)