Package com.jalios.jcms.policy
Interface CtxMenuPolicyFilter
-
- All Superinterfaces:
java.lang.Comparable
,CtxMenuConstants
,PluginComponent
,PolicyFilter
- All Known Implementing Classes:
BasicCtxMenuPolicyFilter
public interface CtxMenuPolicyFilter extends PolicyFilter, CtxMenuConstants
This class provides hooks for contextual menu rendering.- Since:
- jcms-5.7.0
- Author:
- Jean-Philippe Encausse
-
-
Field Summary
-
Fields inherited from interface com.jalios.jcms.ajax.CtxMenuConstants
DISABLED, FLAG_CADDY, FLAG_DELETE, FLAG_EDIT, FLAG_EXPORT, FLAG_INSPECT, FLAG_SEPARATOR, INFO_ICON, MENU_DISABLED, MENU_ENABLED, MENU_SKIPPED, NO_ICON
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description char[]
checkCtxMenuItems(CategoryCtxMenu ctxMenu, Category cat, char[] letters)
Checks the processed contextual menuchar[]
checkCtxMenuItems(MemberCtxMenu ctxMenu, Member mbr, char[] letters)
Checks the processed contextual menuchar[]
checkCtxMenuItems(PublicationCtxMenu ctxMenu, Publication pub, char[] letters)
Checks the processed contextual menuchar[]
checkCtxMenuItems(WidgetCtxMenu ctxMenu, java.lang.String menuItems, java.lang.String chooserType, java.lang.String chooserId, char[] letters)
Checks the processed contextual menuvoid
handleCtxMenuItems(java.lang.StringBuffer sb, CategoryCtxMenu ctxMenu, Category cat)
Handle the current StringBuffer to append custom content for the given Categoryint
handleCtxMenuItems(java.lang.StringBuffer sb, CategoryCtxMenu ctxMenu, Category cat, char letter, int status)
Handle the current StringBuffer to append custom content for the given Category and given Lettervoid
handleCtxMenuItems(java.lang.StringBuffer sb, MemberCtxMenu ctxMenu, Member mbr)
Handle the current StringBuffer to append custom content for the given Memberint
handleCtxMenuItems(java.lang.StringBuffer sb, MemberCtxMenu ctxMenu, Member mbr, char letter, int status)
Handle the current StringBuffer to append custom content for the given Member and given Lettervoid
handleCtxMenuItems(java.lang.StringBuffer sb, PublicationCtxMenu ctxMenu, Publication pub)
Handle the current StringBuffer to append custom content for the given Publicationint
handleCtxMenuItems(java.lang.StringBuffer sb, PublicationCtxMenu ctxMenu, Publication pub, char letter, int status)
Handle the current StringBuffer to append custom content for the given Publication and given Lettervoid
handleCtxMenuItems(java.lang.StringBuffer sb, WidgetCtxMenu ctxMenu, java.lang.String menuItems, java.lang.String chooserType, java.lang.String chooserId)
Handle the current StringBuffer to append custom content for the given Memberint
handleCtxMenuItems(java.lang.StringBuffer sb, WidgetCtxMenu ctxMenu, java.lang.String menuItems, java.lang.String chooserType, java.lang.String chooserId, char letter, int status)
Handle the current StringBuffer to append custom content for the given Member and given Lettervoid
initCtxMenu(MemberCtxMenu ctxMenu, JcmsJspContext jcmsContext)
Initialize the contextual menu.
This method is called when the Context Menu object class is created.void
initCtxMenu(PublicationCtxMenu ctxMenu, JcmsJspContext jcmsContext)
Initialize the contextual menu.
This method is called when the Context Menu object class is created.void
initCtxMenu(WidgetCtxMenu ctxMenu, JcmsJspContext jcmsContext)
Initialize the contextual menu.
This method is called when the Context Menu object class is created.-
Methods inherited from interface com.jalios.jcms.plugin.PluginComponent
init
-
-
-
-
Method Detail
-
initCtxMenu
void initCtxMenu(PublicationCtxMenu ctxMenu, JcmsJspContext jcmsContext)
Initialize the contextual menu.
This method is called when the Context Menu object class is created.- 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
void initCtxMenu(MemberCtxMenu ctxMenu, JcmsJspContext jcmsContext)
Initialize the contextual menu.
This method is called when the Context Menu object class is created.- 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
void initCtxMenu(WidgetCtxMenu ctxMenu, JcmsJspContext jcmsContext)
Initialize the contextual menu.
This method is called when the Context Menu object class is created.- 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
char[] checkCtxMenuItems(PublicationCtxMenu ctxMenu, Publication pub, char[] letters)
Checks the processed contextual menu- Parameters:
ctxMenu
- the instance of the context menu created during initial request.pub
- the working publicationletters
- an array of letters describing menus to display- Returns:
- char[] reorganized chars
-
checkCtxMenuItems
char[] checkCtxMenuItems(CategoryCtxMenu ctxMenu, Category cat, char[] letters)
Checks the processed contextual menu- Parameters:
ctxMenu
- the instance of the context menu created during initial request.cat
- the working categoryletters
- an array of letters describing menus to display- Returns:
- char[] reorganized chars
-
checkCtxMenuItems
char[] checkCtxMenuItems(MemberCtxMenu ctxMenu, Member mbr, char[] letters)
Checks the processed contextual menu- Parameters:
ctxMenu
- the instance of the context menu created during initial request.mbr
- the working memberletters
- an array of letters describing menus to display- Returns:
- char[] reorganized chars
-
checkCtxMenuItems
char[] checkCtxMenuItems(WidgetCtxMenu ctxMenu, java.lang.String menuItems, java.lang.String chooserType, java.lang.String chooserId, char[] letters)
Checks the processed contextual menu- Parameters:
ctxMenu
- the instance of the context menu created during initial request.menuItems
-chooserType
-chooserId
-letters
- an array of letters describing menus to display- Returns:
- char[] reorganized chars
-
handleCtxMenuItems
int handleCtxMenuItems(java.lang.StringBuffer sb, PublicationCtxMenu ctxMenu, Publication pub, char letter, int status)
Handle the current StringBuffer to append custom content for the given Publication and given Letter- Parameters:
sb
- the StringBuffer to updatectxMenu
- the instance of the context menu created during initial request.pub
- the working publicationletter
- the current letterstatus
- preious plugin's status- Returns:
- int the status MENU_SKIPPED, MENU_ENABLED, MENU_DISABLED
-
handleCtxMenuItems
int handleCtxMenuItems(java.lang.StringBuffer sb, CategoryCtxMenu ctxMenu, Category cat, char letter, int status)
Handle the current StringBuffer to append custom content for the given Category and given Letter- Parameters:
sb
- the StringBuffer to updatectxMenu
- the instance of the context menu created during initial request.cat
- the working categoryletter
- the current letterstatus
- preious plugin's status- Returns:
- int the status MENU_SKIPPED, MENU_ENABLED, MENU_DISABLED
-
handleCtxMenuItems
int handleCtxMenuItems(java.lang.StringBuffer sb, MemberCtxMenu ctxMenu, Member mbr, char letter, int status)
Handle the current StringBuffer to append custom content for the given Member and given Letter- Parameters:
sb
- the StringBuffer to updatectxMenu
- the instance of the context menu created during initial request.mbr
- the working memberletter
- the current letterstatus
- preious plugin's status- Returns:
- int the status MENU_SKIPPED, MENU_ENABLED, MENU_DISABLED
-
handleCtxMenuItems
int handleCtxMenuItems(java.lang.StringBuffer sb, WidgetCtxMenu ctxMenu, java.lang.String menuItems, java.lang.String chooserType, java.lang.String chooserId, char letter, int status)
Handle the current StringBuffer to append custom content for the given Member and given Letter- Parameters:
sb
- the StringBuffer to updatectxMenu
- the instance of the context menu created during initial request.menuItems
-chooserType
-chooserId
-letter
- the current letterstatus
- preious plugin's status- Returns:
- int the status MENU_SKIPPED, MENU_ENABLED, MENU_DISABLED
-
handleCtxMenuItems
void handleCtxMenuItems(java.lang.StringBuffer sb, PublicationCtxMenu ctxMenu, Publication pub)
Handle the current StringBuffer to append custom content for the given Publication- Parameters:
sb
- the StringBuffer to updatectxMenu
- the instance of the context menu created during initial request.pub
- the working publication
-
handleCtxMenuItems
void handleCtxMenuItems(java.lang.StringBuffer sb, CategoryCtxMenu ctxMenu, Category cat)
Handle the current StringBuffer to append custom content for the given Category- Parameters:
sb
- the StringBuffer to updatectxMenu
- the instance of the context menu created during initial request.cat
- the working category
-
handleCtxMenuItems
void handleCtxMenuItems(java.lang.StringBuffer sb, MemberCtxMenu ctxMenu, Member mbr)
Handle the current StringBuffer to append custom content for the given Member- Parameters:
sb
- the StringBuffer to updatectxMenu
- the instance of the context menu created during initial request.mbr
- the working member
-
handleCtxMenuItems
void handleCtxMenuItems(java.lang.StringBuffer sb, WidgetCtxMenu ctxMenu, java.lang.String menuItems, java.lang.String chooserType, java.lang.String chooserId)
Handle the current StringBuffer to append custom content for the given Member- Parameters:
sb
- the StringBuffer to updatectxMenu
- the instance of the context menu created during initial request.menuItems
-chooserType
-chooserId
-
-
-