public class

RWLayoutTransform

extends AbstractRWTransform
implements RWBeanVisitor2
java.lang.Object
   ↳ com.microstrategy.web.transform.AbstractTransform
     ↳ com.microstrategy.web.transform.AbstractLayoutTransform
       ↳ com.microstrategy.web.app.transforms.AbstractAppTransform
         ↳ com.microstrategy.web.app.transforms.AbstractWebBeanTransform
           ↳ com.microstrategy.web.app.transforms.AbstractRWTransform
             ↳ com.microstrategy.web.app.transforms.RWLayoutTransform
Known Direct Subclasses
Known Indirect Subclasses

Class Overview

This transform displays the data of a Report Writing Document. It implements the RWBeanVisitor to iterate through the RWData and provides individual methods to render sections, subsections and objects.

Summary

Nested Classes
class RWLayoutTransform.ButtonHelper  
Constants
String FP_CLIENT_SIDE_DESIGN_MODE_TEMPLATE_MANIPULATIONS Constant specifying whether to use client-side template manipulations in design mode.
String FP_CUSTOM_JS_FEATURES Constant specifying any extra features that will be send down to the client.
String FP_DPI_CONVERSION Constant specifying the spi conversion mode between pixels and inches.
String FP_GRAPH_TEMPLATES_DESIGN_STYLE
String FP_GRAPH_TEMPLATES_STYLE Constant specifying the name of the formal parameter for defining the graph style to use with templates.
String FP_GRID_DENSITY Constant specifying the alignment grid density.
String FP_GRID_TEMPLATES_DESIGN_STYLE Constant specifying the name of the formal parameter for defining the grid style to use with templates when the template is in design mode and the RW document is in view mode.
String FP_GRID_TEMPLATES_STYLE Constant specifying the name of the formal parameter for defining the grid style to use with templates.
String FP_IMG_COLLAPSE Constant specifying the name of the formal parameter for metrics unit to used with the rulers.
String FP_IMG_EXPAND Constant specifying the name of the formal parameter for metrics unit to used with the rulers.
String FP_IS_HTML_EXPORT
String FP_IS_VIEW_MODE_ONLY name for the formal parameter "promptsEditStyle".
String FP_JS_PREFIX Constant specifying the name of the formal parameter for javascript object's ids prefix.
String FP_LEVEL_FLAG Constant specifying the name of the formal parameter for defining the level flag.
String FP_MARQUEE_STYLE Constant specifying the marquee selection style.
String FP_METRICS_UNIT Constant specifying the name of the formal parameter for metrics unit to used with the rulers.
String FP_OUTLINE_GRID_TEMPLATES_STYLE Constant specifying the name of the formal parameter for defining the grid style to use with templates when the template is in outline mode.
String FP_PROMPTS_CREATE_RW_DATASET_STYLE name for the formal parameter "promptsCreateRWDatasetStyle".
String FP_PROMPTS_EDIT_STYLE name for the formal parameter "promptsEditStyle".
String FP_PROMPTS_EXECUTE_RW_DATASET_STYLE
String FP_PROMPTS_EXECUTE_STYLE name for the formal parameter "promptsExecuteStyle".
String FP_RWD_DROPZONE_STYLE_NAME name for the formal parameter "RWDZStyleName".
String FP_UNITS Constant specifying the alignment grid density.
String ID_POSTFIX
int LEVEL_ALL Allowed value for the levelFlag formal parameter.
int LEVEL_HRULER Allowed value for the levelFlag formal parameter.
int LEVEL_SECTION_TITLE Allowed value for the levelFlag formal parameter.
int LEVEL_SUBSECTION_HANDLE Allowed value for the levelFlag formal parameter.
int LEVEL_VRULER Allowed value for the levelFlag formal parameter.
[Expand]
Inherited Constants
From class com.microstrategy.web.app.transforms.AbstractAppTransform
Fields
protected FormalParameter RWDZStyleName Indicates the style name of the Drop Zone Editor
protected String _jsPage
protected FormalParameter customJavaScriptFeatures Indicates a comma separated list of the extra features that will be send down to the client
protected FormalParameter dpiConversion name for the formal parameter "dpiConversion".
protected FormalParameter graphTemplatesDesignStyle
protected FormalParameter graphTemplatesStyle Indicates the graph style to use when rendering GridGraph objects.
protected FormalParameter gridDensity name for the formal parameter "gridDensity".
protected FormalParameter gridTemplatesDesignStyle Indicates the grid style to use when rendering Grid objects in design mode when the RW document is in view mode.
protected FormalParameter gridTemplatesStyle Indicates the grid style to use when rendering Grid objects.
protected FormalParameter imgCollapse Specifies the image file name used by the transform to display a collapsable section.
protected FormalParameter imgExpand Specifies the image file name used by the transform to display an expandable section.
protected FormalParameter isHTMLExport
protected FormalParameter isViewModeOnly This field is deprecated. use useDHTML
protected FormalParameter jsPrefix Prefix to append to all javascript object's ids.
protected FormalParameter levelFlag Indicates the level of information to use when displaying the Transform.
protected FormalParameter marqueeSelectionStyle name for the formal parameter "gridDensity".
protected FormalParameter metricsUnit Indicates the metrics unit to use for the rulers.
protected FormalParameter outlineGridTemplatesStyle Indicates the graph style to use when rendering Grid objects in outline mode.
protected FormalParameter promptsCreateRWDatasetStyle This is the name of the style to use to transform a prompted report writer document (from the Create Document page or when a prompted dataset is added).
protected FormalParameter promptsEditStyle This is the name of the style to use to transform a prompted grid when editing reports.
protected FormalParameter promptsExecuteRWDatasetStyle This is the name of the style to use to transform a prompted report writer document (when a prompted dataset is added).
protected FormalParameter promptsExecuteStyle This is the name of the style to use to transform a prompted grid when normal report execution.
protected FormalParameter units name for the formal parameter "units".
protected FormalParameter useClientSideManipulations name for the formal parameter "useClientSideManipulations".
[Expand]
Inherited Fields
From class com.microstrategy.web.app.transforms.AbstractRWTransform
From class com.microstrategy.web.app.transforms.AbstractAppTransform
Public Constructors
RWLayoutTransform()
Default, no argument constructor.
Public Methods
Map getAttributesShellDiv()
Returns a Map with the list of attributes that the shell div must use.
int getCurrentSliceId(String key)
String getDescription()
Display's the description of this transform for StyleCatalog
final static String[] getFeaturesList()
HashList getHyperLinks()
String getID()
TQMS 372960 This method overwrites the super implementation of the getID() so that the id of the shell div of the rwb_viewer, or the id that contains the rwb_viewer shell stays the same when adding prompted datasets.
Class getSupportedBeanType()
Returns the BeanType supported by this bean.
Iterator<WebHyperLinkContainer> getWebHyperLinks()
boolean hasCharts()
void initializeCss()
Extends initializeCss() by initializing private css classes used by this transform.
void initializeImages()
Initialize the images to be used by this transform.
void initializeTransform(Transformable data)
Extends initializeTransform(com.microstrategy.web.beans.Transformable) by obtaining a reference to the data
boolean isContextMenusEnabled()
Indicates whether context-menus are enabled for this Transform.
boolean isCurrentPanel(RWSection section)
boolean isDhtml()
Determine if the environment where this transform instance is being used is DHTML or not
boolean isIFrameDisplayMode()
Determines if the display mode should consider iframe request or not.
void onEnd(MarkupOutput out)
Callback used by RWVisitor for the end of the document.
void onEndSection(RWSection section, MarkupOutput out)
Callback used by RWVisitor to end a Section.
void onEndSubsection(RWSection section, MarkupOutput out, boolean borderedSubsection)
Callback used by RWVisitor to end a subsection.
void onObject(ViewBean viewBean, RWObject ob, MarkupOutput out)

