Package com.microstrategy.web.app.transforms

Class FolderObjectExplorerTransform

    • Field Detail

      • promptString

        public FormalParameter promptString
        Since:
        MicroStrategy Web 9.0.0

      • promptStringID

        public FormalParameter promptStringID
        Since:
        MicroStrategy Web 9.0.0

    • Constructor Detail

      • FolderObjectExplorerTransform

        public FolderObjectExplorerTransform()

    • Method Detail

      • getLinkAttributes

        public java.util.Map getLinkAttributes​(WebDisplayUnit du)
        Returns a map containing the attributes to add to the container of every folder link in the list of contents.
        Parameters:
        du - WebDisplayUnit
        Returns:
        Map

      • getUnitAttributes

        public java.util.Map getUnitAttributes​(WebDisplayUnit du)
        Returns a map containing the attributes to add to the container of every object in the list of contents.
        Overrides:
        getUnitAttributes in class AbstractObjectExplorerTransform
        Parameters:
        du - WebDisplayUnit
        Returns:
        Map
        Since:
        MicroStrategy Web 9.0.0

      • shouldRenderFolderLinks

        public boolean shouldRenderFolderLinks()
        Determines if the Folder Links should be rendered.
        Returns:
        boolean
        Since:
        MicroStrategy Web 9.0.0

      • renderPromptString

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

      • getFolderRoot

        public WebObjectInfo getFolderRoot()
        Returns a (@link WebObjectInfo) as a reference to the folder bean displayed by the transform.
        Returns:
        WebObjectInfo TODO shouldn't this chunck of code be part of the FolderBeanImpl?
        Since:
        MicroStrategy Web 9.0.0

      • addLinksAsOption

        protected void addLinksAsOption​(SelectTag __result)
        Method adds the standard shortcut links that have to be displayed after the contents of the object browser. These links are shortcuts to the Attributes, Metrics, Hierarchies ... folders
        Parameters:
        __result -
        Since:
        MicroStrategy Web 9.0.0

      • shouldAddLinks

        protected boolean shouldAddLinks()
        Determines whether we should show the links for the object browser.
        Returns:
        boolean
        Since:
        MicroStrategy Web 9.0.0

      • isFolder

        protected boolean isFolder​(WebDisplayUnit du)
        Determined whether the unit provided represents a folder in metadata.
        Parameters:
        du - WebDisplayUnit
        Returns:
        boolean true if is a folder.

      • constructEntireTree

        protected TreeNode constructEntireTree()
        This method is used in two scenarios: 1. Every time when we bring up the editor bean by clicking on the link (in this case the whole tree needs to be constructed for sure) 2. when the user switches from a list view to a tree view, the tree needs to be re-constructed possibly from a sub-node all the way to the root folder specified in the configuration
        Specified by:
        constructEntireTree in class AbstractObjectExplorerTreeTransform
        Returns:
        TreeNode the root of the fully constructed tree
        Since:
        MicroStrategy Web 9.0.0

      • getTooltipInfo

        protected java.lang.String getTooltipInfo​(WebObjectInfo item)
        Returns the tooltip to add to each individual item in the Folder's list.
        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.
        Since:
        MicroStrategy Web 9.0.0

      • getTooltipTitle

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

      • generateIncrementalFetchNode

        protected TreeNode generateIncrementalFetchNode​(int direction)
        this methods generates the incremental fetch nodes for the current expanded folder
        Overrides:
        generateIncrementalFetchNode in class AbstractObjectExplorerTreeTransform
        Parameters:
        direction - PREVIOUS - fetch the previous block NEXT - fetch the next block
        Since:
        MicroStrategy Web 9.0.0

      • generateIncrementalFetchNode

        protected TreeNode generateIncrementalFetchNode​(int direction,
                                                WebFolder folder)
        this method generates the incremental fetch tree nodes (next, prev) when necessary inside of a given webfolder
        Parameters:
        direction - the direction of the node (PREVIOUS or NEXT)
        folder - the folder which the incremental fetch nodes should be added to
        Since:
        MicroStrategy Web 9.0.0

      • generateSearchNode

        protected TreeNode generateSearchNode​(java.util.List contents,
                                      WebSearch searchObj)
        this method generates a tree node that represents the root node for the search results it's used when switching from a list view of search results to the tree view
        Parameters:
        contents - the list of the search results
        searchObj - the search object that is used to retrieve the search results
        Since:
        MicroStrategy Web 9.0.0

      • shouldRenderLinks

        protected boolean shouldRenderLinks​(TreeNode node)
        this method checks to see whether we should render links as subnode of the given node
        Specified by:
        shouldRenderLinks in class AbstractObjectExplorerTreeTransform
        Parameters:
        node - the node to check against
        Since:
        MicroStrategy Web 9.0.0

      • isTreeRoot

        protected boolean isTreeRoot​(java.lang.String objID)
                      throws WebObjectsException
        Returns:
        identify whether a given ID of a WebDisplayUnit is the root of the tree display or not; the root in the cube report editor should be "Shared Reports"
        Throws:
        WebObjectsException
        Since:
        MicroStrategy Web 9.0.0

      • getList

        protected java.util.List getList​(SimpleList simpleList)
        Since:
        MicroStrategy Web 9.0.0

      • getReportViewMode

        protected int getReportViewMode​(WebObjectInfo object)
        Returns whether the report is in Grid mode, Graph mode or Grid-Graph mode.
        Parameters:
        object -
        Returns:
        int

      • isVisualizationObject

        protected boolean isVisualizationObject​(WebObjectInfo object)

      • getVisualizationMode

        protected int getVisualizationMode​(WebObjectInfo object)

      • renderLayeredIconInfo

        public void renderLayeredIconInfo​(MarkupOutput out,
                                  WebDisplayUnit 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).
        Parameters:
        out - MarkupOutput instance where to save the contents to display
        object - WebDisplayUnit to be rendered.
        Since:
        MicroStrategy Web 9.0.0