public interface

IncrementalFetch

implements GuiElement
com.microstrategy.web.app.gui.IncrementalFetch
Known Indirect Subclasses

Class Overview

IncrementalFetch interface that defines minimum contract all IncrementalFetch must implement.

Summary

Nested Classes
interface IncrementalFetch.IncrementalFetchDetails This class takes care of the calculations needed for knowing what element indexes are currently being displayed, how many total elements are on the list, how many are still ahead, etc. 
Public Methods
abstract 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.
abstract Object getProperty(String key)
getProperty, for getting the key associated property value.
abstract void initializeIncrementalFetch()
initializeIncrementalFetch, for initializing all Incremental Fetch properties to default values.
abstract void renderFirstPageArrow(MarkupOutput out)
Renders the arrow that will allow navigation to the first page of the result set being examined.
abstract void renderIncrementalFetch(MarkupOutput out)
renderIncrementalFetch, function that encapsulates incremental fetch functionality.
abstract void renderLastPageArrow(MarkupOutput out)
Renders the arrow that will allow navigation to the last page of the result set being examined.
abstract void renderNextPageArrow(MarkupOutput out)
Renders the arrow that will allow navigation to the next page of the results being examined.
abstract void renderNextPageSetArrow(MarkupOutput out)
Renders the arrow that will allow navigation to the next page set of the results being examined.
abstract void renderPostContent(MarkupOutput out)
Renders any other content that should be displayed after what renderTextContent(MarkupOutput) generates
abstract void renderPreContent(MarkupOutput out)
Renders any other content that should be displayed before what renderTextContent(MarkupOutput) generates
abstract void renderPreviousPageArrow(MarkupOutput out)
Renders the arrow that will allow navigation to the previous page of the results being examined.
abstract void renderPreviousPageSetArrow(MarkupOutput out)
Renders the arrow that will allow navigation to the previous page set of the results being examined.
abstract void renderTextContent(MarkupOutput out)
Renders the content of the incremental fetch that is to be rendered in between the arrows for element navigation.
abstract void setProperty(String key, Object obj)
setProperty, for setting the output mode.
abstract void setTargetBoneName(String name)
Set the name of the bone who will be tracking the filter on selection check boxes trough the pages
[Expand]
Inherited Methods
From interface com.microstrategy.web.app.gui.GuiElement

Public Methods

public abstract 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

public abstract Object getProperty (String key)

getProperty, for getting the key associated property value.

Parameters
key property name
Returns
  • Object property value

public abstract void initializeIncrementalFetch ()

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

public abstract 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.

public abstract void renderIncrementalFetch (MarkupOutput out)

renderIncrementalFetch, function that encapsulates incremental fetch functionality.

Parameters
out where to write the output of the method.

public abstract 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.

public abstract 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.

public abstract 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.

public abstract 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.

public abstract 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.

public abstract 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.

public abstract 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.

public abstract 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.

public abstract void setProperty (String key, Object obj)

setProperty, for setting the output mode.

Parameters
key string value defining the index of property.
obj object value.

public abstract void setTargetBoneName (String name)

Set the name of the bone who will be tracking the filter on selection check boxes trough the pages