public abstract class

AbstractPromptWidgetTransform

extends AbstractAppWidgetTransform
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
Known Direct Subclasses
Known Indirect Subclasses

Summary

[Expand]
Inherited Constants
From class com.microstrategy.web.app.transforms.AbstractAppTransform
Fields
protected PromptBean _prompt
protected PromptAppBean _promptAppBean
protected int _promptPosition
public FormalParameter displayModel
[Expand]
Inherited Fields
From class com.microstrategy.web.app.transforms.AbstractAppTransform
Public Constructors
AbstractPromptWidgetTransform()
Public Methods
boolean allowMultipleUserAnswer()
boolean allowSingleUserAnswer()
String getAnswerFormat()
String getAnswerOption()
String getAnswerRestriction()
Block getChildWidget(WebBean bean, String styleName)
Block getChildWidget(WebBean bean, String styleName, String[] fpNames, Object[] fpValues)
Block getDataFormsWidget(WebAttributeForms forms)
WebPromptAnswer getDefaultAnswer()
Return the default user answer.
boolean getDefaultSavingAnswer()
When only one answer allowed and there is default answer (both prompt and re-prompt cases), we would like the saving box be checked.
WebProperty getDisplayProperty(String pName)
String getDisplayStyleName()
ArrayList getElementsAsList(WebElements elems)
String getErrorMessage()
void getItemWidget(BlockList blockList, WebElement elem, WebAttributeForms forms)
String getNamePrefixForSingleSavedAnswer()
int getPromptIndex()
String getPromptMeaning()
String getPromptName()
String getPromptTitle()
int getPropertyDefaultSelection()
String getPropertyHeightValue()
String getPropertyValue(String pName)
String getPropertyWidthValue()
String getRestriction()
List getSavedAnswers()
WebSearch getSearchObject()
subclass can override this method to return its search object associated with the avialable part.
String getSearchTypes()
boolean hasError()
boolean hasSavedAnswers()
void initializeWebComponent(Transformable data)
Initialize the web component to be used by the transform.
boolean isAutoCloseAnswer(WebPromptAnswer ans)
boolean isAvailableFolderAvailable()
In "Each on a separate page" mode, we only collected the first page's search result, if there is a search defined.
boolean isCartStyle()
boolean isCheckboxStyle()
boolean isDefaultAnswer(WebPromptAnswer ans)
Returns whether the input argument is a default answer.
boolean isDisplayingModel()
boolean isHICartStyle()
boolean isHICart_or_TreeStyle()
boolean isListStyle()
boolean isMultiListStyle()
boolean isNonCartStyle()
boolean isOneByOneDisplayMode()
boolean isPropertyWidthFixed()
boolean isPulldownStyle()
boolean isRadioStyle()
boolean isReprompting()
Returns whether current is in reprompting process.
boolean isSingleListStyle()
boolean isTextboxStyle()
boolean isTreeStyle()
boolean isTrimmedTree()
Doug's spec 1) We will add a new property to object prompts that meet all of the following criteria: a.
boolean isUseFolderStructure()
String showObjectDescription()
The return value will control how the description of individual object should be shown: No, Yes or ToolTip.
boolean showSearchBox()
boolean showSearchBoxOrTreeStyle()
boolean usingDefaultAnswer()
Returns whether current answer is using the default answer.
Protected Methods
boolean isDisplaySearchPropOn()
[Expand]
Inherited Methods
From class com.microstrategy.web.app.transforms.AbstractAppWidgetTransform
From class com.microstrategy.web.app.transforms.AbstractAppTransform
From class com.microstrategy.web.transform.AbstractLayoutTransform
From class com.microstrategy.web.transform.AbstractTransform
From class java.lang.Object
From interface com.microstrategy.web.app.transforms.AppTransform
From interface com.microstrategy.web.transform.LayoutTransform
From interface com.microstrategy.web.transform.Transform

Fields

protected PromptBean _prompt

protected PromptAppBean _promptAppBean

protected int _promptPosition

public FormalParameter displayModel

Public Constructors

public AbstractPromptWidgetTransform ()

Public Methods

public boolean allowMultipleUserAnswer ()

public boolean allowSingleUserAnswer ()

public String getAnswerFormat ()

public String getAnswerOption ()

public String getAnswerRestriction ()

public Block getChildWidget (WebBean bean, String styleName)

