Package com.microstrategy.web.app.transforms

Class PromptHierarchicalTreeTransform

    • Field Detail

      • _treeList

        protected java.util.Vector _treeList
        Deprecated.
        Collection of tree nodes.

      • hierarchyImage

        public FormalParameter hierarchyImage
        Deprecated.
        Image used to represent a hierarchy.

      • _hierarchyImage

        protected java.lang.String _hierarchyImage
        Deprecated.

      • folderImage

        public FormalParameter folderImage
        Deprecated.
        Image used to represent a folder.
        Since:
        MicroStrategy Web 7.5.1

      • _folderImage

        protected java.lang.String _folderImage
        Deprecated.
        Indicates name of Folder Image.
        Since:
        MicroStrategy Web 7.5.1

      • attributeImage

        public FormalParameter attributeImage
        Deprecated.
        Image used to represent an attribute.

      • _attributeImage

        protected java.lang.String _attributeImage
        Deprecated.

      • elementImage

        public FormalParameter elementImage
        Deprecated.
        Image used to represent an attribute element.

      • _elementImage

        protected java.lang.String _elementImage
        Deprecated.

      • attributeLockedImage

        public FormalParameter attributeLockedImage
        Deprecated.
        Image used to represent a locked attribute.

      • _attributeLockedImage

        protected java.lang.String _attributeLockedImage
        Deprecated.

      • folderItemsInTree

        public FormalParameter folderItemsInTree
        Deprecated.
        Specifies whether folder items should be displayed or not.
        Since:
        MicroStrategy Web 7.5.1

      • hierarchiesInTree

        public FormalParameter hierarchiesInTree
        Deprecated.
        Specifies whether the hierarchies will be displayed inside the tree.

      • searchSize

        public FormalParameter searchSize
        Deprecated.
        Specifies the size of the search text box.

      • treeStyle

        public FormalParameter treeStyle
        Deprecated.
        Class to indicate the style to use when displaying the tree.

      • browsePath

        protected java.lang.String browsePath
        Deprecated.
        Since:
        MicroStrategy Web 7.5.4

      • backToParentFolderImage

        public FormalParameter backToParentFolderImage
        Deprecated.
        Image for going up in browsing path for object prompts.
        Object Prompts might support object browsing. This is done by displaying a browsing path above given prompt question. This path is similar to that used for displaying location of a given report. This image represents the button for allowing end-users to browse up in the hierarchy.
        Since:
        MicroStrategy Web 7.5.4

    • Constructor Detail

      • PromptHierarchicalTreeTransform

        public PromptHierarchicalTreeTransform()
        Deprecated.
        Default constructor, no arguments.

    • Method Detail

      • canHierarchyPaneBeShown

        public boolean canHierarchyPaneBeShown()
        Deprecated.
        Indicates whether or not Hierarchy pane can be displayed.
        Hierarchical Tree prompt won't display this pane if there aren't any hierarchies in collection. Also, it requires to have FP hierarchiesInTree set to False in order to invoke this method.
        Overrides:
        canHierarchyPaneBeShown in class PromptHierarchicalCartTransform
        Returns:
        boolean true if it is to be displayed.
        Since:
        MicroStrategy Web 7.5.4

      • processAvailableItems

        protected void processAvailableItems()
                              throws WebObjectsException
        Deprecated.
        Initializes the available units list.
        If trees isn't supported (isTreeSupported() method), then parent method processAvailableItems() gets invoked. If supported, this function will parse available list of items and will start creating prompt tree structure.
        Overrides:
        processAvailableItems in class PromptHierarchicalCartTransform
        Throws:
        WebObjectsException - if a problem occurs when highlighting or populating any WebDisplayUnit instance.

      • cleanHierarchyList

        protected void cleanHierarchyList()
        Deprecated.
        Filters out from hierarchies list those items which aren't instances of WebDimension (Hierarchy).
        Clears anything other than hierarchies in the list, for example, folders.
        Removes anything that isn't a Hierarchy.
        Overrides:
        cleanHierarchyList in class PromptHierarchicalCartTransform

      • getPromptEvent

        protected WebEvent getPromptEvent​(int eventId)
        Deprecated.
        Returns prompt event associate to given Id.
        It gets PromptsBean instance from which prompt event is obtained.
        Parameters:
        eventId - int indicating prompt event id.
        Returns:
        WebEvent prompt event, it could be null.

      • addTreeNodeToList

        protected TreeNode addTreeNodeToList​(WebDisplayUnit item,
                                     int level)
        Deprecated.
        Adds WebDisplayUnit to current prompt tree.
        Parameters:
        item - WebDisplayUnit to be added to tree.
        level - int indicates tree node level.
        Returns:
        TreeNode new instance.

      • renderCart

        public void renderCart​(MarkupOutput out)
        Deprecated.
        Renders cart area in hierarchical prompt layout.
        It calls renderAvailable, renderSelected and renderAdd/renderRemove methods.
        Overrides:
        renderCart in class PromptHierarchicalCartTransform
        Parameters:
        out - where to write the output of the method.

      • renderFoldersPane

        public void renderFoldersPane​(MarkupOutput out)
        Deprecated.
        Renders folder's pull-down area in current prompt question.
        Overrides:
        renderFoldersPane in class PromptHierarchicalCartTransform
        Parameters:
        out - MarkupOutput where to render folder layout.
        Since:
        MicroStrategy Web 7.5.4

      • renderHierarchiesPaneContent

        @Deprecated
