java.lang.Object
- com.microstrategy.web.transform.AbstractTransform
- - com.microstrategy.web.transform.AbstractLayoutTransform
  - - com.microstrategy.web.app.transforms.AbstractAppTransform
    - - com.microstrategy.web.app.transforms.PromptsSummaryTransform

All Implemented Interfaces:

AppTransform, LayoutTransform, Transform
```
public class PromptsSummaryTransform
extends AbstractAppTransform
implements LayoutTransform
```
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 java.lang.String`	`_cssPromtAnswer`
`protected java.lang.String`	`_cssPromtNotAnswered`
`protected java.lang.String`	`_cssPromtNumber`
`protected java.lang.String`	`_cssPromtRequired`
`protected java.lang.String`	`_cssPromtSelection`
`protected java.lang.String`	`_cssPromtTitle`
`protected java.lang.String`	`_cssSummaryTable`	CSS valriables
`java.lang.String`	`FP_SHOW_ALL_PROMPTS`	Constant representing the name of the `showAllPrompts` formal parameter
`java.lang.String`	`FP_SHOW_REQUIRED_FIRST`	Constant representing the name of the `showRequiredFirst` formal parameter
`java.lang.String`	`FP_SHOW_YOUR_SELECTION_TEXT`	Constant representing the name of the `showYourSelectionText` formal parameter
`java.lang.String`	`FP_USE_BREAK_SEPARATOR`	Constant representing the name of the `useHTMLBreakSeparator` formal parameter
`protected FormalParameter`	`showAllPrompts`	Specifies whether to show all prompts in report page.
`protected FormalParameter`	`showRequiredFirst`	Specifies whether prompts defined as required will be rendered first or not.
`protected FormalParameter`	`showYourSelectionText`	Specifies whether or not to display "Your selection:" area.
`protected FormalParameter`	`useBackendDetails`	Whether to use backend's filter details when possible
`protected FormalParameter`	`useBreakSeparator`	Specifies whether to use an HTML break or not between prompt answers.

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

PromptsSummaryTransform()
Default no-args constructor.

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method	Description
`boolean`	`canTransform(Transformable data)`	Checks that the transform supports specified data object and that object is in the state supported by this transform.
`java.lang.String`	`getDescription()`	Indicates description for this Transform.
`protected PromptsBean`	`getPromptsBean()`	Returns active PromptBean instance used by this transform.
`java.util.ArrayList`	`getPromptsList()`	Returns current prompt list.
`java.lang.Class`	`getSupportedBeanType()`	Returns Bean type of prompt object being used by the transform.
`void`	`initializeCss()`	Initializes the css classes to be used by this transform.
`void`	`initializeTransform(Transformable data)`	Initializes the objects the transform will use to render its content.
`void`	`renderPrompt(MarkupOutput out, PromptObject prompt)`	Renders the prompt content.
`void`	`renderPrompt(PromptObject prompt, MarkupOutput out)`	Deprecated. use `renderPrompt(MarkupOutput out, PromptObject prompt)` instead.
`void`	`renderPromptDetails(MarkupOutput out)`
`void`	`renderPromptNotAnsweredText(MarkupOutput out)`	Renders localized message "Prompt not answered".
`void`	`renderPromptNumber(MarkupOutput out, PromptObject prompt)`	Renders prompt number.
`void`	`renderPromptObjects(MarkupOutput out, PromptObject prompt)`	Render Prompt objects.
`void`	`renderPromptsContent(MarkupOutput out)`	Renders output for all prompts.
`void`	`renderPromptTitle(MarkupOutput out, PromptObject prompt)`	Renders Prompt's title.
`void`	`renderRequiredPrompt(MarkupOutput out, PromptObject prompt)`	Renders required prompt text message.
`void`	`renderYourSelectionText(MarkupOutput out)`	Renders localized message "Your selection:".
`void`	`transformForRequestSuccessful(MarkupOutput out)`	Renders prompt when component status is marked as "Successful".
`boolean`	`useBackendDetails()`

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, getCancelEvent, 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, initializeImages, 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, renderImage, 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, 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
getFormalParams, getID, getPreview, isPreviewAvailable, isResolved, supports, supports, transform

- Field Detail
  - useBreakSeparator
```
protected FormalParameter useBreakSeparator
```
    Specifies whether to use an HTML break or not between prompt answers. Indicates if the different prompt answers selected to be displayed should be separated from each other using HTML break <BR> or no line break at all.
    This flag is used as boolean value.
    
    Since:
    
    MicroStrategy Web 8.0.0
  - FP_USE_BREAK_SEPARATOR
```
public final java.lang.String FP_USE_BREAK_SEPARATOR
```
    Constant representing the name of the useHTMLBreakSeparator formal parameter
    
    Since:
    
    MicroStrategy Web 8.0.0
    
    See Also:
    
    Constant Field Values
  - showRequiredFirst
```
protected FormalParameter showRequiredFirst
```
    Specifies whether prompts defined as required will be rendered first or not.
    Applies only when prompts are displayed in one page. Prompts can be sorted by priority.
    This flag is used as boolean value.
  - FP_SHOW_REQUIRED_FIRST
```
public final java.lang.String FP_SHOW_REQUIRED_FIRST
```
    Constant representing the name of the showRequiredFirst formal parameter
    
    Since:
    
    MicroStrategy Web 8.0.0
    
    See Also:
    
    Constant Field Values
  - showAllPrompts
```
protected FormalParameter showAllPrompts
```
    Specifies whether to show all prompts in report page.
    If set to false we will render only the open prompts. This flag is used as boolean value.
  - FP_SHOW_ALL_PROMPTS
```
public final java.lang.String FP_SHOW_ALL_PROMPTS
```
    Constant representing the name of the showAllPrompts formal parameter
    
    Since:
    
    MicroStrategy Web 8.0.0
    
    See Also:
    
    Constant Field Values
  - showYourSelectionText
```
protected FormalParameter showYourSelectionText
```
    Specifies whether or not to display "Your selection:" area.
    This flag is used as boolean value.
  - FP_SHOW_YOUR_SELECTION_TEXT
```
public final java.lang.String FP_SHOW_YOUR_SELECTION_TEXT
```
    Constant representing the name of the showYourSelectionText formal parameter
    
    Since:
    
    MicroStrategy Web 8.0.0
    
    See Also:
    
    Constant Field Values
  - useBackendDetails
```
protected FormalParameter useBackendDetails
```
    Whether to use backend's filter details when possible
    
    Since:
    
    MicroStrategy Web 9.0.0
  - _cssSummaryTable
```
protected java.lang.String _cssSummaryTable
```
    CSS valriables
  - _cssPromtNumber
```
protected java.lang.String _cssPromtNumber
```
  - _cssPromtTitle
```
protected java.lang.String _cssPromtTitle
```
  - _cssPromtRequired
```
protected java.lang.String _cssPromtRequired
```
  - _cssPromtSelection
```
protected java.lang.String _cssPromtSelection
```
  - _cssPromtAnswer
```
protected java.lang.String _cssPromtAnswer
```
  - _cssPromtNotAnswered
```
protected java.lang.String _cssPromtNotAnswered
```
- Constructor Detail
  - PromptsSummaryTransform
```
public PromptsSummaryTransform()
```
    Default no-args constructor.
    Initialize all Formal Parameters.
- Method Detail
  - getDescription
```
public java.lang.String getDescription()
```
    Indicates description for this Transform.
    
    Specified by:
    
    getDescription in interface Transform
    
    Returns:
    
    String "This is the Transform that renders the summary of all prompts."
  - initializeTransform
```
public void initializeTransform(Transformable data)
```
    Initializes the objects the transform will use to render its content.
    
    Specified by:
    
    initializeTransform in interface AppTransform
    
    Overrides:
    
    initializeTransform in class AbstractAppTransform
    
    Parameters:
    
    data - the prompt bean to transform
  - getPromptsBean
```
protected PromptsBean getPromptsBean()
```
    Returns active PromptBean instance used by this transform.
    
    Returns:
    
    PromptsBean instance.
  - transformForRequestSuccessful
```
public void transformForRequestSuccessful(MarkupOutput out)
```
    Renders prompt when component status is marked as "Successful".
    Method renderPromptsContent() is invoked in this function.
    
    Specified by:
    
    transformForRequestSuccessful in class AbstractAppTransform
    
    Parameters:
    
    out - where to write the output of the method.
    
    See Also:
    
    AbstractAppTransform.checkStatus(com.microstrategy.web.beans.MarkupOutput)
  - getSupportedBeanType
```
public java.lang.Class getSupportedBeanType()
```
    Returns Bean type of prompt object being used by the transform.
    
    Specified by:
    
    getSupportedBeanType in interface Transform
    
    Overrides:
    
    getSupportedBeanType in class AbstractAppTransform
    
    Returns:
    
    Class object, reference to PromptObject instance.
  - renderPromptsContent
```
public void renderPromptsContent(MarkupOutput out)
```
    Renders output for all prompts.
    
    Parameters:
    
    out - MarkupOutput the content output.
  - getPromptsList
```
public java.util.ArrayList getPromptsList()
```
    Returns current prompt list.
    List is consisted of all prompts defined in current Report.
    
    Returns:
    
    ArrayList collection of available prompts.
    
    Since:
    
    MicroStrategy Web 8.0.0
  - renderPrompt
```
public void renderPrompt(PromptObject prompt,
                         MarkupOutput out)
