public class

FolderTreeTransform

extends FolderViewTransform
java.lang.Object
   ↳ com.microstrategy.web.transform.AbstractTransform
     ↳ com.microstrategy.web.transform.AbstractLayoutTransform
       ↳ com.microstrategy.web.app.transforms.AbstractAppTransform
         ↳ com.microstrategy.web.app.transforms.AbstractObjectInfoListTransform
           ↳ com.microstrategy.web.app.transforms.AbstractFolderTransform
             ↳ com.microstrategy.web.app.transforms.FolderViewTransform
               ↳ com.microstrategy.web.app.transforms.FolderTreeTransform
Known Direct Subclasses

Class Overview

Generic Transform class that can be used to render a folder bean as a tree.

Summary

Constants
String DUMMY_BEAN_NAME
[Expand]
Inherited Constants
From class com.microstrategy.web.app.transforms.FolderViewTransform
From class com.microstrategy.web.app.transforms.AbstractFolderTransform
From class com.microstrategy.web.app.transforms.AbstractObjectInfoListTransform
From class com.microstrategy.web.app.transforms.AbstractAppTransform
Fields
protected FormalParameter anchorTargetForNonFolderBrowseEvents
protected TreeView tree
[Expand]
Inherited Fields
From class com.microstrategy.web.app.transforms.FolderViewTransform
From class com.microstrategy.web.app.transforms.AbstractFolderTransform
From class com.microstrategy.web.app.transforms.AbstractObjectInfoListTransform
From class com.microstrategy.web.app.transforms.AbstractAppTransform
Public Constructors
FolderTreeTransform()
Class Constructor
Public Methods
String getDescription()
Returns a textual description of the transform.
String getID()
When it's an iFrame request, the ID used to render this component needs to be the one of the Tree itself:.
void initializeTransform(Transformable data)

This method initialize the private and protected fields of the transform, such as width and height.

void renderEmptyList(MarkupOutput out, WebFolder folder)
This method is deprecated. please use renderEmptyList(MarkupOutput) instead. The folder to access will be the available for this transform.
void renderList(MarkupOutput out)
Entry method of folder transforms to generate the list content.
Protected Methods
void addScriptDependencies()
Add to the ClientSideHelper associated with this instance the javascript files require to provide interactivity of the tree on the client browser.
TreeNode constructEntireTree()
Constructs the entire tree branch starting from the requested node and going upwards and returns the topmost non-Project node
TreeNode createNewNode(Object childObj, boolean isExpanded)
Ths methos us used to add a new node to the tree
boolean getRenderEntireTree()
Returns true to indicate the tree needs to be rendered entirely.
String getSysFolderDisplayName(int folderName)
Given the the FolderName from EnumDSSXMLFolderNames of Shared Reports, My Reports or My Objects, returns the internationalized text string for the same else returns an empty string.
int getSysFolderName(WebFolder folder)
Takes a WebFolder object and if it is one of Shared Reports, My Reports or My Objects folders, it returns the corresponding System Folder Name from EnumDSSXMLFolderNames or else returns 0
TreeNode getSysFolderNode(int folderName)
Given the folder name from EnumDSSXMLFolderNames, creates a tree node
TreeNode newTreeNode(WebObjectInfo object)
Creates and populates a single tree node
void populateTreeNodes(List children, TreeNode parentNode)
Used to populate the a node from a list of objects.
void renderTree(MarkupOutput out, TreeView tree)
Adds to the provided MarkupOutput the TreeView gui element
boolean suppressObject(int type)
Returns true if a particular object type should not be displayed as a tree node else false
boolean traverseBeyondFolder(WebFolder currentFolder, TreeNode currentNode)
Returns true if the tree contruction should continue higher up else false.
[Expand]
Inherited Methods
From class com.microstrategy.web.app.transforms.FolderViewTransform
From class com.microstrategy.web.app.transforms.AbstractFolderTransform
From class com.microstrategy.web.app.transforms.AbstractObjectInfoListTransform
From class com.microstrategy.web.app.transforms.AbstractAppTransform
From class com.microstrategy.web.transform.AbstractLayoutTransform
From class com.microstrategy.web.transform.AbstractTransform
From class java.lang.Object
From interface com.microstrategy.web.app.transforms.AppTransform
From interface com.microstrategy.web.transform.LayoutTransform
From interface com.microstrategy.web.transform.Transform

