Package com.microstrategy.web.app.transforms

Class PreferencesExportTransform

java.lang.Object

com.microstrategy.web.transform.AbstractTransform

com.microstrategy.web.transform.AbstractLayoutTransform

com.microstrategy.web.app.transforms.AbstractAppTransform

com.microstrategy.web.app.transforms.AbstractPreferencesTransform

com.microstrategy.web.app.transforms.PreferencesGenericTransform

com.microstrategy.web.app.transforms.AbstractOptionsTransform

com.microstrategy.web.app.transforms.PreferencesExportTransform

All Implemented Interfaces:

AppTransform, EnumWebPreferences, LayoutTransform, Transform

public class PreferencesExportTransform
extends AbstractOptionsTransform
implements EnumWebPreferences

This is the transform that renders the Export Preferences and the Export Options page.

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 inherited from class com.microstrategy.web.app.transforms.AbstractOptionsTransform

ACTION_TYPE_EXPORT, ACTION_TYPE_PDF, ACTION_TYPE_PRINT, mapper

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

ORIENTATION_HORIZONTAL, ORIENTATION_VERTICAL

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

_upperLeftCornerImage, _upperRightCornerImage, formID, FP_FORM_ID, FP_LEVEL_FLAG, FP_UPPER_LEFT_CORNER_IMAGE, FP_UPPER_RIGHT_CORNER_IMAGE, LEVEL_ALL, LEVEL_APPLY, LEVEL_APPLY_TO, LEVEL_FORM, LEVEL_LOAD_DEFAULTS, LEVEL_PREFERENCES, levelFlag, upperLeftCornerImage, upperRightCornerImage

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

Fields inherited from interface com.microstrategy.web.objects.EnumWebPreferences

