Package com.microstrategy.web.app.addons

Class IFrameUpdateFilterAddon

java.lang.Object

com.microstrategy.web.app.addons.AbstractAppAddOn

com.microstrategy.web.app.addons.IFrameUpdateFilterAddon

All Implemented Interfaces:

AppAddOns

public class IFrameUpdateFilterAddon
extends AbstractAppAddOn

This class provides a way to control the list of beans rendered on a page during an IFrameUpdate. The configuration file is specified as a property to the Addon.

Since:

MicroStrategy Web 8.1.0

Constructor Summary

Constructors

Constructor	Description
IFrameUpdateFilterAddon()

Method Summary

Modifier and Type	Method	Description
java.lang.String	getAddOnDescription()	This method describes the tasks performed by the AddOn.
protected boolean	isEventOptimizable(WebComponent webComponent, EventList eventInfo, RequestKeys rk)
void	preCollectData(PageComponent pg)	This is the main method of the add on which executes the add on.
void	setBeanName(java.lang.String name)	Sets the Bean name
void	setEventFilterConfigurationFile(java.lang.String value)
protected void	setUpFilter(WebComponent webComponent, RequestKeys rk)
protected void	setUpRenderingFilter(WebComponent webComponent, EventListSet eventFilters, RequestKeys rk)	Sets up the filter for the beans that need to be rendered based on the

Methods inherited from class com.microstrategy.web.app.addons.AbstractAppAddOn

getRequestKeys, isCollectDataRequired, isIFrameRequest, postCollectData

Methods inherited from class java.lang.Object

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

Constructor Detail

IFrameUpdateFilterAddon

public IFrameUpdateFilterAddon()

Method Detail

getAddOnDescription

public java.lang.String getAddOnDescription()

Description copied from interface: AppAddOns

This method describes the tasks performed by the AddOn.

Returns:

The tasks which the Add On performs. This needs to be as descriptive as possible.

preCollectData

public void preCollectData(PageComponent pg)

Description copied from interface: AppAddOns

This is the main method of the add on which executes the add on. This has to be a static method.

Specified by:

preCollectData in interface AppAddOns

Overrides:

preCollectData in class AbstractAppAddOn

Parameters:

pg - is the PageComponent.

setUpFilter

protected void setUpFilter(WebComponent webComponent,
                           RequestKeys rk)

setUpRenderingFilter

protected void setUpRenderingFilter(WebComponent webComponent,
                                    EventListSet eventFilters,
                                    RequestKeys rk)

Sets up the filter for the beans that need to be rendered based on the

Parameters:

webComponent - WebComponent

eventFilters - EventListSet

rk - RequestKeys

setBeanName

public void setBeanName(java.lang.String name)

Sets the Bean name

Parameters:

name - bean name

setEventFilterConfigurationFile

public void setEventFilterConfigurationFile(java.lang.String value)

isEventOptimizable

protected boolean isEventOptimizable(WebComponent webComponent,
                                     EventList eventInfo,
                                     RequestKeys rk)