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

FilterObjectBrowserTransform, FolderAddDataSetTransform, FolderAdminBrowserTransform, FolderObjectBrowserTransform, FolderSaveAsBrowserTransform, ObjectSelectorProjectBrowserTransform

Known Indirect Subclasses

FolderOMDBrowserTransform

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

String	FP_CREATE_REPORT_DISPLAY_SECTION	Constant specifying the name of the formal parameter for defining which sections will be displayed in the Create Report page.
String	FP_DATAMART_IMAGE	Constant specifying the name of the formal parameter for defining the datamart image.
String	FP_DOCUMENT_IMAGE	Constant specifying the name of the formal parameter for defining the document image.
String	FP_EXEC_TARGET	Determines how the user want's to execute the Report/Document object.
String	FP_FILTER_IMAGE	Constant specifying the name of the formal parameter for defining the filter image.
String	FP_FOLDER_IMAGE	Constant specifying the name of the formal parameter for defining the folder image.
String	FP_GRAPH_IMAGE	Constant specifying the name of the formal parameter for defining the graph image.
String	FP_GRID_GRAPH_IMAGE	Constant specifying the name of the formal parameter for defining the gridGraph image.
String	FP_IMAGE_HEIGTH	Constant specifying the name of the formal parameter for defining the image height.
String	FP_IMAGE_WIDTH	Constant specifying the name of the formal parameter for defining the image width.
String	FP_LEVEL_FLAG	Constant specifying the name of the formal parameter for defining the level flag.
String	FP_MAX_OBJECT_TYPE_COUNT	Constant specifying the name of the formal parameter for defining the maximum object type count.
String	FP_REPORT_IMAGE	Constant specifying the name of the formal parameter for defining the report image.
String	FP_RW_DOCUMENT_IMAGE	Constant specifying the name of the formal parameter for defining the report writing document image.
String	FP_SORT_ASCENDING	Constant specifying the name of the formal parameter for defining the sort order of the folder contents.
String	FP_SORT_FIELD	Constant specifying the name of the formal parameter for defining the field from which the folder contents will be sorted.
String	FP_TABLE_ID	Constant specifying the name of the formal parameter for defining the table ID and NAME attributes of the HTML table to render.
String	FP_TEMPLATE_IMAGE	Constant specifying the name of the formal parameter for defining the template image.
int	LEVEL_ALL	Allowed value for the `levelFlag` formal parameter.
int	LEVEL_CONFIRM_DELETE	Allowed value for the `levelFlag` formal parameter.
int	LEVEL_DELETE	Allowed value for the `levelFlag` formal parameter.
int	LEVEL_DESCRIPTION	Allowed value for the `levelFlag` formal parameter.
int	LEVEL_DISPLAY_HEADERS	Allowed value for the `levelFlag` formal parameter.
int	LEVEL_EDIT	Allowed value for the `levelFlag` formal parameter.
int	LEVEL_EMPTY_FOLDER_MESSAGE	Allowed value for the `levelFlag` formal parameter.
int	LEVEL_EXPORT_EXCEL	Allowed value for the `levelFlag` formal parameter.
int	LEVEL_EXPORT_PDF	Allowed value for the `levelFlag` formal parameter.
int	LEVEL_FOLDER_INFORMATION	Allowed value for the `levelFlag` formal parameter.
int	LEVEL_INCREMENTAL_FETCH	Allowed value for the `levelFlag` formal parameter.
int	LEVEL_LOCATION	Allowed value for the `levelFlag` formal parameter.
int	LEVEL_MODIFIED	Allowed value for the {@link #leveimport com.microstrategy.web.objects.rw.; import com.microstrategy.web.tags.; import com.microstrategy.web.transform.*; er.
int	LEVEL_NAME	Allowed value for the `levelFlag` formal parameter.
int	LEVEL_OWNER	Allowed value for the `levelFlag` formal parameter.
int	LEVEL_SEND_NOW	Allowed value for the `levelFlag` formal parameter.
int	LEVEL_SUBSCRIPTION	Allowed value for the `levelFlag` formal parameter.

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

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

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.

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

The default event associated with the execution of this object. i.e.
For a DssXmlTypeReportDefinition, the REPORT_EVENT_EXECUTE event,
For a DssXmlTypeFolder, the FOLDER_EVENT_BROWSE event.
For a DssXmlTypeDocumentDefinition, the DOCUMENT_EVENT_EXECUTE_DOCUMENT event.
For a DssXmlTypeFilter, the WebEventSelectFilter event.
For a DssXmlTypeTemplate, the WebEventSelectTemplate event.
If these events cannot be created or there are not enough privileges for the user to "execute" the object, it will return null.

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.

Interfaces

Classes

FolderProjectBrowserTransform

Class Overview

Summary

Constants

public static final String FP_ALLOW_BROWSE_DIMENSION

public static final String FP_CHECK_IMAGE

public static final String FP_CONTEXT_ID

public static final String FP_FOLDER_LINKS_LOCATION

public static final String FP_HTML_GRAPHIC_MODE

public static final String FP_LEVEL_CHANGE_JS

public static final String FP_RENDER_FORM

public static final String FP_RENDER_LINKS_ANCESTORS

public static final String FP_SEARCH_BOX_JS

public static final String FP_SEARCH_JS

public static final String FP_UP_FOLDER_JS

protected static final String sSpaces

Fields

public FormalParameter allowBrowseDimension

public FormalParameter checkImage

public FormalParameter contextID

protected String cssBody

protected String cssFileSearch

public FormalParameter folderLinksLocation

public FormalParameter htmlGraphicMode

public FormalParameter levelChangeJS

public FormalParameter renderForm

public FormalParameter renderLinksAncestors

public FormalParameter searchBoxJS

public FormalParameter searchJS

public FormalParameter upFolderJS

Public Constructors

public FolderProjectBrowserTransform ()

Public Methods

public String getDescription ()

Returns

public WebEvent getEvent (WebObjectInfo object)

Parameters

Returns

public int getFodlerLinksContextId ()

Returns

public ArrayList getFolderLinkList ()

Returns

public int getFolderLinksContextId ()

public ArrayList getFolderObjects ()

Returns

public Map getLinkAttributes (WebObjectInfo object)

Parameters

Returns

public List getNonFolderObjects ()

public String getObjectName (WebObjectInfo object)

Parameters

Returns

public List getSubFolders ()

public ArrayList getSubfolders ()

Returns

public void initializeCss ()

public void initializeImages ()

public void initializeTransform (Transformable data)

Parameters

public boolean isNamedFolder (int folderName)

Parameters

Returns

public void renderAncestorsSelector (MarkupOutput out)

Parameters

public void renderBrowser (MarkupOutput out)

Parameters

Throws

public void renderBrowserContent (MarkupOutput out)

Parameters

Throws

public void renderClearSearch (MarkupOutput out)

Parameters

public void renderFolderContentHTML (MarkupOutput out, WebObjectInfo woi)

Parameters

public void renderFolderContentsHTML (MarkupOutput out)

Parameters

Throws

public void renderFolderContentsSubmitButtonHTML (MarkupOutput out)