Specific case where RWObject#getDefinition().getType == EnumRWUnitTypes.RWUNIT_GRIDGRAPH The corresponding data value is encapsulated in a ViewBean for ease of use.

void onObject(RWObject object, MarkupOutput out)
Callback used by RWVisitor for individual objects.
void onObject(RWBean rwBean, RWObject ob, MarkupOutput out)
This method is implemented as part of the interface, but it actually does not renders sub
void onStart(RWDefinition definition, MarkupOutput out)
Callback used by RWVisitor for the start of the document.
void onStartSection(RWSection section, MarkupOutput out)
Callback used by RWVisitor for a new Section.
void onStartSubsection(RWSection section, MarkupOutput out)
Callback used by RWVisitor for a new SubSection.
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 renderControlTitleBar(MarkupOutput out, RWObject object)
void renderDashboardControl(MarkupOutput out, RWObject control)
void renderGoverningMessage(MarkupOutput out)
Renders a message in the page indicated the document has exceeded the limits of xml creation in the intelligence server.
void renderGrid(MarkupOutput out, RWObject object, ViewBean grid)
void renderGridCss(MarkupOutput out)
void renderHRuler(MarkupOutput out)
void renderHTMLContainer(MarkupOutput out, RWObject htmlContainer)
void renderHorizontalContainerHandle(MarkupOutput out)
void renderImage(MarkupOutput out, String image)
Renders a transform's image
void renderImage(MarkupOutput out, RWObject image)
void renderLine(MarkupOutput out, RWObject line)
void renderPanelEnd(MarkupOutput out, RWSection section)
void renderPanelStackEnd(MarkupOutput out, RWSection section)
void renderPanelStackStart(MarkupOutput out, RWSection section)
void renderPanelStackTitleBar(MarkupOutput out, RWObject object)
void renderPanelStart(MarkupOutput out, RWSection section)
void renderPartialBoneProperties(MarkupOutput out)
void renderPlaceFolder(RWObject object, MarkupOutput out)
void renderRegisterBone(MarkupOutput out)
If a scriptClass is specified, this method registers the corresponding javascript bone for this component.
void renderRulerStyle(MarkupOutput out)
void renderSectionEnd(MarkupOutput out, RWSection section)
void renderSectionStart(MarkupOutput out, RWSection section)
void renderSectionTitle(MarkupOutput out, RWSection section)
void renderShape(MarkupOutput out, RWObject shape)
void renderShell(MarkupOutput out)

