Package com.microstrategy.web.app.transforms

Class RWFlashDashboardTransform

java.lang.Object

com.microstrategy.web.transform.AbstractTransform

com.microstrategy.web.transform.AbstractLayoutTransform

com.microstrategy.web.app.transforms.AbstractAppTransform

com.microstrategy.web.app.transforms.AbstractWebBeanTransform

com.microstrategy.web.app.transforms.RWFlashDashboardTransform

All Implemented Interfaces:

AppTransform, Transform

public class RWFlashDashboardTransform
extends AbstractWebBeanTransform

Since:

MicroStrategy Web 8.1.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	customJavaScriptFeatures	Indicates a comma separated list of the extra features that will be send down to the client
FormalParameter	extraFlashVars
FormalParameter	flashSource	Indicates the name of the flash source file.
FormalParameter	flashSourceDB	Indicates the name of the flash source file for double byte locales.
static java.lang.String	FP_CUSTOM_JS_FEATURES	Constant specifying any extra features that will be send down to the client.
static java.lang.String	FP_EXTRA_FLASH_VARS
static java.lang.String	FP_FLASH_SOURCE	Constant for the name of the flash source file Formal Parameter.
static java.lang.String	FP_FLASH_SOURCE_DB	Constant for the name of the flash source file Formal Parameter for double byte locales.
static java.lang.String	FP_IS_OVI	Constant specifying flag indicating this is OVI page.
protected FormalParameter	isOVI

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

Method Summary

Modifier and Type	Method	Description
java.lang.String	getDescription()	Returns the textual description of the transform
protected JsonGenerator	getFeatures()
protected HashList	getFlashVars()
protected java.lang.String	getScriptClass()	Returns the name of the javaScript class (if any) to be associated with the component.
java.lang.Class	getSupportedBeanType()	Returns the BeanType supported by this bean.
void	initializeTransform(Transformable data)	This method initialize the private and protected fields of the transform.
void	renderFlashObject(MarkupOutput out)
protected void	renderRegisterBone(MarkupOutput out)	If a scriptClass is specified, this method registers the corresponding javascript bone for this component.
protected void	setBoneProperties(JsonGenerator bonePropertiesGenerator)	Sets the necessary properties to the bone assigned to this transform (based on the AbstractAppTransform.scriptClass formal parameter) Usually called by AbstractAppTransform.renderRegisterBone(MarkupOutput) Can be overwritten to add or modify bone properties.
void	transformForRequestSuccessful(MarkupOutput out)	Generates the output when the bean's status is EnumRequestStatus.WebBeanRequestSuccessful.

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

generateErrorForIframe, getJobExpiredMessage, getReexcuteEventFromBean, getReexecuteButtonDescription, getTaskProcessorBaseURL, getWebReexecuteEvent, renderJobExpiredSection, setWebReexecuteEventArguments

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, 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, 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, renderSelf, renderShell, renderSubBlock, renderUserHelpAnchor, 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.Transform

canTransform, getFormalParams, getPreview, isPreviewAvailable, isResolved, supports, supports

Field Detail

FP_FLASH_SOURCE

public static final java.lang.String FP_FLASH_SOURCE

Constant for the name of the flash source file Formal Parameter.

See Also:

Constant Field Values

FP_FLASH_SOURCE_DB

public static final java.lang.String FP_FLASH_SOURCE_DB

Constant for the name of the flash source file Formal Parameter for double byte locales.

See Also:

Constant Field Values

FP_CUSTOM_JS_FEATURES

public static final java.lang.String FP_CUSTOM_JS_FEATURES

Constant specifying any extra features that will be send down to the client.

See Also:

Constant Field Values

FP_IS_OVI

public static final java.lang.String FP_IS_OVI

Constant specifying flag indicating this is OVI page.

See Also:

Constant Field Values

FP_EXTRA_FLASH_VARS

public static final java.lang.String FP_EXTRA_FLASH_VARS

See Also:

Constant Field Values

flashSource

public FormalParameter flashSource

Indicates the name of the flash source file.

flashSourceDB

public FormalParameter flashSourceDB

Indicates the name of the flash source file for double byte locales.

customJavaScriptFeatures

protected FormalParameter customJavaScriptFeatures

Indicates a comma separated list of the extra features that will be send down to the client

isOVI

protected FormalParameter isOVI

extraFlashVars

public FormalParameter extraFlashVars

Constructor Detail

RWFlashDashboardTransform

public RWFlashDashboardTransform()

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 BeanType supported by this bean. (non-Javadoc)

Specified by:

getSupportedBeanType in interface Transform

Overrides:

getSupportedBeanType in class AbstractAppTransform

Returns:

RWBean.class

getDescription

public java.lang.String getDescription()

Returns the textual description of the transform

Returns:

the description of the transform

transformForRequestSuccessful

public void transformForRequestSuccessful(MarkupOutput out)

Description copied from class: AbstractAppTransform

Generates the output when the bean's status is EnumRequestStatus.WebBeanRequestSuccessful. This is the main entry point to generate the output for those Transforms that just want to render the "regular" bean case.
This is an abstract method. All classes need to implement it.

Specified by:

transformForRequestSuccessful in class AbstractAppTransform

Parameters:

out - output by this transform

See Also:

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

renderRegisterBone

protected void renderRegisterBone(MarkupOutput out)

If a scriptClass is specified, this method registers the corresponding javascript bone for this component.

Overrides:

renderRegisterBone in class AbstractAppTransform

Parameters:

out - MarkupOutput whether the output should be rendered.

Since:

MicroStrategy Web 8.0.0

See Also:

getScriptClass()

renderFlashObject

public void renderFlashObject(MarkupOutput out)

getFlashVars

protected HashList getFlashVars()

Since:

MicroStrategy Web 9.0.0

getScriptClass

protected java.lang.String getScriptClass()

Description copied from class: AbstractAppTransform

Returns the name of the javaScript class (if any) to be associated with the component. When the scriptClass is specified, a bone is registered on the page for this component.

A bone is the corresponding concept of a bean in Microstrategy's javascript environment.
By default, thie methods returns an empty string. Transform which does have an associated bone needs to override this method.

Overrides:

getScriptClass in class AbstractAppTransform

Returns:

String representing the name of a javaScript class

setBoneProperties

protected void setBoneProperties(JsonGenerator bonePropertiesGenerator)

Description copied from class: AbstractAppTransform

Sets the necessary properties to the bone assigned to this transform (based on the AbstractAppTransform.scriptClass formal parameter)
Usually called by AbstractAppTransform.renderRegisterBone(MarkupOutput)
Can be overwritten to add or modify bone properties.

Overrides:

setBoneProperties in class AbstractAppTransform

Parameters:

bonePropertiesGenerator - the JsonGenerator object that contains the collection of bone properties.

getFeatures

protected JsonGenerator getFeatures()