public class

FolderProjectBrowserTransform

extends FolderSmallIconTransform
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
Known Direct Subclasses
Known Indirect Subclasses

Class Overview

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

Summary

Constants
String FP_ALLOW_BROWSE_DIMENSION Name for the formal parameter: allowBrowseDimension
String FP_CHECK_IMAGE Name for the formal parameter: checkImage
String FP_CONTEXT_ID Name for the formal parameter: contextID
String FP_FOLDER_LINKS_LOCATION Name for the formal parameter: renderForm
String FP_HTML_GRAPHIC_MODE Name for the formal parameter: htmlGraphicMode
String FP_LEVEL_CHANGE_JS Name for the formal parameter: levelChangeJS
String FP_RENDER_FORM Name for the formal parameter: renderForm
String FP_RENDER_LINKS_ANCESTORS Name for the formal parameter: renderLinksAncestors
String FP_SEARCH_BOX_JS Name for the formal parameter: searchBoxJS
String FP_SEARCH_JS Name for the formal parameter: searchJS
String FP_UP_FOLDER_JS Name for the formal parameter: upFolderJS
String sSpaces
[Expand]
Inherited Constants
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
Fields
public FormalParameter allowBrowseDimension Indicates wheter to render the browser in gaphic mode even in html mode.
public FormalParameter checkImage Formal parameter: The icon to use to submit the parent folders select box in HTML mode.
public FormalParameter contextID Formal parameter: The context for the object browser fodler links
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 folderLinksLocation Indicates where the Object Browser Folder Links will be rendered 1 - Root 2 - All Folders 3 - Project
public FormalParameter htmlGraphicMode Indicates wheter to render the browser in gaphic mode even in html mode.
public FormalParameter levelChangeJS Formal parameter: The javascript function to execute when you change the folder level
public FormalParameter renderForm Indicates whether the transform will render it's own HTML form
public FormalParameter renderLinksAncestors Indicates whether the Ancestors of the Object Browser Folder Links will be rendered
public FormalParameter searchBoxJS Indicates the javascript function to execute when you key on the search box
public FormalParameter searchJS Indicates the javascript function to execute when you click on the search image button
public FormalParameter upFolderJS Formal parameter: The JavaScript code to execute when clicking on the up folder link to go to the parent folder
[Expand]
Inherited Fields
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
FolderProjectBrowserTransform()
Default Constructor.
Public Methods
String getDescription()
Return the description for this Transform
WebEvent getEvent(WebObjectInfo object)
Based on the object type on the WebObjectInfo sent as parameter, it creates and initializes the corresponding WebEvent for having the object opened or run.
int getFodlerLinksContextId()
This method is deprecated. please use getFolderLinksContextId() instead
ArrayList getFolderLinkList()
Returns a list containing the object browser folder links available for the current context.
int getFolderLinksContextId()
ArrayList getFolderObjects()
This method is deprecated. please use getNonFolderObjects() instead
Map getLinkAttributes(WebObjectInfo object)
this function is added to help generate layered icon in prompt project browser editor Get attribute for folder link in smallIconView
List getNonFolderObjects()
String getObjectName(WebObjectInfo object)
Utility method for obtaining the name of the object being analyzed
List getSubFolders()
ArrayList getSubfolders()
This method is deprecated. please use getSubFolders() instead
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)
This method initialize the private and protected fields of the transform.
boolean isNamedFolder(int folderName)
Returns true if the current folder corresponds to the system folder provided as a parameter
void renderAncestorsSelector(MarkupOutput out)
Renders a select box containing a list of the folder's ancestors
void renderBrowser(MarkupOutput out)
Renders the Project Browser based on the information provided by the fodler bean.
void renderBrowserContent(MarkupOutput out)
Renders the Project Browser's elements based on the information provided by the fodler bean.
void renderClearSearch(MarkupOutput out)
Renders a Link to clear search result and return to original content
void renderFolderContentHTML(MarkupOutput out, WebObjectInfo woi)
Renders a single non-folder content item from the current folder in HTML mode
void renderFolderContentsHTML(MarkupOutput out)
Renders the current folder's non-folder contents title when in HTML mode
void renderFolderContentsSubmitButtonHTML(MarkupOutput out)
Renders the submit button for the folde's non-folder contents section in HTML mode
void renderFolderContentsTitleHTML(MarkupOutput out)
Renders the current folder's non-folder contents title when in HTML mode
void renderFolderLink(MarkupOutput out, WebObjectInfo link)
Renders a single Object Browser Folder Link
void renderFolderLinkOptions(MarkupOutput out)
Renders a set of options for a select input containing the different object browser forlder links available for the current context.
void renderFolderLinks(MarkupOutput out)
renders the current's non-folder contensts as a list
void renderFolderObjects(MarkupOutput out)
renders the current's folder links as a list
void renderFoldersHTML(MarkupOutput out)
Renders the current folder's subfolders when in HTML mode
void renderFoldersSubmitButtonHTML(MarkupOutput out)
Renders the submit button for the folde's subfolders section in HTML mode
void renderFoldersTitleHTML(MarkupOutput out)
Renders the current folder's subfolders title when in HTML mode
void renderHiddenInputs(MarkupOutput out)
Renders the hidden inputs of the events that can be handled by the bean
void renderLayeredIconInfo(MarkupOutput out, WebObjectInfo object, boolean useLinkCss)
generate a SPAN tag which host background image and an inner SPAN for the layering effect in case an additional image has to be included on top of the original (for example, a shortcut arrow, a red error sign, etc).
void renderList(MarkupOutput out)
Renders the list of objects contained in the folder as a list with small icons.
void renderListHTML(MarkupOutput out)
Renders the current folder's content in HTML mode
void renderNameInfo(MarkupOutput out, WebObjectInfo object)
Write out name information for a single object.
void renderObjectName(MarkupOutput out, WebObjectInfo object)
Renders only the name of the object passed as a parameter
void renderOpenParentLink(MarkupOutput out)
Renders a link to the folder's parent
void renderSearchBox(MarkupOutput out)
Renders the search box for the project browser
void renderSearchButton(MarkupOutput out)
Renders a Magnifier image as the search/filter button of the browser
void renderSearchSection(MarkupOutput out)
Renders the search section of the project browser in DHTML mode
void renderSubfolders(MarkupOutput out)
renders the current's folder subfolders as a list
boolean shouldRenderFolderLinks()
Determines if the Object Browser Folder Links should be rendered.
void transformForRequestSuccessful(MarkupOutput out)
Transforms the assosciated WebBean when its status is WebBeanRequestSuccessful.
Protected Methods
AnchorTag generateAnchor(WebEvent event)
Creates an <a> tag from the EventManager.
WebEvent getBrowseEvent()
Returns a WebEvent instance containing the event to use when browsing the folder list displayed by the transform.
WebEvent getBrowseParentFolderEvent()
Returns a WebEvent instance containing the event to use when browsing the folder list displayed by the transform.
String getFolderContentsSelectNameHTML()
returns the name the select box for folder contentss in HTML will have
String getFolderLinkClasses(WebObjectInfo object)
Returns the cssClass name to use when rendering the object browser folder links
WebObjectInfo getFolderRoot()
Returns a (@link WebObjectInfo) as a reference to the folder being displayed by the transform.
Tag getForm(Tag content)
The method will check if the renderFOrm formal parameter is set to true, and if so it will create a new form tag, insert the contents passed as parameter and return the form.
ArrayList getHiddenInputsEventList()
Returns the list of events that will be included in the hidden inputs section.
String getJavascriptTyAttribute(WebObjectInfo object)
Return the Javascript TY attribute to use for the generation of the HTML tag related with this object.
String getProjectID()
Private method that gets the Project ID from the session manager
WebEvent getSearchEvent()
Returns a WebEvent instance containing the event to use when searching trhought the folder list displayed by the transform.
String getTooltipInfo(WebObjectInfo item)
Returns the tooltip to add to each individual item in the Folder's list.
String getTooltipTitle(WebObjectInfo item)
Returns the descriptor to use for rendering the itemss tooltips.
boolean isFolder(WebObjectInfo ob)
void setFolderRoot(WebObjectInfo oi)
void setUpFolderJS(AnchorTag anchor)
Sets the JavaScript code to execute when clicking on the up folder link to go to the parent folder.
[Expand]
Inherited Methods
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

