Class AbstractRWTransform
- 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.AbstractRWTransform
-
- All Implemented Interfaces:
AppTransform
,Transform
- Direct Known Subclasses:
AbstractMojoRWTransform
,AbstractSimplifiedRWXMLTransform
,IPhoneRWTransform
,RWDetailsTransform
,RWGridTransform
,RWIncrementalFetchTransform
,RWLayoutTransform
,RWSavePropertiesTransform
public abstract class AbstractRWTransform extends AbstractWebBeanTransform
AbstractRWTransform is an abstract class which acts as a super class for all report writing transforms. All functional report writing transform classes, such as RWLayoutTransform, RWSavePropertiesTransform, etc should extend from it.- Since:
- MicroStrategy Web 8.0.0
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description protected static class
AbstractRWTransform.ButtonAlignmentsHelper
Helper for button alignment configuration.-
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 AbstractRWTransform()
Default no argument constructor.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description protected void
displayError(MarkupOutput out, java.lang.String className, java.lang.String methodName, java.lang.Exception e, java.lang.String title, java.lang.String message, java.lang.String errorInfo, java.lang.String contactInfo, Tag extra)
void
generateErrorForIframe(MarkupOutput out, java.lang.String title, java.lang.String message, java.lang.String errorInfo, java.lang.String contactInfo, Tag extra)
protected WebEvent
getCancelEvent()
WebEvent
getContinueEvent()
Returns an event to continue browsing if an error happened.java.lang.String
getDocumentStatus(int status)
Get the document's status as a string representation.static int
getDocumentStatusDescriptorKey(int status)
Get the descriptor key for the document's status.java.lang.String
getErrorMessage(WebBeanError error)
Returns the error message for the transform, based on the error.java.lang.String
getErrorTitle(WebBeanError error)
Returns the error title for the transform, based on the error.protected WebEvent
getHistoryListEvent()
protected WebInboxSource
getInboxSource()
return theWebInboxSource
of this session.java.lang.String
getJobExpiredMessage()
java.lang.String
getReexecuteButtonDescription()
protected WebEvent
getRefreshEvent()
protected RWBean
getRWBean()
Returns the report writing bean being transformed.protected RWFrameBean
getRWFrame()
java.lang.Class
getSupportedBeanType()
Returns the supported bean type for the transform.protected WebEvent
getViewDetailsEvent()
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.protected boolean
isDesignMode()
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.protected void
renderProcessingInfoDetails(MarkupOutput out)
protected void
renderProcessingInfoStatus(MarkupOutput out, java.lang.String label, java.lang.String status)
protected void
renderViewDetailsButton(MarkupOutput out)
Renders the View Details button for the wait page.void
setWebReexecuteEventArguments(WebEvent __result)
Sets the reexecute web event's argumentsvoid
transformForRequestInError(MarkupOutput out)
Transform when the status isIn Error
.void
transformForRequestNotInited(MarkupOutput out)
Transform when the status isNot initialized
.protected void
updateVisTransform(TransformInstance transformInstance, RWObject object)
-
Methods inherited from class com.microstrategy.web.app.transforms.AbstractWebBeanTransform
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, getErrorMessage, getErrorTitle, 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, transformForRequestSuccessful, 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, 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 theresourcesFolderImage
application configuration parameter.
-
-
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 interfaceAppTransform
- Overrides:
initializeTransform
in classAbstractAppTransform
- Parameters:
data
- The bean to transform.
-
initializeImages
public void initializeImages()
Initialize the images to be used by this transform.- Overrides:
initializeImages
in classAbstractAppTransform
-
transformForRequestNotInited
public void transformForRequestNotInited(MarkupOutput out)
Transform when the status isNot initialized
.- Overrides:
transformForRequestNotInited
in classAbstractAppTransform
- Parameters:
out
- Output by this transform.- See Also:
AbstractAppTransform.checkStatus(com.microstrategy.web.beans.MarkupOutput)
-
transformForRequestInError
public void transformForRequestInError(MarkupOutput out)
Transform when the status isIn Error
.- Overrides:
transformForRequestInError
in classAbstractAppTransform
- Parameters:
out
- Output by this transform.- See Also:
AbstractAppTransform.checkStatus(com.microstrategy.web.beans.MarkupOutput)
-
displayError
protected void displayError(MarkupOutput out, java.lang.String className, java.lang.String methodName, java.lang.Exception e, java.lang.String title, java.lang.String message, java.lang.String errorInfo, java.lang.String contactInfo, Tag extra)
-
generateErrorForIframe
public void generateErrorForIframe(MarkupOutput out, java.lang.String title, java.lang.String message, java.lang.String errorInfo, java.lang.String contactInfo, Tag extra)
- Overrides:
generateErrorForIframe
in classAbstractWebBeanTransform
-
getErrorMessage
public java.lang.String getErrorMessage(WebBeanError error)
Returns the error message for the transform, based on the error.- Parameters:
error
-WebBeanError
instance with the information that made the document to break- Returns:
- The error message.
-
getErrorTitle
public java.lang.String getErrorTitle(WebBeanError error)
Returns the error title for the transform, based on the error.- Parameters:
error
-WebBeanError
instance with the information that made the document to break- Returns:
- The title for the error message.
-
renderProcessingInfo
public void renderProcessingInfo(MarkupOutput out)
Renders the information about the bean. Overwrites this method by showing information specific for the rw document.- Overrides:
renderProcessingInfo
in classAbstractAppTransform
- 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
-
renderProcessingInfoStatus
protected void renderProcessingInfoStatus(MarkupOutput out, java.lang.String label, java.lang.String status)
-
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
-
getDocumentStatusDescriptorKey
public static int getDocumentStatusDescriptorKey(int status)
Get the descriptor key for the document's status.- Parameters:
status
- the status as an integer- Returns:
- the descriptor key as in integer
-
renderProcessingButtons
public void renderProcessingButtons(MarkupOutput out)
Renders the buttons while processing. By default renders a "Check Status" button, associated with a EnumPageEvents.WebEventRefresh event, 'Add to History List', and a "Cancel this Request" buttons associated with a EnumServletEvents.WebEventCancel event.- Overrides:
renderProcessingButtons
in classAbstractAppTransform
- Parameters:
out
- output by this transform- See Also:
AbstractAppTransform.transformForRequestProcessing(com.microstrategy.web.beans.MarkupOutput)
-
getCancelEvent
protected WebEvent getCancelEvent()
- Overrides:
getCancelEvent
in classAbstractAppTransform
- Returns:
WebEvent
instance initialized with the information for cancelling a request
-
renderHistoryListButton
protected void renderHistoryListButton(MarkupOutput out)
Renders the History List button for the wait page.
It callsgetHistoryListEvent()
to obtain the event used for the button
The button is not rendered if:
-getHistoryListEvent()
returns null
-AbstractAppTransform.processingButtonsFlags
does not haveAbstractAppTransform.PROCESSING_BUTTONS_HISTORY_LIST
- Parameters:
out
- output for this transform
-
getHistoryListEvent
protected WebEvent getHistoryListEvent()
- Returns:
WebEvent
instance initialized with the information for the history list
-
getRefreshEvent
protected WebEvent getRefreshEvent()
- Overrides:
getRefreshEvent
in classAbstractAppTransform
- Returns:
WebEvent
instance initialized with the information for refreshing the request
-
renderViewDetailsButton
protected void renderViewDetailsButton(MarkupOutput out)
Renders the View Details button for the wait page.
It callsgetViewDetailsEvent()
to obtain the event used for the button
The button is not rendered if:
-getViewDetailsEvent()
returns null
-AbstractAppTransform.processingButtonsFlags
does not haveAbstractAppTransform.PROCESSING_BUTTONS_VIEW_DETAILS
- Parameters:
out
- output for this transform
-
getViewDetailsEvent
protected WebEvent getViewDetailsEvent()
- Returns:
WebEvent
instance initialized with the information for going to the details page
-
getInboxSource
protected WebInboxSource getInboxSource()
return theWebInboxSource
of this session.- Returns:
- the WebInboxSource of this session.
-
getRWBean
protected RWBean getRWBean()
Returns the report writing bean being transformed.- Returns:
- The
RWBean
being transformed.
-
setWebReexecuteEventArguments
public void setWebReexecuteEventArguments(WebEvent __result) throws WebBeanException
Sets the reexecute web event's arguments- Overrides:
setWebReexecuteEventArguments
in classAbstractWebBeanTransform
- 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 classAbstractWebBeanTransform
- Returns:
- the web reexecute event
- Since:
- MicroStrategy Web 8.0.1
-
getJobExpiredMessage
public java.lang.String getJobExpiredMessage()
- Overrides:
getJobExpiredMessage
in classAbstractWebBeanTransform
- Returns:
- the job expired message.
- Since:
- MicroStrategy Web 8.0.1
-
getContinueEvent
public WebEvent getContinueEvent()
Returns an event to continue browsing if an error happened.
-
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 classAbstractAppTransform
- 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 interfaceTransform
- Overrides:
getSupportedBeanType
in classAbstractAppTransform
- Returns:
- The
RWBean
bean for this transform.
-
getReexecuteButtonDescription
public java.lang.String getReexecuteButtonDescription()
- Overrides:
getReexecuteButtonDescription
in classAbstractWebBeanTransform
- Returns:
- the description of the reexecute button
- Since:
- MicroStrategy Web 8.0.1
-
updateVisTransform
protected void updateVisTransform(TransformInstance transformInstance, RWObject object)
- Since:
- MicroStrategy Web 8.1.1
-
isDesignMode
protected boolean isDesignMode()
- Since:
- MicroStrategy Web 9.0.0
-
getRWFrame
protected RWFrameBean getRWFrame()
- Since:
- MicroStrategy Web 9.0.0
-
-