Package com.microstrategy.web.app.gui

Interface Cart

    • Method Detail

      • renderCart

        void renderCart​(MarkupOutput out,
                java.util.Enumeration availableItems,
                java.util.Enumeration selectedItems)
        Function that abstracts standard Cart output.
        Parameters:
        out - where to write the output of the method.
        availableItems - enumeration of all available items
        selectedItems - enumeration of all selected items

      • renderCart

        void renderCart​(MarkupOutput out,
                CartElements availableItems,
                CartElements selectedItems)
        Function that abstracts standard Cart output.
        Parameters:
        out - where to write the output of the method.
        availableItems - CartElements collection of all available items
        selectedItems - CartElements collection of all selected items
        Since:
        MicroStrategy Web 8.0.0

      • initializeCart

        void initializeCart()
        InitializeCart, for initializing all Cart properties to default values.

      • renderAvailable

        void renderAvailable​(MarkupOutput out,
                     java.util.Enumeration items)
        This function will display available list of units for a given prompt question. It'll abstract what format to be used for rendering available list.
        Parameters:
        out - where to write the output of the method.
        items - list of units to be displayed in available list.

      • renderSelected

        void renderSelected​(MarkupOutput out,
                    java.util.Enumeration items)
        This function will display selected list of units for a given prompt question. It'll abstract what format to be used for rendering selected list.
        Parameters:
        out - where to write the output of the method.
        items - list of units to be displayed.

      • renderAvailable

        void renderAvailable​(MarkupOutput out,
                     CartElements items)
        This function will display available list of units defined in CartElements collection. It'll abstract what format to be used for rendering available list.
        Parameters:
        out - where to write the output of the method.
        items - collection of CartElements to be displayed in available list.
        Since:
        MicroStrategy Web 8.0.0

      • renderSelected

        void renderSelected​(MarkupOutput out,
                    CartElements items)
        This function will display selected list of units defined in CartElements collection. It'll abstract what format to be used for rendering selected list.
        Parameters:
        out - where to write the output of the method.
        items - collection of CartElements to be displayed.
        Since:
        MicroStrategy Web 8.0.0

      • renderLabel

        void renderLabel​(MarkupOutput out,
                 java.lang.String labelName)
        Function for displaying HTML labels.
        Parameters:
        out - where to write the output of the method.
        labelName - string of label to be displayed.
        Since:
        MicroStrategy Web 8.0.0

      • renderLabel

        void renderLabel​(MarkupOutput out,
                 java.lang.String labelName,
                 java.lang.String forValue)
        Function for displaying HTML labels.
        Parameters:
        out - where to write the output of the method.
        labelName - string of label to be displayed.
        forValue - string value for the FOR attribute of the LABEL HTML tag.
        Since:
        MicroStrategy Web 8.0.0

      • renderActionImage

        void renderActionImage​(MarkupOutput out,
                       java.lang.String[] jsFunction,
                       java.lang.String name,
                       java.lang.String imageClass,
                       java.lang.String title)
        Dsiplays an image that the user will be enabled to click on and submit a request.
        Parameters:
        out - where to write the output of the method
        jsFunction - array of String with the JavaScript information to trigger when the user clicks on the image. If none is provided or the current output mode of the cart is does not support DHTML then the information will not be used.
        imageClass - full css class the image to create will have
        title - tooltip to associate with the image to render
        name - identifier for the image tag to create.
        Since:
        MicroStrategy Web 8.0.0

      • renderAdd

        void renderAdd​(MarkupOutput out)
        Displays add HTML image arrow button.
        Parameters:
        out - where to write the output of the method.

      • renderAddAll

        void renderAddAll​(MarkupOutput out)
        Displays add all HTML image arrow button.
        Parameters:
        out - where to write the output of the method.
        Since:
        MicroStrategy Web 8.1.1

      • renderRemoveAll

        void renderRemoveAll​(MarkupOutput out)
        Displays remove all HTML image arrow button.
        Parameters:
        out - where to write the output of the method.
        Since:
        MicroStrategy Web 8.1.1

      • renderRemove

        void renderRemove​(MarkupOutput out)
        Displays remove HTML image arrow button.
        Parameters:
        out - where to write the output of the method.

      • renderUp

        void renderUp​(MarkupOutput out)
        Displays move up HTML image arrow button.
        Parameters:
        out - where to write the output of the method.
        Since:
        MicroStrategy Web 8.0.0

      • renderDown

        void renderDown​(MarkupOutput out)
        Displays move down HTML image arrow button.
        Parameters:
        out - where to write the output of the method.
        Since:
        MicroStrategy Web 8.0.0

      • setProperty

        void setProperty​(java.lang.String key,
                 java.lang.Object obj)
        Function for initializing individual Cart properties EnumCartProperties to given values. This function is exposed for allowing Cart customization.
        Parameters:
        key - index or key property to be set, which value comes from the EnumCartProperties enumeration.
        obj - Object instance with the value to associate with key index.

      • getProperty

        java.lang.Object getProperty​(java.lang.String key)
        Function for getting Cart properties EnumCartProperties current values.
        Parameters:
        key - index or key property to be retrieved, which value comes from the EnumCartProperties enumeration.
        Returns:
        Object instance that was associated with that key.

      • renderSearch

        void renderSearch​(MarkupOutput out)
        Function that renders search HTML output. Most likely an HTML textfield along with an image button for submitting search pattern.
        Parameters:
        out - where to write the output of the method.

      • renderSearchField

        void renderSearchField​(MarkupOutput out)
        Function called by renderSearch function. It abstracts search textfield to be rendered. Search patttern is entered in this HTML component.
        Parameters:
        out - where to write the output of the method.

      • renderSearchButton

        void renderSearchButton​(MarkupOutput out)
        Function called by renderSeach function. It abstracts image button used for submitting search pattern.
        Parameters:
        out - where to write the output of the method.

      • renderIncrementalFetch

        void renderIncrementalFetch​(MarkupOutput out)
        Function that renders incremental fetch abstraction. Most likely, it'll be rendered below available list and will be used for page this list based on blocks.
        Parameters:
        out - where to write the output of the method.

      • renderMatchCase

        void renderMatchCase​(MarkupOutput out)
        Function that outputs AND / OR match output HTML radio button. This is a global operator that groups all qualifications made by the user.
        Parameters:
        out - where to write the output of the method.

      • setHideWaitPageFlag

        void setHideWaitPageFlag​(boolean flag)
        Function for making sure javascript code for hiding wait page is appended to add/remove image buttons
        Parameters:
        flag - true if extra code is appended.

      • setEnabled

        void setEnabled​(boolean flag)
        Function for enabling or disabling the interaction scripts on the cart rendering.
        Parameters:
        flag - true
        Since:
        MicroStrategy Web 9.0.1