Class PreferencesPrintHeaderFooterTransform
- 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.AbstractHeaderFooterTransform
-
- com.microstrategy.web.app.transforms.PreferencesPrintHeaderFooterTransform
-
- All Implemented Interfaces:
AppTransform
,EnumWebPreferences
,LayoutTransform
,Transform
public class PreferencesPrintHeaderFooterTransform extends AbstractHeaderFooterTransform implements EnumWebPreferences
This is the transform that render the Print Header/Footer editor. Accessed via:- "Preferences > Print Reports > Header and Footer"
- "Print Options page (for reports) > Header and Footer"
- Since:
- MicroStrategy Web 7.3.1 or earlier
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description protected static class
PreferencesPrintHeaderFooterTransform.ImageButtonInformation
This class provides the fields necessary to generate an image for a macro button.-
Nested classes/interfaces inherited from class com.microstrategy.web.app.transforms.AbstractAppTransform
AbstractAppTransform.Context
-
-
Field Summary
Fields Modifier and Type Field Description protected boolean
_hasReportProperties
protected HashList
_projectPropertyValues
protected HashList
_propertyValues
protected FormalParameter
dateImage
Deprecated.image is not used anymore as we now use a pulldownprotected FormalParameter
filterDetailsImage
Deprecated.image is not used anymore as we now use a pulldownprotected FormalParameter
filterNameImage
Deprecated.image is not used anymore as we now use a pulldownprotected FormalParameter
numberOfPagesImage
Deprecated.image is not used anymore as we now use a pulldownprotected FormalParameter
pageByImage
Deprecated.image is not used anymore as we now use a pulldownprotected FormalParameter
pageNumberImage
Deprecated.image is not used anymore as we now use a pulldownprotected FormalParameter
projectNameImage
Deprecated.image is not used anymore as we now use a pulldownprotected FormalParameter
reportNameImage
Deprecated.image is not used anymore as we now use a pulldownprotected FormalParameter
templateNameImage
Deprecated.image is not used anymore as we now use a pulldownprotected FormalParameter
timeImage
Deprecated.image is not used anymore as we now use a pulldownprotected FormalParameter
userNameImage
Deprecated.image is not used anymore as we now use a pulldown-
Fields inherited from class com.microstrategy.web.app.transforms.AbstractHeaderFooterTransform
EXCEL_FOOTER_PANEL, EXCEL_HEADER_PANEL, FOOTER_CENTER_PANEL, FOOTER_LEFT_PANEL, FOOTER_RIGHT_PANEL, HEADER_CENTER_PANEL, HEADER_LEFT_PANEL, HEADER_RIGHT_PANEL, PDF_REPORT_HEADER_PANEL, prevGroupName
-
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 PreferencesPrintHeaderFooterTransform()
Default empty constructor.
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description boolean
canHavePageByMacro()
Returnstrue
if the macro to add page-by information is available.protected AnchorTag
generateAnchor(WebEvent event)
Overwrites the parent method by setting special attributes if the event is not providedprotected void
generateImageAnchor(MarkupOutput out, java.lang.String name, java.lang.String imageSource, java.lang.String tooltip)
Generate an image anchor for the options for the print header/footer preferences, depending if the current environment is HTML or DHTML.protected void
generateOptions(MarkupOutput out)
Generate the different options the user can add to the header/footer, such as date, page number, etc.protected java.util.ArrayList
getButtonList()
Returns the list of available macros for the headers and footers.void
initializeImages()
Initialize the images to be used by this transform.void
initializeTransform(Transformable data)
Initialize the private and protected fields of the transform.void
renderFooterCenter(MarkupOutput out)
Render the center footer portion of the preferences dialogvoid
renderFooterLeft(MarkupOutput out)
Render the left footer portion of the preferences dialogvoid
renderFooterRight(MarkupOutput out)
Render the right footer portion of the preferences dialogvoid
renderHeaderCenter(MarkupOutput out)
Render the center header portion of the preferences dialogvoid
renderHeaderLeft(MarkupOutput out)
Generate the left header portion of the preferences dialogvoid
renderHeaderRight(MarkupOutput out)
Render the right header portion of the preferences dialogprotected void
renderJavascript(MarkupOutput out)
This method is called to generate all javascript functions related to this transform.void
renderMacroButtons(MarkupOutput out)
Renders the list of macros fields available for the headers and footers of a report.void
renderPreference(java.lang.String preferenceName, MarkupOutput out)
Deprecated.Call the corresponding renderXXX method directly.void
transformBody(MarkupOutput out)
Generates the content for the Print header footer Preference's dialog.-
Methods inherited from class com.microstrategy.web.app.transforms.AbstractHeaderFooterTransform
canHaveFilterDetailsMacro, checkPropertiesPresent, getApplyEvent, getCancelEvent, getHeaderFooterPropertyValue, getMacros, getPopulateTextEvent, getSelectGroupEvent, getTitle, renderApplyChanges, renderApplyChangesButton, renderCancelButton, renderFormEnd, renderHeaderFooterTextArea, renderHeaderFooterTextArea, renderMacroPulldown, renderSelectGroupHiddenInputs, transformFooter
-
Methods inherited from class com.microstrategy.web.app.transforms.AbstractOptionsTransform
getActionType, getDescription, getExportEventID, 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, isAdminLevel, renderApplyChangesCombobox, renderFormStart, 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, 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, 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, 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
-
-
-
-
Field Detail
-
pageNumberImage
protected FormalParameter pageNumberImage
Deprecated.image is not used anymore as we now use a pulldownSpecifies the image on the header/footer editor's toolbar used for adding the page number to a header/footer section.
Allowed Values:
The value to indicate should be a valid image file name, with any necessary path information not included already on theresourcesFolderImage
application configuration parameter.
-
numberOfPagesImage
protected FormalParameter numberOfPagesImage
Deprecated.image is not used anymore as we now use a pulldownSpecifies the image on the header/footer editor's toolbar used for adding the number of pages to a header/footer section.
Allowed Values:
The value to indicate should be a valid image file name, with any necessary path information not included already on theresourcesFolderImage
application configuration parameter.
-
dateImage
protected FormalParameter dateImage
Deprecated.image is not used anymore as we now use a pulldownSpecifies the image on the header/footer editor's toolbar used for adding the date to a header/footer section.
Allowed Values:
The value to indicate should be a valid image file name, with any necessary path information not included already on theresourcesFolderImage
application configuration parameter.
-
timeImage
protected FormalParameter timeImage
Deprecated.image is not used anymore as we now use a pulldownSpecifies the image on the header/footer editor's toolbar used for adding the time to a header/footer section.
Allowed Values:
The value to indicate should be a valid image file name, with any necessary path information not included already on theresourcesFolderImage
application configuration parameter.
-
projectNameImage
protected FormalParameter projectNameImage
Deprecated.image is not used anymore as we now use a pulldownSpecifies the image on the header/footer editor's toolbar used for adding the project name to a header/footer section.
Allowed Values:
The value to indicate should be a valid image file name, with any necessary path information not included already on theresourcesFolderImage
application configuration parameter.
-
reportNameImage
protected FormalParameter reportNameImage
Deprecated.image is not used anymore as we now use a pulldownSpecifies the image on the header/footer editor's toolbar used for adding the report name to a header/footer section.
Allowed Values:
The value to indicate should be a valid image file name, with any necessary path information not included already on theresourcesFolderImage
application configuration parameter.
-
templateNameImage
protected FormalParameter templateNameImage
Deprecated.image is not used anymore as we now use a pulldownSpecifies the image on the header/footer editor's toolbar used for adding the template name to a header/footer section.
Allowed Values:
The value to indicate should be a valid image file name, with any necessary path information not included already on theresourcesFolderImage
application configuration parameter.
-
filterNameImage
protected FormalParameter filterNameImage
Deprecated.image is not used anymore as we now use a pulldownSpecifies the image on the header/footer editor's toolbar used for adding the filter name to a header/footer section.
Allowed Values:
The value to indicate should be a valid image file name, with any necessary path information not included already on theresourcesFolderImage
application configuration parameter.
-
filterDetailsImage
protected FormalParameter filterDetailsImage
Deprecated.image is not used anymore as we now use a pulldownSpecifies the image on the header/footer editor's toolbar used for adding the filter details to a header/footer section.
Allowed Values:
The value to indicate should be a valid image file name, with any necessary path information not included already on theresourcesFolderImage
application configuration parameter.
-
userNameImage
protected FormalParameter userNameImage
Deprecated.image is not used anymore as we now use a pulldownSpecifies the image on the header/footer editor's toolbar used for adding the user name to a header/footer section.
Allowed Values:
The value to indicate should be a valid image file name, with any necessary path information not included already on theresourcesFolderImage
application configuration parameter.
-
pageByImage
protected FormalParameter pageByImage
Deprecated.image is not used anymore as we now use a pulldownSpecifies the image on the header/footer editor's toolbar used for adding the page-by information to a header/footer section.
Allowed Values:
The value to indicate should be a valid image file name, with any necessary path information not included already on theresourcesFolderImage
application configuration parameter.
-
_hasReportProperties
protected boolean _hasReportProperties
- Since:
- MicroStrategy Web 8.0.1
-
_propertyValues
protected HashList _propertyValues
- Since:
- MicroStrategy Web 8.0.1
-
_projectPropertyValues
protected HashList _projectPropertyValues
- Since:
- MicroStrategy Web 8.0.1
-
-
Method Detail
-
initializeTransform
public void initializeTransform(Transformable data)
Initialize the private and protected fields of the transform.- Specified by:
initializeTransform
in interfaceAppTransform
- Overrides:
initializeTransform
in classAbstractHeaderFooterTransform
- Parameters:
data
-Transformable
instance representing the information being transformed
-
transformBody
public void transformBody(MarkupOutput out)
Generates the content for the Print header footer Preference's dialog.- Overrides:
transformBody
in classPreferencesGenericTransform
- Parameters:
out
- the body content- See Also:
AbstractPreferencesTransform.transformBody(com.microstrategy.web.beans.MarkupOutput)
-
generateAnchor
protected AnchorTag generateAnchor(WebEvent event)
Overwrites the parent method by setting special attributes if the event is not provided- Overrides:
generateAnchor
in classAbstractAppTransform
- Parameters:
event
-WebEvent
instance from where the anchor will be constructed- Returns:
AnchorTag
initialized instance with the information as provided- Since:
- MicroStrategy Web 8.0.0
-
generateOptions
protected void generateOptions(MarkupOutput out)
Generate the different options the user can add to the header/footer, such as date, page number, etc.- Parameters:
out
- MarkupOutput instance where the HTML content will be saved.- Since:
- MicroStrategy Web 8.0.0
-
renderMacroButtons
public void renderMacroButtons(MarkupOutput out)
Renders the list of macros fields available for the headers and footers of a report. Each macro is rendered as a button, when the button is clicked, the macro's text is appended to the currently selected field.
The list of available macros is obtained from thegetButtonList()
method.- Since:
- MicroStrategy Web 8.0.1
-
getButtonList
protected java.util.ArrayList getButtonList()
Returns the list of available macros for the headers and footers. Each member of the returnedArrayList
is an instance of anPreferencesPrintHeaderFooterTransform.ImageButtonInformation
class.- Since:
- MicroStrategy Web 8.0.0
-
canHavePageByMacro
public boolean canHavePageByMacro()
Returnstrue
if the macro to add page-by information is available.- Since:
- MicroStrategy Web 8.0.1
-
generateImageAnchor
protected void generateImageAnchor(MarkupOutput out, java.lang.String name, java.lang.String imageSource, java.lang.String tooltip)
Generate an image anchor for the options for the print header/footer preferences, depending if the current environment is HTML or DHTML.- Parameters:
out
- MarkupOutput instance where the HTML content generated will be saved.name
- String name of the image to renderimageSource
- String location of the image to displaytooltip
- String with tooltip information about the button to render- Since:
- MicroStrategy Web 8.0.0
-
initializeImages
public void initializeImages()
Description copied from class:AbstractPreferencesTransform
Initialize the images to be used by this transform.- Overrides:
initializeImages
in classAbstractPreferencesTransform
-
renderJavascript
protected 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 classAbstractPreferencesTransform
- Since:
- MicroStrategy Web 8.0.1
-
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 classPreferencesGenericTransform
- Parameters:
preferenceName
- name id of the preferenceout
-MarkupOutput
instance where the HTML output will be saved- Since:
- MicroStrategy Web 7.5.1
- See Also:
AbstractPreferencesTransform.renderPreference(java.lang.String, com.microstrategy.web.beans.MarkupOutput)
-
renderHeaderLeft
public void renderHeaderLeft(MarkupOutput out)
Generate the left header portion of the preferences dialog- Parameters:
out
-MarkupOutput
instance where the HTML output generated will be saved- Since:
- MicroStrategy Web 7.5.1
-
renderHeaderCenter
public void renderHeaderCenter(MarkupOutput out)
Render the center header portion of the preferences dialog- Parameters:
out
-MarkupOutput
instance where the HTML output generated will be saved- Since:
- MicroStrategy Web 7.5.1
-
renderHeaderRight
public void renderHeaderRight(MarkupOutput out)
Render the right header portion of the preferences dialog- Parameters:
out
-MarkupOutput
instance where the HTML output generated will be saved- Since:
- MicroStrategy Web 7.5.1
-
renderFooterLeft
public void renderFooterLeft(MarkupOutput out)
Render the left footer portion of the preferences dialog- Parameters:
out
-MarkupOutput
instance where the HTML output generated will be saved- Since:
- MicroStrategy Web 7.5.1
-
renderFooterCenter
public void renderFooterCenter(MarkupOutput out)
Render the center footer portion of the preferences dialog- Parameters:
out
-MarkupOutput
instance where the HTML output generated will be saved- Since:
- MicroStrategy Web 7.5.1
-
renderFooterRight
public void renderFooterRight(MarkupOutput out)
Render the right footer portion of the preferences dialog- Parameters:
out
-MarkupOutput
instance where the HTML output generated will be saved- Since:
- MicroStrategy Web 7.5.1
-
-