public interface

EnumPreferencesEvents

implements EnumPageEvents
com.microstrategy.web.app.beans.EnumPreferencesEvents

Summary

Constants
int WebEventAddCustomPromptStyle Event to add a new custom prompt style.
int WebEventApplyExportAdminHeaderFooterEditor Event for the apply button on the Export Admin Header and Footer Editor
int WebEventApplyHeaderFooterEditor Event for the apply button on the Header and Footer Editor
int WebEventArgumentAddFont event argument: argument to denote the add button of the font names shopping cart.
int WebEventArgumentAddMacro event argument: argument to add a macro to the header or footer
int WebEventArgumentAdvancedSettingDiv
int WebEventArgumentAdvancedSettingVisibility
int WebEventArgumentAllProjects event argument: apply changes to all projects
int WebEventArgumentApply event argument: apply changes
int WebEventArgumentAvailableFonts event argument: argument to denote the list of available fonts in the system.
int WebEventArgumentCustomStyleToAddBaseStyle
int WebEventArgumentCustomStyleToAddDescription
int WebEventArgumentCustomStyleToAddName
int WebEventArgumentCustomStyleToAddPromptType
int WebEventArgumentCustomStyleToDeleteBaseStyle
int WebEventArgumentCustomStyleToDeleteDescription
int WebEventArgumentCustomStyleToDeleteName
int WebEventArgumentCustomStyleToDeletePromptType
int WebEventArgumentDynamicDiv For dynamic sections event arguments
int WebEventArgumentDynamicDivVisibility
int WebEventArgumentKeepTempPreferences event argument: argument to temporarily keep the value of the preferences.
int WebEventArgumentLoadDefaults event argument: load default values
int WebEventArgumentMacroName event argument: argument that indicates the name of the macro to add to the header or footer
int WebEventArgumentMoveFontDown event argument: argument to denote the move down button of the font names shopping cart.
int WebEventArgumentMoveFontUp event argument: argument to denote the move up button of the font names shopping cart.
int WebEventArgumentPreferencesLevel event argument: level that to which to set the preferences values.
int WebEventArgumentPrevGroupName event argument: argument to denote the name of the previous group preferences.
int WebEventArgumentPrintAddDate This constant is deprecated. we now use WebEventArgumentAddMacro and WebEventArgumentMacroName
int WebEventArgumentPrintAddFilterDetails This constant is deprecated. we now use WebEventArgumentAddMacro and WebEventArgumentMacroName
int WebEventArgumentPrintAddFilterName This constant is deprecated. we now use WebEventArgumentAddMacro and WebEventArgumentMacroName
int WebEventArgumentPrintAddNumberPages This constant is deprecated. we now use WebEventArgumentAddMacro and WebEventArgumentMacroName
int WebEventArgumentPrintAddPage This constant is deprecated. we now use WebEventArgumentAddMacro and WebEventArgumentMacroName
int WebEventArgumentPrintAddPageBy This constant is deprecated. we now use WebEventArgumentAddMacro and WebEventArgumentMacroName
int WebEventArgumentPrintAddProjectName This constant is deprecated. we now use WebEventArgumentAddMacro and WebEventArgumentMacroName
int WebEventArgumentPrintAddReportName This constant is deprecated. we now use WebEventArgumentAddMacro and WebEventArgumentMacroName
int WebEventArgumentPrintAddTemplateName This constant is deprecated. we now use WebEventArgumentAddMacro and WebEventArgumentMacroName
int WebEventArgumentPrintAddTime This constant is deprecated. we now use WebEventArgumentAddMacro and WebEventArgumentMacroName
int WebEventArgumentPrintAddUserName This constant is deprecated. we now use WebEventArgumentAddMacro and WebEventArgumentMacroName
int WebEventArgumentPrintGroupName This constant is deprecated. please use WebEventArgumentPrevGroupName
int WebEventArgumentPrintHeaderFooterApplyButtonName event argument: argument to denote the apply button name of the header footer editor for print preferences
int WebEventArgumentPrintHeaderFooterCancelButtonName event argument: argument to denote the cancel button name of the header footer editor for print preferences
int WebEventArgumentPrintSectionName event argument: argument to denote the section where the details should be added
int WebEventArgumentRemoveFont event argument: argument to denote the remove button of the font names shopping cart.
int WebEventArgumentSelectedFonts event argument: argument to denote the selected fonts.
int WebEventArgumentShowAdvancedPrintPreferences event argument: show advanced print preferences
int WebEventArgumentTarget event argument: target parameter for the group/group-set that will be selected.
int WebEventCancelHeaderFooterEditor Event for the cancel button on the Header and Footer Editor
int WebEventLoadProjectDefaults event to load the project defaults
int WebEventPopulatePrintHeaderFooteTextArea event to populate the left/right/center textarea of the header/footer editor:
int WebEventRemoveCustomPromptStyle Event to add a new custom prompt style.
int WebEventSelectPreferencesGroup event to change the current group
int WebEventSelectPreferencesGroupSet event to change the current group-set
int WebEventShowAdvancedOptions event to show or hide the advanced print preferences:
int WebEventShowExportAdminHeaderFooterEditor event to display the export admin Header Footer Editor
int WebEventShowPDFReportHeaderEditor event to display the PDF Report Header Editor
int WebEventShowProjectHeaderFooterEditor event to display the Header/Footer Editor displaying the Project level settings.
int WebEventSwitchAdvancedSettings
int WebEventSwitchColorThemePreview Event to toggle Color Theme Preview in HTML mode note - this event will use the same set of arguments IDs for event 25009.
int WebEventUpdatePreferences event to update the preferences values:
int WebEventValidatePreferences event to validate the values of the preferences which are submitted:
[Expand]
Inherited Constants
From interface com.microstrategy.web.app.beans.EnumPageEvents
From interface com.microstrategy.web.app.beans.EnumServletEvents

