public class

PreferencesGeneralTransform

extends PreferencesGenericTransform
implements EnumWebPreferences
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.PreferencesGeneralTransform
Known Direct Subclasses

Class Overview

This is the transform that render the General Preferences.

Summary

Constants
String FP_ADD_IMAGE Constant specifying the name of the formal parameter for defining the add image on the shopping cart.
String FP_AVAILABLE_SIZE Constant specifying the name of the formal parameter for defining the size of the available list box shopping cart for selecting fonts.
String FP_COLOR_THEME_PICKER_NAME Constant specifying the name of the formal parameter for defining the name of the Color Theme picker that provides the color theme options.
String FP_CREATE_PAGE_NAME Constant specifying the name of the formal parameter for defining the name of the Create Reports folder page, as specified on the Page Configuration file.
String FP_DOCUMENT_BEAN_NAME Constant specifying the name of the formal parameter for defining the name of the document bean.
String FP_DOCUMENT_PAGE_NAME Constant specifying the name of the formal parameter for defining the name of the Document page, as specified on the Page Configuration file.
String FP_DOWN_IMAGE Constant specifying the name of the formal parameter for defining the down image on the shopping cart.
String FP_FOLDER_BEAN_NAME Constant specifying the name of the formal parameter for defining the name of the folder bean.
String FP_FONT_NAME_PICKER_NAME Constant specifying the name of the formal parameter for defining the name of the system picker that provides the font name options.
String FP_HTML5_VI_PAGE_NAME Constant specifying the name of the formal parameter for defining the name of the HTML5 VI page, as specified on the Page Configuration file.
String FP_MY_PAGE_NAME Constant specifying the name of the formal parameter for defining the name of the My Reports folder page, as specified on the Page Configuration file.
String FP_OIVM_PAGE_NAME Constant specifying the name of the formal parameter for defining the name of the oivm page, as specified on the Page Configuration file.
String FP_REMOVE_IMAGE Constant specifying the name of the formal parameter for defining the remove image on the shopping cart.
String FP_REPORT_BEAN_NAME Constant specifying the name of the formal parameter for defining the name of the report bean.
String FP_REPORT_FRAME_BEAN_NAME Constant specifying the name of the formal parameter for defining the name of the report frame bean.
String FP_REPORT_PAGE_NAME Constant specifying the name of the formal parameter for defining the name of the Report page, as specified on the Page Configuration file.
String FP_RW_DOCUMENT_BEAN_NAME Constant specifying the name of the formal parameter for defining the name of the report writing document bean.
String FP_RW_DOCUMENT_PAGE_NAME Constant specifying the name of the formal parameter for defining the name of the Report Writing Document page, as specified on the Page Configuration file.
String FP_SEARCH_OBJECT_TYPES_PICKER_NAME Constant specifying the name of the formal parameter for defining the name of the search object types picker that provides the search object types.
String FP_SELECTED_SIZE Constant specifying the name of the formal parameter for defining the size of the selected list box shopping cart for selecting fonts.
String FP_SHARED_PAGE_NAME Constant specifying the name of the formal parameter for defining the name of the Shared Reports folder page, as specified on the Page Configuration file.
String FP_START_PAGES_PICKER_NAME Constant specifying the name of the formal parameter for defining the name of the system picker that provides the start page options.
String FP_TIME_ZONES_PICKER_NAME Constant specifying the name of the formal parameter for defining the name of the system picker that provides the time zone options.
String FP_UP_IMAGE Constant specifying the name of the formal parameter for defining the up image on the shopping cart.
String PREFERENCE_ALLOW_OVERWRITE_WITHOUT_WARNING
String PREFERENCE_ALLOW_OVERWRITE_WITH_WARNING
String PREFERENCE_DISALLOW_OVERWRITE
[Expand]
Inherited Constants
From class com.microstrategy.web.app.transforms.PreferencesGenericTransform
From class com.microstrategy.web.app.transforms.AbstractPreferencesTransform
From class com.microstrategy.web.app.transforms.AbstractAppTransform
From interface com.microstrategy.web.objects.EnumWebPreferences
Fields
protected String _addImage This field is deprecated. The formal parameter this property is related to has been deprecated
protected String _downImage This field is deprecated. The formal parameter this property is related to has been deprecated
protected String _removeImage This field is deprecated. The formal parameter this property is related to has been deprecated
protected String _upImage This field is deprecated. The formal parameter this property is related to has been deprecated
protected FormalParameter addImage This field is deprecated. The image is now defined with a CSS style (add), which should be updated if another image is to be used
protected FormalParameter availableSize Specifies the size of the Available listbox of the shopping cart used to select the application's fonts.
protected FormalParameter colorThemePickerName Indicates the name of the system picker that contains the color themes that shall be displayed to the user as possible options for color theme in preferences section of the application.
protected FormalParameter createPageName Specifies the name of the page that displays the contents of Create Reports, as defined on the Page Configuration File.
protected FormalParameter documentBeanName Specifies the name of the bean that displays the documents' content.
protected FormalParameter documentPageName Specifies the name of the page that displays the documents' contents, as defined on the Page Configuration File.
protected FormalParameter downImage This field is deprecated. The image is now defined with a CSS style (down), which should be updated if another image is to be used
protected FormalParameter folderBeanName Specifies the name of the bean that displays the folders' contents.
protected FormalParameter fontNamePickerName Indicates the name of the system picker that contains the font names that shall be displayed to the user as possible options for fonts to use on the application.
protected FormalParameter html5VIPageName Indicates the name of the html5vi dashboard
protected FormalParameter myPageName Specifies the name of the page that displays the contents of My Reports, as defined on the Page Configuration File.
protected FormalParameter oivmPageName Indicates the name of the oivm document
protected FormalParameter removeImage This field is deprecated. The image is now defined with a CSS style (remove), which should be updated if another image is to be used
protected FormalParameter reportBeanName Specifies the name of the bean that displays the reports' content.
protected FormalParameter reportFrameBeanName Specifies the name of the bean that contains the report bean and other editor/toolbar beans.
protected FormalParameter reportPageName Specifies the name of the page that displays the reports' contents, as defined on the Page Configuration File.
protected FormalParameter rwDocumentBeanName Specifies the name of the bean that displays the report writing documents' content.
protected FormalParameter rwDocumentPageName Specifies the name of the page that displays the report writing documents' contents, as defined on the Page Configuration File.
protected FormalParameter searchObjectTypesPickerName Indicates the name of the system picker that contains the all search object types that shall be displayed to the Admin user as available options for search object types in preferences section of the application.
protected FormalParameter selectedSize Specifies the size of the Selected listbox of the shopping cart used to select the application's fonts.
protected FormalParameter sharedPageName Specifies the name of the page that displays the contents of Shared Reports, as defined on the Page Configuration File.
protected FormalParameter startPagesPickerName Indicates the name of the system picker that contains the start pages that shall be displayed to the user as possible start pages in the application.
protected FormalParameter timeZonesPickerName Indicates the name of the system picker that contains the time zones that shall be displayed to the user as possible options for time zones in preferences section of the application.
protected FormalParameter upImage This field is deprecated. The image is now defined with a CSS style (up), which should be updated if another image is to be used
[Expand]
Inherited Fields
From class com.microstrategy.web.app.transforms.AbstractPreferencesTransform
From class com.microstrategy.web.app.transforms.AbstractAppTransform
From interface com.microstrategy.web.objects.EnumWebPreferences
Public Constructors
PreferencesGeneralTransform()
Default no-args constructor
Public Methods
boolean canDisplayDropDownMenus()
Checks if the Dropdown menus sections should be disabled.
boolean canDisplayUserDhtml()
Checks if the administrator has enabled modifying the DHTML preference to end users.
boolean enableAutomaticSessionRecovery()
Check the hidden preference that controls the session recovery feature
WebEvent generateOpenDocumentEvent(DocumentBean db)
Method that will generate the event for running a document, to be saved as part of the Start Page preference, when the Last Document Run is selected.
WebEvent generateOpenFolderEvent(FolderBean fb, String folderPageName)
Method that will generate the event for opening a folder, to be saved as part of the Start Page preference, if a custom folder other than the default ones is selected.
WebEvent generateOpenHTML5VIDashboardEvent(RWBean rw)
Method that will generate the event for running a html5 vi dashboard, to be saved as part of the Start Page preference, when the Last Document Run is selected.
WebEvent generateOpenRWDocumentEvent(RWBean rw)
Method that will generate the event for running a report writing document, to be saved as part of the Start Page preference, when the Last Document Run is selected.
WebEvent generateOpenReportEvent(ReportBean rb, ReportFrameBean rfb)
Method that will generate the event for running a report, to be saved as part of the Start Page preference, when the Last Report Run is selected.
Map getControlledDivAttr(String controlledDiv)
Render the attribute list for the container.
boolean hasMMTAccess()
This method is deprecated. not used anymore
void initializeImages()
Initialize the images to be used by this transform.
boolean isNCConfigured()
Checks if integration with Narrowcast Server is enabled.
void render508(MarkupOutput out)
Renders 'Accessibility mode' preference.
void render508Section(MarkupOutput out)
Renders 'Accessibility mode' section.
void renderAllowDhtml(MarkupOutput out)
Renders 'Allow Dynamic HTML' preference.
void renderAskBeforeSaveChanges(MarkupOutput out, String preferenceEnumName)
Renders the drop down list of ask before saving changes
void renderAutoComplete(MarkupOutput out)
Renders 'AutoComplete Search Preference' preference.
void renderColorTheme(MarkupOutput out)
This method is deprecated. call renderColorThemeDropDownList( ) instead
void renderColorThemeDropDownList(MarkupOutput out)
Render the dropdown list of available Color Themes
void renderColorThemePreview(MarkupOutput out)
Render color theme preview DIV This preview shows the look & feel of theme basic element: shortcut bar, path bar, accordion, panel, editor.
Tag renderColorThemePreviewZoom(MarkupOutput out, Tag previewDiv)
Render color theme preview DIV with Zooming This preview shows the zoomed in version of the color theme preview
void renderContact(MarkupOutput out)
Renders 'Administrator contact info' preference.
void renderContactSection(MarkupOutput out)
Renders 'Administrator contact info' section.
void renderDataDisplaySection(MarkupOutput out)
Renders 'Data Display' section.
void renderDhtmlSection(MarkupOutput out)
Renders 'Dynamic HTML' section.
void renderDropDownMenus(MarkupOutput out)
Renders 'Drop down menu' preferecence.
void renderDropDownMenusSection(MarkupOutput out)
Renders 'Drop down menu' section.
void renderDynamicControlButton(MarkupOutput out, String controlledDiv, String labelHiddenID, String labelShowID)
This method is deprecated. No replacement.
void renderDynamicControlButton(MarkupOutput out, String controlledDiv, String labelHiddenID, String labelShowID, int eventId)
Renders a control button which switchs the visibility of specific Div depending the DHTML or static HTML mode.
void renderElementsIncrementalFetch(MarkupOutput out)
Renders 'Elements Incremental fetch' preference.
void renderEnableGridViewSearch(MarkupOutput out)
Renders 'enable Grid View Search' preference.
void renderEnableVisEditor(MarkupOutput out)
Renders preference that allows users to open the Custom Visualizations Editor
void renderExportReuseNewWindow(MarkupOutput out)
Renders "Re-use new window for each export, print, PDF action" preference
void renderFeatureInfoList(MarkupOutput out)
void renderFilterEditorSection(MarkupOutput out)
Renders 'Filter Editor' section.
void renderFontShoppingCart(MarkupOutput out)
void renderFontSize(MarkupOutput out)
Renders 'Font size' preference.
void renderFontStyle(MarkupOutput out)
Renders 'Font style' preference.
void renderFontStyleOption(MarkupOutput out)
Renders 'Font style' preference.
void renderFontStyleSection(MarkupOutput out)
Renders 'Font style' section.
void renderFullScreenModeBehaviorDocuments(MarkupOutput out)
void renderFullScreenModeBehaviorReports(MarkupOutput out)
void renderFullScreenModeDescriptorDocuments(MarkupOutput out)
void renderFullScreenModeDescriptorReports(MarkupOutput out)
void renderGridSearchObjectTypes(MarkupOutput out)
Render Grid Search allowed object types section This section will be available only in DHTML mode
void renderHideMyReports(MarkupOutput out)
This method is deprecated. This preference has been moved to the Folder Browsing group
void renderHideMyReportsSection(MarkupOutput out)
This method is deprecated. This preference has been moved to the Folder Browsing group
void renderHierarchicalSort(MarkupOutput out)
Renders 'Sort metrics hierarchically' preference
void renderIncrementalFetchSection(MarkupOutput out)
Renders 'Incremental fetch' section.
void renderKeepInCart(MarkupOutput out)
void renderKeepInCartSection(MarkupOutput out)
Renders Keep in Cart Section.
void renderLanguageDropDownList(MarkupOutput out)
Renders the drop down list of the language options
void renderLanguageHeader(MarkupOutput out)
Renders the description for the language section
void renderLastObjectRunOption(MarkupOutput lastObjectOption, StringBuffer lastObjectLabel)
void renderLocale(MarkupOutput out)
Renders 'Locale' preference.
void renderLocaleSection(MarkupOutput out)
Renders 'Locale' section.
void renderMMTAccessOption(MarkupOutput out)
This method is deprecated. not used anymore
void renderMMTAccessSection(MarkupOutput out)
This method is deprecated. not used anymore
void renderMMTAddress(MarkupOutput out)
This method is deprecated. not used anymore
void renderMaxSearch(MarkupOutput out)
Renders 'Max Search Preference' preference.
void renderMaxSessionIdleTime(MarkupOutput out)
Renders maximum session idle time
void renderMaxSort(MarkupOutput out)
Renders 'Max Sort keys' preference
void renderMessagesLocaleDropDownList(MarkupOutput out)
void renderMessagesLocaleHeader(MarkupOutput out)
void renderMetadataLocaleDropDownList(MarkupOutput out)
void renderMetadataLocaleHeader(MarkupOutput out)
void renderNCS(MarkupOutput out)
Renders 'Narrowcast Server' preference.
void renderNCSEnableSection(MarkupOutput out)
Renders 'Narrowcast Server' section.
void renderObjectsIncrementalFetch(MarkupOutput out)
Renders 'Objects Incremental fetch' preference.
void renderOutputFormatsSection(MarkupOutput out)
Renders 'Output Formats' section.
void renderPDFPrint(MarkupOutput out)
void renderPreference(String preferenceName, MarkupOutput out)
This method is deprecated. Call the corresponding renderXXX method directly.
void renderQuickSearch(MarkupOutput out)
Renders 'AutoComplete Search Preference' preference.
void renderRefreshReport(MarkupOutput out)
Renders 'Refresh Report' preference.
void renderRefreshReportSection(MarkupOutput out)
Renders 'Refresh Report' section.
void renderSaveAs8iWarning(MarkupOutput out)
Renders the 'Save as 8i Warning' preference to know whether to prompt users to save reports using new features in MIcrostrategy 8.
void renderSaveAs8iWarningSection(MarkupOutput out)
Renders 'Narrowcast Server' section.
void renderSaveAsOptions(MarkupOutput out)
void renderSaveAsVersionWarning(MarkupOutput out)
void renderSaveAsVersionWarningSection(MarkupOutput out)
void renderSaveMessageText(MarkupOutput out)
Render the save message text that should be presented to the user once the saving has been successful.
void renderSavePromptedReportAs(MarkupOutput out, String preferenceEnumName, String controlledDiv)
void renderSearchObjectTypes(MarkupOutput out)
Render search object types section This section will be available only in DHTML mode and apply to Quick Search UI (even QuickSearch is disabled).
void renderSearchSection(MarkupOutput out)
Renders 'Search' section.
void renderServerLocale(MarkupOutput out)
Renders 'Server Locale' preference.
void renderServerLocaleDropDownList(MarkupOutput out)
Renders the drop down list for the number and date format section
void renderServerLocaleHeader(MarkupOutput out)
Renders the description for the number and date format section
void renderSharedReports(MarkupOutput out)
This method is deprecated. This preference has been moved to the Folder Browsing Group
void renderSharedReportsSection(MarkupOutput out)
This method is deprecated. This preference has been moved to the Folder Browsing Group
void renderSingleLastObjectRun(MarkupOutput lastObjectOption, StringBuffer lastObjectLabel, WebEvent event, String pageTitle, String descriptor)
void renderStart(MarkupOutput out)
Renders 'Start page' preference.
void renderStartSection(MarkupOutput out)
Renders 'Start page' section.
void renderTimeZone(MarkupOutput out)
Renders the renderTimeZone preference
void renderTimeZoneDropDownList(MarkupOutput out)
Renders the drop down list for the time zone
void renderTimeZoneHeader(MarkupOutput out)
Renders the description for the time zone
void renderTrimWarehouseData(MarkupOutput out)
Renders ' Trim Warehouse Datae' preference.
void renderUnits(MarkupOutput out)
Renders 'Units' preference.
void renderUnitsDropDownList(MarkupOutput out)
Renders the drop down list of the units section
void renderUnitsHeader(MarkupOutput out)
Renders the description of the units section
void renderUseDhtml(MarkupOutput out)
Renders 'Use Dynamic HTML' preference.
void renderUseEmbeddedFilters(MarkupOutput out)
Renders the 'Use Embedded Filter' preference.
void renderWait(MarkupOutput out)
Renders 'Wait' preference.
void renderWaitSection(MarkupOutput out)
Renders 'Wait' section.
void renderWarehouseDataLocaleDropDownList(MarkupOutput out)
void renderWarehouseDataLocaleHeader(MarkupOutput out)
void renderWarningSessionTimeout(MarkupOutput out)
Renders 'enable warning before Web user session timeout' preference.
void renderWorkingSet(MarkupOutput out)
Renders 'Working Set' preference.
void setFontNamePicker(ShortcutList fontNamePicker)
void setStartPagesPicker(ShortcutList startPagesPicker)
void setTimeZonePicker(ShortcutList timeZonePicker)
void transformBody(MarkupOutput out)
Generates the content for the General Preference's dialog.
Protected Methods
List getAllowableValues(String preferenceEnumName)
[Expand]
Inherited Methods
From class com.microstrategy.web.app.transforms.PreferencesGenericTransform
From class com.microstrategy.web.app.transforms.AbstractPreferencesTransform
From class com.microstrategy.web.app.transforms.AbstractAppTransform
From class com.microstrategy.web.transform.AbstractLayoutTransform
From class com.microstrategy.web.transform.AbstractTransform
From class java.lang.Object
From interface com.microstrategy.web.app.transforms.AppTransform
From interface com.microstrategy.web.transform.LayoutTransform
From interface com.microstrategy.web.transform.Transform

