Class PreferencesExcelHeaderFooterTransform
- 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.PreferencesExcelHeaderFooterTransform
-
- All Implemented Interfaces:
AppTransform
,LayoutTransform
,Transform
public class PreferencesExcelHeaderFooterTransform extends AbstractHeaderFooterTransform
Transform to render the Sheet Header/Footer Editor for Excel.
Accessed via:- "Preferences > Export Reports > Export Header and Footer"
- "Export Options page (for reports) > Export Header and Footer"
- Since:
- MicroStrategy Web 9.0.0
-
-
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.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
-
-
Constructor Summary
Constructors Constructor Description PreferencesExcelHeaderFooterTransform()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected boolean
checkPropertiesPresent(java.lang.String propSetName)
java.lang.String
getTitle()
void
renderExcelFooter(MarkupOutput out)
Generate the footer section for excelvoid
renderExcelHeader(MarkupOutput out)
Generate the header section for excelvoid
renderExcelHeaderLocation(MarkupOutput out)
Generate the header section for excel-
Methods inherited from class com.microstrategy.web.app.transforms.AbstractHeaderFooterTransform
canHaveFilterDetailsMacro, getApplyEvent, getCancelEvent, getHeaderFooterPropertyValue, getMacros, getPopulateTextEvent, getSelectGroupEvent, initializeTransform, 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, renderPreference, renderRadio, renderShortcutListAsComboBox, renderTextBox, transformBody
-
Methods inherited from class com.microstrategy.web.app.transforms.AbstractPreferencesTransform
getFormID, getLoadDefaultsEvent, getPreference, getPreferencesBean, getPropertyValue, getUpdateEvent, initializeImages, isAdminLevel, renderApplyChangesCombobox, renderFormStart, renderImage, renderInvalidMessage, renderJavascript, 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, 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
-
-
-
-
Method Detail
-
renderExcelHeader
public void renderExcelHeader(MarkupOutput out)
Generate the header section for excel- Parameters:
out
-MarkupOutput
instance where the HTML output generated will be saved
-
renderExcelHeaderLocation
public void renderExcelHeaderLocation(MarkupOutput out)
Generate the header section for excel- Parameters:
out
-MarkupOutput
instance where the HTML output generated will be saved
-
renderExcelFooter
public void renderExcelFooter(MarkupOutput out)
Generate the footer section for excel- Parameters:
out
-MarkupOutput
instance where the HTML output generated will be saved
-
checkPropertiesPresent
protected boolean checkPropertiesPresent(java.lang.String propSetName)
- Overrides:
checkPropertiesPresent
in classAbstractHeaderFooterTransform
-
getTitle
public java.lang.String getTitle()
- Overrides:
getTitle
in classAbstractHeaderFooterTransform
- Returns:
- String value representing the title of this preferences dialog
-
-