ADVANCED_DRILLING_RMC_DISPLAY_DEFAULT, ADVANCED_DRILLING_RMC_DISPLAY_SUBMENU, COVER_PAGE_DETAILS_CONTENTS_WITH_FILTER_DETAILS, COVER_PAGE_DETAILS_CONTENTS_WITH_REPORT_DETAILS, COVER_PAGE_LOCATION_AFTER_REPORT, COVER_PAGE_LOCATION_BEFORE_REPORT, DRILL_OPTION_ALLOW_DRILL_WITHIN, DRILL_OPTION_DRILL_ANYWHERE, DRILL_OPTION_DRILL_HYPERLINKS, DRILL_OPTION_NO_DRILL, DRILL_OPTION_REPORT_DEFINITION, DRILL_OPTION_RETAIN_PARENT_NO, DRILL_OPTION_RETAIN_PARENT_REPORT_DEFINITION, DRILL_OPTION_RETAIN_PARENT_YES, DRILL_OPTION_RETAIN_THRESHOLD_NO, DRILL_OPTION_RETAIN_THRESHOLD_REPORT_DEFINITION, DRILL_OPTION_RETAIN_THRESHOLD_YES, DRILL_OPTION_SIMPLE_DRILL, DRILL_WITHIN_ALWAYS_NEW_REPORT, DRILL_WITHIN_AUTOMATIC, DRILL_WITHIN_MENU_LOCATION, EXCEL, GRAPH_IMAGE_TYPE_BMP, GRAPH_IMAGE_TYPE_GIF, GRAPH_IMAGE_TYPE_JPEG, GRAPH_IMAGE_TYPE_PNG, GRAPH_IMAGE_TYPE_REPORT, GRAPH_USE_REPORT_SIZE, GRAPH_USE_USER_SIZE, HTML, INBOX_ADD_AUTOMATICALLY, INBOX_ADD_MANUAL, PAPER_ORIENTATION_LANDSCAPE_OPTION, PAPER_ORIENTATION_PORTRAIT_OPTION, PDF, PREFERENCE_FALSE, PREFERENCE_LOCALE_DEFAULT, PREFERENCE_NO, PREFERENCE_OFF, PREFERENCE_ON, PREFERENCE_TRUE, PREFERENCE_UNDEFINED_NUM, PREFERENCE_VALUE_ALL_FULL_SCREEN, PREFERENCE_VALUE_FROM_CURRENT, PREFERENCE_VALUE_FROM_CUSTOM, PREFERENCE_VALUE_FROM_DEFAULT, PREFERENCE_VALUE_FROM_REPORT, PREFERENCE_VALUE_FULL_SCREEN_MD, PREFERENCE_VALUE_GRAPH_USE_REPORT_SIZE, PREFERENCE_VALUE_GRAPH_USE_USER_SIZE, PREFERENCE_VALUE_NO_FULL_SCREEN, PREFERENCE_VALUE_VI_EXEC_MODE_FLASH, PREFERENCE_VALUE_VI_EXEC_MODE_HTML5, PREFERENCE_VALUE_VI_EXEC_MODE_SMART, PREFERENCE_VIEWMODE_ICON, PREFERENCE_VIEWMODE_LIST, PREFERENCE_YES, WebPreferenceAccessibility, WebPreferenceAdminInfo, WebPreferenceAdvancedDrillingContextMenuDisplay, WebPreferenceAllObjectBrowserViewMode, WebPreferenceAllowDHTML, WebPreferenceAllowFlashVIOverwrite, WebPreferenceAllowOMDLinksAncestorsBrowse, WebPreferenceAppVersion, WebPreferenceAQHQDefaultOperator, WebPreferenceAskBeforeLinkedDerivedElementsChanges, WebPreferenceAskBeforeSaveChanges, WebPreferenceAutoExpandAttributeInHierarchy, WebPreferenceBasicAuthAdminRole, WebPreferenceBoneProperty, WebPreferenceBrowserSettings, WebPreferenceCancelRequests, WebPreferenceColorTheme, WebPreferenceConfigurationViewMode, WebPreferenceConnectorWebBaseURL, WebPreferenceCopyNameTranslations, WebPreferenceCreateDSCachesOnRWExecution, WebPreferenceCreateSurvey, WebPreferenceDDMenu, WebPreferenceDefaultApplyOption, WebPreferenceDefaultColorThemeForAnalysis, WebPreferenceDefaultLoginMode, WebPreferenceDefaultWebLoginMode, WebPreferenceDesignModeWithoutAnsweringPrompts, WebPreferenceDIConnectorConfig, WebPreferenceDisableIncrementalFetchForRecipientBrowsing, WebPreferenceDisplayUsherAuthentication, WebPreferenceDocumentExecutionMode, WebPreferenceDocumentSectionHeightMode, WebPreferenceDocumentWidthMode, WebPreferenceDpiConversion, WebPreferenceDrillDisableHyperlinkDrill, WebPreferenceDrillKeepParent, WebPreferenceDrillMode, WebPreferenceDrillOpenInNewWindow, WebPreferenceDrillRetainThresholds, WebPreferenceDrillShowMetricValueLink, WebPreferenceDrillShowMetricValueRMC, WebPreferenceElementsBlockCount, WebPreferenceEmbedFontsIVEFlash, WebPreferenceEnableAutomaticSessionRecovery, WebPreferenceEnableContextMenuDrill, WebPreferenceEnabledLoginMode, WebPreferenceEnabledWebLoginMode, WebPreferenceEnableEmbeddedImages, WebPreferenceEnableFlashViewMode, WebPreferenceEnableGridViewSearch, WebPreferenceEnableHTMLPrinting, WebPreferenceEnableMetricEditor, WebPreferenceEnableMMT, WebPreferenceEnableNCS, WebPreferenceEnableQuickSearch, WebPreferenceEnableSearchAutoComplete, WebPreferenceEnableVisEditor, WebPreferenceEnableWarningSessionTimeout, WebPreferenceEnableWSFormsSorting, WebPreferenceEncodeCSVForExportingToExcel, WebPreferenceEncryptUserCredentials, WebPreferenceExcelEmbedImages, WebPreferenceExcelExportFloatImages, WebPreferenceExcelReportFooter, WebPreferenceExcelReportHeader, WebPreferenceExcelReportHeaderLocation, WebPreferenceExecuteFilterTemplate, WebPreferenceExplorerViewMode, WebPreferenceExportExcelVersion, WebPreferenceExportExpandPageByFields, WebPreferenceExportFilterDetails, WebPreferenceExportFormatDocuments, WebPreferenceExportFormatGraphs, WebPreferenceExportFormatGrids, WebPreferenceExportHeadersAsText, WebPreferenceExportMaxCellsHTML, WebPreferenceExportMaxCellsPlainText, WebPreferenceExportMetricValuesAsText, WebPreferenceExportNewWindow, WebPreferenceExportOverlapGridTitles, WebPreferenceExportPageByInfo, WebPreferenceExportPDF, WebPreferenceExportPlaintextDelimiter, WebPreferenceExportReportOfficeRefresh, WebPreferenceExportReportTitle, WebPreferenceExportReuseNewWindow, WebPreferenceExportSection, WebPreferenceExportShowOptions, WebPreferenceExportUseLiveChartGraphs, WebPreferenceExportUseSeparateSheets, WebPreferenceFilterObjectBrowserViewMode, WebPreferenceFilterVisPulldown, WebPreferenceFloatingApplySelectorButton, WebPreferenceFolderViewMode, WebPreferenceFontFamily, WebPreferenceFontFamilyOption, WebPreferenceFontSize, WebPreferenceFontSizeOption, WebPreferenceFullScreenModeDocuments, WebPreferenceFullScreenModeReports, WebPreferenceGraphHeight, WebPreferenceGraphImageFormat, WebPreferenceGraphShowGridGraph, WebPreferenceGraphSize, WebPreferenceGraphWidth, WebPreferenceGraphZones, WebPreferenceGridAllowLinkDrillingOnHeader, WebPreferenceGridAutoPageBy, WebPreferenceGridDefaultGridStyle, WebPreferenceGridDefaultGridStyleID, WebPreferenceGridDefaultGridWidth, WebPreferenceGridDefaultHeaderWidth, WebPreferenceGridDensity, WebPreferenceGridEnableLockHeaders, WebPreferenceGridMaxColumns, WebPreferenceGridMaxRows, WebPreferenceGridMergeColumHeader, WebPreferenceGridSearchObjectTypes, WebPreferenceGridShowDescriptionAsTooltip, WebPreferenceGridShowPageBy, WebPreferenceGridShowPivot, WebPreferenceGridShowReportFilter, WebPreferenceGridShowSort, WebPreferenceGridShowSubtitle, WebPreferenceGridShowViewFilter, WebPreferenceGridUseBuiltInFormat, WebPreferenceGridWrapAtCharacterLevel, WebPreferenceGridWrapMetricValues, WebPreferenceGridWrapRowHeaders, WebPreferenceGroupContextMenuDrillPathsByType, WebPreferenceHideEmptyNodesInOutlineMode, WebPreferenceHideMetricsColumnOnGrids, WebPreferenceHideMyReportsLink, WebPreferenceHierarchicalSort, WebPreferenceHomeCardsDef, WebPreferenceIframeDisabled, WebPreferenceIgnoreIncrementalRendering, WebPreferenceInboxMode, WebPreferenceInboxReuseMessage, WebPreferenceIniPool, WebPreferenceKeepAlive, WebPreferenceKeepItemInCartAvailable, WebPreferenceKeepScheduledRWDInstanceAvailable, WebPreferenceLayoutAlignmentMode, WebPreferenceLibraryWebBaseURL, WebPreferenceLinkFromWidgetToVisualization, WebPreferenceLocale, WebPreferenceMarqueeSelectionStyle, WebPreferenceMaximumBinarySize, WebPreferenceMaxPool, WebPreferenceMaxSearchResult, WebPreferenceMaxSort, WebPreferenceMaxWaitTime, WebPreferenceMessagesLocale, WebPreferenceMetadataLocale, WebPreferenceMMTAddress, WebPreferenceMobileServer, WebPreferenceMQDefaultOperator, WebPreferenceMultiLayoutDocTabStripPosition, WebPreferenceNCSubscriptionsViewMode, WebPreferenceNewHistoryListMessageUponReprompt, WebPreferenceObjectsBlockCount, WebPreferenceOfficeExportRefresh, WebPreferenceOverrideProjectLoginModes, WebPreferencePageHistoryCapacity, WebPreferencePaperType2A, WebPreferencePaperTypeA0, WebPreferencePaperTypeA1, WebPreferencePaperTypeA2, WebPreferencePaperTypeA3, WebPreferencePaperTypeA4, WebPreferencePaperTypeA5, WebPreferencePaperTypeA6, WebPreferencePaperTypeA7, WebPreferencePaperTypeA8, WebPreferencePaperTypeC, WebPreferencePaperTypeD, WebPreferencePaperTypeE, WebPreferencePaperTypeExecutive, WebPreferencePaperTypeF, WebPreferencePaperTypeFOLIO, WebPreferencePaperTypeLEDGER, WebPreferencePaperTypeLEGAL, WebPreferencePaperTypeLETTER, WebPreferencePaperTypeSUPER, WebPreferencePDFAdminFooterFile, WebPreferencePDFAdminHeaderFile, WebPreferencePDFCoverPageDetailsContents, WebPreferencePDFCoverPageFilterDetails, WebPreferencePDFCoverPageLocation, WebPreferencePDFDraftQualityGraphs, WebPreferencePDFEmbedFonts, WebPreferencePDFExpandPageByFields, WebPreferencePDFExportSection, WebPreferencePDFFitToPagesTall, WebPreferencePDFFitToPagesWide, WebPreferencePDFFooterCenterSection, WebPreferencePDFFooterLeftSection, WebPreferencePDFFooterRightSection, WebPreferencePDFGridGraphSamePage, WebPreferencePDFHeaderCenterSection, WebPreferencePDFHeaderLeftSection, WebPreferencePDFHeaderRightSection, WebPreferencePDFMarginSizeBottom, WebPreferencePDFMarginSizeLeft, WebPreferencePDFMarginSizeRight, WebPreferencePDFMarginSizeTop, WebPreferencePDFMaxCells, WebPreferencePDFMaxFooterSize, WebPreferencePDFMaxHeaderSize, WebPreferencePDFPaperOrientationOption, WebPreferencePDFPaperSize, WebPreferencePDFPrint, WebPreferencePDFReportHeader, WebPreferencePDFScalingOption, WebPreferencePDFShowOptions, WebPreferencePDFShrinkFontPercentage, WebPreferencePDFUseBMPGraphs, WebPreferencePrintAdminFooterFile, WebPreferencePrintAdminHeaderFile, WebPreferencePrintCoverPageFilterDetails, WebPreferencePrintDefaultColsPerPage, WebPreferencePrintDefaultRowsPerPage, WebPreferencePrintDisableDHTMLPrinting, WebPreferencePrintDisplayPopupPrintDialog, WebPreferencePrintExpandPagebyFields, WebPreferencePrintFitColsToPage, WebPreferencePrintFitRowsToPage, WebPreferencePrintFooterCenterSection, WebPreferencePrintFooterLeftSection, WebPreferencePrintFooterRightSection, WebPreferencePrintGridColsPerPage, WebPreferencePrintGridGraphSamePage, WebPreferencePrintGridRowsPerPage, WebPreferencePrintHeaderCenterSection, WebPreferencePrintHeaderFooterOption, WebPreferencePrintHeaderLeftSection, WebPreferencePrintHeaderRightSection, WebPreferencePrintMarginSizeBottom, WebPreferencePrintMarginSizeLeft, WebPreferencePrintMarginSizeRight, WebPreferencePrintMarginSizeTop, WebPreferencePrintMaxCellsPerBlock, WebPreferencePrintMaxColsPerPage, WebPreferencePrintMaxFooterSize, WebPreferencePrintMaxGraphsPerBlock, WebPreferencePrintMaxHeaderSize, WebPreferencePrintMaxRowsPerPage, WebPreferencePrintOpenNewWindow, WebPreferencePrintPaperOrientationOption, WebPreferencePrintPaperSize, WebPreferencePrintSaveSettingsPerReport, WebPreferencePrintScalingOption, WebPreferencePrintShowOptionsOnPrint, WebPreferencePrintShrinkFontPercentage, WebPreferenceProjectAlias, WebPreferenceProjectHeader, WebPreferenceProjectIndex, WebPreferencePromptCancelRequests, WebPreferencePromptRemoveJobs, WebPreferencePromptShowObjectDescription, WebPreferencePromptsMatchCaseSensitivity, WebPreferencePromptsMaxElementsToImport, WebPreferencePromptsMaxUploadFileSize, WebPreferencePromptsMode, WebPreferencePromptsPreserveWhiteSpace, WebPreferencePromptsRenameReport, WebPreferencePromptsRequiredFirst, WebPreferencePromptsUploadFileExtensions, WebPreferencePullDownStyleOptions, WebPreferenceRemoveFinishedJobYes, WebPreferenceRemoveJobs, WebPreferenceReportCreationViewMode, WebPreferenceReportReexecute, WebPreferenceRepromptMessageVisible, WebPreferenceRunUponLogin, WebPreferenceRWDrillMode, WebPreferenceRWDrillWithinMode, WebPreferenceSaveAsFilterTemplatePromptOption, WebPreferenceSaveAsKeepFilterManipulations, WebPreferenceSaveAsKeepPromptAnswers, WebPreferenceSaveAsLinkFilter, WebPreferenceSaveAsLinkTemplate, WebPreferenceSaveAsPromptOption, WebPreferenceScheduledEmailMessageLength, WebPreferenceScheduledRWDFormat, WebPreferenceSearchAutoCompleteDelay, WebPreferenceSearchObjectTypes, WebPreferenceSearchWorkingSet, WebPreferenceSecurityPlugInClass, WebPreferenceSecurityRolesViewMode, WebPreferenceServerLocale, WebPreferenceSharedReportsFolderID, WebPreferenceSharedReportsFolderName, WebPreferenceShowAdvancedSaveOptions, WebPreferenceShowBtnInNavBar, WebPreferenceShowDataLabelsOnGraphScroller, WebPreferenceShowEmptyGridAxesInViewMode, WebPreferenceShowFeedbackBtn, WebPreferenceShowFolderUpBtnInNavBar, WebPreferenceShowFooterPath, WebPreferenceShowGraphDropZonesInViewMode, WebPreferenceShowGraphScroller, WebPreferenceShowHyperCard, WebPreferenceShowObjectDescription, WebPreferenceShowPreviews, WebPreferenceShowPromptDetails, WebPreferenceShowSampleRecents, WebPreferenceShowShortcutsBar, WebPreferenceShowSingleFilterInHierarchy, WebPreferenceShowTemplates, WebPreferenceShowUnusedAttributes, WebPreferenceShowVISamples, WebPreferenceShowVITutorial, WebPreferenceShowVIWelcome, WebPreferenceSortSetNamesAndDrillPaths, WebPreferenceSpringAdminAuthMethod, WebPreferenceStartPage, WebPreferenceStartPageCurrent, WebPreferenceStartPageCurrentName, WebPreferenceStartPageCustom, WebPreferenceStartPageCustomName, WebPreferenceStartPageName, WebPreferenceStartPageSource, WebPreferenceSubscriptionsViewMode, WebPreferenceSupportDossierMoveAcrossPanelStack, WebPreferenceSupportDossierPanelStack, WebPreferenceSupportDossierPanelStackCopyMove, WebPreferenceSupportGridIncrementalColumnRender, WebPreferenceSupportMicroChart, WebPreferenceSupportSuperGrid, WebPreferenceSupportSuperGridDev, WebPreferenceTemporalBrowserSettings, WebPreferenceTimeBeforeSessionTimeoutWarning, WebPreferenceTimeZone, WebPreferenceTransactionMaxWait, WebPreferenceTrimWarehouseData, WebPreferenceUnits, WebPreferenceURLWhiteList, WebPreferenceUseBinaryDataInVF, WebPreferenceUseCacheForReportDesignMode, WebPreferenceUseDHTML, WebPreferenceUseEmbeddedFilter, WebPreferenceUseHeaderFooterInSubscriptions, WebPreferenceUseImagesForOutlineMode, WebPreferenceUseNaturalLanguage, WebPreferenceUseRichTextBox, WebPreferenceUserManagerViewModeType, WebPreferenceUserPalette, WebPreferenceUseRWManipulationForDrill, WebPreferenceUseSecurityPlugIn, WebPreferenceUseURLForVisualizations, WebPreferenceUseWebBlocksForPromptDisplay, WebPreferenceVIExecutionMode, WebPreferenceVisualizationsXMLAccessMethod, WebPreferenceWarehouseDataLocale, WebPreferenceWorkingSetSize