```
    Deprecated.
    use renderPrompt(MarkupOutput out, PromptObject prompt) instead.
    
    Renders prompt content.
    
    Parameters:
    
    out - MarkupOutput where to write prompt content.
    
    prompt - PromptObject current active instance.
  - renderPrompt
```
public void renderPrompt(MarkupOutput out,
                         PromptObject prompt)
```
    Renders the prompt content.
    
    Parameters:
    
    prompt - PromptObject the prompt to display
    
    out - MarkupOutput where to write the output of the method.
    
    Since:
    
    MicroStrategy Web 8.0.0
  - renderRequiredPrompt
```
public void renderRequiredPrompt(MarkupOutput out,
                                 PromptObject prompt)
```
    Renders required prompt text message.
    
    Parameters:
    
    out - MarkupOutput where to render prompts
    
    prompt - PromptObject current prompt being rendered.
    
    Since:
    
    MicroStrategy Web 8.0.0
  - renderPromptTitle
```
public void renderPromptTitle(MarkupOutput out,
                              PromptObject prompt)
```
    Renders Prompt's title.
    
    Parameters:
    
    out - MarkupOutput where to render prompt.
    
    prompt - PromptObject being parsed
    
    Since:
    
    MicroStrategy Web 8.0.0
  - renderPromptNumber
```
public void renderPromptNumber(MarkupOutput out,
                               PromptObject prompt)
