Package com.microstrategy.web.app.transforms

Class PromptExpressionWidgetTransform

java.lang.Object

com.microstrategy.web.transform.AbstractTransform

com.microstrategy.web.transform.AbstractLayoutTransform

com.microstrategy.web.app.transforms.AbstractAppTransform

com.microstrategy.web.app.transforms.AbstractAppWidgetTransform

com.microstrategy.web.app.transforms.AbstractPromptWidgetTransform

com.microstrategy.web.app.transforms.PromptExpressionWidgetTransform

All Implemented Interfaces:

AppTransform, LayoutTransform, Transform

Direct Known Subclasses:

PromptHierarchyWidgetTransform

public class PromptExpressionWidgetTransform
extends AbstractPromptWidgetTransform
implements LayoutTransform

Since:

MicroStrategy Web 9.0.0

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 WebExpressionPrompt	_ep
protected ExpressionPromptBean	_expPromptBean

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

_prompt, _promptAppBean, _promptPosition, displayModel

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
PromptExpressionWidgetTransform()

Method Summary

Modifier and Type	Method	Description
java.lang.String	getAllFormsInteger()
void	getAllowedFunctions(BlockList list)
java.util.List<FlattenedTreeNode>	getAnswer()	Returns a flattened enumeration of answer expression tree.
java.util.List<WebAttributeForm>	getAttForms(WebAttribute att)
Block	getAvailableFolderWidget(java.lang.String styleName)
Block	getAvailableFolderWidget(java.lang.String styleName, java.lang.String paramName, java.lang.Object paramValue)
Block	getAvailableFolderWidget(java.lang.String styleName, java.lang.String paramName1, java.lang.Object paramValue1, java.lang.String paramName2, java.lang.Object paramValue2, java.lang.String paramName3, java.lang.Object paramValue3, java.lang.String paramName4, java.lang.Object paramValue4, java.lang.String paramName5, java.lang.Object paramValue5)
java.lang.String	getDefaultAnswerAsString()
java.lang.String	getDefaultFunction()
java.lang.String	getDescription()	Returns a textual description of the transform.
java.lang.String	getDisplayedForms()
java.lang.String	getEmptyTreeText(int descriptor)
java.lang.String	getRestriction()
WebSearch	getSearchObject()	subclass can override this method to return its search object associated with the avialable part.
java.lang.String	getSearchRequiredText()
WebFolder	getSuggestedAnswers()
java.lang.Class	getSupportedBeanType()	Get the class of objects this transform is able to handle.
boolean	hasNonEmptySearchResults()
void	initializeWebComponent(Transformable data)	Initialize the web component to be used by the transform.
boolean	isAllowDisplayOutputLevelSelector()
boolean	isAttributeQualification()
boolean	isAvailableFlattenedExisting()
boolean	isHierarchyQualification()
boolean	isMetricQualification()
boolean	isSAPQualification()
boolean	shouldRenderDualCart()
boolean	shouldRenderNoneOption()
boolean	showIncrementalFetch()

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

allowMultipleUserAnswer, allowSingleUserAnswer, getAnswerFormat, getAnswerOption, getAnswerRestriction, getChildWidget, getChildWidget, getDataFormsWidget, getDefaultAnswer, getDefaultSavingAnswer, getDisplayProperty, getDisplayStyleName, getElementsAsList, getErrorMessage, getItemWidget, getNamePrefixForSingleSavedAnswer, getPromptIndex, getPromptMeaning, getPromptName, getPromptTitle, getPropertyDefaultSelection, getPropertyHeightValue, getPropertyValue, getPropertyWidthValue, getSavedAnswers, getSearchTypes, hasError, hasSavedAnswers, isAutoCloseAnswer, isAvailableFolderAvailable, isCartStyle, isCheckboxStyle, isDefaultAnswer, isDisplayingModel, isDisplaySearchPropOn, isHICart_or_TreeStyle, isHICartStyle, isListStyle, isMultiListStyle, isNonCartStyle, isOneByOneDisplayMode, isPropertyWidthFixed, isPulldownStyle, isRadioStyle, isReprompting, isSingleListStyle, isTextboxStyle, isTreeStyle, isTrimmedTree, isUseFolderStructure, showObjectDescription, showSearchBox, showSearchBoxOrTreeStyle, usingDefaultAnswer

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

