public class

FolderObjectExplorerTransform

extends AbstractObjectExplorerTreeTransform
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
               ↳ com.microstrategy.web.app.transforms.FolderObjectExplorerTransform
Known Direct Subclasses
Known Indirect Subclasses

Summary

[Expand]
Inherited Constants
From class com.microstrategy.web.app.transforms.AbstractObjectExplorerTreeTransform
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
public FormalParameter promptString
public FormalParameter promptStringID
[Expand]
Inherited Fields
From class com.microstrategy.web.app.transforms.AbstractObjectExplorerTreeTransform
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
FolderObjectExplorerTransform()
Public Methods
WebObjectInfo getFolderRoot()
Returns a (@link WebObjectInfo) as a reference to the folder bean displayed by the transform.
Map getLinkAttributes(WebDisplayUnit du)
Returns a map containing the attributes to add to the container of every folder link in the list of contents.
Class getSupportedBeanType()
Get the class of objects this transform is able to handle, which is WizardBean.
Map getUnitAttributes(WebDisplayUnit du)
Returns a map containing the attributes to add to the container of every object in the list of contents.
void initializeTransform(Transformable data)
Initializes transform formal parameters
void renderLayeredIconInfo(MarkupOutput out, WebDisplayUnit object, boolean useLinkCss)
generate a SPAN tag which host background image and an inner SPAN for the layering effect in case an additional image has to be included on top of the original (for example, a shortcut arrow, a red error sign, etc).
void renderOpenParent(MarkupOutput out)
Renders the upFolder button for the Object Browser.
void renderPromptString(MarkupOutput out)
void renderUnit(MarkupOutput out, WebDisplayUnit du)
Returns the give unit in the component's contents list.
boolean shouldRenderFolderLinks()
Determines if the Folder Links should be rendered.
Protected Methods
void addLinksAsOption(SelectTag __result)
Method adds the standard shortcut links that have to be displayed after the contents of the object browser.
TreeNode constructEntireTree()
This method is used in two scenarios: 1.
TreeNode generateIncrementalFetchNode(int direction)
this methods generates the incremental fetch nodes for the current expanded folder
TreeNode generateIncrementalFetchNode(int direction, WebFolder folder)
this method generates the incremental fetch tree nodes (next, prev) when necessary inside of a given webfolder
TreeNode generateSearchNode(List contents, WebSearch searchObj)
this method generates a tree node that represents the root node for the search results it's used when switching from a list view of search results to the tree view
SelectTag getAncestorsSelectTag()
Returns a >select< Tag instance object containing the list\ of the object's ancestors
String getCssName(WebDisplayUnit du)
Retruns the css class to use on the container of the object presented in the list of contents.
String getLinkCssName(WebDisplayUnit du)
Retruns the css class to use on the container of the links presented in the list of contents.
List getList(SimpleList simpleList)
int getReportViewMode(WebObjectInfo object)
Returns whether the report is in Grid mode, Graph mode or Grid-Graph mode.
String getTooltipInfo(WebObjectInfo item)
Returns the tooltip to add to each individual item in the Folder's list.
String getTooltipTitle(WebObjectInfo item)
Returns the descriptor to use for rendering the itemss tooltips.
String getUnitName(WebDisplayUnit du)
Renders only the name of the object passed as a parameter
static int getVisualizationMode(AbstractAppTransform transform, WebObjectInfo object)
int getVisualizationMode(WebObjectInfo object)
boolean isFolder(WebDisplayUnit du)
Determined whether the unit provided represents a folder in metadata.
boolean isTreeRoot(String objID)
static boolean isVisualizationObject(AbstractAppTransform transform, WebObjectInfo object)
boolean isVisualizationObject(WebObjectInfo object)
boolean shouldAddLinks()
Determines whether we should show the links for the object browser.
boolean shouldRenderLinks(TreeNode node)
this method checks to see whether we should render links as subnode of the given node
[Expand]
Inherited Methods
From class com.microstrategy.web.app.transforms.AbstractObjectExplorerTreeTransform
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

Fields

public FormalParameter promptString

public FormalParameter promptStringID

Public Constructors

public FolderObjectExplorerTransform ()

Public Methods

public WebObjectInfo getFolderRoot ()

Returns a (@link WebObjectInfo) as a reference to the folder bean displayed by the transform.

Returns
  • WebObjectInfo TODO shouldn't this chunck of code be part of the FolderBeanImpl?

public Map getLinkAttributes (WebDisplayUnit du)

Returns a map containing the attributes to add to the container of every folder link in the list of contents.

Parameters
du WebDisplayUnit
Returns
  • Map

public Class getSupportedBeanType ()

Get the class of objects this transform is able to handle, which is WizardBean.

