Package com.microstrategy.web.app.transforms

Class InboxToolbarTransform

java.lang.Object

com.microstrategy.web.transform.AbstractTransform

com.microstrategy.web.transform.AbstractLayoutTransform

com.microstrategy.web.app.transforms.AbstractAppTransform

com.microstrategy.web.app.transforms.InboxExtrasTransform

com.microstrategy.web.app.transforms.InboxToolbarTransform

All Implemented Interfaces:

AppTransform, LayoutTransform, Transform

public class InboxToolbarTransform
extends InboxExtrasTransform
implements LayoutTransform

This transform renders the different options that can be offered to users on the History List page, such as refreshing the contents, clearing them or showing more level of information about the messages already displayed.

Since:

MicroStrategy Web 8.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.InboxExtrasTransform

_inboxBean, _messages, FP_BULLET_IMAGE, imgBullet

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
InboxToolbarTransform()	Default no-argument constructor.

Method Summary

Modifier and Type	Method	Description
protected AnchorTag	generateAnchor(WebEvent event)	Overwrites the parent method by setting special attributes if the event is not provided
java.lang.String	getStyleShellDiv()	Returns the style (that is, the style attribute used for css formatting) of the shell's div.
void	renderClearHistoryList(MarkupOutput out)	Renders the option to clear the history list.
void	renderExpandMessages(MarkupOutput out)	Renders the option to expand the document messages information (if applicable) on the history list.
void	renderRefreshHistoryList(MarkupOutput out)	Renders the option to refresh the history list.

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

getClearEvent, getDescription, getDocumentCount, getExpandMessagesEvent, getRefreshEvent, getSelectedDocumentCount, getSelectedMessageIDFromRequest, getSupportedBeanType, initializeImages, initializeTransform, transformForRequestSuccessful

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, getRequestKeys, getResourcesFolder, getScriptClass, getStringValue, getStyleRequestContext, getTagsFactory, getTimeFormat, getUnitsLabel, getWebBeanErrorInfo, hasSubBlock, initHeightAndWidthFromPreferences, initializeCss, 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, transformForRequestInError, transformForRequestNotInited, transformForRequestProcessing, transformForRequestWaitingForUserInput

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, getDescription, getFormalParams, getID, getPreview, getSupportedBeanType, isPreviewAvailable, isResolved, supports, supports, transform

Constructor Detail

InboxToolbarTransform

public InboxToolbarTransform()

Default no-argument constructor.

Method Detail

renderRefreshHistoryList

public void renderRefreshHistoryList(MarkupOutput out)

Renders the option to refresh the history list.

Overrides:

renderRefreshHistoryList in class InboxExtrasTransform

Parameters:

out - MarkupOutput instance where to write the output of the method.

renderClearHistoryList

public void renderClearHistoryList(MarkupOutput out)

Renders the option to clear the history list.

Overrides:

renderClearHistoryList in class InboxExtrasTransform

Parameters:

out - MarkupOutput instance where to write the output of the method.

renderExpandMessages

public void renderExpandMessages(MarkupOutput out)

Renders the option to expand the document messages information (if applicable) on the history list.

Overrides:

renderExpandMessages in class InboxExtrasTransform

Parameters:

out - MarkupOutput instance where to write the output of the method.

getStyleShellDiv

public java.lang.String getStyleShellDiv()

Description copied from class: AbstractAppTransform

Returns the style (that is, the style attribute used for css formatting) of the shell's div.

Overrides:

getStyleShellDiv in class AbstractAppTransform

Since:

MicroStrategy Web 9.0.0

See Also:

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

generateAnchor

protected AnchorTag generateAnchor(WebEvent event)

Overwrites the parent method by setting special attributes if the event is not provided

Overrides:

generateAnchor in class InboxExtrasTransform

Parameters:

event - WebEvent

Returns:

AnchorTag