public abstract class

AbstractObjectExplorerTreeTransform

extends AbstractObjectExplorerTransform
java.lang.Object
   ↳ com.microstrategy.web.transform.AbstractTransform
     ↳ com.microstrategy.web.transform.AbstractLayoutTransform
       ↳ com.microstrategy.web.app.transforms.AbstractAppTransform
         ↳ com.microstrategy.web.app.transforms.AbstractEditorTransform
           ↳ com.microstrategy.web.app.transforms.AbstractObjectExplorerTransform
             ↳ com.microstrategy.web.app.transforms.AbstractObjectExplorerTreeTransform
Known Direct Subclasses
Known Indirect Subclasses

Summary

Constants
int INCREMENTAL_FETCH_NEXT
int INCREMENTAL_FETCH_PREVIOUS
[Expand]
Inherited Constants
From class com.microstrategy.web.app.transforms.AbstractObjectExplorerTransform
From class com.microstrategy.web.app.transforms.AbstractEditorTransform
From class com.microstrategy.web.app.transforms.AbstractAppTransform
Fields
protected boolean populateChildren
protected TreeView tree TreeView that is used to render the tree once it's populated
[Expand]
Inherited Fields
From class com.microstrategy.web.app.transforms.AbstractObjectExplorerTransform
From class com.microstrategy.web.app.transforms.AbstractEditorTransform
From class com.microstrategy.web.app.transforms.AbstractAppTransform
Public Constructors
AbstractObjectExplorerTreeTransform()
Public Methods
String getDescription()
Return description for this Transform.
void initializeTransform(Transformable data)
Initializes transform formal parameters
void renderEditorContents(MarkupOutput out)
Method that renders the editor contents corresponding to this Wizard.
void renderTree(MarkupOutput out)
Method renders the object browser in the tree view.
Protected Methods
void addLinks(TreeNode node)
Method adds the standard shortcut links that have to be displayed after the contents of the object browser.
abstract TreeNode constructEntireTree()
TreeNode createNewNode(Object childObj, boolean isExpanded)
Creates a new tree node for the tree view.
TreeNode generateIncrementalFetchNode(int direction)
abstract String getLinkCssName(WebDisplayUnit wdu)
boolean isRenderAsTree()
Returns whether the object browser has been rendered in list view or tree view
boolean isRenderEntireTree()
Indicates whether it's necessary to render the entire tree
TreeNode newTreeNode(WebDisplayUnit object)
Creates and populates a single tree node
TreeNode newTreeNodeLink(WebDisplayUnit object)
Creates and populates a single tree node
void populateTreeNodes(List children, TreeNode parentNode)
Method populates a tree node with its contents.
List populateWithChildren(WebDisplayUnit webFolder)
Method returns a list populated with the folder's children.
abstract boolean shouldRenderLinks(TreeNode node)
[Expand]
Inherited Methods
From class com.microstrategy.web.app.transforms.AbstractObjectExplorerTransform
From class com.microstrategy.web.app.transforms.AbstractEditorTransform
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 int INCREMENTAL_FETCH_NEXT

Constant Value: 1 (0x00000001)

protected static final int INCREMENTAL_FETCH_PREVIOUS

Constant Value: 0 (0x00000000)

Fields

protected boolean populateChildren

protected TreeView tree

TreeView that is used to render the tree once it's populated

Public Constructors

public AbstractObjectExplorerTreeTransform ()

Public Methods

public String getDescription ()

Return description for this Transform.

Returns
  • description text.

public void initializeTransform (Transformable data)

Initializes transform formal parameters

Parameters
data Transformable instance to be associated with this transform.

public void renderEditorContents (MarkupOutput out)

Method that renders the editor contents corresponding to this Wizard.

Parameters
out MarkupOutput instance where the HTML contents to render are to be saved.

public void renderTree (MarkupOutput out)

Method renders the object browser in the tree view.

Protected Methods

protected void addLinks (TreeNode node)

Method adds the standard shortcut links that have to be displayed after the contents of the object browser. These links are shortcuts to the Attributes, Metrics, Hierarchies ... folders

protected abstract TreeNode constructEntireTree ()

protected TreeNode createNewNode (Object childObj, boolean isExpanded)

Creates a new tree node for the tree view.

protected TreeNode generateIncrementalFetchNode (int direction)

protected abstract String getLinkCssName (WebDisplayUnit wdu)

protected boolean isRenderAsTree ()

Returns whether the object browser has been rendered in list view or tree view

Returns
  • boolean

protected boolean isRenderEntireTree ()

Indicates whether it's necessary to render the entire tree

Returns
  • true if need to render the entire tree; false otherwise

protected TreeNode newTreeNode (WebDisplayUnit object)

Creates and populates a single tree node

protected TreeNode newTreeNodeLink (WebDisplayUnit object)

Creates and populates a single tree node

Parameters
object WebDisplayUnit

protected void populateTreeNodes (List children, TreeNode parentNode)

Method populates a tree node with its contents.

protected List populateWithChildren (WebDisplayUnit webFolder)

Method returns a list populated with the folder's children.

protected abstract boolean shouldRenderLinks (TreeNode node)