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

All Implemented Interfaces:

AppTransform, Transform

Direct Known Subclasses:

DocumentDetailsTransform, DocumentDetailsXHTMLTransform, DocumentFastExportTransform, DocumentSimpleTransform
```
public abstract class AbstractDocumentTransform
extends AbstractWebBeanTransform
```
AbstractDocumentTransform is an abstract class which acts as a super class for all document transforms. All functional document transform classes, such as DocumentDetailsTransform, DocumentSimpleTransform, ... extend from it. Copyright: Copyright (c) 2001

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

protected FormalParameter imgError
The name of the image used when the bean is in error status.
- 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

AbstractDocumentTransform()
Default no argument constructor.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method	Description
`boolean`	`canTransform(Transformable data)`	Returns true if the bean is not waiting for user input.
`protected WebEvent`	`getCancelEvent()`
`protected WebEvent`	`getContinueEvent()`	Returns an event to continue browsing if an error happened.
`protected DocumentBean`	`getDocumentBean()`	Returns the documentBean being transformed.
`java.lang.String`	`getDocumentStatus(int status)`	Get the document's status as a string representation.
`java.lang.String`	`getErrorMessage(int errorCode, java.lang.String defaultMessage)`	Returns the error message for the transform, based on the exception.
`static java.lang.String`	`getErrorMessageFromMSTRDocumentException(java.lang.Throwable cause, java.lang.String newline)`
`java.lang.String`	`getErrorTitle(int errorCode)`	Returns the error title for the transform, overwrites by returning title specific about document execution.
`protected WebEvent`	`getHistoryListEvent()`
`protected WebInboxSource`	`getInboxSource()`	Returns the InboxSource of this session.
`java.lang.String`	`getJobExpiredMessage()`
`java.lang.String`	`getReexecuteButtonDescription()`
`protected WebEvent`	`getRefreshEvent()`
`java.lang.Class`	`getSupportedBeanType()`	Returns the supported bean type for the transform.
`WebEvent`	`getWebReexecuteEvent()`	Returns the reexecute event Always get the event from the servlet.
`void`	`initializeImages()`	Initialize the images to be used by this transform.
`void`	`initializeTransform(Transformable data)`	This method initialize the private and protected fields of the transform.
`void`	`renderErrorButtons(MarkupOutput out, int errorCode, java.lang.String message)`	Deprecated. This method is no longer used by the Transform, all the logic is now in the transformForRequestInError
`void`	`renderErrorInfo(MarkupOutput out, int errorCode, java.lang.String message)`	Deprecated. This method is no longer used by the Transform, all the logic is now in the transformForRequestInError
`protected void`	`renderHistoryListButton(MarkupOutput out)`	Renders the History List button for the wait page.
`void`	`renderImage(MarkupOutput out, java.lang.String image)`	Renders a image for this transform.
`void`	`renderProcessingButtons(MarkupOutput out)`	Renders the buttons while processing.
`void`	`renderProcessingInfo(MarkupOutput out)`	Renders the information about the bean when it is still processing results.
`protected void`	`renderProcessingInfoDetails(MarkupOutput out)`
`void`	`setWebReexecuteEventArguments(WebEvent __result)`	Sets the reexecute web event's arguments
`void`	`transformForRequestInError(MarkupOutput out)`	Transform when the status is `In Error`.
`void`	`transformForRequestNotInited(MarkupOutput out)`	Transform when the status is `Not initialized`.

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

- Field Detail
  - imgError
```
protected FormalParameter imgError
```
    The name of the image used when the bean is in error status. Allowed Values:
    The value to indicate should be a valid image file name, with any necessary path information not included already on the resourcesFolderImage application configuration parameter.
- Constructor Detail
  - AbstractDocumentTransform
```
public AbstractDocumentTransform()
```
    Default no argument constructor.
- Method Detail
  - initializeTransform
```
public void initializeTransform(Transformable data)
```
    This method initialize the private and protected fields of the transform.
    It also invokes the initializeTransform method of the parent.
    
    Specified by:
    
    initializeTransform in interface AppTransform
    
    Overrides:
    
    initializeTransform in class AbstractAppTransform
    
    Parameters:
    
    data - The bean to transform.
  - initializeImages
```
public void initializeImages()
```
    Initialize the images to be used by this transform.
    
    Overrides:
    
    initializeImages in class AbstractAppTransform
  - transformForRequestNotInited