Constructor Summary

Constructors

Constructor	Description
PreferencesExportTransform()

Method Summary

Modifier and Type	Method	Description
protected java.lang.String	getActionType()
java.lang.String	getDescription()	Returns the textual description of the transform
WebEvent	getExportEvent()
protected java.lang.String	getExportEventID()	Returns the ID of the export event used when this transform is used for the Options Page (examples are Export, PDF and Print) This will be used to pass as the "eventToForwardTo" on the Save Report Properties page.
int	getExportFormatsCount()	Deprecated. not used anymore
WebEvent	getExportSavePropertiesEvent()	Deprecated. use getSaveReportPropertiesEvent()
java.lang.String	getTitle()	Generates the Header of the Preferences dialog.
protected java.lang.String	getUniqueID()
void	initializeTransform(Transformable data)	This method initialize the private and protected fields of the transform.
boolean	isCellsLimitExceeded()
boolean	isNotExcel2000()
boolean	isShowEmbedImagesForUser()
void	renderDoNotPrompt(MarkupOutput out)	Generates a checkbox to allow the user to save the "do not prompt me again" preferences in the options page.
void	renderEmbedImages(MarkupOutput out)	Renders checkbox for embedding images
void	renderEnableExportPDF(MarkupOutput out)	Deprecated.
void	renderEncodeCSVForExportingToExcel(MarkupOutput out)	Whether to encode the exporting CSV results as ISO8859_1 so they can be read using Excel.
void	renderExcelVersion(MarkupOutput out)	Renders option for the Excel version
void	renderExpandPageByFields(MarkupOutput out)	Renders checkbox for expanding page by fields.
void	renderExportAdminHeaderFooterButton(MarkupOutput out)	Renders link to edit the export admin header and footer.
void	renderExportButton(MarkupOutput out)	Generates the submit input and related hidden inputs used to submit the information to export the report.
void	renderExportFilterDetails(MarkupOutput out)	Renders checkbox for exporting the filter details.
void	renderExportFooterTextArea(MarkupOutput out)	Deprecated. we now use display this on a separate page
void	renderExportFormatDocuments(MarkupOutput out)	Renders list of radio buttons with the possible export formats for documents.
void	renderExportFormatGraphs(MarkupOutput out)	Renders list of radio buttons with the possible export formats for graphs.
void	renderExportFormatGrids(MarkupOutput out)	Renders list of radio buttons with the possible export formats for grids.
void	renderExportHeaderAsText(MarkupOutput out)	Renders checkboxes for exporting headers and metric values as text.
void	renderExportHeaderTextArea(MarkupOutput out)	Deprecated. we now use display this on a separate page
void	renderExportLimitsMessage(MarkupOutput out)	Renders section that shows the export limits message :'You cannot export this report..'.
void	renderExportMetricValuesAsText(MarkupOutput out)	Renders checkboxes for exporting headers and metric values as text.
void	renderExportPageByInfo(MarkupOutput out)	Renders checkbox for exporting the filter details.
void	renderExportReportTitle(MarkupOutput out)	Renders checkbox for exporting the filter details.
void	renderExportSection(MarkupOutput out)	Renders pulldown list for selecting whether to export the 'whole report' or the 'portion displayed'.
void	renderFormEnd(MarkupOutput out, WebEvent event)	Renders the Form end tag
void	renderFormStart(MarkupOutput out, WebEvent event)	Renders the start of the Preference's Form.
void	renderJavascript(MarkupOutput out)	This method is called to generate all javascript functions related to this transform.
void	renderMaxCells(MarkupOutput out)	Renders textboxes to enter the maximum number of cells to export.
void	renderMaxCellsHTML(MarkupOutput out)	Renders textboxes to enter the maximum number of cells to export to HTML.
void	renderMaxCellsPlainText(MarkupOutput out)	Renders textboxes to enter the maximum number of cells to export to plaintext.
void	renderNewWindow(MarkupOutput out)	Deprecated. This preference has been moved to General Preferences
void	renderOptions(MarkupOutput out)	Renders checkbox for showing the options page before exporting.
void	renderOverlapGridTitles(MarkupOutput out)	Renders checkbox for overlap the grid titles when exporting.
void	renderPreference(java.lang.String preferenceName, MarkupOutput out)	Deprecated. Call the corresponding renderXXX method directly.
void	renderReportOfficeRefresh(MarkupOutput out)	Allow MicroStrategy Office to refresh Reports after exporting to Excel
void	renderUseLiveChartGraphs(MarkupOutput out)	Renders checkbox for using bitmaps for graphs when exporting.
void	renderUseSeparateSheets(MarkupOutput out)	Renders checkbox for using separate sheets when exporting.
void	transformBody(MarkupOutput out)	Generates the content for the PreferencesExportTransform Preference's dialog.
protected void	transformFooter(MarkupOutput out)	Generates the footer of the Preferences dialog

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