Generates the shell for this Transform.

void renderSubsectionEnd(MarkupOutput out, RWSection section)
This method is deprecated. This method has been deprecated. Insted use the method renderSubsectionEnd(MarkupOutput out, RWSection section, boolean renderSubsectionDivider)
void renderSubsectionEnd(MarkupOutput out, RWSection section, boolean renderSubsectionDivider)
void renderSubsectionHandle(MarkupOutput out, RWSection section)
void renderSubsectionStart(MarkupOutput out, RWSection section)
void renderText(MarkupOutput out, RWObject label)
void renderTitleBar(MarkupOutput out, RWObject object)
void renderTitleBar(MarkupOutput out, RWObject object, boolean isGridEmpty)
void renderVRuler(MarkupOutput out, RWSection section)
void startIteration(MarkupOutput out, String key, boolean definitionOnly)
Starts iterating the data, by invoking rwi.iterate();
void startIteration(MarkupOutput out, boolean definitionOnly)
Starts iterating the data, by invoking rwi.iterate();
void startIteration(RWBeanVisitor visitor, MarkupOutput out, String key, boolean definitionOnly)
Starts iterating the data, by invoking rwi.iterate();
void transformForPartialDisplay(MarkupOutput out)
void transformForRequestSuccessful(MarkupOutput out)
Generates the output when the bean's status is WebBeanRequestSuccessful.
void transformForRequestWaitingForUserInput(MarkupOutput out)
Method that generates the output when the bean is WaitingForUserInput.
Protected Methods
void addStyleRule(String key)
String getBeanPath()
Returns the path within the application of the WebBean being transformed.
String getBeanXml()
Returns the Bean's xml.
String getBoneId()
Returns the id to be used for the JavaScript bone.
String getContextMenuManagerName()
Returns the name to use for the ContextMenuManager of this Transform.
int getDpiConversion()
JsonGenerator getFeatures()
Locale getLocale()
Returns number/date locale.
int getNextId()
Returns the next integer to use as objectId for new objects
TransformInstance getPromptsTransform(RWBean rw)
TransformInstance getReportGraphTransform(RWObject object, ViewBean vb)
TransformInstance getReportGridTransform(RWObject object, ViewBean vb)
TransformInstance getReportOutlineGridTransform(RWObject object, ViewBean vb)
TransformInstance getReportVisualizationTransform(RWObject object, ViewBean vb)
int getZoomFactor()
void initializeJavascript()
void renderClipboardGrid(MarkupOutput out, RWObject object)
void renderGrid(MarkupOutput out, RWObject object, ViewBean grid, boolean isDormantBone)
void setupOndemandContextMenuModelView(MarkupOutput out)
Sets up the context menu model and view for ondemand loading of context menu items and renders in the Markupoutput
void updateGridVisualizationTransform(RWObject object, ViewBean vb, TransformInstance ti)
Add necessary formal parameters to the Grid Visualization transform
[Expand]
Inherited Methods
From class com.microstrategy.web.app.transforms.AbstractRWTransform
From class com.microstrategy.web.app.transforms.AbstractWebBeanTransform
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.beans.RWBeanVisitor
From interface com.microstrategy.web.beans.RWBeanVisitor2
From interface com.microstrategy.web.transform.Transform

