Package com.microstrategy.web.app.gui

Interface EnumIncrementalFetchProperties

  • public interface EnumIncrementalFetchProperties
    EnumCartProperties interface. It lists all available Incremental Fetch properties.
    Since:
    MicroStrategy Web 7.3.1 or earlier

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.lang.String APPEND_GO_TO_DIALOG_DOC_BODY
      Boolean property that indicates whether we force append the go to dialog to document body.
      static java.lang.String BLOCK_BEGIN
      Property indicating the block begin of elements on the list where incremental fetch is used
      static java.lang.String BLOCK_BEGIN_ARGUMENT
      Property used for Incremental Fetch inside a form, representing the argument name for block begin information
      static java.lang.String BLOCK_COUNT
      Property indicating the block count of elements on the list where incremental fetch is used
      static java.lang.String BLOCK_COUNT_ARGUMENT
      Property used for Incremental Fetch inside a form, representing the argument name for block count information
      static java.lang.String ELEMENT_BASED_DISPLAY
      Boolean property that indicates if the display of page information will be done based on elements - for example, "1-30 of 235" - or based on total pages on result set - for example, 2 of 5 pages.
      static java.lang.String ELEMENT_BASED_FETCH
      Boolean property indicating the fetch event and its argument are based on element indexes.
      static java.lang.String END_ARGUMENT
      Property used for Incremental Fetch inside a form, representing the argument name for the end arrow to be used in case the navigation arrows are displayed inside a form, as image inputs.
      static java.lang.String END_CSS_DISABLED_IMAGE
      Css class for the end button when shown as disabled
      static java.lang.String END_CSS_IMAGE
      Argument name for end image button CSS class information
      static java.lang.String END_DISABLED_LABEL
      Label (tooltip) for the end button when shown as disabled
      static java.lang.String END_IMAGE
      Deprecated.
      Please use END_CSS_IMAGE instead
      static java.lang.String END_LABEL
      Label for last image button
      static java.lang.String FETCH_EVENT
      Property for specifying the base event for element navigation, such as the page links on the display or the button navigation if using links
      static java.lang.String FIRST_ARGUMENT
      Property used for Incremental Fetch inside a form, representing the argument name for the first arrow to be used in case the navigation arrows are displayed inside a form, as image inputs.
      static java.lang.String FIRST_CSS_DISABLED_IMAGE
      Css class for the first button when shown as disabled
      static java.lang.String FIRST_CSS_IMAGE
      Argument name for first image button CSS class information
      static java.lang.String FIRST_DISABLED_LABEL
      Label (tooltip) for the first button when shown as disabled
      static java.lang.String FIRST_IMAGE
      Deprecated.
      Please use FIRST_CSS_IMAGE instead
      static java.lang.String FIRST_LABEL
      Label for the first image button
      static java.lang.String GO_TO_ARGUMENT
      Property used for Incremental Fetch inside a form, representing the argument name for Go To, to be used in case of next set or previous set navigation arrows, as well as in case of individual page list if using a form.
      static java.lang.String GO_TO_ARGUMENT_ID
      Property linked to FETCH_EVENT.
      static java.lang.String GO_TO_ARGUMENT_ID_INDEX
      Property linked to FETCH_EVENT.
      static java.lang.String LIST_SIZE
      Property indicating the size of the list of pages that will be rendered in between the navigation arrows.
      static java.lang.String MULTIPLE_EVENT  
      static java.lang.String NAVIGATION_BUTTONS
      Bitwise property value indicating which navigation arrows shall be shown.
      static int NAVIGATION_BUTTONS_FIRST_LAST
      Possible value for the NAVIGATION_BUTTONS property.
      static int NAVIGATION_BUTTONS_PREVIOUS_NEXT
      Possible value for the NAVIGATION_BUTTONS property.
      static int NAVIGATION_BUTTONS_PREVIOUS_NEXT_SET
      Possible value for the NAVIGATION_BUTTONS property.
      static java.lang.String NEXT_ARGUMENT
      Property used for Incremental Fetch inside a form, representing the argument name for the next arrow to be used in case the navigation arrows are displayed inside a form, as image inputs.
      static java.lang.String NEXT_CSS_DISABLED_IMAGE
      Css class for the next button when shown as disabled
      static java.lang.String NEXT_CSS_IMAGE
      Argument name for next image button CSS class information
      static java.lang.String NEXT_DISABLED_LABEL
      Label (tooltip) for the next button when shown as disabled
      static java.lang.String NEXT_IMAGE
      Deprecated.
      Please use NEXT_CSS_IMAGE instead
      static java.lang.String NEXT_LABEL
      Label for the next image button
      static java.lang.String NEXT_SET_CSS_DISABLED_IMAGE
      Css class for the next set button when shown disabled
      static java.lang.String NEXT_SET_CSS_IMAGE
      Css class for the next set button
      static java.lang.String NEXT_SET_DISABLED_LABEL
      Label (tooltip) for the next set button when shown as disabled
      static java.lang.String NEXT_SET_LABEL
      Label (tooltip) for the next set button
      static java.lang.String OUTPUT_MODE
      Flag indicating whether DHTML is on or off.
      static java.lang.String PREVIOUS_ARGUMENT
      Property used for Incremental Fetch inside a form, representing the argument name for the previous arrow to be used in case the navigation arrows are displayed inside a form, as image inputs.
      static java.lang.String PREVIOUS_CSS_DISABLED_IMAGE
      Css class for the previous button when shown as disabled
      static java.lang.String PREVIOUS_CSS_IMAGE
      Argument name for previous image button CSS class information
      static java.lang.String PREVIOUS_DISABLED_LABEL
      Label (tooltip) for the previous button when shown as disabled
      static java.lang.String PREVIOUS_IMAGE
      Deprecated.
      Please use PREVIOUS_CSS_IMAGE instead
      static java.lang.String PREVIOUS_LABEL
      Label for the previous image button
      static java.lang.String PREVIOUS_SET_CSS_DISABLED_IMAGE
      Css class for the previous set button when shown disabled
      static java.lang.String PREVIOUS_SET_CSS_IMAGE
      Css class for the previous set button
      static java.lang.String PREVIOUS_SET_DISABLED_LABEL
      Label (tooltip) for the previous set button when shown as disabled
      static java.lang.String PREVIOUS_SET_LABEL
      Label (tooltip) for the previous set button
      static java.lang.String SHOW_DISABLED_ARROWS
      Boolean property that indicates if disabled buttons should be displayed or not
      static java.lang.String TOTAL_COUNT
      Property indicating the total count of elements on the list where incremental fetch is used
      static java.lang.String USE_INSIDE_FORM
      Property indicating if the incremental fetch is inside a Form HTML tag - the buttons will then be generated as image inputs as specified by the FIRST_ARGUMENT and similar properties
      static java.lang.String USE_MULTIPLE_EVENT_FORMAT  
      static java.lang.String ZERO_BASED_LIST
      Boolean property that indicates the start index of the list of elements where incremental fetch is used.

    • Field Detail

      • OUTPUT_MODE

        static final java.lang.String OUTPUT_MODE
        Flag indicating whether DHTML is on or off.
        See Also:
        Constant Field Values

      • BLOCK_BEGIN_ARGUMENT

        static final java.lang.String BLOCK_BEGIN_ARGUMENT
        Property used for Incremental Fetch inside a form, representing the argument name for block begin information
        See Also:
        Constant Field Values

      • BLOCK_COUNT_ARGUMENT

        static final java.lang.String BLOCK_COUNT_ARGUMENT
        Property used for Incremental Fetch inside a form, representing the argument name for block count information
        See Also:
        Constant Field Values

      • PREVIOUS_CSS_IMAGE

        static final java.lang.String PREVIOUS_CSS_IMAGE
        Argument name for previous image button CSS class information
        Since:
        MicroStrategy Web 8.0.0
        See Also:
        Constant Field Values

      • NEXT_CSS_IMAGE

        static final java.lang.String NEXT_CSS_IMAGE
        Argument name for next image button CSS class information
        Since:
        MicroStrategy Web 8.0.0
        See Also:
        Constant Field Values

      • FIRST_CSS_IMAGE

        static final java.lang.String FIRST_CSS_IMAGE
        Argument name for first image button CSS class information
        Since:
        MicroStrategy Web 8.0.0
        See Also:
        Constant Field Values

      • END_CSS_IMAGE

        static final java.lang.String END_CSS_IMAGE
        Argument name for end image button CSS class information
        Since:
        MicroStrategy Web 8.0.0
        See Also:
        Constant Field Values

      • PREVIOUS_LABEL

        static final java.lang.String PREVIOUS_LABEL
        Label for the previous image button
        See Also:
        Constant Field Values

      • NEXT_LABEL

        static final java.lang.String NEXT_LABEL
        Label for the next image button
        See Also:
        Constant Field Values

      • FIRST_LABEL

        static final java.lang.String FIRST_LABEL
        Label for the first image button
        See Also:
        Constant Field Values

      • END_LABEL

        static final java.lang.String END_LABEL
        Label for last image button
        See Also:
        Constant Field Values

      • BLOCK_BEGIN

        static final java.lang.String BLOCK_BEGIN
        Property indicating the block begin of elements on the list where incremental fetch is used
        See Also:
        Constant Field Values

      • BLOCK_COUNT

        static final java.lang.String BLOCK_COUNT
        Property indicating the block count of elements on the list where incremental fetch is used
        See Also:
        Constant Field Values

      • TOTAL_COUNT

        static final java.lang.String TOTAL_COUNT
        Property indicating the total count of elements on the list where incremental fetch is used
        See Also:
        Constant Field Values

      • PREVIOUS_ARGUMENT

        static final java.lang.String PREVIOUS_ARGUMENT
        Property used for Incremental Fetch inside a form, representing the argument name for the previous arrow to be used in case the navigation arrows are displayed inside a form, as image inputs.
        Since:
        MicroStrategy Web 8.0.0
        See Also:
        Constant Field Values

      • NEXT_ARGUMENT

        static final java.lang.String NEXT_ARGUMENT
        Property used for Incremental Fetch inside a form, representing the argument name for the next arrow to be used in case the navigation arrows are displayed inside a form, as image inputs.
        Since:
        MicroStrategy Web 8.0.0
        See Also:
        Constant Field Values

      • GO_TO_ARGUMENT

        static final java.lang.String GO_TO_ARGUMENT
        Property used for Incremental Fetch inside a form, representing the argument name for Go To, to be used in case of next set or previous set navigation arrows, as well as in case of individual page list if using a form.
        Since:
        MicroStrategy Web 9.0.0
        See Also:
        Constant Field Values

      • FIRST_ARGUMENT

        static final java.lang.String FIRST_ARGUMENT
        Property used for Incremental Fetch inside a form, representing the argument name for the first arrow to be used in case the navigation arrows are displayed inside a form, as image inputs.
        Since:
        MicroStrategy Web 8.0.0
        See Also:
        Constant Field Values

      • END_ARGUMENT

        static final java.lang.String END_ARGUMENT
        Property used for Incremental Fetch inside a form, representing the argument name for the end arrow to be used in case the navigation arrows are displayed inside a form, as image inputs.
        Since:
        MicroStrategy Web 8.0.0
        See Also:
        Constant Field Values

      • FETCH_EVENT

        static final java.lang.String FETCH_EVENT
        Property for specifying the base event for element navigation, such as the page links on the display or the button navigation if using links
        Since:
        MicroStrategy Web 9.0.0
        See Also:
        Constant Field Values

      • GO_TO_ARGUMENT_ID

        static final java.lang.String GO_TO_ARGUMENT_ID
        Property linked to FETCH_EVENT. Represents the identifier of the "go to" argument id on the event
        Since:
        MicroStrategy Web 9.0.0
        See Also:
        Constant Field Values

      • GO_TO_ARGUMENT_ID_INDEX

        static final java.lang.String GO_TO_ARGUMENT_ID_INDEX
        Property linked to FETCH_EVENT. Represents the index for the GO_TO_ARGUMENT_ID argument id on the event
        Since:
        MicroStrategy Web 9.0.0
        See Also:
        Constant Field Values

      • ELEMENT_BASED_FETCH

        static final java.lang.String ELEMENT_BASED_FETCH
        Boolean property indicating the fetch event and its argument are based on element indexes. If set to False, then it indicates the argument values represent page indexes to access
        Since:
        MicroStrategy Web 9.0.0
        See Also:
        Constant Field Values

      • USE_INSIDE_FORM

        static final java.lang.String USE_INSIDE_FORM
        Property indicating if the incremental fetch is inside a Form HTML tag - the buttons will then be generated as image inputs as specified by the FIRST_ARGUMENT and similar properties
        Since:
        MicroStrategy Web 9.0.0
        See Also:
        Constant Field Values

      • LIST_SIZE

        static final java.lang.String LIST_SIZE
        Property indicating the size of the list of pages that will be rendered in between the navigation arrows. If a size of 1 is specified, then the display will be with the "X of Y Pages" format; otherwise it will be as "A B C D E of Y Pages" where the different pages will be quick links, as specified by the FETCH_EVENT and GO_TO_ARGUMENT_ID properties
        Since:
        MicroStrategy Web 9.0.0
        See Also:
        Constant Field Values

      • NAVIGATION_BUTTONS_FIRST_LAST

        static final int NAVIGATION_BUTTONS_FIRST_LAST
        Possible value for the NAVIGATION_BUTTONS property. Indicates First and Last buttons shall be rendered
        Since:
        MicroStrategy Web 9.0.0
        See Also:
        Constant Field Values

      • NAVIGATION_BUTTONS_PREVIOUS_NEXT_SET

        static final int NAVIGATION_BUTTONS_PREVIOUS_NEXT_SET
        Possible value for the NAVIGATION_BUTTONS property. Indicates Previous Set and Next Set buttons shall be rendered
        Since:
        MicroStrategy Web 9.0.0
        See Also:
        Constant Field Values

      • NAVIGATION_BUTTONS_PREVIOUS_NEXT

        static final int NAVIGATION_BUTTONS_PREVIOUS_NEXT
        Possible value for the NAVIGATION_BUTTONS property. Indicates Previous and Next buttons shall be rendered
        Since:
        MicroStrategy Web 9.0.0
        See Also:
        Constant Field Values

      • ELEMENT_BASED_DISPLAY

        static final java.lang.String ELEMENT_BASED_DISPLAY
        Boolean property that indicates if the display of page information will be done based on elements - for example, "1-30 of 235" - or based on total pages on result set - for example, 2 of 5 pages. Setting this property to true invalidates the NAVIGATION_BUTTONS setting if indicating Previous Set and Next Set buttons should be displayed, as well as LIST_SIZE since this one is for displaying a set of page links.
        Since:
        MicroStrategy Web 9.0.0
        See Also:
        Constant Field Values

      • PREVIOUS_SET_CSS_IMAGE

        static final java.lang.String PREVIOUS_SET_CSS_IMAGE
        Css class for the previous set button
        Since:
        MicroStrategy Web 9.0.0
        See Also:
        Constant Field Values

      • NEXT_SET_CSS_IMAGE

        static final java.lang.String NEXT_SET_CSS_IMAGE
        Css class for the next set button
        Since:
        MicroStrategy Web 9.0.0
        See Also:
        Constant Field Values

      • PREVIOUS_SET_LABEL

        static final java.lang.String PREVIOUS_SET_LABEL
        Label (tooltip) for the previous set button
        Since:
        MicroStrategy Web 9.0.0
        See Also:
        Constant Field Values

      • NEXT_SET_LABEL

        static final java.lang.String NEXT_SET_LABEL
        Label (tooltip) for the next set button
        Since:
        MicroStrategy Web 9.0.0
        See Also:
        Constant Field Values

      • PREVIOUS_SET_CSS_DISABLED_IMAGE

        static final java.lang.String PREVIOUS_SET_CSS_DISABLED_IMAGE
        Css class for the previous set button when shown disabled
        Since:
        MicroStrategy Web 9.0.0
        See Also:
        Constant Field Values

      • NEXT_SET_CSS_DISABLED_IMAGE

        static final java.lang.String NEXT_SET_CSS_DISABLED_IMAGE
        Css class for the next set button when shown disabled
        Since:
        MicroStrategy Web 9.0.0
        See Also:
        Constant Field Values

      • PREVIOUS_SET_DISABLED_LABEL

        static final java.lang.String PREVIOUS_SET_DISABLED_LABEL
        Label (tooltip) for the previous set button when shown as disabled
        Since:
        MicroStrategy Web 9.0.0
        See Also:
        Constant Field Values

      • NEXT_SET_DISABLED_LABEL

        static final java.lang.String NEXT_SET_DISABLED_LABEL
        Label (tooltip) for the next set button when shown as disabled
        Since:
        MicroStrategy Web 9.0.0
        See Also:
        Constant Field Values

      • PREVIOUS_CSS_DISABLED_IMAGE

        static final java.lang.String PREVIOUS_CSS_DISABLED_IMAGE
        Css class for the previous button when shown as disabled
        Since:
        MicroStrategy Web 9.0.0
        See Also:
        Constant Field Values

      • NEXT_CSS_DISABLED_IMAGE

        static final java.lang.String NEXT_CSS_DISABLED_IMAGE
        Css class for the next button when shown as disabled
        Since:
        MicroStrategy Web 9.0.0
        See Also:
        Constant Field Values

      • FIRST_CSS_DISABLED_IMAGE

        static final java.lang.String FIRST_CSS_DISABLED_IMAGE
        Css class for the first button when shown as disabled
        Since:
        MicroStrategy Web 9.0.0
        See Also:
        Constant Field Values

      • END_CSS_DISABLED_IMAGE

        static final java.lang.String END_CSS_DISABLED_IMAGE
        Css class for the end button when shown as disabled
        Since:
        MicroStrategy Web 9.0.0
        See Also:
        Constant Field Values

      • PREVIOUS_DISABLED_LABEL

        static final java.lang.String PREVIOUS_DISABLED_LABEL
        Label (tooltip) for the previous button when shown as disabled
        Since:
        MicroStrategy Web 9.0.0
        See Also:
        Constant Field Values

      • NEXT_DISABLED_LABEL

        static final java.lang.String NEXT_DISABLED_LABEL
        Label (tooltip) for the next button when shown as disabled
        Since:
        MicroStrategy Web 9.0.0
        See Also:
        Constant Field Values

      • FIRST_DISABLED_LABEL

        static final java.lang.String FIRST_DISABLED_LABEL
        Label (tooltip) for the first button when shown as disabled
        Since:
        MicroStrategy Web 9.0.0
        See Also:
        Constant Field Values

      • END_DISABLED_LABEL

        static final java.lang.String END_DISABLED_LABEL
        Label (tooltip) for the end button when shown as disabled
        Since:
        MicroStrategy Web 9.0.0
        See Also:
        Constant Field Values

      • SHOW_DISABLED_ARROWS

        static final java.lang.String SHOW_DISABLED_ARROWS
        Boolean property that indicates if disabled buttons should be displayed or not
        Since:
        MicroStrategy Web 9.0.0
        See Also:
        Constant Field Values

      • ZERO_BASED_LIST

        static final java.lang.String ZERO_BASED_LIST
        Boolean property that indicates the start index of the list of elements where incremental fetch is used. Typically it will be 1, but sometimes it could be zero
        Since:
        MicroStrategy Web 9.0.0
        See Also:
        Constant Field Values

      • APPEND_GO_TO_DIALOG_DOC_BODY

        static final java.lang.String APPEND_GO_TO_DIALOG_DOC_BODY
        Boolean property that indicates whether we force append the go to dialog to document body. true, always append to document body.
        See Also:
        Constant Field Values

      • NEXT_IMAGE

        static final java.lang.String NEXT_IMAGE
        Deprecated.
        Please use NEXT_CSS_IMAGE instead
        Name for next image button source information
        See Also:
        Constant Field Values

      • FIRST_IMAGE

        static final java.lang.String FIRST_IMAGE
        Deprecated.
        Please use FIRST_CSS_IMAGE instead
        Name for first image button source information
        See Also:
        Constant Field Values

      • END_IMAGE

        static final java.lang.String END_IMAGE
        Deprecated.
        Please use END_CSS_IMAGE instead
        Name for the end image button source information
        See Also:
        Constant Field Values

      • USE_MULTIPLE_EVENT_FORMAT

        static final java.lang.String USE_MULTIPLE_EVENT_FORMAT
        Since:
        MicroStrategy Web 9.0.0
        See Also:
        Constant Field Values

      • MULTIPLE_EVENT

        static final java.lang.String MULTIPLE_EVENT
        Since:
        MicroStrategy Web 9.0.0
        See Also:
        Constant Field Values