Package com.microstrategy.web.app.transforms

Class ElementPickerTransform

  • All Implemented Interfaces:
    AppTransform, Transform
    public class ElementPickerTransform
extends AbstractAppTransform
    This transform renders the element picker used in prompts.
    Since:
    MicroStrategy Web 8.0.1

    • Field Detail

      • 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

      • titleLabelID

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

      • FP_TITLE_LABEL_ID

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

    • Constructor Detail

      • ElementPickerTransform

        public ElementPickerTransform()
        Default constructor

    • Method Detail

      • renderJavascript

        protected void renderJavascript​(MarkupOutput out)
        Renders the javascript for the transform. Calls renderRegisterBone to register the bone.
        Parameters:
        out - MarkupOutputinstance where to create the HTML output

      • 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.
        See Also:
        Transform.getDescription()

      • 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.

      • initEditor

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

      • renderEditor

        public void renderEditor​(MarkupOutput out)
        Main method to render the output of an editor. It creates an Editor and initializes the editor and calls renderOutput method to render the contents into the editor's contents.
        Parameters:
        out - MarkupOutputinstance where to create the HTML output

      • renderOutput

        public void renderOutput​(MarkupOutput out)
        Creates a CartElementPicker instance and initializes the cart properties and then renders the cart into the MarkupOutput.
        Parameters:
        out - MarkupOutputinstance where to create the HTML output

      • initializeCartProperties

        protected void initializeCartProperties​(CartElementPicker cartElemPicker)
        Initializes the cart properties.
        Parameters:
        cartElemPicker - - the CartElementPicker to be initialized

      • initializeCartSearchAndIncrementalFetch

        protected void initializeCartSearchAndIncrementalFetch​(CartElementPicker cartElemPicker)
        Initialize the Search and incremental fetch properties
        Parameters:
        cartElemPicker - - the CartElementPicker to be initialized

      • renderHiddenInputs

        protected void renderHiddenInputs​(MarkupOutput out)
        Render hidden inputs for EnumPromptsBeanEvents.PROMPTS_EVENT_PROCESS_ANY_PROMPTS
        Parameters:
        out - MarkupOutputinstance where to create the HTML output