Constants

public static final String FP_CLIENT_SIDE_DESIGN_MODE_TEMPLATE_MANIPULATIONS

Constant specifying whether to use client-side template manipulations in design mode.

Constant Value: "useClientSideManipulations"

public static final String FP_CUSTOM_JS_FEATURES

Constant specifying any extra features that will be send down to the client.

Constant Value: "customJavaScriptFeatures"

public static final String FP_DPI_CONVERSION

Constant specifying the spi conversion mode between pixels and inches.

Constant Value: "dpiConversion"

public static final String FP_GRAPH_TEMPLATES_DESIGN_STYLE

Constant Value: "graphTemplatesDesignStyle"

public static final String FP_GRAPH_TEMPLATES_STYLE

Constant specifying the name of the formal parameter for defining the graph style to use with templates. Value is templatesStyle.

Constant Value: "graphTemplatesStyle"

public static final String FP_GRID_DENSITY

Constant specifying the alignment grid density.

Constant Value: "gridDensity"

public static final String FP_GRID_TEMPLATES_DESIGN_STYLE

Constant specifying the name of the formal parameter for defining the grid style to use with templates when the template is in design mode and the RW document is in view mode. Value is gridTemplatesDesignStyle.

Constant Value: "gridTemplatesDesignStyle"

public static final String FP_GRID_TEMPLATES_STYLE

Constant specifying the name of the formal parameter for defining the grid style to use with templates. Value is templatesStyle.

Constant Value: "gridTemplatesStyle"

public static final String FP_IMG_COLLAPSE

Constant specifying the name of the formal parameter for metrics unit to used with the rulers.

Constant Value: "imgCollapse"

public static final String FP_IMG_EXPAND

Constant specifying the name of the formal parameter for metrics unit to used with the rulers.

Constant Value: "imgExpand"

public static final String FP_IS_HTML_EXPORT

Constant Value: "isHTMLExport"

public static final String FP_IS_VIEW_MODE_ONLY

name for the formal parameter "promptsEditStyle".

Constant Value: "isViewModeOnly"

public static final String FP_JS_PREFIX

Constant specifying the name of the formal parameter for javascript object's ids prefix.

Constant Value: "jsPrefix"

public static final String FP_LEVEL_FLAG

Constant specifying the name of the formal parameter for defining the level flag. Value is levelFlag.

Constant Value: "levelFlag"

