ObjectPathTransform

Constant specifying the name of the formal parameter for defining the dividing characters in between objects in the path. Value is dividerCharacters.

Constant specifying the name of the formal parameter for defining the characters to use instead of the names of folders that are hidden for the user. Value is hiddenFolderCharacters.

Constant specifying the name of the formal parameter for defining the extra attributes to be added to the anchor to generate. Value is extraItemNameHREFAnchorInfo.

Constant specifying the name of the formal parameter for defining if the object is self contained or not. Value is isSelfContained.

Constant specifying the name of the formal parameter for defining the level flag. Value is levelFlag.

Constant specifying the name of the formal parameter for defining the image to render before the current object is displayed. Value is openFolderImage.

Constant specifying the name of the formal parameter for defining the showLink. Value is showLink .

Allowed value for the levelFlag formal parameter. Convenience flag for selecting all the possible level flag values defined on this class.
Value = -1

Allowed value for the levelFlag formal parameter. Determines if ancestors folder path gets displayed. Value = 128

Allowed value for the levelFlag formal parameter. Specifies that the transform will show a link for the project's Desktop page as part of the path.
Value = 8

Allowed value for the levelFlag formal parameter. Specifies that the transform will render as part of the path, a link for Home application page.
Value = 4

Allowed value for the levelFlag formal parameter. Specifies that the transform will render the current item inside a link.
Value = 16

Allowed value for the levelFlag formal parameter. Specifies that the transform will display a new line character before the last item on the path. One of its main uses is in the Yahoo Path view where, for example, on the Folder page the path is shown in one line, and it places the current folder name (last element) on a separate line.
Value = 1

Allowed value for the levelFlag formal parameter. Determines if each one of the items rendered by the transform as part of the path will be inside links. Value = 64

Allowed value for the levelFlag formal parameter. Specifies that the transform will display an image before the object name which represents the current one being viewed, as defined on the openFolderImage formal parameter.
Value = 2

Allowed value for the levelFlag formal parameter. Specifies that the transform will render a Title ("You are here: " label) before displaying the path.
Value = 32

Indicates the character(s) to be used for separating each one of the different elements when displaying the path.
These characters will be displayed after each element except the last one, for indicating a hierarchy between the folders shown.
Usage: Default value is >. The value to assign to this formal parameter has to be HTML compatible for it to be displayed correctly on the final HTML page.

Indicates any extra information that will be rendered as attributes of the Anchor tag.
Any valid anchor tag attributes and their values might be specified here. This formal parameter is mainly for associating javascript method calls (in which case previous validation is done to confirm the page is being rendered in DHTML mode).

Indicates the character(s) to be used as placeholders when displaying a hidden folder inside the path.
These characters will be displayed instead of the hidden folder name without link associated with it since the user does not have enough privileges for accessing it. If there are two or more hidden folders one after the other, these characters will be displayed only once. Usage: Default value is [ ...]. The value to assign to this formal parameter has to be HTML compatible for it to be displayed correctly on the final HTML page.

Indicates if the current object being transformed should be used when generating the events that will be used for creating the links for accessing other folders.
Default value is boolean TRUE which indicates this object will be the source for the links to render.

Indicates the level of information to use when displaying each item.
The information may be displayed as links. The value to assign to this formal parameter should be a bitwise flag combining constants such as LEVEL_ITEM_LINK, LEVEL_TITLE, etc. For a complete list, refer to ObjectPathTransform.
Usage: If only the title and the current object shall be displayed, the flag value to assign to the formal parameter would be 80 (16 + 64). Default value is LEVEL_ALL

Indicates the image to use before displaying the current object on the path (if requested on the levelFlag formal parameter).
The value to indicate should be a valid image file name, with any necessary path information not included already on the resourcesFolderImage application configuration parameter.

Indicates whether the object path contains a hyperlink to that object
Default value is boolean TRUE which indicates the hyperlinks will be generated for each object path.

Default constructor, initialize formal parameters.

Retrieves the ObjectBean's parent FolderBean. This is the Bean from where we need to get the ancestors from.

Return description for this Transform

Retrieves the ObjectBean's parent FolderBean. This is the Bean from where we need to get the ancestors from.

Returns the supported bean type. This abstract Transform supports all WebComponents so every sub-class should override this method to return the class of the Bean the Transform is expecting, for example:

 public class CustomReportClass extends AbstractAppTransform {

    public Class getSupportedBeanType() {
        //This Transform is expected to work only with a ReportBean,
        //therefore this method needs to return this class:
        return ReportBean.class;
    }

 }
 

Initialize the css class used by this transform.

Initialize images, basically it prefix them with the global folderName

Transform the Folder Bean and append the output to MarkupOutput

Renders the list of ancestors.

This is the main entry point of the Transform when no layout is specified. It displays the path of the folder with a link to each one of its ancestors, i.e.:
Home > VMall > Shared Reports

Renders the curent item

Renders the link the Desktop (start) page.

Renders the link to Home, it uses the openHomeEvent for this.

Renders a new list before the item's name. This might be controlled through a formal parameter

Renders the open folder image.

Renders the title, uses descriptor 51: You are here:

Overwrites by ignoring the state and rendering as the status was succesful. ObjectBeans, even when their processing, should already have their path info.

Overwrites by ignoring the state and rendering as the status was succesful. ObjectBeans, even when their processing, should already have their path info.

Transform when the status is "Successful". If a Layout is specified, it delegates execution to the layout-pareser, otherwise, otherwise it calls renderContent.

Overwrites by ignoring the state and rendering as the status was succesful. ObjectBeans, even when their processing, should already have their path info.

check if the level parameter value contains this flag

Overwrites the parent method by setting the right event element value according to the formal parameters available on the transform

Returns the browser folder event.

Get the objectBean target of this transform

Returns the open desktop event.

Returns the open home event.

Check for special folders, if found one, return the descriptor. It also checks if the Shared Reports folder, using preferences, has been specified as other folder.

Returns the system folder ID (NamedFolder) that is in the hierarchy of the object bean

Render a specific folder. This is a recursive function that calls itself to render the parent.
It calls recursively until it finds the root folder. If the LEVEL_DESKTOP_LINK level is set, instead of stopping in the root folder, it stops in its first child.

Renders a link based on the event.