public class

ObjectBrowserTabRWWorkingSetTransform

extends AbstractObjectBrowserTabTransform
java.lang.Object
   ↳ com.microstrategy.web.transform.AbstractTransform
     ↳ com.microstrategy.web.transform.AbstractLayoutTransform
       ↳ com.microstrategy.web.app.transforms.AbstractAppTransform
         ↳ com.microstrategy.web.app.transforms.AbstractEditorTransform
           ↳ com.microstrategy.web.app.transforms.AbstractObjectBrowserTabTransform
             ↳ com.microstrategy.web.app.transforms.ObjectBrowserTabRWWorkingSetTransform

Summary

Constants
String FP_DATASET_DELETE_IMAGE Constant specifying the name of the formal parameter for defining the image for the button for Delete Data Set.
String FP_DATASET_EDIT_IMAGE Constant specifying the name of the formal parameter for defining the image for the button for Edit Data Set.
String FP_DATASET_LINK_ATTRIBUTE_IMAGE Constant specifying the name of the formal parameter for linkAttributeImage.
String FP_DATASET_NEW_IMAGE Constant specifying the name of the formal parameter for defining the image for the button for New Data Set.
String FP_DATASET_USER_DERIVED_METRIC_IMAGE Constant specifying the name of the formal parameter for userDerivedMetricImage.
String FP_DATASET_USER_SUMMARY_METRIC_IMAGE Constant specifying the name of the formal parameter for userSummaryMetricImage.
String FP_LIST_STYLE Constant specifying the name of the formal parameter for listStyle.
String FP_SHOW_ATTRIBUTE_FORMS Constant specifying the name of the formal parameter for showAttributeForms.
[Expand]
Inherited Constants
From class com.microstrategy.web.app.transforms.AbstractObjectBrowserTabTransform
From class com.microstrategy.web.app.transforms.AbstractEditorTransform
From class com.microstrategy.web.app.transforms.AbstractAppTransform
Fields
protected String cssClosed Class name for a WorkingSet element that is closed
protected String cssOpen Class name for a tree element that is open
protected String cssTree Class name for the DIV tag that contains all the tree elements of the working set
protected String cssTreeTable Class name for the TABLE tag that contains all the tree elements of the working set
public FormalParameter dataSetDeleteImage Indicates the image to use when displaying the Delete Data Set button.
public FormalParameter dataSetNewImage Indicates the image to use when displaying the New Data Set button.
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.
public FormalParameter listStyle Indicates any special style specifications for the HTML tag for the main list on the tab.
public FormalParameter showAttributeForms Formal Parameter: Indicates if attribute forms should be displayed or not
public FormalParameter userDerivedMetricImage Indicates the image to use when displaying an user's derived metric.
public FormalParameter userSummaryMetricImage Indicates the image to use when displaying an user's summary metric.
[Expand]
Inherited Fields
From class com.microstrategy.web.app.transforms.AbstractObjectBrowserTabTransform
From class com.microstrategy.web.app.transforms.AbstractEditorTransform
From class com.microstrategy.web.app.transforms.AbstractAppTransform
Public Constructors
ObjectBrowserTabRWWorkingSetTransform()
Default constructor, no arguments.
Public Methods
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.
String getDescription()
Returns the textual description of the transform
Class getSupportedBeanType()
Returns the supported bean type.
void initializeCss()
Initializes the Css Classes to use.
void initializeImages()
Initializes the name of the images to use on this transform's output.
void initializeTransform(Transformable data)
Initializes transform formal parameters
boolean isTransformEnabled()
Indicates if the transform can be performed for the current state of the bean.
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.
void renderContextMenu(MarkupOutput out)
This method is 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 contextMenus
void renderDerivedAttributeFormTreeEntry(MarkupOutput out, WebAttributeForm form, WebAttribute att, RWDataSet dataSet)
render the form item of derived attribute in the list
void renderDerivedAttributeTreeEntry(MarkupOutput out, WebAttribute att, RWDataSet dataSet)
render the derived attribute item in the list
void renderEditorContents(MarkupOutput out)
Method that renders the main contents of the transform, according to the information available on the bean.
void renderToolbar(MarkupOutput out)
Render a basic toolbar that enables executing actions on the objects here displayed.
void renderTreeEntry(MarkupOutput out, WebObjectInfo objectInfo, RWDataSet element)
Takes care of displaying the HTML for one single element on the list.
void renderTreeEntry(MarkupOutput out, WebObjectInfo objectInfo, WebObjectInfo parentObjectInfo, RWDataSet dataSet)
Takes care of displaying the HTML for one single element on the list.
void renderTreeTable(MarkupOutput out)
Renders the framework for the list that will include the objects available based on the bean being analyzed.
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.
void renderTreeUserMetricEntry(MarkupOutput out, RWUserMetric userMetric, int key, String dsId)
Takes care of displaying the HTML for one single User Metric on the list.
Protected Methods
AnchorTag generateAnchor(WebEvent event)
This method is deprecated. No longer needed since there are no Anchor tags in this transform anymore
String generateTooltipInformation(String objectAlias, WebWorkingSet wSet, WebObjectInfo item)
Get the tooltip information for each object
String generateUserMetricTooltipInfo(String objectAlias, RWUserMetric userMetric)
String getBeanPath()
Returns the path within the application of the WebBean being transformed.
String getContextMenuManagerName()
Returns the name to use for the ContextMenuManager of this Transform.
String getObjectImageName(WebObjectInfo object, RWDataSet dataSet)
String getTooltipTitle(WebObjectInfo obj, WebWorkingSet wSet)
To get the descriptor for the object depending on type and subtype
void initEditor(Editor editor)
Initialize the editor with the global settings.
void initHeightAndWidthFromPreferences()
Initializes the _height and _width of this component from the bone dimesions retrieved from Preferences.
void renderJavascript(MarkupOutput out)
This method should be used by the Editor transforms to generate any javascript necessary.
void renderSummaryMetricMenu(ContextMenuManager cmm, ContextMenu menu, String isMultiSelect)
This method is 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 contextMenus
[Expand]
Inherited Methods
From class com.microstrategy.web.app.transforms.AbstractObjectBrowserTabTransform
From class com.microstrategy.web.app.transforms.AbstractEditorTransform
From class com.microstrategy.web.app.transforms.AbstractAppTransform
From class com.microstrategy.web.transform.AbstractLayoutTransform
From class com.microstrategy.web.transform.AbstractTransform
From class java.lang.Object
From interface com.microstrategy.web.app.transforms.AppTransform
From interface com.microstrategy.web.transform.Transform