public static final String FP_MARQUEE_STYLE

Constant specifying the marquee selection style.

Constant Value: "marqueeSelectionStyle"

public static final String FP_METRICS_UNIT

Constant specifying the name of the formal parameter for metrics unit to used with the rulers.

Constant Value: "metricsUnit"

public static final String FP_OUTLINE_GRID_TEMPLATES_STYLE

Constant specifying the name of the formal parameter for defining the grid style to use with templates when the template is in outline mode. Value is outlineGridTemplatesStyle.

Constant Value: "outlineGridTemplatesStyle"

public static final String FP_PROMPTS_CREATE_RW_DATASET_STYLE

name for the formal parameter "promptsCreateRWDatasetStyle".

Constant Value: "promptsCreateRWDatasetStyle"

public static final String FP_PROMPTS_EDIT_STYLE

name for the formal parameter "promptsEditStyle".

Constant Value: "promptsEditStyle"

public static final String FP_PROMPTS_EXECUTE_RW_DATASET_STYLE

Constant Value: "promptsExecuteRWDatasetStyle"

public static final String FP_PROMPTS_EXECUTE_STYLE

name for the formal parameter "promptsExecuteStyle".

Constant Value: "promptsExecuteStyle"

public static final String FP_RWD_DROPZONE_STYLE_NAME

name for the formal parameter "RWDZStyleName".

Constant Value: "RWDZStyleName"

public static final String FP_UNITS

Constant specifying the alignment grid density.

Constant Value: "units"

protected static final String ID_POSTFIX

Constant Value: "_shell"

public static final int LEVEL_ALL

Allowed value for the levelFlag formal parameter. Convenience flag to indicate all possible LEVEL values.
value 16777215

Constant Value: -1 (0xffffffff)

public static final int LEVEL_HRULER

Allowed value for the levelFlag formal parameter. Specifies that the transform will display the horizontal ruler for each subsection.
value 2

Constant Value: 2 (0x00000002)

public static final int LEVEL_SECTION_TITLE

Allowed value for the levelFlag formal parameter. Specifies that the transform will display the title of each section.
value 4

Constant Value: 4 (0x00000004)

public static final int LEVEL_SUBSECTION_HANDLE

Allowed value for the levelFlag formal parameter. Specifies that the transform will display the handle of each subsections.
value 8

Constant Value: 8 (0x00000008)

public static final int LEVEL_VRULER

Allowed value for the levelFlag formal parameter. Specifies that the transform will display the vertical ruler for each subsection.
value 1

Constant Value: 1 (0x00000001)

Fields

protected FormalParameter RWDZStyleName

Indicates the style name of the Drop Zone Editor

protected String _jsPage

protected FormalParameter customJavaScriptFeatures

Indicates a comma separated list of the extra features that will be send down to the client

protected FormalParameter dpiConversion

name for the formal parameter "dpiConversion".

protected FormalParameter graphTemplatesDesignStyle

protected FormalParameter graphTemplatesStyle

Indicates the graph style to use when rendering GridGraph objects.

protected FormalParameter gridDensity

name for the formal parameter "gridDensity".

protected FormalParameter gridTemplatesDesignStyle

Indicates the grid style to use when rendering Grid objects in design mode when the RW document is in view mode. This will be used when the RW document is in view mode and the user decides to add a grid object to the RW document. In this case we will render the grid in design mode with no data unless we go back to the server to get the data.

protected FormalParameter gridTemplatesStyle

Indicates the grid style to use when rendering Grid objects.

protected FormalParameter imgCollapse

Specifies the image file name used by the transform to display a collapsable section.
It is used to collapse the contents of the section when its children are displayed.
This image should be contained in the images folder of the application.
Usage:
For example, if you want to specify a different image to display the collapsable section, you would need to copy it to the images folder and then specify its name in this formal parameter.

protected FormalParameter imgExpand

Specifies the image file name used by the transform to display an expandable section.
It is used to expand the contents of the section by showing its children.
This image should be contained in the images folder of the application.
Usage:
For example, if you want to specify a different image to display the expandable section, you would need to copy it to the images folder and then specify its name in this formal parameter.

