Interface PanelComponentDefinition

    • Field Detail

      • MENU_CATEGORY_APPLICATIONTOOLS

        static final String MENU_CATEGORY_APPLICATIONTOOLS
        WebManager menu category label
        See Also:
        Constant Field Values
      • MENU_CATEGORY_CHANNELINTEGRATION

        static final String MENU_CATEGORY_CHANNELINTEGRATION
        WebManager menu category label
        See Also:
        Constant Field Values
      • MENU_CATEGORY_INTEGRATIONTOOLS

        static final String MENU_CATEGORY_INTEGRATIONTOOLS
        WebManager menu category label
        See Also:
        Constant Field Values
      • MENU_CATEGORY_LAYOUTMANAGEMENT

        static final String MENU_CATEGORY_LAYOUTMANAGEMENT
        WebManager menu category label
        See Also:
        Constant Field Values
      • MENU_CATEGORY_MEDIATOOLS

        static final String MENU_CATEGORY_MEDIATOOLS
        WebManager menu category label
        See Also:
        Constant Field Values
      • MENU_CATEGORY_TRAFFICMANAGEMENT

        static final String MENU_CATEGORY_TRAFFICMANAGEMENT
        WebManager menu category label
        See Also:
        Constant Field Values
      • MENU_CATEGORY_USERINTERACTION

        static final String MENU_CATEGORY_USERINTERACTION
        WebManager menu category label
        See Also:
        Constant Field Values
      • MENU_CATEGORY_USERMANAGEMENT

        static final String MENU_CATEGORY_USERMANAGEMENT
        WebManager menu category label
        See Also:
        Constant Field Values
      • MENU_CATEGORY_VISITORSEGMENTATION

        static final String MENU_CATEGORY_VISITORSEGMENTATION
        WebManager menu category label
        See Also:
        Constant Field Values
    • Method Detail

      • getAccessKey

        @Deprecated
        char getAccessKey()
        Deprecated.
        As of 10.0 panels do not have an access key. This setting will be ignored.
        Returns the shortcut key for in the WebManager menu that can be used to open a panel.
        Returns:
        The shortcut key for in the WebManager
      • getName

        String getName()
        Returns the name of the panel that is shown in the WebManager menu.
        Specified by:
        getName in interface ComponentDefinition
        Returns:
        The name of the Panel
      • getDescription

        String getDescription()
        Returns the description of the panel. Can be used in a configuration environment to give a description of the panel.
        Specified by:
        getDescription in interface ComponentDefinition
        Returns:
        The description of this panel
      • isResizable

        boolean isResizable()
        Returns true if the panel is resizable.
        Returns:
        true if the panel is resizable
      • getWidth

        int getWidth()
        Returns the default width of the panel.
        Returns:
        the default width of the panel
      • getHeight

        int getHeight()
        Returns the default height of the panel.
        Returns:
        the default height of the panel
      • isPopup

        boolean isPopup()
        Returns true if this panel is a popup screen that is not shown in the WebManager menu.
        Returns:
        True if this panel is a popup screen
      • getMenuCategory

        String getMenuCategory()
        Returns the WebManager menu category label.
        Returns:
        the menu category label
        Since:
        10.0.0
      • setPanelUrl

        void setPanelUrl​(String url)
        Sets the relative or absolute url to render within the panel opened from the menu item associated with this panel. This replaces completely the rendering of the panel by the Spring MVC framework. It can be used for example to support Angular panels, in which case this URL points to the index.html of the Angular application.
        Parameters:
        url - the relative or absolute url to render within the panel opened from the menu item
      • getPanelUrl

        String getPanelUrl()
        Returns the relative or absolute url to render within the panel opened from the menu item associated with this panel. This replaces completely the rendering of the panel by the Spring MVC framework. It can be used for example to support Angular panels, in which case this URL points to the index.html of the Angular application.
        Returns:
        the relative or absolute url to render within the panel opened from the menu item associated with this panel