getOptionsBean, getPreference, getSaveReportPropertiesEvent, getSaveReportPropertiesEventID, getSupportedBeanType, getValidatePreferencesEvent, isGraphOptions, isGridGraphOptions, isGridOptions, isReportPageByNotEmpty, isShowingOptions, renderCustomHeaderFooterButton, renderHeaderAndFooterButton, renderOutlineModeHiddenInput, renderPreferenceBodyText, renderSaveMessage, transformForRequestInError

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

checkPreferenceValue, getAllowableValues, renderAllowSaveFlash, renderAsCheckBox, renderAsChecklist, renderAsComboBox, renderAsComboBox, renderAsComboBox, renderAsRadio, renderAsRadio, renderAsRadio, renderAsTextBox, renderCheckBox, renderCheckBox, renderComboBox, renderDefaultDashboard, renderLabel, renderLabel2, renderPreference, renderRadio, renderShortcutListAsComboBox, renderTextBox

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

getFormID, getLoadDefaultsEvent, getPreference, getPreferencesBean, getPropertyValue, getUpdateEvent, initializeImages, isAdminLevel, renderApplyChanges, renderApplyChangesButton, renderApplyChangesCombobox, renderImage, renderInvalidMessage, renderLoadDefaults, renderNoteInformation, renderPreferenceBodyNote, renderPreferenceBodyNote, renderPreferenceBodyText, renderPreferenceBodyText, renderPreferenceBodyText, renderPreferenceHeader, renderPreferenceHeader, renderSaveMessageText, renderTitle, renderUpdateConfirmation, transformForRequestSuccessful, transformForRequestWaitingForUserInput, transformHeader

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

