Package com.microstrategy.web.app.transforms

Class ReportDetailsPanelTransform

  • All Implemented Interfaces:
    AppTransform, Transform
    public class ReportDetailsPanelTransform
extends AbstractAppTransform
    This transform renders the report details panel contents on the report page.
    It uses an Editor to display the contents of the report details.
    Since:
    MicroStrategy Web 9.0.0

    • Field Detail

      • paneTitleId

        public FormalParameter paneTitleId
        The title to be used for the pane.

      • panelHeight

        public FormalParameter panelHeight
        The title to be used for the pane.

      • helpType

        public FormalParameter helpType
        Indicates the type of help topic this editor uses.

      • helpTopic

        public FormalParameter helpTopic
        Indicates the help topic for the help page of the editor.

      • FP_PANE_TITLE_ID

        public final java.lang.String FP_PANE_TITLE_ID
        Constant defining the formal parameter name - pane title.
        See Also:
        Constant Field Values

      • FP_PANEL_HEIGHT

        public final java.lang.String FP_PANEL_HEIGHT
        Constant defining the formal parameter name - height.
        See Also:
        Constant Field Values

    • Constructor Detail

      • ReportDetailsPanelTransform

        public ReportDetailsPanelTransform()
        Default constructor no args

    • Method Detail

      • renderJavascript

        protected void renderJavascript​(MarkupOutput out)
        Render the Javascript required for the editor. Calls renderRegisterBone.
        Parameters:
        out - - MarkupOutput to render

      • initEditor

        protected void initEditor()
        Initializes the editor with the global settings.
        Parameters:
        editor - the Editorto modify.

      • getCloseEvent

        protected WebEvent getCloseEvent()
        Returns the event to be used for the close button. This returns the EnumPageEvents.WebEventShowBean
        Returns:
        The close event.

      • getEditor

        protected Editor getEditor()
        Returns the instance of the editor used by this transform.
        Returns:
        the instance of the Editor.

      • renderReportDetails

        public void renderReportDetails​(MarkupOutput out)
        Method that will render the content of the report details to a MarkupOutput object
        Parameters:
        out - MarkupOutput that will be used to append the report details

      • canTransform

        public boolean canTransform​(Transformable data)
        Description copied from interface: Transform
        Checks that the transform supports specified data object and that object is in the state supported by this transform.
        Specified by:
        canTransform in interface Transform
        Overrides:
        canTransform in class AbstractTransform
        Returns:
        true if the transform supports specified data object and the object is in the state supported by this transform.

      • getDescription

        public java.lang.String getDescription()
        Description copied from interface: Transform
        Returns a textual description of the transform.
        Returns:
        The textual description of the transform.

      • 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 AbstractAppTransform
        Parameters:
        data - the bean to transform.

      • 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 AbstractAppTransform
        Returns:
        a root class/interface supported by this transform.