```
public void transformForRequestNotInited(MarkupOutput out)
```
    Transform when the status is Not initialized.
    
    Overrides:
    
    transformForRequestNotInited in class AbstractAppTransform
    
    Parameters:
    
    out - Output by this transform.
    
    See Also:
    
    AbstractAppTransform.checkStatus(com.microstrategy.web.beans.MarkupOutput)
  - getErrorMessageFromMSTRDocumentException
```
public static java.lang.String getErrorMessageFromMSTRDocumentException(java.lang.Throwable cause,
                                                                        java.lang.String newline)
```
  - transformForRequestInError
```
public void transformForRequestInError(MarkupOutput out)
```
    Transform when the status is In Error.
    
    Overrides:
    
    transformForRequestInError in class AbstractAppTransform
    
    Parameters:
    
    out - Output by this transform.
    
    See Also:
    
    AbstractAppTransform.checkStatus(com.microstrategy.web.beans.MarkupOutput)
  - renderErrorInfo
```
@Deprecated
public void renderErrorInfo(MarkupOutput out,
                            int errorCode,
                            java.lang.String message)
```
    Deprecated.
    This method is no longer used by the Transform, all the logic is now in the transformForRequestInError
    
    Render the message to display to the user in case there is an error.
    
    Parameters:
    
    out - The transform's output.
    
    errorCode - The ID of the error.
    
    message - The error message.
  - renderErrorButtons
```
@Deprecated
public void renderErrorButtons(MarkupOutput out,
                               int errorCode,
                               java.lang.String message)
```
    Deprecated.
    This method is no longer used by the Transform, all the logic is now in the transformForRequestInError
    
    Renders the "continue" or "re-execute" button for the user to continue working after an error occurs.
    
    Parameters:
    
    out - The transform's output.
    
    errorCode - The If of the error.
    
    message - The error message
  - getErrorTitle
```
public java.lang.String getErrorTitle(int errorCode)
```
    Returns the error title for the transform, overwrites by returning title specific about document execution.
    
    Overrides:
    
    getErrorTitle in class AbstractAppTransform
    
    Parameters:
    
    errorCode - The ID of the error.
    
    Returns:
    
    The error title.
  - getErrorMessage
```
public java.lang.String getErrorMessage(int errorCode,
                                        java.lang.String defaultMessage)
```
    Returns the error message for the transform, based on the exception.
    Overwrites by returning either the original message, or if none was provided, an "Error in document results"
    
    Overrides:
    
    getErrorMessage in class AbstractAppTransform
    
    Parameters:
    
    errorCode - The ID of the error.
    
    defaultMessage - The error's message.
    
    Returns:
    
    The error message.
  - renderProcessingInfo
```
public void renderProcessingInfo(MarkupOutput out)
```
    Renders the information about the bean when it is still processing results.
    Overwrites this method by showing information about the document.
    
    Overrides:
    
    renderProcessingInfo in class AbstractAppTransform
    
    Parameters:
    
    out - Output by this transform.
    
    See Also:
    
    AbstractAppTransform.transformForRequestProcessing(com.microstrategy.web.beans.MarkupOutput)
  - renderProcessingInfoDetails
```
protected void renderProcessingInfoDetails(MarkupOutput out)
```
    Since:
    
    MicroStrategy Web 8.0.2
  - getDocumentStatus
```
public java.lang.String getDocumentStatus(int status)
```
    Get the document's status as a string representation.
    
    Parameters:
    
    status - the status as an integer
    
    Returns:
    
    the status string
    
    Since:
    
    MicroStrategy Web 8.0.0
  - renderProcessingButtons
```
public void renderProcessingButtons(MarkupOutput out)
```
    Renders the buttons while processing.
    Overwrites by setting the corresponding buttons for Documents.
    
    Overrides:
    
    renderProcessingButtons in class AbstractAppTransform
    
    Parameters:
    
    out - Output by this transform.
    
    See Also:
    
    AbstractAppTransform.transformForRequestProcessing(com.microstrategy.web.beans.MarkupOutput)
  - renderHistoryListButton
```
protected void renderHistoryListButton(MarkupOutput out)
```
    Renders the History List button for the wait page.
    It calls getHistoryListEvent() to obtain the event used for the button
    The button is not rendered if:
    - getHistoryListEvent() returns null
    - AbstractAppTransform.processingButtonsFlags does not have AbstractAppTransform.PROCESSING_BUTTONS_HISTORY_LIST
    
    Parameters:
    
    out - output for this transform
    
    Since:
    
    MicroStrategy Web 8.1.0
  - getHistoryListEvent
```
protected WebEvent getHistoryListEvent()
```
    Since:
    
    MicroStrategy Web 8.1.0
  - getCancelEvent
