Package com.microstrategy.web.app.transforms

Class InboxClearTransform

java.lang.Object

com.microstrategy.web.transform.AbstractTransform

com.microstrategy.web.transform.AbstractLayoutTransform

com.microstrategy.web.app.transforms.AbstractAppTransform

com.microstrategy.web.app.transforms.InboxClearTransform

All Implemented Interfaces:

AppTransform, LayoutTransform, Transform

public class InboxClearTransform
extends AbstractAppTransform
implements LayoutTransform

Title: InboxListTransform.

Description: This implements a simple Inbox Transform. It shows all the elements from the history list of the current user.

Since:

MicroStrategy Web 7.3.1 or earlier

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.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
InboxClearTransform()	Default constructor.

Method Summary

Modifier and Type	Method	Description
WebEvent	getCancelEvent()	Generate the event to be used for cancelling the clearing of all the messages from the History List.
WebEvent	getClearInboxEvent()	Generate the event to be used for clearing all the messages from the History List.
java.lang.String	getDescription()	Returns the description to use in the Style Catalog.
WebEvent	getReturnToEvent()	After this page gets executed for the second time, and after the inbox has been cleared, we want to return to a previous page.
java.lang.Class	getSupportedBeanType()	Get the class of objects this transform is able to handle.
void	initializeTransform(Transformable data)	This method initialize the private and protected fields of the transform.
void	renderButtonBar(MarkupOutput out)	Renders the buttons that will execute the action
void	renderConfirmationMessage(MarkupOutput out)	Renders a confirmation message warning user about the action
void	renderConfirmDelete(MarkupOutput out)	Generate the HTML for the Confirm Delete dialog rendered by this transform.
void	renderRemoveTitle(MarkupOutput out)	Renders the HTML content for the title of the dialog to be shown by this transform
void	transformForRequestSuccessful(MarkupOutput out)	Transforms the assosciated WebBean when its status is EnumRequestStatus.WebBeanRequestSuccessful.

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

Constructor Detail

InboxClearTransform

public InboxClearTransform()

Default constructor. Initialize all formal parameters

Method Detail

getDescription

public java.lang.String getDescription()

Returns the description to use in the Style Catalog.

Specified by:

getDescription in interface Transform

Returns:

"This implements the transform to confirm clear all inbox messages."

initializeTransform

public void initializeTransform(Transformable data)

This method initialize the private and protected fields of the transform.

Specified by:

initializeTransform in interface AppTransform

Overrides:

initializeTransform in class AbstractAppTransform

Parameters:

data - Transformable instance with the bean to be transformed.

transformForRequestSuccessful

public void transformForRequestSuccessful(MarkupOutput out)

Transforms the assosciated WebBean when its status is EnumRequestStatus.WebBeanRequestSuccessful.

Specified by:

transformForRequestSuccessful in class AbstractAppTransform

Parameters:

out - MarkupOutput instance where the contents of this transform will be saved.

See Also:

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

renderRemoveTitle

public void renderRemoveTitle(MarkupOutput out)

Renders the HTML content for the title of the dialog to be shown by this transform

Parameters:

out - MarkupOutput instance where the contents of this transform will be saved.

Since:

MicroStrategy Web 8.0.0

renderConfirmDelete

public void renderConfirmDelete(MarkupOutput out)

Generate the HTML for the Confirm Delete dialog rendered by this transform.

Parameters:

out - MarkupOutput instance where the contents of this transform will be saved.

renderConfirmationMessage

public void renderConfirmationMessage(MarkupOutput out)

Renders a confirmation message warning user about the action

Parameters:

out - MarkupOutput instance where the contents of this transform will be saved.

Since:

MicroStrategy Web 8.0.0

renderButtonBar

public void renderButtonBar(MarkupOutput out)

Renders the buttons that will execute the action

Parameters:

out - MarkupOutput instance where the contents of this transform will be saved.

Since:

MicroStrategy Web 8.0.0

getClearInboxEvent

public WebEvent getClearInboxEvent()

Generate the event to be used for clearing all the messages from the History List.

Returns:

a WebEvent initialized instance with the event for removing all the messages from the Inbox, returns null if not supported by the application. By default, the event generated is EnumInboxBeanEvents.INBOX_EVENT_REMOVE_ALL_MESSAGES

getCancelEvent

public WebEvent getCancelEvent()

Generate the event to be used for cancelling the clearing of all the messages from the History List.

Overrides:

getCancelEvent in class AbstractAppTransform

Returns:

a WebEvent initialized instance with the event for cancelling the removal of all the messages from the Inbox, returns null if not supported by the application. By default, the event generated is EnumServletEvents.WebEventOpenHistoryList

getReturnToEvent

public WebEvent getReturnToEvent()

After this page gets executed for the second time, and after the inbox has been cleared, we want to return to a previous page. This returns the event to go back to the previous page.

Returns:

a WebEvent initialized instance with the event for returning to the previous page. Returns null if not supported by the application. By default, the event generated is EnumServletEvents.WebEventOpenHistoryList

getSupportedBeanType

public java.lang.Class getSupportedBeanType()

Get the class of objects this transform is able to handle.

Specified by:

getSupportedBeanType in interface Transform

Overrides:

getSupportedBeanType in class AbstractAppTransform

Returns:

a Class instance with the information about the beans this transform is able to manipulate.