Package com.microstrategy.web.app.transforms

Class PromptsCreateReportTransform

java.lang.Object

com.microstrategy.web.transform.AbstractTransform

com.microstrategy.web.transform.AbstractLayoutTransform

com.microstrategy.web.app.transforms.AbstractAppTransform

com.microstrategy.web.app.transforms.PromptsClassicTransform

com.microstrategy.web.app.transforms.PromptsCreateReportTransform

All Implemented Interfaces:

AppTransform, LayoutTransform, Transform

public class PromptsCreateReportTransform
extends PromptsClassicTransform

The PromptsCreateReportTransform customizes the PromptsClassicTransform to use it within the Create Report/Document page.

The changes mainly consist on controlling if the warning message with the:

Before you can edit or save this report, you must answer the following prompt(s).

message is displayed. It also changes the default message used for the execute button to Edit in Design Mode.

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	showSaveReportButton	Indicates whether or not to display 'Save' button.

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

_1ptransImage, _firstPrompt, _imagesFolder, _lastPrompt, _lowerCornerImage, _nextBlockPrompt, _nextPrompt, _pb, _previousBlockPrompt, _previousPrompt, _totalPrompts, _upperCornerImage, blockCount, canCancelPrompt, DEFAULT_STYLE, displayMode, executeButtonLabel, exportDocumentLabel, exportReportLabel, firstIncFecthImage, formID, incrementalAttrElemBlockCount, incrementalObjectsBlockCount, indexContentPostfixImage, indexListPostfixImage, isDhtmlMode, lastIncFecthImage, levelFlag, lowerCornerImage, MODE_ALL, MODE_ONE_BY_ONE, multiplePromptCssFile, nextIncFecthImage, previousIncFecthImage, PROMPT_LOADED_ARG, promptQuestionLevelFlag, renderForm, showExecuteAtBottom, showExecuteAtTop, showMatchCase, showRequired, showRequiredFirst, STYLE_NAME_PROPERTY, summaryImage, upperCornerImage

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
PromptsCreateReportTransform()	Default no-args constructor.

Method Summary

Modifier and Type	Method	Description
protected boolean	canSavePrompt()	Indicates whether or not end-user is enabled to save given Prompted Report.
protected boolean	checkLevel(int iLevelConst)	Customized checkLevel function that overrides parent's behavior when formal parameter checkLevelustom is active.
java.lang.String	getExecuteButtonLabel()	Changes the default label to be used by the 'Execute' button to Execute in View mode if isViewMode returns true, or Edit in Design Mode otherwise.
protected boolean	isViewMode()	Determines whether PromptBean container has View mode active.
void	renderWarningHeaderMessage(MarkupOutput out)	Renders any mesage before rendering prompts forms and prompt index.

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

areRequiredPromptsShownFirst, canCancelPrompt, canDisplaySaveButton, displayPromptOneByOne, generateAnchor, generateIndexLink, getAnchorPinFromRequest, getAnswerEvent, getBlockEnd, getBlockInit, getCancelEvent, getCurrentIndex, getCurrentPromptDisplayPosition, getDecimalSeparator, getDefaultStyleName, getDescription, getIsDatasetAddedArgumentName, getNavigationArgument, getPromptDisplayPosition, getPromptsAppContext, getPromptsBean, getPromptsList, getPromptsListForIndexSection, getPromptsListForSummary, getPromptsListOneByOne, getPromptTransformByStyle, getRenameMessageLabel, getRePromptArgumentName, getSaveButtonLabel, getSaveEvent, getStyleName, getSupportedBeanType, getTotalOpenPrompts, initializeImages, initializePromptQuestionProperties, initializeTransform, isAddDatasetInRequest, isBottomExecuteButtonViewable, isDhtmlMode, isExecuteSectionAvailable, isForDefinition, isItemKeptInCartAvailable, isMatchCaseShown, isMultipartRequestEnabled, isMultiplePrompt, isOneByOneDisplayMode, isPromptIndexAvailable, isPromptIndexViewable, isPromptQuestionsAvailable, isPromptSummaryViewable, isReprompted, isTopExecuteButtonViewable, isTreeRequest, processPromptedMetricAdded, promptsLoadedFirstTime, renderCalendar, renderCancelButton, renderExecuteBar, renderExecuteButton, renderExecuteButtons, renderFirstPreviousIncrementalFetch, renderFirstPreviousIncrementalFetch, renderFormContent, renderFormEnd, renderFormStart, renderGenericErrorMessage, renderImage, renderImage, renderIncrementalFetch, renderIncrementalFetchImage, renderIndexImage, renderIndexLinkEnd, renderIndexLinkStart, renderJavaScriptFooter, renderJavaScriptHeader, renderLabel, renderLabel, renderMultiplePromptCssLink, renderNextButton, renderNextLastIncrementalFetch, renderNextLastIncrementalFetch, renderPreviousButton, renderPrompt, renderPrompt, renderPrompt, renderPrompt, renderPromptAnchor, renderPromptAnchor, renderPromptIncrementalFetchButtons, renderPromptIndex, renderPromptNumber, renderPromptNumber, renderPromptsContainer, renderPromptsContent, renderPromptsIndex, renderPromptsNonLayoutContainer, renderPromptsSummary, renderPromptSummaryButton, renderPromptSummaryIndexSection, renderRenameMessage, renderRootFolderBrowserHiddenValue, renderSaveButton, renderTitleImage, renderWarnigHeaderMessage, setIncrementalFetchPrompts, shouldDisplayRenameMessage, showPromptSummary, transformForRequestSuccessful

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