public Block getChildWidget (WebBean bean, String styleName, String[] fpNames, Object[] fpValues)

public Block getDataFormsWidget (WebAttributeForms forms)

public WebPromptAnswer getDefaultAnswer ()

Return the default user answer.

public boolean getDefaultSavingAnswer ()

When only one answer allowed and there is default answer (both prompt and re-prompt cases), we would like the saving box be checked.

public WebProperty getDisplayProperty (String pName)

public String getDisplayStyleName ()

public ArrayList getElementsAsList (WebElements elems)

public String getErrorMessage ()

public void getItemWidget (BlockList blockList, WebElement elem, WebAttributeForms forms)

public String getNamePrefixForSingleSavedAnswer ()

public int getPromptIndex ()

public String getPromptMeaning ()

public String getPromptName ()

public String getPromptTitle ()

public int getPropertyDefaultSelection ()

public String getPropertyHeightValue ()

public String getPropertyValue (String pName)

public String getPropertyWidthValue ()

public String getRestriction ()

public List getSavedAnswers ()

public WebSearch getSearchObject ()

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

public String getSearchTypes ()

public boolean hasError ()

public boolean hasSavedAnswers ()

public void initializeWebComponent (Transformable data)

Initialize the web component to be used by the transform.

Parameters
data the bean to transform.

public boolean isAutoCloseAnswer (WebPromptAnswer ans)

public boolean isAvailableFolderAvailable ()

In "Each on a separate page" mode, we only collected the first page's search result, if there is a search defined. The suggested answer for other prompts are valid, but we have not collect the search results for other prompts, if there is any. And we do not want to collect those search data, since avoiding them is the purpose of the "Each on a separate page" mode. So, in layout file, we should first check whether available folder is available before rendering it out.

public boolean isCartStyle ()

public boolean isCheckboxStyle ()

public boolean isDefaultAnswer (WebPromptAnswer ans)

Returns whether the input argument is a default answer. Answer is a default answer when its reuse property is DssXmlPromptAnswerReuseDefault or DssXmlPromptAnswerReuseDefaultAndClose.

Parameters
ans The answer object to check
Returns
  • true if the input answer object is a default answer, otherwise false.

public boolean isDisplayingModel ()

public boolean isHICartStyle ()

public boolean isHICart_or_TreeStyle ()

public boolean isListStyle ()

public boolean isMultiListStyle ()

public boolean isNonCartStyle ()

public boolean isOneByOneDisplayMode ()

public boolean isPropertyWidthFixed ()

public boolean isPulldownStyle ()

public boolean isRadioStyle ()

public boolean isReprompting ()

Returns whether current is in reprompting process.

public boolean isSingleListStyle ()

public boolean isTextboxStyle ()

public boolean isTreeStyle ()

public boolean isTrimmedTree ()

Doug's spec 1) We will add a new property to object prompts that meet all of the following criteria: a. use a search that is defined to search within subfolders, b. use the Tree style, and c. the Use folder structure property is True (which is must be if Tree style is selected). 2) When this new property is enabled, the Web server code will retrieve from backend all objects that match the search criteria, including their complete paths. 3) Web will send these objects to the client, where they will be presented in a tree. a. The tree will start at the folder specified as the root of the search. b. The tree will be fully populated from the beginning. c. All nodes of the tree except those on a direct path to the folder specified as the root of the search will start out fully collapsed. The folder specified as the root of the search will itself be collapsed. d. Below the folder specified as the root of the search, only folders that contain a matching object somewhere within them will be shown. (In other words, only folders that are on the path of some matching object will be shown in the tree). e. If the prompt is defined to Allow navigation above search root, navigation above/outside the search root folder will behave as it does today (folder contents will be retrieved from the server only on-demand, and folders that might not contain matching objects will be shown anyway.) In other words, this new property and behaviour will only apply to the folder specified as the root of the search and its subfolders.

public boolean isUseFolderStructure ()

public String showObjectDescription ()

The return value will control how the description of individual object should be shown: No, Yes or ToolTip.

public boolean showSearchBox ()

public boolean showSearchBoxOrTreeStyle ()

public boolean usingDefaultAnswer ()

Returns whether current answer is using the default answer. When we are not in reprompting and there is default answer existing and project level answer restriction is not NONE, then we are using default answer. When project level answer restriction is set to NONE, Iserver side will disable the user answers feature.

Protected Methods

protected boolean isDisplaySearchPropOn ()