Constants

public static final String FP_ALLOW_BROWSE_DIMENSION

Name for the formal parameter: allowBrowseDimension

Constant Value: "allowBrowseDimension"

public static final String FP_CHECK_IMAGE

Name for the formal parameter: checkImage

Constant Value: "checkImage"

public static final String FP_CONTEXT_ID

Name for the formal parameter: contextID

Constant Value: "contextID"

public static final String FP_FOLDER_LINKS_LOCATION

Name for the formal parameter: renderForm

Constant Value: "folderLinksLocation"

public static final String FP_HTML_GRAPHIC_MODE

Name for the formal parameter: htmlGraphicMode

Constant Value: "htmlGraphicMode"

public static final String FP_LEVEL_CHANGE_JS

Name for the formal parameter: levelChangeJS

Constant Value: "levelChangeJS"

public static final String FP_RENDER_FORM

Name for the formal parameter: renderForm

Constant Value: "renderForm"

public static final String FP_RENDER_LINKS_ANCESTORS

Name for the formal parameter: renderLinksAncestors

Constant Value: "renderLinksAncestors"

public static final String FP_SEARCH_BOX_JS

Name for the formal parameter: searchBoxJS

Constant Value: "searchBoxJS"

public static final String FP_SEARCH_JS

Name for the formal parameter: searchJS

