Package com.microstrategy.web.app.transforms

Class FolderProjectBrowserTransform

    • Field Detail

      • contextID

        public FormalParameter contextID
        Formal parameter: The context for the object browser fodler links

      • levelChangeJS

        public FormalParameter levelChangeJS
        Formal parameter: The javascript function to execute when you change the folder level

      • searchJS

        public FormalParameter searchJS
        Indicates the javascript function to execute when you click on the search image button

      • searchBoxJS

        public FormalParameter searchBoxJS
        Indicates the javascript function to execute when you key on the search box
        Since:
        MicroStrategy Web 8.0.2

      • upFolderJS

        public FormalParameter upFolderJS
        Formal parameter: The JavaScript code to execute when clicking on the up folder link to go to the parent folder
        Since:
        MicroStrategy Web 8.0.2

      • renderForm

        public FormalParameter renderForm
        Indicates whether the transform will render it's own HTML form

      • folderLinksLocation

        public FormalParameter folderLinksLocation
        Indicates where the Object Browser Folder Links will be rendered 1 - Root 2 - All Folders 3 - Project

      • renderLinksAncestors

        public FormalParameter renderLinksAncestors
        Indicates whether the Ancestors of the Object Browser Folder Links will be rendered

      • checkImage

        public FormalParameter checkImage
        Formal parameter: The icon to use to submit the parent folders select box in HTML mode. Used only in HTML mode. For DHTML mode, the CSS contains the image

      • htmlGraphicMode

        public FormalParameter htmlGraphicMode
        Indicates wheter to render the browser in gaphic mode even in html mode.

      • allowBrowseDimension

        public FormalParameter allowBrowseDimension
        Indicates wheter to render the browser in gaphic mode even in html mode.
        Since:
        MicroStrategy Web 9.0.0

      • FP_UP_FOLDER_JS

        public static final java.lang.String FP_UP_FOLDER_JS
        Name for the formal parameter: upFolderJS
        Since:
        MicroStrategy Web 8.0.2
        See Also:
        Constant Field Values

      • FP_SEARCH_BOX_JS

        public static final java.lang.String FP_SEARCH_BOX_JS
        Name for the formal parameter: searchBoxJS
        Since:
        MicroStrategy Web 8.0.2
        See Also:
        Constant Field Values

      • FP_FOLDER_LINKS_LOCATION

        public static final java.lang.String FP_FOLDER_LINKS_LOCATION
        Name for the formal parameter: renderForm
        See Also:
        Constant Field Values

      • FP_ALLOW_BROWSE_DIMENSION

        public static final java.lang.String FP_ALLOW_BROWSE_DIMENSION
        Name for the formal parameter: allowBrowseDimension
        Since:
        MicroStrategy Web 9.0.0
        See Also:
        Constant Field Values

      • cssFileSearch

        protected java.lang.String cssFileSearch
        The className for the search text box

      • cssBody

        protected java.lang.String cssBody
        The className for the body of the project browser contents

    • Constructor Detail

      • FolderProjectBrowserTransform

        public FolderProjectBrowserTransform()
        Default Constructor. Initializes the formal parameters contextID, levelChangeJS, searchJS and renderForm.

    • Method Detail

      • initializeCss

        public void initializeCss()
        Initializes the Css Classes to use. For each one of the css classes to use, the prefix indicated on the formal parameter is added to the name of the class to use.
        Overrides:
        initializeCss in class AbstractFolderTransform

      • initializeImages

        public void initializeImages()
        Initializes the name of the images to use on this transform's output. For each one of the images defined to be displayed, the resource folder information is added to its path and file name as specified on the formal parameters for the images.
        Overrides:
        initializeImages in class AbstractFolderTransform

      • isNamedFolder

        public boolean isNamedFolder​(int folderName)
        Returns true if the current folder corresponds to the system folder provided as a parameter
        Parameters:
        folderName - int
        Returns:
        boolean

      • renderHiddenInputs

        public void renderHiddenInputs​(MarkupOutput out)
        Renders the hidden inputs of the events that can be handled by the bean
        Parameters:
        out - MarkupOutput

      • getSubFolders

        public java.util.List getSubFolders()

      • getSubfolders

        public java.util.ArrayList getSubfolders()
        Deprecated.
        please use getSubFolders() instead
        Returns an arraylist with the subfolders of the current folder
        Returns:
        ArrayList

      • getFolderObjects

        public java.util.ArrayList getFolderObjects()
        Deprecated.
        please use getNonFolderObjects() instead
        Returns an arraylist with the non-folder contents of the current folder
        Returns:
        ArrayList

      • getNonFolderObjects

        public java.util.List getNonFolderObjects()
        Since:
        MicroStrategy Web 9.0.0

      • renderSubfolders

        public void renderSubfolders​(MarkupOutput out)
        renders the current's folder subfolders as a list
        Parameters:
        out - MarkupOutput

      • renderFolderLinks

        public void renderFolderLinks​(MarkupOutput out)
        renders the current's non-folder contensts as a list
        Parameters:
        out - MarkupOutput

      • renderFolderObjects

        public void renderFolderObjects​(MarkupOutput out)
        renders the current's folder links as a list
        Parameters:
        out - MarkupOutput

      • renderFolderContentHTML

        public void renderFolderContentHTML​(MarkupOutput out,
                                    WebObjectInfo woi)
        Renders a single non-folder content item from the current folder in HTML mode
        Parameters:
        out - MarkupOutput

      • renderFolderContentsTitleHTML

        public void renderFolderContentsTitleHTML​(MarkupOutput out)
        Renders the current folder's non-folder contents title when in HTML mode
        Parameters:
        out - MarkupOutput instance where the HTML output is to be saved.

      • renderFolderContentsSubmitButtonHTML

        public void renderFolderContentsSubmitButtonHTML​(MarkupOutput out)
        Renders the submit button for the folde's non-folder contents section in HTML mode
        Parameters:
        out - MarkupOutput instance where the HTML output is to be saved.

      • renderFoldersTitleHTML

        public void renderFoldersTitleHTML​(MarkupOutput out)
        Renders the current folder's subfolders title when in HTML mode
        Parameters:
        out - MarkupOutput instance where the HTML output is to be saved.

      • renderFoldersSubmitButtonHTML

        public void renderFoldersSubmitButtonHTML​(MarkupOutput out)
        Renders the submit button for the folde's subfolders section in HTML mode
        Parameters:
        out - MarkupOutput instance where the HTML output is to be saved.

      • renderFolderLink

        public void renderFolderLink​(MarkupOutput out,
                             WebObjectInfo link)
        Renders a single Object Browser Folder Link
        Parameters:
        out - MarkupOutput
        link - WebObjectInfo

      • renderFolderLinkOptions

        public void renderFolderLinkOptions​(MarkupOutput out)
        Renders a set of options for a select input containing the different object browser forlder links available for the current context.
        Parameters:
        out - MarkupOutput

      • getObjectName

        public java.lang.String getObjectName​(WebObjectInfo object)
        Description copied from class: AbstractObjectInfoListTransform
        Utility method for obtaining the name of the object being analyzed
        Overrides:
        getObjectName in class AbstractObjectInfoListTransform
        Parameters:
        object - WebObjectInfo instance to be processed.
        Returns:
        value of the name property of the object. If handling a shortcut, it will obtain the property of the original target object and return this as result. By default the result will be encoded for its proper display on HTML.
        Since:
        MicroStrategy Web 9.0.0

      • renderOpenParentLink

        public void renderOpenParentLink​(MarkupOutput out)
        Renders a link to the folder's parent
        Parameters:
        out - MarkupOutput

      • setUpFolderJS

        protected void setUpFolderJS​(AnchorTag anchor)
        Sets the JavaScript code to execute when clicking on the up folder link to go to the parent folder.
        Parameters:
        anchor - The anchor tag on which we want to set the JavaScript.

      • renderAncestorsSelector

        public void renderAncestorsSelector​(MarkupOutput out)
        Renders a select box containing a list of the folder's ancestors
        Parameters:
        out - MarkupOutput

      • renderSearchBox

        public void renderSearchBox​(MarkupOutput out)
        Renders the search box for the project browser
        Parameters:
        out - MarkupOutput

      • shouldRenderFolderLinks

        public boolean shouldRenderFolderLinks()
        Determines if the Object Browser Folder Links should be rendered.
        Returns:
        boolean

      • renderSearchSection

        public void renderSearchSection​(MarkupOutput out)
        Renders the search section of the project browser in DHTML mode
        Parameters:
        out - MarkupOutput

      • renderSearchButton

        public void renderSearchButton​(MarkupOutput out)
        Renders a Magnifier image as the search/filter button of the browser
        Parameters:
        out - MarkupOutput

      • renderClearSearch

        public void renderClearSearch​(MarkupOutput out)
        Renders a Link to clear search result and return to original content
        Parameters:
        out - MarkupOutput
        Since:
        MicroStrategy Web 9.0.0

      • getFolderLinkList

        public java.util.ArrayList getFolderLinkList()
        Returns a list containing the object browser folder links available for the current context.
        Returns:
        SimpleList

      • getFolderRoot

        protected WebObjectInfo getFolderRoot()
        Returns a (@link WebObjectInfo) as a reference to the folder being displayed by the transform.
        Returns:
        WebObjectInfo

      • setFolderRoot

        protected void setFolderRoot​(WebObjectInfo oi)

      • getBrowseEvent

        protected WebEvent getBrowseEvent()
        Returns a WebEvent instance containing the event to use when browsing the folder list displayed by the transform.
        Returns:
        WebEvent

      • getBrowseParentFolderEvent

        protected WebEvent getBrowseParentFolderEvent()
        Returns a WebEvent instance containing the event to use when browsing the folder list displayed by the transform.
        Returns:
        WebEvent

      • getSearchEvent

        protected WebEvent getSearchEvent()
        Returns a WebEvent instance containing the event to use when searching trhought the folder list displayed by the transform.
        Returns:
        WebEvent

      • getJavascriptTyAttribute

        protected java.lang.String getJavascriptTyAttribute​(WebObjectInfo object)
        Return the Javascript TY attribute to use for the generation of the HTML tag related with this object.
        Parameters:
        object - The WebObjectInfo for which it's ty attribute name is requested.
        Returns:
        The Javascript TY attribute to use for the generation of the HTML tag related with this object. If none is found given the object type, null will be returned.

      • getTooltipInfo

        protected java.lang.String getTooltipInfo​(WebObjectInfo item)
        Returns the tooltip to add to each individual item in the Folder's list.
        Overrides:
        getTooltipInfo in class FolderSmallIconTransform
        Parameters:
        item - WebObjectInfo the folder's child. It includes the name and description of the item.
        Returns:
        String the tooltip to add to the HTML output.

      • getForm

        protected Tag getForm​(Tag content)
        The method will check if the renderFOrm formal parameter is set to true, and if so it will create a new form tag, insert the contents passed as parameter and return the form. If the formal parameter is set to false, the method return the same tag passed as parameter.
        Parameters:
        content - Tag
        Returns:
        Tag

      • getTooltipTitle

        protected java.lang.String getTooltipTitle​(WebObjectInfo item)
        Returns the descriptor to use for rendering the itemss tooltips.
        Parameters:
        item - WebObjectInfo
        Returns:
        String

      • getFolderLinkClasses

        protected java.lang.String getFolderLinkClasses​(WebObjectInfo object)
        Returns the cssClass name to use when rendering the object browser folder links
        Parameters:
        object - WebObjectInfo
        Returns:
        String

      • getFolderContentsSelectNameHTML

        protected java.lang.String getFolderContentsSelectNameHTML()
        returns the name the select box for folder contentss in HTML will have
        Returns:
        String

      • getProjectID

        protected java.lang.String getProjectID()
        Private method that gets the Project ID from the session manager
        Overrides:
        getProjectID in class AbstractAppTransform
        Returns:
        String projectID

      • getHiddenInputsEventList

        protected java.util.ArrayList getHiddenInputsEventList()
        Returns the list of events that will be included in the hidden inputs section.
        Returns:
        ArrayList

      • getFolderLinksContextId

        public int getFolderLinksContextId()
        Since:
        MicroStrategy Web 9.0.0

      • getFodlerLinksContextId

        public int getFodlerLinksContextId()
        Deprecated.
        please use getFolderLinksContextId() instead
        Returns the context id (from EnumObjectBrowserContexts) to use
        Returns:
        int

      • getLinkAttributes

        public java.util.Map getLinkAttributes​(WebObjectInfo object)
        this function is added to help generate layered icon in prompt project browser editor Get attribute for folder link in smallIconView
        Parameters:
        object - - WebObjectInfo web object to get attribute from
        Returns:
        Map
        Since:
        MicroStrategy Web 9.0.0

      • renderLayeredIconInfo

        public void renderLayeredIconInfo​(MarkupOutput out,
                                  WebObjectInfo object,
                                  boolean useLinkCss)
        generate a SPAN tag which host background image and an inner SPAN for the layering effect in case an additional image has to be included on top of the original (for example, a shortcut arrow, a red error sign, etc).
        Overrides:
        renderLayeredIconInfo in class AbstractObjectInfoListTransform
        Parameters:
        out - MarkupOutput instance where to save the contents to display
        object - WebObjectInfo to be rendered.
        useLinkCss - flag for a largeIconView or listView
        Since:
        MicroStrategy Web 9.0.0