Package com.microstrategy.web.app.transforms

Class MojoPathTransform

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

All Implemented Interfaces:

AppTransform, LayoutTransform, Transform

public class MojoPathTransform
extends PathTransform

Extended implementation for PathTransform used in Mojo pages. Output JSON

Since:

MicroStrategy Web 9.4.0

Nested Class Summary

Nested classes/interfaces inherited from class com.microstrategy.web.app.transforms.AbstractAppTransform

AbstractAppTransform.Context

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	FP_USE_ANCESTORS	Constant specifying the name of the formal parameter for defining the useAncestors.
FormalParameter	useAncestors	Indicates whether the path should use the ancestors.

Fields inherited from class com.microstrategy.web.app.transforms.PathTransform

_event, _hiddenFolderCharacters, _objectName, _pathBean, _showLink, cssItemNameCache, cssUnselectedItemNameCache, dividerCharacters, FP_CHARS_FOR_DIVIDER, FP_CHARS_FOR_HIDDEN_FOLDERS, FP_IS_SELF_CONTAINED, FP_OPEN_DESKTOP_EVENT, FP_OPEN_FOLDER_IMAGE, FP_SHOW_LINK, hiddenFolderCharacters, isSelfContained, openDesktopEvent, openFolderImage, showLink

Fields inherited from class com.microstrategy.web.app.transforms.AbstractAppTransform

_bean, _componentBlock, _cssPrefix, _imgBlank, _imgWait, _selfOutput, _subOutput, appliesTo, CLASS_INPUT, CLASS_MESSAGE, contextMenus, cssFile, cssPrefix, debugErrorFlags, debugFlags, dragMode, extraInput, extraUrl, FP_APPLIES_TO, FP_CONTEXT_MENUS, FP_CSS_ERROR_MESSAGE, FP_CSS_ERROR_TITLE, FP_CSS_FILE, FP_CSS_PREFIX, FP_DEBUG_ERROR_FLAGS, FP_DEBUG_FLAGS, FP_DRAG_MODE, FP_EXTRA_INPUT, FP_EXTRA_URL, FP_HEIGHT, FP_IFRAME_ENABLED, FP_IMG_WAIT, FP_INITIAL_INDENT, FP_ORIENTATION, FP_ORIENTATIONS_ALLOWED, FP_PARTIAL_IFRAME_UPDATE, FP_PROCESSING_BUTTONS_FLAGS, FP_PROCESSING_INFO_FLAGS, FP_RESIZE_LEVEL, FP_SCRIPT_CLASS, FP_TYPE, FP_USE_DHTML, FP_WIDTH, globalCssErrorMessage, globalCssErrorTitle, height, iframeEnabled, imgWait, indent, initialIndent, isDHTML, orientation, orientationsAllowed, partialIframeUpdate, PROCESSING_BUTTONS_ALL, PROCESSING_BUTTONS_CANCEL, PROCESSING_BUTTONS_HISTORY_LIST, PROCESSING_BUTTONS_REFRESH, PROCESSING_BUTTONS_VIEW_DETAILS, PROCESSING_INFO_ALL, PROCESSING_INFO_DESCRIPTION, PROCESSING_INFO_LAST_UPDATE, PROCESSING_INFO_NAME, PROCESSING_INFO_NONE, PROCESSING_INFO_STATUS, processingButtonsFlags, processingInfoFlags, RESIZE_ALL, RESIZE_HORIZONTAL, RESIZE_NONE, RESIZE_VERTICAL, resizeLevel, scriptClass, scriptEndTagEncoder, type, useDHTML, width

Constructor Summary

Constructors

Constructor	Description
MojoPathTransform()	Default constructor, initialize formal parameters.

Method Summary

Modifier and Type	Method	Description
protected void	addLinkForAncestors(BlockList pathBlockList)
protected Block	getBackPickerButton()	Get back button blcok
protected Block	getCurrentObject()
protected BlockList	getExtraLinks()	Get extra links block list
protected Block	getForwardPickerButton()	Get forward button block
protected Block	getHelpLink()
protected Block	getHomeButton()	Get home button block
protected Block	getLinkForDesktop()
protected BlockList	getNavigationButtons()	Get navigation buttons
protected BlockList	getPath()	Get ancestors links block list
protected Block	getSearchInfo()	Get search information block
protected BlockList	getStarburstMenu()	Add starburst's menu list to path bar JSON
protected Block	getUpButton()	Get parent up button Block
void	renderShell(MarkupOutput out)	Generates the shell for this Transform.
void	transformForRequestSuccessful(MarkupOutput out)	Renders the information needed to build the path bar.