Constants

protected static final String DUMMY_BEAN_NAME

Constant Value: "bean_name"

Fields

protected FormalParameter anchorTargetForNonFolderBrowseEvents

protected TreeView tree

Public Constructors

public FolderTreeTransform ()

Class Constructor

Public Methods

public String getDescription ()

Returns a textual description of the transform.

Returns
  • The textual description of the transform.

public String getID ()

When it's an iFrame request, the ID used to render this component needs to be the one of the Tree itself:.

Returns
  • the component's unique id

public void initializeTransform (Transformable data)

This method initialize the private and protected fields of the transform, such as width and height. It also invokes the initializeWebComponent, initializeImages and initializeCss methods.

This method is automatically called from the transform method. Transforms which would like to invoke other methods in this instance directly (for example, to invoke some render methods), need first to call this method to guarantee that the Transform is ready to generate output.

Parameters
data the bean to transform.

public void renderEmptyList (MarkupOutput out, WebFolder folder)

This method is deprecated.
please use renderEmptyList(MarkupOutput) instead. The folder to access will be the available for this transform.

Renders the folder when it has no children. The HTML to render for this case includes only a SPAN HTML tag, with the empty-list corresponding style, displaying the localized descriptor for This folder is empty.

Parameters
out MarkupOutput instance where the transform's output will be saved.
folder the WebFolder instance from the FolderBean being transformed.

public void renderList (MarkupOutput out)

Entry method of folder transforms to generate the list content.

Parameters
out MarkupOutput instance to modify with the transform's output.

Protected Methods

protected void addScriptDependencies ()

Add to the ClientSideHelper associated with this instance the javascript files require to provide interactivity of the tree on the client browser.

protected TreeNode constructEntireTree ()

Constructs the entire tree branch starting from the requested node and going upwards and returns the topmost non-Project node

protected TreeNode createNewNode (Object childObj, boolean isExpanded)

Ths methos us used to add a new node to the tree

Parameters
childObj the object being added to the tree
isExpanded whether the new node will be expanded or collapsed

protected boolean getRenderEntireTree ()

Returns true to indicate the tree needs to be rendered entirely. A false value will indicate the current request this is a partial node update.

protected String getSysFolderDisplayName (int folderName)

Given the the FolderName from EnumDSSXMLFolderNames of Shared Reports, My Reports or My Objects, returns the internationalized text string for the same else returns an empty string.

protected int getSysFolderName (WebFolder folder)

Takes a WebFolder object and if it is one of Shared Reports, My Reports or My Objects folders, it returns the corresponding System Folder Name from EnumDSSXMLFolderNames or else returns 0

Throws
WebException
WebObjectsException

protected TreeNode getSysFolderNode (int folderName)

Given the folder name from EnumDSSXMLFolderNames, creates a tree node

protected TreeNode newTreeNode (WebObjectInfo object)

Creates and populates a single tree node

protected void populateTreeNodes (List children, TreeNode parentNode)

Used to populate the a node from a list of objects.

Parameters
children the list of objects from which new nodes will be created
parentNode to parent node where the new nodes will be created

protected void renderTree (MarkupOutput out, TreeView tree)

Adds to the provided MarkupOutput the TreeView gui element

Parameters
out MarkupOutput to write to
tree the TreeView object to include in the MarkupOutput

protected boolean suppressObject (int type)

Returns true if a particular object type should not be displayed as a tree node else false

protected boolean traverseBeyondFolder (WebFolder currentFolder, TreeNode currentNode)

Returns true if the tree contruction should continue higher up else false. If the tree needs to be shown only upto a particular system folder, this is method can be overridden for such cases.