public interface

EnumIncrementalFetchProperties

com.microstrategy.web.app.gui.EnumIncrementalFetchProperties

Class Overview

EnumCartProperties interface. It lists all available Incremental Fetch properties.

Summary

Constants
String APPEND_GO_TO_DIALOG_DOC_BODY Boolean property that indicates whether we force append the go to dialog to document body.
String BLOCK_BEGIN Property indicating the block begin of elements on the list where incremental fetch is used
String BLOCK_BEGIN_ARGUMENT Property used for Incremental Fetch inside a form, representing the argument name for block begin information
String BLOCK_COUNT Property indicating the block count of elements on the list where incremental fetch is used
String BLOCK_COUNT_ARGUMENT Property used for Incremental Fetch inside a form, representing the argument name for block count information
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.
String ELEMENT_BASED_FETCH Boolean property indicating the fetch event and its argument are based on element indexes.
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.
String END_CSS_DISABLED_IMAGE Css class for the end button when shown as disabled
String END_CSS_IMAGE Argument name for end image button CSS class information
String END_DISABLED_LABEL Label (tooltip) for the end button when shown as disabled
String END_IMAGE This constant is deprecated. Please use END_CSS_IMAGE instead
String END_LABEL Label for last image button
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
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.
String FIRST_CSS_DISABLED_IMAGE Css class for the first button when shown as disabled
String FIRST_CSS_IMAGE Argument name for first image button CSS class information
String FIRST_DISABLED_LABEL Label (tooltip) for the first button when shown as disabled
String FIRST_IMAGE This constant is deprecated. Please use FIRST_CSS_IMAGE instead
String FIRST_LABEL Label for the first image button
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.
String GO_TO_ARGUMENT_ID Property linked to FETCH_EVENT.
String GO_TO_ARGUMENT_ID_INDEX Property linked to FETCH_EVENT.
String LIST_SIZE Property indicating the size of the list of pages that will be rendered in between the navigation arrows.
String MULTIPLE_EVENT
String NAVIGATION_BUTTONS Bitwise property value indicating which navigation arrows shall be shown.
int NAVIGATION_BUTTONS_FIRST_LAST Possible value for the NAVIGATION_BUTTONS property.
int NAVIGATION_BUTTONS_PREVIOUS_NEXT Possible value for the NAVIGATION_BUTTONS property.
int NAVIGATION_BUTTONS_PREVIOUS_NEXT_SET Possible value for the NAVIGATION_BUTTONS property.
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.
String NEXT_CSS_DISABLED_IMAGE Css class for the next button when shown as disabled
String NEXT_CSS_IMAGE Argument name for next image button CSS class information
String NEXT_DISABLED_LABEL Label (tooltip) for the next button when shown as disabled
String NEXT_IMAGE This constant is deprecated. Please use NEXT_CSS_IMAGE instead
String NEXT_LABEL Label for the next image button
String NEXT_SET_CSS_DISABLED_IMAGE Css class for the next set button when shown disabled
String NEXT_SET_CSS_IMAGE Css class for the next set button
String NEXT_SET_DISABLED_LABEL Label (tooltip) for the next set button when shown as disabled
String NEXT_SET_LABEL Label (tooltip) for the next set button
String OUTPUT_MODE Flag indicating whether DHTML is on or off.
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.
String PREVIOUS_CSS_DISABLED_IMAGE Css class for the previous button when shown as disabled
String PREVIOUS_CSS_IMAGE Argument name for previous image button CSS class information
String PREVIOUS_DISABLED_LABEL Label (tooltip) for the previous button when shown as disabled
String PREVIOUS_IMAGE This constant is deprecated. Please use PREVIOUS_CSS_IMAGE instead
String PREVIOUS_LABEL Label for the previous image button
String PREVIOUS_SET_CSS_DISABLED_IMAGE Css class for the previous set button when shown disabled
String PREVIOUS_SET_CSS_IMAGE Css class for the previous set button
String PREVIOUS_SET_DISABLED_LABEL Label (tooltip) for the previous set button when shown as disabled
String PREVIOUS_SET_LABEL Label (tooltip) for the previous set button
String SHOW_DISABLED_ARROWS Boolean property that indicates if disabled buttons should be displayed or not
String TOTAL_COUNT Property indicating the total count of elements on the list where incremental fetch is used
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
String USE_MULTIPLE_EVENT_FORMAT
String ZERO_BASED_LIST Boolean property that indicates the start index of the list of elements where incremental fetch is used.

Constants

public static final 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.

Constant Value: "gotoDialogToBody"

public static final String BLOCK_BEGIN

Property indicating the block begin of elements on the list where incremental fetch is used

Constant Value: "blockBegin"

public static final String BLOCK_BEGIN_ARGUMENT

Property used for Incremental Fetch inside a form, representing the argument name for block begin information

Constant Value: "blockBeginArg"

public static final String BLOCK_COUNT

Property indicating the block count of elements on the list where incremental fetch is used

Constant Value: "blockCount"

public static final String BLOCK_COUNT_ARGUMENT

Property used for Incremental Fetch inside a form, representing the argument name for block count information

Constant Value: "blockCountArg"

public static final 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.

Constant Value: "elemDisplay"

public static final 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

Constant Value: "elementBased"

public static final 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.

Constant Value: "endArgument"

public static final String END_CSS_DISABLED_IMAGE

Css class for the end button when shown as disabled

Constant Value: "endCssDisabledImage"

public static final String END_CSS_IMAGE

Argument name for end image button CSS class information

Constant Value: "endCssImage"

public static final String END_DISABLED_LABEL

Label (tooltip) for the end button when shown as disabled

Constant Value: "endDisabledLabel"

