Package com.microstrategy.web.app.gui

Class IncrementalFetchImpl

java.lang.Object

com.microstrategy.web.app.gui.AbstractGuiElement

com.microstrategy.web.app.gui.IncrementalFetchImpl

All Implemented Interfaces:

GuiElement, IncrementalFetch

public class IncrementalFetchImpl
extends AbstractGuiElement
implements IncrementalFetch

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

Since:

MicroStrategy Web 7.3.1 or earlier

Nested Class Summary

Nested classes/interfaces inherited from interface com.microstrategy.web.app.gui.IncrementalFetch

IncrementalFetch.IncrementalFetchDetails

Field Summary

Fields inherited from class com.microstrategy.web.app.gui.AbstractGuiElement

_appContext, _name, _webComponent

Constructor Summary

Constructors

Constructor	Description
IncrementalFetchImpl()	IncrementalFetchImpl constructor, initialize all Incremental fetch properties.

Method Summary

Modifier and Type	Method	Description
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.
java.lang.Object	getProperty(java.lang.String key)	Function for getting the key associated property value.
java.lang.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 IncrementalFetch.renderTextContent(MarkupOutput) generates
void	renderPreContent(MarkupOutput out)	Renders any other content that should be displayed before what IncrementalFetch.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(java.lang.String key, java.lang.Object obj)	Function for setting any Incremental fetch property.
void	setTargetBoneName(java.lang.String name)	Set the name of the bone who will be tracking the filter on selection check boxes trough the pages
java.lang.String	toString()	Function for returning the class name

Methods inherited from class com.microstrategy.web.app.gui.AbstractGuiElement

getAppContext, getDescriptor, getDescriptor, getDescriptor, getExtraInput, getExtraUrl, getFeatures, getMessages, getName, getTagsFactory, getUseIFrame, getWebComponent, isDhtml, isIFrameEnabled, newHiddenInputBuilder, newNamespaceEncoder, newURIBuilder, renderElement, setAppContext, setExtraInput, setExtraUrl, setName, setUseIFrame, setWebComponent

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.microstrategy.web.app.gui.GuiElement

getAppContext, getDescriptor, getDescriptor, getExtraInput, getExtraUrl, getFeatures, getMessages, getName, getUseIFrame, getWebComponent, renderElement, setAppContext, setExtraInput, setExtraUrl, setName, setUseIFrame, setWebComponent

Constructor Detail

IncrementalFetchImpl

public IncrementalFetchImpl()

IncrementalFetchImpl constructor, initialize all Incremental fetch properties.

Method Detail

setTargetBoneName

public void setTargetBoneName(java.lang.String name)

Description copied from interface: IncrementalFetch

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

Specified by:

setTargetBoneName in interface IncrementalFetch

getTargetBoneName

public java.lang.String getTargetBoneName()

initializeIncrementalFetch

public void initializeIncrementalFetch()

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

Specified by:

initializeIncrementalFetch in interface IncrementalFetch

renderElement

public MarkupOutput renderElement()

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

Specified by:

renderElement in interface GuiElement

Specified by:

renderElement in class AbstractGuiElement

Returns:

MarkupOutput where to write output

getEventManager

public EventManager getEventManager()

Description copied from class: AbstractGuiElement

get event manager for this gui element

Specified by:

getEventManager in interface GuiElement

Overrides:

getEventManager in class AbstractGuiElement

Returns:

the EventManager object

Since:

MicroStrategy Web 9.0.0

renderTextContent

public void renderTextContent(MarkupOutput out)

Description copied from interface: IncrementalFetch

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

Specified by:

renderTextContent in interface IncrementalFetch

Parameters:

out - MarkupOutput instance where the HTML contents generated will be saved.

Since:

MicroStrategy Web 9.0.0

renderFirstPageArrow

public void renderFirstPageArrow(MarkupOutput out)

Description copied from interface: IncrementalFetch

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

Specified by:

renderFirstPageArrow in interface IncrementalFetch