```
protected WebEvent getCancelEvent()
```
    Overrides:
    
    getCancelEvent in class AbstractAppTransform
    
    Returns:
    
    WebEvent instance initialized with the information for cancelling a request
    
    Since:
    
    MicroStrategy Web 8.1.0
  - getRefreshEvent
```
protected WebEvent getRefreshEvent()
```
    Overrides:
    
    getRefreshEvent in class AbstractAppTransform
    
    Returns:
    
    WebEvent instance initialized with the information for refreshing the request
    
    Since:
    
    MicroStrategy Web 8.1.0
  - getDocumentBean
```
protected DocumentBean getDocumentBean()
```
    Returns the documentBean being transformed.
    
    Returns:
    
    The DocumentBean being transformed.
  - getInboxSource
```
protected WebInboxSource getInboxSource()
```
    Returns the InboxSource of this session.
    
    Returns:
    
    The InboxSource of this session.
  - setWebReexecuteEventArguments
```
public void setWebReexecuteEventArguments(WebEvent __result)
                                   throws WebBeanException
```
    Sets the reexecute web event's arguments
    
    Overrides:
    
    setWebReexecuteEventArguments in class AbstractWebBeanTransform
    
    Parameters:
    
    __result -
    
    Throws:
    
    WebBeanException
    
    Since:
    
    MicroStrategy Web 8.0.1
  - getWebReexecuteEvent
```
public WebEvent getWebReexecuteEvent()
```
    Description copied from class: AbstractWebBeanTransform
    
    Returns the reexecute event Always get the event from the servlet.
    
    Overrides:
    
    getWebReexecuteEvent in class AbstractWebBeanTransform
    
    Returns:
    
    the web reexecute event
    
    Since:
    
    MicroStrategy Web 8.0.1
  - getJobExpiredMessage
```
public java.lang.String getJobExpiredMessage()
```
    Overrides:
    
    getJobExpiredMessage in class AbstractWebBeanTransform
    
    Returns:
    
    the job expired message.
    
    Since:
    
    MicroStrategy Web 8.0.1
  - getContinueEvent
```
protected WebEvent getContinueEvent()
```
    Returns an event to continue browsing if an error happened.
    
    Since:
    
    MicroStrategy Web 8.0.0
  - renderImage
```
public void renderImage(MarkupOutput out,
                        java.lang.String image)
```
    Renders a image for this transform.
    Extends by including images of this transform.
    
    Overrides:
    
    renderImage in class AbstractAppTransform
    
    Parameters:
    
    out - Output by this transform.
    
    image - The image name
  - getSupportedBeanType
```
public java.lang.Class getSupportedBeanType()
```
    Returns the supported bean type for the transform.
    
    Specified by:
    
    getSupportedBeanType in interface Transform
    
    Overrides:
    
    getSupportedBeanType in class AbstractAppTransform
    
    Returns:
    
    The DocumentBean bean for this transform.
  - canTransform
```
public boolean canTransform(Transformable data)
```
    Returns true if the bean is not waiting for user input.
    
    Specified by:
    
    canTransform in interface Transform
    
    Overrides:
    
    canTransform in class AbstractTransform
    
    Parameters:
    
    data - The bean to be transformed.
    
    Returns:
    
    true if the bean is not waiting for user input.
  - getReexecuteButtonDescription
```
public java.lang.String getReexecuteButtonDescription()
```
    Overrides:
    
    getReexecuteButtonDescription in class AbstractWebBeanTransform
    
    Returns:
    
    the description of the reexecute button
    
    Since:
    
    MicroStrategy Web 8.0.1

Class AbstractDocumentTransform

Nested Class Summary

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

Field Summary

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

Constructor Summary

Method Summary

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

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

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

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

Methods inherited from class java.lang.Object

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

Field Detail

imgError

Constructor Detail

AbstractDocumentTransform

Method Detail

initializeTransform

initializeImages

transformForRequestNotInited

getErrorMessageFromMSTRDocumentException

transformForRequestInError

renderErrorInfo

renderErrorButtons

getErrorTitle

getErrorMessage

renderProcessingInfo

renderProcessingInfoDetails

getDocumentStatus

renderProcessingButtons

renderHistoryListButton

getHistoryListEvent

getCancelEvent

getRefreshEvent

getDocumentBean

getInboxSource

setWebReexecuteEventArguments

getWebReexecuteEvent

getJobExpiredMessage

getContinueEvent

renderImage

getSupportedBeanType

canTransform

getReexecuteButtonDescription