public class

TreeViewImpl

extends AbstractGuiElement
implements TreeView
java.lang.Object
   ↳ com.microstrategy.web.app.gui.AbstractGuiElement
     ↳ com.microstrategy.web.app.gui.TreeViewImpl

Summary

[Expand]
Inherited Constants
From interface com.microstrategy.web.app.gui.TreeView
[Expand]
Inherited Fields
From class com.microstrategy.web.app.gui.AbstractGuiElement
Public Constructors
TreeViewImpl()
TreeViewImpl constructor, initialize all tree properties.
Public Methods
void addScriptDependency(String filename, String loadCondition)
This method adds a script dependency for a bone.
EventManager getEventManager()
get event manager for this gui element
JsonGenerator getJSONGenerator()
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
boolean getRenderEntireTreeIframeReqNotWithstanding()
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
TreeNode getRootTreeNode()
Function used to return the root tree node.
boolean getSortChildNodes()
Returns whether we should sort the child nodes.
MarkupOutput renderElement()
Function that returns instance of output writer.
void renderJavaScript(MarkupOutput out)
Renders the script dependencies and the bone.
void setRenderEntireTreeIframeReqNotWithstanding(boolean value)
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.
void setRenderRoot(boolean renderRoot)
void setRenderShell(boolean renderShell)
void setRootTreeNode(TreeNode root)
void setScriptClass(String scriptClass)
Holds the name of the javaScript class to be associated with the component.
void setSortChildNodes(boolean value)
Sets whether the child nodes have to be sorted.
void setStyle(String style)
void setSubObjectType(String subObjType)
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.
void setTreeDivAttribute(String name, String value)
Function used for setting Tree properties.
[Expand]
Inherited Methods
From class com.microstrategy.web.app.gui.AbstractGuiElement
From class java.lang.Object
From interface com.microstrategy.web.app.gui.GuiElement
From interface com.microstrategy.web.app.gui.TreeView

Public Constructors

public TreeViewImpl ()

TreeViewImpl constructor, initialize all tree properties.

Public Methods

public void addScriptDependency (String filename, String loadCondition)

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.

Parameters
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.

public EventManager getEventManager ()

get event manager for this gui element

Returns

public JsonGenerator getJSONGenerator ()

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

public boolean getRenderEntireTreeIframeReqNotWithstanding ()

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

public TreeNode getRootTreeNode ()

Function used to return the root tree node. The TreeBox will iterate though the children of this root node to render the tree.

Returns
  • The root TreeNode

public boolean getSortChildNodes ()

Returns whether we should sort the child nodes.

public MarkupOutput renderElement ()

Function that returns instance of output writer.

Returns
  • MarkupOutput

public void renderJavaScript (MarkupOutput out)

Renders the script dependencies and the bone.

public void setRenderEntireTreeIframeReqNotWithstanding (boolean value)

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

public void setRenderRoot (boolean renderRoot)

public void setRenderShell (boolean renderShell)

public void setRootTreeNode (TreeNode root)

public void setScriptClass (String scriptClass)

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

Parameters
scriptClass the name of the script class

public void setSortChildNodes (boolean value)

Sets whether the child nodes have to be sorted.

public void setStyle (String style)

public void setSubObjectType (String subObjType)

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

Parameters
subObjType the sub object type to be set

public void setTreeDivAttribute (String name, String value)

Function used for setting Tree properties. You can specify any property to be set on the main tree div using this function.

Parameters
name Name of property
value Property's value.