Package com.microstrategy.web.app.transforms

Class SearchSuggestTransform

    • Field Detail

      • _mstrPage

        protected PageComponent _mstrPage
        Property to keep the information about the PageComponent associated with the page currently being rendered

      • id

        protected FormalParameter id
        Indicates the name of the outer shell for all folder modes.
        Since:
        MicroStrategy Web 9.0.0

      • isMiniSearchBox

        protected FormalParameter isMiniSearchBox
        Flag to indicate whether this is SearchBox in ShortcutsBar.

      • isServerSearch

        protected FormalParameter isServerSearch
        Flag to indicate whether this is SearchBox in IServer Admin page (Users and Security Roles Search)

      • showAsPopup

        protected FormalParameter showAsPopup
        Flag to indicate whether to show Search Results in a Popup This should be true for QuickSearchBox in ShortcutsBar, and SearchBox in Desktop Page.

      • showSuggestionAsPopup

        protected FormalParameter showSuggestionAsPopup
        Flag to indicate whether to show Suggestion List in a popup; or just below the SearchBox This should be true for QuickSearchBox in ShortcutsBar, and SearchBox in Desktop Page.

      • showSettings

        protected FormalParameter showSettings
        Flag to indicate where to make Advanced Search Options visible. This should be true for Desktop Page and Search Page SearchBox.

      • defaultRootFolderType

        protected FormalParameter defaultRootFolderType
        Search scope folder that used when no explicit folder is given (default as "All Folders"). Such as in Home, Search, Preferences page. But not in pages that have explicit folder, such as My Reports, Shared Reports, or navigating to any folder. Value options: Root Folder, My Reports, Shared Reports that defined in @EnumDSSXMLFolderNames;

    • Constructor Detail

      • SearchSuggestTransform

        public SearchSuggestTransform()
        Default no-args constructor, initialize formal parameters.

    • Method Detail

      • initializeTransform

        public void initializeTransform​(Transformable data)
        Description copied from class: AbstractAppTransform

        This method initialize the private and protected fields of the transform, such as width and height. It also invokes the initializeWebComponent, initializeImages and initializeCss methods.

        This method is automatically called from the transform method. Transforms which would like to invoke other methods in this instance directly (for example, to invoke some render methods), need first to call this method to guarantee that the Transform is ready to generate output.
        Specified by:
        initializeTransform in interface AppTransform
        Overrides:
        initializeTransform in class SearchSimpleTransform
        Parameters:
        data - the bean to transform.

      • getID

        public java.lang.String getID()
        Description copied from class: AbstractAppTransform
        Returns the unique name of the component to be used as the ID for its shell. This id is used for updating the page using the iFrame technology, and as the id for the corresponding bone (if any).
        Specified by:
        getID in interface Transform
        Overrides:
        getID in class AbstractAppTransform
        Returns:
        the component's unique id
        Since:
        MicroStrategy Web 9.0.0

      • setBoneProperties

        protected void setBoneProperties​(JsonGenerator boneProps)
        If we render bone shell from transform, then we want to pass these properties to the bone.
        Overrides:
        setBoneProperties in class AbstractAppTransform
        Parameters:
        boneProps - the JsonGenerator object that contains the collection of bone properties.

      • renderJavaScriptFooter

        public void renderJavaScriptFooter​(MarkupOutput out)
        Renders javascript variables at the bottom of the transform to be used in DHTML mode.
        Overrides:
        renderJavaScriptFooter in class SearchSimpleTransform
        Parameters:
        out - where to write the output of the method.

      • isSettingVisible

        public boolean isSettingVisible()

      • addTitleAttr

        public java.util.Map addTitleAttr​(int descId)

      • addAttr

        public java.util.Map addAttr​(java.lang.String name,
                             java.lang.String value)

      • addAttr

        public java.util.Map addAttr​(java.lang.String name,
                             int descId)

      • renderShell

        public void renderShell​(MarkupOutput out)
        Description copied from class: AbstractAppTransform

        Generates the shell for this Transform.

        The shell is a <div> tag that automatically surrounds the content generated by the Transform. It's used among other things by the javascript to identify the HTML associated with a bone, and by the iFrame update technology to identify a component in the page.

        The attributes to append to this <div> are obtained from the getAttributesShellDiv method; the style from the getStyleShellDiv method.
        This method calls renderCssLink and checkStatus to generate the Transform's content.
        Overrides:
        renderShell in class AbstractAppTransform
        Parameters:
        out - output by this transform

      • createSearchBlock

        protected Block createSearchBlock​(MarkupOutput out)
                           throws java.lang.Exception
        Throws:
        java.lang.Exception

      • setObjectTypes

        public void setObjectTypes​(java.lang.String value)
        Sets the list of object-types used for searching. This must be a comma separated list of object-types. Valid object types are those from the EnumDSSXMLObjectSubTypes or EnumDSSXMLObjectTypes enumerations.
        Since:
        MicroStrategy Web 9.0.0

      • getObjectTypes

        protected java.lang.String getObjectTypes()
        Returns a comma separated list of object-types. If this parameter is not explicitly set, this method will return the default list of object types, that is: reports, documents and folders.
        Since:
        MicroStrategy Web 9.0.0

      • setRootFolderId

        public void setRootFolderId​(java.lang.String value)
        Sets the id of the folder to be used as root for searching. This must be a valid id of a folder existing in the md.
        Since:
        MicroStrategy Web 9.0.0

      • getRootFolderId

        protected java.lang.String getRootFolderId()
        Returns the id of the folder to be used as root for searching. If this parameter has not been explicitly set, it will be calculated based on the application context.
        Since:
        MicroStrategy Web 9.0.0

      • getSysFolder

        protected int getSysFolder()
        Returns the system folder name as defined in EnumDSSXMLFolderNames to be used as root for searching. When a folder-id is also set, this method will return "0". If shared-reports has been set, this method might return "0" if the admin has configured a custom folder for shared reports.
        If this parameter has not been explicitly set, it will be calculated based on the application context.
        Since:
        MicroStrategy Web 9.0.0

      • setSysFolder

        public void setSysFolder​(java.lang.String sysFolder)
        Sets the system folder name as defined in EnumDSSXMLFolderNames to be used as root for searching. When a non-system folder should be used, this value must be set to "0". Assigning any other value will clear the root folder id parameter.
        Since:
        MicroStrategy Web 9.0.0
        See Also:
        getSysFolder()

      • getPreferenceSharedReportsFolderID

        protected java.lang.String getPreferenceSharedReportsFolderID()
        Returns the value of the admin preference for shared reports, or null if it has not been set.
        Since:
        MicroStrategy Web 9.0.0