Package com.microstrategy.web.app.transforms

Class PromptObjectBrowsingTransform

  • All Implemented Interfaces:
    EnumPromptsBeanEvents, Transform
    public class PromptObjectBrowsingTransform
extends PromptCartTransform
    Deprecated.
    Use PromptObjectBrowsingXHTMLTransform instead

    Renders prompt content in a "shopping cart" style with a browseable folder path.
    It extends PromptCartTransform by adding a folder path above the prompt question and by allowing end-user to navigate to available subfolders. Also, it will only display objects that are defined in prompt definition; this means that if only templates are to be displayed then any instance will be displayed if found under given subfolder.

    Since:
    MicroStrategy Web 7.3.1 or earlier

    • Field Detail

      • backToParentFolderImage

        public FormalParameter backToParentFolderImage
        Deprecated.
        Image for going up in browsing path for object prompts.
        Object Prompts might support object browsing. This is done by displaying a browsing path above given prompt question. This path is similar to that used for displaying location of a given report. This image represents the button for allowing end-users to browse up in the hierarchy.

      • _backToParentFolderImage

        protected java.lang.String _backToParentFolderImage
        Deprecated.

      • folderPathSeparator

        public FormalParameter folderPathSeparator
        Deprecated.
        Character used as separator in browsing path for object prompts.
        This flag is used as text value.

      • cssItemName

        public FormalParameter cssItemName
        Deprecated.
        Formal parameter of the prefix to append to all css class names

      • browsePath

        protected java.lang.String browsePath
        Deprecated.
        Browse path string.

    • Constructor Detail

      • PromptObjectBrowsingTransform

        public PromptObjectBrowsingTransform()
        Deprecated.
        Default no-args constructor, initialize all the formal parameters.

    • Method Detail

      • renderCart

        public void renderCart​(MarkupOutput out)
        Deprecated.
        Renders a shopping cart.
        It invokes renderAvailable(), renderArrows() and renderSelected().
        Overrides:
        renderCart in class PromptCartTransform
        Parameters:
        out - MarkupOutput where to write the output of the method.

      • updateIncrementalFetchCartProperties

        protected void updateIncrementalFetchCartProperties()
        Deprecated.
        Updates incremental fetch properties in Cart object.
        Mostly, the total of units is calculated after processing available units, hence, we need to reflect this in Cart incremental fetch properties only if Incremental fetch is enabled (isIncrementalFetchAvailable() is invoked). Incremental Fetch object is obtained from Prompt's cart infrastructure. This function updates its Block Count, Block Begin and Total count properties.
        Overrides:
        updateIncrementalFetchCartProperties in class PromptCartTransform

      • renderFoldersPath

        public void renderFoldersPath​(MarkupOutput out)
        Deprecated.
        Renders folders formatted path text.
        Parameters:
        out - MarkupOutput where to write the output of the method.

      • renderBackParentButton

        public void renderBackParentButton​(MarkupOutput out)
        Deprecated.
        Renders 'Back' button.
        THis button will enable end-user to navigate the different folders available to the parent one.
        Parameters:
        out - MarkupOutput instance where the output HTML will be stored.

      • renderSubFolderPullDown

        public void renderSubFolderPullDown​(MarkupOutput out)
        Deprecated.
        Renders subfolders pull down menu.
        Parameters:
        out - MarkupOutput where to write the output of the method.

      • canTransform

        public boolean canTransform​(Transformable data)
        Deprecated.
        Indicates whether or not given component can be transformed.
        Extends canTransform() by returning true only if the prompt is of type EnumWebPromptType.WebPromptTypeObjects
        Specified by:
        canTransform in interface Transform
        Overrides:
        canTransform in class PromptCartTransform
        Parameters:
        data - object (PromptObject) to transform
        Returns:
        true if the data is a PromptObject of a Expression WebPrompt, which can be transformed.

      • initializeImages

        public void initializeImages()
        Deprecated.
        Initializes all images to be used in this transform.
        It also invokes parent method so all shared images get initialized as well.
        Overrides:
        initializeImages in class PromptCartTransform

      • writeAncestors

        protected void writeAncestors​(MarkupOutput out,
                              SimpleList ancestors,
                              int currentAncestor)
        Deprecated.
        Recursevily renders folder anscestors names.
        Parameters:
        out - where to write the output of the method.
        ancestors - list of folder ancestors
        currentAncestor - current ancestor being rendered.

      • renderLabel

        public void renderLabel​(MarkupOutput out,
                        java.lang.String labelName)
        Deprecated.
        Renders an HTML label.
        Parameters:
        out - MarkupOutput where to write the output of the method.
        labelName - string of label to be displayed.

      • isThereAnyFolderToRender

        protected java.lang.Boolean isThereAnyFolderToRender()
        Deprecated.
        Determines whether there's a root folder as default point for browsing.
        This is determined only if there are folder objects in available units.
        Returns:
        boolean true if there's a starting point for browsing.
        Since:
        MicroStrategy Web 7.5.1