Parameters:

out - MarkupOutput instance where the HTML contents generated will be saved.

Since:

MicroStrategy Web 9.0.0

renderPreviousPageArrow

public void renderPreviousPageArrow(MarkupOutput out)

Description copied from interface: IncrementalFetch

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 <

Specified by:

renderPreviousPageArrow in interface IncrementalFetch

Parameters:

out - MarkupOutput instance where the HTML contents generated will be saved.

Since:

MicroStrategy Web 9.0.0

renderPreviousPageSetArrow

public void renderPreviousPageSetArrow(MarkupOutput out)

Description copied from interface: IncrementalFetch

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

Specified by:

renderPreviousPageSetArrow in interface IncrementalFetch

Parameters:

out - MarkupOutput instance where the HTML contents generated will be saved.

Since:

MicroStrategy Web 9.0.0

renderNextPageArrow

public void renderNextPageArrow(MarkupOutput out)

Description copied from interface: IncrementalFetch

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 >

Specified by:

renderNextPageArrow in interface IncrementalFetch

Parameters:

out - MarkupOutput instance where the HTML contents generated will be saved.

Since:

MicroStrategy Web 9.0.0

renderNextPageSetArrow

public void renderNextPageSetArrow(MarkupOutput out)

Description copied from interface: IncrementalFetch

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

Specified by:

renderNextPageSetArrow in interface IncrementalFetch

Parameters:

out - MarkupOutput instance where the HTML contents generated will be saved.

Since:

MicroStrategy Web 9.0.0

renderLastPageArrow

public void renderLastPageArrow(MarkupOutput out)

Description copied from interface: IncrementalFetch

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

Specified by:

renderLastPageArrow in interface IncrementalFetch

Parameters:

out - MarkupOutput instance where the HTML contents generated will be saved.

Since:

MicroStrategy Web 9.0.0

renderIncrementalFetch

public void renderIncrementalFetch(MarkupOutput out)

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

Specified by:

renderIncrementalFetch in interface IncrementalFetch

Parameters:

out - where to write the output of the method.

renderPreContent

public void renderPreContent(MarkupOutput out)

Description copied from interface: IncrementalFetch

Renders any other content that should be displayed before what IncrementalFetch.renderTextContent(MarkupOutput) generates

Specified by:

renderPreContent in interface IncrementalFetch

Parameters:

out - MarkupOutput instance where the HTML contents generated will be saved.

Since:

MicroStrategy Web 9.0.0

renderPostContent

public void renderPostContent(MarkupOutput out)

Description copied from interface: IncrementalFetch

Renders any other content that should be displayed after what IncrementalFetch.renderTextContent(MarkupOutput) generates

Specified by:

renderPostContent in interface IncrementalFetch

Parameters:

out - MarkupOutput instance where the HTML contents generated will be saved.

Since:

MicroStrategy Web 9.0.0

setProperty

public void setProperty(java.lang.String key,
                        java.lang.Object obj)

Function for setting any Incremental fetch property.

Specified by:

setProperty in interface IncrementalFetch

Parameters:

key - string value defining the index of property.

obj - object value.

getProperty

public java.lang.Object getProperty(java.lang.String key)

Function for getting the key associated property value.

Specified by:

getProperty in interface IncrementalFetch

Parameters:

key - property name

Returns:

Object property value

getIncrementalFetchDetails

public IncrementalFetch.IncrementalFetchDetails getIncrementalFetchDetails()

Description copied from interface: IncrementalFetch

Utility method to get access to incremental fetch information, such as current element index viewed, how many are left, total number of elements, etc.

Specified by:

getIncrementalFetchDetails in interface IncrementalFetch

Returns:

IncrementalFetch.IncrementalFetchDetails instance from where information about the incremental fetch can be obtained

Since:

MicroStrategy Web 9.0.0

toString

public java.lang.String toString()

Function for returning the class name

Overrides:

toString in class java.lang.Object

Returns:

String class name