public abstract class

AbstractSimplifiedRWXMLTransform

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.AbstractSimplifiedRWXMLTransform
Known Direct Subclasses

Summary

Constants
String FP_USE_FIELDPOSITION_AS_ORDER Constant specifying the name of the formal parameter for useFieldPositionAsOrder
[Expand]
Inherited Constants
From class com.microstrategy.web.app.transforms.AbstractAppTransform
Fields
protected FormalParameter useFieldPositionAsOrder Whether to order the fields in a subsection by position, from top, left to bottom, right while generating the data
[Expand]
Inherited Fields
From class com.microstrategy.web.app.transforms.AbstractRWTransform
From class com.microstrategy.web.app.transforms.AbstractAppTransform
Public Constructors
AbstractSimplifiedRWXMLTransform()
Public Methods
void initializeTransform(Transformable data)
Extends initializeTransform(com.microstrategy.web.beans.Transformable) by obtaining a reference to the data
void onEnd(MarkupOutput mo)
Called on iteration end
void onEndSection(RWSection section, MarkupOutput mo)
void onEndSubsection(RWSection subsection, MarkupOutput mo, boolean isBordered)
A subsection border occurs between two subsections, or if the subsection is the very last section in the document.
void onObject(RWObject ob, MarkupOutput mo)

This is invoked as a fallback if the more specific onObject declarations are not matched.

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(RWBean rwBean, RWObject ob, MarkupOutput mo)

Specific case where RWObject#getDefinition().getType == EnumRWUnitTypes.RWUNIT_SUBREPORT.

void onStart(RWDefinition definition, MarkupOutput mo)
Called on iteration start up
void onStartSection(RWSection section, MarkupOutput mo)
void onStartSubsection(RWSection subsection, MarkupOutput mo)
Called on start of subsection
abstract void renderGrid(MarkupOutput mo, RWObject ob, ViewBean vb)
void renderShell(MarkupOutput out)

Generates the shell for this Transform.

void startIteration(MarkupOutput out, boolean definitionOnly)
Starts iterating the data, by invoking rwi.iterate();
void startIteration(MarkupOutput out, String key, boolean definitionOnly)
Starts iterating the data, by invoking rwi.iterate();
[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_USE_FIELDPOSITION_AS_ORDER

Constant specifying the name of the formal parameter for useFieldPositionAsOrder

Constant Value: "useFieldPositionAsOrder"

Fields

protected FormalParameter useFieldPositionAsOrder

Whether to order the fields in a subsection by position, from top, left to bottom, right while generating the data

Public Constructors

public AbstractSimplifiedRWXMLTransform ()

Public Methods

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 void onEnd (MarkupOutput mo)

Called on iteration end

Parameters
mo markup output

public void onEndSection (RWSection section, MarkupOutput mo)

public void onEndSubsection (RWSection subsection, MarkupOutput mo, boolean isBordered)

A subsection border occurs between two subsections, or if the subsection is the very last section in the document.

Parameters
subsection the subsection before the border.
mo the markup output.

public void onObject (RWObject ob, MarkupOutput mo)

This is invoked as a fallback if the more specific onObject declarations are not matched.

Parameters
ob the report writing document object.
mo 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 (RWBean rwBean, RWObject ob, MarkupOutput mo)

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

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

public void onStart (RWDefinition definition, MarkupOutput mo)

Called on iteration start up

Parameters
definition document definition
mo markup output

public void onStartSection (RWSection section, MarkupOutput mo)

public void onStartSubsection (RWSection subsection, MarkupOutput mo)

Called on start of subsection

Parameters
subsection subsection
mo markup output

public abstract void renderGrid (MarkupOutput mo, RWObject ob, ViewBean vb)

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 startIteration (MarkupOutput out, boolean definitionOnly)

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

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

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