Class RWSavePropertiesTransform
- 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
-
- com.microstrategy.web.app.transforms.RWSavePropertiesTransform
-
- All Implemented Interfaces:
AppTransform
,Transform
public class RWSavePropertiesTransform extends AbstractRWTransform
RWSavePropertiesTransform is the class that generates the output for a Report Writing document to be exported.
Please note this transform generates a form which will be submitted automatically after displayed,
therefore it is required the bean is transformed last in the page so any previous HTML/Javascript code
generated by other beans on the page is executed first.- Since:
- MicroStrategy Web 8.0.0
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class com.microstrategy.web.app.transforms.AbstractRWTransform
AbstractRWTransform.ButtonAlignmentsHelper
-
Nested classes/interfaces inherited from class com.microstrategy.web.app.transforms.AbstractAppTransform
AbstractAppTransform.Context
-
-
Field Summary
Fields Modifier and Type Field Description protected FormalParameter
addFileNameToURL
Determines whether to add the file name at the end of the URL.protected FormalParameter
eventToForwardTo
This is the name of the event to redirect to after updating the report page state.protected FormalParameter
setEventArguments
Defines if the arguments of the event to forward to should be set or not.protected FormalParameter
useURLRedirect
Determines whether to use a fake URL to avoid a problem with IE having two excel files open at the same time inside the browser.-
Fields inherited from class com.microstrategy.web.app.transforms.AbstractRWTransform
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 RWSavePropertiesTransform()
Default empty constructor.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
canTransform(Transformable data)
whether the data is transformable.WebEvent
getCancelEvent()
java.lang.String
getDescription()
Return description for this Transformprotected java.lang.String
getDisplayableMSTRFileName()
protected java.lang.String
getDisplayableObjectName()
protected java.lang.String
getFormActionName()
protected java.lang.String
getFormMethod()
protected java.lang.String
getSuggestedFileName()
protected void
renderCancelButton(MarkupOutput out)
Renders the Cancel button for the wait page.protected void
renderCloseWindowLink(Tag div)
Renders the anchor that displays the "Close window" message.void
renderProcessingInfoStatus(MarkupOutput out, java.lang.String label, java.lang.String status)
void
renderShell(MarkupOutput out)
Generates the shell for this Transform.void
transformForRequestInError(MarkupOutput mo)
Transform when the status is "InError".void
transformForRequestSuccessful(MarkupOutput mo)
Transform when the status is "Successful".-
Methods inherited from class com.microstrategy.web.app.transforms.AbstractRWTransform
displayError, generateErrorForIframe, getContinueEvent, getDocumentStatus, getDocumentStatusDescriptorKey, getErrorMessage, getErrorTitle, getHistoryListEvent, getInboxSource, getJobExpiredMessage, getReexecuteButtonDescription, getRefreshEvent, getRWBean, getRWFrame, getSupportedBeanType, getViewDetailsEvent, getWebReexecuteEvent, initializeImages, initializeTransform, isDesignMode, renderHistoryListButton, renderImage, renderProcessingButtons, renderProcessingInfo, renderProcessingInfoDetails, renderViewDetailsButton, setWebReexecuteEventArguments, transformForRequestNotInited, updateVisTransform
-
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, renderContextMenus, renderCssLink, renderDescriptor, renderDescriptor, renderErrorButton, renderHiddenInputFromRequest, renderLayout, renderProcessingButton, renderProcessingButton, renderProcessingButton, renderProcessingButtonForGet, renderProcessingButtonForGet, renderProcessingInfoData, renderProcessingInfoImage, renderProcessingInfoSubtitle, renderProcessingInfoTitle, renderProcessingObjectName, renderRefreshButton, renderRegisterBone, renderSelf, 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
protected FormalParameter eventToForwardTo
This is the name of the event to redirect to after updating the report page state.
Allowed Values: integer values representing WebEvent. It shall be defined in appBeanEvents.xml or mdBeanEvents.xml.
-
setEventArguments
protected FormalParameter setEventArguments
Defines if the arguments of the event to forward to should be set or not.
Default is true, to be set to false when only passing the bean state is required.
Allowed Values: TRUE/FALSE.
-
useURLRedirect
protected FormalParameter useURLRedirect
Determines whether to use a fake URL to avoid a problem with IE having two excel files open at the same time inside the browser.
The fake URL has the following format:
- for aspx:"Microstrategy/asp/number.exp.aspx"
- for jsp: "Microstrategy/export/number"
where the number is a unique identifier.
Internally we will redirect to the appropiate ASP/servlet.- Since:
- MicroStrategy Web 8.0.2
-
addFileNameToURL
protected FormalParameter addFileNameToURL
Determines whether to add the file name at the end of the URL.
This is added to aid the browser on choosing a file name when a PDF or Excel file is saved when displayed embeded in the browser.
The file name is added in the form:
...mstrWeb?n=/FileName.pdf
-
-
Method Detail
-
canTransform
public boolean canTransform(Transformable data)
whether the data is transformable.- Specified by:
canTransform
in interfaceTransform
- Overrides:
canTransform
in classAbstractTransform
- Parameters:
data
- the data- Returns:
- whether the data is transformable
-
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)
-
transformForRequestInError
public void transformForRequestInError(MarkupOutput mo)
Transform when the status is "InError".- Overrides:
transformForRequestInError
in classAbstractRWTransform
- Parameters:
mo
- output by this transform DE47839, if error occures when rendering rwframe bean, rwb will be rendered by this transform and display related error messages- See Also:
AbstractAppTransform.checkStatus(com.microstrategy.web.beans.MarkupOutput)
-
renderCloseWindowLink
protected void renderCloseWindowLink(Tag div)
Renders the anchor that displays the "Close window" message.- Parameters:
div
- the DIV tag where the anchor tag is rendered.
-
getFormMethod
protected java.lang.String getFormMethod()
- Since:
- MicroStrategy Web 9.0.0
-
getFormActionName
protected java.lang.String getFormActionName()
- Since:
- MicroStrategy Web 8.0.2
-
getSuggestedFileName
protected java.lang.String getSuggestedFileName()
- Since:
- MicroStrategy Web 9.0.0
-
getDisplayableObjectName
protected java.lang.String getDisplayableObjectName()
- Since:
- MicroStrategy Web 9.0.0
-
getDisplayableMSTRFileName
protected java.lang.String getDisplayableMSTRFileName()
-
renderShell
public void renderShell(MarkupOutput out)
Description copied from class:AbstractAppTransform
Generates the shell for this Transform.
The shell is a
The attributes to append to this<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.<div>
are obtained from thegetAttributesShellDiv
method; the style from thegetStyleShellDiv
method.
This method callsrenderCssLink
andcheckStatus
to generate the Transform's content.- Overrides:
renderShell
in classAbstractAppTransform
- Parameters:
out
- output by this transform
-
getCancelEvent
public WebEvent getCancelEvent()
- Overrides:
getCancelEvent
in classAbstractRWTransform
- 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
-
renderProcessingInfoStatus
public void renderProcessingInfoStatus(MarkupOutput out, java.lang.String label, java.lang.String status)
- Overrides:
renderProcessingInfoStatus
in classAbstractRWTransform
-
renderCancelButton
protected void renderCancelButton(MarkupOutput out) throws java.lang.IllegalStateException, java.lang.IllegalArgumentException, UnmodifiableException
Description copied from class:AbstractAppTransform
Renders the Cancel button for the wait page.
It callsAbstractAppTransform.getCancelEvent()
to obtain the event for the button
The button is not rendered if:
-AbstractAppTransform.getCancelEvent()
returns null
-AbstractAppTransform.processingButtonsFlags
does not haveAbstractAppTransform.PROCESSING_BUTTONS_CANCEL
- Overrides:
renderCancelButton
in classAbstractAppTransform
- Parameters:
out
- output for this transform- Throws:
java.lang.IllegalStateException
java.lang.IllegalArgumentException
UnmodifiableException
-
-