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

AllObjectBrowserHTMLTransform, FilterAllObjectBrowserTransform

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

protected final String	CLASS_INPUT	This field is deprecated. This property is not used anymore by the transform.
protected final String	CLASS_MESSAGE	This field is deprecated. This property is not used anymore by the transform.
protected WebComponent	_bean	Instance of `WebComponent` being transformed.
protected ComponentBlock	_componentBlock
protected String	_cssPrefix	Property corresponding to the value of the `cssPrefix` formal parameter
protected String	_imgBlank	Field that containts the URL location of a blank image (used as the source of most <IMG> tags as the real URL is specified through css).
protected String	_imgWait	This field is deprecated. This value is not used anymore by the Transform as the wait image is included using css.
protected MarkupOutput	_selfOutput	This field is deprecated. this field is no longer used since partial update blocks are now generated via `ComponentBlock`
protected MarkupOutput	_subOutput	This field is deprecated. this field is no longer used since partial update blocks are now generated via `ComponentBlock`
public FormalParameter	appliesTo	This parameter informs the javascript the id of the bone the actions of this component applies to.
public FormalParameter	contextMenus	This formal parameter is used by the Transform to identify the context-menus definition.
public FormalParameter	cssFile	CSS file that includes the style definition.
public FormalParameter	cssPrefix	Prefix to append to all css class names.
public FormalParameter	debugErrorFlags	Indicates which extra debug information to include in case of an error.
public FormalParameter	debugFlags	Indicates which debug information to include.
public FormalParameter	dragMode	Indicates the drag mode that the component to render will have.
public FormalParameter	extraInput	Indicates any extra inputs to be included in the forms generated by the transform.
public FormalParameter	extraUrl	Indicates any extra parameters to be included in the links generated by the transform.
public FormalParameter	globalCssErrorMessage	This field is deprecated. The css class to use cannot be controlled through a formal parameter anymore.
public FormalParameter	globalCssErrorTitle	This field is deprecated. The css class to use cannot be controlled through a formal parameter anymore.
public FormalParameter	height	Indicates the default height of the component.
public FormalParameter	iframeEnabled	Indicates whether the transform supports iframe manipulations.
public FormalParameter	imgWait	This field is deprecated. This value is not used anymore by the Transform as the wait image is included using css.
protected int	indent	This field is deprecated. Indentation is not appended by Transforms anymore. Although it provided a somewhat better looking HTML source, it also affected performance by increasing the HTML size.
public FormalParameter	initialIndent	This field is deprecated. Indentation is not appended by Transforms anymore. Although it provided a somewhat better looking HTML source, it also affected performance by increasing the HTML size.
protected boolean	isDHTML	This field is deprecated. Use `isDhtml()`.
public FormalParameter	orientation	Indicates the orientation the dialog to render will have.
public FormalParameter	orientationsAllowed	Indicates the orientation modes allowed for the dialog to render.
public FormalParameter	partialIframeUpdate	This formal parameter specifies whether we should replace the whole contentst of the div shell (outerHTML) or the just the inner contents (innerHTML) of that shell div for the transform when the iframe update is going on.
public FormalParameter	processingButtonsFlags	Indicates which buttons to include on the wait page.
public FormalParameter	processingInfoFlags	Indicates which information to include on the wait page.
public FormalParameter	resizeLevel	Indicates whether the component can be resized vertically/horizontally or both or none.
public FormalParameter	scriptClass	Holds the name of the javaScript class (if any) to be associated with the component.
protected static final ScriptVariableJSONEncoder	scriptEndTagEncoder	reference to encoder that deals with tag encoding
public FormalParameter	type	This parameter is used when the output of this Transform generates a corresponding Microstrategy bone in the page, and it informs the javascript the type of bone it is.
public FormalParameter	useDHTML	Indicates whether to use DHTML on the output.
public FormalParameter	width	Indicates the default width of the component.

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

