Package com.microstrategy.web.app.gui
Interface EnumIncrementalFetchProperties
- 
public interface EnumIncrementalFetchPropertiesEnumCartProperties 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.StringAPPEND_GO_TO_DIALOG_DOC_BODYBoolean property that indicates whether we force append the go to dialog to document body.static java.lang.StringBLOCK_BEGINProperty indicating the block begin of elements on the list where incremental fetch is usedstatic java.lang.StringBLOCK_BEGIN_ARGUMENTProperty used for Incremental Fetch inside a form, representing the argument name for block begin informationstatic java.lang.StringBLOCK_COUNTProperty indicating the block count of elements on the list where incremental fetch is usedstatic java.lang.StringBLOCK_COUNT_ARGUMENTProperty used for Incremental Fetch inside a form, representing the argument name for block count informationstatic java.lang.StringELEMENT_BASED_DISPLAYBoolean 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.StringELEMENT_BASED_FETCHBoolean property indicating the fetch event and its argument are based on element indexes.static java.lang.StringEND_ARGUMENTProperty 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.StringEND_CSS_DISABLED_IMAGECss class for the end button when shown as disabledstatic java.lang.StringEND_CSS_IMAGEArgument name for end image button CSS class informationstatic java.lang.StringEND_DISABLED_LABELLabel (tooltip) for the end button when shown as disabledstatic java.lang.StringEND_IMAGEDeprecated.Please useEND_CSS_IMAGEinsteadstatic java.lang.StringEND_LABELLabel for last image buttonstatic java.lang.StringFETCH_EVENTProperty for specifying the base event for element navigation, such as the page links on the display or the button navigation if using linksstatic java.lang.StringFIRST_ARGUMENTProperty 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.StringFIRST_CSS_DISABLED_IMAGECss class for the first button when shown as disabledstatic java.lang.StringFIRST_CSS_IMAGEArgument name for first image button CSS class informationstatic java.lang.StringFIRST_DISABLED_LABELLabel (tooltip) for the first button when shown as disabledstatic java.lang.StringFIRST_IMAGEDeprecated.Please useFIRST_CSS_IMAGEinsteadstatic java.lang.StringFIRST_LABELLabel for the first image buttonstatic java.lang.StringGO_TO_ARGUMENTProperty 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.StringGO_TO_ARGUMENT_IDProperty linked toFETCH_EVENT.static java.lang.StringGO_TO_ARGUMENT_ID_INDEXProperty linked toFETCH_EVENT.static java.lang.StringLIST_SIZEProperty indicating the size of the list of pages that will be rendered in between the navigation arrows.static java.lang.StringMULTIPLE_EVENTstatic java.lang.StringNAVIGATION_BUTTONSBitwise property value indicating which navigation arrows shall be shown.static intNAVIGATION_BUTTONS_FIRST_LASTPossible value for theNAVIGATION_BUTTONSproperty.static intNAVIGATION_BUTTONS_PREVIOUS_NEXTPossible value for theNAVIGATION_BUTTONSproperty.static intNAVIGATION_BUTTONS_PREVIOUS_NEXT_SETPossible value for theNAVIGATION_BUTTONSproperty.static java.lang.StringNEXT_ARGUMENTProperty 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.StringNEXT_CSS_DISABLED_IMAGECss class for the next button when shown as disabledstatic java.lang.StringNEXT_CSS_IMAGEArgument name for next image button CSS class informationstatic java.lang.StringNEXT_DISABLED_LABELLabel (tooltip) for the next button when shown as disabledstatic java.lang.StringNEXT_IMAGEDeprecated.Please useNEXT_CSS_IMAGEinsteadstatic java.lang.StringNEXT_LABELLabel for the next image buttonstatic java.lang.StringNEXT_SET_CSS_DISABLED_IMAGECss class for the next set button when shown disabledstatic java.lang.StringNEXT_SET_CSS_IMAGECss class for the next set buttonstatic java.lang.StringNEXT_SET_DISABLED_LABELLabel (tooltip) for the next set button when shown as disabledstatic java.lang.StringNEXT_SET_LABELLabel (tooltip) for the next set buttonstatic java.lang.StringOUTPUT_MODEFlag indicating whether DHTML is on or off.static java.lang.StringPREVIOUS_ARGUMENTProperty 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.StringPREVIOUS_CSS_DISABLED_IMAGECss class for the previous button when shown as disabledstatic java.lang.StringPREVIOUS_CSS_IMAGEArgument name for previous image button CSS class informationstatic java.lang.StringPREVIOUS_DISABLED_LABELLabel (tooltip) for the previous button when shown as disabledstatic java.lang.StringPREVIOUS_IMAGEDeprecated.Please usePREVIOUS_CSS_IMAGEinsteadstatic java.lang.StringPREVIOUS_LABELLabel for the previous image buttonstatic java.lang.StringPREVIOUS_SET_CSS_DISABLED_IMAGECss class for the previous set button when shown disabledstatic java.lang.StringPREVIOUS_SET_CSS_IMAGECss class for the previous set buttonstatic java.lang.StringPREVIOUS_SET_DISABLED_LABELLabel (tooltip) for the previous set button when shown as disabledstatic java.lang.StringPREVIOUS_SET_LABELLabel (tooltip) for the previous set buttonstatic java.lang.StringSHOW_DISABLED_ARROWSBoolean property that indicates if disabled buttons should be displayed or notstatic java.lang.StringTOTAL_COUNTProperty indicating the total count of elements on the list where incremental fetch is usedstatic java.lang.StringUSE_INSIDE_FORMProperty indicating if the incremental fetch is inside a Form HTML tag - the buttons will then be generated as image inputs as specified by theFIRST_ARGUMENTand similar propertiesstatic java.lang.StringUSE_MULTIPLE_EVENT_FORMATstatic java.lang.StringZERO_BASED_LISTBoolean 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 toFETCH_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 toFETCH_EVENT. Represents the index for theGO_TO_ARGUMENT_IDargument 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 theFIRST_ARGUMENTand 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 theFETCH_EVENTandGO_TO_ARGUMENT_IDproperties- Since:
 - MicroStrategy Web 9.0.0
 - See Also:
 - Constant Field Values
 
 
