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 String TREE_COMPONENT_ID ID used by the tree for the content that needs to be updated.

[Expand] Inherited Fields
From class com.microstrategy.web.app.gui.AbstractGuiElement protected AppContext _appContext the AppContext object associated with this gui element protected String _name name of the gui element protected WebComponent _webComponent the WebComponent object associated with this gui element

[Expand] Inherited Methods
From class com.microstrategy.web.app.gui.AbstractGuiElement AppContext getAppContext() return the AppContext object associated with this gui element String getDescriptor(int key) get descriptor by a key String getDescriptor(String key) get descriptor by a key EventManager getEventManager() get event manager for this gui element String getExtraInput() get extra input information for this gui element String getExtraUrl() get extra url information for this gui element WebFeatures getFeatures() Get the WebFeatures object associated with this gui element Messages getMessages() get the Messages object associated with this gui element String getName() get the name of the gui element TagsFactory getTagsFactory() boolean getUseIFrame() Indicates whether the instance uses IFrames in its output WebComponent getWebComponent() get the WebComponent object associated with this gui element boolean isDhtml() Returns true if the output mode has been set to dhtml boolean isIFrameEnabled() return whether the gui element is iframe enabled ParameterBuilder newHiddenInputBuilder() Convenience method to retrieve a new Hidden Input Builder object from the stored AppContext. NamespaceEncoder newNamespaceEncoder() Convenience method to retrieve a new Namespace Encoder object from the stored AppContext. ParameterBuilder newURIBuilder() Convenience method to retrieve a new URI Builder object from the stored AppContext. boolean renderElement(MarkupOutput mo) Render the current GUI Element with the information provided abstract MarkupOutput renderElement() render the gui element in a MarkupOutput object void setAppContext(AppContext value) set the AppContext object associated with this gui element void setExtraInput(String newValue) set extra url information for this gui element void setExtraUrl(String newValue) set extra url information for this gui element void setName(String value) set the name of the gui element void setUseIFrame(boolean value) Sets whether a ReportFrameElement should use IFrames in its output void setWebComponent(WebComponent value) set the WebComponent object associated with this gui element
From class java.lang.Object Object clone() boolean equals(Object arg0) void finalize() final Class<?> getClass() int hashCode() final void notify() final void notifyAll() String toString() final void wait() final void wait(long arg0, int arg1) final void wait(long arg0)
From interface com.microstrategy.web.app.gui.GuiElement abstract AppContext getAppContext() Get the AppContext instance used by this element abstract String getDescriptor(int key) Get the descriptor associated with the numeric key given abstract String getDescriptor(String key) Get the descriptor associated with the string key given abstract EventManager getEventManager() get the EventManager object associated with this gui element abstract String getExtraInput() get extra input info for the gui element abstract String getExtraUrl() get extra url info for the gui element abstract WebFeatures getFeatures() Get the WebFeatures instance used by this element abstract Messages getMessages() Get the Messages instance used by this element abstract String getName() Get the name property of this GUI element abstract boolean getUseIFrame() Indicates whether a ReportFrameElement uses IFrames in its output abstract WebComponent getWebComponent() Get the WebComponent instance used by this element abstract boolean renderElement(MarkupOutput out) abstract MarkupOutput renderElement() Render the GUI Element represented by this instance abstract void setAppContext(AppContext value) Set the AppContext instance to be used by this element abstract void setExtraInput(String newValue) set extra input info for the gui element abstract void setExtraUrl(String newValue) set extra url info for the gui element abstract void setName(String editorName) Set the name property of this GUI element abstract void setUseIFrame(boolean value) Sets whether a ReportFrameElement should use IFrames in its output abstract void setWebComponent(WebComponent value) Set the WebComponent instance to be used by this element
From interface com.microstrategy.web.app.gui.TreeBox abstract Object getProperty(String key) Function that returns value for a given Tree's property. abstract void renderNodes(MarkupOutput out, Enumeration elements) Function that renders the nodes of a tree box, given the enumeration of TreeNodes objects. abstract void renderTree(MarkupOutput out, Enumeration elements) Creates and register a tree. abstract void setProperty(String key, Object obj) Function used for setting Tree properties.