Package com.microstrategy.web.app.transforms

Class ReportFrameGenericTransform

  • All Implemented Interfaces:
    AppTransform, LayoutTransform, Transform
    public class ReportFrameGenericTransform
extends FrameGenericTransform
    This transforms renders a ReportFrameBean using a LayoutBuilder. It's iFrame aware, so it provides methods to render elements as iFrame components.
    Since:
    MicroStrategy Web 9.0.0

    • Field Detail

      • promptsCreateStyle

        protected FormalParameter promptsCreateStyle
        This is the name of the style to use to transform a prompted grid when creating new reports.
        Allowed Values: any report style name from StyelCatalog.xml file.

      • promptsEditStyle

        protected FormalParameter promptsEditStyle
        This is the name of the style to use to transform a prompted grid when editing reports.
        Allowed Values: any report style name from StyelCatalog.xml file.

      • promptsSavingStyle

        protected FormalParameter promptsSavingStyle
        This is the name of the style to use to transform a prompted grid when trying to save edited or created report which have prompts to be resolved before saving.
        Allowed Values: any report style name from StyelCatalog.xml file.

      • promptsExecuteStyle

        protected FormalParameter promptsExecuteStyle
        This is the name of the style to use to transform a prompted grid when normal report execution.
        Allowed Values: any report style name from StyelCatalog.xml file.

      • FP_PROMPTS_EDIT_STYLE

        public static final java.lang.String FP_PROMPTS_EDIT_STYLE
        name for the formal parameter "promptsEditStyle".
        See Also:
        Constant Field Values

      • FP_PROMPTS_CREATE_STYLE

        public static final java.lang.String FP_PROMPTS_CREATE_STYLE
        name for the formal parameter "promptsCreateStyle".
        See Also:
        Constant Field Values

      • FP_PROMPTS_SAVING_STYLE

        public static final java.lang.String FP_PROMPTS_SAVING_STYLE
        name for the formal parameter "promptsSavingStyle".
        See Also:
        Constant Field Values

      • FP_PROMPTS_EXECUTE_STYLE

        public static final java.lang.String FP_PROMPTS_EXECUTE_STYLE
        name for the formal parameter "promptsExecuteStyle".
        See Also:
        Constant Field Values

    • Constructor Detail

      • ReportFrameGenericTransform

        public ReportFrameGenericTransform()
        Default constructor. Initializes formal parameters.

    • Method Detail

      • renderEditorMessage

        public void renderEditorMessage​(MarkupOutput out,
                                java.lang.String name)
        Generate the HTML corresponding to the editor message, as available via the getEditorMessage property of the FrameBean. Internally calls the FrameGenericTransform.displayComponent(MarkupOutput, String, String) method for the final HTML generation.
        Parameters:
        out - MarkupOutput instance where the HTML output will be saved
        name - String value with the name to be used for the component wrapping the HTML content to generate

      • renderEmptyIFrameComponent

        public void renderEmptyIFrameComponent​(MarkupOutput out,
                                       java.lang.String name)
        Generates the HTML corresponding to a component that should not render any contents at the time. It creates the component placeholder for future rendering, when handling iframe manipulations.
        Parameters:
        out - MarkupOutput instance where the HTML output will be saved
        name - String value with the name to be used for the component wrapping the HTML content to generate

      • getReportDataCellAttributes

        public java.util.Map getReportDataCellAttributes()
        Generate the extra attributes the cell holding the report data requires.
        Returns:
        Map instance initialized with the extra attributes to include into the cell's defintion

      • getReportFormAttributes

        public java.util.Map getReportFormAttributes()
        Generate the extra attributes the main report form requires for its proper definition. Such attributes include the form name, action, method and any extra information required for it to work properly on iframe environments if needed.
        Returns:
        Map instance initialized with the extra attributes to include into the form's defintion

      • renderReportFormHiddenInputs

        public void renderReportFormHiddenInputs​(MarkupOutput out)
        Generate the hidden inputs that should be appended to the form definition while handling report data.
        Parameters:
        out - MarkupOutput instance where the HTML output will be saved

      • renderIFrameComponent

        public void renderIFrameComponent​(MarkupOutput out,
                                  java.lang.String name)
        Generates the HTML for the corresponding frame child component
        Overrides:
        renderIFrameComponent in class FrameGenericTransform
        Parameters:
        out - MarkupOutput instance where the HTML output will be saved
        name - String value with the name to be used for the component wrapping the HTML content to generate, as well as indicating which component will be rendered by this method.

      • renderBean

        public void renderBean​(MarkupOutput out,
                       java.lang.String name,
                       java.lang.String style,
                       boolean setChanged)
        Renders any bean within the hierarchy using the specified style
        Parameters:
        out - MarkupOutput instance
        name - the name of the bean to render
        style - the name of the style to user to render the bean
        setChanged - forces the bean to be marked as changed, in order to have it rendered. If argument is false, property will not be updated.

      • renderVisualization

        public void renderVisualization​(MarkupOutput out,
                                java.lang.String name,
                                boolean setChanged)
        This method verifies the visualization settings of the bean and renders it according to the style specified there
        Parameters:
        out - MarkupOutput instance where the output will be stored
        name - String indicating the name of the bean to be rendered
        setChanged - boolean indicating if the bean has changed since the last time it was rendered

      • 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 FrameGenericTransform
        Returns:
        Class instance corresponding to the ReportFrameBean which is the one supported by this transform

      • getDesignModeEvent

        protected WebEvent getDesignModeEvent()
        Returns:
        WebEvent corresponding to the design mode event supported by this transform

      • isDesignTemplateDisplayed

        public boolean isDesignTemplateDisplayed()
        Returns:
        boolean value indicating if the design mode is (or should be) rendering the template information

      • isDesignFilterDisplayed

        public boolean isDesignFilterDisplayed()
        Returns:
        boolean value indicating if the design mode is (or should be) rendering the filter information

      • renderDesignModeButtonBar

        public void renderDesignModeButtonBar​(MarkupOutput out)
        Generate the HTML corresponding to the button bar that can be rendered on top of the filter and template information while in design mode. This button bar allows users to perform actions such as Cancel design mode, Run the resulting report or Save the changes.
        Parameters:
        out - MarkupOutput instance where the HTML output will be saved

      • getFeaturesList

        public static final java.lang.String[] getFeaturesList()
        Returns:
        a copy of the features String array that is sent to the report frame

      • getID

        public java.lang.String getID()
        Description copied from class: AbstractAppTransform
        Returns the unique name of the component to be used as the ID for its shell. This id is used for updating the page using the iFrame technology, and as the id for the corresponding bone (if any).
        Specified by:
        getID in interface Transform
        Overrides:
        getID in class AbstractAppTransform
        Returns:
        the component's unique id