Class TreeViewImpl

    • Constructor Detail

      • TreeViewImpl

        public TreeViewImpl()
        TreeViewImpl constructor, initialize all tree properties.
    • Method Detail

      • setStyle

        public void setStyle​(java.lang.String style)
        Specified by:
        setStyle in interface TreeView
      • renderJavaScript

        public void renderJavaScript​(MarkupOutput out)
        Renders the script dependencies and the bone.
        out -
      • setRenderShell

        public void setRenderShell​(boolean renderShell)
        Specified by:
        setRenderShell in interface TreeView
      • setRenderRoot

        public void setRenderRoot​(boolean renderRoot)
        Specified by:
        setRenderRoot in interface TreeView
      • getRootTreeNode

        public TreeNode getRootTreeNode()
        Description copied from interface: TreeView
        Function used to return the root tree node. The TreeBox will iterate though the children of this root node to render the tree.
        Specified by:
        getRootTreeNode in interface TreeView
        The root TreeNode
      • setTreeDivAttribute

        public void setTreeDivAttribute​(java.lang.String name,
                                        java.lang.String value)
        Description copied from interface: TreeView
        Function used for setting Tree properties. You can specify any property to be set on the main tree div using this function.
        Specified by:
        setTreeDivAttribute in interface TreeView
        name - Name of property
        value - Property's value.
      • setScriptClass

        public void setScriptClass​(java.lang.String scriptClass)
        Description copied from interface: TreeView
        Holds the name of the javaScript class to be associated with the component. When the scriptClass is specified, a bone is registered on the page for this component. A bone is the corresponding concept of a bean in Microstrategy's javascript environment.
        If no scriptClass is specified we will use "mstrTreeViewImpl" as the default scriptClass
        Specified by:
        setScriptClass in interface TreeView
        scriptClass - the name of the script class
      • setSortChildNodes

        public void setSortChildNodes​(boolean value)
        Sets whether the child nodes have to be sorted.
        value -
      • setSubObjectType

        public void setSubObjectType​(java.lang.String subObjType)
        Description copied from interface: TreeView
        Holds the sub object type of the tree if the tree bone is used as a child bone A bone is the corresponding concept of a bean in Microstrategy's javascript environment.
        by defautl the subObjectType of the tree is null so the tree bone itself should be a registered bone
        Specified by:
        setSubObjectType in interface TreeView
        subObjType - the sub object type to be set
      • getSortChildNodes

        public boolean getSortChildNodes()
        Returns whether we should sort the child nodes.
      • setRenderEntireTreeIframeReqNotWithstanding

        public void setRenderEntireTreeIframeReqNotWithstanding​(boolean value)
        Description copied from interface: TreeView
        This method allows the user to specify if he/she wants a criteria other than iframe request to decide whether to render the entire tree or render just the request node. If set to true, the entire tree will be rendered irrespective of whether the request was an iframe request or not. Default value is set to false
        Specified by:
        setRenderEntireTreeIframeReqNotWithstanding in interface TreeView
      • getRenderEntireTreeIframeReqNotWithstanding

        public boolean getRenderEntireTreeIframeReqNotWithstanding()
        Description copied from interface: TreeView
        Returns a boolean value that indicates whether a criteria has been set other than iframe request which decides whether the entire tree should be rendered or just the request node
        Specified by:
        getRenderEntireTreeIframeReqNotWithstanding in interface TreeView
      • addScriptDependency

        public void addScriptDependency​(java.lang.String filename,
                                        java.lang.String loadCondition)
        Description copied from interface: TreeView
        This method adds a script dependency for a bone. Registration of a bone with a script dependency will be held until all script file dependencies have been resolved (loaded). If the user does not specify any script dependency the application will use "mstrTreeViewImpl.js" as the default JavaScript file name and "mstrTreeViewImplScript" the as the default load condition.
        Specified by:
        addScriptDependency in interface TreeView
        filename - String the name of the script file
        loadCondition - String a JavaScript string that when evaluated (using the eval function) will return true when the file is loaded.
      • getJSONGenerator

        public JsonGenerator getJSONGenerator()
        Description copied from interface: TreeView
        This allows the user to retrieve the JSONGenerator object on which attribute-value pairs can be set These attribute-value pairs translate to properties on the tree bone tree bone
        Specified by:
        getJSONGenerator in interface TreeView