Package com.microstrategy.web.app.gui

Class TreeBoxImpl

java.lang.Object

com.microstrategy.web.app.gui.AbstractGuiElement

com.microstrategy.web.app.gui.TreeBoxImpl

All Implemented Interfaces:

GuiElement, TreeBox

public class TreeBoxImpl
extends AbstractGuiElement
implements TreeBox

Deprecated.

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

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:

• TreeBox.renderTree(com.microstrategy.web.beans.MarkupOutput, java.util.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.
• TreeBox.renderNodes(com.microstrategy.web.beans.MarkupOutput, java.util.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 TreeBox.TREE_COMPONENT_ID.
  
  There are two properties that a user may specify for this element:
  1. EnumCartProperties.TREE_NAME: a unique name that identifies the tree.
  2. EnumCartProperties.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

Since:

MicroStrategy Web 7.5.0

Field Summary

Fields inherited from class com.microstrategy.web.app.gui.AbstractGuiElement

_appContext, _name, _webComponent

Fields inherited from interface com.microstrategy.web.app.gui.TreeBox

TREE_COMPONENT_ID

Constructor Summary

Constructors

Constructor	Description
TreeBoxImpl()	Deprecated. TreeBoxImpl constructor, initialize all tree properties.

Method Summary

Modifier and Type	Method	Description
EventManager	getEventManager()	Deprecated. Function that retuns the reference to the event manager.
java.lang.Object	getProperty(java.lang.String key)	Deprecated. Function that returns value for a given Tree's property.
MarkupOutput	renderElement()	Deprecated. Function that returns instance of output writer.
void	renderNodes(MarkupOutput out, java.util.Enumeration elements)	Deprecated. Generates the content for a list of TreeBox objects.
void	renderTree(MarkupOutput out, java.util.Enumeration elements)	Deprecated. Creates and register a tree.
void	setProperty(java.lang.String key, java.lang.Object obj)	Deprecated. Function used for setting Tree properties.

Methods inherited from class com.microstrategy.web.app.gui.AbstractGuiElement

getAppContext, getDescriptor, getDescriptor, getDescriptor, getExtraInput, getExtraUrl, getFeatures, getMessages, getName, getTagsFactory, getUseIFrame, getWebComponent, isDhtml, isIFrameEnabled, newHiddenInputBuilder, newNamespaceEncoder, newURIBuilder, renderElement, setAppContext, setExtraInput, setExtraUrl, setName, setUseIFrame, setWebComponent

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.microstrategy.web.app.gui.GuiElement

getAppContext, getDescriptor, getDescriptor, getExtraInput, getExtraUrl, getFeatures, getMessages, getName, getUseIFrame, getWebComponent, renderElement, setAppContext, setExtraInput, setExtraUrl, setName, setUseIFrame, setWebComponent

Constructor Detail

TreeBoxImpl

public TreeBoxImpl()

Deprecated.

TreeBoxImpl constructor, initialize all tree properties.

Method Detail

renderTree

public void renderTree(MarkupOutput out,
                       java.util.Enumeration elements)

Deprecated.

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

Specified by:

renderTree in interface TreeBox

Parameters:

out - MarkupOutput where to write the output

elements - An Enumeration of TreeNode objects.

renderElement

public MarkupOutput renderElement()

Deprecated.

Function that returns instance of output writer.

Specified by:

renderElement in interface GuiElement

Specified by:

renderElement in class AbstractGuiElement

Returns:

MarkupOutput

renderNodes

public void renderNodes(MarkupOutput out,
                        java.util.Enumeration elements)

Deprecated.

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

Specified by:

renderNodes in interface TreeBox

Parameters:

out - MarkupOutput where to write the output

elements - An Enumeration of TreeNode objects.

getEventManager

public EventManager getEventManager()

Deprecated.

Function that retuns the reference to the event manager.

Specified by:

getEventManager in interface GuiElement

Overrides:

getEventManager in class AbstractGuiElement

Returns:

EventManager __result the event manager

Since:

MicroStrategy Web 8.0.1

getProperty

public java.lang.Object getProperty(java.lang.String key)

Deprecated.

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

Specified by:

getProperty in interface TreeBox

Parameters:

key - name of property

Returns:

Objest value held by property

setProperty

public void setProperty(java.lang.String key,
                        java.lang.Object obj)

Deprecated.

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

Specified by:

setProperty in interface TreeBox

Parameters:

key - name of property

obj - property's value.