Constants

public static final 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.

Constant Value: "dataSetDeleteImage"

public static final 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.

Constant Value: "dataSetEditImage"

public static final String FP_DATASET_LINK_ATTRIBUTE_IMAGE

Constant specifying the name of the formal parameter for linkAttributeImage. Value is linkAttbuteImage.

Constant Value: "linkAttributeImage"

public static final 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.

Constant Value: "dataSetNewImage"

public static final String FP_DATASET_USER_DERIVED_METRIC_IMAGE

Constant specifying the name of the formal parameter for userDerivedMetricImage. Value is userDerivedMetricImage.

Constant Value: "userDerivedMetricImage"

public static final String FP_DATASET_USER_SUMMARY_METRIC_IMAGE

Constant specifying the name of the formal parameter for userSummaryMetricImage. Value is userSummaryMetricImage.

Constant Value: "userSummaryMetricImage"

public static final String FP_LIST_STYLE

Constant specifying the name of the formal parameter for listStyle. Value is listStyle.

Constant Value: "listStyle"

public static final String FP_SHOW_ATTRIBUTE_FORMS

Constant specifying the name of the formal parameter for showAttributeForms. Value is showAttributeForms.

Constant Value: "showAttributeForms"

Fields

protected String cssClosed

Class name for a WorkingSet element that is closed

