Package com.microstrategy.web.app.transforms

Class AbstractHeaderFooterTransform

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

All Implemented Interfaces:

AppTransform, LayoutTransform, Transform

Direct Known Subclasses:

PreferencesExcelHeaderFooterTransform, PreferencesExportAdminHeaderFooterTransform, PreferencesPDFReportHeaderFooterTransform, PreferencesPrintHeaderFooterTransform

public abstract class AbstractHeaderFooterTransform
extends AbstractOptionsTransform

Abstract class for all transforms that display a header/footer editor on preferences or Options pages.
Used for Exporting, Printing and PDF

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

Modifier and Type	Field	Description
static java.lang.String	EXCEL_FOOTER_PANEL	Identifier for the Excel footer panel
static java.lang.String	EXCEL_HEADER_PANEL	Identifier for the Excel header panel
static java.lang.String	FOOTER_CENTER_PANEL	Identifier for the center footer panel
static java.lang.String	FOOTER_LEFT_PANEL	Identifier for the left footer panel
static java.lang.String	FOOTER_RIGHT_PANEL	Identifier for the right footer panel
static java.lang.String	HEADER_CENTER_PANEL	Identifier for the center header panel
static java.lang.String	HEADER_LEFT_PANEL	Identifier for the left header panel
static java.lang.String	HEADER_RIGHT_PANEL	Identifier for the right header panel
static java.lang.String	PDF_REPORT_HEADER_PANEL	Identifier for the pdf report header panel
protected FormalParameter	prevGroupName	Specifies the name of the previous group preferences.

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
AbstractHeaderFooterTransform()	Default empty constructor.

Method Summary

Modifier and Type	Method	Description
boolean	canHaveFilterDetailsMacro()	Returns true if the macro to add filter-details is available.
protected boolean	checkPropertiesPresent(java.lang.String propSetName)
WebEvent	getApplyEvent()	Returns the event used to apply the editor's changes
WebEvent	getCancelEvent()
protected java.lang.String	getHeaderFooterPropertyValue(java.lang.String prefName, java.lang.String propSetName, java.lang.String propName)
protected java.util.List	getMacros()
WebEvent	getPopulateTextEvent()	Returns the event used to populate the editor with the preferences values
WebEvent	getSelectGroupEvent()	This is the event used to return to the preferences page after editing headers and footers.
java.lang.String	getTitle()
void	initializeTransform(Transformable data)	Initialize the private and protected fields of the transform.
void	renderApplyChanges(MarkupOutput out)	Renders the "Apply" changes section.
void	renderApplyChangesButton(MarkupOutput out)	This method generates the "Apply" button to save current changes.
void	renderCancelButton(MarkupOutput out)	This method generates the "Cancel" button to go back to the previous dialog discarding changes.
void	renderFormEnd(MarkupOutput out, WebEvent event)	Renders the Form end tag
protected void	renderHeaderFooterTextArea(MarkupOutput out, java.lang.String prefName, java.lang.String value)
protected void	renderHeaderFooterTextArea(MarkupOutput out, java.lang.String prefName, java.lang.String value, boolean defaultSelection)
void	renderMacroPulldown(MarkupOutput out)	Renders a pulldown (select box) with the list of macros supported on the editor
protected void	renderSelectGroupHiddenInputs(MarkupOutput out)	This method generates hidden inputs for the select group event, used to go back to the preferences page.
protected void	transformFooter(MarkupOutput out)	Generates the footer of the Preferences dialog

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

Field Detail

HEADER_LEFT_PANEL

public static final java.lang.String HEADER_LEFT_PANEL

Identifier for the left header panel

See Also:

Constant Field Values

HEADER_CENTER_PANEL

public static final java.lang.String HEADER_CENTER_PANEL

Identifier for the center header panel

See Also:

Constant Field Values

HEADER_RIGHT_PANEL

public static final java.lang.String HEADER_RIGHT_PANEL

Identifier for the right header panel

See Also:

Constant Field Values

FOOTER_LEFT_PANEL

public static final java.lang.String FOOTER_LEFT_PANEL

Identifier for the left footer panel

See Also:

Constant Field Values

FOOTER_CENTER_PANEL

public static final java.lang.String FOOTER_CENTER_PANEL

Identifier for the center footer panel

See Also:

Constant Field Values

FOOTER_RIGHT_PANEL