Constant Value: "searchJS"

public static final String FP_UP_FOLDER_JS

Name for the formal parameter: upFolderJS

Constant Value: "upFolderJS"

protected static final String sSpaces

Constant Value: "                                    "

Fields

public FormalParameter allowBrowseDimension

Indicates wheter to render the browser in gaphic mode even in html mode.

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

public FormalParameter contextID

Formal parameter: The context for the object browser fodler links

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 folderLinksLocation

Indicates where the Object Browser Folder Links will be rendered 1 - Root 2 - All Folders 3 - Project

public FormalParameter htmlGraphicMode

Indicates wheter to render the browser in gaphic mode even in html mode.

public FormalParameter levelChangeJS

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

public FormalParameter renderForm

Indicates whether the transform will render it's own HTML form

public FormalParameter renderLinksAncestors

Indicates whether the Ancestors of the Object Browser Folder Links will be rendered

public FormalParameter searchBoxJS

Indicates the javascript function to execute when you key on the search box

public FormalParameter searchJS

Indicates the javascript function to execute when you click on the search image button

public FormalParameter upFolderJS

Formal parameter: The JavaScript code to execute when clicking on the up folder link to go to the parent folder

Public Constructors

public FolderProjectBrowserTransform ()

Default Constructor. Initializes the formal parameters contextID, levelChangeJS, searchJS and renderForm.

Public Methods

public String getDescription ()

Return the description for this Transform

Returns
  • String with the description for the transform.

public WebEvent getEvent (WebObjectInfo object)

Based on the object type on the WebObjectInfo sent as parameter, it creates and initializes the corresponding WebEvent for having the object opened or run.

Parameters
object a WebObjectInfo for which the "execution" event must be retrieved.
Returns

public int getFodlerLinksContextId ()

This method is deprecated.
please use getFolderLinksContextId() instead

Returns the context id (from EnumObjectBrowserContexts) to use

Returns
  • int

public ArrayList getFolderLinkList ()

Returns a list containing the object browser folder links available for the current context.

Returns
  • SimpleList

public int getFolderLinksContextId ()

public ArrayList getFolderObjects ()

This method is deprecated.
please use getNonFolderObjects() instead

Returns an arraylist with the non-folder contents of the current folder

Returns
  • ArrayList

public Map getLinkAttributes (WebObjectInfo object)

this function is added to help generate layered icon in prompt project browser editor Get attribute for folder link in smallIconView

Parameters
object - WebObjectInfo web object to get attribute from
Returns
  • Map

public List getNonFolderObjects ()

public String getObjectName (WebObjectInfo object)

Utility method for obtaining the name of the object being analyzed

Parameters
object WebObjectInfo instance to be processed.
Returns
  • value of the name property of the object. If handling a shortcut, it will obtain the property of the original target object and return this as result. By default the result will be encoded for its proper display on HTML.

public List getSubFolders ()

public ArrayList getSubfolders ()

This method is deprecated.
please use getSubFolders() instead

Returns an arraylist with the subfolders of the current folder

Returns
  • ArrayList

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)

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 boolean isNamedFolder (int folderName)

Returns true if the current folder corresponds to the system folder provided as a parameter

Parameters
folderName int
Returns
  • boolean

public void renderAncestorsSelector (MarkupOutput out)

Renders a select box containing a list of the folder's ancestors

Parameters
out MarkupOutput

public void renderBrowser (MarkupOutput out)

Renders the Project Browser based on the information provided by the fodler bean.

Parameters
out MarkupOutput
Throws
WebBeanException
WebObjectsException
WebBeanException

public void renderBrowserContent (MarkupOutput out)

Renders the Project Browser's elements based on the information provided by the fodler bean. This method is called by the renderBrowser method.

Parameters
out MarkupOutput
Throws
WebObjectsException
WebBeanException
WebObjectsException

public void renderClearSearch (MarkupOutput out)

Renders a Link to clear search result and return to original content

Parameters
out MarkupOutput

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

Renders the current folder's non-folder contents title when in HTML mode

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

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

Renders the current folder's non-folder contents title when in HTML mode

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

public void renderFolderLink (MarkupOutput out, WebObjectInfo link)

Renders a single Object Browser Folder Link

Parameters
out MarkupOutput
link WebObjectInfo

public void renderFolderLinkOptions (MarkupOutput out)

Renders a set of options for a select input containing the different object browser forlder links available for the current context.

Parameters
out MarkupOutput

public void renderFolderLinks (MarkupOutput out)

renders the current's non-folder contensts as a list

