Events reference: com.microstrategy.web.app.beans.OptionsBean

Supported Bean: OptionsBean

The OptionsBean is an application level bean that allows end users to set their preferences values. This bean extends the preferences bean and used specifically for the Print/PDF/Export options. This bean uses most of the methods and logic that it inherits from its parent. the only difference being the setters and getters for the header/footer text and the getter for the report bean. The state of this bean is also an extension of its parent with the information of the header/footer text as a part of the state.

Event handler: com.microstrategy.web.app.beans.EnumSysBeanTypes.AppBeanOptions (42)

Application bean type for the Print/Export/PDF Options bean

Events

applyExportAdminHeaderFooterEditor, applyHeaderFooterEditor, cancelHeaderFooterEditor, loadProjectDefaults, populatePrintHeaderFooteTextArea, selectGroup, selectGroupSet, showAdvancedPrintOptions, showExportAdminHeaderFooterEditor, showPDFReportHeaderEditor, showProjectHeaderFooterEditor, updatePreferences, validatePreferences

applyExportAdminHeaderFooterEditor
Event for the apply button on the Export Admin Header and Footer Editor			25016	EnumPreferencesEvents.WebEventApplyExportAdminHeaderFooterEditor
	allProjects	event argument: apply changes to all projects	25004	EnumPreferencesEvents.WebEventArgumentAllProjects
	applyPrefLevel	event argument: level that to which to set the preferences values.	25002	EnumPreferencesEvents.WebEventArgumentPreferencesLevel
applyHeaderFooterEditor
Event for the apply button on the Header and Footer Editor			25014	EnumPreferencesEvents.WebEventApplyHeaderFooterEditor
	allProjects	event argument: apply changes to all projects	25004	EnumPreferencesEvents.WebEventArgumentAllProjects
	applyPrefLevel	event argument: level that to which to set the preferences values.	25002	EnumPreferencesEvents.WebEventArgumentPreferencesLevel
cancelHeaderFooterEditor
Event for the cancel button on the Header and Footer Editor			25015	EnumPreferencesEvents.WebEventCancelHeaderFooterEditor
loadProjectDefaults
event to load the project defaults			25008	EnumPreferencesEvents.WebEventLoadProjectDefaults
	allProjects	event argument: apply changes to all projects	25004	EnumPreferencesEvents.WebEventArgumentAllProjects
	level	event argument: level that to which to set the preferences values.	25002	EnumPreferencesEvents.WebEventArgumentPreferencesLevel
populatePrintHeaderFooteTextArea
event to populate the left/right/center textarea of the header/footer editor:			25005	EnumPreferencesEvents.WebEventPopulatePrintHeaderFooteTextArea
	addMacro	event argument: argument to add a macro to the header or footer	25040	EnumPreferencesEvents.WebEventArgumentAddMacro
	allProjects	event argument: apply changes to all projects	25004	EnumPreferencesEvents.WebEventArgumentAllProjects
	macroName	event argument: argument that indicates the name of the macro to add to the header or footer	25041	EnumPreferencesEvents.WebEventArgumentMacroName
	prefLevel	event argument: level that to which to set the preferences values.	25002	EnumPreferencesEvents.WebEventArgumentPreferencesLevel
	section	event argument: argument to denote the section where the details should be added	25017	EnumPreferencesEvents.WebEventArgumentPrintSectionName
selectGroup
event to change the current group			25002	EnumPreferencesEvents.WebEventSelectPreferencesGroup
	keepPreferences	event argument: argument to temporarily keep the value of the preferences. The preferences do not get saved to the metadata until the event `EnumPreferencesEvents.WebEventUpdatePreferences` is submited from the page that contains those preferences. Possible values: `PreferencesBean.SAVE_TEMP_PREFERENCE` - Save the preferences temporarily. `PreferencesBean.KEEP_TEMP_PREFERENCE` - Keep the current temporary preferences. If the argument is not specified when calling the event `EnumPreferencesEvents.WebEventSelectPreferencesGroup`, the current temporary preferences will be deleted. Note: Used to keep the preferences value when moving between the Print/PDF and the Header Footer Editor.	25028	EnumPreferencesEvents.WebEventArgumentKeepTempPreferences
	prevGroupName	event argument: argument to denote the name of the previous group preferences. Used on the header/footer editor to know what preferences group to go to when users submit the form.	25029	EnumPreferencesEvents.WebEventArgumentPrevGroupName
	target	event argument: target parameter for the group/group-set that will be selected.	25001	EnumPreferencesEvents.WebEventArgumentTarget
selectGroupSet
event to change the current group-set			25001	EnumPreferencesEvents.WebEventSelectPreferencesGroupSet
	target	event argument: target parameter for the group/group-set that will be selected.	25001	EnumPreferencesEvents.WebEventArgumentTarget
showAdvancedPrintOptions
event to show or hide the advanced print preferences:			25004	EnumPreferencesEvents.WebEventShowAdvancedOptions
	showAdvPrintOptions	event argument: show advanced print preferences	25006	EnumPreferencesEvents.WebEventArgumentShowAdvancedPrintPreferences
