Package com.microstrategy.web.app.transforms

Class ExportTransform

java.lang.Object

com.microstrategy.web.transform.AbstractTransform

com.microstrategy.web.transform.AbstractLayoutTransform

com.microstrategy.web.app.transforms.AbstractAppTransform

com.microstrategy.web.app.transforms.ExportTransform

All Implemented Interfaces:

AppTransform, Transform

public class ExportTransform
extends AbstractAppTransform

This is the main Transform for Exporting.
It will transform the Report Bean with the style specified on the Export Format (set on the Export Bean).

Since:

MicroStrategy Web 8.0.1

Nested Class Summary

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

AbstractAppTransform.Context

Field Summary

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

Method Summary

Modifier and Type	Method	Description
protected WebEvent	getCancelEvent()
java.lang.String	getDescription()	Return description for this Transform
java.lang.Class	getSupportedBeanType()	return the bean type supported by this transform.
void	initializeTransform(Transformable data)	Extends initializeTransform by invoking checkDesignMode() and initializeProperties()
protected void	renderProcessingObjectName(MarkupOutput out)
void	renderShell(MarkupOutput out)	Generates the shell for this Transform.
void	transformForRequestInError(MarkupOutput mo)	Generates the output when the bean's status is EnumRequestStatus.WebBeanRequestEndsInError.
void	transformForRequestProcessing(MarkupOutput out)	Generates the output when the bean's status is EnumRequestStatus.WebBeanRequestProcessing.
void	transformForRequestSuccessful(MarkupOutput mo)	Transform when the status is "Successful".

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, 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, renderRefreshButton, renderRegisterBone, renderSelf, renderSubBlock, renderUserHelpAnchor, setBoneProperties, setDisplayMode, setHasSubBlock, setHeight, setIFrameDisplayMode, setIsDormant, setRenderSubBlock, setShellAttributeOnClosedComponent, setWidth, shouldDisplay, transform, transformForRequestCanceled, transformForRequestNotInited, 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, getFormalParams, getPreview, isPreviewAvailable, isResolved, supports, supports

Constructor Detail

ExportTransform

public ExportTransform()

Method Detail

initializeTransform

public void initializeTransform(Transformable data)

Extends initializeTransform by invoking checkDesignMode() and initializeProperties()

Specified by:

initializeTransform in interface AppTransform

Overrides:

initializeTransform in class AbstractAppTransform

Parameters:

data - the bean to transform.

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

transformForRequestProcessing

public void transformForRequestProcessing(MarkupOutput out)

Description copied from class: AbstractAppTransform

Generates the output when the bean's status is EnumRequestStatus.WebBeanRequestProcessing. This is the case when the iServer is still executing the request and a wait page is displayed to the end user.
This method generates the default wait page contents. It calls renderProcessingInfo and renderProcessingButtons.

Overrides:

transformForRequestProcessing in class AbstractAppTransform

Parameters:

out - output by this transform

Since:

MicroStrategy Web 8.1.1

See Also:

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

renderProcessingObjectName

protected void renderProcessingObjectName(MarkupOutput out)

Overrides:

renderProcessingObjectName in class AbstractAppTransform

Since:

MicroStrategy Web 9.0.0

transformForRequestSuccessful

public void transformForRequestSuccessful(MarkupOutput mo)

Transform when the status is "Successful".

Specified by:

transformForRequestSuccessful in class AbstractAppTransform

Parameters:

mo - output by this transform

See Also:

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

transformForRequestInError

public void transformForRequestInError(MarkupOutput mo)

Description copied from class: AbstractAppTransform

Generates the output when the bean's status is EnumRequestStatus.WebBeanRequestEndsInError. This method just calls AbstractAppTransform.displayError(com.microstrategy.web.beans.MarkupOutput, java.lang.String, java.lang.String, java.lang.Exception) with the title and message based on the error code from the bean's ErrorInfo, as provided by the the getErrorTitle and getErrorMessage methods accordingly.
Transforms that would like to generate customized output based on the error should extend this method.

Overrides:

transformForRequestInError in class AbstractAppTransform

Parameters:

mo - output by this transform

Since:

MicroStrategy Web 8.0.2

See Also:

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

getSupportedBeanType

public java.lang.Class getSupportedBeanType()

return the bean type supported by this transform.

Specified by:

getSupportedBeanType in interface Transform

Overrides:

getSupportedBeanType in class AbstractAppTransform

Returns:

the bean type

getCancelEvent

protected WebEvent getCancelEvent()

Overrides:

getCancelEvent in class AbstractAppTransform

Returns:

WebEvent instance initialized with the information for cancelling a request

getDescription

public java.lang.String getDescription()

Return description for this Transform

Returns:

description for this Transform