Package com.microstrategy.web.app.transforms

Class RWFrameGenericTransform

java.lang.Object

com.microstrategy.web.transform.AbstractTransform

com.microstrategy.web.transform.AbstractLayoutTransform

com.microstrategy.web.app.transforms.AbstractAppTransform

com.microstrategy.web.app.transforms.FrameGenericTransform

com.microstrategy.web.app.transforms.RWFrameGenericTransform

All Implemented Interfaces:

AppTransform, LayoutTransform, Transform

public class RWFrameGenericTransform
extends FrameGenericTransform

Specific implementation of the FrameGenericTransform for the RW Frame.

Since:

MicroStrategy Web 8.0.2

Nested Class Summary

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

AbstractAppTransform.Context

Field Summary

Fields

Modifier and Type	Field	Description
protected FormalParameter	rwAnalysisSWFStyle
protected FormalParameter	rwStyle	This is the name of the style to use when rendering the rw bean.
protected FormalParameter	rwSWFStyle

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

_defaultLayout, customJavaScriptFeatures, FP_CUSTOM_JS_FEATURES

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

Method Summary

Modifier and Type	Method	Description
protected java.lang.String	getDocumentStyleName()	This method returns the name of a style from the style-catalog used to render the ReportBean.
boolean	isInVisualizationMode(RWBean rwb)	Whether the document is in visualization mode
void	renderDocumentData(MarkupOutput out)	render the report data area.
protected void	renderRegisterBone(MarkupOutput out)	If a scriptClass is specified, this method registers the corresponding javascript bone for this component.

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

appendCustomFeatures, displayComponent, displayComponent, displayComponent, generateSimpleMode, getCustomColorDescriptor, getDecimalSeparator, getDescription, getSupportedBeanType, getUserDpi, getUserPalette, initializeTransform, renderCurrentEditor, renderData, renderEditorMessage, renderIFrameComponent, renderObjectBrowser, transformForRequestCanceled, transformForRequestInError, transformForRequestNotInited, transformForRequestProcessing, transformForRequestSuccessful, transformForRequestWaitingForUserInput

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, getCancelEvent, 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, getRefreshEvent, getRequestKeys, getResourcesFolder, getScriptClass, getStringValue, getStyleRequestContext, getStyleShellDiv, getTagsFactory, getTimeFormat, getUnitsLabel, getWebBeanErrorInfo, hasSubBlock, initHeightAndWidthFromPreferences, initializeCss, initializeImages, 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, renderImage, renderLayout, renderProcessingButton, renderProcessingButton, renderProcessingButton, renderProcessingButtonForGet, renderProcessingButtonForGet, renderProcessingButtons, renderProcessingInfo, renderProcessingInfoData, renderProcessingInfoImage, renderProcessingInfoSubtitle, renderProcessingInfoTitle, renderProcessingObjectName, renderRefreshButton, renderSelf, renderShell, renderSubBlock, renderUserHelpAnchor, setBoneProperties, setDisplayMode, setHasSubBlock, setHeight, setIFrameDisplayMode, setIsDormant, setRenderSubBlock, setShellAttributeOnClosedComponent, setWidth, shouldDisplay, transform

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

getLayoutDefinition, setLayoutDefinition

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

canTransform, getFormalParams, getID, getPreview, isPreviewAvailable, isResolved, supports, supports, transform

Field Detail

rwStyle

protected FormalParameter rwStyle

This is the name of the style to use when rendering the rw bean.
Allowed Values: any document style name from StyelCatalog.xml file.

rwSWFStyle

protected FormalParameter rwSWFStyle

Since:

MicroStrategy Web 8.1.0

rwAnalysisSWFStyle

protected FormalParameter rwAnalysisSWFStyle

Since:

MicroStrategy Web 9.0.3

Constructor Detail

RWFrameGenericTransform

public RWFrameGenericTransform()

Method Detail

renderDocumentData

public void renderDocumentData(MarkupOutput out)

render the report data area.
Out of box, it renders the message before the data and the report data - grid, graph or grid&graph.

Parameters:

out - output by the transform

renderRegisterBone

protected void renderRegisterBone(MarkupOutput out)

Description copied from class: AbstractAppTransform

If a scriptClass is specified, this method registers the corresponding javascript bone for this component.

Overrides:

renderRegisterBone in class AbstractAppTransform

Parameters:

out - MarkupOutput whether the output should be rendered.

Since:

MicroStrategy Web 9.0.0

See Also:

AbstractAppTransform.getScriptClass()

getDocumentStyleName

protected java.lang.String getDocumentStyleName()

This method returns the name of a style from the style-catalog used to render the ReportBean. The name is calculated based on the view mode, visualization settings and formal parameters. To programatically calculate a different style you may override this method.

isInVisualizationMode

public boolean isInVisualizationMode(RWBean rwb)

Whether the document is in visualization mode

Parameters:

rwb - the RW Bean

Returns:

Whether the document is in visualization mode