Class ReportExportHTMLTransform
- 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.ReportExportHTMLTransform
-
- All Implemented Interfaces:
AppTransform
,LayoutTransform
,Transform
public class ReportExportHTMLTransform extends AbstractReportTransform implements LayoutTransform
Deprecated.ReportExportHTMLTransform is the class that generates the output for a ReportBean in HTML format for exporting. Used for exporting to HTML and exportining to Excel with formatting.- Since:
- MicroStrategy Web 7.3.1 or earlier
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class com.microstrategy.web.app.transforms.AbstractAppTransform
AbstractAppTransform.Context
-
-
Field Summary
Fields Modifier and Type Field Description protected FormalParameter
_enableExcelNumFormat
Deprecated.This formal parameter determines whether to enable number formatting for Excel.protected FormalParameter
_enableExcelOutline
Deprecated.This formal parameter determines whether to export outline reports as outline in Excel.protected FormalParameter
_isExcel
Deprecated.we now read this value fromExportBean.getExportFormat()
and then ask forExportFormat.isExcel()
protected FormalParameter
_renderOldStyleFilterDetails
Deprecated.This formal parameter determines whether the filter details section is rendered using the old style
Allowed Values: TRUE/FALSEprotected FormalParameter
_renderPageByAfterFilterDetails
Deprecated.This formal parameter determines whether the page by information is rendered after the filter details section.protected FormalParameter
_styleGraphs
Deprecated.This formal parameter determines the style to be used to transform the report bean on graph mode.protected FormalParameter
_styleGrids
Deprecated.This formal parameter determines the style to be used to transform the report bean on grid or grid and graph mode.protected FormalParameter
_styleOutlineGrids
Deprecated.This formal parameter determines the style to be used to transform the report bean on grids in Outline mode.protected FormalParameter
_stylePageByInfo
Deprecated.This formal parameter determines the style to be used to transform the report bean to display the page by information.-
Fields inherited from class com.microstrategy.web.app.transforms.AbstractReportTransform
BLANK_SUBSET_REPORT_ID, 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 ReportExportHTMLTransform()
Deprecated.Default empty constructor.
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description protected java.lang.String
cleanTextForExport(java.lang.String text)
Deprecated.This methods cleans a string to be displayed in Excel.java.util.Map
getAttributesBody()
Deprecated.Gets the list of html attributes for the body tagjava.util.Map
getAttributesHTML()
Deprecated.Gets the list of html attributes for the html tagjava.util.Map
getAttributesMainTable()
Deprecated.Gets the list of html attributes for the main table tagjava.lang.String
getDescription()
Deprecated.Return description for this Transformprotected TransformInstance
getPageByTransform(ReportBean rb)
Deprecated.protected TransformInstance
getReportGraphTransform(ViewBean vb)
Deprecated.protected TransformInstance
getReportGridTransform(ViewBean vb)
Deprecated.protected TransformInstance
getReportOutlineGridTransform(ViewBean vb)
Deprecated.void
initializeProperties()
Deprecated.Initialize some properties for the transform.void
renderCss(MarkupOutput mo)
Deprecated.Render the necessary CSS filesvoid
renderExcelHeader(MarkupOutput mo)
Deprecated.Renders a header to tell Excel to display the headers on top for outline mode reportsvoid
renderFilterDetails(MarkupOutput mo)
Deprecated.Renders the report's filter details.void
renderFooter(MarkupOutput mo)
Deprecated.Renders a footer section that is added at the end of the exported results.void
renderHeader(MarkupOutput mo)
Deprecated.Renders a header section that is added at the top of the exported results.void
renderMetaContentType(MarkupOutput out)
Deprecated.Renders the META tag with the content typevoid
renderNewLine(MarkupOutput mo)
Deprecated.Renders a new line (empty row)void
renderPageByInfo(MarkupOutput mo)
Deprecated.Renders the page by informationvoid
renderPageByInfo(MarkupOutput mo, ReportBean rb)
Deprecated.void
renderReport(MarkupOutput mo)
Deprecated.Renders the report sectionvoid
renderReport(MarkupOutput mo, ReportBean rb, ExportBean eb)
Deprecated.void
renderReport(MarkupOutput mo, ReportBean rb, ExportBean eb, boolean isOldStyle)
Deprecated.void
renderReportName(MarkupOutput mo)
Deprecated.Renders the report namevoid
renderReportName(java.lang.String reportName, MarkupOutput mo)
Deprecated.void
renderReportNameForTitle(MarkupOutput mo)
Deprecated.Renders the report name for the page's titlevoid
renderShell(MarkupOutput out)
Deprecated.Generates the shell for this Transform.void
transformForRequestSuccessful(MarkupOutput mo)
Deprecated.Transform when the status is "Successful".-
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, initializeImages, initializeTransform, initializeWebComponent, isCubeReport, isDatamart, isDesignMode, 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, getAttributesShellDiv, getBeanPath, getBoneId, getClientSideHelper, getContainerServices, getContext, getContextMenu, getContextMenuManager, getContextMenuManagerName, getContextMenusDefinition, getCssPrefix, getDateFormat, getDebugOut, getDescriptor, getDescriptor, getDescriptor, getDescriptor, getDisplayMode, getDisplayName, getErrorMessage, getErrorTitle, getEventManager, getFirstDayOfWeek, getFloatValue, getHelpPath, getID, getIntValue, getJSNameSpace, getLayoutContext, getLocale, getLocale, getPreferenceValue, getProjectID, getRefreshEvent, getRequestKeys, getResourcesFolder, getScriptClass, getStringValue, getStyleRequestContext, getStyleShellDiv, getTagsFactory, getTimeFormat, getUnitsLabel, getWebBeanErrorInfo, hasSubBlock, initHeightAndWidthFromPreferences, initializeCss, 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, renderContextMenus, renderCssLink, renderDescriptor, renderDescriptor, renderErrorButton, renderHiddenInputFromRequest, renderLayout, renderProcessingButton, renderProcessingButton, renderProcessingButton, renderProcessingButtonForGet, renderProcessingButtonForGet, renderProcessingInfoData, renderProcessingInfoImage, renderProcessingInfoSubtitle, renderProcessingInfoTitle, renderProcessingObjectName, renderRefreshButton, renderRegisterBone, renderSelf, renderSubBlock, renderUserHelpAnchor, setBoneProperties, 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, supports, supports
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface com.microstrategy.web.transform.LayoutTransform
getLayoutDefinition, setLayoutDefinition
-
Methods inherited from interface com.microstrategy.web.transform.Transform
canTransform, getFormalParams, getID, getPreview, getSupportedBeanType, isPreviewAvailable, isResolved, supports, supports, transform
-
-
-
-
Field Detail
-
_isExcel
protected FormalParameter _isExcel
Deprecated.we now read this value fromExportBean.getExportFormat()
and then ask forExportFormat.isExcel()
This formal parameter determines whether the application to Export to is Excel.
Allowed Values: TRUE/FALSE.
-
_styleGraphs
protected FormalParameter _styleGraphs
Deprecated.This formal parameter determines the style to be used to transform the report bean on graph mode.
Allowed Values: any report style name from StyleCatalog.xml file.
-
_styleGrids
protected FormalParameter _styleGrids
Deprecated.This formal parameter determines the style to be used to transform the report bean on grid or grid and graph mode.
Allowed Values: any report style name from StyleCatalog.xml file.
-
_styleOutlineGrids
protected FormalParameter _styleOutlineGrids
Deprecated.This formal parameter determines the style to be used to transform the report bean on grids in Outline mode.
Allowed Values: any report style name from StyleCatalog.xml file.- Since:
- MicroStrategy Web 8.0.0
-
_stylePageByInfo
protected FormalParameter _stylePageByInfo
Deprecated.This formal parameter determines the style to be used to transform the report bean to display the page by information.
Allowed Values: any report style name from StyleCatalog.xml file.
-
_renderPageByAfterFilterDetails
protected FormalParameter _renderPageByAfterFilterDetails
Deprecated.This formal parameter determines whether the page by information is rendered after the filter details section.
Allowed Values: TRUE/FALSE- Since:
- MicroStrategy Web 7.5.1
-
_renderOldStyleFilterDetails
protected FormalParameter _renderOldStyleFilterDetails
Deprecated.This formal parameter determines whether the filter details section is rendered using the old style
Allowed Values: TRUE/FALSE- Since:
- MicroStrategy Web 7.5.1
-
_enableExcelOutline
protected FormalParameter _enableExcelOutline
Deprecated.This formal parameter determines whether to export outline reports as outline in Excel. This feature depends on theExportBean.getRawDataEnabled()
property of theExportBean
Allowed Values: TRUE/FALSE.- Since:
- MicroStrategy Web 8.0.0
-
_enableExcelNumFormat
protected FormalParameter _enableExcelNumFormat
Deprecated.This formal parameter determines whether to enable number formatting for Excel. Allowed Values: TRUE/FALSE.- Since:
- MicroStrategy Web 7.5.4
-
-
Method Detail
-
getReportGridTransform
protected TransformInstance getReportGridTransform(ViewBean vb)
Deprecated.- Since:
- MicroStrategy Web 8.0.0
-
getReportGraphTransform
protected TransformInstance getReportGraphTransform(ViewBean vb)
Deprecated.- Since:
- MicroStrategy Web 8.0.0
-
getReportOutlineGridTransform
protected TransformInstance getReportOutlineGridTransform(ViewBean vb)
Deprecated.- Since:
- MicroStrategy Web 8.0.0
-
getPageByTransform
protected TransformInstance getPageByTransform(ReportBean rb)
Deprecated.- Since:
- MicroStrategy Web 8.0.0
-
initializeProperties
public void initializeProperties()
Deprecated.Initialize some properties for the transform.
For example, it may overwrite some formal parameters' values depending on whether the corresponding feature is available.- Overrides:
initializeProperties
in classAbstractReportTransform
- Since:
- MicroStrategy Web 8.0.0
-
transformForRequestSuccessful
public void transformForRequestSuccessful(MarkupOutput mo)
Deprecated.Transform when the status is "Successful".- Specified by:
transformForRequestSuccessful
in classAbstractAppTransform
- Parameters:
mo
- the output object- See Also:
AbstractAppTransform.checkStatus(com.microstrategy.web.beans.MarkupOutput)
-
renderExcelHeader
public void renderExcelHeader(MarkupOutput mo)
Deprecated.Renders a header to tell Excel to display the headers on top for outline mode reports- Parameters:
mo
- MarkupOutput- Since:
- MicroStrategy Web 8.0.0
-
renderMetaContentType
public void renderMetaContentType(MarkupOutput out)
Deprecated.Renders the META tag with the content type- Parameters:
out
- MarkupOutput- Since:
- MicroStrategy Web 8.0.0
-
renderHeader
public void renderHeader(MarkupOutput mo)
Deprecated.Renders a header section that is added at the top of the exported results.
The value of the header is saved as a project property and can be modified under "Preferences > Project Defaults > Project Header"- Parameters:
mo
- MarkupOutput- Since:
- MicroStrategy Web 8.0.2
-
renderReportName
public void renderReportName(java.lang.String reportName, MarkupOutput mo)
Deprecated.This method renders the report name- Parameters:
reportName
- name of the reportmo
- the output object
-
renderReportName
public void renderReportName(MarkupOutput mo)
Deprecated.Renders the report name- Since:
- MicroStrategy Web 8.0.0
-
renderReportNameForTitle
public void renderReportNameForTitle(MarkupOutput mo)
Deprecated.Renders the report name for the page's title- Since:
- MicroStrategy Web 8.0.0
-
renderCss
public void renderCss(MarkupOutput mo)
Deprecated.Render the necessary CSS files- Parameters:
mo
- MarkupOutput- Since:
- MicroStrategy Web 8.0.0
-
renderFilterDetails
public void renderFilterDetails(MarkupOutput mo)
Deprecated.Renders the report's filter details.- Parameters:
mo
- MarkupOutput- Since:
- MicroStrategy Web 8.0.0
-
renderReport
public void renderReport(MarkupOutput mo)
Deprecated.Renders the report section- Parameters:
mo
- the output object- Since:
- MicroStrategy Web 8.0.0
-
renderFooter
public void renderFooter(MarkupOutput mo)
Deprecated.Renders a footer section that is added at the end of the exported results.
The value of the header is saved as a project property and can be modified under "Preferences > Project Defaults > Project Footer"- Parameters:
mo
- MarkupOutput- Since:
- MicroStrategy Web 8.0.2
-
renderReport
public void renderReport(MarkupOutput mo, ReportBean rb, ExportBean eb)
Deprecated.Renders the report section- Parameters:
mo
- the output objectrb
- Report bean to exporteb
- Export bean
-
renderReport
public void renderReport(MarkupOutput mo, ReportBean rb, ExportBean eb, boolean isOldStyle)
Deprecated.This function renders the report section- Parameters:
mo
- the output objectrb
- Report bean to exporteb
- Export beanisOldStyle
- Render the report using Old Style- Since:
- MicroStrategy Web 7.5.1
-
renderPageByInfo
public void renderPageByInfo(MarkupOutput mo, ReportBean rb)
Deprecated.Renders the page by information- Parameters:
mo
- the output objectrb
- report bean to export
-
renderPageByInfo
public void renderPageByInfo(MarkupOutput mo)
Deprecated.Renders the page by information- Parameters:
mo
- the output object- Since:
- MicroStrategy Web 8.0.0
-
renderNewLine
public void renderNewLine(MarkupOutput mo)
Deprecated.Renders a new line (empty row)- Parameters:
mo
- the output object- Since:
- MicroStrategy Web 8.0.0
-
getAttributesHTML
public java.util.Map getAttributesHTML()
Deprecated.Gets the list of html attributes for the html tag- Since:
- MicroStrategy Web 8.0.0
-
getAttributesBody
public java.util.Map getAttributesBody()
Deprecated.Gets the list of html attributes for the body tag- Since:
- MicroStrategy Web 8.0.0
-
getAttributesMainTable
public java.util.Map getAttributesMainTable()
Deprecated.Gets the list of html attributes for the main table tag- Since:
- MicroStrategy Web 8.0.0
-
cleanTextForExport
protected java.lang.String cleanTextForExport(java.lang.String text)
Deprecated.This methods cleans a string to be displayed in Excel.
Adds a space if the text starts with "=", "+" and "-"- Parameters:
text
- text to clean- Returns:
- cleaned text
-
getDescription
public java.lang.String getDescription()
Deprecated.Return description for this Transform- Specified by:
getDescription
in interfaceTransform
- Returns:
- description for this Transform
-
renderShell
public void renderShell(MarkupOutput out)
Deprecated.Description copied from class:AbstractAppTransform
Generates the shell for this Transform.
The shell is a
The attributes to append to this<div>
tag that automatically surrounds the content generated by the Transform. It's used among other things by the javascript to identify the HTML associated with a bone, and by the iFrame update technology to identify a component in the page.<div>
are obtained from thegetAttributesShellDiv
method; the style from thegetStyleShellDiv
method.
This method callsrenderCssLink
andcheckStatus
to generate the Transform's content.- Overrides:
renderShell
in classAbstractAppTransform
- Parameters:
out
- output by this transform- Since:
- MicroStrategy Web 8.0.0
-
-