public abstract class

AbstractAdminPathTransform

extends AbstractAppTransform
implements LayoutTransform
java.lang.Object
   ↳ com.microstrategy.web.transform.AbstractTransform
     ↳ com.microstrategy.web.transform.AbstractLayoutTransform
       ↳ com.microstrategy.web.app.transforms.AbstractAppTransform
         ↳ com.microstrategy.web.app.transforms.AbstractAdminPathTransform
Known Direct Subclasses

Summary

Constants
String FP_CHARS_FOR_DIVIDER Constant specifying the name of the formal parameter for defining the dividing characters in between objects in the path.
String FP_SHOW_LINK Constant specifying the name of the formal parameter for defining the showLink.
[Expand]
Inherited Constants
From class com.microstrategy.web.app.transforms.AbstractAppTransform
Fields
protected String _divideCharacters Protected property for holding the value selected on the dividerCharacters formal parameter
public FormalParameter dividerCharacters Indicates the character(s) to be used for separating each one of the different elements when displaying the path.
public FormalParameter showLink 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.
[Expand]
Inherited Fields
From class com.microstrategy.web.app.transforms.AbstractAppTransform
Public Constructors
AbstractAdminPathTransform()
Default constructor, initialize formal parameters.
Public Methods
String getDescription()
Return description for this Transform
void initializeTransform(Transformable data)
Transform the Folder Bean and append the output to MarkupOutput
void renderContent(MarkupOutput out)
This is the main entry point of the Transform when no layout is specified.
abstract void renderCurrentItem(MarkupOutput out)
void renderDelimiter(MarkupOutput out)
Renders the ">" delimiter between the ancestor items.
void renderGoHome(MarkupOutput out)
Renders a button with a link to Home.
void renderGoOneUp(MarkupOutput out)
Renders the Up One level button.
void renderGoServer(MarkupOutput out)
Renders a button with a link to go to the server page.
void transformForRequestInError(MarkupOutput out)
Overwrites by ignoring the state and rendering as the status was succesful.
void transformForRequestSuccessful(MarkupOutput out)
Transform when the status is "Successful".
void transformForRequestWaitingForUserInput(MarkupOutput out)
Overwrites by ignoring the state and rendering as the status was succesful.
Protected Methods
boolean canRenderHomeButtton()
boolean canRenderParentUpButton()
abstract WebEvent getGoParentPageEvent()
abstract String getGoParentPageTooltip()
WebEvent getGoServerPageEvent()
Provides an event to process the Go-to Server page process.
WebEvent getOpenDefaultDesktopEvent()
Returns an event to open the default desktop page.
void renderLink(MarkupOutput out, WebEvent event, String descriptor)
Renders a HTML anchor tag with the event and a descriptor
void renderSimpleButton(MarkupOutput out, WebEvent event, String descriptor, String id)
Renders a simple button as a link with an event and an id attached to it.
[Expand]
Inherited Methods
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_CHARS_FOR_DIVIDER

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

Constant Value: "dividerCharacters"

public static final String FP_SHOW_LINK

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

Constant Value: "showLink"

Fields

protected String _divideCharacters

Protected property for holding the value selected on the dividerCharacters formal parameter

public FormalParameter dividerCharacters

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.

public FormalParameter showLink

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.

Public Constructors

public AbstractAdminPathTransform ()

Default constructor, initialize formal parameters.

Public Methods

public String getDescription ()

Return description for this Transform

Returns
  • description for the transform

public void initializeTransform (Transformable data)

Transform the Folder Bean and append the output to MarkupOutput

Parameters
data the folder bean to transform

public void renderContent (MarkupOutput out)

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

Parameters
out MarkupOutput

public abstract void renderCurrentItem (MarkupOutput out)

public void renderDelimiter (MarkupOutput out)

Renders the ">" delimiter between the ancestor items.

Parameters
out MarkupOutput

public void renderGoHome (MarkupOutput out)

Renders a button with a link to Home.

Parameters
out MarkupOutput

public void renderGoOneUp (MarkupOutput out)

Renders the Up One level button.

Parameters
out Markupoutput

public void renderGoServer (MarkupOutput out)

Renders a button with a link to go to the server page.

Parameters
out MarkupOutput

public void transformForRequestInError (MarkupOutput out)

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

Parameters
out MarkupOutput instance that will be the output by this transform

public void transformForRequestSuccessful (MarkupOutput out)

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

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

public void transformForRequestWaitingForUserInput (MarkupOutput out)

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

Parameters
out MarkupOutput instance that will be the output by this transform

Protected Methods

protected boolean canRenderHomeButtton ()

protected boolean canRenderParentUpButton ()

protected abstract WebEvent getGoParentPageEvent ()

protected abstract String getGoParentPageTooltip ()

protected WebEvent getGoServerPageEvent ()

Provides an event to process the Go-to Server page process.

Returns
  • a WebEvent with all the information needed to process the event.

protected WebEvent getOpenDefaultDesktopEvent ()

Returns an event to open the default desktop page.

Returns
  • WebEvent for opening the "Default Desktop" page.

protected void renderLink (MarkupOutput out, WebEvent event, String descriptor)

Renders a HTML anchor tag with the event and a descriptor

Parameters
out MarkupOutput
event the WebEvent to be associated with the anchor tag.
descriptor The localized string which is added as a text to the anchor tag.

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

Renders a simple button as a link with an event and an id attached to it.

Parameters
out MarkupOutput
event the WebEvent to be associated with the button.
descriptor The localized string which is added as a text to the button.
id A unique id to the button.