Class PromptsSubscriptionTransform
- 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.PromptsSubscriptionTransform
-
- All Implemented Interfaces:
AppTransform
,LayoutTransform
,Transform
public class PromptsSubscriptionTransform extends PromptsClassicTransform
Extends PromptsClassicTransform by changing the form to work with the Scheduling and Subscription beans. This beans create their own form and have their own cancel events. This transforms makes use ofTag
instances to render HTML output. See reference toTagsFactory
.- 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 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 PromptsSubscriptionTransform()
Default no-args constructor.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected WebEvent
getCancelEvent()
Returns event instance for cancelling a schedule entry.void
renderCancelSubscription(MarkupOutput out)
Renders 'cancel' button for a prompted report subscription.void
renderExecuteButtons(MarkupOutput out)
Renders the output for the execute/cancel buttons.void
renderFormEnd(MarkupOutput out)
Renders closing HTML tag for prompt's form.void
renderFormStart(MarkupOutput out)
Renders opening HTML tag for Prompt's form.-
Methods inherited from class com.microstrategy.web.app.transforms.PromptsClassicTransform
areRequiredPromptsShownFirst, canCancelPrompt, canDisplaySaveButton, canSavePrompt, checkLevel, displayPromptOneByOne, generateAnchor, generateIndexLink, getAnchorPinFromRequest, getAnswerEvent, getBlockEnd, getBlockInit, getCurrentIndex, getCurrentPromptDisplayPosition, getDecimalSeparator, getDefaultStyleName, getDescription, getExecuteButtonLabel, 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, renderFirstPreviousIncrementalFetch, renderFirstPreviousIncrementalFetch, renderFormContent, 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, renderWarningHeaderMessage, 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
-
-
-
-
Method Detail
-
renderFormStart
public void renderFormStart(MarkupOutput out)
Renders opening HTML tag for Prompt's form.
Overwrites the renderFormStart by not rendering the FORM tag. The Subscription transforms are responsible of rendering their own form.- Overrides:
renderFormStart
in classPromptsClassicTransform
- Parameters:
out
- where to write the output of the method.
-
renderFormEnd
public void renderFormEnd(MarkupOutput out)
Renders closing HTML tag for prompt's form.
Overwrites the renderFormEnd by not rendering the FORM tag. The Subscription transforms are responsible of rendering their own form.- Overrides:
renderFormEnd
in classPromptsClassicTransform
- Parameters:
out
- where to write the output of the method.
-
getCancelEvent
protected WebEvent getCancelEvent()
Returns event instance for cancelling a schedule entry.- Overrides:
getCancelEvent
in classPromptsClassicTransform
- Returns:
- the correct cancel event depending on the parent type.
-
renderExecuteButtons
public void renderExecuteButtons(MarkupOutput out)
Renders the output for the execute/cancel buttons.- Overrides:
renderExecuteButtons
in classPromptsClassicTransform
- Parameters:
out
- where to write the output of the method.
-
renderCancelSubscription
public void renderCancelSubscription(MarkupOutput out)
Renders 'cancel' button for a prompted report subscription.- Parameters:
out
- MarkupOutput where to write button.- Since:
- MicroStrategy Web 8.0.0
-
-