Package com.microstrategy.web.app.beans

Interface AppContext

  • All Superinterfaces:
    BeanContext
    All Known Implementing Classes:
    AppContextImpl, MobileChunkedAppContext
    public interface AppContext
extends BeanContext
    This interface maintains a reference to all the context objects required by the application. It saves an instance of specific applications objects, such as the SessionManager, the Preferences and the PageManager. It extends the BeanContext by adding information not only relevant to the WebComponents in the application, but for the application itself.
    Since:
    MicroStrategy Web 7.3.1 or earlier

    • Field Detail

      • CONFIG_CONTROLLER_CLASS

        static final java.lang.String CONFIG_CONTROLLER_CLASS
        Location of the configuration file
        See Also:
        Constant Field Values

      • CONFIG_EXTERNAL_SECURITY_CLASS

        static final java.lang.String CONFIG_EXTERNAL_SECURITY_CLASS
        Name of the class to be used as external security component on the application
        See Also:
        Constant Field Values

      • CONFIG_GLOBAL_FEATURES_CLASS

        static final java.lang.String CONFIG_GLOBAL_FEATURES_CLASS
        Name of the class to be used as external security component on the application
        Since:
        MicroStrategy Web 9.0.0
        See Also:
        Constant Field Values

      • CONFIG_PAGE_MANAGER

        static final java.lang.String CONFIG_PAGE_MANAGER
        Location of the configuration file
        See Also:
        Constant Field Values

      • CONFIG_PAGE_MANAGER_RESOURCE

        static final java.lang.String CONFIG_PAGE_MANAGER_RESOURCE
        Name of the configurations file's master copy
        See Also:
        Constant Field Values

      • CONFIG_SYS_DEFINITONS_RESOURCE

        static final java.lang.String CONFIG_SYS_DEFINITONS_RESOURCE
        Mame of the user preferences' master copy
        See Also:
        Constant Field Values

      • CONFIG_SYS_SERVER_DEFAULTS_RESOURCE

        static final java.lang.String CONFIG_SYS_SERVER_DEFAULTS_RESOURCE
        Mame of the admin preferences' master copy
        See Also:
        Constant Field Values

      • CONFIG_PREFERENCES_GROUPS_RESOURCE

        static final java.lang.String CONFIG_PREFERENCES_GROUPS_RESOURCE
        Mame of the preferences groups' master copy
        See Also:
        Constant Field Values

      • CONFIG_SUBSCRIPTION_PORTAL_RESOURCE

        static final java.lang.String CONFIG_SUBSCRIPTION_PORTAL_RESOURCE
        Mame of the subscription portal properties master copy
        See Also:
        Constant Field Values

      • CONFIG_SUBSCRIPTION_API_RESOURCE

        static final java.lang.String CONFIG_SUBSCRIPTION_API_RESOURCE
        Mame of the subscription api proeprties master copy
        See Also:
        Constant Field Values

      • CONFIG_SUBSCRIPTION_API_TEMPLATE_RESOURCE

        static final java.lang.String CONFIG_SUBSCRIPTION_API_TEMPLATE_RESOURCE
        Mame of the subscription template properties master copy
        See Also:
        Constant Field Values

      • CONFIG_SUBSCRIPTION_ENGINE_RESOURCE

        static final java.lang.String CONFIG_SUBSCRIPTION_ENGINE_RESOURCE
        Mame of the subscriptions engine properties master copy
        See Also:
        Constant Field Values

      • CONFIG_SERVLET_NAME

        static final java.lang.String CONFIG_SERVLET_NAME
        URI of the deployed applciation
        See Also:
        Constant Field Values

      • CONFIG_SERVLET_COMPONENT_NAME

        static final java.lang.String CONFIG_SERVLET_COMPONENT_NAME
        Name of servlet component name
        See Also:
        Constant Field Values

      • CONFIG_SERVLET_EVENT_HANDLER_NAME

        static final java.lang.String CONFIG_SERVLET_EVENT_HANDLER_NAME
        Name of servlet component event handler
        See Also:
        Constant Field Values

      • CONFIG_WEB_SERVLET_NAME

        static final java.lang.String CONFIG_WEB_SERVLET_NAME
        URI of the deployed applciation for web servlet
        See Also:
        Constant Field Values

      • CONFIG_ADMIN_SERVLET_NAME

        static final java.lang.String CONFIG_ADMIN_SERVLET_NAME
        URI of the deployed applciation for web administration servlet
        See Also:
        Constant Field Values

      • CONFIG_SERVER_ADMIN_SERVLET_NAME

        static final java.lang.String CONFIG_SERVER_ADMIN_SERVLET_NAME
        URI of the deployed applciation for intelligence server administration servlet
        Since:
        MicroStrategy Web 9.0.0
        See Also:
        Constant Field Values

      • CONFIG_MESSAGES

        static final java.lang.String CONFIG_MESSAGES
        Name of the MessagesManager object initialization file
        See Also:
        Constant Field Values

      • CONFIG_STYLE_CATALOG

        static final java.lang.String CONFIG_STYLE_CATALOG
        Location of the style catalog's file
        See Also:
        Constant Field Values

      • CONFIG_STYLE_CATALOG_RESOURCE

        static final java.lang.String CONFIG_STYLE_CATALOG_RESOURCE
        Name of the style catalog's master file
        See Also:
        Constant Field Values

      • CONFIG_IFRAME_RESOURCE

        static final java.lang.String CONFIG_IFRAME_RESOURCE
        Name of the JSP used for the IFrame
        Since:
        MicroStrategy Web 8.0.0
        See Also:
        Constant Field Values

      • CONFIG_PREFERENCES

        static final java.lang.String CONFIG_PREFERENCES
        Location of the user preferences file
        See Also:
        Constant Field Values

      • CONFIG_PREFERENCES_GROUPS

        static final java.lang.String CONFIG_PREFERENCES_GROUPS
        Name of the grouped preferences file
        See Also:
        Constant Field Values

      • CONFIG_SERVLET_PATH

        static final java.lang.String CONFIG_SERVLET_PATH
        Servlet's path
        See Also:
        Constant Field Values

      • CONFIG_APP_BEANS_EVENTS

        static final java.lang.String CONFIG_APP_BEANS_EVENTS
        Name of the application events definition file
        See Also:
        Constant Field Values

      • CONFIG_MD_BEANS_EVENTS

        static final java.lang.String CONFIG_MD_BEANS_EVENTS
        Name of the md events definition file
        See Also:
        Constant Field Values

      • CONFIG_DEBUG_FLAGS_MASK

        static final java.lang.String CONFIG_DEBUG_FLAGS_MASK
        Debug Mask Flag
        See Also:
        Constant Field Values

      • CONFIG_RELOAD_CONFIG

        static final java.lang.String CONFIG_RELOAD_CONFIG
        Reload configuration file on every request
        See Also:
        Constant Field Values

      • CONFIG_IFRAME_JSP

        static final java.lang.String CONFIG_IFRAME_JSP
        Name of the jsp containing the iframe logic
        See Also:
        Constant Field Values

      • CONFIG_XHR_JSP

        static final java.lang.String CONFIG_XHR_JSP
        Name of the jsp containing the xhr partial update content
        Since:
        MicroStrategy Web 9.0.1
        See Also:
        Constant Field Values

      • CONFIG_ADMIN_SERVERS

        static final java.lang.String CONFIG_ADMIN_SERVERS
        Name of the file containing the i-servers the application is conencted to
        See Also:
        Constant Field Values

      • CONFIG_IPAADMIN_FILE

        static final java.lang.String CONFIG_IPAADMIN_FILE
        Name of the file containing the IPA configuration
        See Also:
        Constant Field Values

      • CONFIG_IPAENV_FILE

        static final java.lang.String CONFIG_IPAENV_FILE
        Name of the file containing the IPA environments
        See Also:
        Constant Field Values

      • CONFIG_SYS_PREFERENCE_DEFINITION

        static final java.lang.String CONFIG_SYS_PREFERENCE_DEFINITION
        Location of the admin preferences file
        See Also:
        Constant Field Values

      • CONFIG_SYS_SERVER_DEFAULTS

        static final java.lang.String CONFIG_SYS_SERVER_DEFAULTS
        Name of the file containing the default values for i-servers' configuaration
        See Also:
        Constant Field Values

      • CONFIG_ISERVER_POLLING_FREQUENCY

        static final java.lang.String CONFIG_ISERVER_POLLING_FREQUENCY
        polling frequency for asyncrhronous call to the i-server
        See Also:
        Constant Field Values

      • CONFIG_LOG_PROPERTIES_FILE

        static final java.lang.String CONFIG_LOG_PROPERTIES_FILE
        Logger properties file
        See Also:
        Constant Field Values

      • CONFIG_FORMATTER_FILE

        static final java.lang.String CONFIG_FORMATTER_FILE
        formatter config file
        See Also:
        Constant Field Values

      • CONFIG_FORMAT_PROPERTIES_MAPPING

        static final java.lang.String CONFIG_FORMAT_PROPERTIES_MAPPING
        file to store the mapping of formatting properties between the back end and the browser
        Since:
        MicroStrategy Web 8.0.0
        See Also:
        Constant Field Values

      • CONFIG_OBJBROWSER_FOLDERLINKS_FILE

        static final java.lang.String CONFIG_OBJBROWSER_FOLDERLINKS_FILE
        file that stores the folderLinks for object browsers
        Since:
        MicroStrategy Web 8.0.0
        See Also:
        Constant Field Values

      • CONFIG_CACHE_SETTINGS_FILE

        static final java.lang.String CONFIG_CACHE_SETTINGS_FILE
        cache config file
        See Also:
        Constant Field Values

      • CONFIG_CACHE_SETTINGS_PROP

        static final java.lang.String CONFIG_CACHE_SETTINGS_PROP
        See Also:
        Constant Field Values

      • CONFIG_CONFIG_FILES_DEFAULT_LOCATION

        static final java.lang.String CONFIG_CONFIG_FILES_DEFAULT_LOCATION
        Config files location
        Since:
        MicroStrategy Web 7.5.1
        See Also:
        Constant Field Values

      • CONFIG_LOG_FILES_DEFAULT_LOCATION

        static final java.lang.String CONFIG_LOG_FILES_DEFAULT_LOCATION
        Logger properties file location
        See Also:
        Constant Field Values

      • CONFIG_LOG_FILE_MB_SIZE_LIMIT

        static final java.lang.String CONFIG_LOG_FILE_MB_SIZE_LIMIT
        Maximum log file size
        See Also:
        Constant Field Values

      • CONFIG_SUBSCRIPTION_FOLDER

        static final java.lang.String CONFIG_SUBSCRIPTION_FOLDER
        Location of the subscription properties files
        See Also:
        Constant Field Values

      • CONFIG_DEFAULT_EVENT

        static final java.lang.String CONFIG_DEFAULT_EVENT
        Application's default event id
        See Also:
        Constant Field Values

      • CONFIG_DEFAULT_PDF_IMAGES_FOLDER

        static final java.lang.String CONFIG_DEFAULT_PDF_IMAGES_FOLDER
        Application's default images folder for PDF.
        See Also:
        Constant Field Values

      • CONFIG_EXCEL_DIRECT_EXPORT

        static final java.lang.String CONFIG_EXCEL_DIRECT_EXPORT
        Indicates if the application uses the excel direct export functionality
        Since:
        MicroStrategy Web 7.5.0
        See Also:
        Constant Field Values

      • CONFIG_DEFAULT_BLANK_REPORT_ID

        static final java.lang.String CONFIG_DEFAULT_BLANK_REPORT_ID
        Indicates the default object id for the blank report object.
        Since:
        MicroStrategy Web 8.0.0
        See Also:
        Constant Field Values

      • CONFIG_DEFAULT_BLANK_REPORT_WRITING_ID

        static final java.lang.String CONFIG_DEFAULT_BLANK_REPORT_WRITING_ID
        Indicates the default object id for the blank report writing object.
        Since:
        MicroStrategy Web 8.0.0
        See Also:
        Constant Field Values

      • CONFIG_DEFAULT_BLANK_ANALYSIS_ID

        static final java.lang.String CONFIG_DEFAULT_BLANK_ANALYSIS_ID
        Indicates the default object id for the blank Analysis object.
        Since:
        MicroStrategy Web 9.3.1
        See Also:
        Constant Field Values

      • CONFIG_DEFAULT_BLANK_XDA_REPORT_ID

        static final java.lang.String CONFIG_DEFAULT_BLANK_XDA_REPORT_ID
        Indicates the default object id for the blank xda report object.
        Since:
        MicroStrategy Web 8.0.2
        See Also:
        Constant Field Values

      • CONFIG_DEFAULT_BLANK_HTML5_DASHBOARD_ID

        static final java.lang.String CONFIG_DEFAULT_BLANK_HTML5_DASHBOARD_ID
        Indicates the default object id for the blank Analysis object.
        Since:
        MicroStrategy Web 9.5.0
        See Also:
        Constant Field Values

      • CONFIG_BLOCK_LIBRARY

        static final java.lang.String CONFIG_BLOCK_LIBRARY
        Location of the BLOCK LIBRARY to use.
        Since:
        MicroStrategy Web 9.0.0
        See Also:
        Constant Field Values

      • CONFIG_WIDGET_LIBRARY

        static final java.lang.String CONFIG_WIDGET_LIBRARY
        Deprecated.
        Use CONFIG_BLOCK_LIBRARY instead.
        Location of the BLOCK LIBRARY to use.
        Since:
        MicroStrategy Web 9.0.0
        See Also:
        Constant Field Values

      • CONFIG_SSL_TRUSTSTORE

        static final java.lang.String CONFIG_SSL_TRUSTSTORE
        See Also:
        Constant Field Values

      • CONFIG_SSL_TRUSTSTORE_PWD

        static final java.lang.String CONFIG_SSL_TRUSTSTORE_PWD
        See Also:
        Constant Field Values

      • CONFIG_SSL_KEYSTORE_PWD

        static final java.lang.String CONFIG_SSL_KEYSTORE_PWD
        See Also:
        Constant Field Values

      • CONFIG_REFINE_SSL_TRUSTSTORE

        static final java.lang.String CONFIG_REFINE_SSL_TRUSTSTORE
        See Also:
        Constant Field Values

      • CONFIG_REFINE_SSL_TRUSTSTORE_PWD

        static final java.lang.String CONFIG_REFINE_SSL_TRUSTSTORE_PWD
        See Also:
        Constant Field Values

      • JAVASCRIPT_RESOURCES_FOLDER

        static final java.lang.String JAVASCRIPT_RESOURCES_FOLDER
        Constant used for specifying the type of resources level to return => Javascript folder
        See Also:
        Constant Field Values

      • JSP_RESOURCES_FOLDER

        static final java.lang.String JSP_RESOURCES_FOLDER
        Constant used for specifying the type of resources level to return => JSP folder
        Since:
        MicroStrategy Web 7.5.3
        See Also:
        Constant Field Values

      • CUSTOM_RESOURCES_FOLDER

        static final java.lang.String CUSTOM_RESOURCES_FOLDER
        Constant used for specifying the type of resources level to return => CUSTOM folders
        Since:
        MicroStrategy Web 9.0.0
        See Also:
        Constant Field Values

      • HELP_RESOURCES_FOLDER

        static final java.lang.String HELP_RESOURCES_FOLDER
        Constant used for specifying the type of resources level to return => Help folder
        Since:
        MicroStrategy Web 9.0.0
        See Also:
        Constant Field Values

      • CUSTOM_HELP_RESOUCRCES_FOLDER

        static final java.lang.String CUSTOM_HELP_RESOUCRCES_FOLDER
        Constant used for specifying the type of resources level to return => Custom Help folder (plugins)
        Since:
        MicroStrategy Web 9.0.0
        See Also:
        Constant Field Values

      • IMAGE_RESOURCES_FOLDER

        static final java.lang.String IMAGE_RESOURCES_FOLDER
        Constant used for specifying the type of resources level to return => Images folder
        See Also:
        Constant Field Values

      • STYLE_RESOURCES_FOLDER

        static final java.lang.String STYLE_RESOURCES_FOLDER
        Constant used for specifying the type of resources level to return => Styles folder
        See Also:
        Constant Field Values

      • RESOURCE_FOLDER_PREFIX

        static final java.lang.String RESOURCE_FOLDER_PREFIX
        Prefix used to know which configParameters are resourceFolders
        See Also:
        Constant Field Values

      • STYLE_FIXED_FONT_RESOURCES_FOLDER

        static final java.lang.String STYLE_FIXED_FONT_RESOURCES_FOLDER
        Constant used for specifying the type of resources level to return => Styles folder with fixed font
        See Also:
        Constant Field Values

      • STYLE_FIXED_FONT_DB_RESOURCES_FOLDER

        static final java.lang.String STYLE_FIXED_FONT_DB_RESOURCES_FOLDER
        Constant used for specifying the type of resources level to return => Styles folder with fixed font for double byte
        See Also:
        Constant Field Values

      • STYLE_DB_RESOURCES_FOLDER

        static final java.lang.String STYLE_DB_RESOURCES_FOLDER
        Constant used for specifying the type of resources level to return => Styles folder for double byte
        See Also:
        Constant Field Values

      • CONFIG_DISABLE_MAX_STATE_COMPRESSION

        static final java.lang.String CONFIG_DISABLE_MAX_STATE_COMPRESSION
        Constant used for specifying whether to compress XML status for RWBean and ReportBean,of which the size of XML status tends to be big.
        Since:
        MicroStrategy Web 8.1.1
        See Also:
        Constant Field Values

      • DEFAULT_EVENT_XML

        static final java.lang.String DEFAULT_EVENT_XML
        Constant used for the default events xml relative to the configuration path.
        Since:
        MicroStrategy Web 9.0.0
        See Also:
        Constant Field Values

      • DISPLAY_MODE_HTML

        static final java.lang.String DISPLAY_MODE_HTML
        Constant used to indicate that the rendering will be done in format of html
        Since:
        MicroStrategy Web 9.0.1
        See Also:
        Constant Field Values

      • DISPLAY_MODE_JSON

        static final java.lang.String DISPLAY_MODE_JSON
        Constant used to indicate that the rendering will be done in format of json
        Since:
        MicroStrategy Web 9.0.1
        See Also:
        Constant Field Values

    • Method Detail

      • getExternalSecurity

        ExternalSecurity getExternalSecurity()
        This method returns the External Security instance associated with this application context.
        Returns:
        ExternalSecurity

      • setExternalSecurity

        void setExternalSecurity​(ExternalSecurity es)
        This method sets the External Security associated with this application context.
        Parameters:
        es - An ExternalSecurity instance.

      • getSessionManager

        SessionManager getSessionManager()
        Deprecated.
        Use WebAppSessionManager instead, via the getAppSessionManager method.
        This method returns the Session Manager associated with this application context.
        Returns:
        SessionManager

      • setAppSessionManager

        void setAppSessionManager​(WebAppSessionManager sm)
        This method sets the Application Session Manager associated with this application context.
        Since:
        MicroStrategy Web 9.0.0

      • setSessionManager

        void setSessionManager​(SessionManager sm)
        Deprecated.
        Use WebAppSessionManager instead, via the getAppSessionManager method.
        This method sets the Session Manager associated with this application context.
        Parameters:
        sm - A SessionManager instance.

      • getPreferences

        Preferences getPreferences()
        This method returns the Preferences object associated with this application context.
        Returns:
        Preferences

      • setPreferences

        void setPreferences​(Preferences prefs)
        This method sets a Preferences object for use with this application context.
        Parameters:
        prefs - A Preferences object.

      • getPageManager

        PageManager getPageManager()
        This method gets the PageManager object associated with this application context.
        Returns:
        the (@link PageManager) object associates with this application context.

      • setPageManager

        void setPageManager​(PageManager pageManager)
        This method sets the PageManager object associated with this application context.
        Parameters:
        pageManager - A PageManager object.

      • getBrowserSettings

        BrowserSettings getBrowserSettings()
        This method returns the BrowserSettings object associated with this application context.
        Returns:
        BrowserSettings

      • setBrowserSettings

        void setBrowserSettings​(BrowserSettings bs)
        This method sets the BrowserSettings object to be associated with this application context.
        Parameters:
        bs - An instance of an BrowserSettings object.

      • getDocumentFromFileResource

        org.w3c.dom.Document getDocumentFromFileResource​(java.lang.String filePath)
        This method returns a DOM Document from a file resource. The method works by attempting the following operations, in order:
        1. Try to call the same method on BeanContext first. If that succeeds, return.
        2. Next, it tries to get the real path to this file relative to the web application. If it retrieves a valid path, it again calls the BeanContext's version of this method. If it succeeds, it returns.
        3. At this point, we cannot resolve the reference as a physical file. We then try to use the ServletContext's getResourceAsInput method to retrieve the contents of the file as resource that may be embedded within a WAR file. If this succeeeds, we load the contents into a DOM document and return it.THIS IS ONLY POSSIBLE WITHIN A JAVA ENVIRONMENT.
        4. If we get to this step, then we return an Exception.
        Parameters:
        filePath - The absolute or relative path to the file resource.
        Returns:
        the Document node that contains the file contents.

      • getResourcesFolder

        java.lang.String getResourcesFolder​(java.lang.String folderType)
        Return the path to the resources folder indicated on the configuration file, corresponding to the type sent as parameter.
        This is actually a convenience method for the getConfigParameter. This method returns all configuration parameters that starts with RESOURCE_FOLDER_PREFIX and folderType is whatever goes after that. This method also makes sure that the name of the folder has always a backslash "/" at the end.
        Parameters:
        folderType - integer constant that specifies the type of resource folder to return
        Returns:
        the path of the base folder for the folder type requested

      • setServletPath

        void setServletPath​(java.lang.String servletPath)
        Define the full application path to the Servlet. This value is read form the configuration file and if is not set it will be automatically generated from the request.
        Parameters:
        servletPath - a String with the servlet path

      • setConfigServletPath

        void setConfigServletPath​(java.lang.String configServletPath)
        Define the full application path to the Servlet as defined in the configuration file.
        Parameters:
        configServletPath - a String with the servlet path

      • getConfigServletPath

        java.lang.String getConfigServletPath()
        Get the full application path to the Servlet as defined in the configuration file
        Returns:
        a String with the servlet path

      • getResourceFileAsString

        java.lang.String getResourceFileAsString​(java.lang.String filePath,
                                         java.lang.String resourceFileName)
        Returns the contents of the resource file as string from the file path provided. If the resource cannot be found in the location, it will be dispensed
        Parameters:
        filePath - location of the resource file (relative path)
        resourceFileName - resource file
        Returns:
        the contents of the resource file.

      • getFileContentsAsString

        java.lang.String getFileContentsAsString​(java.lang.String filePath)
        Returns the contents of the resource file as string from the file path provided. it does not dispense the file
        Parameters:
        filePath - location of the resource file (relative path)
        Returns:
        the contents of the resource file.

      • getFileContentsAsString

        java.lang.String getFileContentsAsString​(java.lang.String filePath,
                                         java.lang.String encoding)
        Returns the contents of the resource file as string from the file path provided using the named character encoding. it does not dispense the file
        Parameters:
        filePath - location of the resource file (relative path)
        encoding - The name of a supported character encoding.
        Returns:
        the contents of the resource file.

      • getRealPath

        java.lang.String getRealPath​(java.lang.String filePath)
        Return the absolute path of th erelative path provided
        Parameters:
        filePath - relative path to get the relative path from
        Returns:
        the absolute path

      • getBrowserLocaleId

        java.lang.String getBrowserLocaleId()
        This method returns the Locale Id defined in web preferences as Language. If default, it'll return browser's locale Id instead.
        Returns:
        a String with the Locale ID.

      • getBrowserServerLocaleId

        java.lang.String getBrowserServerLocaleId()
        This method returns the Locale associated with Date and Number format locale web preference.If default, it'll return browser's locale Id instead.
        Returns:
        a String with the Locale ID.

      • getConfigParameter

        java.lang.String getConfigParameter​(java.lang.String param)
        Returns the value of a configuration parameter. Configuration parameters are defined in the web.xml file using the context-param and init-param tags.
        Parameters:
        param - name of the parameter to retrieve
        Returns:
        the value of the parameter

      • putConfigParameter

        void putConfigParameter​(java.lang.String key,
                        java.lang.String value)
        Appends a Configuration Parameter to the Configuration Parameters list. Configuration parameters are defined in the web.xml file using the context-param and init-param tags.
        Parameters:
        key - name of the configuration parameter
        value - value of the configuration parameter

      • dispenseFile

        void dispenseFile​(java.lang.String realPath,
                  java.lang.String resourcePath)
        Dispenses the master copy of the a resource file located in the classpath into the file indicated in the realpath
        Parameters:
        realPath - the destination of the resource file to dispense
        resourcePath - the resource file to dispense.

      • setDefaultEvent

        void setDefaultEvent​(int eventID)
        Sets the eventTD provided as the default event of the application
        Parameters:
        eventID - eventID of the application's default event

      • getFontSize

        java.lang.String getFontSize()
        A string with the base font size to use, the string might contain the type of size (i.e, pt, px, etc.)
        Returns:
        a string with size of the font to use

      • getFontName

        java.lang.String getFontName()
        Returns a string with the name of the fonts, or the list of fonts that a browser should use when rendering the page. This is usually retrieved from user Preferences
        Returns:
        a String with a comma separated list of the fonts to use in this page.

      • isDoubleByte

        boolean isDoubleByte()
        Returns true if the locale is a double byte language like Chinese, Korean or Japenese.
        Returns:
        true if the locale is a double byte language like Chinese, Korean or Japenese.

      • getRootName

        java.lang.String getRootName()
        Returns the name of the root component In the case of the jsp/servlet enviroment,it will be the name of the main servlet component This corresponds to the value of the parameter CONFIG_SERVLET_NAME
        Since:
        MicroStrategy Web 9.0.0

      • getCurrentPage

        PageComponent getCurrentPage()
        Returns the name of the current page associated with the context. It returns null if there no current page.
        Returns:
        PageComponent which is set on this object.
        Since:
        MicroStrategy Web 9.0.0
        See Also:
        setCurrentPage(PageComponent)

      • setCurrentPage

        void setCurrentPage​(PageComponent page)
        Set a page as the current page of this context.
        Parameters:
        page - PageComponent instance.
        Since:
        MicroStrategy Web 9.0.0
        See Also:
        getCurrentPage()