Package com.microstrategy.web.app.transforms

Class ReportOutlineModeExcelTransform

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.AbstractReportTransform

com.microstrategy.web.app.transforms.AbstractReportDataTransform

com.microstrategy.web.app.transforms.AbstractReportGridTransform

com.microstrategy.web.app.transforms.ReportGridTransformImpl

com.microstrategy.web.app.transforms.ReportOutlineModeTransformImpl

com.microstrategy.web.app.transforms.AbstractReportOutlineModeExportTransform

com.microstrategy.web.app.transforms.ReportOutlineModeExcelTransform

All Implemented Interfaces:

AppTransform, ReportDataTransform, LayoutTransform, Transform

public class ReportOutlineModeExcelTransform
extends AbstractReportOutlineModeExportTransform

Since:

MicroStrategy Web 9.0.0

Nested Class Summary

Nested classes/interfaces inherited from class com.microstrategy.web.app.transforms.ReportGridTransformImpl

ReportGridTransformImpl.Context

Field Summary

Fields

Modifier and Type	Field	Description
protected FormalParameter	addExcelFormatInfo	Determines whether to add the number formatting information for Excel.
protected FormalParameter	addExcelOutlineInfo	Determines whether to add properties to the report rows of outline reports to be displayed as outline mode in Exporting to Excel.
protected FormalParameter	forceHeadersAndTitlesAsTextForExcel	Determines whether to force the headers and titles to be text for Excel.
protected FormalParameter	forceMetricValuesAsTextForExcel	Determines whether to force the metric values to be text for Excel.

Fields inherited from class com.microstrategy.web.app.transforms.ReportOutlineModeTransformImpl

cssOutlineModeContractImage, cssOutlineModeExpandImage, cssOutlineModeLevelCell, cssOutlineModeLevelTable, imgOutlineContract, imgOutlineExpand, outlineModeDefaultLevelMax, outlineModeLevelTableID, outlineModeState, outlineModeSupressDuplicateSubTotals, staticOutlineMode, useImagesForOutlineMode

Fields inherited from class com.microstrategy.web.app.transforms.ReportGridTransformImpl

_sharedCellProperties, containerHeight, containerWidth, cssParentFontSize, cssPathParameter, cssUseRelativeFont, dpiConversion, drillLinkExtraURL, drillRetainParent, FP_IS_HTML_EXPORT, headerMetricValueOptimized, heightMode, hideMetricsLabel, ignoreSubtotal, imgActiveSortAsc, imgActiveSortDesc, imgInActiveSortAsc, imgInActiveSortDesc, isHTMLExport, lastRowTitle, maxSortAllowed, mergeColHeaderPara, overflowMode, showBandingPara, showDrillAdvanced, showDrillCheckBox, showDrillDownOnly, showDrillHyperlink, showDrillHyperlinkMetric, showDrillMetric, showDrillRMC, showDrillRMCMetric, showFilterOnSelectionCheckBox, showSortButtonsForAttributes, showSortButtonsForMetrics, showSortRMCForAttributes, showSortRMCForMetrics, showUniqueDrillPaths, useImageOnEmptyCells, widthMode, wrapMetricValue, wrapRowHeader, zoomFactor

Fields inherited from class com.microstrategy.web.app.transforms.AbstractReportGridTransform

_contextMenuManager, _gridCellClasses, _imgRemove, _imgShiftDown, _imgShiftLeft, _imgShiftLeftDown, _imgShiftRight, _imgShiftRightDown, _imgShiftRightUp, _imgShiftUp, _imgToPageBy, _rdcFactory, _reuseFlag, addNumberFormatting, COL_HEADER, COL_HEADER_CLASS, COL_TITLE, COL_TITLE_CLASS, contextMenuName, DISPLAY_CELL, DISPLAY_CELL_CLASS, gridClassesConfFile, imgRemove, imgShiftDown, imgShiftLeft, imgShiftLeftDown, imgShiftRight, imgShiftRightDown, imgShiftRightUp, imgShiftUp, imgToPageBy, isContextMenuEnabled, isDragAndDropEnabled, METRIC_VALUE, METRIC_VALUE_CLASS, postTextForMetricValue, postTextForNonMetricValue, preTextForMetricValue, preTextForNonMetricValue, reportDesignModePara, returnReplacement, REUSE_FLAG, ROW_HEADER, ROW_HEADER_CLASS, ROW_TITLE, ROW_TITLE_CLASS, showContextMenus, showDescriptionAsTooltip, showExtraRemoveRMC, showFormattingRMC, showGridInFullWidth, showPivotPara, showPivotRMC, showRemovePara, showRemoveRMC, showRenameRMC