protected FormalParameter isHTMLExport

protected FormalParameter isViewModeOnly

This field is deprecated.
use useDHTML

Indicates the only available mode for the document will be HTML view mode.

protected FormalParameter jsPrefix

Prefix to append to all javascript object's ids.

protected FormalParameter levelFlag

Indicates the level of information to use when displaying the Transform. For indicating which fields to show, the value to assign to this formal parameter should be a bitwise flag combining constants such as LEVEL_VRULER, LEVEL_HRULER, LEVEL_SECTION_TITLE, etc.
value #LEVEL_ALL

protected FormalParameter marqueeSelectionStyle

name for the formal parameter "gridDensity".

protected FormalParameter metricsUnit

Indicates the metrics unit to use for the rulers. Possible values are "in" for inches, "px" for pixels, "cm" for cetimeters value "in"

protected FormalParameter outlineGridTemplatesStyle

Indicates the graph style to use when rendering Grid objects in outline mode.

protected FormalParameter promptsCreateRWDatasetStyle

This is the name of the style to use to transform a prompted report writer document (from the Create Document page or when a prompted dataset is added).
In this case, the cancel and save buttons should not be displayed in the prompt page.

protected FormalParameter promptsEditStyle

This is the name of the style to use to transform a prompted grid when editing reports.
Allowed Values: any report style name from StyelCatalog.xml file.

protected FormalParameter promptsExecuteRWDatasetStyle

This is the name of the style to use to transform a prompted report writer document (when a prompted dataset is added).
In this case, the cancel and save buttons should not be displayed in the prompt page.

protected FormalParameter promptsExecuteStyle

This is the name of the style to use to transform a prompted grid when normal report execution.
Allowed Values: any report style name from StyelCatalog.xml file.

protected FormalParameter units

name for the formal parameter "units".

protected FormalParameter useClientSideManipulations

name for the formal parameter "useClientSideManipulations".

Public Constructors

public RWLayoutTransform ()

Default, no argument constructor.

Public Methods

public Map getAttributesShellDiv ()

Returns a Map with the list of attributes that the shell div must use. The shell is the main div surrounding the Transform's output.
This method can be overriden in case the subclass would like to add or change the value of attributes in the shell.

public int getCurrentSliceId (String key)

public String getDescription ()

Display's the description of this transform for StyleCatalog

Returns
  • This transform displays the data of a Report Writing Document.

public static final String[] getFeaturesList ()

Returns
  • a copy of the features String array that is sent to the RW execution page

public HashList getHyperLinks ()

public String getID ()

TQMS 372960 This method overwrites the super implementation of the getID() so that the id of the shell div of the rwb_viewer, or the id that contains the rwb_viewer shell stays the same when adding prompted datasets. The original issue happens because in design mode, it was rwbDocumentDesignStyle, but after adding a prompeted dataset it changes to rwbDocumentViewStyle

Returns
  • the component's unique id

public Class getSupportedBeanType ()

Returns the BeanType supported by this bean. (non-Javadoc)

Returns
  • RWBean.class

public Iterator<WebHyperLinkContainer> getWebHyperLinks ()

public boolean hasCharts ()

public void initializeCss ()

Extends initializeCss() by initializing private css classes used by this transform.

public void initializeImages ()

Initialize the images to be used by this transform.

public void initializeTransform (Transformable data)

Extends initializeTransform(com.microstrategy.web.beans.Transformable) by obtaining a reference to the data

Parameters
data The bean to transform.

public boolean isContextMenusEnabled ()

Indicates whether context-menus are enabled for this Transform. By default context-menus are enabled only if the contextMenus formal parameter has been set.

Returns
  • true if context-menus are enabled in this Transform.

public boolean isCurrentPanel (RWSection section)

public boolean isDhtml ()

Determine if the environment where this transform instance is being used is DHTML or not

Returns
  • boolean value indicating the environment is DHTML or not.

