Package com.microstrategy.web.app.transforms

Class ObjectBrowserTabRWWorkingSetTransform

    • Field Detail

      • listStyle

        public FormalParameter listStyle
        Indicates any special style specifications for the HTML tag for the main list on the tab.

      • dataSetNewImage

        public FormalParameter dataSetNewImage
        Indicates the image to use when displaying the New Data Set button.
        The value to indicate should be a valid image file name, with any necessary path information not included already on the resourcesFolderImage application configuration parameter.

      • dataSetDeleteImage

        public FormalParameter dataSetDeleteImage
        Indicates the image to use when displaying the Delete Data Set button.
        The value to indicate should be a valid image file name, with any necessary path information not included already on the resourcesFolderImage application configuration parameter.

      • userDerivedMetricImage

        public FormalParameter userDerivedMetricImage
        Indicates the image to use when displaying an user's derived metric.
        The value to indicate should be a valid image file name, with any necessary path information not included already on the resourcesFolderImage application configuration parameter.

      • userSummaryMetricImage

        public FormalParameter userSummaryMetricImage
        Indicates the image to use when displaying an user's summary metric.
        The value to indicate should be a valid image file name, with any necessary path information not included already on the resourcesFolderImage application configuration parameter.

      • linkAttributeImage

        public FormalParameter linkAttributeImage
        Indicates the image to use when displaying a link attribute
        The value to indicate should be a valid image file name, with any necessary path information not included already on the resourcesFolderImage application configuration parameter.

      • showAttributeForms

        public FormalParameter showAttributeForms
        Formal Parameter: Indicates if attribute forms should be displayed or not

      • FP_LIST_STYLE

        public static final java.lang.String FP_LIST_STYLE
        Constant specifying the name of the formal parameter for listStyle. Value is listStyle.
        See Also:
        Constant Field Values

      • FP_DATASET_NEW_IMAGE

        public static final java.lang.String FP_DATASET_NEW_IMAGE
        Constant specifying the name of the formal parameter for defining the image for the button for New Data Set. Value is dataSetNewImage.
        See Also:
        Constant Field Values

      • FP_DATASET_EDIT_IMAGE

        public static final java.lang.String FP_DATASET_EDIT_IMAGE
        Constant specifying the name of the formal parameter for defining the image for the button for Edit Data Set. Value is dataSetEditImage.
        See Also:
        Constant Field Values

      • FP_DATASET_DELETE_IMAGE

        public static final java.lang.String FP_DATASET_DELETE_IMAGE
        Constant specifying the name of the formal parameter for defining the image for the button for Delete Data Set. Value is dataSetDeleteImage.
        See Also:
        Constant Field Values

      • FP_SHOW_ATTRIBUTE_FORMS

        public static final java.lang.String FP_SHOW_ATTRIBUTE_FORMS
        Constant specifying the name of the formal parameter for showAttributeForms. Value is showAttributeForms.
        See Also:
        Constant Field Values

      • FP_DATASET_USER_DERIVED_METRIC_IMAGE

        public static final java.lang.String FP_DATASET_USER_DERIVED_METRIC_IMAGE
        Constant specifying the name of the formal parameter for userDerivedMetricImage. Value is userDerivedMetricImage.
        See Also:
        Constant Field Values

      • FP_DATASET_USER_SUMMARY_METRIC_IMAGE

        public static final java.lang.String FP_DATASET_USER_SUMMARY_METRIC_IMAGE
        Constant specifying the name of the formal parameter for userSummaryMetricImage. Value is userSummaryMetricImage.
        See Also:
        Constant Field Values

      • FP_DATASET_LINK_ATTRIBUTE_IMAGE

        public static final java.lang.String FP_DATASET_LINK_ATTRIBUTE_IMAGE
        Constant specifying the name of the formal parameter for linkAttributeImage. Value is linkAttbuteImage.
        See Also:
        Constant Field Values

      • cssTreeTable

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

      • 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

    • Constructor Detail

      • ObjectBrowserTabRWWorkingSetTransform

        public ObjectBrowserTabRWWorkingSetTransform()
        Default constructor, no arguments. Initializes formal parameters.

    • Method Detail

      • renderEditorContents

        public void renderEditorContents​(MarkupOutput out)
        Method that renders the main contents of the transform, according to the information available on the bean. This method can be customized if users would like to obtain a different output for the same given bean. Calls renderToolbar() and renderTreeTable().
        Specified by:
        renderEditorContents in class AbstractEditorTransform
        Parameters:
        out - MarkupOutput instance where the HTML contents to render will be saved.

      • renderToolbar

        public void renderToolbar​(MarkupOutput out)
        Render a basic toolbar that enables executing actions on the objects here displayed.
        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.

      • generateAnchor

        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

      • renderTreeTableBody

        public void renderTreeTableBody​(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.

      • renderTreeUserMetricEntry

        public void renderTreeUserMetricEntry​(MarkupOutput out,
                                      RWUserMetric userMetric,
                                      int key,
                                      java.lang.String dsId)
        Takes care of displaying the HTML for one single User Metric on the list.
        Parameters:
        out - MarkupOutput instance where the HTML contents to render will be saved.
        userMetric - instance of RWUserMetric from where reading all necessary data
        key -
        dsId -

      • renderTreeEntry

        public void renderTreeEntry​(MarkupOutput out,
                            WebObjectInfo objectInfo,
                            WebObjectInfo parentObjectInfo,
                            RWDataSet dataSet)
        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
        dataSet - reference to the RWDataSet instance that it's being displayed.
        parentObjectInfo - reference to the parent WebObjectInfo. Used for attribute forms only.

      • renderDerivedAttributeTreeEntry

        public void renderDerivedAttributeTreeEntry​(MarkupOutput out,
                                            WebAttribute att,
                                            RWDataSet dataSet)
        render the derived attribute item in the list
        Parameters:
        out - MarkupOutput instance where the HTML contents to render will be saved.
        att - WebAttribute instance corresponding to derived attribute.
        dataSet - reference to the RWDataSet instance that it's being displayed.

      • isTransformEnabled

        public boolean isTransformEnabled()
        Indicates if the transform can be performed for the current state of the bean. If there's a case where the bean might be ready but the information it gets does not match what the transform expects, the rendering process might be stopped here. The outcome will be the component not being rendered at all (which can be logged as a warning for future investigation).
        Overrides:
        isTransformEnabled in class AbstractObjectBrowserTabTransform
        Returns:
        True if it's possible to use the transform for rendering the bean. Otherwise, returns False

      • elementHasChildren

        public boolean elementHasChildren​(WebObjectInfo objectInfo)
        Analyzes the WebObjectInfo instance and based on its type and/or subtype, it determines if this transform is configured for displaying its children or not. For example: if it's a report, it will return true since metrics, attributes and other components might be displayed.
        Parameters:
        objectInfo - WebObjectInfo to check if it has children to display or not
        Returns:
        True if the children of this object should be displayed, returns False otherwise.

      • renderChildrenElements

        public void renderChildrenElements​(MarkupOutput out,
                                   WebObjectInfo objectInfo,
                                   RWDataSet element)
        Once it is determined that the WebObjectInfo instance has children that this transform can render, this method will display them. Calls renderTreeEntry() for each one of the children to display
        Parameters:
        out - MarkupOutput instance where the HTML contents to render will be saved.
        objectInfo - current WebObjectInfo instance to included on the list, from where its children will be displayed
        element - reference to the RWDataSet instance that it's being displayed.

      • getDescription

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

      • initializeImages

        public void initializeImages()
        Initializes the name of the images to use on this transform's output. For each one of the images defined to be displayed, the resource folder information is added to its path and file name as specified on the formal parameters for the images.
        Overrides:
        initializeImages in class AbstractObjectBrowserTabTransform

      • 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

      • renderJavascript

        protected void renderJavascript​(MarkupOutput out)
        This method should be used by the Editor transforms to generate any javascript necessary.
        Overrides:
        renderJavascript in class AbstractEditorTransform
        Parameters:
        out - MarkupOutput where the output should be rendered.

      • getContextMenuManagerName

        protected 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

        public void renderContextMenu​(MarkupOutput out)
        Deprecated.
        This method is not used anymore and will be removed in future versions of the product. 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.

      • renderSummaryMetricMenu

        protected void renderSummaryMetricMenu​(ContextMenuManager cmm,
                                       ContextMenu menu,
                                       java.lang.String isMultiSelect)
        Deprecated.
        This method is not used anymore and will be removed in future versions of the product. To customize context-menus, use the xml-definition specified by AbstractAppTransform.contextMenus
        Renders context menun for allowing insertion of Summary metric.
        It'll render a context menu entry consisted of a submenu listing all supported derived metric formulas: Average, Maximum, Minimum, Standard Deviation, Variance, Sum/Total and Count.
        Parameters:
        cmm - ContextMenuManager Context menu helper or factory.
        menu - ContextMenu RMC context menu on dataset elements.
        isMultiSelect - JS function for determining whether or not there's a multiselection.

      • initHeightAndWidthFromPreferences

        protected void initHeightAndWidthFromPreferences()
        Initializes the _height and _width of this component from the bone dimesions retrieved from Preferences. The format of the preference is : id1:width:heigth@id2:width:height@....
        Overrides:
        initHeightAndWidthFromPreferences in class AbstractAppTransform

      • generateTooltipInformation

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

      • generateUserMetricTooltipInfo

        protected java.lang.String generateUserMetricTooltipInfo​(java.lang.String objectAlias,
                                                         RWUserMetric userMetric)
        Parameters:
        objectAlias - String
        userMetric - RWUserMetric
        Returns:
        String

      • getObjectImageName

        protected java.lang.String getObjectImageName​(WebObjectInfo object,
                                              RWDataSet dataSet)
        Since:
        MicroStrategy Web 9.0.0