Package com.microstrategy.web.app.transforms

Class PromptsIFrameTransform

    • Field Detail

      • _treeList

        protected java.util.Vector _treeList

      • _promptPosition

        protected int _promptPosition

      • ARGUMENT_PANE_STATUS

        protected static final int ARGUMENT_PANE_STATUS
        Specifies constant for identifying whether or not pane is in 'status' mode.
        Since:
        MicroStrategy Web 8.0.0
        See Also:
        Constant Field Values

      • ARGUMENT_PANE_SELECT

        protected static final int ARGUMENT_PANE_SELECT
        Specifies constant for identifying whether or not pane is in 'select' mode.
        Since:
        MicroStrategy Web 8.0.0
        See Also:
        Constant Field Values

      • ARGUMENT_PANE_QUALIFY

        protected static final int ARGUMENT_PANE_QUALIFY
        Specifies constant for identifying whether or not pane is in 'qualify' mode.
        Since:
        MicroStrategy Web 8.0.0
        See Also:
        Constant Field Values

      • imgError

        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.
        Since:
        MicroStrategy Web 7.5.1

      • hierarchyImage

        public FormalParameter hierarchyImage
        Specifies the image to use to represent a hierarchy object in tree.
        Since:
        MicroStrategy Web 8.0.0

      • _hierarchyImage

        protected java.lang.String _hierarchyImage

      • attributeImage

        public FormalParameter attributeImage
        Specifies the image to use to represent an attribute object in tree.
        Since:
        MicroStrategy Web 8.0.0

      • _attributeImage

        protected java.lang.String _attributeImage

      • attributeLockedImage

        public FormalParameter attributeLockedImage
        Specifies the image to use to represent a locked attribute object in tree.
        Since:
        MicroStrategy Web 8.0.0

      • _attributeLockedImage

        protected java.lang.String _attributeLockedImage

      • elementImage

        public FormalParameter elementImage
        Specifies the image to use to represent an attribute's eleement object in tree.
        Since:
        MicroStrategy Web 8.0.0

      • _elementImage

        protected java.lang.String _elementImage

      • folderImage

        public FormalParameter folderImage
        Specifies the image to use to represent a folder object in tree.
        Since:
        MicroStrategy Web 8.0.0

      • _folderImage

        protected java.lang.String _folderImage
        Since:
        MicroStrategy Web 7.5.1

    • Constructor Detail

      • PromptsIFrameTransform

        public PromptsIFrameTransform()
        Default no-args constructor.
        Initialize all Formal Parameters.

    • Method Detail

      • initializeImages

        public void initializeImages()
        Initialize the images to be used by this transform.
        Overrides:
        initializeImages in class PromptsClassicTransform
        Since:
        MicroStrategy Web 7.5.1

      • renderPromptErrorMessage

        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
        Since:
        MicroStrategy Web 7.5.1

      • getErrorMessage

        protected java.lang.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
        Since:
        MicroStrategy Web 7.5.1

      • getIFrameErrorMessage

        protected java.lang.String getIFrameErrorMessage​(WebBeanError promptError)
        Returns IFrame error mesasage.
        Returns:
        String error message associated to IFrame request.
        Since:
        MicroStrategy Web 8.0.0

      • getPromptObj

        protected PromptObject getPromptObj()
        Returns current instance of PromptObject.
        Returns:
        PromptObject instance
        Since:
        MicroStrategy Web 8.0.0

      • getWebPrompt

        protected WebPrompt getWebPrompt()
        Returns current WebPrompt instance.
        Returns:
        WebPrompt instance
        Since:
        MicroStrategy Web 8.0.0

      • processTreeList

        protected void processTreeList()
        Process prompt tree request.
        It constructs and expands new tree node based on request values.

      • renderAttributeElements

        @Deprecated
public void renderAttributeElements​(WebDimensionAttribute dimAttr,
                                    WebDisplayUnit hierarchy,
                                    int level)
                             throws WebObjectsException
        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

      • renderJavaScriptFooter

        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.
        Overrides:
        renderJavaScriptFooter in class PromptsClassicTransform
        Parameters:
        out - where to write the output of the method.

      • isBrowseHierarchyEvent

        protected boolean isBrowseHierarchyEvent()
        Indicates whether or not given event is Hierarchy type.
        Returns:
        boolean true if it's a hierarchy event.

      • isBrowseElementsEvent

        protected boolean isBrowseElementsEvent()
        Indicates whether or not, given event is of type 'browse elements'.
        *
        Returns:
        boolean true if 'browse elements' is being processed.
        Since:
        MicroStrategy Web 7.5.1

      • isHighlightDimensionAttributeEvent

        protected boolean isHighlightDimensionAttributeEvent()
        Indicates whether or not, given event is of type 'highlight dimension attribute'.
        *
        Returns:
        boolean true if 'browse elements' is being processed.
        Since:
        MicroStrategy Web 8.0.2

      • isBrowseDimensionAttributeElementsEvent

        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.
        Since:
        MicroStrategy Web 8.0.2

      • isBrowseFolderEvent

        protected boolean isBrowseFolderEvent()
        Indicates whether or not, given event is of type 'browse folder'.
        *
        Returns:
        boolean true if 'browse folder' is being processed.
        Since:
        MicroStrategy Web 7.5.1

      • addIncrementalFetchNode

        protected void addIncrementalFetchNode​(java.lang.String displayName,
                                       java.lang.String id,
                                       int blockBegin,
                                       int iBlockCount,
                                       int level,
                                       WebAttribute attribute,
                                       WebDisplayUnit hierarchy,
                                       java.lang.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.

      • getPromptEvent

        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.

      • getPromptPosition

        protected int getPromptPosition​(RequestKeys keys)
        Determines prompt position from request.
        Parameters:
        keys - RequestKeys request
        Returns:
        int prompt index.

      • addTreeNodeToList

        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.

      • isLocked

        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

      • getFirstHighlightedItem

        protected WebDisplayUnit getFirstHighlightedItem​(WebDisplayUnits units)
        Returns the first highlighted item found
        Parameters:
        units - display units to check
        Returns:
        WebDisplayUnit the first highlighted item

      • isXDA_MDX_Report

        protected boolean isXDA_MDX_Report()
        Indicates whether or not this a prompted MDX Report.
        Returns:
        boolean true if MDX report.
        Since:
        MicroStrategy Web 8.0.2

      • getDimensionAttribute

        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

      • initializeTreeImages

        protected void initializeTreeImages()
        Initializes this prompt images.
        It invokes parent method so all shared images get initialized as well.

      • isSearchPossible

        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.

      • getID

        public java.lang.String getID()
        Returns the unique name of the component to be used as the ID for its shell
        Specified by:
        getID in interface Transform
        Overrides:
        getID in class AbstractAppTransform
        Returns:
        the component's unique id
        Since:
        MicroStrategy Web 8.0.0

      • supports

        public boolean supports​(java.lang.Class c)
        Indicates whether given Class is supported.
        Specified by:
        supports in interface Transform
        Overrides:
        supports in class AbstractTransform
        Parameters:
        c - Class to be checked
        Returns:
        boolean true if supported.

      • isSAPExpression

        protected boolean isSAPExpression()
        Check whether the prompt is a SAP Expression Prompt
        Returns:
        true if the Prompt's ExpressionType is EnumDSSXMLExpressionType.DssXmlExpressionMDXSAPVariable
        Since:
        MicroStrategy Web 8.0.1

      • hasAccessGranted

        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.
        Since:
        MicroStrategy Web 8.0.2