Package com.microstrategy.web.app.transforms

Class LogoutTransform

java.lang.Object

com.microstrategy.web.transform.AbstractTransform

com.microstrategy.web.transform.AbstractLayoutTransform

com.microstrategy.web.app.transforms.AbstractAppTransform

com.microstrategy.web.app.transforms.LogoutTransform

All Implemented Interfaces:

AppTransform, LayoutTransform, Transform

public class LogoutTransform
extends AbstractAppTransform
implements LayoutTransform

This transform renders the logout dialog to the 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
LogoutTransform()	Default constructor.

Method Summary

Modifier and Type	Method	Description
protected WebEvent	getAfterLogoutEvent()	Generate the WebEvent that will indicate where to take the user once the logout is completed.
java.lang.String	getDescription()	Returns the textual description of the transform
java.lang.Class	getSupportedBeanType()	Returns the supported bean type.
void	initializeTransform(Transformable data)	This method initialize the private and protected fields of the transform.
void	renderErrorMessage(MarkupOutput out)	Render the given message as a problem while performing log out.
void	renderErrorMessage(MarkupOutput out, java.lang.String message)	Render the given message as a problem while performing log out.
void	renderExitLogoutPage(MarkupOutput out)	Render a form button to take the user to the location specified by the getAfterLogoutEvent() method, after the logout has been performed.
void	renderLogoutMessage(MarkupOutput out)	Render a message to indicate the user s/he has been logged out.
void	renderLogoutTitle(MarkupOutput out)	Render the title for the message this transform will be showing to the user.
void	transformForRequestSuccessful(MarkupOutput out)	Generates the graphical output for the LogoutBean instance being transformed, when it's state is successful.

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, 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

LogoutTransform

public LogoutTransform()

Default constructor. Initializes formal parameters.

Method Detail

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 - bean that will be transformed

getSupportedBeanType

public java.lang.Class getSupportedBeanType()

Returns the supported bean type. This transform supports LogoutBean instances

Specified by:

getSupportedBeanType in interface Transform

Overrides:

getSupportedBeanType in class AbstractAppTransform

Returns:

LogoutBean.class

getDescription

public java.lang.String getDescription()

Returns the textual description of the transform

Specified by:

getDescription in interface Transform

Returns:

the description of the transform

renderErrorMessage

public void renderErrorMessage(MarkupOutput out)

Render the given message as a problem while performing log out.

Parameters:

out - MarkupOutput where the resulting HTML to render will be saved logging out

Since:

MicroStrategy Web 8.0.0

renderErrorMessage

public void renderErrorMessage(MarkupOutput out,
                               java.lang.String message)

Render the given message as a problem while performing log out.

Parameters:

out - MarkupOutput where the resulting HTML to render will be saved

message - a String with the specific message to show to the user, indicating any errors while logging out

renderLogoutMessage

public void renderLogoutMessage(MarkupOutput out)

Render a message to indicate the user s/he has been logged out.

Parameters:

out - MarkupOutput where the resulting HTML to render will be saved

renderExitLogoutPage

public void renderExitLogoutPage(MarkupOutput out)

Render a form button to take the user to the location specified by the getAfterLogoutEvent() method, after the logout has been performed.

Parameters:

out - MarkupOutput where the resulting HTML to render will be saved

renderLogoutTitle

public void renderLogoutTitle(MarkupOutput out)

Render the title for the message this transform will be showing to the user.

Parameters:

out - MarkupOutput instance where the HTML content to display will be saved.

Since:

MicroStrategy Web 8.0.0

transformForRequestSuccessful

public void transformForRequestSuccessful(MarkupOutput out)

Generates the graphical output for the LogoutBean instance being transformed, when it's state is successful.

Specified by:

transformForRequestSuccessful in class AbstractAppTransform

Parameters:

out - MarkupOutput instance where to create the HTML output

See Also:

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

getAfterLogoutEvent

protected WebEvent getAfterLogoutEvent()

Generate the WebEvent that will indicate where to take the user once the logout is completed. This event information is used as argument for the renderExitLogoutPage method.

Returns:

a WebEvent instance for opening the home or welcome page of the application, or where the user should be taken to after the logout is completed. Returns null if the application does not support it.