```
    Renders prompt number.
    
    Parameters:
    
    out - MarkupOutput where to render prompt.
    
    prompt - PromptObject being parsed
    
    Since:
    
    MicroStrategy Web 8.0.0
  - renderPromptObjects
```
public void renderPromptObjects(MarkupOutput out,
                                PromptObject prompt)
```
    Render Prompt objects.
    
    Parameters:
    
    out - MarkupOutput where to render prompt.
    
    prompt - PromptObject being parsed
    
    Since:
    
    MicroStrategy Web 8.0.0
  - initializeCss
```
public void initializeCss()
```
    Initializes the css classes to be used by this transform.
    
    Overrides:
    
    initializeCss in class AbstractAppTransform
  - renderPromptNotAnsweredText
```
public void renderPromptNotAnsweredText(MarkupOutput out)
```
    Renders localized message "Prompt not answered".
    
    Parameters:
    
    out - where to write the output of the method.
    
    Since:
    
    MicroStrategy Web 8.0.0
  - renderYourSelectionText
```
public void renderYourSelectionText(MarkupOutput out)
```
    Renders localized message "Your selection:".
    
    Parameters:
    
    out - where to write the output of the method.
    
    Since:
    
    MicroStrategy Web 8.0.0
  - canTransform
```
public boolean canTransform(Transformable data)
```
    Description copied from interface: Transform
    
    Checks that the transform supports specified data object and that object is in the state supported by this transform.
    
    Specified by:
    
    canTransform in interface Transform
    
    Overrides:
    
    canTransform in class AbstractTransform
    
    Returns:
    
    true if the transform supports specified data object and the object is in the state supported by this transform.
    
    Since:
    
    MicroStrategy Web 8.0.1
  - renderPromptDetails
```
public void renderPromptDetails(MarkupOutput out)
```
    Since:
    
    MicroStrategy Web 9.0.0
  - useBackendDetails
```
public boolean useBackendDetails()
```
    Since:
    
    MicroStrategy Web 9.0.0

Class PromptsSummaryTransform

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.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.LayoutTransform

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

Field Detail

useBreakSeparator

FP_USE_BREAK_SEPARATOR

showRequiredFirst

FP_SHOW_REQUIRED_FIRST

showAllPrompts

FP_SHOW_ALL_PROMPTS

showYourSelectionText

FP_SHOW_YOUR_SELECTION_TEXT

useBackendDetails

_cssSummaryTable

_cssPromtNumber

_cssPromtTitle

_cssPromtRequired

_cssPromtSelection

_cssPromtAnswer

_cssPromtNotAnswered

Constructor Detail

PromptsSummaryTransform

Method Detail

getDescription

initializeTransform

getPromptsBean

transformForRequestSuccessful

getSupportedBeanType

renderPromptsContent

getPromptsList

renderPrompt

renderPrompt

renderRequiredPrompt

renderPromptTitle

renderPromptNumber

renderPromptObjects

initializeCss

renderPromptNotAnsweredText

renderYourSelectionText

canTransform

renderPromptDetails

useBackendDetails