public class

ObjectPathXHTMLTransform

extends ObjectPathTransform
java.lang.Object
   ↳ com.microstrategy.web.transform.AbstractTransform
     ↳ com.microstrategy.web.transform.AbstractLayoutTransform
       ↳ com.microstrategy.web.app.transforms.AbstractAppTransform
         ↳ com.microstrategy.web.app.transforms.ObjectPathTransform
           ↳ com.microstrategy.web.app.transforms.ObjectPathXHTMLTransform
Known Direct Subclasses

This class is deprecated.
use PathTransform instead

Class Overview

ObjectPathXHTMLTransform extends ObjectPathTransform by adding a couple of new buttons: go one folder up, and create folder.

Summary

Constants
int LEVEL_HOME_BUTTON This constant is deprecated. please use the layout xml
int LEVEL_NEW_FOLDER_BUTTON This constant is deprecated. please use the layout xml
int LEVEL_PARENT_UP_BUTTON This constant is deprecated. please use the layout xml
[Expand]
Inherited Constants
From class com.microstrategy.web.app.transforms.ObjectPathTransform
From class com.microstrategy.web.app.transforms.AbstractAppTransform
[Expand]
Inherited Fields
From class com.microstrategy.web.app.transforms.ObjectPathTransform
From class com.microstrategy.web.app.transforms.AbstractAppTransform
Public Constructors
ObjectPathXHTMLTransform()
Default constructor, initialize formal parameters.
Public Methods
List getObjectPathFolderAncestors(int rootIndex)
Returns all the ancestors of the current object
String getStyleShellDiv()
Overwrites the parent method by changin the default style's display to be "inline".
void initializeTransform(Transformable data)
Transform the Folder Bean and append the output to MarkupOutput
boolean isSpecialFolder()
Checks if the current object is a special folder
void renderAncestor(MarkupOutput out, WebFolder folder)
Renders the WebFolder object name w/o the hyperlink to that folder
void renderAncestors(MarkupOutput out)
This method is deprecated. please use the layout xml or renderAncestors(MarkupOutput out, int rootIndex);
void renderAncestors(MarkupOutput out, int rootIndex)
Renders the folder ancestors as path
void renderContent(MarkupOutput out)
Transform when the status is "Successful".
void renderCreateFolderButton(MarkupOutput out)
void renderHomeButton(MarkupOutput out)
Renders a button link to Home, it uses the openHomeEvent for this.
void renderParentFolderDelimiter(MarkupOutput out)
Renders the delimiter between the folder names The divider character is set through Formal Parameter
void renderParentUpButton(MarkupOutput out)
Renders a button link to the parent folders.
Protected Methods
AnchorTag generateAnchor(WebEvent event)
Overwrites the parent method by setting the right event element value according to the formal parameters available on the transform
OMDCreateFolderBean getCreateFolderBean()
String getImageSrc(String imgId)
Get the image source to display as part of the object path content.
WebEvent getOpenCreateFolderEvent()
void renderSimpleButton(MarkupOutput out, WebEvent event, String descriptor, String id, String src)
void renderSimpleLink(MarkupOutput out, WebEvent event, String descriptor, String css, boolean showLink)
Renders a link based on the event.
[Expand]
Inherited Methods
From class com.microstrategy.web.app.transforms.ObjectPathTransform
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 int LEVEL_HOME_BUTTON

This constant is deprecated.
please use the layout xml

Allowed value for the levelFlag formal parameter. Determines if a home button will be displayed on the left side of the path information. Value = 1024

Constant Value: 1024 (0x00000400)

public static final int LEVEL_NEW_FOLDER_BUTTON

This constant is deprecated.
please use the layout xml

Allowed value for the levelFlag formal parameter. Determines if a parent up button will be displayed on the left side of the path information. Value = 512

Constant Value: 512 (0x00000200)

public static final int LEVEL_PARENT_UP_BUTTON

This constant is deprecated.
please use the layout xml

Allowed value for the levelFlag formal parameter. Determines if a parent up button will be displayed on the left side of the path information. Value = 256

Constant Value: 256 (0x00000100)

Public Constructors

public ObjectPathXHTMLTransform ()

Default constructor, initialize formal parameters.

Public Methods

public List getObjectPathFolderAncestors (int rootIndex)

Returns all the ancestors of the current object

Parameters
rootIndex , indicates the starting index of the ancestor
Returns
  • a list of ancestors, the order is top down, the first ancestor (index 0) is the the highest ancestor (i.e, server, project)

public String getStyleShellDiv ()

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

public void initializeTransform (Transformable data)

Transform the Folder Bean and append the output to MarkupOutput

Parameters
data the folder bean to transform

public boolean isSpecialFolder ()

Checks if the current object is a special folder

Returns
  • boolean indicating whether it is a sepcial folder.
Throws
WebBeanException
WebBeanException

public void renderAncestor (MarkupOutput out, WebFolder folder)

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

Parameters
folder , the folder to be rendered

public void renderAncestors (MarkupOutput out)

This method is deprecated.
please use the layout xml or renderAncestors(MarkupOutput out, int rootIndex);

Renders the list of ancestors.

Parameters
out the transform's output

public void renderAncestors (MarkupOutput out, int rootIndex)

Renders the folder ancestors as path

Parameters
rootIndex , indicates the starting index of the ancestors For example, desktop link is the highest ancestor with index of 0; by specifying rootIndex=1, the desktop link won't be rendered

public void renderContent (MarkupOutput out)

Transform when the status is "Successful". It displays the path of the folder with a link to each one of its ancestors, i.e.:
Home > VMall Shared Reports

Parameters
out a MarkupOutput instance with the HTML output by this transform

public void renderCreateFolderButton (MarkupOutput out)

public void renderHomeButton (MarkupOutput out)

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

Parameters
out the transform's output

public void renderParentFolderDelimiter (MarkupOutput out)

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

public void renderParentUpButton (MarkupOutput out)

Renders a button link to the parent folders.

Parameters
out the transform's output

Protected Methods

protected AnchorTag generateAnchor (WebEvent event)

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

Parameters
event WebEvent instance from where the anchor will be constructed
Returns
  • AnchorTag initialized instance with the information as provided by the arguments.

protected OMDCreateFolderBean getCreateFolderBean ()

protected String getImageSrc (String imgId)

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.

Parameters
imgId String indicating the ID of the image from where the source should be calculated. For example, values like tbHome or tbReturn are expected
Returns
  • String with the source to use for the image to display.

protected WebEvent getOpenCreateFolderEvent ()

protected void renderSimpleButton (MarkupOutput out, WebEvent event, String descriptor, String id, String src)

protected void renderSimpleLink (MarkupOutput out, WebEvent event, String descriptor, String css, boolean showLink)

Renders a link based on the event.

Parameters
out the transform's output
event the event associated witht he link
descriptor the content of the link
css the class to use
showLink whether to render to link or not (if false, the descriptor will be simply rendered within a SPAN tag).