public class

TreeBoxImpl

extends AbstractGuiElement
implements TreeBox
java.lang.Object
   ↳ com.microstrategy.web.app.gui.AbstractGuiElement
     ↳ com.microstrategy.web.app.gui.TreeBoxImpl

This class is deprecated.
Use (@link com.microstrategy.web.app.gui.TreeViewImpl} instead of this to render a tree view.

Class Overview

The TreeBox GuiElement is designed to create a hierarchical tree that can be dynamically populated using WebEvents.
It receives an enumeration of TreeNode objects. Each TreeNode contains its display information as well as the event to trigger when the node is selected, or in the case when the node is not a leaf, the event that will retrieve its content.
Noticed that Events to expand a node will automatically be submitted through the iFrame using javascript.
The TreeBox provides two render methods:

  • renderTree(MarkupOutput, Enumeration) it creates and register a new tree and populates its root nodes with the Enumeration it receives. This method should be used the first time the tree is generated.
  • renderNodes(MarkupOutput, Enumeration): it will just generate the content of the child nodes. This method should be used when updating the tree through the iFrame. When this is the case, make sure the content is enclosed by a div with id TREE_COMPONENT_ID.

    There are two properties that a user may specify for this element:
    1. TREE_NAME: a unique name that identifies the tree.
    2. CART_INDEX: the index of this tree within the page.

    When using this GuiElement, make sure the links to following files are included in the final HTML output:
    • javascript/DHTML.js
    • javascript/treev3.js
    • style/mstr/tree.css

Summary

[Expand]
Inherited Constants
From interface com.microstrategy.web.app.gui.TreeBox
[Expand]
Inherited Fields
From class com.microstrategy.web.app.gui.AbstractGuiElement
Public Constructors
TreeBoxImpl()
TreeBoxImpl constructor, initialize all tree properties.
Public Methods
EventManager getEventManager()
Function that retuns the reference to the event manager.
Object getProperty(String key)
Function that returns value for a given Tree's property.
MarkupOutput renderElement()
Function that returns instance of output writer.
void renderNodes(MarkupOutput out, Enumeration elements)
Generates the content for a list of TreeBox objects.
void renderTree(MarkupOutput out, Enumeration elements)
Creates and register a tree.
void setProperty(String key, Object obj)
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.TreeBox

Public Constructors

public TreeBoxImpl ()

TreeBoxImpl constructor, initialize all tree properties.

Public Methods

public EventManager getEventManager ()

Function that retuns the reference to the event manager.

Returns
  • EventManager __result the event manager

public Object getProperty (String key)

Function that returns value for a given Tree's property.

Parameters
key name of property
Returns
  • Objest value held by property

public MarkupOutput renderElement ()

Function that returns instance of output writer.

Returns
  • MarkupOutput

public void renderNodes (MarkupOutput out, Enumeration elements)

Generates the content for a list of TreeBox objects. You may use this method to update the tree content after an iframe request.

Parameters
out MarkupOutput where to write the output
elements An Enumeration of TreeNode objects.

public void renderTree (MarkupOutput out, Enumeration elements)

Creates and register a tree. It also populate its root elements. Use the first time a tree is generated.

Parameters
out MarkupOutput where to write the output
elements An Enumeration of TreeNode objects.

public void setProperty (String key, Object obj)

Function used for setting Tree properties. Key is the name of the property and obj its value.

Parameters
key name of property
obj property's value.