protected String cssOpen

Class name for a tree element that is open

protected String cssTree

Class name for the DIV tag that contains all the tree elements of the working set

protected String cssTreeTable

Class name for the TABLE tag that contains all the tree elements of the working set

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.

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.

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.

public FormalParameter listStyle

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

public FormalParameter showAttributeForms

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

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.

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.

Public Constructors

public ObjectBrowserTabRWWorkingSetTransform ()

Default constructor, no arguments. Initializes formal parameters.

Public Methods

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.

public String getDescription ()

Returns the textual description of the transform

Returns
  • the description of the transform

public Class getSupportedBeanType ()

Returns the supported bean type. This transform supports RWWorkingSetBrowserTabBean instances

Returns
  • the class of the bean supported by this transform.

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.

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.

public void initializeTransform (Transformable data)

Initializes transform formal parameters

Parameters
data Transformable instance to be transformed.

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

Returns
  • True if it's possible to use the transform for rendering the bean. Otherwise, returns False

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.

public void renderContextMenu (MarkupOutput out)

This method is 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 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.

public void renderDerivedAttributeFormTreeEntry (MarkupOutput out, WebAttributeForm form, WebAttribute att, RWDataSet dataSet)

render the form item of derived attribute in the list

Parameters
out MarkupOutput instance where the HTML contents to render will be saved.
form WebAttributeForm instance to render.
att WebAttribute instance which has this form.
dataSet reference to the RWDataSet instance that it's being displayed.

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.

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().

Parameters
out MarkupOutput instance where the HTML contents to render will be saved.

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.

public void renderTreeEntry (MarkupOutput out, WebObjectInfo objectInfo, RWDataSet element)

Takes care of displaying the HTML for one single element on the list. Calls renderTreeEntry(MarkupOutput, WebObjectInfo, WebObjectInfo, RWDataSet)

Parameters
out MarkupOutput instance where the HTML contents to render will be saved.
objectInfo WebObjectInfo instance to include on the list
element reference to the RWDataSet instance that it's being displayed.

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
parentObjectInfo reference to the parent WebObjectInfo. Used for attribute forms only.
dataSet reference to the RWDataSet instance that it's being displayed.

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.

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.

public void renderTreeUserMetricEntry (MarkupOutput out, RWUserMetric userMetric, int key, 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

Protected Methods

protected AnchorTag generateAnchor (WebEvent event)

This method is deprecated.
No longer needed since there are no Anchor tags in this transform anymore

Overwrites the parent method by setting requested attributes

Parameters
event WebEvent instance base for creating the anchor
Returns
  • AnchorTag intitialized instance with the information as provided

protected String generateTooltipInformation (String objectAlias, WebWorkingSet wSet, WebObjectInfo item)

Get the tooltip information for each object

Parameters
wSet WebWorkingSet
item WebObjectInfo
Returns
  • String

protected String generateUserMetricTooltipInfo (String objectAlias, RWUserMetric userMetric)

Parameters
objectAlias String
userMetric RWUserMetric
Returns
  • String

protected String getBeanPath ()

Returns the path within the application of the WebBean being transformed.
When submitting an WebEvent, this path allows Microstrategy Web to uniquely identify the location of the bean that needs to handle the event.
This method is used by the renderRegisterBone method to inform the javascript bone the bean to whom it should send its server-side requests.

Returns
  • String

protected String getContextMenuManagerName ()

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.

protected String getObjectImageName (WebObjectInfo object, RWDataSet dataSet)

protected 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

protected void initEditor (Editor editor)

Initialize the editor with the global settings.

Parameters
editor Editor instance to initialize

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

protected void renderJavascript (MarkupOutput out)

This method should be used by the Editor transforms to generate any javascript necessary.

Parameters
out MarkupOutput where the output should be rendered.

protected void renderSummaryMetricMenu (ContextMenuManager cmm, ContextMenu menu, String isMultiSelect)

This method is 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 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.