Package com.microstrategy.web.app.transforms

Class MojoTemplateTransformImpl

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

com.microstrategy.web.app.transforms.AbstractReportDataTransform

com.microstrategy.web.app.transforms.MojoTemplateTransformImpl

All Implemented Interfaces:

AppTransform, ReportDataTransform, LayoutTransform, Transform

Direct Known Subclasses:

MojoXtabTransformImpl

public class MojoTemplateTransformImpl
extends AbstractReportDataTransform

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	contentTypeParam

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

_blankImage, _cssBottom, _cssCenter, _cssLeft, _cssRight, _cssTop, _ifLeftArrowImage, _ifRightArrowImage, advancedDrillingContextMenuDisplay, BLANK_SUBSET_REPORT_ID, cssBottom, cssCenter, cssLeft, cssRight, cssTop, customJavaScriptFeatures, drillRetainThresholds, drillWithinBehavior, gridGraphUnitKeyContext, groupContextMenuDrillPathsByType, hasIncreFetchForColumnOnLeft, hasIncreFetchForColumnOnRight, id, ifLeftArrowImage, ifRightArrowImage, incrementalFetchStyleForRow, quickSwitch, quickSwitchCurrent, rwbViewerID, showDrillPathSetNamesSubMenuAtTopLevel, showIncreFetchForColumn, showIncreFetchForRowOnBottom, showIncreFetchForRowOnTop, showSubtitlePara, sortSetNamesAndDrillPaths, transformContext, uniqueReportId

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

BLANK_XDA_REPORT_ID, cssErrorMessage, cssErrorTitle, cssUseFileContent, generateJSForDrillCheckBoxesForIncFetch, iFramePara, imgError, showScroller, useBuiltInFormatPara

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

Method Summary

Modifier and Type	Method	Description
protected void	addGridStructureBlock(Block bRWTemplate, ViewBean vb)	Adds the grid structure block to the template definition block.
protected Block	createGridModelBlock()
java.lang.String	getDescription()	Returns a textual description of the transform.
static BlockList	getThresholdsBlockList(WebThresholds thresholds, AppContext appContext, java.util.Locale locale)
boolean	hasCenter()	Whether the transform has the center area.
protected boolean	isGraphTransform()
protected boolean	isGridTransform()
protected void	prepareToTransform(MarkupOutput out)
void	renderCenter(MarkupOutput out, ReportBean rb)	Render center area of the transform.
void	renderData(MarkupOutput out, ReportBean rb)	Render the report data area.
void	renderEmptyCase(MarkupOutput out, ReportBean rb)	Render when the report grid/graph is empty.
void	renderLayout(MarkupOutput out, ReportBean rb)	Render the layout for the report grid.
void	transformForRequestSuccessful(MarkupOutput out)	Transform when the status is "Successful".

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

createBlockEditorProperties, createBlockEditorProperties, generatePageHistoryItems, getAttributesShellDiv, getBeanPath, getBoneId, getDisplayMode, getFrameBean, getGridData, getGridScriptClass, getGridWidths, getID, getMetricAxisName, getReportSetting, getTransformContext, getViewBean, getWebTemplate, hasBottom, hasLeft, hasRight, hasTop, initializeCss, initializeImages, initializeProperties, initializeTranformContext, initializeTransform, initializeWebComponent, isCalledFromPrinting, isGridEmpty, isQuickSwitchEnabled, isRWBean, renderBottom, renderContent, renderIncreFetchOnColumnLeftPart, renderIncreFetchOnColumnRightPart, renderIncreFetchOnRow, renderJavascript, renderLeft, renderRight, renderRowsIncrementalFetch, renderTop, setBoneProperties, shouldRenderGridInfo, showSubtitle, showSubtitle, showSubTitleOnly, supports, supports

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

canTransform, generateAnchor, generateErrorForIframe, generateErrorForIframe, generateIncFetchAnchor, generateIncFetchOpenAnchor, getCancelEvent, getContinueEvent, getErrorMessage, getErrorTitle, getHistoryListEvent, getInboxSource, getJobExpiredMessage, getNextColumnsEvent, getPreviousColumnsEvent, getReexecuteButtonDescription, getReportBean, getReportStatus, getReportStatusDescriptorKey, getRepromptEvent, getSupportedBeanType, getViewDetailsEvent, getWebReexecuteEvent, isCubeReport, isDatamart, isDesignMode, isIFrameEnabled, isIncRefreshReport, isNonViewableReport, renderColumnsIncrementalFetch, renderColumnsIncrementalFetchNext, renderColumnsIncrementalFetchPrevious, renderContinueFormForRequestInError, renderErrorButtons, renderErrorInfo, renderHistoryListButton, renderImage, renderJobExpiredSection, renderProcessingButtons, renderProcessingInfo, renderProcessingInfoDetails, renderViewDetailsButton, setWebReexecuteEventArguments, transformForRequestInError, transformForRequestNotInited, useBuiltInFormat

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

