Package com.microstrategy.web.app.transforms

Class MojoRWDTransform.RWLayoutContextDefn

java.lang.Object

com.microstrategy.web.app.transforms.MojoRWDTransform.RWLayoutContext

com.microstrategy.web.app.transforms.MojoRWDTransform.RWLayoutContextDefn

All Implemented Interfaces:

RWBeanVisitor, RWBeanVisitor2

Direct Known Subclasses:

MojoIVETransform.IVELayoutContextDefn

Enclosing class:

MojoRWDTransform

protected class MojoRWDTransform.RWLayoutContextDefn
extends MojoRWDTransform.RWLayoutContext

This class is used to walk the Report Writer Document's definition tree (it implements RWBeanVisitor2 and extends MojoRWDTransform.RWLayoutContext which walks the RWD's data tree)and holds state about what it has encountered... e

Field Summary

Fields inherited from class com.microstrategy.web.app.transforms.MojoRWDTransform.RWLayoutContext

bRWLayoutDef, subsectionBlockStack, subsectionBoundingBoxMap

Constructor Summary

Constructors

Constructor	Description
RWLayoutContextDefn(Block bRWLayoutDef, Block bRWLayout, boolean docWidthModeAuto)

Method Summary

Modifier and Type	Method	Description
protected void	addRWTemplateDefProperties(RWGridGraphDef gridGraphDef, RWUnit rwUnit, Block bRWTemplateDef, ViewBean vb)
protected Block	createRWControlDefBlock(RWControlDef unitDef, RWUnit rwUnit)
protected Block	createRWPanelDefBlock(RWSubsectionDef panelDef, RWSection panel)
protected Block	createRWPanelStackDefBlock(RWSectionDef sectionDef, RWSection rwSection)
protected RWDataSet	getDatasetForSearchBox(java.lang.String srcObjId)
java.util.Map<java.lang.String,com.microstrategy.web.app.transforms.FormatPropertyConverterFactory.SubsectionBoundingBox>	getSubsectionBoundingBoxMap()
protected boolean	getViewBeanHasTitleProperty(ViewBean viewBean, RWGridGraphDef gridGraphDef, Block bRWUnitDef, WebFormat wf)
protected boolean	isPSAsFilterPanel(RWUnitDef def)
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(RWBean rwBean, RWObject ob, MarkupOutput mo)	Specific case where RWObject#getDefinition().getType == EnumRWUnitTypes.RWUNIT_SUBREPORT.
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(RWObject ob, MarkupOutput mo)	This is invoked as a fallback if the more specific onObject declarations are not matched.
void	onStartSection(RWSection section, MarkupOutput mo)
void	onStartSubsection(RWSection subsection, MarkupOutput mo)	Called on start of subsection
protected void	setSelectorTitleProperties(Block bRWSelectorDef, RWControlDef controlDef, WebFormat ctlFormat)
protected boolean	shuoldIncludeSelectorTitleProperties(RWControlDef controlDef)

Methods inherited from class com.microstrategy.web.app.transforms.MojoRWDTransform.RWLayoutContext

addRWTemplateProperties, addTemplateExtraInfo, createNumberFormatsBlock, createRWEditableTextBlock, createRWGridBlock, createRWHTMLContainerBlock, firstException, forceShowAsGrid, getAndroidVisualization, getEffectiveDisplayMode, getThresholdKey, getXtabTransformInstance, hasExceptions, ignoreSection, isAndroidVisualization, isMojoVisualization, isQuickSwitchEnabled, isVisualization, onStart, skipSubsection, storeException

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RWLayoutContextDefn

public RWLayoutContextDefn(Block bRWLayoutDef,
                           Block bRWLayout,
                           boolean docWidthModeAuto)

Method Detail

getSubsectionBoundingBoxMap

public java.util.Map<java.lang.String,com.microstrategy.web.app.transforms.FormatPropertyConverterFactory.SubsectionBoundingBox> getSubsectionBoundingBoxMap()

onStartSection

public void onStartSection(RWSection section,
                           MarkupOutput mo)

Specified by:

onStartSection in interface RWBeanVisitor

Overrides:

onStartSection in class MojoRWDTransform.RWLayoutContext

Parameters:

section - the report writing document section.

mo - the markup output.

See Also:

RWVisitor.onStartSection(RWSection)

onStartSubsection

public void onStartSubsection(RWSection subsection,
                              MarkupOutput mo)

Description copied from interface: RWBeanVisitor2

Called on start of subsection

Specified by:

onStartSubsection in interface RWBeanVisitor2

Overrides:

onStartSubsection in class MojoRWDTransform.RWLayoutContext

Parameters:

subsection - subsection

mo - markup output

onEndSubsection

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

Description copied from interface: RWBeanVisitor2

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

Specified by:

onEndSubsection in interface RWBeanVisitor2

Overrides:

onEndSubsection in class MojoRWDTransform.RWLayoutContext

Parameters:

subsection - the subsection before the border.

mo - the markup output.

onEndSection

public void onEndSection(RWSection section,
                         MarkupOutput mo)

Specified by:

onEndSection in interface RWBeanVisitor

Overrides:

onEndSection in class MojoRWDTransform.RWLayoutContext

Parameters:

section - the report writing document section.

mo - the markup output.

See Also:

RWVisitor.onEndSection(RWSection)

onEnd

public void onEnd(MarkupOutput mo)

Description copied from interface: RWBeanVisitor2

Called on iteration end

Specified by:

onEnd in interface RWBeanVisitor2

Overrides:

onEnd in class MojoRWDTransform.RWLayoutContext

Parameters:

mo - markup output

onObject

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

Description copied from interface: RWBeanVisitor

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

Specified by:

onObject in interface RWBeanVisitor

Overrides:

onObject in class MojoRWDTransform.RWLayoutContext

Parameters:

rwBean - an embedded bean.

ob - the report writing document object.

mo - the markup output.

See Also:

RWVisitor.onObject(RWObject)

onObject

public void onObject(RWObject ob,
                     MarkupOutput mo)

Description copied from interface: RWBeanVisitor

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

Specified by:

onObject in interface RWBeanVisitor

Overrides:

onObject in class MojoRWDTransform.RWLayoutContext

Parameters:

ob - the report writing document object.

mo - the markup output.

See Also:

RWVisitor.onObject(RWObject)

onObject

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

Description copied from interface: RWBeanVisitor

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

Specified by:

onObject in interface RWBeanVisitor

Overrides:

onObject in class MojoRWDTransform.RWLayoutContext

Parameters:

viewBean - an embedded bean.

ob - the report writing document object.

mo - the markup output.

See Also:

RWVisitor.onObject(RWObject)

getViewBeanHasTitleProperty

protected boolean getViewBeanHasTitleProperty(ViewBean viewBean,
                                              RWGridGraphDef gridGraphDef,
                                              Block bRWUnitDef,
                                              WebFormat wf)

createRWPanelStackDefBlock

protected Block createRWPanelStackDefBlock(RWSectionDef sectionDef,
                                           RWSection rwSection)
                                    throws java.lang.Exception

Throws:

java.lang.Exception

getDatasetForSearchBox

protected RWDataSet getDatasetForSearchBox(java.lang.String srcObjId)
                                    throws WebObjectsException,
                                           WebBeanException

Throws:

WebObjectsException

WebBeanException

shuoldIncludeSelectorTitleProperties

protected boolean shuoldIncludeSelectorTitleProperties(RWControlDef controlDef)

setSelectorTitleProperties

protected void setSelectorTitleProperties(Block bRWSelectorDef,
                                          RWControlDef controlDef,
                                          WebFormat ctlFormat)

createRWPanelDefBlock

protected Block createRWPanelDefBlock(RWSubsectionDef panelDef,
                                      RWSection panel)
                               throws java.lang.Exception

Throws:

java.lang.Exception

addRWTemplateDefProperties

protected void addRWTemplateDefProperties(RWGridGraphDef gridGraphDef,
                                          RWUnit rwUnit,
                                          Block bRWTemplateDef,
                                          ViewBean vb)
                                   throws java.lang.Exception

Throws:

java.lang.Exception

createRWControlDefBlock

protected Block createRWControlDefBlock(RWControlDef unitDef,
                                        RWUnit rwUnit)
                                 throws java.lang.Exception

Throws:

java.lang.Exception

isPSAsFilterPanel

protected boolean isPSAsFilterPanel(RWUnitDef def)