Fields inherited from class com.microstrategy.web.app.transforms.AbstractReportDataTransform

_blankImage, _cssBottom, _cssCenter, _cssLeft, _cssRight, _cssTop, _ifLeftArrowImage, _ifRightArrowImage, advancedDrillingContextMenuDisplay, BLANK_SUBSET_REPORT_ID, cssBottom, cssCenter, cssLeft, cssRight, cssTop, customJavaScriptFeatures, drillRetainThresholds, drillWithinBehavior, gridGraphUnitKeyContext, groupContextMenuDrillPathsByType, hasIncreFetchForColumnOnLeft, hasIncreFetchForColumnOnRight, id, ifLeftArrowImage, ifRightArrowImage, incrementalFetchStyleForRow, quickSwitch, quickSwitchCurrent, rwbViewerID, showDrillPathSetNamesSubMenuAtTopLevel, showIncreFetchForColumn, showIncreFetchForRowOnBottom, showIncreFetchForRowOnTop, showSubtitlePara, sortSetNamesAndDrillPaths, transformContext, uniqueReportId

Fields inherited from class com.microstrategy.web.app.transforms.AbstractReportTransform

BLANK_XDA_REPORT_ID, cssErrorMessage, cssErrorTitle, cssUseFileContent, generateJSForDrillCheckBoxesForIncFetch, iFramePara, imgError, showScroller, useBuiltInFormatPara

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

Method Summary

Modifier and Type	Method	Description
protected void	addApplicableAttributesRow(WebRow row, java.util.Map attributes)
protected java.lang.String	getCSSInformation(WebCSSHelper cssHelper)
void	initializeProperties()	Extends initializeProperties by invoking initializeTranformContext

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

getAttributesBoneDiv, getAttributesGridTable, getLockHeaderTag, initializeTransform, renderLockHeadersInfo, updateDynamicScriptFileInformation

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

generateJavaScriptForOutlineMode, getAttributesRow, getCurrentHeader, getDescription, getResultSetStartRow, initializeImages, isSubtotal, newRowHeader, newRowTitle, newRowTitle, renderGridData, renderJavascript, renderOutlineModeLevels, renderRowTitle

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

buildDNDForEmptyGrid, canAddThresholds, canDrill, canFilterOn, canFormat, canInsertShortcutMetric, canModifyAttributeForm, canPivot, canRemoveFromGrid, canRemoveFromReport, canRename, canResize, canSort, checkAndRenderEmptyRowHeader, checkAndRenderExtraColumn, containerHeight, containerWidth, generateGridTable, generateJavaScriptForDrill, generateJavaScriptForResizeColumns, generateJSForDrillCheckBoxesForIncFetch, generatePreHTMLForResizeColumns, generateReportGridTable, getAdvancedDrillEvent, getAdvancedDrillProcessEvent, getAttributesEmptyGridTable, getColTitleCount, getColTitleSpan, getContextMenuManager, getContextMenuManagerName, getCssGrid, getDerivedElementsEvent, getDrillEditorProcessEvent, getDrillEvent, getDrillFilterOnSelectionEvent, getExtraColumn, getOpenAccordionEvent, getOpenObjectBrowserEvent, getRenameEvent, getRwdDrillOutEvent, getRWGridGraphDef, getSortEvent, getSubtitlesCount, hasCenter, heightMode, initializeTranformContext, isDesignMode, isDrillRMCAvailableForMetricValue, isLockedHeaders, isReportTruncated, isSpecifyIdForTitleCell, isSpecifyWidthForCell, mergeColHeader, newColHeader, newColHeader, newColHeader, newColTitle, newColTitle, newColTitle, newColTitle, newColTitle, newColTitle, newColTitle, newColTitle, newColTitle, newEmptyColHeader, newEmptyMetricValue, newEmptyRowHeader, newEmptyRowHeader, newEmptyRowTitle, newGridHeader, newGridTitle, newMetricValue, newMetricValue, newRowHeader, newRowHeader, newRowTitle, newRowTitle, newRowTitle, newRowTitle, newRowTitle, newRowTitle, newRowTitle, newRowTitle, newRowTitle, onColumnHeader, onColumnTitle, onMetricValue, onRowEnd, onRowEnd, onRowHeader, onRowStart, onRowStart, onRowTitle, overflowMode, renderBottom, renderCenter, renderColTags, renderColTagsHtml, renderColumnHeader, renderColumnHeaders, renderColumnTitle, renderColumnTitle, renderColumnTitles, renderContextMenus, renderCssLink, renderCubeReportMessage, renderCustomGroups, renderData, renderData, renderDatamartMessage, renderDropZones, renderEmptyCase, renderEmptyGrid, renderEmptyGridRows, renderEmptyMessage, renderExtraRowHeader, renderFirstSingleRow, renderGrid, renderGridData, renderGridHeaders, renderGridHeaders, renderGridTitles, renderIncRefresReportMessage, renderLayout, renderLayout, renderMaxRowsLimitMessage, renderMetricValue, renderMetricValues, renderNonViewableMessage, renderRegisterBone, renderRowHeader, renderRowHeader, renderRowHeaders, renderRowHeaders, renderRowTitles, renderRowTitlesAccessibility, renderSingleRow, renderSingleRow, setBoneProperties, showColHeaders, showEmptyAxis, showEmptyAxisCssLink, showEmptyColAxis, showEmptyMetricAxis, showEmptyRowAxis, showRowHeaders, widthMode

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

