Package com.microstrategy.web.app

Class PageInfo

  • All Implemented Interfaces:
    ConfigurationElement, ConfigurationFile, java.lang.Cloneable
    public class PageInfo
extends AbstractConfigurationElement
    A PageInfo class instance represents the information regarding a page that can be handled by the Web Application. All the details required for displaying one page on the application are available from here.
    Since:
    MicroStrategy Web 7.3.1 or earlier

    • Field Detail

      • ATT_ALLOW_CANCEL

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

      • ATT_LOGIN_REQUIRED

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

      • ATT_EVENT_HANDLER

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

      • ATT_BINARY_DISPLAY

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

      • ATT_BINARY_DISPLAY_BEAN

        public static final java.lang.String ATT_BINARY_DISPLAY_BEAN
        Since:
        MicroStrategy Web 8.0.0
        See Also:
        Constant Field Values

      • ATT_PERSIST_MODE

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

      • ATT_TITLE_BEAN

        public static final java.lang.String ATT_TITLE_BEAN
        Since:
        MicroStrategy Web 9.0.0
        See Also:
        Constant Field Values

      • ATT_USE_RESOURCE_MGR

        public static final java.lang.String ATT_USE_RESOURCE_MGR
        Since:
        MicroStrategy Web 9.0.0
        See Also:
        Constant Field Values

      • ATT_CACHE_CONTROL

        public static final java.lang.String ATT_CACHE_CONTROL
        Since:
        MicroStrategy Web 9.0.0
        See Also:
        Constant Field Values

      • ATT_ISPROMPT

        public static final java.lang.String ATT_ISPROMPT
        Since:
        MicroStrategy Web 9.0.2
        See Also:
        Constant Field Values

      • ATT_SHOW_RECOVER_LINK

        public static final java.lang.String ATT_SHOW_RECOVER_LINK
        Flag indicating whether the page support automatic session recovery feature by displaying a recovery link to last messageID.
        See Also:
        Constant Field Values

    • Constructor Detail

      • PageInfo

        public PageInfo()
        Class constructor. Initializes a new -empty- instance of the Page class.

      • PageInfo

        public PageInfo​(org.w3c.dom.Node root)
        Class constructor. Initializes a Page instance based on the information included on the XML Node
        Parameters:
        root - Node instance representing the Page information.

      • PageInfo

        public PageInfo​(org.w3c.dom.Node root,
                PageInfo defaultPage)
        Class constructor. Initializes a Page with the information based on the XML Node and the default page instance.
        Parameters:
        root - Node instance representing the Page information.
        defaultPage - Template page for defining the default properties if required

    • Method Detail

      • getKeyAttribute

        protected java.lang.String getKeyAttribute()
        Description copied from class: AbstractConfigurationElement
        This method must return the attribute that uniquely identifies this element among its siblings; if no single attribute can be used, return null and override the getKey and setKey methods.
        Specified by:
        getKeyAttribute in class AbstractConfigurationElement
        Since:
        MicroStrategy Web 9.0.0

      • getPageInstance

        public WebComponent getPageInstance​(AppContext appContext)
                             throws WebAppException
        Generate the WebComponent instance related with the page information stored
        Parameters:
        appContext - the AppContext object with information about the application.
        Returns:
        an instance of a PageComponent initialized based on the information on this page
        Throws:
        WebAppException - if an error occurs while initialization.

      • getMessage

        public java.lang.String getMessage​(Messages messages)
        Get the page's localized description based on the descriptor information used for initializing this instance
        Parameters:
        messages - the Messages localization instance.
        Returns:
        the page's localized descriptor, or the description if the descriptionId is empty.

      • getTemplateInfoList

        public TemplateInfoList getTemplateInfoList()
        Get the TemplateInfo instance for this page.
        Returns:
        the TemplateInfo instance containing information used by the output page to render. Usage: getTemplateInfo() was replaced with getTemplateInfoList().getTemplateInfo(EnumRequestStatus.WebBeanRequestSuccessful)

      • setTemplateInfoList

        public void setTemplateInfoList​(TemplateInfoList templateInfoList)
        Set the list of template infos on the page
        Parameters:
        templateInfoList - The TemplateInfoList to be set on the page
        Since:
        MicroStrategy Web 9.0.0

      • getWebBeanInfoList

        public WebBeanInfoList getWebBeanInfoList()
        Get the list of beans defined for this page
        Returns:
        a WebBeanInfoList instance containing the beans defined for the page

      • setWebBeanInfoList

        public void setWebBeanInfoList​(WebBeanInfoList webBeanInfoList)
        Set the WebBeanInfoList on the page to the given list
        Parameters:
        webBeanInfoList - The new WebBeanInfoList to be set on the page
        Since:
        MicroStrategy Web 9.0.0

      • getEventMapList

        public EventMapList getEventMapList()
        Get the list of event mapping related to this page
        Returns:
        an instance of EventMapList containing the list of events that need to be mapped.

      • setEventMapList

        public void setEventMapList​(EventMapList eventMapList)
        Set the list of event mappings on the page
        Parameters:
        eventMapList - The list of event maps to be set on the page
        Since:
        MicroStrategy Web 9.0.0

      • getJavaScripts

        public JavaScriptInfoList getJavaScripts()
        Get the list of javascripts related to this page
        Returns:
        an instance of JavaScriptInfoList containing the list of JavaScripts defined for this page.

      • setJavaScripts

        public void setJavaScripts​(JavaScriptInfoList javaScriptInfoList)
        Set the list of javascripts on the page
        Parameters:
        javaScriptInfoList - The javascripts list to be set on the page
        Since:
        MicroStrategy Web 9.0.0

      • getAddOns

        public AddonInfoList getAddOns()
        Get the list of add-ons related to this page
        Returns:
        an instance of AddonInfoList containing the list of add-ons defined for this page.

      • setAddOns

        public void setAddOns​(AddonInfoList addonInfoList)
        Set the AddonInfoList on the page to the given list
        Parameters:
        addonInfoList - The new AddonInfoList to be set on the page
        Since:
        MicroStrategy Web 9.0.0

      • getName

        public java.lang.String getName()
        Get the page name related with this instance
        Returns:
        the page name

      • setName

        public void setName​(java.lang.String pageName)
        Set the page's name to the given parameter
        Parameters:
        pageName - the new name of the page

      • getBinaryDisplay

        public java.lang.String getBinaryDisplay()
        Deprecated.
        Use getBinaryDisplayBean instead.
        Get the binary display information related with this page
        Returns:
        the bean name (or bean hierarchy) that will be displayed as binary output

      • getBinaryDisplayBean

        public java.lang.String getBinaryDisplayBean()
        Get the binary display information related with this page
        Returns:
        the bean name (or bean hierarchy) that will be displayed as binary output
        Since:
        MicroStrategy Web 8.0.0

      • setBinaryDisplay

        public void setBinaryDisplay​(java.lang.String binaryDisplayBean)
        Deprecated.
        Use SetBinaryDisplayBean instead.
        Set the binary display information related with this page
        Parameters:
        binaryDisplayBean - the bean name (or bean hierarchy) that will be displayed as binary output

      • setBinaryDisplayBean

        public void setBinaryDisplayBean​(java.lang.String binaryDisplayBean)
        Set the binary display information related with this page
        Parameters:
        binaryDisplayBean - the bean name (or bean hierarchy) that will be displayed as binary output
        Since:
        MicroStrategy Web 8.0.0

      • getDescriptorID

        public java.lang.String getDescriptorID()
        Get the descriptor ID related with this page
        Returns:
        the descriptor ID for this page

      • setDescriptorID

        public void setDescriptorID​(java.lang.String descriptorID)
        Set the descriptor ID of this page to the given parameter
        Parameters:
        descriptorID - a descriptorID from the

      • getDescription

        public java.lang.String getDescription()
        Get the String description related with this page
        Returns:
        the text description of this page

      • setDescription

        public void setDescription​(java.lang.String description)
        Set the text descriptor of this page to the given parameter
        Parameters:
        description - the description of this page.

      • getPageComponentClass

        public java.lang.String getPageComponentClass()
        Get the name of the class related with the event handler for this page
        Returns:
        the name of the class for the event handler of this page.

      • setPageComponentClass

        public void setPageComponentClass​(java.lang.String className)
        Set the name of the class for the component instance of this page.
        Parameters:
        className - a fully qualified class name to use as component instance for this page.

      • getEventHandlerClass

        public java.lang.String getEventHandlerClass()
        Get the name of the class related with the event handler for this page
        Returns:
        the name of the class for the event handler of this page.

      • setEventHandlerClass

        public void setEventHandlerClass​(java.lang.String eventHandlerClass)
        Set the name of the class for the event handler of this page.
        Parameters:
        eventHandlerClass - a fully qualified class name to use as EventHandler for this page.

      • getFeatureId

        public java.lang.String getFeatureId()
        Get the feature Id associated with this page. The feature Id controls whether the page is visible or not depending on user privileges and application settings.
        Returns:
        the feature Id associated with this page.

      • setFeatureId

        public void setFeatureId​(java.lang.String featureId)
        Sets the name of the class for the event handler of this page.
        Parameters:
        featureId - the feature Id associated with this page.

      • setIsDefault

        public void setIsDefault​(boolean isDefault)
        Set the isDefault flag for this Page instance
        Parameters:
        isDefault - true/false value

      • isTrack

        public boolean isTrack()
        Returns if this object should be traced as visited link or not. Only tracks are maintained by the application for last visted pages.
        Returns:
        true if this page is a track of the application.

      • setIsTrack

        public void setIsTrack​(boolean isTrack)
        Sets if this object should be traced as visited link or not. Only tracks are maintained by the application for last visted pages.
        Parameters:
        isTrack - true if this page is a track of the application.

      • getAllowCancel

        public boolean getAllowCancel()
        Returns if this object be used as destination when a cancel event occurs.
        Returns:
        true if this page can receive the cancel event.

      • setAllowCancel

        public void setAllowCancel​(boolean allowCancel)
        Sets if this object be used as destination when a cancel event occurs.
        Parameters:
        allowCancel - true if if this page can receive the cancel event.

      • isPersistable

        public boolean isPersistable()
        Verifies if this page instance is persistable or not.
        Returns:
        true if the page's persist mode property has assigned any valid value different than EnumBeanPersistMode.BeanPersistModeDefault, otherwise, returns false.

      • setPersistMode

        public void setPersistMode​(int persistMode)
        Sets the persist mode property of this object. The default assigned to it is to save it.
        Parameters:
        persistMode - value of the setting to assign.

      • isDefault

        public boolean isDefault()
        Get the isDefault flag for this Page instance. The default page is used by the PageManager to serve as template when creating other pages.
        Returns:
        the true/false value of the isDefault flag of this Page

      • setIsLoginRequired

        public void setIsLoginRequired​(boolean loginRequired)
        Set if login is required for accessing this page
        Parameters:
        loginRequired - true/false value

      • isLoginRequired

        public boolean isLoginRequired()
        Get if login is required for accessing this page
        Returns:
        the true/false value of the loginRequired flag of this Page

      • setTitleBean

        public void setTitleBean​(java.lang.String value)
        Since:
        MicroStrategy Web 9.0.0

      • getTitleBean

        public java.lang.String getTitleBean()
        Since:
        MicroStrategy Web 9.0.0

      • setPrototypeAttribute

        public void setPrototypeAttribute​(java.lang.String prototype)
        set the name of the inherited page as prototype attribute
        Parameters:
        prototype - name of the inherited page
        Since:
        MicroStrategy Web 9.0.0

      • getPrototypeAttribute

        public java.lang.String getPrototypeAttribute()
        return the name of the inherited page stored as prototype attribute
        Returns:
        name of the inherited page
        Since:
        MicroStrategy Web 9.0.0

      • setUseResourceManager

        public void setUseResourceManager​(java.lang.String useResourceMgr)
        set the value for the ATT_USE_RESOURCE_MGR attribute
        Parameters:
        useResourceMgr - The values can be "on", "off", "renderInline"
        Since:
        MicroStrategy Web 9.0.0

      • getUseResourceManager

        public java.lang.String getUseResourceManager()
        return the value for the ATT_USE_RESOURCE_MGR attribute
        Since:
        MicroStrategy Web 9.0.0

      • setCacheControl

        public void setCacheControl​(java.lang.String cacheControl)
        set the value for the ATT_CACHE_CONTROL attribute
        Parameters:
        cacheControl - The values can be "on", "off", "auto" (read from preference)
        Since:
        MicroStrategy Web 9.0.0

      • getCacheControl

        public java.lang.String getCacheControl()
        return the value for the ATT_CACHE_CONTROL attribute
        Since:
        MicroStrategy Web 9.0.0

      • isPrompt

        public boolean isPrompt()
        return the value for the ATT_ISPROMPT attribute
        Since:
        MicroStrategy Web 9.0.0

      • setIsPrompt

        public void setIsPrompt​(java.lang.Boolean isPrompt)
        set the value for the ATT_ISPROMPT attribute
        Parameters:
        isPrompt - The values can be "true", "false"
        Since:
        MicroStrategy Web 9.0.0

      • initPrototype

        protected void initPrototype​(java.lang.String protoName)
        Description copied from class: AbstractConfigurationElement
        Inits the prototype object of this element. This element will inherit all the attribute and child elements from the prototype, but then any values defined through the config-src file or inline take precedence over the prototype. The name attribute represents the name of the prototype as specified in the XML. Typically this is the name of a sibling node in the xml. If name is empty, a different sibling might be used as prototype (like in the case of the PageInfo, which the page marked as isDefault is used as the default prototype). If this object already has a prototype, or if the prototype is not found in the siblings collections this methods throws an Exception.
        Overrides:
        initPrototype in class AbstractConfigurationElement
        Parameters:
        protoName - Prototype name, typically the name of a sibling node in the xml.
        Since:
        MicroStrategy Web 9.0.0

      • isRelatedToPage

        public boolean isRelatedToPage​(PageInfo page)
        Indicated whether the page shares common executable beans with another page.
        AN executable bean could be a Report Bean, a RW Bean or a Document Bean.
        Parameters:
        page - a PageInfo instance.
        Since:
        MicroStrategy Web 9.0.0

      • setHelpTopic

        public void setHelpTopic​(java.lang.String helpTopic)
        set the value for the ATT_HELP_TOPIC attribute
        Parameters:
        useResourceMgr - The value is string of helpt topic
        Since:
        MicroStrategy Web 9.3.1

      • getHelpTopic

        public java.lang.String getHelpTopic()
        return the value for the ATT_HELP_TOPIC attribute
        Since:
        MicroStrategy Web 9.3.1

      • setShowRecoverLink

        public void setShowRecoverLink​(boolean showRecoverLink)
        Set flag indicating whether this page can support show last message recovery link.
        Parameters:
        showLastMsgLink -

      • getShowRecoverLink

        public boolean getShowRecoverLink()
        Get flag indicating whether this page can support show last message recovery link.
        Returns:
        true if this page can support automatic session recovery