Constants

public static final int WebEventAddCustomPromptStyle

public static final int WebEventApplyExportAdminHeaderFooterEditor

Event for the apply button on the Export Admin Header and Footer Editor

Constant Value: 25016 (0x000061b8)

public static final int WebEventApplyHeaderFooterEditor

Event for the apply button on the Header and Footer Editor

Constant Value: 25014 (0x000061b6)

public static final int WebEventArgumentAddFont

event argument: argument to denote the add button of the font names shopping cart.

Constant Value: 25022 (0x000061be)

public static final int WebEventArgumentAddMacro

event argument: argument to add a macro to the header or footer

Constant Value: 25040 (0x000061d0)

public static final int WebEventArgumentAdvancedSettingDiv

Constant Value: 25030 (0x000061c6)

public static final int WebEventArgumentAdvancedSettingVisibility

Constant Value: 25031 (0x000061c7)

public static final int WebEventArgumentAllProjects

event argument: apply changes to all projects

Constant Value: 25004 (0x000061ac)

public static final int WebEventArgumentApply

event argument: apply changes

Constant Value: 25003 (0x000061ab)

public static final int WebEventArgumentAvailableFonts

event argument: argument to denote the list of available fonts in the system.

Constant Value: 25026 (0x000061c2)

public static final int WebEventArgumentCustomStyleToAddBaseStyle

Constant Value: 25033 (0x000061c9)

public static final int WebEventArgumentCustomStyleToAddDescription

Constant Value: 25035 (0x000061cb)

public static final int WebEventArgumentCustomStyleToAddName

Constant Value: 25032 (0x000061c8)

public static final int WebEventArgumentCustomStyleToAddPromptType

Constant Value: 25034 (0x000061ca)

public static final int WebEventArgumentCustomStyleToDeleteBaseStyle

Constant Value: 25037 (0x000061cd)

public static final int WebEventArgumentCustomStyleToDeleteDescription

Constant Value: 25039 (0x000061cf)

public static final int WebEventArgumentCustomStyleToDeleteName

Constant Value: 25036 (0x000061cc)

public static final int WebEventArgumentCustomStyleToDeletePromptType

Constant Value: 25038 (0x000061ce)

public static final int WebEventArgumentDynamicDiv

For dynamic sections event arguments

Constant Value: 25030 (0x000061c6)

public static final int WebEventArgumentDynamicDivVisibility

Constant Value: 25031 (0x000061c7)

public static final int WebEventArgumentKeepTempPreferences

event argument: argument to temporarily keep the value of the preferences.
The preferences do not get saved to the metadata until the event WebEventUpdatePreferences is submited from the page that contains those preferences.

Possible values:
SAVE_TEMP_PREFERENCE - Save the preferences temporarily.
KEEP_TEMP_PREFERENCE - Keep the current temporary preferences.

If the argument is not specified when calling the event 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.

Constant Value: 25028 (0x000061c4)

public static final int WebEventArgumentLoadDefaults

event argument: load default values

Constant Value: 25005 (0x000061ad)

public static final int WebEventArgumentMacroName

event argument: argument that indicates the name of the macro to add to the header or footer

Constant Value: 25041 (0x000061d1)

public static final int WebEventArgumentMoveFontDown

event argument: argument to denote the move down button of the font names shopping cart.

Constant Value: 25025 (0x000061c1)

public static final int WebEventArgumentMoveFontUp

event argument: argument to denote the move up button of the font names shopping cart.

Constant Value: 25024 (0x000061c0)

public static final int WebEventArgumentPreferencesLevel

event argument: level that to which to set the preferences values.

Constant Value: 25002 (0x000061aa)

public static final int WebEventArgumentPrevGroupName

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.

Constant Value: 25029 (0x000061c5)

public static final int WebEventArgumentPrintAddDate

This constant is deprecated.
we now use WebEventArgumentAddMacro and WebEventArgumentMacroName

event argument: argument to add date

Constant Value: 25009 (0x000061b1)

public static final int WebEventArgumentPrintAddFilterDetails

This constant is deprecated.
we now use WebEventArgumentAddMacro and WebEventArgumentMacroName

event argument: argument to add filter details

Constant Value: 25015 (0x000061b7)

public static final int WebEventArgumentPrintAddFilterName

This constant is deprecated.
we now use WebEventArgumentAddMacro and WebEventArgumentMacroName

event argument: argument to add filter name