generateJavaScriptForDragAndDrop, getCssPrefix, getDesignMode, getGridCell, getGridCellColHeader, getGridCellColTitle, getGridCellMetricValue, getGridCellRowHeader, getGridCellRowTitle, getGridGenericCell, initGridCellClasses, initializeCellClasses, isContextMenuEnabled, isDragAndDropEnabled, isGraphTransform, isGridTransform, setGridCellClass, setGridCellClass, showFormattingRMC, showPivot, showPivotRMC, showRemove, showRemoveRMC, showRenameRMC

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

createBlockEditorProperties, createBlockEditorProperties, generatePageHistoryItems, getAttributesShellDiv, getBeanPath, getBoneId, getDisplayMode, getFrameBean, getGridData, getGridScriptClass, getGridWidths, getID, getMetricAxisName, getReportSetting, getTransformContext, getViewBean, getWebTemplate, hasBottom, hasLeft, hasRight, hasTop, initializeCss, initializeWebComponent, isCalledFromPrinting, isGridEmpty, isQuickSwitchEnabled, isRWBean, renderContent, renderIncreFetchOnColumnLeftPart, renderIncreFetchOnColumnRightPart, renderIncreFetchOnRow, renderLeft, renderRight, renderRowsIncrementalFetch, renderTop, shouldRenderGridInfo, showSubtitle, showSubtitle, showSubTitleOnly, supports, supports, transformForRequestSuccessful

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

canTransform, generateAnchor, generateErrorForIframe, generateErrorForIframe, generateIncFetchAnchor, generateIncFetchOpenAnchor, getCancelEvent, getContinueEvent, getErrorMessage, getErrorTitle, getHistoryListEvent, getInboxSource, getJobExpiredMessage, getNextColumnsEvent, getPreviousColumnsEvent, getReexecuteButtonDescription, getReportBean, getReportStatus, getReportStatusDescriptorKey, getRepromptEvent, getSupportedBeanType, getViewDetailsEvent, getWebReexecuteEvent, isCubeReport, isDatamart, isIFrameEnabled, isIncRefreshReport, isNonViewableReport, renderColumnsIncrementalFetch, renderColumnsIncrementalFetchNext, renderColumnsIncrementalFetchPrevious, renderContinueFormForRequestInError, renderErrorButtons, renderErrorInfo, renderHistoryListButton, renderImage, renderJobExpiredSection, renderProcessingButtons, renderProcessingInfo, renderProcessingInfoDetails, renderViewDetailsButton, setWebReexecuteEventArguments, transformForRequestInError, transformForRequestNotInited, useBuiltInFormat

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

getReexcuteEventFromBean, getTaskProcessorBaseURL

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

