public class

ObjectBrowserTabProjectBrowserTransform

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

This class is deprecated.
This class is no longer used by Web

Class Overview

This Transforms allows project browsing within an Object Browser Manager.

Summary

Constants
int DISPLAY_LEVEL_CONTENTS_BODY_ALL Value that can be used for the levelFlag for this transform to render all sections of the project browser (ancestors dropdown, search box, contents list, incremental fetch)
int DISPLAY_LEVEL_CONTENTS_BODY_ANCESTORS Value that can be used for the levelFlag for this transform to render the ancestors of the current folder as a select box
int DISPLAY_LEVEL_CONTENTS_BODY_INCREMENTAL_FETCH Value that can be used for the levelFlag for this transform to render the incremental fetch for the project browser
int DISPLAY_LEVEL_CONTENTS_BODY_LIST Value that can be used for the levelFlag for this transform to render the project browser contents list alone
int DISPLAY_LEVEL_CONTENTS_BODY_SEARCH Value that can be used for the levelFlag for this transform to render the project browser search box.
String FP_CHECK_IMAGE Name for the formal parameter: checkImage
String FP_FOLDER_JS Name for the formal parameter: folderJS
String FP_FOLDER_UP_IMAGE Name for the formal parameter: folderUpImage
String FP_FOLDER_UP_JS Name for the formal parameter: folderUpJS
String FP_IMAGE_FIRST_PAGE Name for the formal parameter: imgFirstPage
String FP_IMAGE_FIRST_PAGE_DISABLED Name for the formal parameter: imgFirstPageDisabled
String FP_IMAGE_LAST_PAGE Name for the formal parameter: imgLastPage
String FP_IMAGE_LAST_PAGE_DISABLED Name for the formal parameter: imgLastPageDisabled
String FP_IMAGE_NEXT_PAGE Name for the formal parameter: imgNextPage
String FP_IMAGE_NEXT_PAGE_DISABLED Name for the formal parameter: imgNextPageDisabled
String FP_IMAGE_PREVIOUS_PAGE Name for the formal parameter: imgPreviousPage
String FP_IMAGE_PREVIOUS_PAGE_DISABLED Name for the formal parameter: imgPreviousPageDisabled
String FP_INCREMENTAL_FETCH_JS Name for the formal parameter: incrementalFetchJS
String FP_LEVEL_CHANGE_JS Name for the formal parameter: levelChangeJS
String FP_LEVEL_FLAG Name for the formal parameter: levelFlag
String FP_SEARCH_IMAGE Name for the formal parameter: searchImage
String FP_SEARCH_JS Name for the formal parameter: searchJS
[Expand]
Inherited Constants
From class com.microstrategy.web.app.transforms.AbstractObjectBrowserTabTransform
From class com.microstrategy.web.app.transforms.AbstractEditorTransform
From class com.microstrategy.web.app.transforms.AbstractAppTransform
Fields
protected RWProjectBrowserTabBean _projectBrowserBean The project browser bean
public FormalParameter checkImage Formal parameter: The icon to use to submit the parent folders select box in HTML mode.
protected String cssBody The className for the body of the project browser contents
protected String cssFileSearch The className for the search text box
public FormalParameter folderJS Formal parameter: The javascript function to execute when you click on a folder
public FormalParameter folderUpImage Formal parameter: Indicates the image to use for allowing the user to navigate one folder up in the hierarchy.
public FormalParameter folderUpJS Formal parameter: The javascript function to execute when you click on the image that takes you up a level in the folder structure.
public FormalParameter imgFirstPage Formal parameter: The image to use for the first page of the incremental fetch when active.
public FormalParameter imgFirstPageDisabled Formal parameter: The image to use for the first page of the incremental fetch when inactive.
public FormalParameter imgLastPage Formal parameter: The image to use for the last page of the incremental fetch when active.
public FormalParameter imgLastPageDisabled Formal parameter: The image to use for the last page of the incremental fetch when inactive.
public FormalParameter imgNextPage Formal parameter: The image to use for the next page of the incremental fetch when active.
public FormalParameter imgNextPageDisabled Formal parameter: The image to use for the next page of the incremental fetch when inactive.
public FormalParameter imgPreviousPage Formal parameter: The image to use for the previous page of the incremental fetch.
public FormalParameter imgPreviousPageDisabled Formal parameter: The image to use for the previous page of the incremental fetch when inactive.
public FormalParameter incrementalFetchJS Formal parameter: The javascript function to execute when you click on the incremental fetch links
public FormalParameter levelChangeJS Formal parameter: The javascript function to execute when you change the folder level
public FormalParameter levelFlag This level flag can be used to control the components that will be rendered by the project browser bean.
public FormalParameter searchImage Formal parameter: Indicates the image to use for allowing the user to run a search.
public FormalParameter searchJS Formal parameter: The javascript function to execute when you click on the search image button
[Expand]
Inherited Fields
From class com.microstrategy.web.app.transforms.AbstractObjectBrowserTabTransform
From class com.microstrategy.web.app.transforms.AbstractEditorTransform
From class com.microstrategy.web.app.transforms.AbstractAppTransform
Public Constructors
ObjectBrowserTabProjectBrowserTransform()
Default constructor for the transform.
Public Methods
String getDescription()
Returns the textual description of the transform
Class getSupportedBeanType()
Returns the supported bean type.
void initializeCss()
Initializes the Css Classes to use.
void initializeImages()
Initializes the name of the images to use on this transform's output.
void initializeTransform(Transformable data)
Initializes transform formal parameters
boolean isTransformEnabled()
Indicates if the transform can be performed for the current state of the bean.
void renderAncestorInformation(MarkupOutput out)
Renders the ancestors of the current folder in the form of a 'SELECT' box Used in DHTML mode only.
void renderContentsBodyDHTML(MarkupOutput out)
Renders the body of the contents of the project browser in DHTML mode.
void renderContentsBodyHTML(MarkupOutput out)
Renders the body of the contents of the project browser in HTML mode.
void renderContextMenu(MarkupOutput out)
This method is for rendering the context menus.
void renderEditorContents(MarkupOutput out)
Renders the contents of the project browser.
void renderGlobalEventsInformation(MarkupOutput out)
Render extra event information, for events that some one else might trigger
void renderIncrementalFetch(MarkupOutput out)
Renders the incremental fetch section in DHTML mode
void renderObjectCount(MarkupOutput out)
This method render the section that displays the number of objects found.
void renderObjectList(MarkupOutput out)
Renders the list of objects for the current folder/search results whose contents is being displayed in DHTML mode.
void renderSearchSection(MarkupOutput out)
Renders the search section of the project browser in DHTML mode
void renderTreeTable(MarkupOutput out)
Renders the contents of the current folder/search results of the project browser bean in DHTML mode.
void transformForRequestSuccessful(MarkupOutput out)
Transforms the assosciated TabBean when its status is WebBeanRequestSuccessful.
Protected Methods
void displayIncrementalFetchArrow(MarkupOutput out, int pageNumber, String imageCss, String alt)
Renders the incremental fetch arrow in DHTML mode
AnchorTag generateAnchor(WebEvent event)
Overwrites the parent method by setting special attributes if the event is not provided
WebEvent getEvent(WebObjectInfo object, int objectType)
Get events based on the WebObjectInfo (to initialize) or only for the requested object type (not initialized)
WebEvent getFolderNavigateEvent(WebObjectInfo folderObject)
Returns the web event to navigate a folder
WebEvent getFolderNavigateEvent()
Returns the web event to navigate a folder
WebEvent getGoToParentEvent(String parentFolderID)
Returns the event for navigating to the parent folder
WebEvent getIncrementalFetchEvent(int newPage)
Returns the event to do incremental fetch
WebEvent getSearchEvent()
Returns the web event to run a search
void renderAttributeObject(MarkupOutput out, WebObjectInfo objectInfo)
Renders each object that is of type EnumDSSXMLObjectTypes.DssXmlTypeAttribute as part of the contents of the project browser bean in DHTML mode
void renderAttributeObject(MarkupOutput out, WebObjectInfo objectInfo, String className)
Renders each object that is of type EnumDSSXMLObjectTypes.DssXmlTypeAttribute as part of the contents of the project browser bean in DHTML mode
void renderFolderObject(MarkupOutput out, WebObjectInfo objectInfo, boolean isFolderLink, String className)
Renders each folder as part of the contents of the project browser in DHTML mode
void renderFolderObject(MarkupOutput out, WebObjectInfo objectInfo, boolean isFolderLink)
Renders each folder as part of the contents of the project browser in DHTML mode
void renderSingleObject(MarkupOutput out, WebObjectInfo objectInfo, String className)
Renders each non-folder objects as part of the contents of the project browser bean in DHTML mode
void renderSingleObject(MarkupOutput out, WebObjectInfo objectInfo)
Renders each non-folder objects as part of the contents of the project browser bean in DHTML mode
[Expand]
Inherited Methods
From class com.microstrategy.web.app.transforms.AbstractObjectBrowserTabTransform
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.Transform

