Package com.microstrategy.web.app.transforms

Class FolderRadioButtonTransform

    • Constructor Detail

      • FolderRadioButtonTransform

        public FolderRadioButtonTransform()
        Deprecated.
        Class constructor, initializes the formal parameters.
        Since:
        MicroStrategy Web 8.0.0

    • Method Detail

      • renderList

        public void renderList​(MarkupOutput out,
                       WebDisplayUnits list)
        Deprecated.
        Renders the folder contents in a radio list button format, consisting on a main HTML TABLE, and where each one of the objects inside the folder get rendered as a TR inside of it. All the objects will belong to a main FORM, which event specification is given by the getOpenObjectEvent() method. For submitting this FORM, a button will be displayed at the end of the list, specified by the renderNextButton() method.
        Specified by:
        renderList in class AbstractFolderTransform
        Parameters:
        out - MarkupOutput instance to modify with the transform's output.
        list - WebDisplayUnits instance with the list of objects that will be rendered by this transform, as contents of the folder being analyzed.

      • renderItems

        public void renderItems​(MarkupOutput out)
        Deprecated.
        Renders each one of the items inside the folder being transformed.
        Parameters:
        out - MarkupOutput instance where the HTML content to display will be saved.
        Since:
        MicroStrategy Web 8.0.0

      • renderNextButton

        public void renderNextButton​(MarkupOutput out)
        Deprecated.
        Renders a button for allowing the selected object in the radio button list to be executed.
        The HTML contents generated by this method are inside an HTML TR tag, therefore the main TABLE tag where this row will exist has to be created beforehand. By default, the renderList() method takes care of it.
        Parameters:
        out - MarkupOutput instance to modify with the transform's output.

      • getDescription

        public java.lang.String getDescription()
        Deprecated.
        Return the description for this Transform
        Returns:
        String with the description for the transform.

      • renderObject

        public void renderObject​(MarkupOutput out,
                         WebObjectInfo object)
        Deprecated.
        Renders the WebObjectInfo object requested according to the specifications of this transform.
        The HTML contents generated by this method are inside a TR tag with two cells (one for the radio button, another for the object name and description), therefore the parent TABLE needs to be opened beforehand. By default, the renderList() method takes care of that.
        Overrides:
        renderObject in class AbstractObjectInfoListTransform
        Parameters:
        out - MarkupOutput instance where to save the contents to display
        object - WebObjectInfo to be rendered.

      • getOpenObjectEvent

        protected WebEvent getOpenObjectEvent()
        Deprecated.
        Creates and initializes a WebEvent for having the object opened or run.
        Returns:
        a WebEvent instance initialized, or null if the application does not support the event.

      • renderRadioButtonForObject

        protected void renderRadioButtonForObject​(MarkupOutput out,
                                          WebEvent openEvent,
                                          WebObjectInfo object,
                                          boolean selected)
        Deprecated.
        Render the radio button for the WebObjectInfo specified, according with the WebEvent defined. If the event has been customized, then this method should also be overwritten for the event argument identifiers to be correct.
        Parameters:
        out - MarkupOutput where the HTML output will be saved
        openEvent - WebEvent representing the action to do with the given object
        object - WebObjectInfo currently being processed
        selected - boolean indicating if the radio button should be selected or not

      • renderFormInputInfo

        protected void renderFormInputInfo​(MarkupOutput out,
                                   WebEvent openEvent)
        Deprecated.
        Render any hidden input information that has to be added while displaying the contents in the folder, according with the WebEvent specified. If the event has been customized, then this method should also be overwritten for the event argument identifiers to be correct.
        Parameters:
        out - MarkupOutput where the HTML output will be saved
        openEvent - WebEvent representing the action to do with the given object