Constant Value: 25014 (0x000061b6)

public static final int WebEventArgumentPrintAddNumberPages

This constant is deprecated.
we now use WebEventArgumentAddMacro and WebEventArgumentMacroName

event argument: argument to add number of pages

Constant Value: 25008 (0x000061b0)

public static final int WebEventArgumentPrintAddPage

This constant is deprecated.
we now use WebEventArgumentAddMacro and WebEventArgumentMacroName

event argument: argument to add page number

Constant Value: 25007 (0x000061af)

public static final int WebEventArgumentPrintAddPageBy

This constant is deprecated.
we now use WebEventArgumentAddMacro and WebEventArgumentMacroName

event argument: argument to add page-by information

Constant Value: 25021 (0x000061bd)

public static final int WebEventArgumentPrintAddProjectName

This constant is deprecated.
we now use WebEventArgumentAddMacro and WebEventArgumentMacroName

event argument: argument to add project name

Constant Value: 25011 (0x000061b3)

public static final int WebEventArgumentPrintAddReportName

This constant is deprecated.
we now use WebEventArgumentAddMacro and WebEventArgumentMacroName

event argument: argument to add report name

Constant Value: 25012 (0x000061b4)

public static final int WebEventArgumentPrintAddTemplateName

This constant is deprecated.
we now use WebEventArgumentAddMacro and WebEventArgumentMacroName

event argument: argument to add template name

Constant Value: 25013 (0x000061b5)

public static final int WebEventArgumentPrintAddTime

This constant is deprecated.
we now use WebEventArgumentAddMacro and WebEventArgumentMacroName

event argument: argument to add time

Constant Value: 25010 (0x000061b2)

public static final int WebEventArgumentPrintAddUserName

This constant is deprecated.
we now use WebEventArgumentAddMacro and WebEventArgumentMacroName

event argument: argument to add user name

Constant Value: 25016 (0x000061b8)

public static final int WebEventArgumentPrintGroupName

This constant is deprecated.
please use WebEventArgumentPrevGroupName

event argument: argument to denote the name of the print group preferences.

Constant Value: 25020 (0x000061bc)

public static final int WebEventArgumentPrintHeaderFooterApplyButtonName

event argument: argument to denote the apply button name of the header footer editor for print preferences

Constant Value: 25018 (0x000061ba)

public static final int WebEventArgumentPrintHeaderFooterCancelButtonName

event argument: argument to denote the cancel button name of the header footer editor for print preferences

Constant Value: 25019 (0x000061bb)

public static final int WebEventArgumentPrintSectionName

event argument: argument to denote the section where the details should be added

Constant Value: 25017 (0x000061b9)

public static final int WebEventArgumentRemoveFont

event argument: argument to denote the remove button of the font names shopping cart.

Constant Value: 25023 (0x000061bf)

public static final int WebEventArgumentSelectedFonts

event argument: argument to denote the selected fonts.

Constant Value: 25027 (0x000061c3)

public static final int WebEventArgumentShowAdvancedPrintPreferences

event argument: show advanced print preferences

Constant Value: 25006 (0x000061ae)

public static final int WebEventArgumentTarget

event argument: target parameter for the group/group-set that will be selected.

Constant Value: 25001 (0x000061a9)

public static final int WebEventCancelHeaderFooterEditor

Event for the cancel button on the Header and Footer Editor

Constant Value: 25015 (0x000061b7)

public static final int WebEventLoadProjectDefaults

event to load the project defaults

Constant Value: 25008 (0x000061b0)

public static final int WebEventPopulatePrintHeaderFooteTextArea

event to populate the left/right/center textarea of the header/footer editor:

Constant Value: 25005 (0x000061ad)

public static final int WebEventRemoveCustomPromptStyle

public static final int WebEventSelectPreferencesGroup

event to change the current group

Constant Value: 25002 (0x000061aa)

public static final int WebEventSelectPreferencesGroupSet

event to change the current group-set

Constant Value: 25001 (0x000061a9)

public static final int WebEventShowAdvancedOptions

event to show or hide the advanced print preferences:

Constant Value: 25004 (0x000061ac)

public static final int WebEventShowExportAdminHeaderFooterEditor

event to display the export admin Header Footer Editor

Constant Value: 25013 (0x000061b5)

public static final int WebEventShowPDFReportHeaderEditor

event to display the PDF Report Header Editor

Constant Value: 25012 (0x000061b4)

public static final int WebEventShowProjectHeaderFooterEditor

event to display the Header/Footer Editor displaying the Project level settings.

Constant Value: 25007 (0x000061af)

public static final int WebEventSwitchAdvancedSettings

Constant Value: 25009 (0x000061b1)

public static final int WebEventSwitchColorThemePreview

Event to toggle Color Theme Preview in HTML mode note - this event will use the same set of arguments IDs for event 25009.

Constant Value: 25017 (0x000061b9)

public static final int WebEventUpdatePreferences

event to update the preferences values:

Constant Value: 25003 (0x000061ab)

public static final int WebEventValidatePreferences

event to validate the values of the preferences which are submitted:

Constant Value: 25006 (0x000061ae)