Class DocumentFastExportTransform
- 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.AbstractDocumentTransform
-
- com.microstrategy.web.app.transforms.DocumentFastExportTransform
-
- All Implemented Interfaces:
AppTransform
,Transform
public class DocumentFastExportTransform extends AbstractDocumentTransform
DocumentFastExportTransform is the class that generates the output for a DocumentBean before fast exporting- Since:
- MicroStrategy Web 7.3.1 or earlier
-
-
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 FormalParameter
eventToForwardTo
This is the ID of the event to be executed by the HTML form to be rendered and submitted automatically by this Transform.static java.lang.String
FP_EVENT_SET_ARGUMENTS
static java.lang.String
FP_EVENT_TO_FORWARD_TO
FormalParameter
setEventArguments
Defines if the arguments of the event specified in the formal parameter eventToForwardTo should be set or not.-
Fields inherited from class com.microstrategy.web.app.transforms.AbstractDocumentTransform
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 DocumentFastExportTransform()
Default no argument constructor.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.String
getDescription()
Return description for this Transform.protected WebEvent
setEventArgumentsFromRequestKeys(WebEvent event, RequestKeys rk)
Checks for all the parameters on the request keys and if they are arguments of the event, it asigns the value of the parameter to the event's argument Note: if none of the request's parameters are arguments of teh event it returns the original eventvoid
transformForRequestSuccessful(MarkupOutput mo)
Transform when the status is "Successful".-
Methods inherited from class com.microstrategy.web.app.transforms.AbstractDocumentTransform
canTransform, getCancelEvent, getContinueEvent, getDocumentBean, getDocumentStatus, getErrorMessage, getErrorMessageFromMSTRDocumentException, getErrorTitle, getHistoryListEvent, getInboxSource, getJobExpiredMessage, getReexecuteButtonDescription, getRefreshEvent, getSupportedBeanType, getWebReexecuteEvent, initializeImages, initializeTransform, renderErrorButtons, renderErrorInfo, renderHistoryListButton, renderImage, renderProcessingButtons, renderProcessingInfo, renderProcessingInfoDetails, setWebReexecuteEventArguments, transformForRequestInError, transformForRequestNotInited
-
Methods inherited from class com.microstrategy.web.app.transforms.AbstractWebBeanTransform
generateErrorForIframe, 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, 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, renderShell, renderSubBlock, renderUserHelpAnchor, setBoneProperties, 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, 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
getFormalParams, getPreview, isPreviewAvailable, isResolved, supports, supports
-
-
-
-
Field Detail
-
eventToForwardTo
public FormalParameter eventToForwardTo
This is the ID of the event to be executed by the HTML form to be rendered and submitted automatically by this Transform.
This transform allows a page including document beans to be fully processed before redirecting the user request to the next page, which will be indicated by the event ID defined on this formal parameter. Typically this event will be a servlet event with a target attribute, so that we can redirect to the page specified as the target.
-
setEventArguments
public FormalParameter setEventArguments
Defines if the arguments of the event specified in the formal parameter eventToForwardTo should be set or not.
If this value is set to true, we will parse the request keys and look for any argument names which are acceptable by the eventToForwardTo event, and if we find any, we will set them on the event.
-
FP_EVENT_TO_FORWARD_TO
public static final java.lang.String FP_EVENT_TO_FORWARD_TO
- See Also:
- Constant Field Values
-
FP_EVENT_SET_ARGUMENTS
public static final java.lang.String FP_EVENT_SET_ARGUMENTS
- See Also:
- Constant Field Values
-
-
Method Detail
-
transformForRequestSuccessful
public void transformForRequestSuccessful(MarkupOutput mo)
Transform when the status is "Successful".- Specified by:
transformForRequestSuccessful
in classAbstractAppTransform
- Parameters:
mo
- Output by this transform.- See Also:
AbstractAppTransform.checkStatus(com.microstrategy.web.beans.MarkupOutput)
-
setEventArgumentsFromRequestKeys
protected WebEvent setEventArgumentsFromRequestKeys(WebEvent event, RequestKeys rk)
Checks for all the parameters on the request keys and if they are arguments of the event, it asigns the value of the parameter to the event's argument Note: if none of the request's parameters are arguments of teh event it returns the original event- Parameters:
event
- The WebEvent to forward to as specified in the formal parameter eventToForwardTo.rk
- The RequestKeys from which we have to set argument values on the event.- Returns:
- The new event with all arguments set.
-
getDescription
public java.lang.String getDescription()
Return description for this Transform.- Returns:
- The description for this Transform.
-
-