| 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.PromptsIFrameTransform | ||||
Summary
| Constants | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| int | ARGUMENT_PANE_QUALIFY | Specifies constant for identifying whether or not pane is in 'qualify' mode. | |||||||||
| int | ARGUMENT_PANE_SELECT | Specifies constant for identifying whether or not pane is in 'select' mode. | |||||||||
| int | ARGUMENT_PANE_STATUS | Specifies constant for identifying whether or not pane is in 'status' mode. | |||||||||
|
[Expand]
Inherited Constants | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
 From class
com.microstrategy.web.app.transforms.PromptsClassicTransform
| |||||||||||
|
From class
com.microstrategy.web.app.transforms.AbstractAppTransform
| |||||||||||
| Fields | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| protected String | _attributeImage | ||||||||||
| protected String | _attributeLockedImage | ||||||||||
| protected String | _elementImage | ||||||||||
| protected String | _folderImage | ||||||||||
| protected String | _hierarchyImage | ||||||||||
| protected int | _promptPosition | ||||||||||
| protected Vector | _treeList | ||||||||||
| public FormalParameter | attributeImage | Specifies the image to use to represent an attribute object in tree. | |||||||||
| public FormalParameter | attributeLockedImage | Specifies the image to use to represent a locked attribute object in tree. | |||||||||
| public FormalParameter | elementImage | Specifies the image to use to represent an attribute's eleement object in tree. | |||||||||
| public FormalParameter | folderImage | Specifies the image to use to represent a folder object in tree. | |||||||||
| public FormalParameter | hierarchyImage | Specifies the image to use to represent a hierarchy object in tree. | |||||||||
| public FormalParameter | imgError | Specifies the image to use to highlight an error in a prompt. | |||||||||
|
[Expand]
Inherited Fields | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
|
From class
com.microstrategy.web.app.transforms.PromptsClassicTransform
| |||||||||||
|
From class
com.microstrategy.web.app.transforms.AbstractAppTransform
| |||||||||||
| Public Constructors | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
|
PromptsIFrameTransform()
Default no-args constructor.
| |||||||||||
| Public Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| boolean |
canTransform(Transformable data)
whether the data is transformable.
| ||||||||||
| String |
getDescription()
Return description for this Transform.
| ||||||||||
| String |
getID()
Returns the unique name of the component to be used as the ID for its shell
| ||||||||||
| void |
initializeImages()
Initialize the images to be used by this transform.
| ||||||||||
| void | initializeTransform(Transformable data) | ||||||||||
| void |
renderAttributeElements(WebDimensionAttribute dimAttr, WebDisplayUnit hierarchy, int level)
This method is deprecated.
This method is not used anymore and will be removed in future versions of the product.
| ||||||||||
| void |
renderJavaScriptFooter(MarkupOutput out)
Renders javascript variables at the bottom of the transform to be used in DHTML mode.
| ||||||||||
| void |
renderPromptErrorMessage(MarkupOutput out)
Displays a localized generic error message to end-users.
| ||||||||||
| boolean |
supports(Transformable data)
Indicates whether or not this object is supported.
| ||||||||||
| boolean |
supports(Class c)
Indicates whether given Class is supported.
| ||||||||||
| void |
transformForRequestSuccessful(MarkupOutput out)
Execute transform on PromptBean when the status is "Successful".
| ||||||||||
| Protected Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| void |
addIncrementalFetchNode(String displayName, String id, int blockBegin, int iBlockCount, int level, WebAttribute attribute, WebDisplayUnit hierarchy, String cssClass)
Adds incremental fetch node to prompt tree node being expanded.
| ||||||||||
| TreeNode |
addTreeNodeToList(WebDisplayUnit item, int level)
Adds tree node to prompt tree list.
| ||||||||||
| WebDimensionAttribute |
getDimensionAttribute(WebDisplayUnit unit)
Returns the same object if it's already WebDimensionAttribute,
otherwise
| ||||||||||
| String |
getErrorMessage(WebBeanError promptError)
Returns a localized error message.
| ||||||||||
| WebDisplayUnit |
getFirstHighlightedItem(WebDisplayUnits units)
Returns the first highlighted item found
| ||||||||||
| String |
getIFrameErrorMessage(WebBeanError promptError)
Returns IFrame error mesasage.
| ||||||||||
| WebEvent |
getPromptEvent(int eventId)
Indicates a Prompt event based on Event Id passed in.
| ||||||||||
| PromptObject |
getPromptObj()
Returns current instance of
PromptObject. | ||||||||||
| int |
getPromptPosition(RequestKeys keys)
Determines prompt position from request.
| ||||||||||
| WebPrompt |
getWebPrompt()
Returns current
WebPrompt instance. | ||||||||||
| boolean |
hasAccessGranted(WebObjectInfo objInfo)
Indicates whether or not current user has access granted to given WebObjectInfo instance.
| ||||||||||
| void |
initializeTreeImages()
Initializes this prompt images.
| ||||||||||
| boolean |
isBrowseDimensionAttributeElementsEvent()
Indicates whether or not, given event is of type 'browse dimension attribute elements'.
| ||||||||||
| boolean |
isBrowseElementsEvent()
Indicates whether or not, given event is of type 'browse elements'.
| ||||||||||
| boolean |
isBrowseFolderEvent()
Indicates whether or not, given event is of type 'browse folder'.
| ||||||||||
| boolean |
isBrowseHierarchyEvent()
Indicates whether or not given event is Hierarchy type.
| ||||||||||
| boolean |
isHighlightDimensionAttributeEvent()
Indicates whether or not, given event is of type 'highlight dimension attribute'.
| ||||||||||
| boolean |
isLocked(WebDisplayUnit unit)
function for determining whether given unit is locked up.
| ||||||||||
| boolean |
isSAPExpression()
Check whether the prompt is a SAP Expression Prompt
| ||||||||||
| boolean |
isSearchPossible(WebDisplayUnit unit)
Checks whether it's possible to filter elements based on the display unit
| ||||||||||
| boolean |
isXDA_MDX_Report()
Indicates whether or not this a prompted MDX Report.
| ||||||||||
| void |
processTreeAttributeElements(WebDimensionAttribute dimAttr, WebDisplayUnit hierarchy, int level)
Populates the tree with all attribute's elements.
| ||||||||||
| void |
processTreeList()
Process prompt tree request.
| ||||||||||
|
[Expand]
Inherited Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
|
From class
com.microstrategy.web.app.transforms.PromptsClassicTransform
| |||||||||||
|
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
| |||||||||||
Constants
protected static final int ARGUMENT_PANE_QUALIFY
Specifies constant for identifying whether or not pane is in 'qualify' mode.
protected static final int ARGUMENT_PANE_SELECT
Specifies constant for identifying whether or not pane is in 'select' mode.
protected static final int ARGUMENT_PANE_STATUS
Specifies constant for identifying whether or not pane is in 'status' mode.
Fields
protected String _attributeImage
protected String _attributeLockedImage
protected String _elementImage
protected String _folderImage
protected String _hierarchyImage
protected int _promptPosition
protected Vector _treeList
public FormalParameter attributeImage
Specifies the image to use to represent an attribute object in tree.
public FormalParameter attributeLockedImage
Specifies the image to use to represent a locked attribute object in tree.
public FormalParameter elementImage
Specifies the image to use to represent an attribute's eleement object in tree.
public FormalParameter hierarchyImage
Specifies the image to use to represent a hierarchy object in tree.
public FormalParameter imgError
Specifies the image to use to highlight an error in a prompt.
The value to indicate should be a valid image file name, with any necessary path information not included already on the
resourcesFolderImage application configuration parameter.
Public Constructors
public PromptsIFrameTransform ()
Default no-args constructor.
Initialize all Formal Parameters.
Public Methods
public boolean canTransform (Transformable data)
whether the data is transformable.
Parameters
| data | the data |
|---|
Returns
- whether the data is transformable
public String getDescription ()
Return description for this Transform.
Returns
- "This is the Transform that renders Prompts in the Application."
public String getID ()
Returns the unique name of the component to be used as the ID for its shell
Returns
- the component's unique id
public void initializeImages ()
Initialize the images to be used by this transform.
public void initializeTransform (Transformable data)
Initializes prompt transform
It converts Transformable data parameter into a PromptsBean instance.
Transform can be used from Schedule or Subscription featueres.
Parameters
| data | Transformable object to be transformed. |
|---|
public void renderAttributeElements (WebDimensionAttribute dimAttr, WebDisplayUnit hierarchy, int level)
This method is deprecated.
This method is not used anymore and will be removed in future versions of the product.
Renders output for all attribute's elements.
Parameters
| dimAttr | WebDimensionAttribute attribute where elements are parsed from. |
|---|---|
| hierarchy | WebDisplayUnit where dimAttr belongs to. |
| level | int value for indicating level of indentation |
Throws
| WebObjectsException} exception thrown if occurred. | |
| WebObjectsException |
public void renderJavaScriptFooter (MarkupOutput out)
Renders javascript variables at the bottom of the transform to be used in DHTML mode.
Overrides renderJavaScriptFooter by not generating any output.
Parameters
| out | where to write the output of the method. |
|---|
public void renderPromptErrorMessage (MarkupOutput out)
Displays a localized generic error message to end-users.
Error is displayed mostly when a validation fails either in backend or SDK.
It is enabled in all prompt types and styles.
Parameters
| out | MarkupOutput the transform output |
|---|
public boolean supports (Transformable data)
Indicates whether or not this object is supported.
Parameters
| data | Transformable to be checked |
|---|
Returns
- boolean true if supported
public boolean supports (Class c)
Indicates whether given Class is supported.
Parameters
| c | Class to be checked |
|---|
Returns
- boolean true if supported.
public void transformForRequestSuccessful (MarkupOutput out)
Execute transform on PromptBean when the status is "Successful".
Parameters
| out | MarkupOutput instance where to write the output of the method. |
|---|
Protected Methods
protected void addIncrementalFetchNode (String displayName, String id, int blockBegin, int iBlockCount, int level, WebAttribute attribute, WebDisplayUnit hierarchy, String cssClass)
Adds incremental fetch node to prompt tree node being expanded.
It only adds this functionality if number of element exceed block count settings.
Parameters
| displayName | String text describing incremental fetch |
|---|---|
| id | String unique id |
| blockBegin | int index |
| iBlockCount | int index |
| level | int how deep in tree to be rendered new tree node. |
| attribute | WebAttribute instance being parsed |
| hierarchy | WebDisplayUnit instance where attribute belong to. |
| cssClass | String CSS for formatting node output. |
protected TreeNode addTreeNodeToList (WebDisplayUnit item, int level)
Adds tree node to prompt tree list.
Parameters
| item | WebDisplayUnit being parsed |
|---|---|
| level | int tree node level |
Returns
- TreeNode new instance.
protected WebDimensionAttribute getDimensionAttribute (WebDisplayUnit unit)
Returns the same object if it's already WebDimensionAttribute, otherwise
Parameters
| unit | display unit to check |
|---|
Returns
- instance of dimension
protected String getErrorMessage (WebBeanError promptError)
Returns a localized error message.
Error message is associated to promptError code returned by SDK. It's
associated to a generic error message to be displayed.
Parameters
| promptError | instance of WebBeanError, most likely an validation error thrown in process prompt phase. |
|---|
Returns
- error message as String. Error is localized to active language
protected WebDisplayUnit getFirstHighlightedItem (WebDisplayUnits units)
Returns the first highlighted item found
Parameters
| units | display units to check |
|---|
Returns
- WebDisplayUnit the first highlighted item
protected String getIFrameErrorMessage (WebBeanError promptError)
Returns IFrame error mesasage.
Returns
- String error message associated to IFrame request.
protected WebEvent getPromptEvent (int eventId)
Indicates a Prompt event based on Event Id passed in.
Parameters
| eventId | int associated to a Prompt event. |
|---|
Returns
- WebEvent instance if any.
protected PromptObject getPromptObj ()
Returns current instance of PromptObject.
Returns
- PromptObject instance
protected int getPromptPosition (RequestKeys keys)
Determines prompt position from request.
Parameters
| keys | RequestKeys request |
|---|
Returns
- int prompt index.
protected boolean hasAccessGranted (WebObjectInfo objInfo)
Indicates whether or not current user has access granted to given WebObjectInfo instance.
Parameters
| objInfo | WebObjectInfo instance which user is validated against |
|---|
Returns
- boolean true if user can access given WebObjectInfo instance.
protected void initializeTreeImages ()
Initializes this prompt images.
It invokes parent method so all shared images get initialized as well.
protected boolean isBrowseDimensionAttributeElementsEvent ()
Indicates whether or not, given event is of type 'browse dimension attribute elements'.
*
Returns
- boolean true if 'browse elements' is being processed.
protected boolean isBrowseElementsEvent ()
Indicates whether or not, given event is of type 'browse elements'.
*
Returns
- boolean true if 'browse elements' is being processed.
protected boolean isBrowseFolderEvent ()
Indicates whether or not, given event is of type 'browse folder'.
*
Returns
- boolean true if 'browse folder' is being processed.
protected boolean isBrowseHierarchyEvent ()
Indicates whether or not given event is Hierarchy type.
Returns
- boolean true if it's a hierarchy event.
protected boolean isHighlightDimensionAttributeEvent ()
Indicates whether or not, given event is of type 'highlight dimension attribute'.
*
Returns
- boolean true if 'browse elements' is being processed.
protected boolean isLocked (WebDisplayUnit unit)
function for determining whether given unit is locked up.
Parameters
| unit | display unit to check |
|---|
Returns
- true if attribute is locked
protected boolean isSAPExpression ()
Check whether the prompt is a SAP Expression Prompt
Returns
- true if the Prompt's ExpressionType is
EnumDSSXMLExpressionType.DssXmlExpressionMDXSAPVariable
protected boolean isSearchPossible (WebDisplayUnit unit)
Checks whether it's possible to filter elements based on the display unit
Parameters
| unit | the display unit for which we want to check: |
|---|
Returns
- true if it's possible to search (filter) elements of the given type.
protected boolean isXDA_MDX_Report ()
Indicates whether or not this a prompted MDX Report.
Returns
- boolean true if MDX report.
protected void processTreeAttributeElements (WebDimensionAttribute dimAttr, WebDisplayUnit hierarchy, int level)
Populates the tree with all attribute's elements.
Parameters
| dimAttr | WebDimensionAttribute attribute where elements are parsed from. |
|---|---|
| hierarchy | WebDisplayUnit where dimAttr belongs to. |
| level | int value for indicating level of indentation |
Throws
| WebObjectsException} exception thrown if occurred. | |
| WebObjectsException |
protected void processTreeList ()
Process prompt tree request.
It constructs and expands new tree node based on request values.