Constants

public static final String FP_ADD_IMAGE

Constant specifying the name of the formal parameter for defining the add image on the shopping cart. Value is addImage.

Constant Value: "addImage"

public static final String FP_AVAILABLE_SIZE

Constant specifying the name of the formal parameter for defining the size of the available list box shopping cart for selecting fonts. Value is availableSize.

Constant Value: "availableSize"

public static final String FP_COLOR_THEME_PICKER_NAME

Constant specifying the name of the formal parameter for defining the name of the Color Theme picker that provides the color theme options. Value is colorThemePickerName.

Constant Value: "colorThemePickerName"

public static final String FP_CREATE_PAGE_NAME

Constant specifying the name of the formal parameter for defining the name of the Create Reports folder page, as specified on the Page Configuration file. Value is createPageName.

Constant Value: "createPageName"

public static final String FP_DOCUMENT_BEAN_NAME

Constant specifying the name of the formal parameter for defining the name of the document bean. Value is documentBeanName.

Constant Value: "documentBeanName"

public static final String FP_DOCUMENT_PAGE_NAME

Constant specifying the name of the formal parameter for defining the name of the Document page, as specified on the Page Configuration file. Value is documentPageName.

Constant Value: "documentPageName"

public static final String FP_DOWN_IMAGE

Constant specifying the name of the formal parameter for defining the down image on the shopping cart. Value is downImage.

