Class PromptDetailsTransform

  • All Implemented Interfaces:
    AppTransform, Transform

    public class PromptDetailsTransform
    extends AbstractAppTransform
    This transform renders the prompt details on the report page. It uses an editor to display the contents of the prompt details.
    Since:
    MicroStrategy Web 8.0.1
    • Field Detail

      • paneTitleId

        public FormalParameter paneTitleId
        The title to be used for the pane.
      • 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
      • promptSummaryStyleName

        public FormalParameter promptSummaryStyleName
        The name of the style to be used to render the prompts summary.
      • FP_STYLE_TO_USE

        public final java.lang.String FP_STYLE_TO_USE
        Constant defining the formal parameter name - prompt summary style.
        See Also:
        Constant Field Values
      • editorLayoutFile

        public FormalParameter editorLayoutFile
        Indicates the name of the definition file associated with the editor.
      • FP_EDITOR_LAYOUT_FILE

        public static final java.lang.String FP_EDITOR_LAYOUT_FILE
        Constant defining the formal parameter name - Editor Layout file.
        See Also:
        Constant Field Values
    • Constructor Detail

      • PromptDetailsTransform

        public PromptDetailsTransform()
        Default constructor.
    • 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.
      • renderOutput

        protected void renderOutput​(MarkupOutput out)
        Render the output to the editor.
        Parameters:
        out -
      • 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.
        See Also:
        AbstractAppTransform.getSupportedBeanType()
      • 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.
      • 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.