public class

ObjectBrowserTabOMDTransform

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.ObjectBrowserTabOMDTransform

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

Class Overview

This Transform renders the object browser for the Objects Manipulations Dialog.

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_NEW_FOLDER_BUTTON Value that can be used for the levelFlag for this transform to render the new folder button on the ancesstors pane.
int DISPLAY_LEVEL_CONTENTS_BODY_SEARCH Value that can be used for the levelFlag for this transform to render the project browser search box.
int DISPLAY_LEVEL_CONTENTS_BODY_UP_BUTTON Value that can be used for the levelFlag for this transform to render the up button on the ancesstors pane.
String FP_CREATE_FORM
String FP_FOLDER_JS
String FP_IMAGE_FIRST_PAGE
String FP_IMAGE_FIRST_PAGE_DISABLED
String FP_IMAGE_LAST_PAGE
String FP_IMAGE_LAST_PAGE_DISABLED
String FP_IMAGE_NEXT_PAGE
String FP_IMAGE_NEXT_PAGE_DISABLED
String FP_IMAGE_PREVIOUS_PAGE
String FP_IMAGE_PREVIOUS_PAGE_DISABLED
String FP_INCREMENTAL_FETCH_JS
String FP_LEVEL_CHANGE_JS
String FP_LEVEL_FLAG
[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
public FormalParameter createForm
protected String cssBody
protected String cssFileSearch
protected String cssShortcut
protected String cssTreeTable
public FormalParameter folderJS
public FormalParameter imgFirstPage
public FormalParameter imgFirstPageDisabled
public FormalParameter imgLastPage
public FormalParameter imgLastPageDisabled
public FormalParameter imgNextPage
public FormalParameter imgNextPageDisabled
public FormalParameter imgPreviousPage
public FormalParameter imgPreviousPageDisabled
public FormalParameter incrementalFetchJS
public FormalParameter levelChangeJS
public FormalParameter levelFlag This level flag can be used to control the components that will be rendered by the project browser bean.
protected String scriptClassFolderList
protected String scriptClassShortcut
protected String scriptClassTreeTable
protected String styFolderList
protected String styShortcut
protected String styTreeTable
protected String tyFolderList
protected String tyShortcut
protected String tyTreeTable
[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
ObjectBrowserTabOMDTransform()
Public Methods
String getDescription()
Returns the textual description of the transform
WebEvent getOpenCreateFolderEvent()
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 renderAncestorButtons(MarkupOutput out)
void renderAncestorInformation(MarkupOutput out)
void renderAncestorList(MarkupOutput out)
void renderContentsBodyDHTML(MarkupOutput out)
void renderContentsBodyHTML(MarkupOutput out)
void renderContextMenu(MarkupOutput out)
This method is for rendering the context menus.
void renderCreateFolderButton(MarkupOutput out)
void renderEditorContents(MarkupOutput out)
Generates the graphical output for the Editor
void renderFolderUpButton(MarkupOutput out)
void renderGlobalEventsInformation(MarkupOutput out)
void renderIncrementalFetch(MarkupOutput out)
void renderObjectCount(MarkupOutput out)
This method render the section that displays the number of objects found.
void renderObjectList(MarkupOutput out)
void renderTreeTable(MarkupOutput out)
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)
AnchorTag generateAnchor(WebEvent event)
Creates an <a> tag from the EventManager.
String getCssName(WebObjectInfo object)
WebEvent getEvent(WebObjectInfo object, int objectType)
WebEvent getFolderNavigateEvent()
WebEvent getFolderNavigateEvent(WebObjectInfo folderObject)
WebEvent getGoToParentEvent(String parentFolderID)
WebEvent getIncrementalFetchEvent(int newPage)
String getObjectName(WebObjectInfo ob)
WebEvent getSearchEvent()
void renderFolderObject(MarkupOutput out, WebObjectInfo object, boolean isFolderLink)
void renderSingleObject(MarkupOutput out, WebObjectInfo object)
[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_NEW_FOLDER_BUTTON

Value that can be used for the levelFlag for this transform to render the new folder button on the ancesstors pane.

Constant Value: 32 (0x00000020)

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 int DISPLAY_LEVEL_CONTENTS_BODY_UP_BUTTON

Value that can be used for the levelFlag for this transform to render the up button on the ancesstors pane.

Constant Value: 16 (0x00000010)

public static final String FP_CREATE_FORM

Constant Value: "createForm"

public static final String FP_FOLDER_JS

Constant Value: "folderJS"

public static final String FP_IMAGE_FIRST_PAGE

Constant Value: "imgFirstPage"

public static final String FP_IMAGE_FIRST_PAGE_DISABLED

Constant Value: "imgFirstPageDisabled"

public static final String FP_IMAGE_LAST_PAGE

Constant Value: "imgLastPage"

public static final String FP_IMAGE_LAST_PAGE_DISABLED

Constant Value: "imgLastPageDisabled"

public static final String FP_IMAGE_NEXT_PAGE

Constant Value: "imgNextPage"

public static final String FP_IMAGE_NEXT_PAGE_DISABLED

Constant Value: "imgNextPageDisabled"

public static final String FP_IMAGE_PREVIOUS_PAGE

Constant Value: "imgPreviousPage"

public static final String FP_IMAGE_PREVIOUS_PAGE_DISABLED

Constant Value: "imgPreviousPageDisabled"

public static final String FP_INCREMENTAL_FETCH_JS

Constant Value: "incrementalFetchJS"

public static final String FP_LEVEL_CHANGE_JS

Constant Value: "levelChangeJS"

public static final String FP_LEVEL_FLAG

Constant Value: "levelFlag"

Fields

protected RWProjectBrowserTabBean _projectBrowserBean

public FormalParameter createForm

protected String cssBody

protected String cssFileSearch

protected String cssShortcut

protected String cssTreeTable

public FormalParameter folderJS

public FormalParameter imgFirstPage

public FormalParameter imgFirstPageDisabled

public FormalParameter imgLastPage

public FormalParameter imgLastPageDisabled

public FormalParameter imgNextPage

public FormalParameter imgNextPageDisabled

public FormalParameter imgPreviousPage

public FormalParameter imgPreviousPageDisabled

public FormalParameter incrementalFetchJS

public FormalParameter levelChangeJS

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

protected String scriptClassFolderList

protected String scriptClassShortcut

protected String scriptClassTreeTable

protected String styFolderList

protected String styShortcut

protected String styTreeTable

protected String tyFolderList

protected String tyShortcut

protected String tyTreeTable

Public Constructors

public ObjectBrowserTabOMDTransform ()

Public Methods

public String getDescription ()

Returns the textual description of the transform

Returns
  • the description of the transform

public WebEvent getOpenCreateFolderEvent ()

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. If there's a case where the bean might be ready but the information it gets does not match what the transform expects, the rendering process might be stopped here. The outcome will be the component not being rendered at all (which can be logged as a warning for future investigation).

Returns
  • True if it's possible to use the transform for rendering the bean. Otherwise, returns False

public void renderAncestorButtons (MarkupOutput out)

Throws
UnmodifiableException

public void renderAncestorInformation (MarkupOutput out)

public void renderAncestorList (MarkupOutput out)

Throws
IndexOutOfBoundsException
UnmodifiableException
UnsupportedOperationException

public void renderContentsBodyDHTML (MarkupOutput out)

public void renderContentsBodyHTML (MarkupOutput out)

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

Throws
UnmodifiableException

public void renderEditorContents (MarkupOutput out)

Generates the graphical output for the Editor

Parameters
out MarkupOutput instance where to create the HTML output

public void renderFolderUpButton (MarkupOutput out)

Throws
IndexOutOfBoundsException
UnmodifiableException
UnsupportedOperationException

public void renderGlobalEventsInformation (MarkupOutput out)

public void renderIncrementalFetch (MarkupOutput out)

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)

public void renderTreeTable (MarkupOutput out)

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)

protected AnchorTag generateAnchor (WebEvent event)

Creates an <a> tag from the EventManager.

Parameters
event the WebEvent to generate the link with the request
Returns
  • AnchorTag instance initialized with the information from the event

protected String getCssName (WebObjectInfo object)

protected WebEvent getEvent (WebObjectInfo object, int objectType)

protected WebEvent getFolderNavigateEvent ()

protected WebEvent getFolderNavigateEvent (WebObjectInfo folderObject)

protected WebEvent getGoToParentEvent (String parentFolderID)

protected WebEvent getIncrementalFetchEvent (int newPage)

protected String getObjectName (WebObjectInfo ob)

protected WebEvent getSearchEvent ()

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

protected void renderSingleObject (MarkupOutput out, WebObjectInfo object)