Package com.microstrategy.web.app.transforms

Class AbstractAdminPathTransform

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

All Implemented Interfaces:

AppTransform, LayoutTransform, Transform

Direct Known Subclasses:

GroupPathTransform, SecurityRolePathTransform

public abstract class AbstractAdminPathTransform
extends AbstractAppTransform
implements LayoutTransform

Since:

MicroStrategy Web 9.0.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
protected java.lang.String	_divideCharacters	Protected property for holding the value selected on the dividerCharacters formal parameter
FormalParameter	dividerCharacters	Indicates the character(s) to be used for separating each one of the different elements when displaying the path.
static java.lang.String	FP_CHARS_FOR_DIVIDER	Constant specifying the name of the formal parameter for defining the dividing characters in between objects in the path.
static java.lang.String	FP_SHOW_LINK	Constant specifying the name of the formal parameter for defining the showLink.
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.

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
AbstractAdminPathTransform()	Default constructor, initialize formal parameters.

Method Summary

Modifier and Type	Method	Description
protected boolean	canRenderHomeButtton()
protected boolean	canRenderParentUpButton()
java.lang.String	getDescription()	Return description for this Transform
protected abstract WebEvent	getGoParentPageEvent()
protected abstract java.lang.String	getGoParentPageTooltip()
protected WebEvent	getGoServerPageEvent()	Provides an event to process the Go-to Server page process.
protected WebEvent	getOpenDefaultDesktopEvent()	Returns an event to open the default desktop page.
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.
protected void	renderLink(MarkupOutput out, WebEvent event, java.lang.String descriptor)	Renders a HTML anchor tag with the event and a descriptor
protected void	renderSimpleButton(MarkupOutput out, WebEvent event, java.lang.String descriptor, java.lang.String id)	Renders a simple button as a link with an event and an id attached to it.
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.

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

addContactInfo, addDynamicScriptClass, addDynamicScriptFile, addFormalParameter, checkLevel, checkProcessingButtonsFlag, checkProcessingInfoFlag, checkStatus, displayError, displayError, displayError, emptyCell, excludeStaticTags, generateAnchor, 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, getStyleShellDiv, getSupportedBeanType, getTagsFactory, getTimeFormat, getUnitsLabel, getWebBeanErrorInfo, hasSubBlock, initHeightAndWidthFromPreferences, initializeCss, initializeImages, 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, renderShell, renderSubBlock, renderUserHelpAnchor, setBoneProperties, setDisplayMode, setHasSubBlock, setHeight, setIFrameDisplayMode, setIsDormant, setRenderSubBlock, setShellAttributeOnClosedComponent, setWidth, shouldDisplay, transform, transformForRequestCanceled, transformForRequestNotInited, transformForRequestProcessing

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, getSupportedBeanType, isPreviewAvailable, isResolved, supports, supports, transform

Field Detail

showLink

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.

dividerCharacters

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.

_divideCharacters

protected java.lang.String _divideCharacters

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

FP_SHOW_LINK

public static final java.lang.String FP_SHOW_LINK

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

See Also:

Constant Field Values

FP_CHARS_FOR_DIVIDER

public static final java.lang.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.

See Also:

Constant Field Values

Constructor Detail

AbstractAdminPathTransform

public AbstractAdminPathTransform()

Default constructor, initialize formal parameters.

Method Detail

initializeTransform

public void initializeTransform(Transformable data)

Transform the Folder Bean and append the output to MarkupOutput

Specified by:

initializeTransform in interface AppTransform

Overrides:

initializeTransform in class AbstractAppTransform

Parameters:

data - the folder bean to transform

transformForRequestWaitingForUserInput

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.

Overrides:

transformForRequestWaitingForUserInput in class AbstractAppTransform

Parameters:

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

See Also:

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

transformForRequestInError

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.

Overrides:

transformForRequestInError in class AbstractAppTransform

Parameters:

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

See Also:

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

getDescription

public java.lang.String getDescription()

Return description for this Transform

Specified by:

getDescription in interface Transform

Returns:

description for the transform

transformForRequestSuccessful

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.

Specified by:

transformForRequestSuccessful in class AbstractAppTransform

Parameters:

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

See Also:

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

renderContent

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

getOpenDefaultDesktopEvent

protected WebEvent getOpenDefaultDesktopEvent()

Returns an event to open the default desktop page.

Returns:

WebEvent for opening the "Default Desktop" page.

renderSimpleButton

protected void renderSimpleButton(MarkupOutput out,
                                  WebEvent event,
                                  java.lang.String descriptor,
                                  java.lang.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.

renderLink

protected void renderLink(MarkupOutput out,
                          WebEvent event,
                          java.lang.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.

getGoServerPageEvent

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.

renderGoServer

public void renderGoServer(MarkupOutput out)

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

Parameters:

out - MarkupOutput

canRenderHomeButtton

protected boolean canRenderHomeButtton()

canRenderParentUpButton

protected boolean canRenderParentUpButton()

renderGoHome

public void renderGoHome(MarkupOutput out)

Renders a button with a link to Home.

Parameters:

out - MarkupOutput

renderGoOneUp

public void renderGoOneUp(MarkupOutput out)

Renders the Up One level button.

Parameters:

out - Markupoutput

getGoParentPageEvent

protected abstract WebEvent getGoParentPageEvent()

getGoParentPageTooltip

protected abstract java.lang.String getGoParentPageTooltip()

renderDelimiter

public void renderDelimiter(MarkupOutput out)

Renders the ">" delimiter between the ancestor items.

Parameters:

out - MarkupOutput

renderCurrentItem

public abstract void renderCurrentItem(MarkupOutput out)