addContactInfo, addDynamicScriptClass, addDynamicScriptFile, addFormalParameter, checkLevel, checkProcessingButtonsFlag, checkProcessingInfoFlag, checkStatus, displayError, displayError, displayError, emptyCell, excludeStaticTags, generateAnchorForExport, generateHiddenInputsForEvent, generateIFrameTag, getAppContext, getArgumentName, getClientSideHelper, getContainerServices, getContext, getContextMenu, getContextMenusDefinition, getDateFormat, getDebugOut, getDescriptor, getDescriptor, getDescriptor, getDescriptor, getDisplayMode, getDisplayName, getErrorMessage, getErrorTitle, getEventManager, getFirstDayOfWeek, getFloatValue, getHelpPath, getIntValue, getJSNameSpace, getLayoutContext, getLocale, getLocale, getPreferenceValue, getProjectID, getRefreshEvent, getRequestKeys, getResourcesFolder, getScriptClass, getStringValue, getStyleRequestContext, getStyleShellDiv, getTagsFactory, getTimeFormat, getUnitsLabel, getWebBeanErrorInfo, hasSubBlock, initHeightAndWidthFromPreferences, is508, isBlockMode, isContextMenusEnabled, isDhtml, isDialog, isDormant, isFeatureAvailable, isIFrameDisplayMode, isIFrameRequest, isJobExpired, isModal, isOpen, isPortlet, isTrue, localIsIFrameDisplayMode, newContext, newHiddenInputBuilder, newNamespaceEncoder, newURIBuilder, redirectToDisplayError, renderBean, renderBean, renderBean, renderBean, renderCancelButton, renderDescriptor, renderDescriptor, renderErrorButton, renderHiddenInputFromRequest, renderLayout, renderProcessingButton, renderProcessingButton, renderProcessingButton, renderProcessingButtonForGet, renderProcessingButtonForGet, renderProcessingInfoData, renderProcessingInfoImage, renderProcessingInfoSubtitle, renderProcessingInfoTitle, renderProcessingObjectName, renderRefreshButton, renderSelf, renderShell, renderSubBlock, renderUserHelpAnchor, setDisplayMode, setHasSubBlock, setHeight, setIFrameDisplayMode, setIsDormant, setRenderSubBlock, setShellAttributeOnClosedComponent, setWidth, shouldDisplay, transform, transformForRequestCanceled, transformForRequestProcessing, transformForRequestWaitingForUserInput

Methods inherited from class com.microstrategy.web.transform.AbstractLayoutTransform

getLayoutDefinition, setLayoutDefinition, transformUsingLayout

Methods inherited from class com.microstrategy.web.transform.AbstractTransform

addFormalParam, getEvents, getFormalParams, getPreview, isPreviewAvailable, isResolved, removeFormalParam, setAnnotation, setDeprecated

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, getPreview, getSupportedBeanType, isPreviewAvailable, isResolved, transform

Field Detail

addExcelFormatInfo

protected FormalParameter addExcelFormatInfo

Determines whether to add the number formatting information for Excel.
It should be of BOOLEAN type.

forceMetricValuesAsTextForExcel

protected FormalParameter forceMetricValuesAsTextForExcel

Determines whether to force the metric values to be text for Excel.
It should be of BOOLEAN type.

forceHeadersAndTitlesAsTextForExcel

protected FormalParameter forceHeadersAndTitlesAsTextForExcel

Determines whether to force the headers and titles to be text for Excel.
It should be of BOOLEAN type.

addExcelOutlineInfo

protected FormalParameter addExcelOutlineInfo

Determines whether to add properties to the report rows of outline reports to be displayed as outline mode in Exporting to Excel.
Allowed Values: TRUE/FALSE.

Constructor Detail

ReportOutlineModeExcelTransform

public ReportOutlineModeExcelTransform()

Method Detail

initializeProperties

public void initializeProperties()

Description copied from class: AbstractReportDataTransform

Extends initializeProperties by invoking initializeTranformContext

Overrides:

initializeProperties in class ReportOutlineModeTransformImpl

getCSSInformation

protected java.lang.String getCSSInformation(WebCSSHelper cssHelper)

Overrides:

getCSSInformation in class ReportGridTransformImpl

addApplicableAttributesRow

protected void addApplicableAttributesRow(WebRow row,
                                          java.util.Map attributes)

Overrides:

addApplicableAttributesRow in class ReportOutlineModeTransformImpl