public class

IncrementalFetchImpl

extends AbstractGuiElement
implements IncrementalFetch
java.lang.Object
   ↳ com.microstrategy.web.app.gui.AbstractGuiElement
     ↳ com.microstrategy.web.app.gui.IncrementalFetchImpl

Class Overview

IncrementalFetchImpl abstraction it renders an HMTL output for Incremental fetch functionality.

Summary

[Expand]
Inherited Fields
From class com.microstrategy.web.app.gui.AbstractGuiElement
Public Constructors
IncrementalFetchImpl()
IncrementalFetchImpl constructor, initialize all Incremental fetch properties.
Public Methods
EventManager getEventManager()
get event manager for this gui element
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.
Object getProperty(String key)
Function for getting the key associated property value.
String getTargetBoneName()
void initializeIncrementalFetch()
initializeIncrementalFetch, for initializing all Incremental Fetch properties to default values.
MarkupOutput renderElement()
Function that returns an instance of MarkupOutput class.
void renderFirstPageArrow(MarkupOutput out)
Renders the arrow that will allow navigation to the first page of the result set being examined.
void renderIncrementalFetch(MarkupOutput out)
Function that renders whole incremental fetch HTML section.
void renderLastPageArrow(MarkupOutput out)
Renders the arrow that will allow navigation to the last page of the result set being examined.
void renderNextPageArrow(MarkupOutput out)
Renders the arrow that will allow navigation to the next page of the results being examined.
void renderNextPageSetArrow(MarkupOutput out)
Renders the arrow that will allow navigation to the next page set of the results being examined.
void renderPostContent(MarkupOutput out)
Renders any other content that should be displayed after what renderTextContent(MarkupOutput) generates
void renderPreContent(MarkupOutput out)
Renders any other content that should be displayed before what renderTextContent(MarkupOutput) generates
void renderPreviousPageArrow(MarkupOutput out)
Renders the arrow that will allow navigation to the previous page of the results being examined.
void renderPreviousPageSetArrow(MarkupOutput out)
Renders the arrow that will allow navigation to the previous page set of the results being examined.
void renderTextContent(MarkupOutput out)
Renders the content of the incremental fetch that is to be rendered in between the arrows for element navigation.
void setProperty(String key, Object obj)
Function for setting any Incremental fetch property.
void setTargetBoneName(String name)
Set the name of the bone who will be tracking the filter on selection check boxes trough the pages
String toString()
Function for returning the class name
[Expand]
Inherited Methods
From class com.microstrategy.web.app.gui.AbstractGuiElement
From class java.lang.Object
From interface com.microstrategy.web.app.gui.GuiElement
From interface com.microstrategy.web.app.gui.IncrementalFetch

Public Constructors

public IncrementalFetchImpl ()

IncrementalFetchImpl constructor, initialize all Incremental fetch properties.

Public Methods

public EventManager getEventManager ()

get event manager for this gui element

Returns

public 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 Object getProperty (String key)

Function for getting the key associated property value.

Parameters
key property name
Returns
  • Object property value

public String getTargetBoneName ()

public void initializeIncrementalFetch ()

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

public MarkupOutput renderElement ()

Function that returns an instance of MarkupOutput class. This instance is used for rendering HTML output

Returns
  • MarkupOutput where to write output

public 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 void renderIncrementalFetch (MarkupOutput out)

Function that renders whole incremental fetch HTML section. Calculations are performed for obtaining corresponding block begin.

Parameters
out where to write the output of the method.

public 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 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 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 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 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 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 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 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 void setProperty (String key, Object obj)

Function for setting any Incremental fetch property.

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

public void setTargetBoneName (String name)

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

public String toString ()

Function for returning the class name

Returns
  • String class name