Class AbstractRWDataVisualizationTransform
- 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
-
- All Implemented Interfaces:
AppTransform
,RWBeanVisitor
,RWBeanVisitor2
,Transform
- Direct Known Subclasses:
RWFlashTransform
public abstract class AbstractRWDataVisualizationTransform extends RWLayoutTransform
Transform used to render a visualization on the document. Provides methods for obtaining the custom XML or a URL to obtain the report XML.
The subclasses simply need to implement renderVisualization()- 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 FormalParameter
documentXMLPageName
The name of the page on the pageConfig that returns the custom document XML.FormalParameter
documentXMLStyle
The name of the style to use to generate the custom document XML Allowed values: String value that corresponds to a style on the styleCatalog.FormalParameter
useAbsoluteURLs
Whether to use an absolute path on the CustomURL FlashVar-
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 AbstractRWDataVisualizationTransform()
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description protected ParameterBuilder
getBaseURL()
Returns aParameterBuilder
object that contains a base URL.protected ParameterBuilder
getBaseURL(boolean useAbsoluteURL)
Returns aParameterBuilder
object that contains a base URL which can be used to access the Web application.protected java.lang.String
getCustomDocumentXML()
java.lang.String
getDescription()
Display's the description of this transform for StyleCatalogprotected ParameterBuilder
getTaskBaseURL()
Returns aParameterBuilder
object that contains a base URL which can be used to invoke a Task on the Tasks infrastructure.protected java.lang.String
getTaskURLForCustomDocumentXML()
Returns a URL that can be used to obtain the document XML of the current report being transformed.protected java.lang.String
getURLForCustomDocumentXML()
Returns a URL that can be used to obtain the document XML of the current report being transformed.void
initializeTransform(Transformable data)
ExtendsAbstractAppTransform.initializeTransform(com.microstrategy.web.beans.Transformable)
by obtaining a reference to the datavoid
renderGridCss(MarkupOutput out)
abstract void
renderVisualization(MarkupOutput out)
Renders the visualization's content (i.e.void
startIteration(RWBeanVisitor2 visitor, MarkupOutput out, java.lang.String key, boolean definitionOnly)
Starts iterating the data, by invokingrwi.iterate();
void
startIteration(RWBeanVisitor visitor, MarkupOutput out, java.lang.String key, boolean definitionOnly)
Starts iterating the data, by invokingrwi.iterate();
-
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
-
documentXMLStyle
public FormalParameter documentXMLStyle
The name of the style to use to generate the custom document XML Allowed values: String value that corresponds to a style on the styleCatalog.
-
documentXMLPageName
public FormalParameter documentXMLPageName
The name of the page on the pageConfig that returns the custom document XML.
Used to generate the URL for the custom document XML. Allowed values: String value that corresponds to a page name on the pageConfig.
-
useAbsoluteURLs
public FormalParameter useAbsoluteURLs
Whether to use an absolute path on the CustomURL FlashVar- Since:
- MicroStrategy Web 8.1.0
-
-
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 classRWLayoutTransform
- Parameters:
data
- The bean to transform.
-
startIteration
public void startIteration(RWBeanVisitor2 visitor, MarkupOutput out, java.lang.String key, boolean definitionOnly)
Starts iterating the data, by invokingrwi.iterate();
-
startIteration
public void startIteration(RWBeanVisitor visitor, MarkupOutput out, java.lang.String key, boolean definitionOnly)
Starts iterating the data, by invokingrwi.iterate();
- Overrides:
startIteration
in classRWLayoutTransform
-
renderVisualization
public abstract void renderVisualization(MarkupOutput out)
Renders the visualization's content (i.e. the embeded flash oject)- Parameters:
out
- The markup output
-
getCustomDocumentXML
protected java.lang.String getCustomDocumentXML()
- Returns:
- the document XML specified by the formal parameter "documentXMLStyle"
-
getURLForCustomDocumentXML
protected java.lang.String getURLForCustomDocumentXML()
Returns a URL that can be used to obtain the document XML of the current report being transformed.- Returns:
- a URL that can be used to obtain the document XML of the current report being transformed.
-
getBaseURL
protected ParameterBuilder getBaseURL()
Returns aParameterBuilder
object that contains a base URL.
This object is initialized with the TargetBase, TargetPrefix and contains the session manager state which is used in URLs as argumentEnumWebParameters.WebSessionManagerState
to restore the session.- Returns:
- a
ParameterBuilder
object that contains a base URL.
-
getBaseURL
protected ParameterBuilder getBaseURL(boolean useAbsoluteURL)
Returns aParameterBuilder
object that contains a base URL which can be used to access the Web application.
This object is initialized with the TargetBase, TargetPrefix and contains the session manager state which is used in URLs as argumentEnumWebParameters.WebSessionManagerState
to restore the session.- Parameters:
useAbsoluteURL
- whether to use an absolute URL- Returns:
- a
ParameterBuilder
object that contains a base URL which can be used to access the Web application. - Since:
- MicroStrategy Web 8.1.0
-
getTaskURLForCustomDocumentXML
protected java.lang.String getTaskURLForCustomDocumentXML()
Returns a URL that can be used to obtain the document XML of the current report being transformed.
The URL uses the Tasks infrastructure- Returns:
- a URL that can be used to obtain the document XML of the current report being transformed.
- Since:
- MicroStrategy Web 8.1.0
-
getTaskBaseURL
protected ParameterBuilder getTaskBaseURL()
Returns aParameterBuilder
object that contains a base URL which can be used to invoke a Task on the Tasks infrastructure.
This object is initialized with the TargetBase, TargetPrefix and contains the session manager state which is used in URLs as argumentEnumWebParameters.WebSessionManagerState
to restore the session.- Returns:
- a
ParameterBuilder
object that contains a base URL which can be used to invoke a Task on the Tasks infrastructure. - Since:
- MicroStrategy Web 8.1.0
-
renderGridCss
public void renderGridCss(MarkupOutput out)
- Overrides:
renderGridCss
in classRWLayoutTransform
-
getDescription
public java.lang.String getDescription()
Description copied from class:RWLayoutTransform
Display's the description of this transform for StyleCatalog- Specified by:
getDescription
in interfaceTransform
- Overrides:
getDescription
in classRWLayoutTransform
- Returns:
- This transform displays the data of a Report Writing Document.
-
-