Constant Value: "downImage"

public static final String FP_FOLDER_BEAN_NAME

Constant specifying the name of the formal parameter for defining the name of the folder bean. Value is folderBeanName.

Constant Value: "folderBeanName"

public static final String FP_FONT_NAME_PICKER_NAME

Constant specifying the name of the formal parameter for defining the name of the system picker that provides the font name options. Value is fontNamePickerName.

Constant Value: "fontNamePickerName"

public static final String FP_HTML5_VI_PAGE_NAME

Constant specifying the name of the formal parameter for defining the name of the HTML5 VI page, as specified on the Page Configuration file. Value is Html5Vi.

Constant Value: "html5viPageName"

public static final String FP_MY_PAGE_NAME

Constant specifying the name of the formal parameter for defining the name of the My Reports folder page, as specified on the Page Configuration file. Value is myPageName.

Constant Value: "myPageName"

public static final String FP_OIVM_PAGE_NAME

Constant specifying the name of the formal parameter for defining the name of the oivm page, as specified on the Page Configuration file. Value is oivmPageName.

Constant Value: "oivmPageName"

public static final String FP_REMOVE_IMAGE

Constant specifying the name of the formal parameter for defining the remove image on the shopping cart. Value is removeImage.

Constant Value: "removeImage"

public static final String FP_REPORT_BEAN_NAME