Constants

public static final int DISPLAY_LEVEL_CONTENTS_BODY_ALL

Value that can be used for the levelFlag for this transform to render all sections of the project browser (ancestors dropdown, search box, contents list, incremental fetch)

Constant Value: -1 (0xffffffff)

public static final int DISPLAY_LEVEL_CONTENTS_BODY_ANCESTORS

Value that can be used for the levelFlag for this transform to render the ancestors of the current folder as a select box

Constant Value: 2 (0x00000002)

public static final int DISPLAY_LEVEL_CONTENTS_BODY_INCREMENTAL_FETCH

Value that can be used for the levelFlag for this transform to render the incremental fetch for the project browser

Constant Value: 8 (0x00000008)

public static final int DISPLAY_LEVEL_CONTENTS_BODY_LIST

Value that can be used for the levelFlag for this transform to render the project browser contents list alone

Constant Value: 1 (0x00000001)

public static final int DISPLAY_LEVEL_CONTENTS_BODY_SEARCH

Value that can be used for the levelFlag for this transform to render the project browser search box.

Constant Value: 4 (0x00000004)

public static final String FP_CHECK_IMAGE

Name for the formal parameter: checkImage

Constant Value: "checkImage"

public static final String FP_FOLDER_JS

Name for the formal parameter: folderJS