public boolean isIFrameDisplayMode ()

Determines if the display mode should consider iframe request or not. A sample application of this logic will be to determine if the COMMENT HTML tags have to be generated in order for the response to be processed correctly by the iframe in the page. If the logic is to be specialized for the application, please overwrite localIsIFrameDisplayMode().

Returns
  • boolean value indicating if the display mode of this transform should be generated for iframe manipulation or not

public void onEnd (MarkupOutput out)

Callback used by RWVisitor for the end of the document.

Parameters
out markup output

public void onEndSection (RWSection section, MarkupOutput out)

Callback used by RWVisitor to end a Section.

public void onEndSubsection (RWSection section, MarkupOutput out, boolean borderedSubsection)

Callback used by RWVisitor to end a subsection.

Parameters
section the subsection before the border.
out the markup output.

public void onObject (ViewBean viewBean, RWObject ob, MarkupOutput out)

Specific case where RWObject#getDefinition().getType == EnumRWUnitTypes.RWUNIT_GRIDGRAPH The corresponding data value is encapsulated in a ViewBean for ease of use.

Parameters
viewBean an embedded bean.
ob the report writing document object.
out the markup output.

public void onObject (RWObject object, MarkupOutput out)

Callback used by RWVisitor for individual objects.

Parameters
object the report writing document object.
out the markup output.

public void onObject (RWBean rwBean, RWObject ob, MarkupOutput out)

This method is implemented as part of the interface, but it actually does not renders sub

Parameters
rwBean an embedded bean.
ob the report writing document object.
out the markup output.

public void onStart (RWDefinition definition, MarkupOutput out)

Callback used by RWVisitor for the start of the document.

Parameters
definition document definition
out markup output

public void onStartSection (RWSection section, MarkupOutput out)

Callback used by RWVisitor for a new Section.

public void onStartSubsection (RWSection section, MarkupOutput out)

Callback used by RWVisitor for a new SubSection.

Parameters
section subsection
out markup output

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

Parameters
out where to write the output of the method.

public void renderControlTitleBar (MarkupOutput out, RWObject object)

public void renderDashboardControl (MarkupOutput out, RWObject control)

public void renderGoverningMessage (MarkupOutput out)

Renders a message in the page indicated the document has exceeded the limits of xml creation in the intelligence server.

public void renderGrid (MarkupOutput out, RWObject object, ViewBean grid)

public void renderGridCss (MarkupOutput out)

public void renderHRuler (MarkupOutput out)

public void renderHTMLContainer (MarkupOutput out, RWObject htmlContainer)

public void renderHorizontalContainerHandle (MarkupOutput out)

public void renderImage (MarkupOutput out, String image)

Renders a transform's image

Parameters
out where to write the output of the method.
image the image name

public void renderImage (MarkupOutput out, RWObject image)

public void renderLine (MarkupOutput out, RWObject line)

public void renderPanelEnd (MarkupOutput out, RWSection section)

public void renderPanelStackEnd (MarkupOutput out, RWSection section)

public void renderPanelStackStart (MarkupOutput out, RWSection section)

public void renderPanelStackTitleBar (MarkupOutput out, RWObject object)

public void renderPanelStart (MarkupOutput out, RWSection section)

public void renderPartialBoneProperties (MarkupOutput out)

public void renderPlaceFolder (RWObject object, MarkupOutput out)

public void renderRegisterBone (MarkupOutput out)

If a scriptClass is specified, this method registers the corresponding javascript bone for this component.

Parameters
out MarkupOutput whether the output should be rendered.

public void renderRulerStyle (MarkupOutput out)

public void renderSectionEnd (MarkupOutput out, RWSection section)

public void renderSectionStart (MarkupOutput out, RWSection section)

public void renderSectionTitle (MarkupOutput out, RWSection section)

public void renderShape (MarkupOutput out, RWObject shape)

public void renderShell (MarkupOutput out)

Generates the shell for this Transform.