public static final String END_IMAGE

This constant is deprecated.
Please use END_CSS_IMAGE instead

Name for the end image button source information

Constant Value: "endImage"

public static final String END_LABEL

Label for last image button

Constant Value: "endLabel"

public static final 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

Constant Value: "fetchEvent"

public static final 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.

Constant Value: "firstArgument"

public static final String FIRST_CSS_DISABLED_IMAGE

Css class for the first button when shown as disabled

Constant Value: "firstCssDisabledImage"

public static final String FIRST_CSS_IMAGE

Argument name for first image button CSS class information

Constant Value: "firstCssImage"

public static final String FIRST_DISABLED_LABEL

Label (tooltip) for the first button when shown as disabled

Constant Value: "firstDisabledLabel"

public static final String FIRST_IMAGE

This constant is deprecated.
Please use FIRST_CSS_IMAGE instead

Name for first image button source information

Constant Value: "firstImage"

public static final String FIRST_LABEL

Label for the first image button

Constant Value: "firstLabel"

public static final 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.

Constant Value: "goToArgument"

public static final String GO_TO_ARGUMENT_ID

Property linked to FETCH_EVENT. Represents the identifier of the "go to" argument id on the event

Constant Value: "goToArgId"

public static final 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

Constant Value: "goToArgIdIndex"

public static final 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

Constant Value: "listSize"

public static final String MULTIPLE_EVENT

Constant Value: "multipleEvent"

public static final String NAVIGATION_BUTTONS

Bitwise property value indicating which navigation arrows shall be shown. if NAVIGATION_BUTTONS_FIRST_LAST value is included, then there will be buttons that will enable users to navigate to the first and last pages of the result set. NAVIGATION_BUTTONS_PREVIOUS_NEXT will enable +-1 page navigation; NAVIGATION_BUTTONS_PREVIOUS_NEXT_SET will enable multiple page navigation, according to the LIST_SIZE specified.

Constant Value: "navButtons"

public static final int NAVIGATION_BUTTONS_FIRST_LAST

Possible value for the NAVIGATION_BUTTONS property. Indicates First and Last buttons shall be rendered

Constant Value: 1 (0x00000001)

public static final int NAVIGATION_BUTTONS_PREVIOUS_NEXT

Possible value for the NAVIGATION_BUTTONS property. Indicates Previous and Next buttons shall be rendered

Constant Value: 4 (0x00000004)

public 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

Constant Value: 2 (0x00000002)

public static final 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.

Constant Value: "nextArgument"

public static final String NEXT_CSS_DISABLED_IMAGE

Css class for the next button when shown as disabled

Constant Value: "nextCssDisabledImage"

public static final String NEXT_CSS_IMAGE

Argument name for next image button CSS class information

Constant Value: "nextCssImage"

public static final String NEXT_DISABLED_LABEL

Label (tooltip) for the next button when shown as disabled

Constant Value: "nextDisabledLabel"

public static final String NEXT_IMAGE

This constant is deprecated.
Please use NEXT_CSS_IMAGE instead

Name for next image button source information

Constant Value: "nextImage"

public static final String NEXT_LABEL

Label for the next image button

Constant Value: "nextLabel"

public static final String NEXT_SET_CSS_DISABLED_IMAGE

Css class for the next set button when shown disabled

Constant Value: "nextSetCssDisabledImage"

public static final String NEXT_SET_CSS_IMAGE

Css class for the next set button

Constant Value: "nextSetCssImage"

public static final String NEXT_SET_DISABLED_LABEL

Label (tooltip) for the next set button when shown as disabled

Constant Value: "nextSetDisabledLabel"

public static final String NEXT_SET_LABEL

Label (tooltip) for the next set button

Constant Value: "nextSetLabel"

public static final String OUTPUT_MODE

Flag indicating whether DHTML is on or off.

Constant Value: "outputMode"

public static final 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.

Constant Value: "previousArgument"

public static final String PREVIOUS_CSS_DISABLED_IMAGE

Css class for the previous button when shown as disabled

Constant Value: "previousCssDisabledImage"

public static final String PREVIOUS_CSS_IMAGE

Argument name for previous image button CSS class information

Constant Value: "previousCssImage"

public static final String PREVIOUS_DISABLED_LABEL

Label (tooltip) for the previous button when shown as disabled

Constant Value: "previousDisabledLabel"

public static final String PREVIOUS_IMAGE

This constant is deprecated.
Please use PREVIOUS_CSS_IMAGE instead

Name for previous image button source information

Constant Value: "previousImage"

public static final String PREVIOUS_LABEL

Label for the previous image button

Constant Value: "previousLabel"

public static final String PREVIOUS_SET_CSS_DISABLED_IMAGE

Css class for the previous set button when shown disabled

Constant Value: "previousSetCssDisabledImage"

public static final String PREVIOUS_SET_CSS_IMAGE

Css class for the previous set button

Constant Value: "previousSetCssImage"

public static final String PREVIOUS_SET_DISABLED_LABEL

Label (tooltip) for the previous set button when shown as disabled

Constant Value: "previousSetDisabledLabel"

public static final String PREVIOUS_SET_LABEL

Label (tooltip) for the previous set button

Constant Value: "previousSetLabel"

public static final String SHOW_DISABLED_ARROWS

Boolean property that indicates if disabled buttons should be displayed or not

Constant Value: "showDisabled"

public static final String TOTAL_COUNT

Property indicating the total count of elements on the list where incremental fetch is used

Constant Value: "totalCount"

public static final 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

Constant Value: "useForm"

public static final String USE_MULTIPLE_EVENT_FORMAT

Constant Value: "useMultipleEventFormat"

public static final 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

Constant Value: "zeroBasedList"