addContactInfo, addDynamicScriptClass, addDynamicScriptFile, addFormalParameter, checkLevel, checkProcessingButtonsFlag, checkProcessingInfoFlag, checkStatus, displayError, displayError, displayError, emptyCell, excludeStaticTags, generateAnchor, generateAnchorForExport, generateHiddenInputsForEvent, generateIFrameTag, getAppContext, getArgumentName, getAttributesShellDiv, getBeanPath, getBoneId, getCancelEvent, getClientSideHelper, getContainerServices, getContext, getContextMenu, getContextMenuManager, getContextMenuManagerName, getContextMenusDefinition, getCssPrefix, getDateFormat, getDebugOut, getDescriptor, getDescriptor, getDescriptor, getDescriptor, getDisplayMode, getDisplayName, getErrorMessage, getErrorMessage, getErrorTitle, 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, initializeWebComponent, is508, isBlockMode, isContextMenusEnabled, isDhtml, isDialog, isDormant, isFeatureAvailable, isIFrameDisplayMode, isIFrameEnabled, isIFrameRequest, isJobExpired, isModal, isOpen, isPortlet, isTrue, localIsIFrameDisplayMode, newContext, newHiddenInputBuilder, newNamespaceEncoder, newURIBuilder, redirectToDisplayError, renderBean, renderBean, renderBean, renderBean, renderCancelButton, renderContextMenus, renderCssLink, renderDescriptor, renderDescriptor, renderErrorButton, renderHiddenInputFromRequest, renderLayout, renderProcessingButton, renderProcessingButton, renderProcessingButton, renderProcessingButtonForGet, renderProcessingButtonForGet, renderProcessingButtons, renderProcessingInfo, renderProcessingInfoData, renderProcessingInfoImage, renderProcessingInfoSubtitle, renderProcessingInfoTitle, renderProcessingObjectName, renderRefreshButton, renderRegisterBone, renderSelf, renderShell, renderSubBlock, renderUserHelpAnchor, setBoneProperties, setDisplayMode, setHasSubBlock, setHeight, setIFrameDisplayMode, setIsDormant, setRenderSubBlock, setShellAttributeOnClosedComponent, setWidth, shouldDisplay, transform, transformForRequestCanceled, transformForRequestNotInited, transformForRequestProcessing

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

