Package com.microstrategy.web.app.transforms

Class ObjectBrowserTabReportWorkingSetTransform

  • All Implemented Interfaces:
    AppTransform, Transform
    public class ObjectBrowserTabReportWorkingSetTransform
extends AbstractObjectBrowserTabTransform

    This Transform renders the Report objects (working set) tab of the report's object browser.

    Since:
    MicroStrategy Web 8.0.0

    • Field Detail

      • cssTree

        protected java.lang.String cssTree
        Class name for the DIV tag that contains all the tree elements of the working set

      • cssOpen

        protected java.lang.String cssOpen
        Class name for a tree element that is open

      • cssClosed

        protected java.lang.String cssClosed
        Class name for a WorkingSet element that is closed

      • cssBold

        protected java.lang.String cssBold
        Class name for a WorkingSet element that is on the template

    • Constructor Detail

      • ObjectBrowserTabReportWorkingSetTransform

        public ObjectBrowserTabReportWorkingSetTransform()
        Default constructor, no arguments. Initialization of formal parameters done here

    • Method Detail

      • initializeCss

        public void initializeCss()
        Initializes the Css Classes to use. For each one of the css classes to use, the prefix indicated on the formal parameter is added to the name of the class to use.
        Overrides:
        initializeCss in class AbstractAppTransform

      • getDescription

        public java.lang.String getDescription()
        Returns the textual description of the transform
        Returns:
        the description of the transform

      • isDesignMode

        public boolean isDesignMode()
        Returns true if this Transform is being used in the context of design-mode
        Returns:
        true if the corresponding ReportFrameBean is in design mode.
        Since:
        MicroStrategy Web 8.0.1

      • renderEditorContents

        public void renderEditorContents​(MarkupOutput out)
        Method that renders the main contents of the transform, according to the information available on the bean.
        Specified by:
        renderEditorContents in class AbstractEditorTransform
        Parameters:
        out - MarkupOutput instance where the HTML contents to render will be saved.

      • renderTreeTable

        public void renderTreeTable​(MarkupOutput out)
        Renders the framework for the list that will include the objects available based on the bean being analyzed. Calls renderTreeTableBody()
        Parameters:
        out - MarkupOutput instance where the HTML contents to render will be saved.

      • renderTreeTableBodyDHTML

        public void renderTreeTableBodyDHTML​(MarkupOutput out)
        For each one of the elements of the bean analyzed, renders their corresponding HTML for them to be shown on the list. Calls renderTreeEntry() for each one of the elements to render.
        Parameters:
        out - MarkupOutput instance where the HTML contents to render will be saved.

      • generateAnchor

        @Deprecated
protected AnchorTag generateAnchor​(WebEvent event)
        Deprecated.
        No longer needed since there are no Anchor tags in this transform anymore
        Overwrites the parent method by setting requested attributes
        Overrides:
        generateAnchor in class AbstractAppTransform
        Parameters:
        event - WebEvent instance base for creating the anchor
        Returns:
        AnchorTag intitialized instance with the information as provided

      • renderTreeEntry

        public void renderTreeEntry​(MarkupOutput out,
                            WebObjectInfo objectInfo,
                            WebWorkingSet wSet)
        Takes care of displaying the HTML for one single element on the list. Calls elementHasChildren() to find out if child objects need to be displayed, and renderChildrenElements() if there's any to include.
        Parameters:
        out - MarkupOutput instance where the HTML contents to render will be saved.
        objectInfo - current WebObjectInfo instance to include on the list
        wSet - WebWorkingSet instance of the report.

      • renderAttributeForms

        public void renderAttributeForms​(MarkupOutput out,
                                 WebObjectInfo objectInfo,
                                 WebWorkingSet wSet)
        Renders the attribute forms for each attribute
        Parameters:
        out - MarkupOutput
        objectInfo - WebObjectInfo
        wSet - WebWorkingSet

      • renderAttributeForm

        public void renderAttributeForm​(MarkupOutput out,
                                WebAttributeForm attForm,
                                WebAttribute att,
                                WebWorkingSet wSet)
        Renders each attribute form
        Parameters:
        out - MarkupOutput
        attForm - WebAttributeForm
        att - WebAttribute
        wSet - WebWorkingSet

      • getContextMenuManagerName

        public java.lang.String getContextMenuManagerName()
        Description copied from class: AbstractAppTransform
        Returns the name to use for the ContextMenuManager of this Transform. By default, it uses getID() + "_cmm". Transforms may override this method in case they need a different value.
        Overrides:
        getContextMenuManagerName in class AbstractAppTransform
        Since:
        MicroStrategy Web 8.0.1

      • renderContextMenu

        @Deprecated
public void renderContextMenu​(MarkupOutput out)
        Deprecated.
        To customize context-menus use the xml-definition specified by AbstractAppTransform.contextMenus
        Renders the context menu context to use in the transform For dataset: 'set as primary dataset', 'delete from document' For template unit: ' add to grouping' , 'add to section'
        Parameters:
        out - where to write the output of the method.

      • getObjectImageName

        protected java.lang.String getObjectImageName​(WebObjectInfo object)
        Utility method that helps giving the image name to use - based on the information available on the formal parameters - based on the the object type and/or subtype of the WebObjectInfo instance.
        Overrides:
        getObjectImageName in class AbstractObjectBrowserTabTransform
        Parameters:
        object - The WebObjectInfo for which it's image name is required.
        Returns:
        a String with the name of the image associated with the WebObjectInfo. If the type specified on the WebObjectInfo definition does not match the predefined list of styles, it looks then based on the subtype. If still not found, it will return a transparent image.

      • renderTreeTableBodyHTML

        public void renderTreeTableBodyHTML​(MarkupOutput out)
        Renders the working set contents of the report in HTML mode
        Parameters:
        out - MarkupOutput

      • generateTooltipInformation

        protected java.lang.String generateTooltipInformation​(java.lang.String objectAlias,
                                                      WebWorkingSet wSet,
                                                      WebObjectInfo item)
        Get the tooltip information for each object
        Parameters:
        item - WebObjectInfo
        wSet - WebWorkingSet
        objectAlias - String
        Returns:
        String

      • getTooltipTitle

        protected java.lang.String getTooltipTitle​(WebObjectInfo obj,
                                           WebWorkingSet wSet)
        To get the descriptor for the object depending on type and subtype
        Parameters:
        obj - WebObjectInfo
        wSet - WebWorkingSet
        Returns:
        String

      • getFrame

        public ReportFrameBean getFrame()
        Since:
        MicroStrategy Web 8.0.2