Package com.microstrategy.web.app.transforms

Class CurrentItemTransform

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.CurrentItemTransform

All Implemented Interfaces:

AppTransform, LayoutTransform, Transform

public class CurrentItemTransform
extends PathTransform

This class is used to render the path section of a page.
It renders the Back/Forward buttons as well as links and information about the object being displayed in the current page.

This class implements LayoutTransform which enables building the layout through an external xml configuration file.

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 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
CurrentItemTransform()

Method Summary

Modifier and Type	Method	Description
void	renderHomeButton(MarkupOutput out)	Renders a button link to Home, it uses the openDesktopEvent for this.

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, renderLinkForDesktop, renderLinkForHome, renderNewLine, renderObjectName, renderOpenFolderImage, renderParent, renderParentFolderDelimiter, renderParentUpButton, renderSimpleButton, renderSimpleButton, renderSimpleLink, renderSimpleLink, renderTitle, setBoneProperties, setHasAncestors, shouldDisableBackButton, transformForRequestInError, transformForRequestProcessing, transformForRequestSuccessful, 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, 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, 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

Constructor Detail

CurrentItemTransform

public CurrentItemTransform()

Method Detail

renderHomeButton

public void renderHomeButton(MarkupOutput out)

Description copied from class: PathTransform

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

Overrides:

renderHomeButton in class PathTransform

Parameters:

out - the transform's output