public class

OptionsAddOn

extends AbstractAppAddOn
java.lang.Object
   ↳ com.microstrategy.web.app.addons.AbstractAppAddOn
     ↳ com.microstrategy.web.app.addons.OptionsAddOn

Class Overview

Title: OptionsAddOn.

Description: This add on takes care of setting the title of the HTML page for the print and PDF options page when it is invoked from the report page. It also takes care of setting the title of the header footer editor page for the print and pdf options.

Copyright: Copyright (c) 2002

Company: Microstrategy, Inc.

Summary

Public Constructors
OptionsAddOn()
Public Methods
String getAddOnDescription()
void preCollectData(PageComponent page)
This is the main method of the add on which executes the add on.
void setBeanName(String beanName)
This method is deprecated. use setOptionsBeanName()
void setOptionsBeanName(String optionsBeanName)
Sets the options bean name
void setPrintHeaderFooterGroupName(String groupName)
Sets the print header footer group name
void setReportBeanName(String reportBeanName)
Sets the report bean name
[Expand]
Inherited Methods
From class com.microstrategy.web.app.addons.AbstractAppAddOn
From class java.lang.Object
From interface com.microstrategy.web.app.addons.AppAddOns

Public Constructors

public OptionsAddOn ()

Public Methods

public String getAddOnDescription ()

Returns
  • the description of the AddOn

public void preCollectData (PageComponent page)

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

Parameters
page is the PageComponent.

public void setBeanName (String beanName)

This method is deprecated.
use setOptionsBeanName()

Sets the bean name

Parameters
beanName bean name

public void setOptionsBeanName (String optionsBeanName)

Sets the options bean name

Parameters
optionsBeanName options bean name

public void setPrintHeaderFooterGroupName (String groupName)

Sets the print header footer group name

public void setReportBeanName (String reportBeanName)

Sets the report bean name

Parameters
reportBeanName report bean name