Package com.microstrategy.web.app.gui

Interface IncrementalFetch

  • All Superinterfaces:
    GuiElement
    All Known Implementing Classes:
    IncrementalFetchImpl
    public interface IncrementalFetch
extends GuiElement
    IncrementalFetch interface that defines minimum contract all IncrementalFetch must implement.
    Since:
    MicroStrategy Web 7.3.1 or earlier

    • Method Detail

      • getProperty

        java.lang.Object getProperty​(java.lang.String key)
        getProperty, for getting the key associated property value.
        Parameters:
        key - property name
        Returns:
        Object property value

      • renderIncrementalFetch

        void renderIncrementalFetch​(MarkupOutput out)
        renderIncrementalFetch, function that encapsulates incremental fetch functionality.
        Parameters:
        out - where to write the output of the method.

      • setProperty

        void setProperty​(java.lang.String key,
                 java.lang.Object obj)
        setProperty, for setting the output mode.
        Parameters:
        key - string value defining the index of property.
        obj - object value.

      • initializeIncrementalFetch

        void initializeIncrementalFetch()
        initializeIncrementalFetch, for initializing all Incremental Fetch properties to default values.

      • renderTextContent

        void renderTextContent​(MarkupOutput out)
        Renders the content of the incremental fetch that is to be rendered in between the arrows for element navigation. For example: 1 2 3 4 5 of 12 pages or 1 of 12 pages
        Parameters:
        out - MarkupOutput instance where the HTML contents generated will be saved.
        Since:
        MicroStrategy Web 9.0.0

      • renderFirstPageArrow

        void renderFirstPageArrow​(MarkupOutput out)
        Renders the arrow that will allow navigation to the first page of the result set being examined. Typically, the image it will show will be similar to |<
        Parameters:
        out - MarkupOutput instance where the HTML contents generated will be saved.
        Since:
        MicroStrategy Web 9.0.0

      • renderPreviousPageArrow

        void renderPreviousPageArrow​(MarkupOutput out)
        Renders the arrow that will allow navigation to the previous page of the results being examined. Typically, the image it will show will be similar to <
        Parameters:
        out - MarkupOutput instance where the HTML contents generated will be saved.
        Since:
        MicroStrategy Web 9.0.0

      • renderPreviousPageSetArrow

        void renderPreviousPageSetArrow​(MarkupOutput out)
        Renders the arrow that will allow navigation to the previous page set of the results being examined. Typically, the image it will show will be similar to <<
        Parameters:
        out - MarkupOutput instance where the HTML contents generated will be saved.
        Since:
        MicroStrategy Web 9.0.0

      • renderNextPageArrow

        void renderNextPageArrow​(MarkupOutput out)
        Renders the arrow that will allow navigation to the next page of the results being examined. Typically, the image it will show will be similar to >
        Parameters:
        out - MarkupOutput instance where the HTML contents generated will be saved.
        Since:
        MicroStrategy Web 9.0.0

      • renderNextPageSetArrow

        void renderNextPageSetArrow​(MarkupOutput out)
        Renders the arrow that will allow navigation to the next page set of the results being examined. Typically, the image it will show will be similar to >>
        Parameters:
        out - MarkupOutput instance where the HTML contents generated will be saved.
        Since:
        MicroStrategy Web 9.0.0

      • renderLastPageArrow

        void renderLastPageArrow​(MarkupOutput out)
        Renders the arrow that will allow navigation to the last page of the result set being examined. Typically, the image it will show will be similar to >|
        Parameters:
        out - MarkupOutput instance where the HTML contents generated will be saved.
        Since:
        MicroStrategy Web 9.0.0

      • renderPreContent

        void renderPreContent​(MarkupOutput out)
        Renders any other content that should be displayed before what renderTextContent(MarkupOutput) generates
        Parameters:
        out - MarkupOutput instance where the HTML contents generated will be saved.
        Since:
        MicroStrategy Web 9.0.0

      • renderPostContent

        void renderPostContent​(MarkupOutput out)
        Renders any other content that should be displayed after what renderTextContent(MarkupOutput) generates
        Parameters:
        out - MarkupOutput instance where the HTML contents generated will be saved.
        Since:
        MicroStrategy Web 9.0.0

      • getIncrementalFetchDetails

        IncrementalFetch.IncrementalFetchDetails getIncrementalFetchDetails()
        Utility method to get access to incremental fetch information, such as current element index viewed, how many are left, total number of elements, etc.
        Returns:
        IncrementalFetch.IncrementalFetchDetails instance from where information about the incremental fetch can be obtained
        Since:
        MicroStrategy Web 9.0.0

      • setTargetBoneName

        void setTargetBoneName​(java.lang.String name)
        Set the name of the bone who will be tracking the filter on selection check boxes trough the pages
        Parameters:
        name -
        Since:
        MicroStrategy Web 9.0.0