showExportAdminHeaderFooterEditor
event to display the export admin Header Footer Editor			25013	EnumPreferencesEvents.WebEventShowExportAdminHeaderFooterEditor
	keepPreferences	event argument: argument to temporarily keep the value of the preferences. The preferences do not get saved to the metadata until the event `EnumPreferencesEvents.WebEventUpdatePreferences` is submited from the page that contains those preferences. Possible values: `PreferencesBean.SAVE_TEMP_PREFERENCE` - Save the preferences temporarily. `PreferencesBean.KEEP_TEMP_PREFERENCE` - Keep the current temporary preferences. If the argument is not specified when calling the event `EnumPreferencesEvents.WebEventSelectPreferencesGroup`, the current temporary preferences will be deleted. Note: Used to keep the preferences value when moving between the Print/PDF and the Header Footer Editor.	25028	EnumPreferencesEvents.WebEventArgumentKeepTempPreferences
	prevGroupName	event argument: argument to denote the name of the previous group preferences. Used on the header/footer editor to know what preferences group to go to when users submit the form.	25029	EnumPreferencesEvents.WebEventArgumentPrevGroupName
showPDFReportHeaderEditor
event to display the PDF Report Header Editor			25012	EnumPreferencesEvents.WebEventShowPDFReportHeaderEditor
	keepPreferences	event argument: argument to temporarily keep the value of the preferences. The preferences do not get saved to the metadata until the event `EnumPreferencesEvents.WebEventUpdatePreferences` is submited from the page that contains those preferences. Possible values: `PreferencesBean.SAVE_TEMP_PREFERENCE` - Save the preferences temporarily. `PreferencesBean.KEEP_TEMP_PREFERENCE` - Keep the current temporary preferences. If the argument is not specified when calling the event `EnumPreferencesEvents.WebEventSelectPreferencesGroup`, the current temporary preferences will be deleted. Note: Used to keep the preferences value when moving between the Print/PDF and the Header Footer Editor.	25028	EnumPreferencesEvents.WebEventArgumentKeepTempPreferences
	prevGroupName	event argument: argument to denote the name of the previous group preferences. Used on the header/footer editor to know what preferences group to go to when users submit the form.	25029	EnumPreferencesEvents.WebEventArgumentPrevGroupName
showProjectHeaderFooterEditor
event to display the Header/Footer Editor displaying the Project level settings.			25007	EnumPreferencesEvents.WebEventShowProjectHeaderFooterEditor
	keepPreferences	event argument: argument to temporarily keep the value of the preferences. The preferences do not get saved to the metadata until the event `EnumPreferencesEvents.WebEventUpdatePreferences` is submited from the page that contains those preferences. Possible values: `PreferencesBean.SAVE_TEMP_PREFERENCE` - Save the preferences temporarily. `PreferencesBean.KEEP_TEMP_PREFERENCE` - Keep the current temporary preferences. If the argument is not specified when calling the event `EnumPreferencesEvents.WebEventSelectPreferencesGroup`, the current temporary preferences will be deleted. Note: Used to keep the preferences value when moving between the Print/PDF and the Header Footer Editor.	25028	EnumPreferencesEvents.WebEventArgumentKeepTempPreferences
	prevGroupName	event argument: argument to denote the name of the previous group preferences. Used on the header/footer editor to know what preferences group to go to when users submit the form.	25029	EnumPreferencesEvents.WebEventArgumentPrevGroupName
	target	event argument: target parameter for the group/group-set that will be selected.	25001	EnumPreferencesEvents.WebEventArgumentTarget
updatePreferences
event to update the preferences values:			25003	EnumPreferencesEvents.WebEventUpdatePreferences
	addFont	event argument: argument to denote the add button of the font names shopping cart.	25022	EnumPreferencesEvents.WebEventArgumentAddFont
	allProjects	event argument: apply changes to all projects	25004	EnumPreferencesEvents.WebEventArgumentAllProjects
	apply	event argument: apply changes	25003	EnumPreferencesEvents.WebEventArgumentApply
	availableFonts	event argument: argument to denote the list of available fonts in the system.	25026	EnumPreferencesEvents.WebEventArgumentAvailableFonts
	defaults	event argument: load default values	25005	EnumPreferencesEvents.WebEventArgumentLoadDefaults
	level	event argument: level that to which to set the preferences values.	25002	EnumPreferencesEvents.WebEventArgumentPreferencesLevel
	moveFontDown	event argument: argument to denote the move down button of the font names shopping cart.	25025	EnumPreferencesEvents.WebEventArgumentMoveFontDown
	moveFontUp	event argument: argument to denote the move up button of the font names shopping cart.	25024	EnumPreferencesEvents.WebEventArgumentMoveFontUp
	removeFont	event argument: argument to denote the remove button of the font names shopping cart.	25023	EnumPreferencesEvents.WebEventArgumentRemoveFont
	selectedFonts	event argument: argument to denote the selected fonts.	25027	EnumPreferencesEvents.WebEventArgumentSelectedFonts
validatePreferences
event to validate the values of the preferences which are submitted:			25006	EnumPreferencesEvents.WebEventValidatePreferences
	level	event argument: level that to which to set the preferences values.	25002	EnumPreferencesEvents.WebEventArgumentPreferencesLevel

Notes

* denotes required field.