Constant Value: "folderJS"

public static final String FP_FOLDER_UP_IMAGE

Name for the formal parameter: folderUpImage

Constant Value: "folderUpImage"

public static final String FP_FOLDER_UP_JS

Name for the formal parameter: folderUpJS

Constant Value: "folderUpJS"

public static final String FP_IMAGE_FIRST_PAGE

Name for the formal parameter: imgFirstPage

Constant Value: "imgFirstPage"

public static final String FP_IMAGE_FIRST_PAGE_DISABLED

Name for the formal parameter: imgFirstPageDisabled

Constant Value: "imgFirstPageDisabled"

public static final String FP_IMAGE_LAST_PAGE

Name for the formal parameter: imgLastPage

Constant Value: "imgLastPage"

public static final String FP_IMAGE_LAST_PAGE_DISABLED

Name for the formal parameter: imgLastPageDisabled

Constant Value: "imgLastPageDisabled"

public static final String FP_IMAGE_NEXT_PAGE

Name for the formal parameter: imgNextPage

Constant Value: "imgNextPage"

public static final String FP_IMAGE_NEXT_PAGE_DISABLED

Name for the formal parameter: imgNextPageDisabled

Constant Value: "imgNextPageDisabled"

public static final String FP_IMAGE_PREVIOUS_PAGE

Name for the formal parameter: imgPreviousPage

Constant Value: "imgPreviousPage"

public static final String FP_IMAGE_PREVIOUS_PAGE_DISABLED

Name for the formal parameter: imgPreviousPageDisabled

Constant Value: "imgPreviousPageDisabled"

public static final String FP_INCREMENTAL_FETCH_JS

Name for the formal parameter: incrementalFetchJS

Constant Value: "incrementalFetchJS"

public static final String FP_LEVEL_CHANGE_JS

Name for the formal parameter: levelChangeJS

Constant Value: "levelChangeJS"

public static final String FP_LEVEL_FLAG

Name for the formal parameter: levelFlag

Constant Value: "levelFlag"

public static final String FP_SEARCH_IMAGE

Name for the formal parameter: searchImage

Constant Value: "searchImage"

public static final String FP_SEARCH_JS

Name for the formal parameter: searchJS

Constant Value: "searchJS"

Fields

protected RWProjectBrowserTabBean _projectBrowserBean

The project browser bean

public FormalParameter checkImage

Formal parameter: The icon to use to submit the parent folders select box in HTML mode. Used only in HTML mode. For DHTML mode, the CSS contains the image

protected String cssBody

The className for the body of the project browser contents

protected String cssFileSearch

The className for the search text box

public FormalParameter folderJS

Formal parameter: The javascript function to execute when you click on a folder

public FormalParameter folderUpImage

Formal parameter: Indicates the image to use for allowing the user to navigate one folder up in the hierarchy. Used only in HTML mode. For DHTML mode, the CSS contains the image

public FormalParameter folderUpJS

Formal parameter: The javascript function to execute when you click on the image that takes you up a level in the folder structure.

