Package com.microstrategy.web.app.transforms

Class ObjectPathXHTMLTransform

    • Field Detail

      • LEVEL_HOME_BUTTON

        public static final int LEVEL_HOME_BUTTON
        Deprecated.
        please use the layout xml
        Allowed value for the levelFlag formal parameter. Determines if a home button will be displayed on the left side of the path information. Value = 1024
        See Also:
        Constant Field Values

      • LEVEL_PARENT_UP_BUTTON

        public static final int LEVEL_PARENT_UP_BUTTON
        Deprecated.
        please use the layout xml
        Allowed value for the levelFlag formal parameter. Determines if a parent up button will be displayed on the left side of the path information. Value = 256
        See Also:
        Constant Field Values

      • LEVEL_NEW_FOLDER_BUTTON

        public static final int LEVEL_NEW_FOLDER_BUTTON
        Deprecated.
        please use the layout xml
        Allowed value for the levelFlag formal parameter. Determines if a parent up button will be displayed on the left side of the path information. Value = 512
        See Also:
        Constant Field Values

    • Constructor Detail

      • ObjectPathXHTMLTransform

        public ObjectPathXHTMLTransform()
        Deprecated.
        Default constructor, initialize formal parameters.

    • Method Detail

      • renderContent

        public void renderContent​(MarkupOutput out)
        Deprecated.
        Transform when the status is "Successful". It displays the path of the folder with a link to each one of its ancestors, i.e.:
        Home > VMall Shared Reports
        Overrides:
        renderContent in class ObjectPathTransform
        Parameters:
        out - a MarkupOutput instance with the HTML output by this transform

      • getImageSrc

        protected java.lang.String getImageSrc​(java.lang.String imgId)
        Deprecated.
        Get the image source to display as part of the object path content. This method is called only when the user has turned on Accessibility mode under Preferences.
        Parameters:
        imgId - String indicating the ID of the image from where the source should be calculated. For example, values like tbHome or tbReturn are expected
        Returns:
        String with the source to use for the image to display.
        Since:
        MicroStrategy Web 8.1.1

      • renderHomeButton

        public void renderHomeButton​(MarkupOutput out)
        Deprecated.
        Renders a button link to Home, it uses the openHomeEvent for this.
        Parameters:
        out - the transform's output

      • renderParentUpButton

        public void renderParentUpButton​(MarkupOutput out)
        Deprecated.
        Renders a button link to the parent folders.
        Parameters:
        out - the transform's output

      • renderCreateFolderButton

        public void renderCreateFolderButton​(MarkupOutput out)
        Deprecated.

      • renderAncestors

        public void renderAncestors​(MarkupOutput out)
        Deprecated.
        please use the layout xml or renderAncestors(MarkupOutput out, int rootIndex);
        Renders the list of ancestors.
        Overrides:
        renderAncestors in class ObjectPathTransform
        Parameters:
        out - the transform's output
        Since:
        MicroStrategy Web 8.0.1

      • renderAncestors

        public void renderAncestors​(MarkupOutput out,
                            int rootIndex)
        Deprecated.
        Renders the folder ancestors as path
        Parameters:
        out -
        rootIndex - , indicates the starting index of the ancestors For example, desktop link is the highest ancestor with index of 0; by specifying rootIndex=1, the desktop link won't be rendered
        Since:
        MicroStrategy Web 8.0.1

      • isSpecialFolder

        public boolean isSpecialFolder()
                        throws WebBeanException
        Deprecated.
        Checks if the current object is a special folder
        Returns:
        boolean indicating whether it is a sepcial folder.
        Throws:
        WebBeanException
        Since:
        MicroStrategy Web 8.0.1

      • getObjectPathFolderAncestors

        public java.util.List getObjectPathFolderAncestors​(int rootIndex)
        Deprecated.
        Returns all the ancestors of the current object
        Parameters:
        rootIndex - , indicates the starting index of the ancestor
        Returns:
        a list of ancestors, the order is top down, the first ancestor (index 0) is the the highest ancestor (i.e, server, project)
        Since:
        MicroStrategy Web 8.0.1

      • getOpenCreateFolderEvent

        protected WebEvent getOpenCreateFolderEvent()
        Deprecated.

      • generateAnchor

        protected AnchorTag generateAnchor​(WebEvent event)
        Deprecated.
        Overwrites the parent method by setting the right event element value according to the formal parameters available on the transform
        Overrides:
        generateAnchor in class ObjectPathTransform
        Parameters:
        event - WebEvent instance from where the anchor will be constructed
        Returns:
        AnchorTag initialized instance with the information as provided by the arguments.

      • renderSimpleButton

        protected void renderSimpleButton​(MarkupOutput out,
                                  WebEvent event,
                                  java.lang.String descriptor,
                                  java.lang.String id,
                                  java.lang.String src)
        Deprecated.

      • renderParentFolderDelimiter

        public void renderParentFolderDelimiter​(MarkupOutput out)
        Deprecated.
        Renders the delimiter between the folder names The divider character is set through Formal Parameter
        Parameters:
        out -

      • renderAncestor

        public void renderAncestor​(MarkupOutput out,
                           WebFolder folder)
        Deprecated.
        Renders the WebFolder object name w/o the hyperlink to that folder
        Parameters:
        out -
        folder - , the folder to be rendered
        Since:
        MicroStrategy Web 8.0.1

      • renderSimpleLink

        protected void renderSimpleLink​(MarkupOutput out,
                                WebEvent event,
                                java.lang.String descriptor,
                                java.lang.String css,
                                boolean showLink)
        Deprecated.
        Renders a link based on the event.
        Overrides:
        renderSimpleLink in class ObjectPathTransform
        Parameters:
        out - the transform's output
        event - the event associated witht he link
        descriptor - the content of the link
        css - the class to use
        showLink - whether to render to link or not (if false, the descriptor will be simply rendered within a SPAN tag).