public class

AllObjectBrowserTransform

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

Summary

Nested Classes
class AllObjectBrowserTransform.Context Extends AbstractAppTransform.Context by providing a link to the current WebObjectInfo
[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
[Expand]
Inherited Fields
From class com.microstrategy.web.app.transforms.FolderObjectExplorerTransform
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
AllObjectBrowserTransform()
Public Methods
Map getContextMenuAttributes(WebDisplayUnit wdu)
Returns the context-menu specific attributes to assign to the context-menu container
String getDescription()
Return description for this Transform.
void initializeTransform(Transformable data)
Initializes transform formal parameters
void renderDisplayFormatIcon(MarkupOutput out)
Renders a link to change the display format of the object browser content
void renderOpenParent(MarkupOutput out)
Renders the upFolder button for the Object Browser.
void renderUnit(MarkupOutput out, WebDisplayUnit du)
Returns the give unit in the component's contents list.
boolean shouldDisplayObject(WebDisplayUnit du)
Protected Methods
TreeNode constructEntireTree()
This method is used in two scenarios: 1.
ArrayList getAncestorsOptionTags(StringBuffer indentBuffer)
SelectTag getAncestorsSelectTag()
Returns a >select< Tag instance object containing the list\ of the object's ancestors
AnchorTag getBrowseUnitAnchor(WebDisplayUnit du)
Gets the browse event used by the data explorer bean in an anchor tag
WebEvent getChangeDisplayFormatEvent()
Returns a new instance of the event use to toggle the display format
TransformContext getContext()
Extends getContext() by setting to the context object a reference the current WebObjectInfo
ContextMenu getContextMenu(WebDisplayUnit du)
Return the ContextMenu associated with the object
String getJavascriptTyAttribute(WebObjectInfo object)
Return the Javascript TY attribute to use for the generation of the HTML tag related with this object.
Tag getSearchBox()
Returns the search box for the project browser
boolean isDimension(WebDisplayUnit du)
Determined whether the unit provided represents a dimension in metadata.
boolean isRenderAsTree()
Returns whether the object browser is displayed in List View or Tree View
boolean isStartingFolder(String objID)
TransformContext newContext()
Creates a new instance of a TransformContext.
TreeNode newTreeNode(WebDisplayUnit object)
Creates and populates a single tree node
TreeNode newTreeNodeLink(WebDisplayUnit object)
Creates and populates a single tree node
void renderJavascript(MarkupOutput out)
This method should be used by the Editor transforms to generate any javascript necessary.
boolean shouldAddLinks()
We should add links only if StartBrowsingFolderID is not specified or if allowAllObjectBrowsing is true
[Expand]
Inherited Methods
From class com.microstrategy.web.app.transforms.FolderObjectExplorerTransform
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

Public Constructors

public AllObjectBrowserTransform ()

Public Methods

public Map getContextMenuAttributes (WebDisplayUnit wdu)

Returns the context-menu specific attributes to assign to the context-menu container

Parameters
wdu WebObjectInfo
Returns
  • Map CX, CXID ....

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 renderDisplayFormatIcon (MarkupOutput out)

Renders a link to change the display format of the object browser content

Parameters
out MarkupOutput

public void renderOpenParent (MarkupOutput out)

Renders the upFolder button for the Object Browser.

Parameters
out MarkupOutput

public void renderUnit (MarkupOutput out, WebDisplayUnit du)

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

Parameters
out MarkupOutput
du WebDisplayUnit

public boolean shouldDisplayObject (WebDisplayUnit du)

Protected Methods

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 ArrayList getAncestorsOptionTags (StringBuffer indentBuffer)

protected SelectTag getAncestorsSelectTag ()

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

Returns
  • SelectTag

protected AnchorTag getBrowseUnitAnchor (WebDisplayUnit du)

Gets the browse event used by the data explorer bean in an anchor tag

Returns
  • AnchorTag

protected WebEvent getChangeDisplayFormatEvent ()

Returns a new instance of the event use to toggle the display format

Returns
  • WebEvent

protected TransformContext getContext ()

Extends getContext() by setting to the context object a reference the current WebObjectInfo

protected ContextMenu getContextMenu (WebDisplayUnit du)

Return the ContextMenu associated with the object

Parameters
du WebObjectInfo
Returns

protected String getJavascriptTyAttribute (WebObjectInfo object)

Return the Javascript TY attribute to use for the generation of the HTML tag related with this object.

Parameters
object The WebObjectInfo for which it's ty attribute name is requested.
Returns
  • The Javascript TY attribute to use for the generation of the HTML tag related with this object. If none is found given the object type, null will be returned.

protected Tag getSearchBox ()

Returns the search box for the project browser

protected boolean isDimension (WebDisplayUnit du)

Determined whether the unit provided represents a dimension in metadata.

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

protected boolean isRenderAsTree ()

Returns whether the object browser is displayed in List View or Tree View

Returns
  • boolean

protected boolean isStartingFolder (String objID)

Returns
  • identify whether a given ID of a WebDisplayUnit is the root of the all object browsing for a certain report.

protected TransformContext newContext ()

Creates a new instance of a TransformContext. It's used by the getContext method the first time is invoked. Transforms who require to include extra information in the context should create their own TransformContext implementation (possibly a subclass of AppTransformContext) and returns a new instance in this method.

protected TreeNode newTreeNode (WebDisplayUnit object)

Creates and populates a single tree node

Returns
  • TreeNode

protected TreeNode newTreeNodeLink (WebDisplayUnit object)

Creates and populates a single tree node

Parameters
object WebDisplayUnit

protected void renderJavascript (MarkupOutput out)

This method should be used by the Editor transforms to generate any javascript necessary.
The default implementation includes a call to the ClientSideHelper to render the dynamic scrips and the registerBone call.

Parameters
out MarkupOutput where the output should be rendered.

protected boolean shouldAddLinks ()

We should add links only if StartBrowsingFolderID is not specified or if allowAllObjectBrowsing is true

Returns
  • boolean