Class BasicCtxMenuPolicyFilter

    • Constructor Detail

      • BasicCtxMenuPolicyFilter

        public BasicCtxMenuPolicyFilter()
    • Method Detail

      • init

        public boolean init​(Plugin plugin)
        Description copied from interface: PluginComponent
        Initialize the component with the given plugin configuration
        Specified by:
        init in interface PluginComponent
        Parameters:
        plugin - the calling plugin
        Returns:
        true if the component has been correctly initialized.
        Since:
        jcms-5.7.1
        See Also:
        PluginComponent.init(Plugin)
      • initCtxMenu

        public void initCtxMenu​(PublicationCtxMenu ctxMenu,
                                JcmsJspContext jcmsContext)
        Description copied from interface: CtxMenuPolicyFilter
        Initialize the contextual menu.
        This method is called when the Context Menu object class is created.
        Specified by:
        initCtxMenu in interface CtxMenuPolicyFilter
        Parameters:
        ctxMenu - the instance of the context menu created during initial request.
        jcmsContext - the JcmsJspContext of the request during which the context menu object was created.
      • initCtxMenu

        public void initCtxMenu​(MemberCtxMenu ctxMenu,
                                JcmsJspContext jcmsContext)
        Description copied from interface: CtxMenuPolicyFilter
        Initialize the contextual menu.
        This method is called when the Context Menu object class is created.
        Specified by:
        initCtxMenu in interface CtxMenuPolicyFilter
        Parameters:
        ctxMenu - the instance of the context menu created during initial request.
        jcmsContext - the JcmsJspContext of the request during which the context menu object was created.
      • initCtxMenu

        public void initCtxMenu​(WidgetCtxMenu ctxMenu,
                                JcmsJspContext jcmsContext)
        Description copied from interface: CtxMenuPolicyFilter
        Initialize the contextual menu.
        This method is called when the Context Menu object class is created.
        Specified by:
        initCtxMenu in interface CtxMenuPolicyFilter
        Parameters:
        ctxMenu - the instance of the context menu created during initial request.
        jcmsContext - the JcmsJspContext of the request during which the context menu object was created.
      • checkCtxMenuItems

        public char[] checkCtxMenuItems​(PublicationCtxMenu ctxMenu,
                                        Publication pub,
                                        char[] letters)
        Description copied from interface: CtxMenuPolicyFilter
        Checks the processed contextual menu
        Specified by:
        checkCtxMenuItems in interface CtxMenuPolicyFilter
        Parameters:
        ctxMenu - the instance of the context menu created during initial request.
        pub - the working publication
        letters - an array of letters describing menus to display
        Returns:
        char[] reorganized chars
      • checkCtxMenuItems

        public char[] checkCtxMenuItems​(CategoryCtxMenu ctxMenu,
                                        Category cat,
                                        char[] letters)
        Description copied from interface: CtxMenuPolicyFilter
        Checks the processed contextual menu
        Specified by:
        checkCtxMenuItems in interface CtxMenuPolicyFilter
        Parameters:
        ctxMenu - the instance of the context menu created during initial request.
        cat - the working category
        letters - an array of letters describing menus to display
        Returns:
        char[] reorganized chars
      • checkCtxMenuItems

        public char[] checkCtxMenuItems​(MemberCtxMenu ctxMenu,
                                        Member mbr,
                                        char[] letters)
        Description copied from interface: CtxMenuPolicyFilter
        Checks the processed contextual menu
        Specified by:
        checkCtxMenuItems in interface CtxMenuPolicyFilter
        Parameters:
        ctxMenu - the instance of the context menu created during initial request.
        mbr - the working member
        letters - an array of letters describing menus to display
        Returns:
        char[] reorganized chars
      • checkCtxMenuItems

        public char[] checkCtxMenuItems​(WidgetCtxMenu ctxMenu,
                                        java.lang.String menuItems,
                                        java.lang.String chooserType,
                                        java.lang.String chooserId,
                                        char[] letters)
        Description copied from interface: CtxMenuPolicyFilter
        Checks the processed contextual menu
        Specified by:
        checkCtxMenuItems in interface CtxMenuPolicyFilter
        Parameters:
        ctxMenu - the instance of the context menu created during initial request.
        letters - an array of letters describing menus to display
        Returns:
        char[] reorganized chars
      • handleCtxMenuItems

        public int handleCtxMenuItems​(java.lang.StringBuffer sb,
                                      PublicationCtxMenu ctxMenu,
                                      Publication pub,
                                      char letter,
                                      int status)
        Description copied from interface: CtxMenuPolicyFilter
        Handle the current StringBuffer to append custom content for the given Publication and given Letter
        Specified by:
        handleCtxMenuItems in interface CtxMenuPolicyFilter
        Parameters:
        sb - the StringBuffer to update
        ctxMenu - the instance of the context menu created during initial request.
        pub - the working publication
        letter - the current letter
        status - preious plugin's status
        Returns:
        int the status MENU_SKIPPED, MENU_ENABLED, MENU_DISABLED
      • handleCtxMenuItems

        public int handleCtxMenuItems​(java.lang.StringBuffer sb,
                                      CategoryCtxMenu ctxMenu,
                                      Category cat,
                                      char letter,
                                      int status)
        Description copied from interface: CtxMenuPolicyFilter
        Handle the current StringBuffer to append custom content for the given Category and given Letter
        Specified by:
        handleCtxMenuItems in interface CtxMenuPolicyFilter
        Parameters:
        sb - the StringBuffer to update
        ctxMenu - the instance of the context menu created during initial request.
        cat - the working category
        letter - the current letter
        status - preious plugin's status
        Returns:
        int the status MENU_SKIPPED, MENU_ENABLED, MENU_DISABLED
      • handleCtxMenuItems

        public int handleCtxMenuItems​(java.lang.StringBuffer sb,
                                      MemberCtxMenu ctxMenu,
                                      Member mbr,
                                      char letter,
                                      int status)
        Description copied from interface: CtxMenuPolicyFilter
        Handle the current StringBuffer to append custom content for the given Member and given Letter
        Specified by:
        handleCtxMenuItems in interface CtxMenuPolicyFilter
        Parameters:
        sb - the StringBuffer to update
        ctxMenu - the instance of the context menu created during initial request.
        mbr - the working member
        letter - the current letter
        status - preious plugin's status
        Returns:
        int the status MENU_SKIPPED, MENU_ENABLED, MENU_DISABLED
      • handleCtxMenuItems

        public int handleCtxMenuItems​(java.lang.StringBuffer sb,
                                      WidgetCtxMenu ctxMenu,
                                      java.lang.String menuItems,
                                      java.lang.String chooserType,
                                      java.lang.String chooserId,
                                      char letter,
                                      int status)
        Description copied from interface: CtxMenuPolicyFilter
        Handle the current StringBuffer to append custom content for the given Member and given Letter
        Specified by:
        handleCtxMenuItems in interface CtxMenuPolicyFilter
        Parameters:
        sb - the StringBuffer to update
        ctxMenu - the instance of the context menu created during initial request.
        letter - the current letter
        status - preious plugin's status
        Returns:
        int the status MENU_SKIPPED, MENU_ENABLED, MENU_DISABLED
      • handleCtxMenuItems

        public void handleCtxMenuItems​(java.lang.StringBuffer sb,
                                       PublicationCtxMenu ctxMenu,
                                       Publication pub)
        Description copied from interface: CtxMenuPolicyFilter
        Handle the current StringBuffer to append custom content for the given Publication
        Specified by:
        handleCtxMenuItems in interface CtxMenuPolicyFilter
        Parameters:
        sb - the StringBuffer to update
        ctxMenu - the instance of the context menu created during initial request.
        pub - the working publication
      • handleCtxMenuItems

        public void handleCtxMenuItems​(java.lang.StringBuffer sb,
                                       CategoryCtxMenu ctxMenu,
                                       Category cat)
        Description copied from interface: CtxMenuPolicyFilter
        Handle the current StringBuffer to append custom content for the given Category
        Specified by:
        handleCtxMenuItems in interface CtxMenuPolicyFilter
        Parameters:
        sb - the StringBuffer to update
        ctxMenu - the instance of the context menu created during initial request.
        cat - the working category
      • handleCtxMenuItems

        public void handleCtxMenuItems​(java.lang.StringBuffer sb,
                                       MemberCtxMenu ctxMenu,
                                       Member mbr)
        Description copied from interface: CtxMenuPolicyFilter
        Handle the current StringBuffer to append custom content for the given Member
        Specified by:
        handleCtxMenuItems in interface CtxMenuPolicyFilter
        Parameters:
        sb - the StringBuffer to update
        ctxMenu - the instance of the context menu created during initial request.
        mbr - the working member
      • handleCtxMenuItems

        public void handleCtxMenuItems​(java.lang.StringBuffer sb,
                                       WidgetCtxMenu ctxMenu,
                                       java.lang.String menuItems,
                                       java.lang.String chooserType,
                                       java.lang.String chooserId)
        Description copied from interface: CtxMenuPolicyFilter
        Handle the current StringBuffer to append custom content for the given Member
        Specified by:
        handleCtxMenuItems in interface CtxMenuPolicyFilter
        Parameters:
        sb - the StringBuffer to update
        ctxMenu - the instance of the context menu created during initial request.