public FormalParameter imgFirstPage

Formal parameter: The image to use for the first page of the incremental fetch when active. Used only in HTML mode. For DHTML mode, the CSS contains the image

public FormalParameter imgFirstPageDisabled

Formal parameter: The image to use for the first page of the incremental fetch when inactive. Used only in HTML mode. For DHTML mode, the CSS contains the image

public FormalParameter imgLastPage

Formal parameter: The image to use for the last page of the incremental fetch when active. Used only in HTML mode. For DHTML mode, the CSS contains the image

public FormalParameter imgLastPageDisabled

Formal parameter: The image to use for the last page of the incremental fetch when inactive. Used only in HTML mode. For DHTML mode, the CSS contains the image

public FormalParameter imgNextPage

Formal parameter: The image to use for the next page of the incremental fetch when active. Used only in HTML mode. For DHTML mode, the CSS contains the image

public FormalParameter imgNextPageDisabled

Formal parameter: The image to use for the next page of the incremental fetch when inactive. Used only in HTML mode. For DHTML mode, the CSS contains the image

public FormalParameter imgPreviousPage

Formal parameter: The image to use for the previous page of the incremental fetch. Used only in HTML mode. For DHTML mode, the CSS contains the image

public FormalParameter imgPreviousPageDisabled

Formal parameter: The image to use for the previous page of the incremental fetch when inactive. Used only in HTML mode. For DHTML mode, the CSS contains the image

public FormalParameter incrementalFetchJS

Formal parameter: The javascript function to execute when you click on the incremental fetch links

public FormalParameter levelChangeJS

Formal parameter: The javascript function to execute when you change the folder level

public FormalParameter levelFlag

This level flag can be used to control the components that will be rendered by the project browser bean. The default value of the level flag is DISPLAY_LEVEL_CONTENTS_BODY_ALL. Any combination of the following values can also be used.
DISPLAY_LEVEL_CONTENTS_BODY_ANCESTORS,
DISPLAY_LEVEL_CONTENTS_BODY_LIST,
DISPLAY_LEVEL_CONTENTS_BODY_SEARCH,
DISPLAY_LEVEL_CONTENTS_BODY_INCREMENTAL_FETCH

public FormalParameter searchImage

Formal parameter: Indicates the image to use for allowing the user to run a search. Used only in HTML mode. For DHTML mode, the CSS contains the image

public FormalParameter searchJS

Formal parameter: The javascript function to execute when you click on the search image button

Public Constructors

public ObjectBrowserTabProjectBrowserTransform ()

Default constructor for the transform. Adds all the formal parameters to the transform

Public Methods

public String getDescription ()

Returns the textual description of the transform

Returns
  • the description of the transform

public Class getSupportedBeanType ()

Returns the supported bean type. This transform supports RWProjectBrowserTabBean instances

Returns
  • the class of the bean supported by this transform.

public void initializeCss ()

Initializes the Css Classes to use. For each one of the css classes to use, the prefix indicated on the formal parameter is added to the name of the class to use.

public void initializeImages ()

Initializes the name of the images to use on this transform's output. For each one of the images defined to be displayed, the resource folder information is added to its path and file name as specified on the formal parameters for the images.

public void initializeTransform (Transformable data)

Initializes transform formal parameters

Parameters
data Transformable instance that will be transformed by this class.

public boolean isTransformEnabled ()

Indicates if the transform can be performed for the current state of the bean. Overwrites the parent method by testing for DHTML environment and if the content is of CONTENTS_TYPE_WEBFOLDER type

Returns
  • true if the tansform can render the bean.

public void renderAncestorInformation (MarkupOutput out)

Renders the ancestors of the current folder in the form of a 'SELECT' box Used in DHTML mode only.

Parameters
out MarkupOutput

public void renderContentsBodyDHTML (MarkupOutput out)

Renders the body of the contents of the project browser in DHTML mode. Called from renderEditorContents(MarkupOutput)

Parameters
out MarkupOutput

public void renderContentsBodyHTML (MarkupOutput out)

Renders the body of the contents of the project browser in HTML mode. Called from renderEditorContents(MarkupOutput)

Parameters
out MarkupOutput

public void renderContextMenu (MarkupOutput out)

This method is for rendering the context menus. By default there are no context menus The context menus for the report object browser are rendered in ReportAllObjectsTransform

Parameters
out MarkupOutput

public void renderEditorContents (MarkupOutput out)

Renders the contents of the project browser.

Parameters
out MarkupOutput instance where the editor contents are written to