Returns
  • a Class instance with the information about the beans this transform is able to manipulate.

public Map getUnitAttributes (WebDisplayUnit du)

Returns a map containing the attributes to add to the container of every object in the list of contents.

Parameters
du WebDisplayUnit
Returns
  • Map

public void initializeTransform (Transformable data)

Initializes transform formal parameters

Parameters
data Transformable instance to be associated with this transform.

public void renderLayeredIconInfo (MarkupOutput out, WebDisplayUnit object, boolean useLinkCss)

generate a SPAN tag which host background image and an inner SPAN for the layering effect in case an additional image has to be included on top of the original (for example, a shortcut arrow, a red error sign, etc).

Parameters
out MarkupOutput instance where to save the contents to display
object WebDisplayUnit to be rendered.

public void renderOpenParent (MarkupOutput out)

Renders the upFolder button for the Object Browser.

Parameters
out MarkupOutput

public void renderPromptString (MarkupOutput out)

public void renderUnit (MarkupOutput out, WebDisplayUnit du)

Returns the give unit in the component's contents list.

Parameters
out MarkupOutput
du WebDisplayUnit

public boolean shouldRenderFolderLinks ()

Determines if the Folder Links should be rendered.

Returns
  • boolean

Protected Methods

protected void addLinksAsOption (SelectTag __result)

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 TreeNode constructEntireTree ()

This method is used in two scenarios: 1. Every time when we bring up the editor bean by clicking on the link (in this case the whole tree needs to be constructed for sure) 2. when the user switches from a list view to a tree view, the tree needs to be re-constructed possibly from a sub-node all the way to the root folder specified in the configuration

Returns
  • TreeNode the root of the fully constructed tree

protected TreeNode generateIncrementalFetchNode (int direction)

this methods generates the incremental fetch nodes for the current expanded folder

Parameters
direction PREVIOUS - fetch the previous block NEXT - fetch the next block

protected TreeNode generateIncrementalFetchNode (int direction, WebFolder folder)

this method generates the incremental fetch tree nodes (next, prev) when necessary inside of a given webfolder

Parameters
direction the direction of the node (PREVIOUS or NEXT)
folder the folder which the incremental fetch nodes should be added to

protected TreeNode generateSearchNode (List contents, WebSearch searchObj)

this method generates a tree node that represents the root node for the search results it's used when switching from a list view of search results to the tree view

Parameters
contents the list of the search results
searchObj the search object that is used to retrieve the search results

protected SelectTag getAncestorsSelectTag ()

Returns a >select< Tag instance object containing the list\ of the object's ancestors

Returns
  • SelectTag

protected String getCssName (WebDisplayUnit du)

Retruns the css class to use on the container of the object presented in the list of contents.

Parameters
du WebDisplayUnit
Returns
  • String

protected String getLinkCssName (WebDisplayUnit du)

Retruns the css class to use on the container of the links presented in the list of contents.

Parameters
du WebDisplayUnit
Returns
  • String

protected List getList (SimpleList simpleList)

protected int getReportViewMode (WebObjectInfo object)

Returns whether the report is in Grid mode, Graph mode or Grid-Graph mode.

Returns
  • int

protected String getTooltipInfo (WebObjectInfo item)

Returns the tooltip to add to each individual item in the Folder's list.

Parameters
item WebObjectInfo the folder's child. It includes the name and description of the item.
Returns
  • String the tooltip to add to the HTML output.

protected String getTooltipTitle (WebObjectInfo item)

Returns the descriptor to use for rendering the itemss tooltips.

Parameters
item WebObjectInfo
Returns
  • String

protected String getUnitName (WebDisplayUnit du)

Renders only the name of the object passed as a parameter

Parameters
du WebDisplayUnit
Returns
  • String

protected static int getVisualizationMode (AbstractAppTransform transform, WebObjectInfo object)

protected int getVisualizationMode (WebObjectInfo object)

protected boolean isFolder (WebDisplayUnit du)

Determined whether the unit provided represents a folder in metadata.

Parameters
du WebDisplayUnit
Returns
  • boolean true if is a folder.

protected boolean isTreeRoot (String objID)

Returns
  • identify whether a given ID of a WebDisplayUnit is the root of the tree display or not; the root in the cube report editor should be "Shared Reports"

protected static boolean isVisualizationObject (AbstractAppTransform transform, WebObjectInfo object)

protected boolean isVisualizationObject (WebObjectInfo object)

protected boolean shouldAddLinks ()

Determines whether we should show the links for the object browser.

Returns
  • boolean

protected boolean shouldRenderLinks (TreeNode node)

this method checks to see whether we should render links as subnode of the given node

Parameters
node the node to check against