Class ReportOutlineModeTransformImpl
- 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
-
- All Implemented Interfaces:
AppTransform
,ReportDataTransform
,LayoutTransform
,Transform
- Direct Known Subclasses:
AbstractReportOutlineModeExportTransform
public class ReportOutlineModeTransformImpl extends ReportGridTransformImpl
Title: ReportOutlineModeTransformImpl.
The ReportOutlineModeTransformImpl generates the grid visualization of the data returned by a Report. As opposed to the
ReportGridTransformImpl
, the data is displayed in outline mode, for example:Region Category Subcategory Quarter Q1 03 Q2 03 Q3 03 Q4 03 Metrics Profit Forecast Profit Forecast Profit Forecast Profit Forecast [-] Northwest [-] Electronics Audio Equipment $2,727 $5,770 $3,489 $6,230 Cameras $7,212 $11,745 $8,819 $11,556 TV's $1,808 $4,190 $2,428 $4,001 [-] Movies Drama $1,140 $1,867 $1,497 $2,157 Special Interests $613 $1,125 $658 $1,092 [-] Music Pop $649 $959 $628 $1,266 Soul / R&B $549 $1,040 $690 $1,166 [-] Southwest [-] Electronics Audio Equipment $5,754 $9,291 $6,669 $13,134 Cameras $12,125 $25,268 $17,725 $26,134 TV's $4,508 $7,359 $4,863 $9,169 [-] Movies Drama $2,030 $3,693 $2,629 $4,927 Special Interests $1,169 $1,807 $1,302 $2,290 [-] Music Pop $930 $2,041 $1,182 $2,229 Soul / R&B $1,009 $1,928 $1,375 $2,376 For the data to be displayed correctly, the report data must come already
"indented"
. This happens by setting the"Indented"
property in the"Template Formatting"
property set of the template extended properties.- Since:
- MicroStrategy Web 7.3.1 or earlier
-
-
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
cssOutlineModeContractImage
Deprecated.css formatting should now be applied through the layout-xml.protected FormalParameter
cssOutlineModeExpandImage
Deprecated.css formatting should now be applied through the layout-xml.protected FormalParameter
cssOutlineModeLevelCell
Deprecated.css formatting should now be applied through the layout-xml.protected FormalParameter
cssOutlineModeLevelTable
Deprecated.css formatting should now be applied through the layout-xml.protected FormalParameter
imgOutlineContract
This is the image name for collapsing the Outline Mode grid data.protected FormalParameter
imgOutlineExpand
This is the image name for expanding the Outline Mode grid data.protected FormalParameter
outlineModeDefaultLevelMax
Deprecated.This parameter is not used anymore.protected FormalParameter
outlineModeLevelTableID
Deprecated.This parameter is not used anymore.protected FormalParameter
outlineModeState
This is an XML representation of the outline mode expansion state.protected FormalParameter
outlineModeSupressDuplicateSubTotals
If this is set to true we will supress the duplication of sub totals in outline mode except for the case when the metrics are on the rows.protected FormalParameter
staticOutlineMode
This will indicate if we want a static or non static outline mode.protected FormalParameter
useImagesForOutlineMode
If this is set to true we will use the contract and expand images to denote outline mode, if set to false we will use text to display those states.-
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 ReportOutlineModeTransformImpl()
default no-args constructor.
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description protected void
addApplicableAttributesRow(WebRow row, java.util.Map attributes)
protected void
generateJavaScriptForOutlineMode(MarkupOutput out, ReportBean rb)
Deprecated.This method has been deprecated and will be removed in future versions of the product.protected java.util.Map
getAttributesRow(WebRow row)
Generates the list of attributes used by <tr> of a single row.protected WebHeader
getCurrentHeader()
java.lang.String
getDescription()
Returns a textual description of this transform to be used in WYSIWYG tools.protected int
getResultSetStartRow()
void
initializeImages()
initialize the images for the transform.void
initializeProperties()
ExtendsinitializeProperties
by invokinginitializeTranformContext
protected boolean
isSubtotal(WebHeader header)
Returnstrue
if the givenWebHeader
corresponds to a subtotal.ReportGridCellRowHeader
newRowHeader(WebHeader wh)
Creates and initialize a newReportGridCellRowHeader
with the given parameters.ReportGridCellRowTitle
newRowTitle(WebTitle title, int subTitleIndex)
Creates and initialize a newReportGridCellRowTitle
with the given parameters.ReportGridCellRowTitle
newRowTitle(WebTitle title, WebSubTitle subTitle, int subTitleIndex)
Creates and initialize a newReportGridCellRowTitle
with the given parameters.void
renderGridData(MarkupOutput out, boolean includeMetricValues)
Generates the data content of the grid, this includes both Row headers and metric values.protected void
renderJavascript(MarkupOutput out)
This method renders the javascript code that needs to be generated on the server side because its content is dynamic.void
renderOutlineModeLevels(MarkupOutput out, ReportBean rb)
Deprecated.This method is not used by Microstrategy Web.void
renderRowTitle(MarkupOutput out, ReportBean rb, WebTitle title)
Renders a single rowTitle.protected void
updateDynamicScriptFileInformation()
-
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, getAttributesBoneDiv, getAttributesEmptyGridTable, getAttributesGridTable, getColTitleCount, getColTitleSpan, getContextMenuManager, getContextMenuManagerName, getCssGrid, getCSSInformation, getDerivedElementsEvent, getDrillEditorProcessEvent, getDrillEvent, getDrillFilterOnSelectionEvent, getExtraColumn, getLockHeaderTag, getOpenAccordionEvent, getOpenObjectBrowserEvent, getRenameEvent, getRwdDrillOutEvent, getRWGridGraphDef, getSortEvent, getSubtitlesCount, hasCenter, heightMode, initializeTranformContext, initializeTransform, 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, renderLockHeadersInfo, 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
-
imgOutlineExpand
protected FormalParameter imgOutlineExpand
This is the image name for expanding the Outline Mode grid data.
Allowed Values: The value to indicate should be a valid image file name, with any necessary path information not included already on theresourcesFolderImage
application configuration parameter.
-
imgOutlineContract
protected FormalParameter imgOutlineContract
This is the image name for collapsing the Outline Mode grid data.
Allowed Values: The value to indicate should be a valid image file name, with any necessary path information not included already on theresourcesFolderImage
application configuration parameter.
-
outlineModeDefaultLevelMax
protected FormalParameter outlineModeDefaultLevelMax
Deprecated.This parameter is not used anymore.If this value is set to true the default level at which any newly run report wil open for outline mode will be maximum expanded.
If it is false, the default will be fully collapsed.
This property will be used only if the report property denoting the outline mode level is not present.
Allowed Values: String values.
-
outlineModeLevelTableID
protected FormalParameter outlineModeLevelTableID
Deprecated.This parameter is not used anymore.This is the ID for the table used to show the outline mode levels at the top of the report.
Allowed Values: String value representing an ID.- Since:
- MicroStrategy Web 7.5.0
-
cssOutlineModeLevelTable
protected FormalParameter cssOutlineModeLevelTable
Deprecated.css formatting should now be applied through the layout-xml.This is the css name for the table used to show the outline mode levels at the top of the report.
Allowed Values: String value representing a css class name. It should be defined in a css file included in the page.
-
cssOutlineModeLevelCell
protected FormalParameter cssOutlineModeLevelCell
Deprecated.css formatting should now be applied through the layout-xml.This is the css name for the cells used to show the outline mode levels at the top of the report.
Allowed Values: String value representing a css class name. It should be defined in a css file included in the page.
-
cssOutlineModeExpandImage
protected FormalParameter cssOutlineModeExpandImage
Deprecated.css formatting should now be applied through the layout-xml.This is the css name for the expand image used in the outline mode grid display.
Allowed Values: String value representing a css class name. It should be defined in a css file included in the page.
-
cssOutlineModeContractImage
protected FormalParameter cssOutlineModeContractImage
Deprecated.css formatting should now be applied through the layout-xml.This is the css name for the contract image used in the outline mode grid display.
Allowed Values: String value representing a css class name. It should be defined in a css file included in the page.
-
outlineModeSupressDuplicateSubTotals
protected FormalParameter outlineModeSupressDuplicateSubTotals
If this is set to true we will supress the duplication of sub totals in outline mode except for the case when the metrics are on the rows.
Allowed Values: boolean true or false.- Since:
- MicroStrategy Web 7.5.0
-
useImagesForOutlineMode
protected FormalParameter useImagesForOutlineMode
If this is set to true we will use the contract and expand images to denote outline mode, if set to false we will use text to display those states.
Allowed Values: boolean true or false.- Since:
- MicroStrategy Web 7.5.1
-
outlineModeState
protected FormalParameter outlineModeState
This is an XML representation of the outline mode expansion state.
Allowed Values: String with an XML representation of the outline mode expansion state.- Since:
- MicroStrategy Web 8.0.0
-
staticOutlineMode
protected FormalParameter staticOutlineMode
This will indicate if we want a static or non static outline mode.
In static outline mode we will not execute or render any of the Javascript associated with outline mode. In HTML mode the oultine mode transform will always be static irrespective of the value of this formal parameter. Allowed Values: true or false.- Since:
- MicroStrategy Web 8.0.0
-
-
Method Detail
-
getDescription
public java.lang.String getDescription()
Description copied from class:ReportGridTransformImpl
Returns a textual description of this transform to be used in WYSIWYG tools.- Specified by:
getDescription
in interfaceTransform
- Overrides:
getDescription
in classReportGridTransformImpl
- Returns:
- "The ReportGridTransformImpl generates the grid visualization of the data returned by a Report.";
-
initializeProperties
public void initializeProperties()
Description copied from class:AbstractReportDataTransform
ExtendsinitializeProperties
by invokinginitializeTranformContext
- Overrides:
initializeProperties
in classReportGridTransformImpl
-
initializeImages
public void initializeImages()
Description copied from class:AbstractReportTransform
initialize the images for the transform.- Overrides:
initializeImages
in classAbstractReportGridTransform
-
renderGridData
public void renderGridData(MarkupOutput out, boolean includeMetricValues)
Description copied from class:ReportGridTransformImpl
Generates the data content of the grid, this includes both Row headers and metric values.
TheincludeMetricValues
argument controls whether the metric values will be included in the output. The purpose of not including metric values is for situations when we would like to generate only the row axis and no data (internally used for lock headers).- Overrides:
renderGridData
in classReportGridTransformImpl
- Parameters:
out
- MarkupOutput to generate the HTML.includeMetricValues
- whether to include metric values or not- Since:
- MicroStrategy Web 8.0.0
-
isSubtotal
protected boolean isSubtotal(WebHeader header)
Returnstrue
if the givenWebHeader
corresponds to a subtotal.- Since:
- MicroStrategy Web 8.0.1
-
renderJavascript
protected void renderJavascript(MarkupOutput out)
Description copied from class:ReportGridTransformImpl
This method renders the javascript code that needs to be generated on the server side because its content is dynamic. It extendsrenderJavascript
by including control variables that informs the browser the grid status, and context (or right-mouse-click) menus.- Overrides:
renderJavascript
in classReportGridTransformImpl
- Parameters:
out
- MarkupOutput to generate the HTML.- Since:
- MicroStrategy Web 8.0.0
-
generateJavaScriptForOutlineMode
protected void generateJavaScriptForOutlineMode(MarkupOutput out, ReportBean rb)
Deprecated.This method has been deprecated and will be removed in future versions of the product. It is expected that these control variables will be part of the grid's bone.Generates the javascript control variables used with the outline mode feature.- Parameters:
out
- MarkupOutput to generate the HTML.rb
- ReportBean being transformed (ignored, always uses the bean passed to theinitializeTransform
method).
-
renderRowTitle
public void renderRowTitle(MarkupOutput out, ReportBean rb, WebTitle title)
Renders a single rowTitle.
Basically, it creates a newReportGridCellRowTitle
using thenewRowTitle
method, and callsonRowTitle
.
Extendssuper.renderRowTitle
by merging the subtitles cells into one single cell (when outline mode is on, each attribute is displayed in only one column, regardless of how many attribute forms are being displayed).- Overrides:
renderRowTitle
in classReportGridTransformImpl
- Parameters:
out
- MarkupOutput to generate the HTML.rb
- ReportBean being transformed (ignored, always uses the bean passed to theinitializeTransform
method).title
- the corresponding WebTitle
-
renderOutlineModeLevels
public void renderOutlineModeLevels(MarkupOutput out, ReportBean rb)
Deprecated.This method is not used by Microstrategy Web. If you need to generate these buttons you may callReportToolbarTransform.renderOutlineModeLevels(com.microstrategy.web.beans.MarkupOutput)
directly.Generates the HTML for the buttons that changes the current grid's expanded level.
Out of the box, this is actually rendered by theReportToolbar
, specifically by theReportToolbarTransform.renderOutlineModeLevels(com.microstrategy.web.beans.MarkupOutput)
method.- Parameters:
out
- MarkupOutput to generate the HTML.rb
- ReportBean being transformed (ignored, always uses the bean passed to theinitializeTransform
method).
-
getResultSetStartRow
protected int getResultSetStartRow()
- Returns:
- int the result window first row number.
- Since:
- MicroStrategy Web 8.0.0
-
getCurrentHeader
protected WebHeader getCurrentHeader()
- Since:
- MicroStrategy Web 9.0.0
-
addApplicableAttributesRow
protected void addApplicableAttributesRow(WebRow row, java.util.Map attributes)
- Since:
- MicroStrategy Web 9.0.0
-
getAttributesRow
protected java.util.Map getAttributesRow(WebRow row)
Description copied from class:ReportGridTransformImpl
Generates the list of attributes used by <tr> of a single row.- Overrides:
getAttributesRow
in classReportGridTransformImpl
- Parameters:
row
- the corresponding WebRow- Returns:
- Map with the Attributes to use
- Since:
- MicroStrategy Web 8.0.0
-
newRowHeader
public ReportGridCellRowHeader newRowHeader(WebHeader wh)
Description copied from class:ReportGridTransformImpl
Creates and initialize a newReportGridCellRowHeader
with the given parameters.- Overrides:
newRowHeader
in classReportGridTransformImpl
- Since:
- MicroStrategy Web 8.0.0
-
newRowTitle
public ReportGridCellRowTitle newRowTitle(WebTitle title, WebSubTitle subTitle, int subTitleIndex)
Description copied from class:ReportGridTransformImpl
Creates and initialize a newReportGridCellRowTitle
with the given parameters.- Overrides:
newRowTitle
in classReportGridTransformImpl
- Since:
- MicroStrategy Web 8.1.2
-
newRowTitle
public ReportGridCellRowTitle newRowTitle(WebTitle title, int subTitleIndex)
Description copied from class:ReportGridTransformImpl
Creates and initialize a newReportGridCellRowTitle
with the given parameters.- Overrides:
newRowTitle
in classReportGridTransformImpl
-
updateDynamicScriptFileInformation
protected void updateDynamicScriptFileInformation()
- Overrides:
updateDynamicScriptFileInformation
in classReportGridTransformImpl
-
-