getLayoutDefinition, setLayoutDefinition, transformUsingLayout

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

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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.microstrategy.web.transform.LayoutTransform

getLayoutDefinition, setLayoutDefinition

Methods inherited from interface com.microstrategy.web.transform.Transform

canTransform, getFormalParams, getID, getPreview, isPreviewAvailable, isResolved, supports, supports, transform

Constructor Detail

PreferencesExportTransform

public PreferencesExportTransform()

Method Detail

renderFormStart

public void renderFormStart(MarkupOutput out,
                            WebEvent event)

Renders the start of the Preference's Form. This method also renders the hidden inputs associated with the event

Overrides:

renderFormStart in class AbstractPreferencesTransform

Parameters:

out - the output object

event - the WebEvent to render

renderFormEnd

public void renderFormEnd(MarkupOutput out,
                          WebEvent event)

Description copied from class: AbstractPreferencesTransform

Renders the Form end tag

Overrides:

renderFormEnd in class AbstractPreferencesTransform

Parameters:

out - where to write the output of the method.

Since:

MicroStrategy Web 8.0.1

getUniqueID

protected java.lang.String getUniqueID()

Returns:

a unique ID used to be appended to the target of the URL generated for exporting

Since:

MicroStrategy Web 8.0.1

getDescription

public java.lang.String getDescription()

Returns the textual description of the transform

Specified by:

getDescription in interface Transform

Overrides:

getDescription in class AbstractOptionsTransform

Returns:

the textual description of the transform

Since:

MicroStrategy Web 7.5.1

initializeTransform

public void initializeTransform(Transformable data)

This method initialize the private and protected fields of the transform. In particular it initialize the indent field based on the value of the initialIndent formal parameter, and the isDhtml() based on the bean's OutputFormat. It also invokes the initializeImages and initializeCss methods. This method is call from the transform method of the Transform instance.

Specified by:

initializeTransform in interface AppTransform

