Package com.microstrategy.web.app.transforms

Class FolderCreateReportTransform

    • Field Detail

      • blankObjectId

        public FormalParameter blankObjectId
        Deprecated.
        Indicates the object ID of the Blank Report.
        If found, it will display it inside its own box while rendering the contents of the folder.
        Since:
        MicroStrategy Web 8.0.0

      • promptExecuteStyle

        public FormalParameter promptExecuteStyle
        Deprecated.
        Specifies the name of prompt style to use for transforming selected prompted template in View Mode.
        This formal parameters will denote a text to be used as the name of the prompt style that tells to display 'Save' button in prompted report or Document.
        Since:
        MicroStrategy Web 8.0.0

      • promptCreateStyle

        public FormalParameter promptCreateStyle
        Deprecated.
        Specifies the name of prompt style to use for transforming selected prompted template in Design Mode.
        This formal parameters will denote a text to be used as the name of the prompt style that tells to display 'Save' button in prompted report or Document.
        Since:
        MicroStrategy Web 8.0.0

      • displaySection

        public FormalParameter displaySection
        Deprecated.
        Specifies which sections are to be displayed in the Create Report page (Create Report, Other Reports).
        This formal parameters will denote a number to be used as a flag for the two sections of this page.
        Since:
        MicroStrategy Web 7.5.1

      • promptStyle

        public FormalParameter promptStyle
        Deprecated.
        Specifies the name of prompt style to use for transforming selected prompted template in Create Repor page.
        This formal parameters will denote a text to be used as the name of the prompt style. This value will be passed as an event argument for EnumPageEvents.WebEventEditReport event which will be set in getOpenObjectEvent method.
        that tells to display 'Save' button in prompted report or Document.
        Since:
        MicroStrategy Web 7.5.1

      • FP_BLANK_REPORT_ID

        public static final java.lang.String FP_BLANK_REPORT_ID
        Deprecated.
        Constant specifying the name of the formal parameter for defining the ID of the blank report. Value is blankObjectId.
        See Also:
        Constant Field Values

      • _templateHeaderDesc

        public java.lang.String _templateHeaderDesc
        Deprecated.
        Since:
        MicroStrategy Web 8.0.0

      • _blankObjectHeaderDesc

        public java.lang.String _blankObjectHeaderDesc
        Deprecated.
        Since:
        MicroStrategy Web 8.0.0

      • _blankObjectName

        public java.lang.String _blankObjectName
        Deprecated.
        Since:
        MicroStrategy Web 8.0.0

      • _blankObjectDesc

        public java.lang.String _blankObjectDesc
        Deprecated.
        Since:
        MicroStrategy Web 8.0.0

    • Constructor Detail

      • FolderCreateReportTransform

        public FolderCreateReportTransform()
        Deprecated.
        Default no-argument constructor. Initializes formal parameters.

    • Method Detail

      • hasCreateBlankObjectPrivileges

        public boolean hasCreateBlankObjectPrivileges()
        Deprecated.
        Returns:
        boolean
        Since:
        MicroStrategy Web 8.0.0

      • renderList

        public void renderList​(MarkupOutput out,
                       WebDisplayUnits list)
        Deprecated.
        Extends the original method by splitting it in two: renderBlankObject() and renderTemplateList()
        Overrides:
        renderList in class FolderRadioButtonTransform
        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.

      • isEmptyList

        public boolean isEmptyList​(WebDisplayUnits list)
        Deprecated.
        Indicates whether or not given list is empty.
        Checks that at least there's one instance of a Report or a sub Folder.
        Parameters:
        list - collection of units
        Returns:
        boolean true if empty list.
        Since:
        MicroStrategy Web 8.0.0

      • renderSubFolderIconInfo

        public void renderSubFolderIconInfo​(MarkupOutput out,
                                    WebObjectInfo object)
        Deprecated.
        Write out the image information for a single object.
        Parameters:
        out - MarkupOutput instance where to save the contents to display
        object - WebObjectInfo to be rendered.

      • renderSubFolderDescription

        public void renderSubFolderDescription​(MarkupOutput out,
                                       WebObjectInfo object)
        Deprecated.
        Write out folder description for a single object.
        Parameters:
        out - MarkupOutput instance where to save the contents to display
        object - WebObjectInfo to be rendered.
        Since:
        MicroStrategy Web 7.5.3

      • renderSubFolderNameInfo

        public void renderSubFolderNameInfo​(MarkupOutput out,
                                    WebObjectInfo object)
        Deprecated.
        Write out name information for a single object.
        Parameters:
        out - MarkupOutput instance where to save the contents to display
        object - WebObjectInfo to be rendered.

      • renderSubFolder

        public void renderSubFolder​(MarkupOutput out,
                            WebObjectInfo object)
        Deprecated.
        Writes out information for a single subfolder object.
        Parameters:
        out - MarkupOutput instance where to save the contents to display
        object - WebObjectInfo to be rendered.

      • renderBlankObject

        public void renderBlankObject​(MarkupOutput out)
        Deprecated.
        Renders the first part of the transform, that is the part where the user might pick a "blank" report to start working.
        The contents are inside an HTML TABLE, and each one of the objects to display are divided in a table row, with two cells: one for the radio button and another one for the name and description of the object (if available).
        Parameters:
        out - MarkupOutput instance to modify with the transform's output. be rendered by this transform, as contents of the folder being analyzed.
        Since:
        MicroStrategy Web 8.0.0

      • renderTemplateList

        public void renderTemplateList​(MarkupOutput out)
                        throws WebBeanException,
                               WebObjectsException
        Deprecated.
        Renders the list of templates in this folder. Basically just adds a message on the top and calls the parent renderList() method.
        Parameters:
        out - MarkupOutput instance to modify with the transform's output. be rendered by this transform, as contents of the folder being analyzed.
        Throws:
        WebBeanException - if an error happens while rendering the information
        WebObjectsException - if an error happens while rendering the information
        Since:
        MicroStrategy Web 8.0.0

      • renderTemplateList

        public void renderTemplateList​(MarkupOutput out,
                               WebDisplayUnits list)
        Deprecated.
        Renders the list of templates in this folder. Basically just adds a message on the top and calls the parent renderList() method.
        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.

      • renderTemplateListContent

        public void renderTemplateListContent​(MarkupOutput out,
                                      WebDisplayUnits list)
        Deprecated.
        Renders the folder contents in a radio list button format.
        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.

      • 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 FolderRadioButtonTransform
        Parameters:
        out - MarkupOutput instance where to save the contents to display
        object - WebObjectInfo to be rendered.
        Since:
        MicroStrategy Web 8.0.0

      • renderNextButton

        public void renderNextButton​(MarkupOutput out)
        Deprecated.
        Extends renderNextButton() method by adding a checkbox to indicate if the user wants to run the report in design mode.
        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.
        Overrides:
        renderNextButton in class FolderRadioButtonTransform
        Parameters:
        out - MarkupOutput instance to modify with the transform's output.

      • isObjectVisible

        public boolean isObjectVisible​(WebObjectInfo object)
        Deprecated.
        Extends isObjectVisible() by returning false if the object is the blank report. We don't want to display this object as part of the template list since it has already been rendered by its own.
        Overrides:
        isObjectVisible in class AbstractFolderTransform
        Parameters:
        object - WebObjectInfo instance to check for.
        Returns:
        True if object requested is visible, otherwise returns False

      • renderTemplateListInputInfo

        protected void renderTemplateListInputInfo​(MarkupOutput out,
                                           WebEvent openEvent)
        Deprecated.
        Render any hidden input information that has to be added while displaying the contents for the method that takes care of the list of templates. 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
        Since:
        MicroStrategy Web 8.0.0

      • renderBlankObjectFormInputInfo

        protected void renderBlankObjectFormInputInfo​(MarkupOutput out,
                                              WebEvent createEvent,
                                              WebObjectInfo object)
        Deprecated.
        Render any hidden input information that has to be added while displaying the contents for the method that takes care of the blank report (renderBlankObject), 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
        createEvent - WebEvent representing the action to do with the given object
        object - WebObjectInfo currently being processed
        Since:
        MicroStrategy Web 8.0.0

      • renderDesignModeOption

        protected void renderDesignModeOption​(MarkupOutput out,
                                      WebEvent createEvent,
                                      boolean checked)
        Deprecated.
        Render a check box giving the option to have the report selected run in design mode. 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
        createEvent - WebEvent representing the action to do with the given object
        checked - boolean indicating if the check box to generate should be checked or not.