public class

MojoPathTransform

extends PathTransform
java.lang.Object
   ↳ com.microstrategy.web.transform.AbstractTransform
     ↳ com.microstrategy.web.transform.AbstractLayoutTransform
       ↳ com.microstrategy.web.app.transforms.AbstractAppTransform
         ↳ com.microstrategy.web.app.transforms.PathTransform
           ↳ com.microstrategy.web.app.transforms.MojoPathTransform

Class Overview

Extended implementation for PathTransform used in Mojo pages. Output JSON

Summary

Constants
String FP_USE_ANCESTORS Constant specifying the name of the formal parameter for defining the useAncestors.
[Expand]
Inherited Constants
From class com.microstrategy.web.app.transforms.PathTransform
From class com.microstrategy.web.app.transforms.AbstractAppTransform
Fields
public FormalParameter useAncestors Indicates whether the path should use the ancestors.
[Expand]
Inherited Fields
From class com.microstrategy.web.app.transforms.PathTransform
From class com.microstrategy.web.app.transforms.AbstractAppTransform
Public Constructors
MojoPathTransform()
Default constructor, initialize formal parameters.
Public Methods
void renderShell(MarkupOutput out)

Generates the shell for this Transform.

void transformForRequestSuccessful(MarkupOutput out)
Renders the information needed to build the path bar.
Protected Methods
void addLinkForAncestors(BlockList pathBlockList)
Block getBackPickerButton()
Get back button blcok
Block getCurrentObject()
BlockList getExtraLinks()
Get extra links block list
Block getForwardPickerButton()
Get forward button block
Block getHelpLink()
Block getHomeButton()
Get home button block
Block getLinkForDesktop()
BlockList getNavigationButtons()
Get navigation buttons
BlockList getPath()
Get ancestors links block list
Block getSearchInfo()
Get search information block
BlockList getStarburstMenu()
Add starburst's menu list to path bar JSON
Block getUpButton()
Get parent up button Block
[Expand]
Inherited Methods
From class com.microstrategy.web.app.transforms.PathTransform
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_USE_ANCESTORS

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

Constant Value: "useAncestors"

Fields

public FormalParameter useAncestors

Indicates whether the path should use the ancestors. Default value is boolean TRUE which indicates the ancestors will be used in the path. This value should be false if it is the Default Home Page. (Currently MyPage). MicroStrategy 10.5

Public Constructors

public MojoPathTransform ()

Default constructor, initialize formal parameters.

Public Methods

public void renderShell (MarkupOutput out)

Generates the shell for this Transform.

The shell is a <div> tag that automatically surrounds the content generated by the Transform. It's used among other things by the javascript to identify the HTML associated with a bone, and by the iFrame update technology to identify a component in the page.

The attributes to append to this <div> are obtained from the getAttributesShellDiv method; the style from the getStyleShellDiv method.
This method calls renderCssLink and checkStatus to generate the Transform's content.

Parameters
out output by this transform

public void transformForRequestSuccessful (MarkupOutput out)

Renders the information needed to build the path bar.

Parameters
out the transform's output

Protected Methods

protected void addLinkForAncestors (BlockList pathBlockList)

Throws
Exception

protected Block getBackPickerButton ()

Get back button blcok

Returns
  • block of back button
Throws
Exception

protected Block getCurrentObject ()

Throws
Exception

protected BlockList getExtraLinks ()

Get extra links block list

Returns
  • block list of extra links
Throws
Exception

protected Block getForwardPickerButton ()

Get forward button block

Returns
  • block of forward button
Throws
Exception

protected Block getHelpLink ()

Throws
Exception

protected Block getHomeButton ()

Get home button block

Returns
  • a block of home button
Throws
Exception

protected Block getLinkForDesktop ()

Throws
Exception

protected BlockList getNavigationButtons ()

Get navigation buttons

Returns
  • a list of navigation buttons
Throws
Exception

protected BlockList getPath ()

Get ancestors links block list

Returns
  • BlockList of path links
Throws
Exception

protected Block getSearchInfo ()

Get search information block

Returns
  • block of search information
Throws
Exception

protected BlockList getStarburstMenu ()

Add starburst's menu list to path bar JSON

protected Block getUpButton ()

Get parent up button Block

Returns
  • block of up button
Throws
Exception