public class

FolderObjectBrowserTransform

extends FolderProjectBrowserTransform
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.FolderSmallIconTransform
               ↳ com.microstrategy.web.app.transforms.FolderProjectBrowserTransform
                 ↳ com.microstrategy.web.app.transforms.FolderObjectBrowserTransform

Class Overview

Description: The class is used to transform a Folder Bean into it's Object Brwoser mode.

Summary

[Expand]
Inherited Constants
From class com.microstrategy.web.app.transforms.FolderProjectBrowserTransform
From class com.microstrategy.web.app.transforms.FolderSmallIconTransform
From class com.microstrategy.web.app.transforms.AbstractFolderTransform
From class com.microstrategy.web.app.transforms.AbstractObjectInfoListTransform
From class com.microstrategy.web.app.transforms.AbstractAppTransform
[Expand]
Inherited Fields
From class com.microstrategy.web.app.transforms.FolderProjectBrowserTransform
From class com.microstrategy.web.app.transforms.FolderSmallIconTransform
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
FolderObjectBrowserTransform()
Public Methods
Map getContainerAttributes()
Returns a Map containing any attribute that must be added to the list's container.
void initializeTransform(Transformable data)
This method initialize the private and protected fields of the transform.
void renderFolderContentHTML(MarkupOutput out, WebObjectInfo woi)
Renders a single non-folder content item from the current folder in HTML mode
void renderFolderContentsSubmitButtonHTML(MarkupOutput out)
Renders the submit button for the folde's non-folder contents section in HTML mode
void renderList(MarkupOutput out)
Renders the list of objects contained in the folder as a list with small icons.
void transformForRequestSuccessful(MarkupOutput out)
Transforms the assosciated WebBean when its status is WebBeanRequestSuccessful.
Protected Methods
String getFolderContentsSelectNameHTML()
returns the name the select box for folder contentss in HTML will have
ArrayList getHiddenInputsEventList()
Returns the list of events that will be included in the hidden inputs section.
WebEvent getModifyFilterEvent()
Returns a WebEvent instance containing the event to use when adding an element to the filter.
WebEvent getModifyGridEvent()
Returns a WebEvent instance containing the event to use when adding unit to the grid.
String getObjectInfoParameter(WebObjectInfo woi)
Outputs a string formatted the way the objectInfo argument of the event requires it
WebComponent getProjectBrowserBean()
Returns a WebComponent instance representing the ProjectBrowser bean from where the transform will obtain information from.
boolean isTargetingFilter()
Returns true if the associated ProjectBrowser bean is modifying the report filter on the report
[Expand]
Inherited Methods
From class com.microstrategy.web.app.transforms.FolderProjectBrowserTransform
From class com.microstrategy.web.app.transforms.FolderSmallIconTransform
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

Public Constructors

public FolderObjectBrowserTransform ()

Public Methods

public Map getContainerAttributes ()

Returns a Map containing any attribute that must be added to the list's container.

Returns
  • Map key-value pairs of attributes.

public void initializeTransform (Transformable data)

This method initialize the private and protected fields of the transform. Extends initializeTransform by initializing the cache of this transform's Formal parameters.

Parameters
data Transformable instance with the bean to be transformed.

public void renderFolderContentHTML (MarkupOutput out, WebObjectInfo woi)

Renders a single non-folder content item from the current folder in HTML mode

Parameters
out MarkupOutput

public void renderFolderContentsSubmitButtonHTML (MarkupOutput out)

Renders the submit button for the folde's non-folder contents section in HTML mode

Parameters
out MarkupOutput instance where the HTML output is to be saved.

public void renderList (MarkupOutput out)

Renders the list of objects contained in the folder as a list with small icons.

Parameters
out MarkupOutput instance where the HTML output is to be saved.

public void transformForRequestSuccessful (MarkupOutput out)

Transforms the assosciated WebBean when its status is WebBeanRequestSuccessful.

Parameters
out MarkupOutput instance where the contents of this transform will be saved.

Protected Methods

protected String getFolderContentsSelectNameHTML ()

returns the name the select box for folder contentss in HTML will have

Returns
  • String

protected ArrayList getHiddenInputsEventList ()

Returns the list of events that will be included in the hidden inputs section.

Returns
  • ArrayList

protected WebEvent getModifyFilterEvent ()

Returns a WebEvent instance containing the event to use when adding an element to the filter.

Returns
  • WebEvent

protected WebEvent getModifyGridEvent ()

Returns a WebEvent instance containing the event to use when adding unit to the grid.

Returns
  • WebEvent

protected String getObjectInfoParameter (WebObjectInfo woi)

Outputs a string formatted the way the objectInfo argument of the event requires it

Returns
  • a String with the following format: ID|Type|Subtype|Alias|Name or

protected WebComponent getProjectBrowserBean ()

Returns a WebComponent instance representing the ProjectBrowser bean from where the transform will obtain information from.

Returns
  • WebComponent

protected boolean isTargetingFilter ()

Returns true if the associated ProjectBrowser bean is modifying the report filter on the report

Returns
  • boolean