- 
NAVIGATION_BUTTONS
static final java.lang.String NAVIGATION_BUTTONS
Bitwise property value indicating which navigation arrows shall be shown. ifNAVIGATION_BUTTONS_FIRST_LASTvalue 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_NEXTwill enable +-1 page navigation;NAVIGATION_BUTTONS_PREVIOUS_NEXT_SETwill enable multiple page navigation, according to theLIST_SIZEspecified.- 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 theNAVIGATION_BUTTONSproperty. 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 theNAVIGATION_BUTTONSproperty. 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 theNAVIGATION_BUTTONSproperty. 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 theNAVIGATION_BUTTONSsetting if indicating Previous Set and Next Set buttons should be displayed, as well asLIST_SIZEsince 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
 
 
- 
PREVIOUS_IMAGE
@Deprecated static final java.lang.String PREVIOUS_IMAGE
Deprecated.Please usePREVIOUS_CSS_IMAGEinsteadName for previous image button source information- See Also:
 - Constant Field Values
 
 
- 
NEXT_IMAGE
@Deprecated static final java.lang.String NEXT_IMAGE
Deprecated.Please useNEXT_CSS_IMAGEinsteadName for next image button source information- See Also:
 - Constant Field Values
 
 
- 
FIRST_IMAGE
@Deprecated static final java.lang.String FIRST_IMAGE
Deprecated.Please useFIRST_CSS_IMAGEinsteadName for first image button source information- See Also:
 - Constant Field Values
 
 
- 
END_IMAGE
@Deprecated static final java.lang.String END_IMAGE
Deprecated.Please useEND_CSS_IMAGEinsteadName 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
 
 
 - 
 
 -