Package com.microstrategy.web.app.transforms

Class MojoRWDTransform

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

com.microstrategy.web.app.transforms.MojoRWDTransform

All Implemented Interfaces:

AppTransform, Transform

Direct Known Subclasses:

MojoIVETransform

public class MojoRWDTransform
extends AbstractMojoRWTransform

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected class	MojoRWDTransform.RWLayoutContext	This class is used to walk the Report Writer Document tree (it implements RWBeanVisitor2) and holds state about what it has encountered...
protected class	MojoRWDTransform.RWLayoutContextDefn	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...
static class	MojoRWDTransform.ScriptTagExtractor
static class	MojoRWDTransform.TransformStringUtil

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
protected double	desiredZoomFactor
protected int	dpiConversion
protected int	zoomFactor

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

Method Summary

Modifier and Type	Method	Description
protected com.microstrategy.web.app.transforms.FormatPropertyConverterFactory.ConverterContext	createConverterContext(RWUnit rwUnit, WebFormat webFormat)
protected MojoRWDTransform.RWLayoutContext	createLayoutContext(Block bRWLayoutDef, Block bRWLayout, java.util.Map<java.lang.String,com.microstrategy.web.app.transforms.FormatPropertyConverterFactory.SubsectionBoundingBox> subsectionBB)
protected MojoRWDTransform.RWLayoutContextDefn	createLayoutContextDefn(Block bRWLayoutDef, Block bRWLayout, boolean docWidthModeAuto)
protected Block	createRWInstanceBlock()
protected BlockList	getAttributeFormsBlock(WebAttributeForms forms, WebAttributeForms baseForms)
protected RWIterateSettings	getDefnIterateSettings()
java.lang.String	getDescription()	Returns a textual description of the transform.
protected boolean	getHideLayoutTabStrip(int layoutCount, boolean showTabForSingleLayout)
protected int	getNextId()	Returns the next integer to use as objectId for new objects
protected Block	getRootDefn(RWSectionDef rwSectionDef)
protected WebWorkingSet	getWorkingSet()
protected void	prepareMarkupOutput(MarkupOutput out)
void	renderShell(MarkupOutput out)	Generates the shell for this Transform.
protected void	setLayoutDefProperties(RWLayoutSectionDef theLayout, Block bRWLayoutDef, java.lang.String key, java.lang.String title, int supportedOrientations, boolean docWidthModeAuto, boolean isCurrent)
void	transformForRequestInError(MarkupOutput out)	Transform when the status is In Error.
void	transformForRequestSuccessful(MarkupOutput out)	Generates the output when the bean's status is EnumRequestStatus.WebBeanRequestSuccessful.
void	transformForRequestWaitingForUserInput(MarkupOutput out)	Generates the output when the bean's status is EnumRequestStatus.WebBeanRequestWaitingForUserInput, that is when the bean needs to answer prompts.

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

createErrorBlock

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, initializeTransform, isDesignMode, renderHistoryListButton, renderImage, renderProcessingButtons, renderProcessingInfo, renderProcessingInfoDetails, renderProcessingInfoStatus, renderViewDetailsButton, setWebReexecuteEventArguments, 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, 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

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, getFormalParams, getPreview, isPreviewAvailable, isResolved, supports, supports

Field Detail

zoomFactor

protected int zoomFactor

dpiConversion

protected int dpiConversion

desiredZoomFactor

protected double desiredZoomFactor

Constructor Detail

MojoRWDTransform

public MojoRWDTransform()

Method Detail

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

transformForRequestSuccessful

public void transformForRequestSuccessful(MarkupOutput out)

Description copied from class: AbstractAppTransform

Generates the output when the bean's status is EnumRequestStatus.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.

Specified by:

transformForRequestSuccessful in class AbstractAppTransform

Parameters:

out - output by this transform

See Also:

AbstractAppTransform.checkStatus(com.microstrategy.web.beans.MarkupOutput)

getDescription

public java.lang.String getDescription()

Description copied from interface: Transform

Returns a textual description of the transform.

Returns:

The textual description of the transform.

transformForRequestWaitingForUserInput

public void transformForRequestWaitingForUserInput(MarkupOutput out)

Description copied from class: AbstractAppTransform

Generates the output when the bean's status is EnumRequestStatus.WebBeanRequestWaitingForUserInput, that is when the bean needs to answer prompts. By default it just generates an error message.
Usually prompts are handled by a Prompts transform, the bean is responsible to delegate execution to this transform when prompts are open so reaching this method is actually considered an error.
Transforms that would like to generate customized error message for this scenario should extend this method.

Overrides:

transformForRequestWaitingForUserInput in class AbstractAppTransform

Parameters:

out - output by this transform

See Also:

AbstractAppTransform.checkStatus(com.microstrategy.web.beans.MarkupOutput)

transformForRequestInError

public void transformForRequestInError(MarkupOutput out)

Description copied from class: AbstractRWTransform

Transform when the status is In Error.

Overrides:

transformForRequestInError in class AbstractRWTransform

Parameters:

out - Output by this transform.

See Also:

AbstractAppTransform.checkStatus(com.microstrategy.web.beans.MarkupOutput)

prepareMarkupOutput

protected void prepareMarkupOutput(MarkupOutput out)

createRWInstanceBlock

protected Block createRWInstanceBlock()
                               throws java.lang.Exception

Throws:

java.lang.Exception

getAttributeFormsBlock

protected BlockList getAttributeFormsBlock(WebAttributeForms forms,
                                           WebAttributeForms baseForms)

getRootDefn

protected Block getRootDefn(RWSectionDef rwSectionDef)
                     throws java.lang.Exception

Throws:

java.lang.Exception

getWorkingSet

protected WebWorkingSet getWorkingSet()

getHideLayoutTabStrip

protected boolean getHideLayoutTabStrip(int layoutCount,
                                        boolean showTabForSingleLayout)

setLayoutDefProperties

protected void setLayoutDefProperties(RWLayoutSectionDef theLayout,
                                      Block bRWLayoutDef,
                                      java.lang.String key,
                                      java.lang.String title,
                                      int supportedOrientations,
                                      boolean docWidthModeAuto,
                                      boolean isCurrent)
                               throws WebObjectsException,
                                      WebBeanException

Throws:

WebObjectsException

WebBeanException

getDefnIterateSettings

protected RWIterateSettings getDefnIterateSettings()

getNextId

protected int getNextId()

Returns the next integer to use as objectId for new objects

Returns:

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

createLayoutContextDefn

protected MojoRWDTransform.RWLayoutContextDefn createLayoutContextDefn(Block bRWLayoutDef,
                                                                       Block bRWLayout,
                                                                       boolean docWidthModeAuto)

createLayoutContext

protected MojoRWDTransform.RWLayoutContext createLayoutContext(Block bRWLayoutDef,
                                                               Block bRWLayout,
                                                               java.util.Map<java.lang.String,com.microstrategy.web.app.transforms.FormatPropertyConverterFactory.SubsectionBoundingBox> subsectionBB)

createConverterContext

protected com.microstrategy.web.app.transforms.FormatPropertyConverterFactory.ConverterContext createConverterContext(RWUnit rwUnit,
                                                                                                                      WebFormat webFormat)