Package com.microstrategy.web.app.transforms

Class AbstractSimplifiedRWXMLTransform

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

All Implemented Interfaces:

AppTransform, RWBeanVisitor, RWBeanVisitor2, Transform

Direct Known Subclasses:

MobileChunkedRWTransform, RWXMLTransform

public abstract class AbstractSimplifiedRWXMLTransform
extends AbstractRWTransform
implements RWBeanVisitor2

Since:

MicroStrategy Web 8.1.2

Nested Class Summary

Nested classes/interfaces inherited from class com.microstrategy.web.app.transforms.AbstractRWTransform

AbstractRWTransform.ButtonAlignmentsHelper

Nested classes/interfaces inherited from class com.microstrategy.web.app.transforms.AbstractAppTransform

AbstractAppTransform.Context

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	FP_USE_FIELDPOSITION_AS_ORDER	Constant specifying the name of the formal parameter for useFieldPositionAsOrder
protected FormalParameter	useFieldPositionAsOrder	Whether to order the fields in a subsection by position, from top, left to bottom, right while generating the data

Fields inherited from class com.microstrategy.web.app.transforms.AbstractRWTransform

imgError

Fields inherited from class com.microstrategy.web.app.transforms.AbstractAppTransform

_bean, _componentBlock, _cssPrefix, _imgBlank, _imgWait, _selfOutput, _subOutput, appliesTo, CLASS_INPUT, CLASS_MESSAGE, contextMenus, cssFile, cssPrefix, debugErrorFlags, debugFlags, dragMode, extraInput, extraUrl, FP_APPLIES_TO, FP_CONTEXT_MENUS, FP_CSS_ERROR_MESSAGE, FP_CSS_ERROR_TITLE, FP_CSS_FILE, FP_CSS_PREFIX, FP_DEBUG_ERROR_FLAGS, FP_DEBUG_FLAGS, FP_DRAG_MODE, FP_EXTRA_INPUT, FP_EXTRA_URL, FP_HEIGHT, FP_IFRAME_ENABLED, FP_IMG_WAIT, FP_INITIAL_INDENT, FP_ORIENTATION, FP_ORIENTATIONS_ALLOWED, FP_PARTIAL_IFRAME_UPDATE, FP_PROCESSING_BUTTONS_FLAGS, FP_PROCESSING_INFO_FLAGS, FP_RESIZE_LEVEL, FP_SCRIPT_CLASS, FP_TYPE, FP_USE_DHTML, FP_WIDTH, globalCssErrorMessage, globalCssErrorTitle, height, iframeEnabled, imgWait, indent, initialIndent, isDHTML, orientation, orientationsAllowed, partialIframeUpdate, PROCESSING_BUTTONS_ALL, PROCESSING_BUTTONS_CANCEL, PROCESSING_BUTTONS_HISTORY_LIST, PROCESSING_BUTTONS_REFRESH, PROCESSING_BUTTONS_VIEW_DETAILS, PROCESSING_INFO_ALL, PROCESSING_INFO_DESCRIPTION, PROCESSING_INFO_LAST_UPDATE, PROCESSING_INFO_NAME, PROCESSING_INFO_NONE, PROCESSING_INFO_STATUS, processingButtonsFlags, processingInfoFlags, RESIZE_ALL, RESIZE_HORIZONTAL, RESIZE_NONE, RESIZE_VERTICAL, resizeLevel, scriptClass, scriptEndTagEncoder, type, useDHTML, width

Constructor Summary

Constructors

Constructor	Description
AbstractSimplifiedRWXMLTransform()

Method Summary

Modifier and Type	Method	Description
void	initializeTransform(Transformable data)	Extends AbstractAppTransform.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(RWBean rwBean, RWObject ob, MarkupOutput mo)	Specific case where RWObject#getDefinition().getType == EnumRWUnitTypes.RWUNIT_SUBREPORT.
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 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
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, java.lang.String key, boolean definitionOnly)	Starts iterating the data, by invoking rwi.iterate();

Methods inherited from class com.microstrategy.web.app.transforms.AbstractRWTransform

displayError, generateErrorForIframe, getCancelEvent, getContinueEvent, getDocumentStatus, getDocumentStatusDescriptorKey, getErrorMessage, getErrorTitle, getHistoryListEvent, getInboxSource, getJobExpiredMessage, getReexecuteButtonDescription, getRefreshEvent, getRWBean, getRWFrame, getSupportedBeanType, getViewDetailsEvent, getWebReexecuteEvent, initializeImages, isDesignMode, renderHistoryListButton, renderImage, renderProcessingButtons, renderProcessingInfo, renderProcessingInfoDetails, renderProcessingInfoStatus, renderViewDetailsButton, setWebReexecuteEventArguments, transformForRequestInError, transformForRequestNotInited, updateVisTransform

Methods inherited from class com.microstrategy.web.app.transforms.AbstractWebBeanTransform

getReexcuteEventFromBean, getTaskProcessorBaseURL, renderJobExpiredSection

Methods inherited from class com.microstrategy.web.app.transforms.AbstractAppTransform

