Class ReportGridTransformImpl
- 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
-
- All Implemented Interfaces:
AppTransform,ReportDataTransform,LayoutTransform,Transform
- Direct Known Subclasses:
AbstractReportGridExportTransform,IPhoneReportGridTransformImpl,ReportDesignModeTransformImpl,ReportOutlineModeTransformImpl
public class ReportGridTransformImpl extends AbstractReportGridTransform
The ReportGridTransformImpl generates the grid visualization of the data returned by a Report.
Take as example the following table: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,737 $4,795 $3,351 $7,064 Northwest Electronics Cameras $7,368 $11,930 $8,441 $11,252 Northwest Electronics TV's $1,680 $4,239 $2,278 $3,778 Northwest Movies Drama $1,114 $1,817 $1,361 $2,232 Northwest Movies Special Interests $598 $1,167 $643 $1,078 Northwest Music Pop $635 $978 $626 $1,158 As with any other Transforms, the output can be customized by extending public or protected render methods. In particular, this Transform defines 3 main public methods:
renderGrid(MarkupOutput): which generates the whole grid, and calls:renderGridHeaders(MarkupOutput): which generates the top section:
Region Category Subcategory Quarter Q1 03 Q2 03 Q3 03 Q4 03 Metrics Profit Forecast Profit Forecast Profit Forecast Profit Forecast
renderGridData(MarkupOutput): which generates the bottom section:
Northwest Electronics Audio Equipment $2,737 $4,795 $3,351 $7,064 Northwest Electronics Cameras $7,368 $11,930 $8,441 $11,252 Northwest Electronics TV's $1,680 $4,239 $2,278 $3,778 Northwest Movies Drama $1,114 $1,817 $1,361 $2,232 Northwest Movies Special Interests $598 $1,167 $643 $1,078 Northwest Music Pop $635 $978 $626 $1,158
This Transform allows to customize the content of every cell, for this reason, this content is not generated internally, but is delegated to a class that implements the
ReportGridDisplayCellinterface.
When therenderGridmethod is invoked, the Transform starts iterating through the grid's data. For each cell that it identifies needs to be rendered, it creates a differentReportGridDisplayCelland initializes it with the corresponding information. Depending on the cell type, an specializedReportGridDisplayCellis created with the relevant data. There are five types of cells:- row titles (
ReportGridCellRowTitle)Region - column titles (
ReportGridCellColTitle)Quarter - row headers (
ReportGridCellRowHeader)Northwest - column headers (
ReportGridCellColHeader)Q4 03 - metric values (
ReportGridCellMetricValue)$7,368
The implementation class to use for each of these cells is controlled through a configuration file. The name and location of the file to be used by the Transform is specified in the
AbstractReportGridTransform.gridClassesConfFile. Developers then, can create their own implementation of these classes (or extend the default ones) that modifies the cell output.In the report page, this Transform is also responsible for generating the incremental fetch links for both, columns and rows. This functionality is inherited from
AbstractReportDataTransform- Since:
- MicroStrategy Web 7.3.1 or earlier
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description classReportGridTransformImpl.ContextExtendsAbstractAppTransform.Context.
-
Field Summary
Fields Modifier and Type Field Description protected com.microstrategy.web.app.transforms.SharedCellProperties_sharedCellPropertiesprotected FormalParametercontainerHeightSpecifies the height (in any measure accepted by the web-browser) of the <div> tag enclosing the grid's table.protected FormalParametercontainerWidthSpecifies the width (in any measure accepted by the web-browser) of the <div> tag enclosing the grid's table.protected FormalParametercssParentFontSizeThis is the report's base font size.protected FormalParametercssPathParameterDetermines the CSS class path to for all CSS classes in a grid report.protected FormalParametercssUseRelativeFontDetermines whether to use relative font for the CSS.protected FormalParameterdpiConversionIndicates the dpi conversion factor to convert between inches and pixels (inches=pixels/dpiConversion).protected FormalParameterdrillLinkExtraURLThis is the code which we will append with the drill hyperlink tag for DHTML.protected FormalParameterdrillRetainParentThis is the FP which tells whether to retain the parent while drilling.static java.lang.StringFP_IS_HTML_EXPORTprotected FormalParameterheaderMetricValueOptimizedThis is the parameter which decides if we move the common html attributes of non-metric headers and metric value cells to a map and is thus stored once.protected FormalParameterheightModeDetermines whether the <div> tag enclosing the grid should have a fixed height, or should expand to fit the height of the grid's content.protected FormalParameterhideMetricsLabelHides the 'Metrics' label on the grid's titles.protected FormalParameterignoreSubtotalIt is used in the transform to specify whether to display subtotal cells.protected FormalParameterimgActiveSortAscThis is the image name for showing the active sort icon for ascending values.protected FormalParameterimgActiveSortDescThis is the image name for showing the active sort icon for descending values.protected FormalParameterimgInActiveSortAscThis is the image name for showing the inactive sort icon for ascending values.protected FormalParameterimgInActiveSortDescThis is the image name for showing the inactive sort icon for descending values.protected FormalParameterisHTMLExportprotected ReportGridCellRowTitlelastRowTitleprotected FormalParametermaxSortAllowedThis is the value used in the transform to specify how many nested sorts will be allowed in the report.protected FormalParametermergeColHeaderParaIt is used in the transform to specify merge or repeat column headers.protected FormalParameteroverflowModeIf thewidthModeorheightModeis set to be fixed, this parameter specifies what should happen with the <div>'s content if it overflows the space specified by thecontainerHeightorcontainerWidthparameters.protected FormalParametershowBandingParaIt is used in the transform to specify whether to show banding.protected FormalParametershowDrillAdvancedIt is used in the transform to specify whether to allow advanced drilling.protected FormalParametershowDrillCheckBoxIt is used in the transform to specify whether to allow select filter - check box drilling.protected FormalParametershowDrillDownOnlyIt is used in the transform to specify whether to allow drilling to the child only.protected FormalParametershowDrillHyperlinkIt is used in the transform to specify whether to allow hyperlink drilling.protected FormalParametershowDrillHyperlinkMetricIt is used in the transform to specify whether to allow hyperlink drilling for metrics.protected FormalParametershowDrillMetricIt is used in the transform to specify whether to allow drilling on metrics.protected FormalParametershowDrillRMCIt is used in the transform to specify whether to show Right Mouse Click menu for drill.protected FormalParametershowDrillRMCMetricIt is used in the transform to specify whether to show Right Mouse Click menu for drill for metrics.protected FormalParametershowFilterOnSelectionCheckBoxIt is used in the transform to specify whether to allow filter on selection.protected FormalParametershowSortButtonsForAttributesThis is the flag used in the transform to specify whether to show sort buttons for attributes (row titles).protected FormalParametershowSortButtonsForMetricsThis is the flag used in the transform to specify whether to show sort buttons for metrics (column headers).protected FormalParametershowSortRMCForAttributesThis is the flag used in the transform to specify whether to show sort right mouse click menu for attributes (row titles).protected FormalParametershowSortRMCForMetricsThis is the flag used in the transform to specify whether to show sort right mouse click menu for metrics (column headers).protected FormalParametershowUniqueDrillPathsIt is used in the transform to specify whether to show unique drill paths on context menus.protected FormalParameteruseImageOnEmptyCellsIt is used in the transform to specify the use of transparent image on empty metric cells.protected FormalParameterwidthModeDetermines whether the <div> tag enclosing the grid should have a fixed width, or should expand to fit the width of the grid's content.protected FormalParameterwrapMetricValueThis is the parameter which decides if we wrap the metric values cells when displaying the report.protected FormalParameterwrapRowHeaderThis is the parameter which decides if we wrap the row header cells when displaying the report.protected FormalParameterzoomFactorIndicates the zoom factor to use for adjusting sizes.-
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 ReportGridTransformImpl()Default no-args constructor.
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description protected voidbuildDNDForEmptyGrid(MarkupOutput out)Deprecated.This method is not called anymore and it doesn't generate any HTML.booleancanAddThresholds()Utility method for determining if all the privileges are enabled for displaying the user the option to add thresholds to current element from the gridbooleancanDrill()Utility methood for determining if all the privileges are enabled for displaying the user the option to drill on one element from the gridbooleancanFilterOn()Utility methood for determining if all the privileges are enabled for displaying the user the option to filter on one element from the gridbooleancanFormat()Utility methood for determining if all the privileges are enabled for displaying the user the option to format one element from the gridbooleancanInsertShortcutMetric()Utility methood for determining if all the privileges are enabled for displaying the user the option to insert shortcut metrics on the gridbooleancanModifyAttributeForm()Utility methood for determining if all the privileges are enabled for displaying the user the option to modify the attribute forms on one element from the gridbooleancanPivot()Utility methood for determining if all the privileges are enabled for displaying the user the option to pivot one element from the gridbooleancanRemoveFromGrid()Utility methood for determining if all the privileges are enabled for displaying the user the option to remove one element from the gridbooleancanRemoveFromReport()Utility methood for determining if all the privileges are enabled for displaying the user the option to remove one element from the reportbooleancanRename()Utility methood for determining if all the privileges are enabled for displaying the user the option to rename one element from the gridbooleancanResize()Utility methood for determining if allowing users to resize columns of a linked template in rwdbooleancanSort()Utility methood for determining if all the privileges are enabled for displaying the user the option to sort on one element from the gridprotected voidcheckAndRenderEmptyRowHeader(MarkupOutput out)Renders the drag and drop zone as the empty row header at the left hand side of the gridprotected voidcheckAndRenderExtraColumn(MarkupOutput out)protected java.lang.StringcontainerHeight()Returns the value of thecontainerWidthformal parameter (in pixels).protected java.lang.StringcontainerWidth()Returns the value of thecontainerWidthformal parameter (in pixels).protected TaggenerateGridTable()Creates theTableTaginstance that is used for the table holding the report's data.protected voidgenerateJavaScriptForDrill(MarkupOutput out, ReportBean rb)Deprecated.This method has been deprecated and will be removed in future versions of the product.protected voidgenerateJavaScriptForResizeColumns(MarkupOutput out, ReportBean rb)Deprecated.This method has been deprecated and will be removed in future versions of the product.protected voidgenerateJSForDrillCheckBoxesForIncFetch(MarkupOutput out, ReportBean rb)Deprecated.This method has been deprecated and will be removed in future versions of the product.protected voidgeneratePreHTMLForResizeColumns(MarkupOutput out)Deprecated.This method is not called anymore and it doesn't generate any HTML.protected voidgenerateReportGridTable(MarkupOutput out, ReportBean rb, boolean specifyUniqueReportID)Deprecated.This method has been deprecated and will be removed in future versions of the product.WebEventgetAdvancedDrillEvent()WebEventgetAdvancedDrillProcessEvent()protected java.util.MapgetAttributesBoneDiv()Generates the list of attributes used by a div surrounding the grid.protected java.util.MapgetAttributesEmptyGridTable()Generates the list of attributes used by an empty grid's table.protected java.util.MapgetAttributesGridTable()Generates the list of attributes used by the grid's table.protected java.util.MapgetAttributesRow(WebRow row)Generates the list of attributes used by <tr> of a single row.protected intgetColTitleCount()protected intgetColTitleSpan()Returns how many columns, the title cell spans over.ContextMenuManagergetContextMenuManager()Returns theContextMenuManagerinstance used by this Transform.protected java.lang.StringgetContextMenuManagerName()Returns the name to use for theContextMenuManagerof this Transform.protected java.lang.StringgetCssGrid()Returns the css class to be used by the grid table.protected java.lang.StringgetCSSInformation(WebCSSHelper cssHelper)WebEventgetDerivedElementsEvent()java.lang.StringgetDescription()Returns a textual description of this transform to be used in WYSIWYG tools.WebEventgetDrillEditorProcessEvent()WebEventgetDrillEvent()WebEventgetDrillFilterOnSelectionEvent()protected booleangetExtraColumn()protected TaggetLockHeaderTag()Generate the lock header tag information for the grid.WebEventgetOpenAccordionEvent()Returns the event to open the accordion.WebEventgetOpenObjectBrowserEvent()Returns the event to open the ObjectBrowser.WebEventgetRenameEvent()WebEventgetRwdDrillOutEvent()protected RWGridGraphDefgetRWGridGraphDef()WebEventgetSortEvent()protected intgetSubtitlesCount(WebTemplateUnit unit)booleanhasCenter()Whether the transform has the center area.protected intheightMode()Deprecated.Please query directly theheightModeformal parameter insteadvoidinitializeProperties()ExtendsinitializePropertiesby invokinginitializeTranformContextvoidinitializeTranformContext()Deprecated.please use instead the ReportGridTransformImpl.Context instance as context.voidinitializeTransform(Transformable data)ExtendsinitializeTransformby initiliazing the grid cell classes by callinginitializeCellClassesprotected booleanisDesignMode()This methods allows the transform to identify if concrete subclasses are designed to work in design mode, or in execute mode.booleanisDrillRMCAvailableForMetricValue()Utility method to check if Drill RMC is available.protected booleanisLockedHeaders()booleanisReportTruncated()Returns the value ofgetReportBean().getReportData().isReportTruncated().protected booleanisSpecifyIdForTitleCell()protected booleanisSpecifyWidthForCell()protected booleanmergeColHeader()Deprecated.Please query directly themergeColHeaderParaformal parameter insteadReportGridCellColHeadernewColHeader()Creates and initialize a newReportGridCellColHeaderwith no underlying SDK object.ReportGridCellColHeadernewColHeader(WebHeader header)Creates and initialize a newReportGridCellColHeaderwith the given parameters.ReportGridCellColHeadernewColHeader(WebTemplateMetric metric)Creates and initialize a newReportGridCellColHeaderwith the given parameters.ReportGridCellColTitlenewColTitle()Creates and initialize a newReportGridCellColTitlewith no underlying SDK object.ReportGridCellColTitlenewColTitle(WebTemplateUnit unit)Creates and initialize a newReportGridCellColTitlewith the given parameters.ReportGridCellColTitlenewColTitle(WebTemplateUnit unit, int subtitleIndex)Creates and initialize a newReportGridCellColTitlewith the given parameters.ReportGridCellColTitlenewColTitle(WebTemplateUnit unit, WebAttributeForm form, int subtitleIndex)Creates and initialize a newReportGridCellColTitlewith the given parameters.ReportGridCellColTitlenewColTitle(WebTemplateUnit unit, WebAttributeForm form, int subtitleIndex, boolean showSubTitleOnly)Creates and initialize a newReportGridCellColTitlewith the given parameters.ReportGridCellColTitlenewColTitle(WebTitle title)Creates and initialize a newReportGridCellColTitlewith the given parameters.ReportGridCellColTitlenewColTitle(WebTitle title, int subTitleIndex)Creates and initialize a newReportGridCellColTitlewith the given parameters.ReportGridCellColTitlenewColTitle(WebTitle title, WebSubTitle subTitle, int subTitleIndex)Creates and initialize a newReportGridCellColTitlewith the given parameters.ReportGridCellColTitlenewColTitle(WebTitle title, WebSubTitle subTitle, int subTitleIndex, boolean showSubTitleOnly)Creates and initialize a newReportGridCellColTitlewith the given parameters.ReportGridCellColHeadernewEmptyColHeader()Create and initialize a newReportGridCellColHeaderwith a drop units here message with no underlying SDK object.ReportGridCellMetricValuenewEmptyMetricValue()Creates and initialize a newReportGridCellMetricValuewith a "drop objects here" message with no underlying SDK object.ReportGridCellRowHeadernewEmptyRowHeader()Create and initialize a newReportGridCellRowHeaderwith a "drop units here" message with no underlying SDK object.ReportGridCellRowHeadernewEmptyRowHeader(int rowSpan)Creates and returns an empty row header with the specified rowSpan.ReportGridCellRowTitlenewEmptyRowTitle()Creates and initialize a newReportGridCellRowTitlewith no underlying SDK object.protected ReportGridCellHeadernewGridHeader(WebHeader header, java.lang.String className)protected ReportGridCellTitlenewGridTitle(WebTitle title, java.lang.String className)ReportGridCellMetricValuenewMetricValue()Creates and initialize a newReportGridCellMetricValuewith no underlying SDK object.ReportGridCellMetricValuenewMetricValue(WebRowValue rowValue)Creates and initialize a newReportGridCellMetricValuewith the given parameters.ReportGridCellRowHeadernewRowHeader()Creates and initialize a newReportGridCellRowHeaderwith no underlying SDK object.ReportGridCellRowHeadernewRowHeader(WebHeader rowHeader)Creates and initialize a newReportGridCellRowHeaderwith the given parameters.ReportGridCellRowHeadernewRowHeader(WebTemplateMetric metric)Creates and initialize a newReportGridCellRowHeaderwith the given parameters.ReportGridCellRowTitlenewRowTitle()Creates and initialize a newReportGridCellRowTitlewith no underlying SDK object.ReportGridCellRowTitlenewRowTitle(WebTemplateUnit unit)Creates and initialize a newReportGridCellRowTitlewith the given parameters.ReportGridCellRowTitlenewRowTitle(WebTemplateUnit unit, int subtitleIndex)Creates and initialize a newReportGridCellRowTitlewith the given parameters.ReportGridCellRowTitlenewRowTitle(WebTemplateUnit unit, int subtitleIndex, boolean showSubTitleOnly)Creates and initialize a newReportGridCellRowTitlewith the given parameters.ReportGridCellRowTitlenewRowTitle(WebTemplateUnit unit, WebAttributeForm form, int subtitleIndex)Creates and initialize a newReportGridCellRowTitlewith the given parameters.ReportGridCellRowTitlenewRowTitle(WebTemplateUnit unit, WebAttributeForm form, int subtitleIndex, boolean showSubTitleOnly)Creates and initialize a newReportGridCellRowTitlewith the given parameters.ReportGridCellRowTitlenewRowTitle(WebTitle title)Creates and initialize a newReportGridCellRowTitlewith the given parameters.ReportGridCellRowTitlenewRowTitle(WebTitle title, int subTitleIndex)Creates and initialize a newReportGridCellRowTitlewith the given parameters.ReportGridCellRowTitlenewRowTitle(WebTitle title, int subTitleIndex, boolean showSubTitleOnly)Creates and initialize a newReportGridCellRowTitlewith the given parameters.ReportGridCellRowTitlenewRowTitle(WebTitle title, WebSubTitle subTitle, int subTitleIndex)Creates and initialize a newReportGridCellRowTitlewith the given parameters.ReportGridCellRowTitlenewRowTitle(WebTitle title, WebSubTitle subTitle, int subTitleIndex, boolean showSubTitleOnly)Creates and initialize a newReportGridCellRowTitlewith the given parameters.protected voidonColumnHeader(ReportGridCellColHeader cell, MarkupOutput out)This method is called when a column header needs to be rendered.protected voidonColumnTitle(ReportGridCellColTitle cell, MarkupOutput out)This method is called when a column title needs to be rendered.protected voidonMetricValue(ReportGridCellMetricValue cell, MarkupOutput out)This method is called when a metric value needs to be rendered.protected voidonRowEnd(MarkupOutput out)This method is called when row has finished.protected voidonRowEnd(WebRow row, MarkupOutput out)This method is called when row has finished.protected voidonRowHeader(ReportGridCellRowHeader cell, MarkupOutput out)This method is called when a row header needs to be rendered.protected voidonRowStart(MarkupOutput out)This method is called when a new row needs to be rendered.protected voidonRowStart(WebRow row, MarkupOutput out)This method is called when a new row needs to be rendered.protected voidonRowTitle(ReportGridCellRowTitle cell, MarkupOutput out)This method is called when a row title needs to be rendered.protected intoverflowMode()Returns the value of theoverflowModeformal parameter.voidrenderBottom(MarkupOutput out, ReportBean rb)Deprecated.This method has been deprecated and will be removed in future versions of the product.voidrenderCenter(MarkupOutput out, ReportBean rb)Deprecated.This method has been deprecated and will be removed in future versions of the product.voidrenderColTags(MarkupOutput out)Generates the HTML for <col> tags for the main table.protected voidrenderColTagsHtml(MarkupOutput out, int dpi, double zoom)Renders the col tags for a grid column widths.voidrenderColumnHeader(MarkupOutput out, ReportBean rb, WebHeader header)Renders a single column header.voidrenderColumnHeaders(MarkupOutput out, ReportBean rb, WebHeaders colHeaders)Renders the column headers of the report.voidrenderColumnTitle(MarkupOutput out, ReportBean rb, WebTitle title)Renders a single column title.voidrenderColumnTitle(MarkupOutput out, ReportBean rb, WebTitle title, int colSpan)voidrenderColumnTitles(MarkupOutput out, ReportBean rb, WebGridTitles colTitles)Deprecated.This method has been deprecated and will be removed in future versions of the product.protected voidrenderContextMenus(MarkupOutput out)Generates the HTML used for client-side context (right mouse click) menus.voidrenderCssLink(MarkupOutput out)ExtendsrenderCssLinkto generate the <style> tag necessary for this report's format.voidrenderCubeReportMessage(MarkupOutput out)Renders a message to the end user indicating that the results of the cube report has been published This method is called when the current report type isCube.protected voidrenderCustomGroups(MarkupOutput out, ReportGridCellRowTitle cell, int rowSpan)Renders custom groups on the grid template.voidrenderData(MarkupOutput out, ReportBean rb)Deprecated.This method has been deprecated and will be removed in future versions of the product.voidrenderData(MarkupOutput out, ReportBean rb, boolean renderMetricValues)Deprecated.This method has been deprecated and will be removed in future versions of the product.voidrenderDatamartMessage(MarkupOutput out)Renders a message to the end user indicating that the results of the report have been stored in a table.voidrenderDropZones(MarkupOutput out)voidrenderEmptyCase(MarkupOutput out, ReportBean rb)Deprecated.This method has been deprecated and will be removed in future versions of the product.voidrenderEmptyGrid(MarkupOutput out)Generates the HTML when the grid contains no data.protected voidrenderEmptyGridRows(MarkupOutput out)voidrenderEmptyMessage(MarkupOutput out)Generates the "no data" message for a grid.voidrenderExtraRowHeader(MarkupOutput out, WebHeader extraHeader, int rowSpan)Renders an extra row header.voidrenderFirstSingleRow(MarkupOutput out, ReportBean rb, WebGridRows rows, boolean includeMetricValues)Generates a single row of data with an empty metrics axis.voidrenderGrid(MarkupOutput out)Renders the grid.voidrenderGridData(MarkupOutput out)Generates the data content of the grid, this includes both Row headers and metric values.protected voidrenderGridData(MarkupOutput out, boolean includeMetricValues)Generates the data content of the grid, this includes both Row headers and metric values.voidrenderGridHeaders(MarkupOutput out)Generates the top part of the report, that is, the row titles, column titles and column headers.protected voidrenderGridHeaders(MarkupOutput out, boolean includeColumnHeaders)Generates the top part of the report, that is, the row titles, column titles and column headers.protected voidrenderGridTitles(MarkupOutput out)Convenience method to generate only the grid titles, that is row and column titles.voidrenderIncRefresReportMessage(MarkupOutput out)Renders a message to the end user indicating that the results of the cube report has been published This method is called when the current report type isIncremental Refresh.protected voidrenderJavascript(MarkupOutput out)This method renders the javascript code that needs to be generated on the server side because its content is dynamic.voidrenderLayout(MarkupOutput out, ReportBean rb)Deprecated.This method has been deprecated and will be removed in future versions of the product.voidrenderLayout(MarkupOutput out, ReportBean rb, boolean renderRowTitles, boolean renderColTitles, boolean renderColHeaders)Deprecated.This method has been deprecated and will be removed in future versions of the product.protected voidrenderLockHeadersInfo(MarkupOutput out)Generates divs that allows the headers to be "locked" in the browser window.voidrenderMaxRowsLimitMessage(MarkupOutput out)Renders a message indicating that report exceeded the number of cells allowed by the MicroStrategy Server.voidrenderMetricValue(MarkupOutput out, ReportBean rb, WebRowValue rowValue)Renders a single metric value.voidrenderMetricValues(MarkupOutput out, ReportBean rb, WebRow row)Renders the metric values of a single row.voidrenderNonViewableMessage(MarkupOutput out)Renders a message to the end user indicating that the results of the report have been stored in a table.protected voidrenderRegisterBone(MarkupOutput out)If a scriptClass is specified, this method registers the corresponding javascript bone for this component.voidrenderRowHeader(MarkupOutput out, ReportBean rb, WebHeader rowHeader)Deprecated.This method is not used anymore by the Transform.voidrenderRowHeader(MarkupOutput out, ReportBean rb, WebHeader rowHeader, boolean displayTotalLabel)Renders a single row header.protected voidrenderRowHeaders(MarkupOutput out)Convenience method to generate only the row headers (all row headers).voidrenderRowHeaders(MarkupOutput out, ReportBean rb, WebRow row)Renders the row headers of a single row.voidrenderRowTitle(MarkupOutput out, ReportBean rb, WebTitle title)Renders a single rowTitle.voidrenderRowTitles(MarkupOutput out, ReportBean rb, WebGridTitles rowTitles)Renders the row titles of the report.protected voidrenderRowTitlesAccessibility(MarkupOutput out, ReportBean rb, WebGridTitles rowTitles)Renders an empty list of row titles.voidrenderSingleRow(MarkupOutput out, ReportBean rb, WebRow row)Generates a single row of data.voidrenderSingleRow(MarkupOutput out, ReportBean rb, WebRow row, boolean includeMetricValues)Generates a single row of data.protected voidsetBoneProperties(JsonGenerator boneProps)Sets the necessary properties to the bone assigned to this transform (based on theAbstractAppTransform.scriptClassformal parameter)
Usually called byAbstractAppTransform.renderRegisterBone(MarkupOutput)
Can be overwritten to add or modify bone properties.protected booleanshowColHeaders()Check whether theTemplate FormattingpropertyShowColumnHeadersis true or false.protected booleanshowEmptyAxis()protected booleanshowEmptyAxisCssLink()protected booleanshowEmptyColAxis()protected booleanshowEmptyMetricAxis()protected booleanshowEmptyRowAxis()protected booleanshowRowHeaders()Check whether theTemplate FormattingpropertyShowRowHeadersis true or false.protected voidupdateDynamicScriptFileInformation()protected intwidthMode()Deprecated.Please query directly thewidthModeformal parameter instead-
Methods inherited from class com.microstrategy.web.app.transforms.AbstractReportGridTransform
generateJavaScriptForDragAndDrop, getCssPrefix, getDesignMode, getGridCell, getGridCellColHeader, getGridCellColTitle, getGridCellMetricValue, getGridCellRowHeader, getGridCellRowTitle, getGridGenericCell, initGridCellClasses, initializeCellClasses, initializeImages, 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
-
useImageOnEmptyCells
protected FormalParameter useImageOnEmptyCells
It is used in the transform to specify the use of transparent image on empty metric cells.
Allowed Values: TRUE/FALSE.
It is recommended for this formal paramter to be set to false, as using images for empty cells might degrade performance.- Since:
- MicroStrategy Web 8.1.1
-
mergeColHeaderPara
protected FormalParameter mergeColHeaderPara
It is used in the transform to specify merge or repeat column headers.
Allowed Values: TRUE/FALSE.
-
showBandingPara
protected FormalParameter showBandingPara
It is used in the transform to specify whether to show banding. It only applies to reports that don't use built-in formattings (i.e. reports from old projects).
Allowed Values: TRUE/FALSE.
-
showDrillHyperlink
protected FormalParameter showDrillHyperlink
It is used in the transform to specify whether to allow hyperlink drilling.
Allowed Values: TRUE/FALSE.
-
showDrillHyperlinkMetric
protected FormalParameter showDrillHyperlinkMetric
It is used in the transform to specify whether to allow hyperlink drilling for metrics.
Allowed Values: TRUE/FALSE.
-
showDrillRMC
protected FormalParameter showDrillRMC
It is used in the transform to specify whether to show Right Mouse Click menu for drill.
Allowed Values: TRUE/FALSE.
-
showDrillRMCMetric
protected FormalParameter showDrillRMCMetric
It is used in the transform to specify whether to show Right Mouse Click menu for drill for metrics.
Allowed Values: TRUE/FALSE.
-
showDrillAdvanced
protected FormalParameter showDrillAdvanced
It is used in the transform to specify whether to allow advanced drilling.
Allowed Values: TRUE/FALSE.
-
showDrillDownOnly
protected FormalParameter showDrillDownOnly
It is used in the transform to specify whether to allow drilling to the child only.
Allowed Values: TRUE/FALSE.
-
showDrillMetric
protected FormalParameter showDrillMetric
It is used in the transform to specify whether to allow drilling on metrics.
Allowed Values: TRUE/FALSE.
-
showDrillCheckBox
protected FormalParameter showDrillCheckBox
It is used in the transform to specify whether to allow select filter - check box drilling.
Allowed Values: TRUE/FALSE.
-
showFilterOnSelectionCheckBox
protected FormalParameter showFilterOnSelectionCheckBox
It is used in the transform to specify whether to allow filter on selection.
Allowed Values: TRUE/FALSE.
-
wrapRowHeader
protected FormalParameter wrapRowHeader
This is the parameter which decides if we wrap the row header cells when displaying the report. It was added to support older browsers that ignore WordWrap in css (which is how the Word Wrap property in the grid formatting dialog works). In newer browsers, the user has complete control. It's usually mapped to the "wrapRowHeader" preference (set at the project level by the administrator) and set through the style catalog. It affects the transform's output as follow:- If
true, users with Internet Explorer 5.5 and greater-word wrapping is controlled by the "Wrap text" setting on the Format panel (on the Alignment tab); users with Internet Explorer 5.0 and less and Netscape Navigator 4.7-word wrapping is allowed in all attribute element cells. - When
false, users with IE 5.5 and greater-word wrapping for the attribute element cells that are in the rows (on the left of the grid) is not allowed. Word wrapping in all other cells is still controlled by the "Wrap text" setting on the Format panel (on the Alignment tab); users with Internet Explorer 5.0 and below-word wrapping for the attribute element cells that are in the rows (on the left of the grid) is not allowed. Word wrapping is allowed in all other cells.
- If
-
wrapMetricValue
protected FormalParameter wrapMetricValue
This is the parameter which decides if we wrap the metric values cells when displaying the report. It was added to support older browsers that ignore WordWrap in css (which is how the Word Wrap property in the grid formatting dialog works). In newer browsers, the user has complete control. It's usually mapped to the "wrapRowHeader" preference (set at the project level by the administrator) and set through the style catalog. It affects the transform's output as follow:- If
true, users with Internet Explorer 5.5 and greater-word wrapping is controlled by the "Wrap text" setting on the Format panel (on the Alignment tab); users with Internet Explorer 5.0 and less and Netscape Navigator 4.7-word wrapping is allowed in all attribute element cells. - When
false, users with IE 5.5 and greater-word wrapping for the attribute element cells that are in the rows (on the left of the grid) is not allowed. Word wrapping in all other cells is still controlled by the "Wrap text" setting on the Format panel (on the Alignment tab); users with Internet Explorer 5.0 and below-word wrapping for the attribute element cells that are in the rows (on the left of the grid) is not allowed. Word wrapping is allowed in all other cells.
- If
-
headerMetricValueOptimized
protected FormalParameter headerMetricValueOptimized
This is the parameter which decides if we move the common html attributes of non-metric headers and metric value cells to a map and is thus stored once. Allowed Values: TRUE/FALSE.
-
drillRetainParent
protected FormalParameter drillRetainParent
This is the FP which tells whether to retain the parent while drilling.
If a value is specified here, then the drill Preference on the preference page for the same is ignored.
Allowed Values:
PreferencesDrillTransform.DRILL_OPTION_DRILL_ANYWHERE = "1";
PreferencesDrillTransform.DRILL_OPTION_DRILL_HYPERLINKS = "2";
PreferencesDrillTransform.DRILL_OPTION_SIMPLE_DRILL = "3";
PreferencesDrillTransform.DRILL_OPTION_NO_DRILL = "4";
PreferencesDrillTransform.DRILL_OPTION_REPORT_DEFINITION = "5";
-
maxSortAllowed
protected FormalParameter maxSortAllowed
This is the value used in the transform to specify how many nested sorts will be allowed in the report.
Allowed Values: positive integer values.
-
drillLinkExtraURL
protected FormalParameter drillLinkExtraURL
This is the code which we will append with the drill hyperlink tag for DHTML.
Allowed Values: String values.
-
ignoreSubtotal
protected FormalParameter ignoreSubtotal
It is used in the transform to specify whether to display subtotal cells.
Allowed Values: TRUE/FALSE.
-
hideMetricsLabel
protected FormalParameter hideMetricsLabel
Hides the 'Metrics' label on the grid's titles.
Allowed Values: TRUE/FALSE.- Since:
- MicroStrategy Web 7.5.0
-
imgActiveSortAsc
protected FormalParameter imgActiveSortAsc
This is the image name for showing the active sort icon for ascending values.
Allowed Values: The value to indicate should be a valid image file name, with any necessary path information not included already on theresourcesFolderImageapplication configuration parameter.
-
imgActiveSortDesc
protected FormalParameter imgActiveSortDesc
This is the image name for showing the active sort icon for descending values.
Allowed Values: The value to indicate should be a valid image file name, with any necessary path information not included already on theresourcesFolderImageapplication configuration parameter.
-
imgInActiveSortAsc
protected FormalParameter imgInActiveSortAsc
This is the image name for showing the inactive sort icon for ascending values.
Allowed Values: The value to indicate should be a valid image file name, with any necessary path information not included already on theresourcesFolderImageapplication configuration parameter.
-
imgInActiveSortDesc
protected FormalParameter imgInActiveSortDesc
This is the image name for showing the inactive sort icon for descending values.
Allowed Values: The value to indicate should be a valid image file name, with any necessary path information not included already on theresourcesFolderImageapplication configuration parameter.
-
showSortButtonsForAttributes
protected FormalParameter showSortButtonsForAttributes
This is the flag used in the transform to specify whether to show sort buttons for attributes (row titles).
Allowed Values: TRUE/FALSE.
-
showSortRMCForAttributes
protected FormalParameter showSortRMCForAttributes
This is the flag used in the transform to specify whether to show sort right mouse click menu for attributes (row titles).
Allowed Values: TRUE/FALSE.
-
showSortButtonsForMetrics
protected FormalParameter showSortButtonsForMetrics
This is the flag used in the transform to specify whether to show sort buttons for metrics (column headers).
Allowed Values: TRUE/FALSE.
-
showSortRMCForMetrics
protected FormalParameter showSortRMCForMetrics
This is the flag used in the transform to specify whether to show sort right mouse click menu for metrics (column headers).
Allowed Values: TRUE/FALSE.
-
cssParentFontSize
protected FormalParameter cssParentFontSize
This is the report's base font size.
Used when generating the report's CSS classes with theWebCSSHelper.
Allowed Values: positive integer values.- Since:
- MicroStrategy Web 7.5.0
-
cssUseRelativeFont
protected FormalParameter cssUseRelativeFont
Determines whether to use relative font for the CSS.
Used when generating the report's CSS classes with theWebCSSHelper.
It should be of BOOLEAN type.- Since:
- MicroStrategy Web 7.5.4
-
cssPathParameter
protected FormalParameter cssPathParameter
Determines the CSS class path to for all CSS classes in a grid report.
This class will be appended as a prefix to all the CSS classes generated by theWebCSSHelperwith a '.' at the beginning- Since:
- MicroStrategy Web 8.0.0
-
dpiConversion
protected FormalParameter dpiConversion
Indicates the dpi conversion factor to convert between inches and pixels (inches=pixels/dpiConversion).- Since:
- MicroStrategy Web 8.0.0
-
zoomFactor
protected FormalParameter zoomFactor
Indicates the zoom factor to use for adjusting sizes. Fonts, column widths and other size related features will adjust their values by this percentage.
Default value: 100.- Since:
- MicroStrategy Web 8.0.0
-
containerWidth
protected FormalParameter containerWidth
Specifies the width (in any measure accepted by the web-browser) of the <div> tag enclosing the grid's table. Only used when thewidthModeis set to be fixed.- Since:
- MicroStrategy Web 8.0.0
-
containerHeight
protected FormalParameter containerHeight
Specifies the height (in any measure accepted by the web-browser) of the <div> tag enclosing the grid's table. Only used when theheightModeis set to be fixed.- Since:
- MicroStrategy Web 8.0.0
-
widthMode
protected FormalParameter widthMode
Determines whether the <div> tag enclosing the grid should have a fixed width, or should expand to fit the width of the grid's content.
Allowed values:- 0-Fixed
- 2-Fit to contents
containerWidthproperty must also be specified.- Since:
- MicroStrategy Web 8.0.0
-
heightMode
protected FormalParameter heightMode
Determines whether the <div> tag enclosing the grid should have a fixed height, or should expand to fit the height of the grid's content.
Allowed values:- 0-Fixed
- 2-Fit to contents
containerHeightproperty must also be specified.- Since:
- MicroStrategy Web 8.0.0
-
overflowMode
protected FormalParameter overflowMode
If the
Allowed values:widthModeorheightModeis set to be fixed, this parameter specifies what should happen with the <div>'s content if it overflows the space specified by thecontainerHeightorcontainerWidthparameters.- 0-Clipped: The content is clipped, and it's not visible
- 1-Scroll: The content is clipped but scrollbars are enabled.
- Since:
- MicroStrategy Web 8.0.0
-
showUniqueDrillPaths
protected FormalParameter showUniqueDrillPaths
It is used in the transform to specify whether to show unique drill paths on context menus.
Allowed Values: TRUE/FALSE.- Since:
- MicroStrategy Web 8.1.2
-
isHTMLExport
protected FormalParameter isHTMLExport
-
FP_IS_HTML_EXPORT
public static final java.lang.String FP_IS_HTML_EXPORT
- See Also:
- Constant Field Values
-
lastRowTitle
protected ReportGridCellRowTitle lastRowTitle
- Since:
- MicroStrategy Web 9.0.0
-
_sharedCellProperties
protected com.microstrategy.web.app.transforms.SharedCellProperties _sharedCellProperties
- Since:
- MicroStrategy Web 8.1.0
-
-
Method Detail
-
getDescription
public java.lang.String getDescription()
Returns a textual description of this transform to be used in WYSIWYG tools.- Returns:
- "The ReportGridTransformImpl generates the grid visualization of the data returned by a Report.";
-
initializeTransform
public void initializeTransform(Transformable data)
Description copied from class:AbstractReportGridTransformExtendsinitializeTransformby initiliazing the grid cell classes by callinginitializeCellClasses- Specified by:
initializeTransformin interfaceAppTransform- Overrides:
initializeTransformin classAbstractReportGridTransform- Parameters:
data- the bean to transform.- Since:
- MicroStrategy Web 8.0.0
-
updateDynamicScriptFileInformation
protected void updateDynamicScriptFileInformation()
- Since:
- MicroStrategy Web 9.0.0
-
initializeProperties
public void initializeProperties()
Description copied from class:AbstractReportDataTransformExtendsinitializePropertiesby invokinginitializeTranformContext- Overrides:
initializePropertiesin classAbstractReportGridTransform
-
initializeTranformContext
public void initializeTranformContext()
Deprecated.please use instead the ReportGridTransformImpl.Context instance as context.Description copied from class:AbstractReportDataTransformInitialize the transform context object. This object is later passed to theReportGridDisplayCellinstances so they have information about the transform.- Overrides:
initializeTranformContextin classAbstractReportDataTransform
-
renderJavascript
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. It extendsrenderJavascriptby including control variables that informs the browser the grid status, and context (or right-mouse-click) menus.- Overrides:
renderJavascriptin classAbstractReportDataTransform- Parameters:
out- MarkupOutput to generate the HTML.- Since:
- MicroStrategy Web 8.0.0
-
renderContextMenus
protected void renderContextMenus(MarkupOutput out)
Generates the HTML used for client-side context (right mouse click) menus. These are registered into theContextMenuManagerby the Transform and the cells.- Overrides:
renderContextMenusin classAbstractAppTransform- Parameters:
out- MarkupOutput to generate the HTML.- Since:
- MicroStrategy Web 8.0.0
-
renderEmptyCase
public void renderEmptyCase(MarkupOutput out, ReportBean rb)
Deprecated.This method has been deprecated and will be removed in future versions of the product. In its place, use/extend therenderEmptyGridmethod.Generates the HTML when the grid contains no data.- Parameters:
out- MarkupOutput to generate the HTML.rb- ReportBean being transformed (ignored, always uses the bean passed to theinitializeTransformmethod).
-
renderRegisterBone
protected void renderRegisterBone(MarkupOutput out)
Description copied from class:AbstractAppTransformIf a scriptClass is specified, this method registers the corresponding javascript bone for this component.- Overrides:
renderRegisterBonein classAbstractAppTransform- Parameters:
out- MarkupOutput whether the output should be rendered.- Since:
- MicroStrategy Web 8.0.0
- See Also:
AbstractAppTransform.getScriptClass()
-
setBoneProperties
protected void setBoneProperties(JsonGenerator boneProps)
Description copied from class:AbstractAppTransformSets the necessary properties to the bone assigned to this transform (based on theAbstractAppTransform.scriptClassformal parameter)
Usually called byAbstractAppTransform.renderRegisterBone(MarkupOutput)
Can be overwritten to add or modify bone properties.- Overrides:
setBonePropertiesin classAbstractReportDataTransform- Parameters:
boneProps- the JsonGenerator object that contains the collection of bone properties.
-
getRWGridGraphDef
protected RWGridGraphDef getRWGridGraphDef() throws WebBeanException, WebObjectsException
- Throws:
WebBeanExceptionWebObjectsException
-
renderEmptyGrid
public void renderEmptyGrid(MarkupOutput out)
Generates the HTML when the grid contains no data.
It simply creates an empty table and call therenderEmptyMessagemethod.
In case this Transform is used in the context of Documents (ReportWriting), nothing is generated.- Parameters:
out- MarkupOutput to generate the HTML.- Since:
- MicroStrategy Web 8.0.0
-
renderEmptyMessage
public void renderEmptyMessage(MarkupOutput out)
Generates the "no data" message for a grid.
It checks whether the grid is empty because the template contains no objects, or just because the current selection in the page-by generates no data, and renders the appropriate message.- Parameters:
out- MarkupOutput to generate the HTML.- Since:
- MicroStrategy Web 8.0.0
-
getOpenAccordionEvent
public WebEvent getOpenAccordionEvent()
Returns the event to open the accordion. This is used in the case that the grid is empty so the users can open the browser and add objects.- Returns:
- WebEvent to open the obect browser in the report page.
- Since:
- MicroStrategy Web 9.0.0
-
renderLayout
public void renderLayout(MarkupOutput out, ReportBean rb)
Deprecated.This method has been deprecated and will be removed in future versions of the product. In its place, use/extend therenderGridHeadersmethod.Generates the top part of the report, that is, the row titles, column titles and column headers.- Parameters:
out- MarkupOutput to generate the HTML.rb- ReportBean being transformed (ignored, always uses the bean passed to theinitializeTransformmethod).
-
renderLayout
public void renderLayout(MarkupOutput out, ReportBean rb, boolean renderRowTitles, boolean renderColTitles, boolean renderColHeaders)
Deprecated.This method has been deprecated and will be removed in future versions of the product. In its place, use/extend therenderGridHeadersmethod.Generates the top part of the report, that is, the row titles, column titles and column headers.- Parameters:
out- MarkupOutput to generate the HTML.rb- ReportBean being transformed (ignored, always uses the bean passed to theinitializeTransformmethod).renderRowTitles- ignored, this argument is not used anymore.renderColTitles- ignored, this argument is not used anymore.renderColHeaders- to decide whether to include column headers in the output.
-
renderColumnTitles
public void renderColumnTitles(MarkupOutput out, ReportBean rb, WebGridTitles colTitles)
Deprecated.This method has been deprecated and will be removed in future versions of the product.This method has never been used, nor implemented. It's kept only for backwards compatibility.- Parameters:
out- MarkupOutput to generate the HTML.rb- ReportBean being transformed (ignored, always uses the bean passed to theinitializeTransformmethod).colTitles- collection of grid titles being rendered.
-
renderColumnTitle
public void renderColumnTitle(MarkupOutput out, ReportBean rb, WebTitle title)
Renders a single column title.
It creates theReportGridCellColTitleusing thenewColTitlemethod, and callsonColumnTitle- Parameters:
out- MarkupOutput to generate the HTML.rb- ReportBean being transformed (ignored, always uses the bean passed to theinitializeTransformmethod).title- the corresponding WebTitle
-
renderColumnTitle
public void renderColumnTitle(MarkupOutput out, ReportBean rb, WebTitle title, int colSpan)
- Since:
- MicroStrategy Web 9.0.0
-
renderData
public void renderData(MarkupOutput out, ReportBean rb)
Deprecated.This method has been deprecated and will be removed in future versions of the product. In its place, use/extend therenderGridDatamethod.Generates the data content of the grid, this includes both Row headers and metric values.- Parameters:
out- MarkupOutput to generate the HTML.rb- ReportBean being transformed (ignored, always uses the bean passed to theinitializeTransformmethod).
-
renderData
public void renderData(MarkupOutput out, ReportBean rb, boolean renderMetricValues)
Deprecated.This method has been deprecated and will be removed in future versions of the product. In its place, use/extend therenderGridDatamethod.Generates the data content of the grid, this includes both Row headers and metric values.- Parameters:
out- MarkupOutput to generate the HTML.rb- ReportBean being transformed (ignored, always uses the bean passed to theinitializeTransformmethod).renderMetricValues- whether to include metric values or not
-
renderSingleRow
public void renderSingleRow(MarkupOutput out, ReportBean rb, WebRow row)
Generates a single row of data. It calls:- onRowStart (to inform a new row is being rendered).
- renderRowHeaders (if
showRowHeadersreturntrue). - renderMetricValues.
- onRowEnd (to inform a new row is being rendered).
- Parameters:
out- MarkupOutput to generate the HTML.rb- ReportBean being transformed (ignored, always uses the bean passed to theinitializeTransformmethod).row- the corresponding WebRow
-
renderSingleRow
public void renderSingleRow(MarkupOutput out, ReportBean rb, WebRow row, boolean includeMetricValues)
Generates a single row of data. It calls:- onRowStart (to inform a new row is being rendered).
- renderRowHeaders (if
showRowHeadersreturntrue). - renderMetricValues (if the
includeMetricValuesargument istrue). - onRowEnd (to inform a new row is being rendered).
- Parameters:
out- MarkupOutput to generate the HTML.rb- ReportBean being transformed (ignored, always uses the bean passed to theinitializeTransformmethod).row- the corresponding WebRowincludeMetricValues- true if metric values show be included. False otherwise.
-
renderFirstSingleRow
public void renderFirstSingleRow(MarkupOutput out, ReportBean rb, WebGridRows rows, boolean includeMetricValues)
Generates a single row of data with an empty metrics axis. It calls:- onRowStart (to inform a new row is being rendered).
- renderRowHeaders (if
showRowHeadersreturntrue). - onMetricValue(newEmptyMetricValue()) (if the
includeMetricValuesargument istrue). - onRowEnd (to inform a new row is being rendered).
- Parameters:
out- MarkupOutput to generate the HTML.rb- ReportBean being transformed (ignored, always uses the bean passed to theinitializeTransformmethod).rows- entire WebGridRows collectionincludeMetricValues- true if metric values show be included. False otherwise.- Since:
- MicroStrategy Web 9.0.0
-
showEmptyAxis
protected boolean showEmptyAxis()
- Since:
- MicroStrategy Web 9.0.0
-
showEmptyRowAxis
protected boolean showEmptyRowAxis()
- Since:
- MicroStrategy Web 9.0.0
-
showEmptyColAxis
protected boolean showEmptyColAxis()
- Since:
- MicroStrategy Web 9.0.0
-
showEmptyMetricAxis
protected boolean showEmptyMetricAxis()
- Since:
- MicroStrategy Web 9.0.0
-
showEmptyAxisCssLink
protected boolean showEmptyAxisCssLink()
- Since:
- MicroStrategy Web 9.0.0
-
renderRowHeaders
public void renderRowHeaders(MarkupOutput out, ReportBean rb, WebRow row)
Renders the row headers of a single row.
Basically, it iterates through the rowHeaders collection and calls renderRowHeader, for example:WebHeaders rowHeaders = row.getHeaderElements(); for (int j = 0; j < rowHeaders.size(); j++) { renderRowHeader(out, rb, rowHeaders.get(j), firstTotal); }- Parameters:
out- MarkupOutput to generate the HTML.rb- ReportBean being transformed (ignored, always uses the bean passed to theinitializeTransformmethod).row- the corresponding WebRow
-
renderRowHeader
public void renderRowHeader(MarkupOutput out, ReportBean rb, WebHeader rowHeader)
Deprecated.This method is not used anymore by the Transform. Instead userenderRowHeader(MarkupOutput, ReportBean, WebHeader, boolean)Renders a single row header.
It creates theReportGridCellRowHeaderusing thenewRowHeadermethod, and callsonRowHeader- Parameters:
out- MarkupOutput to generate the HTML.rb- ReportBean being transformed (ignored, always uses the bean passed to theinitializeTransformmethod).rowHeader- the corresponding rowHeader
-
renderRowHeader
public void renderRowHeader(MarkupOutput out, ReportBean rb, WebHeader rowHeader, boolean displayTotalLabel)
Renders a single row header.
It creates theReportGridCellRowHeaderusing thenewRowHeadermethod, and callsonRowHeader.
If this is a row header of a total, then it will first check theignoreSubtotalFormal Parameter and if true, won't render the cell; if false, it will then check thedisplayTotalLabelargument, and when false, will set the cell's text to be a blank space.- Parameters:
out- MarkupOutput to generate the HTML.rb- ReportBean being transformed (ignored, always uses the bean passed to theinitializeTransformmethod).rowHeader- the corresponding rowHeaderdisplayTotalLabel- false if totals rowHeaders- Since:
- MicroStrategy Web 7.5.0
-
renderExtraRowHeader
public void renderExtraRowHeader(MarkupOutput out, WebHeader extraHeader, int rowSpan)
Renders an extra row header.
It creates theReportGridCellRowHeaderusing theextraHeadermethod, and callsonRowHeader.
This method is mainly used for #809124, if row span is larger than 8190 we need to divide the original td cell and render extra td cells. This method uses the cached row header to render a new cell with expected row span.- Parameters:
out- MarkupOutput to generate the HTML.extraHeader- the cached rowHeader.rowSpan- the expected row span for this extra cell.
-
renderMetricValues
public void renderMetricValues(MarkupOutput out, ReportBean rb, WebRow row)
Renders the metric values of a single row.
Basically, it iterates through the rowHeaders collection and callsrenderMetricValue, for example:for (int j = 0; j < row.size(); j++) { renderMetricValue(out, rb, row.get(j)); }- Parameters:
out- MarkupOutput to generate the HTML.rb- ReportBean being transformed (ignored, always uses the bean passed to theinitializeTransformmethod).row- the corresponding WebRow
-
renderMetricValue
public void renderMetricValue(MarkupOutput out, ReportBean rb, WebRowValue rowValue)
Renders a single metric value.
If this cell is for a total, it will check theignoreSubtotalFormal Parameter and if true, it will just ignore this cell, otherwise it creates a newReportGridCellMetricValueusing thenewMetricValuemethod, and callsonMetricValue.- Parameters:
out- MarkupOutput to generate the HTML.rb- ReportBean being transformed (ignored, always uses the bean passed to theinitializeTransformmethod).rowValue- the corresponding WebRowValue
-
renderRowTitlesAccessibility
protected void renderRowTitlesAccessibility(MarkupOutput out, ReportBean rb, WebGridTitles rowTitles)
Renders an empty list of row titles.
This is a needed in accessibility mode because screen readers don't support "rowspan" attribute in table cells, so we need to expand the row titles when their rowspan is greater than 0. This method basically iterates through the list ofrowTitlesand generates an empty row title cell for each one of them, for example:for (int i = 0; i < rowTitles.size(); i++) { WebTitle title = rowTitles.get(i); for (int j = 0; j < title.getSpan(); j++) { onRowTitle(newRowTitle(), out); } }- Parameters:
out- MarkupOutput to generate the HTML.rb- ReportBean being transformed (ignored, always uses the bean passed to theinitializeTransformmethod).rowTitles- the corresponding WebGridTitles
-
renderRowTitles
public void renderRowTitles(MarkupOutput out, ReportBean rb, WebGridTitles rowTitles)
Renders the row titles of the report.
Basically, it iterates through the rowTitles collection and callsrenderRowTitle, for example:for (int i = 0; i < rowTitles.size(); i++) { renderRowTitle(out, rb, rowTitles.get(i)); }- Parameters:
out- MarkupOutput to generate the HTML.rb- ReportBean being transformed (ignored, always uses the bean passed to theinitializeTransformmethod).rowTitles- the corresponding WebGridTitles
-
renderRowTitle
public void renderRowTitle(MarkupOutput out, ReportBean rb, WebTitle title)
Renders a single rowTitle.
Basically, it creates a newReportGridCellRowTitleusing thenewRowTitlemethod, and callsonRowTitle.- Parameters:
out- MarkupOutput to generate the HTML.rb- ReportBean being transformed (ignored, always uses the bean passed to theinitializeTransformmethod).title- the corresponding WebTitle
-
renderCustomGroups
protected void renderCustomGroups(MarkupOutput out, ReportGridCellRowTitle cell, int rowSpan) throws WebObjectsException, WebBeanException
Renders custom groups on the grid template.- Parameters:
out-MarkupOutputcell-ReportGridCellRowTitlerowSpan- The number of rows you would want this particular row to span over.- Throws:
WebObjectsExceptionWebBeanException
-
getColTitleSpan
protected int getColTitleSpan() throws WebObjectsException, WebBeanExceptionReturns how many columns, the title cell spans over.- Returns:
- {@link Integer)
- Throws:
WebObjectsExceptionWebBeanException
-
renderColumnHeaders
public void renderColumnHeaders(MarkupOutput out, ReportBean rb, WebHeaders colHeaders)
Renders the column headers of the report.
Basically, it iterates through the colHeaders collection and callsrenderColumnHeader, for example:for (int i = 0; i < colHeaders.size(); i++) { renderColumnHeader(out, rb, colHeaders.get(i)); }- Parameters:
out- MarkupOutput to generate the HTML.rb- ReportBean being transformed (ignored, always uses the bean passed to theinitializeTransformmethod).colHeaders- the corresponding WebHeaders
-
renderColumnHeader
public void renderColumnHeader(MarkupOutput out, ReportBean rb, WebHeader header)
Renders a single column header.
Basically, it creates a newReportGridCellColHeaderusing thenewColHeadermethod, and callsonColumnHeader.- Parameters:
out- MarkupOutput to generate the HTML.rb- ReportBean being transformed (ignored, always uses the bean passed to theinitializeTransformmethod).header- the corresponding WebHeader
-
renderCssLink
public void renderCssLink(MarkupOutput out)
ExtendsrenderCssLinkto generate the <style> tag necessary for this report's format.
This can be controlled with theuseBuiltInFormatFormalParameter: if it is false, even if the report has built-in format information from the iServer, this will not be generated and will just callsuper.renderCssLink- Overrides:
renderCssLinkin classAbstractAppTransform- Parameters:
out- MarkupOutput to generate the HTML.
-
getCSSInformation
protected java.lang.String getCSSInformation(WebCSSHelper cssHelper)
- Since:
- MicroStrategy Web 9.0.0
-
buildDNDForEmptyGrid
protected void buildDNDForEmptyGrid(MarkupOutput out)
Deprecated.This method is not called anymore and it doesn't generate any HTML. It's kept just for backwards compatibility.- Parameters:
out- MarkupOutput to generate the HTML.
-
generateJavaScriptForDrill
protected void generateJavaScriptForDrill(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 to generate dynamic drill URLs.- Parameters:
out- MarkupOutput to generate the HTML.rb- ReportBean being transformed (ignored, always uses the bean passed to theinitializeTransformmethod).
-
generateJavaScriptForResizeColumns
protected void generateJavaScriptForResizeColumns(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 resize columns feature.- Parameters:
out- MarkupOutput to generate the HTML.rb- ReportBean being transformed (ignored, always uses the bean passed to theinitializeTransformmethod).
-
generatePreHTMLForResizeColumns
protected void generatePreHTMLForResizeColumns(MarkupOutput out)
Deprecated.This method is not called anymore and it doesn't generate any HTML. It's kept just for backwards compatibility.- Parameters:
out- MarkupOutput to generate the HTML.
-
generateJSForDrillCheckBoxesForIncFetch
protected void generateJSForDrillCheckBoxesForIncFetch(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 functionality will be part of the grid's bone.Generates the javascript used to initialize the drilling when using incremental fetch.- Parameters:
out- MarkupOutput to generate the HTML.rb- ReportBean being transformed (ignored, always uses the bean passed to theinitializeTransformmethod).
-
renderBottom
public void renderBottom(MarkupOutput out, ReportBean rb)
Deprecated.This method has been deprecated and will be removed in future versions of the product. In its place, users can control the output using a layout-xml.Render bottom area of the transform.
Out of box, we are displaying a message if the report is truncated because the number of report cells is exceeding limit.
Then we display the incremental fetch for row, if the formal parameter "showIncreFetchForRowOnBottom" is true.
Sample source code for this method is provided below.
if (isReportTruncated()) { renderMaxRowsLimitMessage(out); } if (isTrue(showIncreFetchForRowOnBottom)) { renderIncreFetchOnRow(out, getReportBean()); }- Specified by:
renderBottomin interfaceReportDataTransform- Overrides:
renderBottomin classAbstractReportDataTransform- Parameters:
out- MarkupOutput to generate the HTML.rb- ReportBean being transformed (ignored, always uses the bean passed to theinitializeTransformmethod).
-
hasCenter
public boolean hasCenter()
Description copied from class:AbstractReportDataTransformWhether the transform has the center area. Out of box, it returns true.- Specified by:
hasCenterin classAbstractReportDataTransform- Returns:
- Whether the transform has the center area
- Since:
- MicroStrategy Web 8.0.0
-
renderCenter
public void renderCenter(MarkupOutput out, ReportBean rb)
Deprecated.This method has been deprecated and will be removed in future versions of the product. In its place, users can control the output using a layout-xml.Renders the center area of the Transform, that is, the grid.
This method first checks if the grid is emtpy, and callsrenderEmptyGrid, otherwise it checks if its a datamart, and callsrenderDatamartMessage. By default it just callsrenderGrid. Sample source code for this method is provided below.
if (isGridEmpty()) { renderEmptyGrid(out); } else if (isDatamart()) { renderDatamartMessage(out); } else { renderGrid(out); }- Parameters:
out- MarkupOutput to generate the HTML.rb- ReportBean being transformed (ignored, always uses the bean passed to theinitializeTransformmethod).
-
renderNonViewableMessage
public void renderNonViewableMessage(MarkupOutput out)
Renders a message to the end user indicating that the results of the report have been stored in a table. This method is called when the current report type isDatamart, Cube, Incremental Refresh.- Parameters:
out- MarkupOutput to generate the HTML.- Since:
- MicroStrategy Web 9.0.0
-
renderDatamartMessage
public void renderDatamartMessage(MarkupOutput out)
Renders a message to the end user indicating that the results of the report have been stored in a table. This method is called when the current report type isDatamart.- Parameters:
out- MarkupOutput to generate the HTML.- Since:
- MicroStrategy Web 8.0.0
-
renderCubeReportMessage
public void renderCubeReportMessage(MarkupOutput out)
Renders a message to the end user indicating that the results of the cube report has been published This method is called when the current report type isCube.- Parameters:
out- MarkupOutput to generate the HTML.- Since:
- MicroStrategy Web 9.0.0
-
renderIncRefresReportMessage
public void renderIncRefresReportMessage(MarkupOutput out)
Renders a message to the end user indicating that the results of the cube report has been published This method is called when the current report type isIncremental Refresh.- Parameters:
out- MarkupOutput to generate the HTML.- Since:
- MicroStrategy Web 9.0.0
-
renderMaxRowsLimitMessage
public void renderMaxRowsLimitMessage(MarkupOutput out)
Renders a message indicating that report exceeded the number of cells allowed by the MicroStrategy Server.- Parameters:
out- MarkupOutput to generate the HTML.- Since:
- MicroStrategy Web 8.0.0
-
renderGrid
public void renderGrid(MarkupOutput out)
Renders the grid.
It callsrenderGridHeadersandrenderGridData. It also callsrenderLockHeadersInfoto generates divs necessary with this feature.
Sample source code for this method is provided below.
Tag tableTag = generateGridTable(); renderColTags(tableTag.getContent()); renderGridHeaders(tableTag.getContent()); renderGridData(tableTag.getContent()); tableTag.render(out); renderLockHeadersInfo(out);
- Parameters:
out- MarkupOutput to generate the HTML.- Since:
- MicroStrategy Web 8.0.0
-
renderDropZones
public void renderDropZones(MarkupOutput out)
- Since:
- MicroStrategy Web 9.0.0
-
getLockHeaderTag
protected Tag getLockHeaderTag()
Generate the lock header tag information for the grid.- Returns:
Taginstance with the lock header information. If not supported given the scenario, it might returnnull.- Since:
- MicroStrategy Web 9.0.0
-
isLockedHeaders
protected boolean isLockedHeaders()
-
isSpecifyWidthForCell
protected boolean isSpecifyWidthForCell()
- Since:
- MicroStrategy Web 8.0.1
-
isSpecifyIdForTitleCell
protected boolean isSpecifyIdForTitleCell()
- Since:
- MicroStrategy Web 8.0.1
-
renderLockHeadersInfo
protected void renderLockHeadersInfo(MarkupOutput out)
Generates divs that allows the headers to be "locked" in the browser window.
The row headers and column headers are generated again by this method, then using javascript these are positioned on top of the original headers, creating the illusion that the later are kept still.- Parameters:
out- MarkupOutput to generate the HTML.- Since:
- MicroStrategy Web 8.0.0
-
renderGridHeaders
public void renderGridHeaders(MarkupOutput out)
Generates the top part of the report, that is, the row titles, column titles and column headers.- Parameters:
out- MarkupOutput to generate the HTML.- Since:
- MicroStrategy Web 8.0.0
-
renderGridHeaders
protected void renderGridHeaders(MarkupOutput out, boolean includeColumnHeaders)
Generates the top part of the report, that is, the row titles, column titles and column headers.
TheincludeColumnHeadersargument allows to dynamically decide if the column headers should be rendered or not.- Parameters:
out- MarkupOutput to generate the HTML.includeColumnHeaders- to decide whether to include column headers in the output.- Since:
- MicroStrategy Web 8.0.0
-
renderGridTitles
protected void renderGridTitles(MarkupOutput out)
Convenience method to generate only the grid titles, that is row and column titles. It callsrenderGridHeaders(out, false);- Parameters:
out- MarkupOutput to generate the HTML.- Since:
- MicroStrategy Web 8.0.0
-
renderGridData
public void renderGridData(MarkupOutput out)
Generates the data content of the grid, this includes both Row headers and metric values.- Parameters:
out- MarkupOutput to generate the HTML.- Since:
- MicroStrategy Web 8.0.0
-
renderGridData
protected void renderGridData(MarkupOutput out, boolean includeMetricValues)
Generates the data content of the grid, this includes both Row headers and metric values.
TheincludeMetricValuesargument 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).- Parameters:
out- MarkupOutput to generate the HTML.includeMetricValues- whether to include metric values or not- Since:
- MicroStrategy Web 8.0.0
-
renderEmptyGridRows
protected void renderEmptyGridRows(MarkupOutput out) throws WebObjectsException, WebBeanException
- Throws:
WebObjectsExceptionWebBeanException- Since:
- MicroStrategy Web 9.0.0
-
checkAndRenderExtraColumn
protected void checkAndRenderExtraColumn(MarkupOutput out)
- Since:
- Microstrategy Web 9.0.1
-
checkAndRenderEmptyRowHeader
protected void checkAndRenderEmptyRowHeader(MarkupOutput out)
Renders the drag and drop zone as the empty row header at the left hand side of the grid- Since:
- Microstrategy Web 9.0.1
-
getExtraColumn
protected boolean getExtraColumn() throws WebObjectsException, WebBeanException- Throws:
WebObjectsExceptionWebBeanException- Since:
- Microstrategy Web 9.0.1
-
getColTitleCount
protected int getColTitleCount()
- Since:
- MicroStrategy Web 9.0.0
-
getSubtitlesCount
protected int getSubtitlesCount(WebTemplateUnit unit)
- Since:
- MicroStrategy Web 9.0.0
-
renderRowHeaders
protected void renderRowHeaders(MarkupOutput out)
Convenience method to generate only the row headers (all row headers). It callsrenderGridData(out, false);- Parameters:
out- MarkupOutput to generate the HTML.- Since:
- MicroStrategy Web 8.0.0
-
renderColTags
public void renderColTags(MarkupOutput out)
Generates the HTML for <col> tags for the main table.
This tags control the width of the column in the grid.- Parameters:
out- MarkupOutput to generate the HTML.- Since:
- MicroStrategy Web 8.0.0
-
renderColTagsHtml
protected void renderColTagsHtml(MarkupOutput out, int dpi, double zoom)
Renders the col tags for a grid column widths.- Parameters:
dpi- int containing the dpi of the clientzoom- value for zoom property to useout-MarkupOutputinstance where the HTML contents to render are to be saved- Since:
- MicroStrategy Web 9.0.0
-
getOpenObjectBrowserEvent
public WebEvent getOpenObjectBrowserEvent()
Returns the event to open the ObjectBrowser. This is used in the case that the grid is empty so the users can open the browser and add objects.- Returns:
- WebEvent to open the obect browser in the report page.
- Since:
- MicroStrategy Web 8.0.0
-
getDrillEvent
public WebEvent getDrillEvent()
- Since:
- MicroStrategy Web 8.0.1
-
getRwdDrillOutEvent
public WebEvent getRwdDrillOutEvent()
- Since:
- MicroStrategy Web 9.0.0
-
getRenameEvent
public WebEvent getRenameEvent()
- Since:
- MicroStrategy Web 8.0.1
-
getDerivedElementsEvent
public WebEvent getDerivedElementsEvent()
- Since:
- MicroStrategy Web 9.0.0
-
getAdvancedDrillEvent
public WebEvent getAdvancedDrillEvent()
- Since:
- MicroStrategy Web 8.0.1
-
getDrillEditorProcessEvent
public WebEvent getDrillEditorProcessEvent()
- Since:
- MicroStrategy Web 8.0.1
-
getDrillFilterOnSelectionEvent
public WebEvent getDrillFilterOnSelectionEvent()
- Since:
- MicroStrategy Web 8.0.1
-
getAdvancedDrillProcessEvent
public WebEvent getAdvancedDrillProcessEvent()
- Since:
- MicroStrategy Web 8.0.1
-
getSortEvent
public WebEvent getSortEvent()
- Since:
- MicroStrategy Web 8.0.1
-
mergeColHeader
protected boolean mergeColHeader()
Deprecated.Please query directly themergeColHeaderParaformal parameter insteadReturns the value of themergeColHeaderformal parameter.
-
overflowMode
protected int overflowMode()
Returns the value of theoverflowModeformal parameter.- Since:
- MicroStrategy Web 8.0.0
-
containerWidth
protected java.lang.String containerWidth()
Returns the value of thecontainerWidthformal parameter (in pixels).- Since:
- MicroStrategy Web 8.0.0
-
containerHeight
protected java.lang.String containerHeight()
Returns the value of thecontainerWidthformal parameter (in pixels).- Since:
- MicroStrategy Web 8.0.0
-
widthMode
protected int widthMode()
Deprecated.Please query directly thewidthModeformal parameter insteadReturns the value of thewidthModeformal parameter.- Since:
- MicroStrategy Web 8.0.0
-
heightMode
protected int heightMode()
Deprecated.Please query directly theheightModeformal parameter insteadReturns the value of theheightModeformal parameter.- Since:
- MicroStrategy Web 8.0.0
-
showColHeaders
protected boolean showColHeaders()
Check whether theTemplate FormattingpropertyShowColumnHeadersis true or false.- Returns:
- the boolean value of the property.
- Since:
- MicroStrategy Web 8.0.0
-
showRowHeaders
protected boolean showRowHeaders()
Check whether theTemplate FormattingpropertyShowRowHeadersis true or false.- Returns:
- the boolean value of the property.
- Since:
- MicroStrategy Web 8.0.0
-
isReportTruncated
public boolean isReportTruncated()
Returns the value ofgetReportBean().getReportData().isReportTruncated(). This indicates that this report has exceeded the maximum amount of rows allowed by the administrator, therefore the data has been truncated.- Returns:
trueif the report data has been truncated.- Since:
- MicroStrategy Web 8.0.0
-
isDesignMode
protected boolean isDesignMode()
Description copied from class:AbstractReportTransformThis methods allows the transform to identify if concrete subclasses are designed to work in design mode, or in execute mode.- Overrides:
isDesignModein classAbstractReportTransform- Returns:
- false by default. Any inherting class should override to implement its own version.
- Since:
- MicroStrategy Web 8.0.0
-
generateReportGridTable
protected void generateReportGridTable(MarkupOutput out, ReportBean rb, boolean specifyUniqueReportID)
Deprecated.This method has been deprecated and will be removed in future versions of the product. It's not used anymore. In its place you may call:generateGridTable().renderOpenTag(out);Generates the open tag of the report's grid table.- Parameters:
out- MarkupOutput to generate the HTML.rb- ReportBean being transformed (ignored, always uses the bean passed to theinitializeTransformmethod). *specifyUniqueReportID- (ignored).
-
generateGridTable
protected Tag generateGridTable()
Creates theTableTaginstance that is used for the table holding the report's data.- Returns:
- The
TableTagfor the grid. - Since:
- MicroStrategy Web 8.0.0
-
getAttributesEmptyGridTable
protected java.util.Map getAttributesEmptyGridTable()
Generates the list of attributes used by an empty grid's table. This method may be extended to include extra/custom attributes.- Returns:
- Map with the Attributes to use
- Since:
- MicroStrategy Web 8.0.0
-
getAttributesGridTable
protected java.util.Map getAttributesGridTable()
Generates the list of attributes used by the grid's table. This method may be extended to include extra/custom attributes.- Returns:
- Map with the Attributes to use
- Since:
- MicroStrategy Web 8.0.0
-
getAttributesBoneDiv
protected java.util.Map getAttributesBoneDiv()
Generates the list of attributes used by a div surrounding the grid. This div includes the information used by grid's bone, such asscriptclassandsubtype(sty).- Returns:
- Map with the Attributes to use
- Since:
- MicroStrategy Web 8.0.0
-
getAttributesRow
protected java.util.Map getAttributesRow(WebRow row)
Generates the list of attributes used by <tr> of a single row.- Parameters:
row- the corresponding WebRow- Returns:
- Map with the Attributes to use
- Since:
- MicroStrategy Web 8.0.0
-
getCssGrid
protected java.lang.String getCssGrid()
Returns the css class to be used by the grid table.- Since:
- MicroStrategy Web 8.0.0
-
newRowTitle
public ReportGridCellRowTitle newRowTitle(WebTitle title)
Creates and initialize a newReportGridCellRowTitlewith the given parameters.- Since:
- MicroStrategy Web 8.0.0
-
newRowTitle
public ReportGridCellRowTitle newRowTitle(WebTitle title, WebSubTitle subTitle, int subTitleIndex)
Creates and initialize a newReportGridCellRowTitlewith the given parameters.- Since:
- MicroStrategy Web 8.0.0
-
newRowTitle
public ReportGridCellRowTitle newRowTitle(WebTitle title, WebSubTitle subTitle, int subTitleIndex, boolean showSubTitleOnly)
Creates and initialize a newReportGridCellRowTitlewith the given parameters.- Since:
- MicroStrategy Web 8.0.0
-
newColTitle
public ReportGridCellColTitle newColTitle(WebTitle title)
Creates and initialize a newReportGridCellColTitlewith the given parameters.- Since:
- MicroStrategy Web 8.0.0
-
newColTitle
public ReportGridCellColTitle newColTitle(WebTitle title, WebSubTitle subTitle, int subTitleIndex)
Creates and initialize a newReportGridCellColTitlewith the given parameters.- Since:
- MicroStrategy Web 8.0.0
-
newColTitle
public ReportGridCellColTitle newColTitle(WebTitle title, WebSubTitle subTitle, int subTitleIndex, boolean showSubTitleOnly)
Creates and initialize a newReportGridCellColTitlewith the given parameters.- Since:
- MicroStrategy Web 8.0.0
-
newColTitle
public ReportGridCellColTitle newColTitle(WebTitle title, int subTitleIndex)
Creates and initialize a newReportGridCellColTitlewith the given parameters.- Since:
- MicroStrategy Web 8.0.0
-
newRowHeader
public ReportGridCellRowHeader newRowHeader()
Creates and initialize a newReportGridCellRowHeaderwith no underlying SDK object.- Since:
- MicroStrategy Web 8.0.0
-
newEmptyRowHeader
public ReportGridCellRowHeader newEmptyRowHeader()
Create and initialize a newReportGridCellRowHeaderwith a "drop units here" message with no underlying SDK object.- Since:
- MicroStrategy Web 9.0.0
-
newEmptyRowHeader
public ReportGridCellRowHeader newEmptyRowHeader(int rowSpan)
Creates and returns an empty row header with the specified rowSpan.- Parameters:
rowSpan- The number of rows you expect the new header to span over.- Returns:
-
newRowHeader
public ReportGridCellRowHeader newRowHeader(WebHeader rowHeader)
Creates and initialize a newReportGridCellRowHeaderwith the given parameters.- Since:
- MicroStrategy Web 8.0.0
-
newColHeader
public ReportGridCellColHeader newColHeader(WebHeader header)
Creates and initialize a newReportGridCellColHeaderwith the given parameters.- Since:
- MicroStrategy Web 8.0.0
-
newGridHeader
protected ReportGridCellHeader newGridHeader(WebHeader header, java.lang.String className)
- Since:
- MicroStrategy Web 8.1.0
-
newMetricValue
public ReportGridCellMetricValue newMetricValue(WebRowValue rowValue)
Creates and initialize a newReportGridCellMetricValuewith the given parameters.- Since:
- MicroStrategy Web 8.0.0
-
newEmptyMetricValue
public ReportGridCellMetricValue newEmptyMetricValue()
Creates and initialize a newReportGridCellMetricValuewith a "drop objects here" message with no underlying SDK object.- Since:
- MicroStrategy Web 9.0.0
-
newMetricValue
public ReportGridCellMetricValue newMetricValue()
Creates and initialize a newReportGridCellMetricValuewith no underlying SDK object.- Since:
- MicroStrategy Web 8.0.0
-
newRowTitle
public ReportGridCellRowTitle newRowTitle(WebTemplateUnit unit)
Creates and initialize a newReportGridCellRowTitlewith the given parameters.- Since:
- MicroStrategy Web 8.0.0
-
newRowTitle
public ReportGridCellRowTitle newRowTitle(WebTemplateUnit unit, WebAttributeForm form, int subtitleIndex)
Creates and initialize a newReportGridCellRowTitlewith the given parameters.- Since:
- MicroStrategy Web 8.0.0
-
newRowTitle
public ReportGridCellRowTitle newRowTitle(WebTemplateUnit unit, WebAttributeForm form, int subtitleIndex, boolean showSubTitleOnly)
Creates and initialize a newReportGridCellRowTitlewith the given parameters.- Since:
- MicroStrategy Web 8.0.0
-
newColTitle
public ReportGridCellColTitle newColTitle(WebTemplateUnit unit)
Creates and initialize a newReportGridCellColTitlewith the given parameters.- Since:
- MicroStrategy Web 8.0.0
-
newColTitle
public ReportGridCellColTitle newColTitle(WebTemplateUnit unit, WebAttributeForm form, int subtitleIndex)
Creates and initialize a newReportGridCellColTitlewith the given parameters.- Since:
- MicroStrategy Web 8.0.0
-
newColTitle
public ReportGridCellColTitle newColTitle(WebTemplateUnit unit, WebAttributeForm form, int subtitleIndex, boolean showSubTitleOnly)
Creates and initialize a newReportGridCellColTitlewith the given parameters.- Since:
- MicroStrategy Web 8.0.0
-
newRowHeader
public ReportGridCellRowHeader newRowHeader(WebTemplateMetric metric)
Creates and initialize a newReportGridCellRowHeaderwith the given parameters.- Since:
- MicroStrategy Web 8.0.0
-
newColHeader
public ReportGridCellColHeader newColHeader(WebTemplateMetric metric)
Creates and initialize a newReportGridCellColHeaderwith the given parameters.- Since:
- MicroStrategy Web 8.0.0
-
newRowTitle
public ReportGridCellRowTitle newRowTitle()
Creates and initialize a newReportGridCellRowTitlewith no underlying SDK object.- Since:
- MicroStrategy Web 8.0.0
-
newEmptyRowTitle
public ReportGridCellRowTitle newEmptyRowTitle()
Creates and initialize a newReportGridCellRowTitlewith no underlying SDK object.- Since:
- MicroStrategy Web 9.0.0
-
newColTitle
public ReportGridCellColTitle newColTitle()
Creates and initialize a newReportGridCellColTitlewith no underlying SDK object.- Since:
- MicroStrategy Web 8.0.0
-
newGridTitle
protected ReportGridCellTitle newGridTitle(WebTitle title, java.lang.String className)
- Since:
- MicroStrategy Web 8.1.0
-
newColHeader
public ReportGridCellColHeader newColHeader()
Creates and initialize a newReportGridCellColHeaderwith no underlying SDK object.- Since:
- MicroStrategy Web 8.0.0
-
newEmptyColHeader
public ReportGridCellColHeader newEmptyColHeader()
Create and initialize a newReportGridCellColHeaderwith a drop units here message with no underlying SDK object.- Since:
- MicroStrategy Web 9.0.0
-
newColTitle
public ReportGridCellColTitle newColTitle(WebTemplateUnit unit, int subtitleIndex)
Creates and initialize a newReportGridCellColTitlewith the given parameters.- Since:
- MicroStrategy Web 8.0.0
-
newRowTitle
public ReportGridCellRowTitle newRowTitle(WebTitle title, int subTitleIndex)
Creates and initialize a newReportGridCellRowTitlewith the given parameters.- Since:
- MicroStrategy Web 8.0.0
-
newRowTitle
public ReportGridCellRowTitle newRowTitle(WebTitle title, int subTitleIndex, boolean showSubTitleOnly)
Creates and initialize a newReportGridCellRowTitlewith the given parameters.- Since:
- MicroStrategy Web 8.0.0
-
newRowTitle
public ReportGridCellRowTitle newRowTitle(WebTemplateUnit unit, int subtitleIndex)
Creates and initialize a newReportGridCellRowTitlewith the given parameters.- Since:
- MicroStrategy Web 8.0.0
-
newRowTitle
public ReportGridCellRowTitle newRowTitle(WebTemplateUnit unit, int subtitleIndex, boolean showSubTitleOnly)
Creates and initialize a newReportGridCellRowTitlewith the given parameters.- Since:
- MicroStrategy Web 8.0.0
-
onRowStart
protected void onRowStart(MarkupOutput out)
This method is called when a new row needs to be rendered. It is responsible to open the<tr>tag- Parameters:
out- MarkupOutput to generate the HTML.- Since:
- MicroStrategy Web 8.0.0
-
onRowStart
protected void onRowStart(WebRow row, MarkupOutput out)
This method is called when a new row needs to be rendered. It is responsible to open the<tr>tag- Parameters:
out- MarkupOutput to generate the HTML.row- the corresponding WebRow- Since:
- MicroStrategy Web 8.0.0
-
onRowTitle
protected void onRowTitle(ReportGridCellRowTitle cell, MarkupOutput out)
This method is called when a row title needs to be rendered. By default it just callscell.generateOutput(out)(that is, it just delegates it to the cell itself).- Parameters:
cell- the corresponding cellout- MarkupOutput to generate the HTML.- Since:
- MicroStrategy Web 8.0.0
-
onColumnTitle
protected void onColumnTitle(ReportGridCellColTitle cell, MarkupOutput out)
This method is called when a column title needs to be rendered. By default it just callscell.generateOutput(out)(that is, it just delegates it to the cell itself).- Parameters:
cell- the corresponding cellout- MarkupOutput to generate the HTML.- Since:
- MicroStrategy Web 8.0.0
-
onRowHeader
protected void onRowHeader(ReportGridCellRowHeader cell, MarkupOutput out)
This method is called when a row header needs to be rendered. By default it just callscell.generateOutput(out)(that is, it just delegates it to the cell itself).- Parameters:
cell- the corresponding cellout- MarkupOutput to generate the HTML.- Since:
- MicroStrategy Web 8.0.0
-
onColumnHeader
protected void onColumnHeader(ReportGridCellColHeader cell, MarkupOutput out)
This method is called when a column header needs to be rendered. By default it just callscell.generateOutput(out)(that is, it just delegates it to the cell itself).- Parameters:
cell- the corresponding cellout- MarkupOutput to generate the HTML.- Since:
- MicroStrategy Web 8.0.0
-
onMetricValue
protected void onMetricValue(ReportGridCellMetricValue cell, MarkupOutput out)
This method is called when a metric value needs to be rendered. By default it just callscell.generateOutput(out)(that is, it just delegates it to the cell itself).- Parameters:
cell- the corresponding cellout- MarkupOutput to generate the HTML.- Since:
- MicroStrategy Web 8.0.0
-
onRowEnd
protected void onRowEnd(MarkupOutput out)
This method is called when row has finished. It is responsible to close the<tr>tag- Parameters:
out- MarkupOutput to generate the HTML.- Since:
- MicroStrategy Web 8.0.0
-
onRowEnd
protected void onRowEnd(WebRow row, MarkupOutput out)
This method is called when row has finished. It is responsible to close the<tr>tag- Parameters:
row- the corresponding WebRowout- MarkupOutput to generate the HTML.- Since:
- MicroStrategy Web 8.0.0
-
getContextMenuManagerName
protected java.lang.String getContextMenuManagerName()
Returns the name to use for theContextMenuManagerof this Transform. By default, it uses_bean.getName() + "_GM"unless otherwise specified by the formal parameter- Overrides:
getContextMenuManagerNamein classAbstractAppTransform- Since:
- MicroStrategy Web 8.0.1
-
getContextMenuManager
public ContextMenuManager getContextMenuManager()
Description copied from class:AbstractAppTransformReturns theContextMenuManagerinstance used by this Transform. This method will return a non-null instance, even if context menus are not enabled for this transform (i.e. ifAbstractAppTransform.isContextMenusEnabled()returnsfalse).- Overrides:
getContextMenuManagerin classAbstractAppTransform- Since:
- MicroStrategy Web 8.0.1
-
canRemoveFromGrid
public boolean canRemoveFromGrid()
Utility methood for determining if all the privileges are enabled for displaying the user the option to remove one element from the grid- Returns:
- boolean value indicating if the manipulation should be enabled
- Since:
- MicroStrategy Web 8.0.1
-
canRemoveFromReport
public boolean canRemoveFromReport()
Utility methood for determining if all the privileges are enabled for displaying the user the option to remove one element from the report- Returns:
- boolean value indicating if the manipulation should be enabled
- Since:
- MicroStrategy Web 8.0.1
-
canRename
public boolean canRename()
Utility methood for determining if all the privileges are enabled for displaying the user the option to rename one element from the grid- Returns:
- boolean value indicating if the manipulation should be enabled
- Since:
- MicroStrategy Web 8.0.1
-
canAddThresholds
public boolean canAddThresholds()
Utility method for determining if all the privileges are enabled for displaying the user the option to add thresholds to current element from the grid- Returns:
- boolean value indicating if the manipulation should be enabled
- Since:
- MicroStrategy Web 9.0.0
-
canFilterOn
public boolean canFilterOn()
Utility methood for determining if all the privileges are enabled for displaying the user the option to filter on one element from the grid- Returns:
- boolean value indicating if the manipulation should be enabled
- Since:
- MicroStrategy Web 8.0.1
-
canFormat
public boolean canFormat()
Utility methood for determining if all the privileges are enabled for displaying the user the option to format one element from the grid- Returns:
- boolean value indicating if the manipulation should be enabled
- Since:
- MicroStrategy Web 8.0.1
-
canSort
public boolean canSort()
Utility methood for determining if all the privileges are enabled for displaying the user the option to sort on one element from the grid- Returns:
- boolean value indicating if the manipulation should be enabled
- Since:
- MicroStrategy Web 8.0.1
-
canDrill
public boolean canDrill()
Utility methood for determining if all the privileges are enabled for displaying the user the option to drill on one element from the grid- Returns:
- boolean value indicating if the manipulation should be enabled
- Since:
- MicroStrategy Web 8.0.1
-
canInsertShortcutMetric
public boolean canInsertShortcutMetric()
Utility methood for determining if all the privileges are enabled for displaying the user the option to insert shortcut metrics on the grid- Returns:
- boolean value indicating if the manipulation should be enabled
- Since:
- MicroStrategy Web 8.0.1
-
canPivot
public boolean canPivot()
Utility methood for determining if all the privileges are enabled for displaying the user the option to pivot one element from the grid- Returns:
- boolean value indicating if the manipulation should be enabled
- Since:
- MicroStrategy Web 8.0.1
-
isDrillRMCAvailableForMetricValue
public boolean isDrillRMCAvailableForMetricValue()
Utility method to check if Drill RMC is available.- Since:
- MicroStrategy Web 8.0.1
-
canModifyAttributeForm
public boolean canModifyAttributeForm()
Utility methood for determining if all the privileges are enabled for displaying the user the option to modify the attribute forms on one element from the grid- Returns:
- boolean value indicating if the manipulation should be enabled
- Since:
- MicroStrategy Web 8.0.1
-
canResize
public boolean canResize()
Utility methood for determining if allowing users to resize columns of a linked template in rwd- Returns:
- boolean value indicating if the manipulation should be enabled
- Since:
- MicroStrategy Web 9.2.2
-
-