Constant specifying the name of the formal parameter for defining the name of the report bean. Value is reportBeanName.

Constant Value: "reportBeanName"

public static final String FP_REPORT_FRAME_BEAN_NAME

Constant specifying the name of the formal parameter for defining the name of the report frame bean. Value is reportFrameBeanName.

Constant Value: "reportFrameBeanName"

public static final String FP_REPORT_PAGE_NAME

Constant specifying the name of the formal parameter for defining the name of the Report page, as specified on the Page Configuration file. Value is reportPageName.

Constant Value: "reportPageName"

public static final String FP_RW_DOCUMENT_BEAN_NAME

Constant specifying the name of the formal parameter for defining the name of the report writing document bean. Value is rwDocumentBeanName.

Constant Value: "rwDocumentBeanName"

public static final String FP_RW_DOCUMENT_PAGE_NAME

Constant specifying the name of the formal parameter for defining the name of the Report Writing Document page, as specified on the Page Configuration file. Value is rwDocumentPageName.

Constant Value: "rwDocumentPageName"

public static final String FP_SEARCH_OBJECT_TYPES_PICKER_NAME

Constant specifying the name of the formal parameter for defining the name of the search object types picker that provides the search object types. Value is searchObjectTypesPickerName.

Constant Value: "searchObjectTypesPickerName"

public static final String FP_SELECTED_SIZE

Constant specifying the name of the formal parameter for defining the size of the selected list box shopping cart for selecting fonts. Value is selectedSelectSize.

Constant Value: "selectedSelectSize"

public static final String FP_SHARED_PAGE_NAME

Constant specifying the name of the formal parameter for defining the name of the Shared Reports folder page, as specified on the Page Configuration file. Value is sharedPageName.

