Class RWFlashTransform
- 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.AbstractRWTransform
-
- com.microstrategy.web.app.transforms.RWLayoutTransform
-
- com.microstrategy.web.app.transforms.AbstractRWDataVisualizationTransform
-
- com.microstrategy.web.app.transforms.RWFlashTransform
-
- All Implemented Interfaces:
AppTransform
,RWBeanVisitor
,RWBeanVisitor2
,Transform
public class RWFlashTransform extends AbstractRWDataVisualizationTransform
This Transform generates an embeded flash object tag. It can include the report XML for the Flash to use or a URL that can be used to obtain the report XML.- Since:
- MicroStrategy Web 8.0.2
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class com.microstrategy.web.app.transforms.RWLayoutTransform
RWLayoutTransform.ButtonHelper
-
Nested classes/interfaces inherited from class com.microstrategy.web.app.transforms.AbstractRWTransform
AbstractRWTransform.ButtonAlignmentsHelper
-
Nested classes/interfaces inherited from class com.microstrategy.web.app.transforms.AbstractAppTransform
AbstractAppTransform.Context
-
-
Field Summary
Fields Modifier and Type Field Description protected FormalParameter
containerHeight
Specifies the height (in any measure accepted by the web-browser) of the element rendered by this transform.protected FormalParameter
containerWidth
Specifies the width (in any measure accepted by the web-browser) of the element rendered by this transform.protected FormalParameter
extraFlashVars
Deprecated.to add extra flashvars please extend Transform and overwritegetFlashVars()
FormalParameter
flashFile
The name of the flash SWF file to include.protected FormalParameter
includeBaseURL
Adds a FlashVar named "baseURL" that contains a URL that can be used to access MicroStrategy Web from Flash.protected FormalParameter
useJS
Whether to use Javascript to render the embeded Flash Object.-
Fields inherited from class com.microstrategy.web.app.transforms.AbstractRWDataVisualizationTransform
documentXMLPageName, documentXMLStyle, useAbsoluteURLs
-
Fields inherited from class com.microstrategy.web.app.transforms.RWLayoutTransform
_jsPage, customJavaScriptFeatures, dpiConversion, FP_CLIENT_SIDE_DESIGN_MODE_TEMPLATE_MANIPULATIONS, FP_CUSTOM_JS_FEATURES, FP_DPI_CONVERSION, FP_GRAPH_TEMPLATES_DESIGN_STYLE, FP_GRAPH_TEMPLATES_STYLE, FP_GRID_DENSITY, FP_GRID_TEMPLATES_DESIGN_STYLE, FP_GRID_TEMPLATES_STYLE, FP_IMG_COLLAPSE, FP_IMG_EXPAND, FP_IS_HTML_EXPORT, FP_IS_VIEW_MODE_ONLY, FP_JS_PREFIX, FP_LEVEL_FLAG, FP_MARQUEE_STYLE, FP_METRICS_UNIT, FP_OUTLINE_GRID_TEMPLATES_STYLE, FP_PROMPTS_CREATE_RW_DATASET_STYLE, FP_PROMPTS_EDIT_STYLE, FP_PROMPTS_EXECUTE_RW_DATASET_STYLE, FP_PROMPTS_EXECUTE_STYLE, FP_RWD_DROPZONE_STYLE_NAME, FP_UNITS, graphTemplatesDesignStyle, graphTemplatesStyle, gridDensity, gridTemplatesDesignStyle, gridTemplatesStyle, ID_POSTFIX, imgCollapse, imgExpand, isHTMLExport, isViewModeOnly, jsPrefix, LEVEL_ALL, LEVEL_HRULER, LEVEL_SECTION_TITLE, LEVEL_SUBSECTION_HANDLE, LEVEL_VRULER, levelFlag, marqueeSelectionStyle, metricsUnit, outlineGridTemplatesStyle, promptsCreateRWDatasetStyle, promptsEditStyle, promptsExecuteRWDatasetStyle, promptsExecuteStyle, RWDZStyleName, units, useClientSideManipulations
-
Fields inherited from class com.microstrategy.web.app.transforms.AbstractRWTransform
imgError
-
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 RWFlashTransform()
Default no-args constructor, initializes formal parameters.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected HashList<java.lang.String,java.lang.String>
getFlashVars()
Returns the collection of flashVars to be added to the embedded Flash object.void
initializeTransform(Transformable data)
ExtendsAbstractAppTransform.initializeTransform(com.microstrategy.web.beans.Transformable)
by obtaining a reference to the dataprotected void
renderEmbededFlashObjectTag(MarkupOutput out)
Renders an embeded object flash file based on the values set on the formal parameters.void
renderVisualization(MarkupOutput out)
Renders an embeded Flash object tag.-
Methods inherited from class com.microstrategy.web.app.transforms.AbstractRWDataVisualizationTransform
getBaseURL, getBaseURL, getCustomDocumentXML, getDescription, getTaskBaseURL, getTaskURLForCustomDocumentXML, getURLForCustomDocumentXML, renderGridCss, startIteration, startIteration
-
Methods inherited from class com.microstrategy.web.app.transforms.RWLayoutTransform
addStyleRule, getAttributesShellDiv, getBeanPath, getBeanXml, getBoneId, getContextMenuManagerName, getContinueEvent, getCurrentSliceId, getDpiConversion, getFeatures, getFeaturesList, getHyperLinks, getID, getLocale, getNextId, getPromptsTransform, getReportGraphTransform, getReportGridTransform, getReportOutlineGridTransform, getReportVisualizationTransform, getSupportedBeanType, getWebHyperLinks, getZoomFactor, hasCharts, initializeCss, initializeImages, initializeJavascript, isContextMenusEnabled, isCurrentPanel, isDhtml, isIFrameDisplayMode, onEnd, onEndSection, onEndSubsection, onObject, onObject, onObject, onStart, onStartSection, onStartSubsection, renderClipboardGrid, renderContextMenu, renderControlTitleBar, renderDashboardControl, renderGoverningMessage, renderGrid, renderGrid, renderHorizontalContainerHandle, renderHRuler, renderHTMLContainer, renderImage, renderImage, renderLine, renderPanelEnd, renderPanelStackEnd, renderPanelStackStart, renderPanelStackTitleBar, renderPanelStart, renderPartialBoneProperties, renderPlaceFolder, renderRegisterBone, renderRulerStyle, renderSectionEnd, renderSectionStart, renderSectionTitle, renderShape, renderShell, renderSubsectionEnd, renderSubsectionEnd, renderSubsectionHandle, renderSubsectionStart, renderText, renderTitleBar, renderTitleBar, renderVRuler, setupOndemandContextMenuModelView, startIteration, startIteration, transformForPartialDisplay, transformForRequestSuccessful, transformForRequestWaitingForUserInput, updateGridVisualizationTransform
-
Methods inherited from class com.microstrategy.web.app.transforms.AbstractRWTransform
displayError, generateErrorForIframe, getCancelEvent, getDocumentStatus, getDocumentStatusDescriptorKey, getErrorMessage, getErrorTitle, getHistoryListEvent, getInboxSource, getJobExpiredMessage, getReexecuteButtonDescription, getRefreshEvent, getRWBean, getRWFrame, getViewDetailsEvent, getWebReexecuteEvent, isDesignMode, renderHistoryListButton, renderProcessingButtons, renderProcessingInfo, renderProcessingInfoDetails, renderProcessingInfoStatus, renderViewDetailsButton, setWebReexecuteEventArguments, transformForRequestInError, transformForRequestNotInited, updateVisTransform
-
Methods inherited from class com.microstrategy.web.app.transforms.AbstractWebBeanTransform
getReexcuteEventFromBean, getTaskProcessorBaseURL, renderJobExpiredSection
-
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, getClientSideHelper, getContainerServices, getContext, getContextMenu, getContextMenuManager, getContextMenusDefinition, getCssPrefix, getDateFormat, getDebugOut, getDescriptor, getDescriptor, getDescriptor, getDescriptor, getDisplayMode, getDisplayName, getErrorMessage, getErrorMessage, getErrorTitle, getErrorTitle, getEventManager, getFirstDayOfWeek, getFloatValue, getHelpPath, getIntValue, getJSNameSpace, getLayoutContext, getLocale, getPreferenceValue, getProjectID, getRequestKeys, getResourcesFolder, getScriptClass, getStringValue, getStyleRequestContext, getStyleShellDiv, getTagsFactory, getTimeFormat, getUnitsLabel, getWebBeanErrorInfo, hasSubBlock, initHeightAndWidthFromPreferences, initializeWebComponent, is508, isBlockMode, isDialog, isDormant, isFeatureAvailable, isIFrameEnabled, isIFrameRequest, isJobExpired, isModal, isOpen, isPortlet, isTrue, localIsIFrameDisplayMode, newContext, newHiddenInputBuilder, newNamespaceEncoder, newURIBuilder, redirectToDisplayError, renderBean, renderBean, renderBean, renderBean, renderCancelButton, renderContextMenus, renderCssLink, renderDescriptor, renderDescriptor, renderErrorButton, renderHiddenInputFromRequest, renderLayout, renderProcessingButton, renderProcessingButton, renderProcessingButton, renderProcessingButtonForGet, renderProcessingButtonForGet, renderProcessingInfoData, renderProcessingInfoImage, renderProcessingInfoSubtitle, renderProcessingInfoTitle, renderProcessingObjectName, renderRefreshButton, renderSelf, renderSubBlock, renderUserHelpAnchor, setBoneProperties, setDisplayMode, setHasSubBlock, setHeight, setIFrameDisplayMode, setIsDormant, setRenderSubBlock, setShellAttributeOnClosedComponent, setWidth, shouldDisplay, transform, transformForRequestCanceled, transformForRequestProcessing
-
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
-
flashFile
public FormalParameter flashFile
The name of the flash SWF file to include. Allowed values: String values
-
containerWidth
protected FormalParameter containerWidth
Specifies the width (in any measure accepted by the web-browser) of the element rendered by this transform. Its value can be specified on the request as "containerWidth" and this will overwrite the existing value.
-
containerHeight
protected FormalParameter containerHeight
Specifies the height (in any measure accepted by the web-browser) of the element rendered by this transform. Its value can be specified on the request as "containerHeight" and this will overwrite the existing value.
-
extraFlashVars
protected FormalParameter extraFlashVars
Deprecated.to add extra flashvars please extend Transform and overwritegetFlashVars()
The value of this parameter specifies a collection of extra flashVar variables that will be passed to the embedded flash object. These variables consist of name/value pairs in the following format:
"name1=value1&name2=value2&name3=value3"
If set through the styleCatalog.xml, the '&' must be encoded, so it should be "name1=value1&name2=value2&name3=value3"
-
includeBaseURL
protected FormalParameter includeBaseURL
Adds a FlashVar named "baseURL" that contains a URL that can be used to access MicroStrategy Web from Flash.
This link includes the session manager state which is used to restore the session
-
useJS
protected FormalParameter useJS
Whether to use Javascript to render the embeded Flash Object.
Javascript is used validate that the proper version of Flash is installed on the client.
Its value can be specified on the request as "useJS" and this will overwrite the existing value.- Since:
- MicroStrategy Web 8.1.1
-
-
Method Detail
-
initializeTransform
public void initializeTransform(Transformable data)
Description copied from class:RWLayoutTransform
ExtendsAbstractAppTransform.initializeTransform(com.microstrategy.web.beans.Transformable)
by obtaining a reference to the data- Specified by:
initializeTransform
in interfaceAppTransform
- Overrides:
initializeTransform
in classAbstractRWDataVisualizationTransform
- Parameters:
data
- The bean to transform.- Since:
- MicroStrategy Web 8.1.1
-
renderVisualization
public void renderVisualization(MarkupOutput out)
Renders an embeded Flash object tag.- Specified by:
renderVisualization
in classAbstractRWDataVisualizationTransform
- Parameters:
out
- The markup output
-
getFlashVars
protected HashList<java.lang.String,java.lang.String> getFlashVars()
Returns the collection of flashVars to be added to the embedded Flash object. Based on the value ofEnumWebPreferences.WebPreferenceVisualizationsXMLAccessMethod
, it adds "customURL" or "customXML" with their corresponding values.
It may also add a baseURL if specified in the formal parameter.
This method can be overritten to add more flashVars.- Returns:
- the collection of flashVars to be added to the embedded Flash object
-
renderEmbededFlashObjectTag
protected void renderEmbededFlashObjectTag(MarkupOutput out)
Renders an embeded object flash file based on the values set on the formal parameters.- Parameters:
out
- the Markup output
-
-