public class

FolderFrameTreeTransform

extends FolderTreeTransform
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
                 ↳ com.microstrategy.web.app.transforms.FolderFrameTreeTransform

Class Overview

Transform class used to generate the visual representation of the folder as a tree in Microstrategy Web.

Summary

[Expand]
Inherited Constants
From class com.microstrategy.web.app.transforms.FolderTreeTransform
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 Hashtable<Integer, Boolean> rootFoldersOnDisplay
protected FormalParameter visibleRootFolders
[Expand]
Inherited Fields
From class com.microstrategy.web.app.transforms.FolderTreeTransform
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
FolderFrameTreeTransform()
Class Constructor
Public Methods
void addShortcutLinks(TreeNode root)
Add the folder links from the folderLinks.xml to the tree case on the context Id of the tree
WebEvent getEvent(WebObjectInfo object)
Based on the object type on the WebObjectInfo sent as parameter, it creates and initializes the corresponding WebEvent for having the object opened or run.
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.
void transformForRequestInError(MarkupOutput out)
Generates the output when the bean's status is WebBeanRequestEndsInError.
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.
void createRootLevelFolders()
Creates the folders that will display at the root level of the tree.
String getFolderLinkClasses(WebObjectInfo object)
Returns the css class to use when rendering the different named folders and shortcuts available in the tree
boolean getRenderEntireTree()
Returns true to indicate the tree needs to be rendered entirely.
void renderTree(MarkupOutput out, TreeView tree)
This method will write into the provided MarkupOutput the entire folder tree
boolean suppressObject(int type)
This method is called for every object rendered by the tree.
boolean traverseBeyondFolder(WebFolder currentFolder, TreeNode currentNode)
Indicates whether the tree should render the child nodes while rendering the current node.
[Expand]
Inherited Methods
From class com.microstrategy.web.app.transforms.FolderTreeTransform
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

Fields

protected Hashtable<Integer, Boolean> rootFoldersOnDisplay

protected FormalParameter visibleRootFolders

Public Constructors

public FolderFrameTreeTransform ()

Class Constructor

Public Methods

public void addShortcutLinks (TreeNode root)

Add the folder links from the folderLinks.xml to the tree case on the context Id of the tree

public WebEvent getEvent (WebObjectInfo object)

Based on the object type on the WebObjectInfo sent as parameter, it creates and initializes the corresponding WebEvent for having the object opened or run.

Parameters
object a WebObjectInfo for which the "execution" event must be retrieved.
Returns

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.

Entry method of folder transforms to generate empty list .

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.

public void transformForRequestInError (MarkupOutput out)

Generates the output when the bean's status is WebBeanRequestEndsInError.

Parameters
out output by this transform

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 void createRootLevelFolders ()

Creates the folders that will display at the root level of the tree. Depending on the user privileges, this list of folders will include Shared Reports, My Reports and My Objects

protected String getFolderLinkClasses (WebObjectInfo object)

Returns the css class to use when rendering the different named folders and shortcuts available in the tree

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 void renderTree (MarkupOutput out, TreeView tree)

This method will write into the provided MarkupOutput the entire folder tree

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

protected boolean suppressObject (int type)

This method is called for every object rendered by the tree. When the value returned is true, the object will not be included in the tree output.

Parameters
type The object type (#EnumDSSXMLObjectTypes) of the object being added to the tree

protected boolean traverseBeyondFolder (WebFolder currentFolder, TreeNode currentNode)

Indicates whether the tree should render the child nodes while rendering the current node.