Package com.microstrategy.web.app.transforms

Class ToolbarSetTransform

java.lang.Object

com.microstrategy.web.transform.AbstractTransform

com.microstrategy.web.transform.AbstractLayoutTransform

com.microstrategy.web.app.transforms.AbstractAppTransform

com.microstrategy.web.app.transforms.ToolbarSetTransform

All Implemented Interfaces:

AppTransform, LayoutTransform, Transform

public class ToolbarSetTransform
extends AbstractAppTransform
implements LayoutTransform

This transforms handles ToolbarSetBean instances for rendering its different ToolbarBean instances defined as children one after the other.

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

Modifier and Type	Field	Description
protected FormalParameter	toolbarStyle	Indicates the name of the style to use to render toolbars

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

Method Summary

Modifier and Type	Method	Description
java.lang.String	getDescription()	Returns the textual description of the transform
java.lang.Class	getSupportedBeanType()	Returns the supported bean type.
protected ToolbarSetBean	getToolbarSetBean()	Get the ToolbarSetBean instance being transformed
void	initializeCss()	Initializes the Css classes to use on this transform.
void	renderToolbar(MarkupOutput out, ToolbarBean tb)	Render a single ToolbarBean instance.
void	transformForRequestSuccessful(MarkupOutput out)	Generates the graphical output for a ToolbarSetBean when its state 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, 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, initializeImages, initializeTransform, 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, 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

Field Detail

toolbarStyle

protected FormalParameter toolbarStyle

Indicates the name of the style to use to render toolbars

Constructor Detail

ToolbarSetTransform

public ToolbarSetTransform()

Default constructor. Initializes formal parameters.

Method Detail

initializeCss

public void initializeCss()

Initializes the Css classes to use on this transform.

Overrides:

initializeCss in class AbstractAppTransform

getSupportedBeanType

public java.lang.Class getSupportedBeanType()

Returns the supported bean type. This transform supports ToolbarSetBean instances

Specified by:

getSupportedBeanType in interface Transform

Overrides:

getSupportedBeanType in class AbstractAppTransform

Returns:

the ToolbarSetBean class supported by this transform.

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

transformForRequestSuccessful

public void transformForRequestSuccessful(MarkupOutput out)

Generates the graphical output for a ToolbarSetBean when its state is EnumRequestStatus.WebBeanRequestSuccessful. If no layout has been defined for the transform, then it will render each one of the ToolbarBean children one after the other.

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)

renderToolbar

public void renderToolbar(MarkupOutput out,
                          ToolbarBean tb)

Render a single ToolbarBean instance. The style to use for it will be the one specified on the toolbarStyle formal parameter, or the one already linked to the ToolbarBean instance if the formal parameter was not defined.

Parameters:

tb - ToolbarBean to render

out - MarkupOutput instance where to save the HTML contents to render.

getToolbarSetBean

protected ToolbarSetBean getToolbarSetBean()

Get the ToolbarSetBean instance being transformed

Returns:

the current ToolbarSetBean instance being transformed