public static final java.lang.String FOOTER_RIGHT_PANEL

Identifier for the right footer panel

See Also:

Constant Field Values

EXCEL_HEADER_PANEL

public static final java.lang.String EXCEL_HEADER_PANEL

Identifier for the Excel header panel

See Also:

Constant Field Values

EXCEL_FOOTER_PANEL

public static final java.lang.String EXCEL_FOOTER_PANEL

Identifier for the Excel footer panel

See Also:

Constant Field Values

PDF_REPORT_HEADER_PANEL

public static final java.lang.String PDF_REPORT_HEADER_PANEL

Identifier for the pdf report header panel

See Also:

Constant Field Values

prevGroupName

protected FormalParameter prevGroupName

Specifies the name of the previous group preferences. We will go to this group if the button \"Cancel\" is clicked on the form.
Allowed Values:
The available preferences groups are specified in the preferencesGroups file.

Constructor Detail

AbstractHeaderFooterTransform

public AbstractHeaderFooterTransform()

Default empty constructor.
Initialize formal parameters.

Method Detail

initializeTransform

public void initializeTransform(Transformable data)

Initialize the private and protected fields of the transform.

Specified by:

initializeTransform in interface AppTransform

Overrides:

initializeTransform in class AbstractOptionsTransform

Parameters:

data - Transformable instance representing the information being transformed

getHeaderFooterPropertyValue

protected java.lang.String getHeaderFooterPropertyValue(java.lang.String prefName,
                                                        java.lang.String propSetName,
                                                        java.lang.String propName)

renderHeaderFooterTextArea

protected void renderHeaderFooterTextArea(MarkupOutput out,
                                          java.lang.String prefName,
                                          java.lang.String value)

renderHeaderFooterTextArea

protected void renderHeaderFooterTextArea(MarkupOutput out,
                                          java.lang.String prefName,
                                          java.lang.String value,
                                          boolean defaultSelection)

checkPropertiesPresent

protected boolean checkPropertiesPresent(java.lang.String propSetName)

renderMacroPulldown

public void renderMacroPulldown(MarkupOutput out)

Renders a pulldown (select box) with the list of macros supported on the editor

Parameters:

out - the markup output where to render the pulldown

getMacros

protected java.util.List getMacros()

canHaveFilterDetailsMacro

public boolean canHaveFilterDetailsMacro()

Returns true if the macro to add filter-details is available.

renderCancelButton

public void renderCancelButton(MarkupOutput out)

This method generates the "Cancel" button to go back to the previous dialog discarding changes.

Overrides:

renderCancelButton in class AbstractAppTransform

Parameters:

out - output for this transform

renderApplyChanges

public void renderApplyChanges(MarkupOutput out)

Renders the "Apply" changes section.
If used for preferences it calls AbstractPreferencesTransform.renderApplyChangesCombobox(MarkupOutput)

Overrides:

renderApplyChanges in class AbstractPreferencesTransform

renderApplyChangesButton

public void renderApplyChangesButton(MarkupOutput out)

This method generates the "Apply" button to save current changes.

Overrides:

renderApplyChangesButton in class AbstractPreferencesTransform

getPopulateTextEvent

public WebEvent getPopulateTextEvent()

Returns the event used to populate the editor with the preferences values

Returns:

a WebEvent used to populate the editor's values.

getApplyEvent

public WebEvent getApplyEvent()

Returns the event used to apply the editor's changes

Returns:

a WebEvent used to apply the editor's changes

getCancelEvent

public WebEvent getCancelEvent()

Overrides:

getCancelEvent in class AbstractAppTransform

Returns:

WebEvent instance initialized with the information for cancelling a request

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.

renderSelectGroupHiddenInputs

protected void renderSelectGroupHiddenInputs(MarkupOutput out)

This method generates hidden inputs for the select group event, used to go back to the preferences page.

getSelectGroupEvent

public WebEvent getSelectGroupEvent()

This is the event used to return to the preferences page after editing headers and footers.

transformFooter

protected void transformFooter(MarkupOutput out)

Description copied from class: AbstractPreferencesTransform

Generates the footer of the Preferences dialog

Overrides:

transformFooter in class AbstractPreferencesTransform

Parameters:

out - where to create the output

getTitle

public java.lang.String getTitle()

Overrides:

getTitle in class AbstractOptionsTransform

Returns:

String value representing the title of this preferences dialog