addContactInfo, addDynamicScriptClass, addDynamicScriptFile, addFormalParameter, checkLevel, checkProcessingButtonsFlag, checkProcessingInfoFlag, checkStatus, displayError, displayError, displayError, emptyCell, excludeStaticTags, generateAnchor, generateAnchorForExport, generateHiddenInputsForEvent, generateIFrameTag, getAppContext, getArgumentName, getAttributesShellDiv, getBeanPath, getBoneId, getClientSideHelper, getContainerServices, getContext, getContextMenu, getContextMenuManager, getContextMenuManagerName, getContextMenusDefinition, getCssPrefix, getDateFormat, getDebugOut, getDescriptor, getDescriptor, getDescriptor, getDescriptor, getDisplayMode, getDisplayName, getErrorMessage, getErrorMessage, getErrorTitle, getErrorTitle, getEventManager, getFirstDayOfWeek, getFloatValue, getHelpPath, getID, getIntValue, getJSNameSpace, getLayoutContext, getLocale, getLocale, getPreferenceValue, getProjectID, getRequestKeys, getResourcesFolder, getScriptClass, getStringValue, getStyleRequestContext, getStyleShellDiv, getTagsFactory, getTimeFormat, getUnitsLabel, getWebBeanErrorInfo, hasSubBlock, initHeightAndWidthFromPreferences, initializeCss, initializeWebComponent, is508, isBlockMode, isContextMenusEnabled, isDhtml, isDialog, isDormant, isFeatureAvailable, isIFrameDisplayMode, isIFrameEnabled, isIFrameRequest, isJobExpired, isModal, isOpen, isPortlet, isTrue, localIsIFrameDisplayMode, newContext, newHiddenInputBuilder, newNamespaceEncoder, newURIBuilder, redirectToDisplayError, redirectToDisplayError, renderBean, renderBean, renderBean, renderBean, renderCancelButton, renderContextMenus, renderCssLink, renderDescriptor, renderDescriptor, renderErrorButton, renderHiddenInputFromRequest, renderLayout, renderProcessingButton, renderProcessingButton, renderProcessingButton, renderProcessingButtonForGet, renderProcessingButtonForGet, renderProcessingInfoData, renderProcessingInfoImage, renderProcessingInfoSubtitle, renderProcessingInfoTitle, renderProcessingObjectName, renderRefreshButton, renderRegisterBone, renderSelf, renderSubBlock, renderUserHelpAnchor, setBoneProperties, setDisplayMode, setHasSubBlock, setHeight, setIFrameDisplayMode, setIsDormant, setRenderSubBlock, setShellAttributeOnClosedComponent, setWidth, shouldDisplay, transform, transformForRequestCanceled, transformForRequestProcessing, transformForRequestSuccessful, transformForRequestWaitingForUserInput

Methods inherited from class com.microstrategy.web.transform.AbstractLayoutTransform

getLayoutDefinition, setLayoutDefinition, transformUsingLayout

Methods inherited from class com.microstrategy.web.transform.AbstractTransform

addFormalParam, canTransform, getEvents, getFormalParams, getPreview, isPreviewAvailable, isResolved, removeFormalParam, setAnnotation, setDeprecated, supports, supports

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.microstrategy.web.transform.Transform

canTransform, getDescription, getFormalParams, getPreview, isPreviewAvailable, isResolved, supports, supports

Field Detail

useFieldPositionAsOrder

protected FormalParameter useFieldPositionAsOrder

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

FP_USE_FIELDPOSITION_AS_ORDER

public static final java.lang.String FP_USE_FIELDPOSITION_AS_ORDER

Constant specifying the name of the formal parameter for useFieldPositionAsOrder

See Also:

Constant Field Values

Constructor Detail

AbstractSimplifiedRWXMLTransform

public AbstractSimplifiedRWXMLTransform()

Method Detail

initializeTransform

public void initializeTransform(Transformable data)

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

Specified by:

initializeTransform in interface AppTransform

Overrides:

initializeTransform in class AbstractRWTransform

Parameters:

data - The bean to transform.

startIteration

public void startIteration(MarkupOutput out,
                           boolean definitionOnly)

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

startIteration

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

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

onObject

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

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

Parameters:

viewBean - an embedded bean.

ob - the report writing document object.

out - the markup output.

See Also:

RWBeanVisitor.onObject(ViewBean, RWObject, MarkupOutput)

renderGrid

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

onStartSection

public void onStartSection(RWSection section,
                           MarkupOutput mo)

Specified by:

onStartSection in interface RWBeanVisitor

Parameters:

section - the report writing document section.

mo - the markup output.

See Also:

RWVisitor.onStartSection(RWSection)

onEndSection

public void onEndSection(RWSection section,
                         MarkupOutput mo)

Specified by:

onEndSection in interface RWBeanVisitor

Parameters:

section - the report writing document section.

mo - the markup output.

See Also:

RWVisitor.onEndSection(RWSection)

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

Parameters:

ob - the report writing document object.

mo - the markup output.

See Also:

RWVisitor.onObject(RWObject)

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

Parameters:

rwBean - an embedded bean.

ob - the report writing document object.

mo - the markup output.

See Also:

RWVisitor.onObject(RWObject)

renderShell

public void renderShell(MarkupOutput out)

Description copied from class: AbstractAppTransform

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.

Overrides:

renderShell in class AbstractAppTransform

Parameters:

out - output by this transform

onStart

public void onStart(RWDefinition definition,
                    MarkupOutput mo)

Description copied from interface: RWBeanVisitor2

Called on iteration start up

Specified by:

onStart in interface RWBeanVisitor2

Parameters:

definition - document definition

mo - markup output

onEnd

public void onEnd(MarkupOutput mo)

Description copied from interface: RWBeanVisitor2

Called on iteration end

Specified by:

onEnd in interface RWBeanVisitor2

Parameters:

mo - markup output

onStartSubsection

public void onStartSubsection(RWSection subsection,
                              MarkupOutput mo)

Description copied from interface: RWBeanVisitor2

Called on start of subsection

Specified by:

onStartSubsection in interface RWBeanVisitor2

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

Parameters:

subsection - the subsection before the border.

mo - the markup output.