buildFlattenedExpression, getAttForms, getChildWidget, getCssName, getIserverNodeFunction, getObjectInfoCssName, getPreferenceValueReplaceNull, getSelf, includeAncestorInfo, includeFolderInfo, includeOwnerInfo, includeTimeInfo, insertChildren, inTreeStructure, isNull, isShowObjectTags, renderShell, renderTest, transformForRequestSuccessful

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, initializeCss, initializeImages, initializeTransform, 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, 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

_ep

protected WebExpressionPrompt _ep

_expPromptBean

protected ExpressionPromptBean _expPromptBean

Constructor Detail

PromptExpressionWidgetTransform

public PromptExpressionWidgetTransform()

Method Detail

getDescription

public java.lang.String getDescription()

Description copied from interface: Transform

Returns a textual description of the transform.

Specified by:

getDescription in interface Transform

Returns:

The textual description of the transform.

initializeWebComponent

public void initializeWebComponent(Transformable data)

Description copied from class: AbstractAppTransform

Initialize the web component to be used by the transform.

Specified by:

initializeWebComponent in interface AppTransform

Overrides:

initializeWebComponent in class AbstractPromptWidgetTransform

Parameters:

data - the bean to transform.

getAvailableFolderWidget

public Block getAvailableFolderWidget(java.lang.String styleName)

getAvailableFolderWidget

public Block getAvailableFolderWidget(java.lang.String styleName,
                                      java.lang.String paramName,
                                      java.lang.Object paramValue)

getAvailableFolderWidget

public Block getAvailableFolderWidget(java.lang.String styleName,
                                      java.lang.String paramName1,
                                      java.lang.Object paramValue1,
                                      java.lang.String paramName2,
                                      java.lang.Object paramValue2,
                                      java.lang.String paramName3,
                                      java.lang.Object paramValue3,
                                      java.lang.String paramName4,
                                      java.lang.Object paramValue4,
                                      java.lang.String paramName5,
                                      java.lang.Object paramValue5)

getAnswer

public java.util.List<FlattenedTreeNode> getAnswer()

Returns a flattened enumeration of answer expression tree.

Returns:

An Enumeration of FlattenedTreeNode objects.

getSearchObject

public WebSearch getSearchObject()

Description copied from class: AbstractPromptWidgetTransform

subclass can override this method to return its search object associated with the avialable part.

Overrides:

getSearchObject in class AbstractPromptWidgetTransform

getAttForms

public java.util.List<WebAttributeForm> getAttForms(WebAttribute att)

isAvailableFlattenedExisting

public boolean isAvailableFlattenedExisting()

getDefaultAnswerAsString

public java.lang.String getDefaultAnswerAsString()

hasNonEmptySearchResults

public boolean hasNonEmptySearchResults()

getEmptyTreeText

public java.lang.String getEmptyTreeText(int descriptor)

getSearchRequiredText

public java.lang.String getSearchRequiredText()

getAllFormsInteger

public java.lang.String getAllFormsInteger()

getSuggestedAnswers

public WebFolder getSuggestedAnswers()

isAttributeQualification

public boolean isAttributeQualification()

isMetricQualification

public boolean isMetricQualification()

isHierarchyQualification

public boolean isHierarchyQualification()

isSAPQualification

public boolean isSAPQualification()

getAllowedFunctions

public void getAllowedFunctions(BlockList list)

getDefaultFunction

public java.lang.String getDefaultFunction()

getDisplayedForms

public java.lang.String getDisplayedForms()

getRestriction

public java.lang.String getRestriction()

Overrides:

getRestriction in class AbstractPromptWidgetTransform

isAllowDisplayOutputLevelSelector

public boolean isAllowDisplayOutputLevelSelector()

showIncrementalFetch

public boolean showIncrementalFetch()

shouldRenderNoneOption

public boolean shouldRenderNoneOption()

shouldRenderDualCart

public boolean shouldRenderDualCart()

getSupportedBeanType

public java.lang.Class getSupportedBeanType()

Get the class of objects this transform is able to handle.

Specified by:

getSupportedBeanType in interface Transform

Overrides:

getSupportedBeanType in class AbstractAppTransform

Returns:

a Class instance with the information about the beans this transform is able to manipulate.