public void renderGlobalEventsInformation (MarkupOutput out)

Render extra event information, for events that some one else might trigger

Parameters
out MarkupOutput

public void renderIncrementalFetch (MarkupOutput out)

Renders the incremental fetch section in DHTML mode

Parameters
out MarkupOutput

public void renderObjectCount (MarkupOutput out)

This method render the section that displays the number of objects found. Used for the report - all objects tab of the object browser

Parameters
out MarkupOutput

public void renderObjectList (MarkupOutput out)

Renders the list of objects for the current folder/search results whose contents is being displayed in DHTML mode. Also renders all the folderLinks that has been configured using the objBrowserFolderLinks.xml file

Parameters
out MarkupOutput

public void renderSearchSection (MarkupOutput out)

Renders the search section of the project browser in DHTML mode

Parameters
out MarkupOutput

public void renderTreeTable (MarkupOutput out)

Renders the contents of the current folder/search results of the project browser bean in DHTML mode. Calls renderObjectList(MarkupOutput)

Parameters
out MarkupOutput

public void transformForRequestSuccessful (MarkupOutput out)

Transforms the assosciated TabBean when its status is WebBeanRequestSuccessful. Calls renderTabFrame()

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

Protected Methods

protected void displayIncrementalFetchArrow (MarkupOutput out, int pageNumber, String imageCss, String alt)

Renders the incremental fetch arrow in DHTML mode

Parameters
out MarkupOutput
pageNumber Integer
imageCss String
alt String Tooltip for the image

protected AnchorTag generateAnchor (WebEvent event)

Overwrites the parent method by setting special attributes if the event is not provided

Parameters
event WebEvent
Returns
  • AnchorTag

protected WebEvent getEvent (WebObjectInfo object, int objectType)

Get events based on the WebObjectInfo (to initialize) or only for the requested object type (not initialized)

Parameters
object WebObjectInfo
objectType Integer
Returns

protected WebEvent getFolderNavigateEvent (WebObjectInfo folderObject)

Returns the web event to navigate a folder

Parameters
folderObject WebObjectInfo
Returns

protected WebEvent getFolderNavigateEvent ()

Returns the web event to navigate a folder

Returns

protected WebEvent getGoToParentEvent (String parentFolderID)

Returns the event for navigating to the parent folder

Parameters
parentFolderID identifier of the folder where to go to
Returns
  • WebEvent instance initialized for requesting the navigation to the parent of the current folder.

protected WebEvent getIncrementalFetchEvent (int newPage)

Returns the event to do incremental fetch

Parameters
newPage index number of the page where to go to
Returns
  • WebEvent instance intitialized with the information for requesting a page navigation

protected WebEvent getSearchEvent ()

Returns the web event to run a search

Returns

protected void renderAttributeObject (MarkupOutput out, WebObjectInfo objectInfo)

Renders each object that is of type EnumDSSXMLObjectTypes.DssXmlTypeAttribute as part of the contents of the project browser bean in DHTML mode

Parameters
out MarkupOutput
objectInfo WebObjectInfo

protected void renderAttributeObject (MarkupOutput out, WebObjectInfo objectInfo, String className)

Renders each object that is of type EnumDSSXMLObjectTypes.DssXmlTypeAttribute as part of the contents of the project browser bean in DHTML mode

Parameters
out MarkupOutput
objectInfo WebObjectInfo
className String

protected void renderFolderObject (MarkupOutput out, WebObjectInfo objectInfo, boolean isFolderLink, String className)

Renders each folder as part of the contents of the project browser in DHTML mode

Parameters
out MarkupOutput
objectInfo WebObjectInfo
isFolderLink Boolean Whether the folder is a folderLink or not
className String

protected void renderFolderObject (MarkupOutput out, WebObjectInfo objectInfo, boolean isFolderLink)

Renders each folder as part of the contents of the project browser in DHTML mode

Parameters
out MarkupOutput
objectInfo WebObjectInfo
isFolderLink Boolean Whether the folder is a folderLink or not

protected void renderSingleObject (MarkupOutput out, WebObjectInfo objectInfo, String className)

Renders each non-folder objects as part of the contents of the project browser bean in DHTML mode

Parameters
out MarkupOutput
objectInfo WebObjectInfo
className String

protected void renderSingleObject (MarkupOutput out, WebObjectInfo objectInfo)

Renders each non-folder objects as part of the contents of the project browser bean in DHTML mode

Parameters
out MarkupOutput
objectInfo WebObjectInfo