Package com.microstrategy.web.app.addons

Class AbstractAppAddOn

java.lang.Object

com.microstrategy.web.app.addons.AbstractAppAddOn

All Implemented Interfaces:

AppAddOns

Direct Known Subclasses:

AbstractSaveReportPropertiesAddOn, DebugFlagsAddOn, DocumentSetFlagsAddOn, ExportReportAddOn, FastExportAddOn, FastReportPDFExportAddOn, FolderFrameAddOn, FolderLastVisitedAddOn, FolderProjectBrowserAddOnBase, FolderSetFlagsAddOn, IFrameUpdateFilterAddon, OptionsAddOn, PageFullScreenModeAddOn, PDFSetFlagsAddOn, ReportDetailsSetFlagsAddOn, ReportSetFlagsAddOn, ReportSetResultWindowAddOn, RWDesignModeAddOn, RWDetailsSetFlagsAddOn, RWDFilterAddOn, RWDWizardAddOn, RWExportAddOn, RWSetFlagsAddOn, RWSetOIVMFlagsAddOn, SaveAsFolderFlagsAddOn, SaveAsReportFlagsAddOn, SaveReportPropertiesAddOn, SearchSupportedTypesAddon

public abstract class AbstractAppAddOn
extends java.lang.Object
implements AppAddOns

Since:

MicroStrategy Web 7.5.0

Constructor Summary

Constructors

Constructor	Description
AbstractAppAddOn()

Method Summary

Modifier and Type	Method	Description
protected RequestKeys	getRequestKeys(PageComponent pg)	The method returns the RequestKeys object associated
boolean	isCollectDataRequired(PageComponent pg, WebComponent child)	Determins wheter the page should call collect data on the child
protected boolean	isIFrameRequest(RequestKeys rk)
void	postCollectData(PageComponent pg)	Executes post collectData operations.
void	preCollectData(PageComponent pg)	This is the main method of the add on which executes the add on.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.microstrategy.web.app.addons.AppAddOns

getAddOnDescription

Constructor Detail

AbstractAppAddOn

public AbstractAppAddOn()

Method Detail

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

Parameters:

pg - is the PageComponent.

postCollectData

public void postCollectData(PageComponent pg)

Description copied from interface: AppAddOns

Executes post collectData operations.

Specified by:

postCollectData in interface AppAddOns

isCollectDataRequired

public boolean isCollectDataRequired(PageComponent pg,
                                     WebComponent child)

Determins wheter the page should call collect data on the child

Specified by:

isCollectDataRequired in interface AppAddOns

Parameters:

pg - the PageComponent instance

child - the child of the page}

Returns:

true if the collect data must be called

Since:

MicroStrategy Web 8.0.0

getRequestKeys

protected RequestKeys getRequestKeys(PageComponent pg)

The method returns the RequestKeys object associated

Returns:

a RequestKeys instance

isIFrameRequest

protected boolean isIFrameRequest(RequestKeys rk)

Since:

MicroStrategy Web 8.0.0