PathTransform

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 if the object is self contained or not. Value is isSelfContained.

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 .

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 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 target bean of 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 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.

Return the WebFolder or the ancestor of the current object.
For instance: the folder that contains the current report.

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

Return description for this Transform

Whether the current object has ancestors

Returns all the ancestors of the current object

Returns all the ancestors of the current object

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

Overwrites the parent method by changin the default style's display to be "inline".

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

Checks if the current object is a special folder

Renders the WebFolder object name w/o the hyperlink to that folder

Renders the folder ancestors as path

Renders a Back button link, it uses the openHistoryPage event for this.

Renders the button to create a folder

Renders the curent item

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.

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 Forward button link, it uses the openHistoryPage event for this.

Renders a button link to Home, it uses the openDesktopEvent for this.

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 current objects name (i.e. report name)

Renders the open folder image.

Renders the parent folder

Renders the delimiter between the folder names The divider character is set through Formal Parameter

Renders a button link to the parent folders.

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

Sets whether the current object has ancestors

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.

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

Returns the open history page event used for the back button.

Returns the browser folder event.

Returns the open history page event used for the forward button.

Get the image source to display as part of the object path content. This method is called only when the user has turned on Accessibility mode under Preferences.

Get the objectBean target of this transform

Returns the open desktop event.

Returns the open home event.

Get the WebEvent and descption of parent folder.

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

Check whether the parent folder of current object is one of the templates folders.

Renders a link based on the event.

Renders a link based on the event.

Sets the necessary properties to the bone assigned to this transform (based on the scriptClass formal parameter)
Usually called by renderRegisterBone(MarkupOutput)
Can be overwritten to add or modify bone properties.