Package com.microstrategy.web.app.addons

Class OptionsAddOn

  • All Implemented Interfaces:
    AppAddOns
    public class OptionsAddOn
extends AbstractAppAddOn

    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.

    Since:
    MicroStrategy Web 7.3.1 or earlier

    • Constructor Detail

      • OptionsAddOn

        public OptionsAddOn()

    • Method Detail

      • preCollectData

        public void preCollectData​(PageComponent page)
        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:
        page - is the PageComponent.
        Since:
        MicroStrategy Web 7.5.0

      • getAddOnDescription

        public java.lang.String getAddOnDescription()
        Description copied from interface: AppAddOns
        This method describes the tasks performed by the AddOn.
        Returns:
        the description of the AddOn

      • setBeanName

        @Deprecated
public void setBeanName​(java.lang.String beanName)
        Deprecated.
        use setOptionsBeanName()
        Sets the bean name
        Parameters:
        beanName - bean name

      • setReportBeanName

        public void setReportBeanName​(java.lang.String reportBeanName)
        Sets the report bean name
        Parameters:
        reportBeanName - report bean name
        Since:
        MicroStrategy Web 8.0.0

      • setOptionsBeanName

        public void setOptionsBeanName​(java.lang.String optionsBeanName)
        Sets the options bean name
        Parameters:
        optionsBeanName - options bean name
        Since:
        MicroStrategy Web 8.0.0

      • setPrintHeaderFooterGroupName

        public void setPrintHeaderFooterGroupName​(java.lang.String groupName)
        Sets the print header footer group name
        Parameters:
        groupName -