Overrides:

initializeTransform in class AbstractOptionsTransform

Parameters:

data - the bean to transform.

Since:

MicroStrategy Web 7.5.1

transformBody

public void transformBody(MarkupOutput out)

Generates the content for the PreferencesExportTransform Preference's dialog.

Overrides:

transformBody in class PreferencesGenericTransform

Parameters:

out - the output object

See Also:

AbstractPreferencesTransform.transformBody(com.microstrategy.web.beans.MarkupOutput)

renderPreference

public void renderPreference(java.lang.String preferenceName,
                             MarkupOutput out)

Deprecated.

Call the corresponding renderXXX method directly.

Render individual preferences based on the name provided

Overrides:

renderPreference in class PreferencesGenericTransform

Parameters:

preferenceName - name id of the preference

out - the Markup output

Since:

MicroStrategy Web 7.5.1

See Also:

AbstractPreferencesTransform.renderPreference(java.lang.String, com.microstrategy.web.beans.MarkupOutput)

renderExportSection

public void renderExportSection(MarkupOutput out)

Renders pulldown list for selecting whether to export the 'whole report' or the 'portion displayed'.

Parameters:

out - the output object

renderExportLimitsMessage

public void renderExportLimitsMessage(MarkupOutput out)

Renders section that shows the export limits message :'You cannot export this report..'. Used only in the options page.

Parameters:

out - the output object

renderExportFormatGrids

public void renderExportFormatGrids(MarkupOutput out)

Renders list of radio buttons with the possible export formats for grids. The export formats are initialized from a configuration file and are passed on exportFormatList

Parameters:

out - the output object

Since:

MicroStrategy Web 7.5.1

renderExportFormatGraphs

public void renderExportFormatGraphs(MarkupOutput out)

Renders list of radio buttons with the possible export formats for graphs. The export formats are initialized from a configuration file and are passed on exportFormatList.

Parameters:

out - the output object

Since:

MicroStrategy Web 7.5.1

renderExportFormatDocuments

public void renderExportFormatDocuments(MarkupOutput out)

Renders list of radio buttons with the possible export formats for documents. The export formats are initialized from a configuration file and are passed on exportFormatList.

Parameters:

out - the output object

Since:

MicroStrategy Web 7.5.1

renderNewWindow

public void renderNewWindow(MarkupOutput out)

Deprecated.

This preference has been moved to General Preferences

Renders checkbox for opening a new window when exporting. Displayed only in the preferences page.

Parameters:

out - the output object

renderMaxCells

public void renderMaxCells(MarkupOutput out)

Renders textboxes to enter the maximum number of cells to export. Displayed only on the preferences page on the Project Defaults section.

Parameters:

out - the output object

renderMaxCellsPlainText

public void renderMaxCellsPlainText(MarkupOutput out)

Renders textboxes to enter the maximum number of cells to export to plaintext. Displayed only on the preferences page on the Project Defaults section.

Parameters:

out - the output object

Since:

MicroStrategy Web 7.5.1

renderMaxCellsHTML

public void renderMaxCellsHTML(MarkupOutput out)

Renders textboxes to enter the maximum number of cells to export to HTML. Displayed only on the preferences page on the Project Defaults section.

Parameters:

out - the output object

Since:

MicroStrategy Web 7.5.1

renderExcelVersion

public void renderExcelVersion(MarkupOutput out)

Renders option for the Excel version

Parameters:

out - the output object

Since:

MicroStrategy Web 8.0.1

renderExportMetricValuesAsText

public void renderExportMetricValuesAsText(MarkupOutput out)

Renders checkboxes for exporting headers and metric values as text.

Parameters:

out - the output object

Since:

MicroStrategy Web 7.5.1

renderExportHeaderAsText

public void renderExportHeaderAsText(MarkupOutput out)

Renders checkboxes for exporting headers and metric values as text.

Parameters:

out - the output object

Since:

MicroStrategy Web 7.5.1

renderExportFilterDetails

public void renderExportFilterDetails(MarkupOutput out)

Renders checkbox for exporting the filter details.

Parameters:

out - the output object

renderExportReportTitle

public void renderExportReportTitle(MarkupOutput out)

Renders checkbox for exporting the filter details.

Parameters:

out - the output object

Since:

MicroStrategy Web 9.0.0

renderExportPageByInfo

public void renderExportPageByInfo(MarkupOutput out)

Renders checkbox for exporting the filter details.

Parameters:

out - the output object

Since:

MicroStrategy Web 9.0.0

renderEnableExportPDF

public void renderEnableExportPDF(MarkupOutput out)

Deprecated.

Renders checkbox for enabling export to PDF.

Parameters:

out - the output object

renderOptions

public void renderOptions(MarkupOutput out)

Renders checkbox for showing the options page before exporting.

Parameters:

out - the output object

renderExpandPageByFields

public void renderExpandPageByFields(MarkupOutput out)

Renders checkbox for expanding page by fields.

Parameters:

out - the output object

Since:

MicroStrategy Web 8.0.1

renderUseSeparateSheets

public void renderUseSeparateSheets(MarkupOutput out)

Renders checkbox for using separate sheets when exporting.

Parameters:

out - the output object

Since:

MicroStrategy Web 8.0.1

renderUseLiveChartGraphs