public void renderHierarchiesPaneContent​(boolean enabled,
                                         MarkupOutput out)
        Deprecated.
        Replaced by function renderHierarchiesPaneContent(MarkupOutput out, boolean enabled)
        Parameters:
        enabled -
        out -
        Since:
        MicroStrategy Web 7.5.4

      • renderHierarchiesPaneContent

        public void renderHierarchiesPaneContent​(MarkupOutput out,
                                         boolean enabled)
        Deprecated.
        Since:
        MicroStrategy Web 9.0.0

      • getResourcesFolder

        public java.lang.String getResourcesFolder​(java.lang.String folderType)
        Deprecated.
        Wraps the AppContext's getResourceFolder method.
        But it validates that the getBeanContext is indeed an AppContext.
        Parameters:
        folderType - the folder type
        Returns:
        AppContext's getResourceFolder, or "" if not defined.

      • renderAvailable

        public void renderAvailable​(MarkupOutput out)
        Deprecated.
        Renders available HTML list.
        HTML list gets populated with items in prompt's available list.
        Overrides:
        renderAvailable in class PromptHierarchicalCartTransform
        Parameters:
        out - where to write the output of the method.

      • renderPromptErrorMessage

        public void renderPromptErrorMessage​(MarkupOutput out)
        Deprecated.
        Renders 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.
        Overrides:
        renderPromptErrorMessage in class AbstractPromptObjectTransform
        Parameters:
        out - the transform output
        Since:
        MicroStrategy Web 7.5.1

      • initializeImages

        public void initializeImages()
        Deprecated.
        Initializes the images used in this transform.
        It invokes parent method in order to get all shared images initialized as well.
        Overrides:
        initializeImages in class PromptHierarchicalCartTransform

      • writeAncestors

        protected void writeAncestors​(MarkupOutput out,
                              SimpleList ancestors,
                              int currentAncestor)
        Deprecated.
        Renders folder path denoting ancestors folders to current folder.
        Parameters:
        out - MarkupOutput where to write folder path
        ancestors - SimpleList collection of ancestors
        currentAncestor - int number of ancestors to be rendered.
        Since:
        MicroStrategy Web 7.5.4

      • renderBackParentButton

        public void renderBackParentButton​(MarkupOutput out)
        Deprecated.
        Renders HTML button to trigger back to parent folder.
        Parameters:
        out - MarkupOutput where to write HTML output
        Since:
        MicroStrategy Web 7.5.4

      • promptsLoadedFirstTime

        protected boolean promptsLoadedFirstTime()
        Deprecated.
        Checks in request whether or not prompts are loaded the firt time.
        It looks for any 'prompt' hidden value in request indicating there was a prompt request to be processed. This means, user has started editing any prompt in report.
        Returns:
        boolean true if there's no prompt request values.
        Since:
        MicroStrategy Web 7.5.4

      • renderFoldersPath

        public void renderFoldersPath​(MarkupOutput out)
        Deprecated.
        Renders folder path, including current folder and its ancestors.
        It invokes writeAncestors() method.
        Parameters:
        out - MarkupOutput where to write output.
        Since:
        MicroStrategy Web 7.5.4

      • getLabelForFolderFirstOption

        protected java.lang.String getLabelForFolderFirstOption()
        Deprecated.
        Indicates localized label to be displayed as first option in Subfolder's pull-down menu.
        Overrides:
        getLabelForFolderFirstOption in class PromptHierarchicalCartTransform
        Returns:
        String localized label.
        Since:
        MicroStrategy Web 7.5.4

      • renderSubFolderPullDown

        public void renderSubFolderPullDown​(MarkupOutput out)
        Deprecated.
        Renders HTML pull-down menu consisted of all existing subfolders.
        Parameters:
        out - MarkupOutput where to write HTML output.
        Since:
        MicroStrategy Web 7.5.4

      • isTreeSupported

        protected boolean isTreeSupported()
        Deprecated.
        Indicates whether or not tree prompt style is supported.
        Tree mode is only supported if it is dhtml mode and in IE 5.5 or greater.
        Returns:
        boolean true if tree style is supported.

      • getFirstNonHighlightedDimension

        public WebDisplayUnit getFirstNonHighlightedDimension​(WebDisplayUnits units)
        Deprecated.
        Since:
        MicroStrategy Web 7.5.4