void	addFormalParam(FormalParameterImpl formal) This method is used to add a `FormalParameterImpl` object to the transform.
boolean	canTransform(Transformable data) Checks that the transform supports specified data object and that object is in the state supported by this transform.
static List<Integer>	getEvents(RequestKeys rkeys) Determines event(s) triggered from the request keys.
FormalParameters	getFormalParams() Returns the collection of formal parameters associated with this transform.
String	getID() Returns the unique name of the component to be used as the ID for its shell
MarkupOutput	getPreview() Produces a preview output for this transform.
boolean	isPreviewAvailable() Returns true if this transform supports preview functionality, false otherwise.
boolean	isResolved() Returns whether each required formal parameter has a value associated with it.
FormalParameterImpl	removeFormalParam(String name) Removes the formal parameter with the given name from the formal parameters collection.
void	setAnnotation(FormalParameter fp, FormalParameterAnnotation fpa) Used for internal housekeeping.
void	setDeprecated(FormalParameter fp, String desc) Used for internal housekeeping.
boolean	supports(Class type) Returns true if the transform supports objects of specified type.
boolean	supports(Transformable data) Returns true if the transform supports the specified data object.

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

abstract boolean	canTransform(Transformable data) Checks that the transform supports specified data object and that object is in the state supported by this transform.
abstract String	getDescription() Returns a textual description of the transform.
abstract FormalParameters	getFormalParams() Returns the collection of formal parameters associated with this transform.
abstract String	getID() Returns the unique name of the component to be used as the ID for its shell
abstract MarkupOutput	getPreview() This method is deprecated. This feature is not used
abstract Class	getSupportedBeanType() Returns a root class/interface supported by this transform.
abstract boolean	isPreviewAvailable() This method is deprecated. This feature is not used
abstract boolean	isResolved() Returns whether each required formal parameter has a value associated with it.
abstract boolean	supports(Class beanClass) Returns true if the transform supports objects of specified type.
abstract boolean	supports(Transformable data) Returns true if the transform supports the specified data object.
abstract void	transform(Transformable data, MarkupOutput transOut) Transforms the data object and appends result to the transOut.

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

ContextMenu ContextMenu

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.

Throws

WebObjectsException

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

Interfaces

Classes

AllObjectBrowserTransform

Summary

Public Constructors

public AllObjectBrowserTransform ()

Public Methods

public Map getContextMenuAttributes (WebDisplayUnit wdu)

Parameters

Returns

public String getDescription ()

Returns

public void initializeTransform (Transformable data)

Parameters

public void renderDisplayFormatIcon (MarkupOutput out)

Parameters

public void renderOpenParent (MarkupOutput out)

Parameters

public void renderUnit (MarkupOutput out, WebDisplayUnit du)

Parameters

See Also

public boolean shouldDisplayObject (WebDisplayUnit du)

Protected Methods

protected TreeNode constructEntireTree ()

Returns

protected ArrayList getAncestorsOptionTags (StringBuffer indentBuffer)

protected SelectTag getAncestorsSelectTag ()

Returns

protected AnchorTag getBrowseUnitAnchor (WebDisplayUnit du)

Returns

protected WebEvent getChangeDisplayFormatEvent ()

Returns

protected TransformContext getContext ()

protected ContextMenu getContextMenu (WebDisplayUnit du)

Parameters

Returns

protected String getJavascriptTyAttribute (WebObjectInfo object)

Parameters

Returns

protected Tag getSearchBox ()

protected boolean isDimension (WebDisplayUnit du)

Parameters

Returns

protected boolean isRenderAsTree ()

Returns

protected boolean isStartingFolder (String objID)

Returns

Throws

protected TransformContext newContext ()

protected TreeNode newTreeNode (WebDisplayUnit object)

Returns

protected TreeNode newTreeNodeLink (WebDisplayUnit object)

Parameters

protected void renderJavascript (MarkupOutput out)

Parameters

protected boolean shouldAddLinks ()

Returns