protected class

MojoRWDTransform.RWLayoutContext

extends Object
implements RWBeanVisitor2
java.lang.Object
   ↳ com.microstrategy.web.app.transforms.MojoRWDTransform.RWLayoutContext
Known Direct Subclasses
Known Indirect Subclasses

Class Overview

This class is used to walk the Report Writer Document tree (it implements RWBeanVisitor2) and holds state about what it has encountered...

Summary

Fields
protected Block bRWLayoutDef
protected Stack<Block> subsectionBlockStack
protected Map<String, FormatPropertyConverterFactory.SubsectionBoundingBox> subsectionBoundingBoxMap
Public Constructors
RWLayoutContext(Block bRWLayoutDef, Block bRWLayout, Map<String, FormatPropertyConverterFactory.SubsectionBoundingBox> subsectionBB)
Public Methods
Exception firstException()
boolean hasExceptions()
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(ViewBean viewBean, RWObject ob, MarkupOutput mo)

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

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

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
Protected Methods
boolean addRWTemplateProperties(Block tb, ViewBean viewBean, RWGridGraphDef gridGraphDef, RWGridGraphObject gridGraphObj, Map<String, String> dbps)
void addTemplateExtraInfo(Block bRWTemplate, ViewBean vb, RWGridGraphObject gridGraphObj)
BlockList createNumberFormatsBlock(WebTemplate template, AppContext context, boolean isForMetrics)
Get the format properties of grid units' value for each template.
Block createRWEditableTextBlock(RWUnitDef unitDef, RWObject object, Map<String, String> dbps)
Block createRWGridBlock(ViewBean viewBean, RWGridGraphDef gridGraphDef, RWGridGraphObject gridGraphObj, Map<String, String> dbps)
Block createRWHTMLContainerBlock(RWUnitDef unitDef, RWObject object, Map<String, String> dbps)
boolean forceShowAsGrid(ViewBean viewBean)
String getAndroidVisualization(ViewBean viewBean)
int getEffectiveDisplayMode(RWGridGraphDef def)
String getThresholdKey(String thrID)
TransformInstance getXtabTransformInstance(ViewBean viewBean, RWGridGraphDef gridGraphDef)
boolean ignoreSection(RWSection section, RWSectionDef sectionDef)
boolean isAndroidVisualization(ViewBean viewBean)
boolean isMojoVisualization(ViewBean viewBean)
boolean isQuickSwitchEnabled(RWGridGraphDef unitDef)
boolean isVisualization(ViewBean viewBean)
boolean skipSubsection(RWSection subsection, RWSubsectionDef subsectionDef)
void storeException(Exception e)
[Expand]
Inherited Methods
From class java.lang.Object
From interface com.microstrategy.web.beans.RWBeanVisitor
From interface com.microstrategy.web.beans.RWBeanVisitor2

Fields

protected Block bRWLayoutDef

protected Stack<Block> subsectionBlockStack

protected Map<String, FormatPropertyConverterFactory.SubsectionBoundingBox> subsectionBoundingBoxMap

Public Constructors

public RWLayoutContext (Block bRWLayoutDef, Block bRWLayout, Map<String, FormatPropertyConverterFactory.SubsectionBoundingBox> subsectionBB)

Public Methods

public Exception firstException ()

public boolean hasExceptions ()

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 (ViewBean viewBean, RWObject ob, MarkupOutput mo)

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

Protected Methods

protected boolean addRWTemplateProperties (Block tb, ViewBean viewBean, RWGridGraphDef gridGraphDef, RWGridGraphObject gridGraphObj, Map<String, String> dbps)

protected void addTemplateExtraInfo (Block bRWTemplate, ViewBean vb, RWGridGraphObject gridGraphObj)

protected BlockList createNumberFormatsBlock (WebTemplate template, AppContext context, boolean isForMetrics)

Get the format properties of grid units' value for each template. Implemented in MojoIVETransform

Returns
  • null
Throws
Exception

protected Block createRWEditableTextBlock (RWUnitDef unitDef, RWObject object, Map<String, String> dbps)

Throws
Exception

protected Block createRWGridBlock (ViewBean viewBean, RWGridGraphDef gridGraphDef, RWGridGraphObject gridGraphObj, Map<String, String> dbps)

Throws
Exception

protected Block createRWHTMLContainerBlock (RWUnitDef unitDef, RWObject object, Map<String, String> dbps)

Throws
Exception

protected boolean forceShowAsGrid (ViewBean viewBean)

protected String getAndroidVisualization (ViewBean viewBean)

Throws
WebBeanException
WebObjectsException

protected int getEffectiveDisplayMode (RWGridGraphDef def)

protected String getThresholdKey (String thrID)

protected TransformInstance getXtabTransformInstance (ViewBean viewBean, RWGridGraphDef gridGraphDef)

Throws
WebTransformException

protected boolean ignoreSection (RWSection section, RWSectionDef sectionDef)

protected boolean isAndroidVisualization (ViewBean viewBean)

Throws
WebBeanException
WebObjectsException

protected boolean isMojoVisualization (ViewBean viewBean)

protected boolean isQuickSwitchEnabled (RWGridGraphDef unitDef)

protected boolean isVisualization (ViewBean viewBean)

protected boolean skipSubsection (RWSection subsection, RWSubsectionDef subsectionDef)

protected void storeException (Exception e)