Constant Value: "sharedPageName"

public static final String FP_START_PAGES_PICKER_NAME

Constant specifying the name of the formal parameter for defining the name of the system picker that provides the start page options. Value is startPagesPickerName.

Constant Value: "startPagesPickerName"

public static final String FP_TIME_ZONES_PICKER_NAME

Constant specifying the name of the formal parameter for defining the name of the system picker that provides the time zone options. Value is timeZonesPickerName.

Constant Value: "timeZonesPickerName"

public static final String FP_UP_IMAGE

Constant specifying the name of the formal parameter for defining the up image on the shopping cart. Value is upImage.

Constant Value: "upImage"

public static final String PREFERENCE_ALLOW_OVERWRITE_WITHOUT_WARNING

Constant Value: "0"

public static final String PREFERENCE_ALLOW_OVERWRITE_WITH_WARNING

Constant Value: "1"

public static final String PREFERENCE_DISALLOW_OVERWRITE

Constant Value: "2"

Fields

protected String _addImage

This field is deprecated.
The formal parameter this property is related to has been deprecated

Property to keep the value assigned to the {!link PreferencesGeneralTransform#FP_ADD_IMAGE} formal parameter

protected String _downImage

This field is deprecated.
The formal parameter this property is related to has been deprecated

Property to keep the value assigned to the {!link PreferencesGeneralTransform#FP_DOWN_IMAGE} formal parameter

protected String _removeImage

This field is deprecated.
The formal parameter this property is related to has been deprecated

Property to keep the value assigned to the {!link PreferencesGeneralTransform#FP_REMOVE_IMAGE} formal parameter

protected String _upImage

This field is deprecated.
The formal parameter this property is related to has been deprecated

Property to keep the value assigned to the {!link PreferencesGeneralTransform#FP_UP_IMAGE} formal parameter

protected FormalParameter addImage

This field is deprecated.
The image is now defined with a CSS style (add), which should be updated if another image is to be used

Image to add elements to the Selected listbox of the shopping cart used to select the application's fonts. Used on the 'Font style' section of the preferences.
Allowed Values:
The value to indicate should be a valid image file name, with any necessary path information not included already on the resourcesFolderImage application configuration parameter.
Usage:This may be changed to customize the shopping cart displayed on the 'Font style' section of the preferences.

protected FormalParameter availableSize

Specifies the size of the Available listbox of the shopping cart used to select the application's fonts. Used on the 'Font style' section of the preferences.
Usage: This may be changed to customize the size of the listboxes on the shopping cart.

protected FormalParameter colorThemePickerName

Indicates the name of the system picker that contains the color themes that shall be displayed to the user as possible options for color theme in preferences section of the application.

protected FormalParameter createPageName

Specifies the name of the page that displays the contents of Create Reports, as defined on the Page Configuration File. Used on the 'Default start page' section of the preferences.

protected FormalParameter documentBeanName

Specifies the name of the bean that displays the documents' content. Used on the 'Default start page' section of the preferences.
The value defined here has to be the same name assigned to the document bean defined on the Page Configuration File page definition that will be running the document.

protected FormalParameter documentPageName

Specifies the name of the page that displays the documents' contents, as defined on the Page Configuration File. Used on the 'Default start page' section of the preferences.

protected FormalParameter downImage

This field is deprecated.
The image is now defined with a CSS style (down), which should be updated if another image is to be used

Image to move elements down on the Selected listbox of the shopping cart used to select the application's fonts. Used on the 'Font style' section of the preferences.
Allowed Values:
The value to indicate should be a valid image file name, with any necessary path information not included already on the resourcesFolderImage application configuration parameter.
Usage:This may be changed to customize the shopping cart displayed on the 'Font style' section of the preferences.

protected FormalParameter folderBeanName

Specifies the name of the bean that displays the folders' contents. Used on the 'Default start page' section of the preferences.
The value defined here has to be the same name assigned to the folder bean defined on the Page Configuration File page definition that will be showing the contents.

protected FormalParameter fontNamePickerName

Indicates the name of the system picker that contains the font names that shall be displayed to the user as possible options for fonts to use on the application.

protected FormalParameter html5VIPageName

Indicates the name of the html5vi dashboard

protected FormalParameter myPageName

Specifies the name of the page that displays the contents of My Reports, as defined on the Page Configuration File. Used on the 'Default start page' section of the preferences.

protected FormalParameter oivmPageName

Indicates the name of the oivm document

protected FormalParameter removeImage

This field is deprecated.
The image is now defined with a CSS style (remove), which should be updated if another image is to be used

Image to remove elements from the Selected listbox of the shopping cart used to select the application's fonts. Used on the 'Font style' section of the preferences.
Allowed Values:
The value to indicate should be a valid image file name, with any necessary path information not included already on the resourcesFolderImage application configuration parameter.
Usage:This may be changed to customize the shopping cart displayed on the 'Font style' section of the preferences.

protected FormalParameter reportBeanName

Specifies the name of the bean that displays the reports' content. Used on the 'Default start page' section of the preferences.
The value defined here has to be the same name assigned to the report bean defined on the Page Configuration File page definition that will be running the report.

protected FormalParameter reportFrameBeanName

Specifies the name of the bean that contains the report bean and other editor/toolbar beans. Used on the 'Default start page' section of the preferences.
The value defined here has to be the same name assigned to the report frame bean defined on the Page Configuration File page definition that will be running the report.

protected FormalParameter reportPageName

Specifies the name of the page that displays the reports' contents, as defined on the Page Configuration File. Used on the 'Default start page' section of the preferences.

protected FormalParameter rwDocumentBeanName

Specifies the name of the bean that displays the report writing documents' content. Used on the 'Default start page' section of the preferences.
The value defined here has to be the same name assigned to the report writing document bean defined on the Page Configuration File page definition that will be running the document.

protected FormalParameter rwDocumentPageName

Specifies the name of the page that displays the report writing documents' contents, as defined on the Page Configuration File. Used on the 'Default start page' section of the preferences.

protected FormalParameter searchObjectTypesPickerName

Indicates the name of the system picker that contains the all search object types that shall be displayed to the Admin user as available options for search object types in preferences section of the application.

protected FormalParameter selectedSize

Specifies the size of the Selected listbox of the shopping cart used to select the application's fonts. Used on the 'Font style' section of the preferences.
Usage: This may be changed to customize the size of the listboxes on the shopping cart.

protected FormalParameter sharedPageName

Specifies the name of the page that displays the contents of Shared Reports, as defined on the Page Configuration File. Used on the 'Default start page' section of the preferences.

protected FormalParameter startPagesPickerName

Indicates the name of the system picker that contains the start pages that shall be displayed to the user as possible start pages in the application.

protected FormalParameter timeZonesPickerName

Indicates the name of the system picker that contains the time zones that shall be displayed to the user as possible options for time zones in preferences section of the application.

protected FormalParameter upImage

This field is deprecated.
The image is now defined with a CSS style (up), which should be updated if another image is to be used

Image to move elements up on the Selected listbox of the shopping cart used to select the application's fonts. Used on the 'Font style' section of the preferences.
Allowed Values:
The value to indicate should be a valid image file name, with any necessary path information not included already on the resourcesFolderImage application configuration parameter.
Usage:This may be changed to customize the shopping cart displayed on the 'Font style' section of the preferences.

Public Constructors

public PreferencesGeneralTransform ()

Default no-args constructor

Public Methods

public boolean canDisplayDropDownMenus ()

Checks if the Dropdown menus sections should be disabled. This section is not available if the DHTML preference is not on, or if the Accessibility preference is on.

Returns
  • true if accessibility is off and DHTML is turned on.

public boolean canDisplayUserDhtml ()

Checks if the administrator has enabled modifying the DHTML preference to end users.

Returns
  • true if the WebPreferenceAllowDHTML is set to true.

public boolean enableAutomaticSessionRecovery ()

Check the hidden preference that controls the session recovery feature

Returns
  • boolean

public WebEvent generateOpenDocumentEvent (DocumentBean db)

Method that will generate the event for running a document, to be saved as part of the Start Page preference, when the Last Document Run is selected.

Parameters
db a valid DocumentBean instance, intialized with at least its object ID information, for the event to be generated correctly
Returns
  • an event for running the document, initialized with the information passed as parameters. If no event could be created, it will return null.

public WebEvent generateOpenFolderEvent (FolderBean fb, String folderPageName)

Method that will generate the event for opening a folder, to be saved as part of the Start Page preference, if a custom folder other than the default ones is selected.

Parameters
fb a valid FolderBean instance, intialized with at least its object ID information, for the event to be generated correctly
folderPageName name of the page that will take care of opening the requested folder, compared against the values of the myPageName, createPageName and sharedPageName formal parameters.
Returns
  • an event for opening the folder, initialized with the information passed as parameters. If no event could be created, it will return null.

public WebEvent generateOpenHTML5VIDashboardEvent (RWBean rw)

Method that will generate the event for running a html5 vi dashboard, to be saved as part of the Start Page preference, when the Last Document Run is selected.

Parameters
rw a valid RWBean instance, intialized with at least its object ID information, for the event to be generated correctly
Returns
  • an event for running the html5 vi dashboard, initialized with the information passed as parameters. If no event could be created, it will return null.

public WebEvent generateOpenRWDocumentEvent (RWBean rw)

Method that will generate the event for running a report writing document, to be saved as part of the Start Page preference, when the Last Document Run is selected.

Parameters
rw a valid RWBean instance, intialized with at least its object ID information, for the event to be generated correctly
Returns
  • an event for running the document, initialized with the information passed as parameters. If no event could be created, it will return null.

public WebEvent generateOpenReportEvent (ReportBean rb, ReportFrameBean rfb)

Method that will generate the event for running a report, to be saved as part of the Start Page preference, when the Last Report Run is selected.

Parameters
rb a valid ReportBean instance, intialized, for the event to be generated correctly
rfb a valid ReportFrameBean instance, intialized, for the event to be generated correctly
Returns
  • an event for opening the folder, initialized with the information passed as parameters. If no event could be created, it will return null.

public Map getControlledDivAttr (String controlledDiv)

Render the attribute list for the container.

Parameters
controlledDiv The id for the container.
Returns
  • list of attributes in Map structure.

public boolean hasMMTAccess ()

This method is deprecated.
not used anymore

Checks if the application can be integrated with Microstrategy e-Trainer.

Returns

public void initializeImages ()

Initialize the images to be used by this transform.

public boolean isNCConfigured ()

Checks if integration with Narrowcast Server is enabled.

Returns
  • true if integration is enable.d

public void render508 (MarkupOutput out)

Renders 'Accessibility mode' preference.

Parameters
out the output object

public void render508Section (MarkupOutput out)

Renders 'Accessibility mode' section.

Parameters
out the output object

public void renderAllowDhtml (MarkupOutput out)

Renders 'Allow Dynamic HTML' preference.

Parameters
out the output object

public void renderAskBeforeSaveChanges (MarkupOutput out, String preferenceEnumName)

Renders the drop down list of ask before saving changes

public void renderAutoComplete (MarkupOutput out)

Renders 'AutoComplete Search Preference' preference.

Parameters
out MarkupOutput

public void renderColorTheme (MarkupOutput out)

This method is deprecated.
call renderColorThemeDropDownList( ) instead

Render 'Color Theme' preference.

public void renderColorThemeDropDownList (MarkupOutput out)

Render the dropdown list of available Color Themes

public void renderColorThemePreview (MarkupOutput out)

Render color theme preview DIV This preview shows the look & feel of theme basic element: shortcut bar, path bar, accordion, panel, editor.

public Tag renderColorThemePreviewZoom (MarkupOutput out, Tag previewDiv)

Render color theme preview DIV with Zooming This preview shows the zoomed in version of the color theme preview

Parameters
previewDiv theme preview DIV to add more children and attributes to

public void renderContact (MarkupOutput out)

Renders 'Administrator contact info' preference.

Parameters
out the output object

public void renderContactSection (MarkupOutput out)

Renders 'Administrator contact info' section.

Parameters
out the output object

public void renderDataDisplaySection (MarkupOutput out)

Renders 'Data Display' section.

Parameters
out the output object

public void renderDhtmlSection (MarkupOutput out)

Renders 'Dynamic HTML' section.

Parameters
out the output object

public void renderDropDownMenus (MarkupOutput out)

Renders 'Drop down menu' preferecence.

Parameters
out the output object

public void renderDropDownMenusSection (MarkupOutput out)

Renders 'Drop down menu' section.

Parameters
out the output object

public void renderDynamicControlButton (MarkupOutput out, String controlledDiv, String labelHiddenID, String labelShowID)

This method is deprecated.
No replacement.

Renders a control button which switchs the visibility of specific Div depending the DHTML or static HTML mode. It works hand-in-hand with getControlledDivAttr(String controlledDiv) to switch the visiblity of Div with ID as controlledDiv.

Parameters
out MarkupOutput
controlledDiv The ID of controlled Div
labelHiddenID The label for this button when Div is hidden
labelShowID The label for this button when Div is visible

public void renderDynamicControlButton (MarkupOutput out, String controlledDiv, String labelHiddenID, String labelShowID, int eventId)

Renders a control button which switchs the visibility of specific Div depending the DHTML or static HTML mode. It works hand-in-hand with getControlledDivAttr(String controlledDiv) to switch the visiblity of Div with ID as controlledDiv. Note - This function is an overload of the original renderDynamicControlButton by adding an additional argument of eventId since the page now has multiple dynamic buttons.

Parameters
out MarkupOutput
controlledDiv The ID of controlled Div
labelHiddenID The label for this button when Div is hidden
labelShowID The label for this button when Div is visible

public void renderElementsIncrementalFetch (MarkupOutput out)

Renders 'Elements Incremental fetch' preference.

Parameters
out the output object

public void renderEnableGridViewSearch (MarkupOutput out)

Renders 'enable Grid View Search' preference.

Parameters
out MarkupOutput

public void renderEnableVisEditor (MarkupOutput out)

Renders preference that allows users to open the Custom Visualizations Editor

Parameters
out MarkupOutput

public void renderExportReuseNewWindow (MarkupOutput out)

Renders "Re-use new window for each export, print, PDF action" preference

public void renderFeatureInfoList (MarkupOutput out)

public void renderFilterEditorSection (MarkupOutput out)

Renders 'Filter Editor' section.

Parameters
out the output object

public void renderFontShoppingCart (MarkupOutput out)

public void renderFontSize (MarkupOutput out)

Renders 'Font size' preference.

Parameters
out the output object

public void renderFontStyle (MarkupOutput out)

Renders 'Font style' preference.

Parameters
out the output object

public void renderFontStyleOption (MarkupOutput out)

Renders 'Font style' preference.

Parameters
out the output object

public void renderFontStyleSection (MarkupOutput out)

Renders 'Font style' section.

Parameters
out the output object

public void renderFullScreenModeBehaviorDocuments (MarkupOutput out)

public void renderFullScreenModeBehaviorReports (MarkupOutput out)

public void renderFullScreenModeDescriptorDocuments (MarkupOutput out)

public void renderFullScreenModeDescriptorReports (MarkupOutput out)

public void renderGridSearchObjectTypes (MarkupOutput out)

Render Grid Search allowed object types section This section will be available only in DHTML mode

Parameters
out MarkupOutput

public void renderHideMyReports (MarkupOutput out)

This method is deprecated.
This preference has been moved to the Folder Browsing group

Renders 'My Reports' preference.

Parameters
out the output object

public void renderHideMyReportsSection (MarkupOutput out)

This method is deprecated.
This preference has been moved to the Folder Browsing group

Renders 'My Reports' section.

Parameters
out the output object

public void renderHierarchicalSort (MarkupOutput out)

Renders 'Sort metrics hierarchically' preference

Parameters
out the output object

public void renderIncrementalFetchSection (MarkupOutput out)

Renders 'Incremental fetch' section.

Parameters
out the output object

public void renderKeepInCart (MarkupOutput out)

Parameters
out MarkupOutput

public void renderKeepInCartSection (MarkupOutput out)

Renders Keep in Cart Section.

Parameters
out the output object

public void renderLanguageDropDownList (MarkupOutput out)

Renders the drop down list of the language options

public void renderLanguageHeader (MarkupOutput out)

Renders the description for the language section

public void renderLastObjectRunOption (MarkupOutput lastObjectOption, StringBuffer lastObjectLabel)

public void renderLocale (MarkupOutput out)

Renders 'Locale' preference.

Parameters
out the output object

public void renderLocaleSection (MarkupOutput out)

Renders 'Locale' section.

Parameters
out the output object

public void renderMMTAccessOption (MarkupOutput out)

This method is deprecated.
not used anymore

Renders MMT Section preference.

Parameters
out the output object

public void renderMMTAccessSection (MarkupOutput out)

This method is deprecated.
not used anymore

Renders MMT Section section.

Parameters
out the output object

public void renderMMTAddress (MarkupOutput out)

This method is deprecated.
not used anymore

Renders MMT address preference.

Parameters
out the output object

public void renderMaxSearch (MarkupOutput out)

Renders 'Max Search Preference' preference.

Parameters
out the output object

public void renderMaxSessionIdleTime (MarkupOutput out)

Renders maximum session idle time

Parameters
out MarkupOutput

public void renderMaxSort (MarkupOutput out)

Renders 'Max Sort keys' preference

Parameters
out the output object

public void renderMessagesLocaleDropDownList (MarkupOutput out)

public void renderMessagesLocaleHeader (MarkupOutput out)

public void renderMetadataLocaleDropDownList (MarkupOutput out)

public void renderMetadataLocaleHeader (MarkupOutput out)

public void renderNCS (MarkupOutput out)

Renders 'Narrowcast Server' preference.

Parameters
out the output object

public void renderNCSEnableSection (MarkupOutput out)

Renders 'Narrowcast Server' section.

Parameters
out the output object

public void renderObjectsIncrementalFetch (MarkupOutput out)

Renders 'Objects Incremental fetch' preference.

Parameters
out the output object

public void renderOutputFormatsSection (MarkupOutput out)

Renders 'Output Formats' section.

Parameters
out the output object

public void renderPDFPrint (MarkupOutput out)

public void renderPreference (String preferenceName, MarkupOutput out)

This method is deprecated.
Call the corresponding renderXXX method directly.

Render individual preferences based on the name provided

Parameters
preferenceName name id of the preference

public void renderQuickSearch (MarkupOutput out)

Renders 'AutoComplete Search Preference' preference.

Parameters
out MarkupOutput

public void renderRefreshReport (MarkupOutput out)

Renders 'Refresh Report' preference.

Parameters
out the output object

public void renderRefreshReportSection (MarkupOutput out)

Renders 'Refresh Report' section.

Parameters
out the output object

public void renderSaveAs8iWarning (MarkupOutput out)

Renders the 'Save as 8i Warning' preference to know whether to prompt users to save reports using new features in MIcrostrategy 8.

Parameters
out the output object

public void renderSaveAs8iWarningSection (MarkupOutput out)

Renders 'Narrowcast Server' section.

Parameters
out the output object

public void renderSaveAsOptions (MarkupOutput out)

public void renderSaveAsVersionWarning (MarkupOutput out)

public void renderSaveAsVersionWarningSection (MarkupOutput out)

public void renderSaveMessageText (MarkupOutput out)

Render the save message text that should be presented to the user once the saving has been successful.

Parameters
out MarkupOutput where to write the output of the method

public void renderSavePromptedReportAs (MarkupOutput out, String preferenceEnumName, String controlledDiv)

public void renderSearchObjectTypes (MarkupOutput out)

Render search object types section This section will be available only in DHTML mode and apply to Quick Search UI (even QuickSearch is disabled).

Parameters
out MarkupOutput

public void renderSearchSection (MarkupOutput out)

Renders 'Search' section.

Parameters
out the output object

public void renderServerLocale (MarkupOutput out)

Renders 'Server Locale' preference.

Parameters
out the output object

public void renderServerLocaleDropDownList (MarkupOutput out)

Renders the drop down list for the number and date format section

public void renderServerLocaleHeader (MarkupOutput out)

Renders the description for the number and date format section

public void renderSharedReports (MarkupOutput out)

This method is deprecated.
This preference has been moved to the Folder Browsing Group

Renders 'Shared Reports' preference.

Parameters
out the output object

public void renderSharedReportsSection (MarkupOutput out)

This method is deprecated.
This preference has been moved to the Folder Browsing Group

Renders 'Shared Reports' section.

Parameters
out the output object

public void renderSingleLastObjectRun (MarkupOutput lastObjectOption, StringBuffer lastObjectLabel, WebEvent event, String pageTitle, String descriptor)

public void renderStart (MarkupOutput out)

Renders 'Start page' preference.

Parameters
out the output object

public void renderStartSection (MarkupOutput out)

Renders 'Start page' section.

Parameters
out the output object

public void renderTimeZone (MarkupOutput out)

Renders the renderTimeZone preference

Parameters
out the output object

public void renderTimeZoneDropDownList (MarkupOutput out)

Renders the drop down list for the time zone

public void renderTimeZoneHeader (MarkupOutput out)

Renders the description for the time zone

public void renderTrimWarehouseData (MarkupOutput out)

Renders ' Trim Warehouse Datae' preference.

Parameters
out the output object

public void renderUnits (MarkupOutput out)

Renders 'Units' preference.

Parameters
out the output object

public void renderUnitsDropDownList (MarkupOutput out)

Renders the drop down list of the units section

public void renderUnitsHeader (MarkupOutput out)

Renders the description of the units section

public void renderUseDhtml (MarkupOutput out)

Renders 'Use Dynamic HTML' preference.

Parameters
out the output object

public void renderUseEmbeddedFilters (MarkupOutput out)

Renders the 'Use Embedded Filter' preference.

Parameters
out the output object

public void renderWait (MarkupOutput out)

Renders 'Wait' preference.

Parameters
out the output object

public void renderWaitSection (MarkupOutput out)

Renders 'Wait' section.

Parameters
out the output object

public void renderWarehouseDataLocaleDropDownList (MarkupOutput out)

public void renderWarehouseDataLocaleHeader (MarkupOutput out)

public void renderWarningSessionTimeout (MarkupOutput out)

Renders 'enable warning before Web user session timeout' preference.

Parameters
out MarkupOutput

public void renderWorkingSet (MarkupOutput out)

Renders 'Working Set' preference.

Parameters
out the output object

public void setFontNamePicker (ShortcutList fontNamePicker)

Parameters
fontNamePicker The fontNamePicker to set.

public void setStartPagesPicker (ShortcutList startPagesPicker)

Parameters
startPagesPicker The startPagesPicker to set.

public void setTimeZonePicker (ShortcutList timeZonePicker)

Parameters
timeZonePicker The timeZonePicker to set.

public void transformBody (MarkupOutput out)

Generates the content for the General Preference's dialog.

Parameters
out the body content

Protected Methods

protected List getAllowableValues (String preferenceEnumName)