Package com.microstrategy.web.app.transforms

Class PromptsSummaryTransform

    • Field Detail

      • useBreakSeparator

        protected FormalParameter useBreakSeparator
        Specifies whether to use an HTML break or not between prompt answers. Indicates if the different prompt answers selected to be displayed should be separated from each other using HTML break <BR> or no line break at all.
        This flag is used as boolean value.
        Since:
        MicroStrategy Web 8.0.0

      • FP_USE_BREAK_SEPARATOR

        public final java.lang.String FP_USE_BREAK_SEPARATOR
        Constant representing the name of the useHTMLBreakSeparator formal parameter
        Since:
        MicroStrategy Web 8.0.0
        See Also:
        Constant Field Values

      • showRequiredFirst

        protected FormalParameter showRequiredFirst
        Specifies whether prompts defined as required will be rendered first or not.
        Applies only when prompts are displayed in one page. Prompts can be sorted by priority.
        This flag is used as boolean value.

      • FP_SHOW_REQUIRED_FIRST

        public final java.lang.String FP_SHOW_REQUIRED_FIRST
        Constant representing the name of the showRequiredFirst formal parameter
        Since:
        MicroStrategy Web 8.0.0
        See Also:
        Constant Field Values

      • showAllPrompts

        protected FormalParameter showAllPrompts
        Specifies whether to show all prompts in report page.
        If set to false we will render only the open prompts. This flag is used as boolean value.

      • FP_SHOW_ALL_PROMPTS

        public final java.lang.String FP_SHOW_ALL_PROMPTS
        Constant representing the name of the showAllPrompts formal parameter
        Since:
        MicroStrategy Web 8.0.0
        See Also:
        Constant Field Values

      • showYourSelectionText

        protected FormalParameter showYourSelectionText
        Specifies whether or not to display "Your selection:" area.
        This flag is used as boolean value.

      • FP_SHOW_YOUR_SELECTION_TEXT

        public final java.lang.String FP_SHOW_YOUR_SELECTION_TEXT
        Constant representing the name of the showYourSelectionText formal parameter
        Since:
        MicroStrategy Web 8.0.0
        See Also:
        Constant Field Values

      • useBackendDetails

        protected FormalParameter useBackendDetails
        Whether to use backend's filter details when possible
        Since:
        MicroStrategy Web 9.0.0

      • _cssSummaryTable

        protected java.lang.String _cssSummaryTable
        CSS valriables

      • _cssPromtNumber

        protected java.lang.String _cssPromtNumber

      • _cssPromtTitle

        protected java.lang.String _cssPromtTitle

      • _cssPromtRequired

        protected java.lang.String _cssPromtRequired

      • _cssPromtSelection

        protected java.lang.String _cssPromtSelection

      • _cssPromtAnswer

        protected java.lang.String _cssPromtAnswer

      • _cssPromtNotAnswered

        protected java.lang.String _cssPromtNotAnswered

    • Constructor Detail

      • PromptsSummaryTransform

        public PromptsSummaryTransform()
        Default no-args constructor.
        Initialize all Formal Parameters.

    • Method Detail

      • getDescription

        public java.lang.String getDescription()
        Indicates description for this Transform.
        Specified by:
        getDescription in interface Transform
        Returns:
        String "This is the Transform that renders the summary of all prompts."

      • getPromptsBean

        protected PromptsBean getPromptsBean()
        Returns active PromptBean instance used by this transform.
        Returns:
        PromptsBean instance.

      • renderPromptsContent

        public void renderPromptsContent​(MarkupOutput out)
        Renders output for all prompts.
        Parameters:
        out - MarkupOutput the content output.

      • getPromptsList

        public java.util.ArrayList getPromptsList()
        Returns current prompt list.
        List is consisted of all prompts defined in current Report.
        Returns:
        ArrayList collection of available prompts.
        Since:
        MicroStrategy Web 8.0.0

      • renderPrompt

        @Deprecated
public void renderPrompt​(PromptObject prompt,
                         MarkupOutput out)
        Deprecated.
        use renderPrompt(MarkupOutput out, PromptObject prompt) instead.
        Renders prompt content.
        Parameters:
        out - MarkupOutput where to write prompt content.
        prompt - PromptObject current active instance.

      • renderPrompt

        public void renderPrompt​(MarkupOutput out,
                         PromptObject prompt)
        Renders the prompt content.
        Parameters:
        prompt - PromptObject the prompt to display
        out - MarkupOutput where to write the output of the method.
        Since:
        MicroStrategy Web 8.0.0

      • renderRequiredPrompt

        public void renderRequiredPrompt​(MarkupOutput out,
                                 PromptObject prompt)
        Renders required prompt text message.
        Parameters:
        out - MarkupOutput where to render prompts
        prompt - PromptObject current prompt being rendered.
        Since:
        MicroStrategy Web 8.0.0

      • renderPromptTitle

        public void renderPromptTitle​(MarkupOutput out,
                              PromptObject prompt)
        Renders Prompt's title.
        Parameters:
        out - MarkupOutput where to render prompt.
        prompt - PromptObject being parsed
        Since:
        MicroStrategy Web 8.0.0

      • renderPromptNumber

        public void renderPromptNumber​(MarkupOutput out,
                               PromptObject prompt)
        Renders prompt number.
        Parameters:
        out - MarkupOutput where to render prompt.
        prompt - PromptObject being parsed
        Since:
        MicroStrategy Web 8.0.0

      • renderPromptObjects

        public void renderPromptObjects​(MarkupOutput out,
                                PromptObject prompt)
        Render Prompt objects.
        Parameters:
        out - MarkupOutput where to render prompt.
        prompt - PromptObject being parsed
        Since:
        MicroStrategy Web 8.0.0

      • renderPromptNotAnsweredText

        public void renderPromptNotAnsweredText​(MarkupOutput out)
        Renders localized message "Prompt not answered".
        Parameters:
        out - where to write the output of the method.
        Since:
        MicroStrategy Web 8.0.0

      • renderYourSelectionText

        public void renderYourSelectionText​(MarkupOutput out)
        Renders localized message "Your selection:".
        Parameters:
        out - where to write the output of the method.
        Since:
        MicroStrategy Web 8.0.0

      • 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.
        Since:
        MicroStrategy Web 8.0.1

      • renderPromptDetails

        public void renderPromptDetails​(MarkupOutput out)
        Since:
        MicroStrategy Web 9.0.0

      • useBackendDetails

        public boolean useBackendDetails()
        Since:
        MicroStrategy Web 9.0.0