Package com.microstrategy.web.app.transforms

Class AbstractOptionsTransform

    • Field Detail

      • ACTION_TYPE_PDF

        public static final java.lang.String ACTION_TYPE_PDF
        Since:
        MicroStrategy Web 9.0.0
        See Also:
        Constant Field Values

      • ACTION_TYPE_PRINT

        public static final java.lang.String ACTION_TYPE_PRINT
        Since:
        MicroStrategy Web 9.0.0
        See Also:
        Constant Field Values

      • ACTION_TYPE_EXPORT

        public static final java.lang.String ACTION_TYPE_EXPORT
        Since:
        MicroStrategy Web 9.0.0
        See Also:
        Constant Field Values

    • Constructor Detail

      • AbstractOptionsTransform

        public AbstractOptionsTransform()
        Default empty constructor. Initialize formal parameters.

    • Method Detail

      • transformForRequestInError

        public void transformForRequestInError​(MarkupOutput out)
        Generates the graphical output for the PreferencesBean when the bean is in Error. It will call the parent method if it is not invoked from the options page or if has an error object which is not null or if it ha no preference validation errors. If there are preference validation errors from the options page then it will render and error message and make a call to transformForRequestWaitingForUserInput so the user might change Preferences again and get a chance to correct them.
        Overrides:
        transformForRequestInError in class AbstractAppTransform
        Parameters:
        out - where to create the output
        See Also:
        AbstractAppTransform.checkStatus(com.microstrategy.web.beans.MarkupOutput)

      • initializeTransform

        public void initializeTransform​(Transformable data)
        Description copied from class: AbstractAppTransform

        This method initialize the private and protected fields of the transform, such as width and height. It also invokes the initializeWebComponent, initializeImages and initializeCss methods.

        This method is automatically called from the transform method. Transforms which would like to invoke other methods in this instance directly (for example, to invoke some render methods), need first to call this method to guarantee that the Transform is ready to generate output.
        Specified by:
        initializeTransform in interface AppTransform
        Overrides:
        initializeTransform in class AbstractPreferencesTransform
        Parameters:
        data - the bean to transform.

      • renderSaveMessage

        public void renderSaveMessage​(MarkupOutput out)
        If a preference was updated and there were no errors, this method shows a success message to the user.
        Overrides:
        renderSaveMessage in class AbstractPreferencesTransform
        Parameters:
        out - where to write the output of the method.

      • renderOutlineModeHiddenInput

        protected void renderOutlineModeHiddenInput​(MarkupOutput out)
        Render the Hidden Inputs for the Outline Mode to be passed to the PDF.
        Parameters:
        out - where to write the output of the method.
        Since:
        MicroStrategy Web 8.0.1

      • isShowingOptions

        public boolean isShowingOptions()
        This method is used to determine whether the transform is being used to display user preferences or report export options
        Returns:
        true if used to display exporting/printing options.
        Since:
        MicroStrategy Web 8.0.1

      • getOptionsBean

        protected OptionsBean getOptionsBean()
        Returns the current OptionsBean
        Returns:
        this OptionsBean

      • getSupportedBeanType

        public java.lang.Class getSupportedBeanType()
        Description copied from class: AbstractAppTransform
        Returns the supported bean type. This abstract Transform supports all WebComponents so every sub-class should override this method to return the class of the Bean the Transform is expecting, for example: 
         public class CustomReportClass extends AbstractAppTransform {

    public Class getSupportedBeanType() {
        //This Transform is expected to work only with a ReportBean,
        //therefore this method needs to return this class:
        return ReportBean.class;
    }

 }
        Specified by:
        getSupportedBeanType in interface Transform
        Overrides:
        getSupportedBeanType in class AbstractPreferencesTransform
        Returns:
        a root class/interface supported by this transform.

      • isGridGraphOptions

        public boolean isGridGraphOptions()
        Determines if the editor is being used to display grid/graph options.
        Returns:
        true if the options bean is being used to display grid options
        Since:
        MicroStrategy Web 8.0.1

      • isGridOptions

        public boolean isGridOptions()
        Determines if the editor is being used to display grid options.
        Returns:
        true if the options bean is being used to display grid options
        Since:
        MicroStrategy Web 8.0.1

      • isGraphOptions

        public boolean isGraphOptions()
        Determines if the editor is being used to display grid options.
        Returns:
        true if the options bean is being used to display grid options
        Since:
        MicroStrategy Web 8.0.1

      • isReportPageByNotEmpty

        public boolean isReportPageByNotEmpty()
        Determin whether the page-by in the report is empty
        Returns:
        true if the transform is displaying print options and there are template units in the page-by.
        Since:
        MicroStrategy Web 8.0.1

      • getValidatePreferencesEvent

        public WebEvent getValidatePreferencesEvent()
        Returns the event used to validate preferences before exporting.
        Since:
        MicroStrategy Web 8.0.1

      • getSaveReportPropertiesEvent

        protected WebEvent getSaveReportPropertiesEvent()
        Returns:
        the save report properties event. Used for the options pages.
        Since:
        MicroStrategy Web 9.0.0

      • getSaveReportPropertiesEventID

        protected int getSaveReportPropertiesEventID()
        Since:
        MicroStrategy Web 9.0.0

      • getExportEventID

        protected java.lang.String getExportEventID()
        Returns the ID of the export event used when this transform is used for the Options Page (examples are Export, PDF and Print)
        This will be used to pass as the "eventToForwardTo" on the Save Report Properties page.
        Returns:
        The ID of the final event used when this transform is used for the Options Page (examples are Export, PDF and Print)
        Since:
        MicroStrategy Web 9.0.0

      • renderHeaderAndFooterButton

        public void renderHeaderAndFooterButton​(MarkupOutput out,
                                        java.lang.String groupName)
        Renders link to edit custom header and footer.
        Parameters:
        out - the output object
        Since:
        MicroStrategy Web 9.0.0

      • renderCustomHeaderFooterButton

        protected void renderCustomHeaderFooterButton​(MarkupOutput out,
                                              WebEvent evt)
        Since:
        MicroStrategy Web 9.0.0

      • getPreference

        protected java.lang.String getPreference​(java.lang.String name)
        Overwrites implementation to check for report properties if set.
        Overrides:
        getPreference in class AbstractPreferencesTransform
        Parameters:
        name - name of the preference
        Returns:
        preference.getValue() for the requested level
        Since:
        MicroStrategy Web 9.0.0

      • renderPreferenceBodyText

        protected void renderPreferenceBodyText​(MarkupOutput out,
                                        java.lang.String preferenceName,
                                        java.lang.String text,
                                        java.lang.String tagID)
        Renders the text of a Preference. This method associate the text label to its corresponding radiobox or checkbox.
        Overrides:
        renderPreferenceBodyText in class AbstractPreferencesTransform
        Parameters:
        preferenceName - the preference name
        text - the title to display
        tagID - the element ID with which this text is associated
        out - where to create the output
        Since:
        MicroStrategy Web 9.0.0