public class

ObjectBrowserTabReportWorkingSetTransform

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

Class Overview

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

Summary

[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 cssBold Class name for a WorkingSet element that is on the template
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
[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
ObjectBrowserTabReportWorkingSetTransform()
Default constructor, no arguments.
Public Methods
String getContextMenuManagerName()
Returns the name to use for the ContextMenuManager of this Transform.
String getDescription()
Returns the textual description of the transform
ReportFrameBean getFrame()
Class getSupportedBeanType()
Returns the supported bean type.
void initializeCss()
Initializes the Css Classes to use.
void initializeTransform(Transformable data)
Initializes transform formal parameters
boolean isDesignMode()
Returns true if this Transform is being used in the context of design-mode
void renderAttributeForm(MarkupOutput out, WebAttributeForm attForm, WebAttribute att, WebWorkingSet wSet)
Renders each attribute form
void renderAttributeForms(MarkupOutput out, WebObjectInfo objectInfo, WebWorkingSet wSet)
Renders the attribute forms for each attribute
void renderContextMenu(MarkupOutput out)
This method is deprecated. To customize context-menus use the xml-definition specified by contextMenus
void renderEditorContents(MarkupOutput out)
Method that renders the main contents of the transform, according to the information available on the bean.
void renderTreeEntry(MarkupOutput out, WebObjectInfo objectInfo, WebWorkingSet wSet)
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 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.
void renderTreeTableBodyHTML(MarkupOutput out)
Renders the working set contents of the report in HTML mode
void transformForRequestSuccessful(MarkupOutput out)
Transforms the assosciated TabBean when its status is WebBeanRequestSuccessful.
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 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.
String getTooltipTitle(WebObjectInfo obj, WebWorkingSet wSet)
To get the descriptor for the object depending on type and subtype
void renderJavascript(MarkupOutput out)
This method should be used by the Editor transforms to generate any javascript necessary.
[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

Fields

protected String cssBold

Class name for a WorkingSet element that is on the template

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

Public Constructors

public ObjectBrowserTabReportWorkingSetTransform ()

Default constructor, no arguments. Initialization of formal parameters done here

Public Methods

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

public String getDescription ()

Returns the textual description of the transform

Returns
  • the description of the transform

public ReportFrameBean getFrame ()

public Class getSupportedBeanType ()

Returns the supported bean type. This transform supports ReportWorkingSetBrowserTabBean 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 initializeTransform (Transformable data)

Initializes transform formal parameters

Parameters
data Transformable instance to be transformed by this class

public boolean isDesignMode ()

Returns true if this Transform is being used in the context of design-mode

Returns

public void renderAttributeForm (MarkupOutput out, WebAttributeForm attForm, WebAttribute att, WebWorkingSet wSet)

Renders each attribute form

Parameters
out MarkupOutput
attForm WebAttributeForm
att WebAttribute
wSet WebWorkingSet

public void renderAttributeForms (MarkupOutput out, WebObjectInfo objectInfo, WebWorkingSet wSet)

Renders the attribute forms for each attribute

Parameters
out MarkupOutput
objectInfo WebObjectInfo
wSet WebWorkingSet

public void renderContextMenu (MarkupOutput out)

This method is deprecated.
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 renderEditorContents (MarkupOutput out)

Method that renders the main contents of the transform, according to the information available on the bean.

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

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.

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

public void renderTreeTableBodyHTML (MarkupOutput out)

Renders the working set contents of the report in HTML mode

Parameters
out MarkupOutput

public void transformForRequestSuccessful (MarkupOutput out)

Transforms the assosciated TabBean when its status is WebBeanRequestSuccessful. Calls renderTabFrame()

Parameters
out MarkupOutput instance where the contents of this transform will be saved.

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
objectAlias String
wSet WebWorkingSet
item WebObjectInfo
Returns
  • String

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

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.

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 renderJavascript (MarkupOutput out)

This method should be used by the Editor transforms to generate any javascript necessary.
The default implementation includes a call to the ClientSideHelper to render the dynamic scrips and the registerBone call.

Parameters
out MarkupOutput where the output should be rendered.