getReexcuteEventFromBean, getTaskProcessorBaseURL

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

addContactInfo, addDynamicScriptClass, addDynamicScriptFile, addFormalParameter, checkLevel, checkProcessingButtonsFlag, checkProcessingInfoFlag, checkStatus, displayError, displayError, displayError, emptyCell, excludeStaticTags, generateAnchorForExport, generateHiddenInputsForEvent, generateIFrameTag, getAppContext, getArgumentName, getClientSideHelper, getContainerServices, getContext, getContextMenu, getContextMenuManager, getContextMenuManagerName, getContextMenusDefinition, getCssPrefix, getDateFormat, getDebugOut, getDescriptor, getDescriptor, getDescriptor, getDescriptor, getDisplayMode, getDisplayName, getErrorMessage, getErrorTitle, getEventManager, getFirstDayOfWeek, getFloatValue, getHelpPath, getIntValue, getJSNameSpace, getLayoutContext, getLocale, getLocale, getPreferenceValue, getProjectID, getRefreshEvent, getRequestKeys, getResourcesFolder, getScriptClass, getStringValue, getStyleRequestContext, getStyleShellDiv, getTagsFactory, getTimeFormat, getUnitsLabel, getWebBeanErrorInfo, hasSubBlock, initHeightAndWidthFromPreferences, is508, isBlockMode, isContextMenusEnabled, isDhtml, isDialog, isDormant, isFeatureAvailable, isIFrameDisplayMode, 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, renderShell, renderSubBlock, renderUserHelpAnchor, setDisplayMode, setHasSubBlock, setHeight, setIFrameDisplayMode, setIsDormant, setRenderSubBlock, setShellAttributeOnClosedComponent, setWidth, shouldDisplay, transform, transformForRequestCanceled, transformForRequestProcessing, transformForRequestWaitingForUserInput

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

getLayoutDefinition, setLayoutDefinition, transformUsingLayout

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

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

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, getPreview, getSupportedBeanType, isPreviewAvailable, isResolved, transform

Field Detail

contentTypeParam

protected FormalParameter contentTypeParam

Constructor Detail

MojoTemplateTransformImpl

public MojoTemplateTransformImpl()

Method Detail

transformForRequestSuccessful

public void transformForRequestSuccessful(MarkupOutput out)

Description copied from class: AbstractReportDataTransform

Transform when the status is "Successful". This is the main entry point of the Transform. It will check if a layout-xml has been specified and use it, otherwise it calls renderContent.
After the content has been generated it calls renderJavascript to generate any necessary client-side information.

Overrides:

transformForRequestSuccessful in class AbstractReportDataTransform

Parameters:

out - MarkupOutput to generate the HTML.

See Also:

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

prepareToTransform

protected void prepareToTransform(MarkupOutput out)

createGridModelBlock

protected Block createGridModelBlock()
                              throws java.lang.Exception

Throws:

java.lang.Exception

addGridStructureBlock

protected void addGridStructureBlock(Block bRWTemplate,
                                     ViewBean vb)

Adds the grid structure block to the template definition block.

Parameters:

bRWTemplate - The template data block.

vb - The view bean.

Throws:

java.lang.Exception

WebObjectsException

WebBeanException

getThresholdsBlockList

public static BlockList getThresholdsBlockList(WebThresholds thresholds,
                                               AppContext appContext,
                                               java.util.Locale locale)

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.

renderCenter

public void renderCenter(MarkupOutput out,
                         ReportBean rb)

Description copied from interface: ReportDataTransform

Render center area of the transform.

Parameters:

out - output by this transform

rb - this report bean

renderData

public void renderData(MarkupOutput out,
                       ReportBean rb)

Description copied from interface: ReportDataTransform

Render the report data area.
The CENTER area of the transform has layout on top and data on bottom.

Parameters:

out - output by this transform

rb - this report bean

renderEmptyCase

public void renderEmptyCase(MarkupOutput out,
                            ReportBean rb)

Description copied from interface: ReportDataTransform

Render when the report grid/graph is empty.
Usually some information message is displayed.

Parameters:

out - output by this transform

rb - this report bean

renderLayout

public void renderLayout(MarkupOutput out,
                         ReportBean rb)

Description copied from interface: ReportDataTransform

Render the layout for the report grid.
The CENTER area of the transform has layout on top and data on bottom.

Parameters:

out - output by this transform

rb - this report bean

isGraphTransform

protected boolean isGraphTransform()

Specified by:

isGraphTransform in class AbstractReportDataTransform

isGridTransform

protected boolean isGridTransform()

Specified by:

isGridTransform in class AbstractReportDataTransform

hasCenter

public boolean hasCenter()

Description copied from class: AbstractReportDataTransform

Whether the transform has the center area. Out of box, it returns true.

Specified by:

hasCenter in class AbstractReportDataTransform

Returns:

Whether the transform has the center area