addContactInfo, addDynamicScriptClass, addDynamicScriptFile, addFormalParameter, checkLevel, checkProcessingButtonsFlag, checkProcessingInfoFlag, checkStatus, displayError, displayError, displayError, emptyCell, excludeStaticTags, 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, 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, renderProcessingButtons, renderProcessingInfo, renderProcessingInfoData, renderProcessingInfoImage, renderProcessingInfoSubtitle, renderProcessingInfoTitle, renderProcessingObjectName, renderRefreshButton, renderRegisterBone, renderSelf, renderShell, renderSubBlock, renderUserHelpAnchor, setBoneProperties, setDisplayMode, setHasSubBlock, setHeight, setIFrameDisplayMode, setIsDormant, setRenderSubBlock, setShellAttributeOnClosedComponent, setWidth, shouldDisplay, transform, transformForRequestCanceled, transformForRequestInError, transformForRequestNotInited, transformForRequestProcessing, 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.LayoutTransform

getLayoutDefinition, setLayoutDefinition

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

canTransform, getFormalParams, getID, getPreview, isPreviewAvailable, isResolved, supports, supports, transform

Field Detail

showSaveReportButton

public FormalParameter showSaveReportButton

Indicates whether or not to display 'Save' button.

Constructor Detail

PromptsCreateReportTransform

public PromptsCreateReportTransform()

Default no-args constructor. Invoke parent's class constructor to initialize all corresponding properties

Method Detail

getExecuteButtonLabel

public java.lang.String getExecuteButtonLabel()

Changes the default label to be used by the 'Execute' button to Execute in View mode if isViewMode returns true, or Edit in Design Mode otherwise.

However if the formal parameter executeButtonLabel is specified, it will use its value as the ID for a message in the Resource Bundle.

Overrides:

getExecuteButtonLabel in class PromptsClassicTransform

Returns:

String localized message.

Since:

MicroStrategy Web 7.5.1

renderWarningHeaderMessage

public void renderWarningHeaderMessage(MarkupOutput out)

Renders any mesage before rendering prompts forms and prompt index.

Overrides:

renderWarningHeaderMessage in class PromptsClassicTransform

Parameters:

out - MarkupOutput where to write the output of the method.

Since:

MicroStrategy Web 8.0.0

checkLevel

protected boolean checkLevel(int iLevelConst)

Customized checkLevel function that overrides parent's behavior when formal parameter checkLevelustom is active.
When requested, this function will change behavior and will return true if 'Warning header message' flag is on and ReportBean mode is set to View mode only. If checkLevelCustom isn't active, then normal checkLevel behavior will take place.

Overrides:

checkLevel in class PromptsClassicTransform

Parameters:

iLevelConst - level flag

Returns:

true means the level flag is included in the level parameter value

Since:

MicroStrategy Web 7.5.1

canSavePrompt

protected boolean canSavePrompt()

Indicates whether or not end-user is enabled to save given Prompted Report.
Useful to determine whether or not to displaye 'Save' button in Prompt page.

Overrides:

canSavePrompt in class PromptsClassicTransform

Returns:

true if user has proper permissions.

Since:

MicroStrategy Web 8.0.0

isViewMode

protected boolean isViewMode()

Determines whether PromptBean container has View mode active.
This function assumes that container bean is ReportFrameBean. If that's the case, it checks its design mode property.

Returns:

boolean true is view mode is active.

Since:

MicroStrategy Web 7.5.1