Parameters
out MarkupOutput

public void renderFolderObjects (MarkupOutput out)

renders the current's folder links as a list

Parameters
out MarkupOutput

public void renderFoldersHTML (MarkupOutput out)

Renders the current folder's subfolders when in HTML mode

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

public void renderFoldersSubmitButtonHTML (MarkupOutput out)

Renders the submit button for the folde's subfolders section in HTML mode

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

public void renderFoldersTitleHTML (MarkupOutput out)

Renders the current folder's subfolders title when in HTML mode

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

public void renderHiddenInputs (MarkupOutput out)

Renders the hidden inputs of the events that can be handled by the bean

Parameters
out MarkupOutput

public void renderLayeredIconInfo (MarkupOutput out, WebObjectInfo object, boolean useLinkCss)

generate a SPAN tag which host background image and an inner SPAN for the layering effect in case an additional image has to be included on top of the original (for example, a shortcut arrow, a red error sign, etc).

Parameters
out MarkupOutput instance where to save the contents to display
object WebObjectInfo to be rendered.
useLinkCss flag for a largeIconView or listView

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

Renders the current folder's content in HTML mode

Parameters
out MarkupOutput instance where the HTML output is to be saved.
Throws
WebObjectsException
WebBeanException
IndexOutOfBoundsException
UnmodifiableException
WebObjectsException

public void renderNameInfo (MarkupOutput out, WebObjectInfo object)

Write out name information for a single object. The string will be rendered as a link if the event according to the object type, provided by the getEvent(WebObjectInfo) method is available.

Parameters
out MarkupOutput instance where to save the contents to display
object WebObjectInfo to be rendered.

public void renderObjectName (MarkupOutput out, WebObjectInfo object)

Renders only the name of the object passed as a parameter

Parameters
out MarkupOutput instance where to save the contents to display
object WebObjectInfo

public void renderOpenParentLink (MarkupOutput out)

Renders a link to the folder's parent

Parameters
out MarkupOutput

public void renderSearchBox (MarkupOutput out)

Renders the search box for the project browser

Parameters
out MarkupOutput

public void renderSearchButton (MarkupOutput out)

Renders a Magnifier image as the search/filter button of the browser

Parameters
out MarkupOutput

public void renderSearchSection (MarkupOutput out)

Renders the search section of the project browser in DHTML mode

Parameters
out MarkupOutput

public void renderSubfolders (MarkupOutput out)

renders the current's folder subfolders as a list

Parameters
out MarkupOutput

public boolean shouldRenderFolderLinks ()

Determines if the Object Browser Folder Links should be rendered.

Returns
  • boolean

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 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 WebEvent getBrowseEvent ()

Returns a WebEvent instance containing the event to use when browsing the folder list displayed by the transform.

Returns
  • WebEvent

protected WebEvent getBrowseParentFolderEvent ()

Returns a WebEvent instance containing the event to use when browsing the folder list displayed by the transform.

Returns
  • WebEvent

protected String getFolderContentsSelectNameHTML ()

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

Returns
  • String

protected String getFolderLinkClasses (WebObjectInfo object)

Returns the cssClass name to use when rendering the object browser folder links

Parameters
object WebObjectInfo
Returns
  • String

protected WebObjectInfo getFolderRoot ()

Returns a (@link WebObjectInfo) as a reference to the folder being displayed by the transform.

Returns
  • WebObjectInfo

protected Tag getForm (Tag content)

The method will check if the renderFOrm formal parameter is set to true, and if so it will create a new form tag, insert the contents passed as parameter and return the form. If the formal parameter is set to false, the method return the same tag passed as parameter.

Parameters
content Tag
Returns
  • Tag

protected ArrayList getHiddenInputsEventList ()

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

Returns
  • ArrayList

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 String getProjectID ()

Private method that gets the Project ID from the session manager

Returns
  • String projectID

protected WebEvent getSearchEvent ()

Returns a WebEvent instance containing the event to use when searching trhought the folder list displayed by the transform.

Returns
  • WebEvent

protected String getTooltipInfo (WebObjectInfo item)

Returns the tooltip to add to each individual item in the Folder's list.

Parameters
item WebObjectInfo the folder's child. It includes the name and description of the item.
Returns
  • String the tooltip to add to the HTML output.

protected String getTooltipTitle (WebObjectInfo item)

Returns the descriptor to use for rendering the itemss tooltips.

Parameters
item WebObjectInfo
Returns
  • String

protected boolean isFolder (WebObjectInfo ob)

protected void setFolderRoot (WebObjectInfo oi)

protected void setUpFolderJS (AnchorTag anchor)

Sets the JavaScript code to execute when clicking on the up folder link to go to the parent folder.

Parameters
anchor The anchor tag on which we want to set the JavaScript.