The shell is a <div> tag that automatically surrounds the content generated by the Transform. It's used among other things by the javascript to identify the HTML associated with a bone, and by the iFrame update technology to identify a component in the page.

The attributes to append to this <div> are obtained from the getAttributesShellDiv method; the style from the getStyleShellDiv method.
This method calls renderCssLink and checkStatus to generate the Transform's content.

Parameters
out output by this transform

public void renderSubsectionEnd (MarkupOutput out, RWSection section)

This method is deprecated.
This method has been deprecated. Insted use the method renderSubsectionEnd(MarkupOutput out, RWSection section, boolean renderSubsectionDivider)

public void renderSubsectionEnd (MarkupOutput out, RWSection section, boolean renderSubsectionDivider)

public void renderSubsectionHandle (MarkupOutput out, RWSection section)

public void renderSubsectionStart (MarkupOutput out, RWSection section)

public void renderText (MarkupOutput out, RWObject label)

public void renderTitleBar (MarkupOutput out, RWObject object)

public void renderTitleBar (MarkupOutput out, RWObject object, boolean isGridEmpty)

public void renderVRuler (MarkupOutput out, RWSection section)

public void startIteration (MarkupOutput out, String key, boolean definitionOnly)

Starts iterating the data, by invoking rwi.iterate();

public void startIteration (MarkupOutput out, boolean definitionOnly)

Starts iterating the data, by invoking rwi.iterate();

public void startIteration (RWBeanVisitor visitor, MarkupOutput out, String key, boolean definitionOnly)

Starts iterating the data, by invoking rwi.iterate();

public void transformForPartialDisplay (MarkupOutput out)

public void transformForRequestSuccessful (MarkupOutput out)

Generates the output when the bean's status is WebBeanRequestSuccessful. This is the main entry point to generate the output for those Transforms that just want to render the "regular" bean case.
This is an abstract method. All classes need to implement it.

Parameters
out output by this transform

public void transformForRequestWaitingForUserInput (MarkupOutput out)

Method that generates the output when the bean is WaitingForUserInput.
It checks if the child bean in this state is the RW bean, and if so transforms it using the correct style.

Parameters
out where to write the output of the method.

Protected Methods

protected void addStyleRule (String key)

Throws
IllegalArgumentException

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

Returns the Bean's xml. This is only implemented for beans that extends WebBean, for other beans, the transform needs to overwrite this method.

Returns
  • The bean's getDocument() results. If the bean doesn't support it or an exception is thrown, returns [na]

protected String getBoneId ()

Returns the id to be used for the JavaScript bone.
This method is used by the renderRegisterBone method to indicate the id of the bone html element.

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 int getDpiConversion ()

protected JsonGenerator getFeatures ()

protected Locale getLocale ()

Returns number/date locale. Should not be used for messages.

Returns
  • Locale instance

protected int getNextId ()

Returns the next integer to use as objectId for new objects

Returns
  • the int value of getRWBean().getRWInstance().getDefinition().getKeySeed()

protected TransformInstance getPromptsTransform (RWBean rw)

protected TransformInstance getReportGraphTransform (RWObject object, ViewBean vb)

protected TransformInstance getReportGridTransform (RWObject object, ViewBean vb)

protected TransformInstance getReportOutlineGridTransform (RWObject object, ViewBean vb)

protected TransformInstance getReportVisualizationTransform (RWObject object, ViewBean vb)

protected int getZoomFactor ()

protected void initializeJavascript ()

protected void renderClipboardGrid (MarkupOutput out, RWObject object)

protected void renderGrid (MarkupOutput out, RWObject object, ViewBean grid, boolean isDormantBone)

protected void setupOndemandContextMenuModelView (MarkupOutput out)

Sets up the context menu model and view for ondemand loading of context menu items and renders in the Markupoutput

Parameters
out MarkupOutput object

protected void updateGridVisualizationTransform (RWObject object, ViewBean vb, TransformInstance ti)

Add necessary formal parameters to the Grid Visualization transform

Parameters
object RWObject
vb View Bean
ti Transform Instance