Methods inherited from class com.microstrategy.web.app.transforms.PathTransform

canRenderHomeButtton, canRenderParentUpButton, generateAnchor, getAncestorFolder, getAncestors, getBackButtonEvent, getBrowseFolderEvent, getCreateFolderBean, getDescription, getForwardButtonEvent, getHasAncestors, getImageSrc, getObjectBean, getObjectNameAndEvent, getObjectPathFolderAncestors, getObjectPathFolderAncestors, getObjectsFactory, getOpenCreateFolderEvent, getOpenDesktopEvent, getOpenHistoryPage, getOpenHomeEvent, getParentEventAndDesc, getParentFolderBean, getServletWebComponent, getSpecialFolderName, getStyleShellDiv, getSupportedBeanType, getSysFolderID, initializeCss, initializeImages, initializeTransform, isAncestorNamedFolder, isFolderRoot, isNewObject, isSpecialFolder, isTemplateFolder, renderAncestor, renderAncestors, renderBackButton, renderCreateFolderButton, renderCurrentItem, renderFolder, renderFolder, renderForwardButton, renderHomeButton, renderLinkForDesktop, renderLinkForHome, renderNewLine, renderObjectName, renderOpenFolderImage, renderParent, renderParentFolderDelimiter, renderParentUpButton, renderSimpleButton, renderSimpleButton, renderSimpleLink, renderSimpleLink, renderTitle, setBoneProperties, setHasAncestors, shouldDisableBackButton, transformForRequestInError, transformForRequestProcessing, transformForRequestWaitingForUserInput, useParentAncestors

Methods inherited from class com.microstrategy.web.app.transforms.AbstractAppTransform

addContactInfo, addDynamicScriptClass, addDynamicScriptFile, addFormalParameter, checkLevel, checkProcessingButtonsFlag, checkProcessingInfoFlag, checkStatus, displayError, displayError, displayError, emptyCell, excludeStaticTags, generateAnchorForExport, generateHiddenInputsForEvent, generateIFrameTag, getAppContext, getArgumentName, getAttributesShellDiv, getBeanPath, getBoneId, getCancelEvent, getClientSideHelper, getContainerServices, getContext, getContextMenu, getContextMenuManager, getContextMenuManagerName, getContextMenusDefinition, getCssPrefix, getDateFormat, getDebugOut, getDescriptor, getDescriptor, getDescriptor, getDescriptor, getDisplayMode, getDisplayName, getErrorMessage, getErrorMessage, getErrorTitle, getErrorTitle, getEventManager, getFirstDayOfWeek, getFloatValue, getHelpPath, getID, getIntValue, getJSNameSpace, getLayoutContext, getLocale, getLocale, getPreferenceValue, getProjectID, getRefreshEvent, getRequestKeys, getResourcesFolder, getScriptClass, getStringValue, getStyleRequestContext, getTagsFactory, getTimeFormat, getUnitsLabel, getWebBeanErrorInfo, hasSubBlock, initHeightAndWidthFromPreferences, initializeWebComponent, is508, isBlockMode, isContextMenusEnabled, isDhtml, isDialog, isDormant, isFeatureAvailable, isIFrameDisplayMode, isIFrameEnabled, isIFrameRequest, isJobExpired, isModal, isOpen, isPortlet, isTrue, localIsIFrameDisplayMode, newContext, newHiddenInputBuilder, newNamespaceEncoder, newURIBuilder, redirectToDisplayError, renderBean, renderBean, renderBean, renderBean, renderCancelButton, renderContextMenus, renderCssLink, renderDescriptor, renderDescriptor, renderErrorButton, renderHiddenInputFromRequest, renderImage, renderLayout, renderProcessingButton, renderProcessingButton, renderProcessingButton, renderProcessingButtonForGet, renderProcessingButtonForGet, renderProcessingButtons, renderProcessingInfo, renderProcessingInfoData, renderProcessingInfoImage, renderProcessingInfoSubtitle, renderProcessingInfoTitle, renderProcessingObjectName, renderRefreshButton, renderRegisterBone, renderSelf, renderSubBlock, renderUserHelpAnchor, setDisplayMode, setHasSubBlock, setHeight, setIFrameDisplayMode, setIsDormant, setRenderSubBlock, setShellAttributeOnClosedComponent, setWidth, shouldDisplay, transform, transformForRequestCanceled, transformForRequestNotInited