public void renderUseLiveChartGraphs(MarkupOutput out)

Renders checkbox for using bitmaps for graphs when exporting.

Parameters:

out - the output object

Since:

MicroStrategy Web 8.0.1

renderOverlapGridTitles

public void renderOverlapGridTitles(MarkupOutput out)

Renders checkbox for overlap the grid titles when exporting.

Parameters:

out - the output object

Since:

MicroStrategy Web 8.0.1

renderReportOfficeRefresh

public void renderReportOfficeRefresh(MarkupOutput out)

Allow MicroStrategy Office to refresh Reports after exporting to Excel

Parameters:

out - the output object

Since:

MicroStrategy Web 8.0.1

renderExportHeaderTextArea

public void renderExportHeaderTextArea(MarkupOutput out)

Deprecated.

we now use display this on a separate page

Renders the text area for Export Header in the Export tab of the Admin(Project Defaults) Preference page

Parameters:

out -

Since:

MicroStrategy Web 8.0.2

renderExportFooterTextArea

public void renderExportFooterTextArea(MarkupOutput out)

Deprecated.

we now use display this on a separate page

Renders the text area for Export Footer in the Export tab of the Admin(Project Defaults) Preference page

Parameters:

out -

Since:

MicroStrategy Web 8.0.2

getTitle

public java.lang.String getTitle()

Generates the Header of the Preferences dialog. Over ride the method in AbstractPreferenceTransform

Overrides:

getTitle in class AbstractOptionsTransform

Returns:

the Header of the Preferences dialog

transformFooter

protected void transformFooter(MarkupOutput out)

Generates the footer of the Preferences dialog

Overrides:

transformFooter in class AbstractPreferencesTransform

Parameters:

out - the output object

renderEmbedImages

public void renderEmbedImages(MarkupOutput out)

Renders checkbox for embedding images

Parameters:

out - the output object

Since:

MicroStrategy Web 9.0.0

isShowEmbedImagesForUser

public boolean isShowEmbedImagesForUser()

Returns:

true if the default setting hide the embed all images option

Since:

MicroStrategy Web 11.3.0

renderDoNotPrompt

public void renderDoNotPrompt(MarkupOutput out)
                       throws UnmodifiableException

Generates a checkbox to allow the user to save the "do not prompt me again" preferences in the options page.

Parameters:

out - the markup output object

Throws:

UnmodifiableException

Since:

MicroStrategy Web 8.0.1

renderExportButton

public void renderExportButton(MarkupOutput out)

Generates the submit input and related hidden inputs used to submit the information to export the report.

Parameters:

out - the markup output object

Since:

MicroStrategy Web 8.0.1

renderExportAdminHeaderFooterButton

public void renderExportAdminHeaderFooterButton(MarkupOutput out)

Renders link to edit the export admin header and footer.

Parameters:

out - the output object

Since:

MicroStrategy Web 9.0.0

renderEncodeCSVForExportingToExcel

public void renderEncodeCSVForExportingToExcel(MarkupOutput out)

Whether to encode the exporting CSV results as ISO8859_1 so they can be read using Excel.

Parameters:

out - the output object

Since:

MicroStrategy Web 9.0.0

renderJavascript

public void renderJavascript(MarkupOutput out)

Description copied from class: AbstractPreferencesTransform

This method is called to generate all javascript functions related to this transform.

Overrides:

renderJavascript in class AbstractPreferencesTransform

Since:

MicroStrategy Web 8.0.1

getExportFormatsCount

public int getExportFormatsCount()

Deprecated.

not used anymore

Returns:

the number of formats available for exporting

Since:

MicroStrategy Web 8.0.1

getExportEvent

public WebEvent getExportEvent()

Returns:

the event used to export the report.

Since:

MicroStrategy Web 8.0.1

getExportSavePropertiesEvent

public WebEvent getExportSavePropertiesEvent()

Deprecated.

use getSaveReportPropertiesEvent()

Returns:

the event used to save the corresponding report properties.

Since:

MicroStrategy Web 8.0.1

isCellsLimitExceeded

public boolean isCellsLimitExceeded()

Returns:

true if the number of rows in the report has exceeded the limit imposed by the administrator's preferences to use when exporting reports.

Since:

MicroStrategy Web 8.0.1

isNotExcel2000

public boolean isNotExcel2000()

Returns:

true if the version used is not Excel 2000 SR1 (set through preferences).

Since:

MicroStrategy Web 8.0.1

getExportEventID

protected java.lang.String getExportEventID()

Description copied from class: AbstractOptionsTransform

Returns the ID of the export event used when this transform is used for the Options Page (examples are Export, PDF and Print)
This will be used to pass as the "eventToForwardTo" on the Save Report Properties page.

Overrides:

getExportEventID in class AbstractOptionsTransform

Returns:

The ID of the final event used when this transform is used for the Options Page (examples are Export, PDF and Print)

Since:

MicroStrategy Web 9.0.0

getActionType

protected java.lang.String getActionType()

Overrides:

getActionType in class AbstractOptionsTransform

Returns:

the type of action (AbstractOptionsTransform.ACTION_TYPE_PDF, AbstractOptionsTransform.ACTION_TYPE_PRINT or AbstractOptionsTransform.ACTION_TYPE_EXPORT)

Since:

MicroStrategy Web 9.0.0