Methods inherited from class com.microstrategy.web.transform.AbstractLayoutTransform

getLayoutDefinition, setLayoutDefinition, transformUsingLayout

Methods inherited from class com.microstrategy.web.transform.AbstractTransform

addFormalParam, canTransform, getEvents, getFormalParams, getPreview, isPreviewAvailable, isResolved, removeFormalParam, setAnnotation, setDeprecated, supports, supports

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.microstrategy.web.transform.LayoutTransform

getLayoutDefinition, setLayoutDefinition

Methods inherited from interface com.microstrategy.web.transform.Transform

canTransform, getFormalParams, getID, getPreview, isPreviewAvailable, isResolved, supports, supports, transform

Field Detail

useAncestors

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

FP_USE_ANCESTORS

public static final java.lang.String FP_USE_ANCESTORS

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

See Also:

Constant Field Values

Constructor Detail

MojoPathTransform

public MojoPathTransform()

Default constructor, initialize formal parameters.

Method Detail

renderShell

public void renderShell(MarkupOutput out)

Description copied from class: AbstractAppTransform

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.

Overrides:

renderShell in class AbstractAppTransform

Parameters:

out - output by this transform

transformForRequestSuccessful

public void transformForRequestSuccessful(MarkupOutput out)

Renders the information needed to build the path bar.

Overrides:

transformForRequestSuccessful in class PathTransform

Parameters:

out - the transform's output

See Also:

AbstractAppTransform.checkStatus(com.microstrategy.web.beans.MarkupOutput)

getExtraLinks

protected BlockList getExtraLinks()
                           throws java.lang.Exception

Get extra links block list

Returns:

block list of extra links

Throws:

java.lang.Exception

getHelpLink

protected Block getHelpLink()
                     throws java.lang.Exception

Throws:

java.lang.Exception

getSearchInfo

protected Block getSearchInfo()
                       throws java.lang.Exception

Get search information block

Returns:

block of search information

Throws:

java.lang.Exception

getPath

protected BlockList getPath()
                     throws java.lang.Exception

Get ancestors links block list

Returns:

BlockList of path links

Throws:

java.lang.Exception

getCurrentObject

protected Block getCurrentObject()
                          throws java.lang.Exception

Throws:

java.lang.Exception

addLinkForAncestors

protected void addLinkForAncestors(BlockList pathBlockList)
                            throws java.lang.Exception

Throws:

java.lang.Exception

getLinkForDesktop

protected Block getLinkForDesktop()
                           throws java.lang.Exception

Throws:

java.lang.Exception

getNavigationButtons

protected BlockList getNavigationButtons()
                                  throws java.lang.Exception

Get navigation buttons

Returns:

a list of navigation buttons

Throws:

java.lang.Exception

getUpButton

protected Block getUpButton()
                     throws java.lang.Exception

Get parent up button Block

Returns:

block of up button

Throws:

java.lang.Exception

getForwardPickerButton

protected Block getForwardPickerButton()
                                throws java.lang.Exception

Get forward button block

Returns:

block of forward button

Throws:

java.lang.Exception

getBackPickerButton

protected Block getBackPickerButton()
                             throws java.lang.Exception

Get back button blcok

Returns:

block of back button

Throws:

java.lang.Exception

getHomeButton

protected Block getHomeButton()
                       throws java.lang.Exception

Get home button block

Returns:

a block of home button

Throws:

java.lang.Exception

getStarburstMenu

protected BlockList getStarburstMenu()

Add starburst's menu list to path bar JSON

Parameters:

rootBlock - the root block to output the JSON