com.jalios.jcms.policy
Interface CtxMenuPolicyFilter

All Superinterfaces:

Comparable, PluginComponent, PolicyFilter

All Known Implementing Classes:

BasicCtxMenuPolicyFilter, WikiPageCtxMenuPolicyFilter

public interface CtxMenuPolicyFilter
extends PolicyFilter

This class provides hooks for contextual menu rendering.

Since:

jcms-5.7.0

Version:

$Revision: 19014 $

Author:

Jean-Philippe Encausse

Field Summary

static String

REVISION

Method Summary

char[]	checkCtxMenuItems(CategoryCtxMenu ctxMenu, Category cat, char[] letters) Checks the processed contextual menu
char[]	checkCtxMenuItems(MemberCtxMenu ctxMenu, Member mbr, char[] letters) Checks the processed contextual menu
char[]	checkCtxMenuItems(PublicationCtxMenu ctxMenu, Publication pub, char[] letters) Checks the processed contextual menu
void	handleCtxMenuItems(StringBuffer sb, CategoryCtxMenu ctxMenu, Category cat) Handle the current StringBuffer to append custom content for the given Category
int	handleCtxMenuItems(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
void	handleCtxMenuItems(StringBuffer sb, MemberCtxMenu ctxMenu, Member mbr) Handle the current StringBuffer to append custom content for the given Member
int	handleCtxMenuItems(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
void	handleCtxMenuItems(StringBuffer sb, PublicationCtxMenu ctxMenu, Publication pub) Handle the current StringBuffer to append custom content for the given Publication
int	handleCtxMenuItems(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
void	initCtxMenu(CategoryCtxMenu ctxMenu, JcmsJspContext jcmsContext) Initialize the contextual menu.
void	initCtxMenu(MemberCtxMenu ctxMenu, JcmsJspContext jcmsContext) Initialize the contextual menu.
void	initCtxMenu(PublicationCtxMenu ctxMenu, JcmsJspContext jcmsContext) Initialize the contextual menu.

Methods inherited from interface java.lang.Comparable

compareTo

Methods inherited from interface com.jalios.jcms.plugin.PluginComponent

init

Field Detail

REVISION

static final String REVISION

See Also:

Constant Field Values

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(CategoryCtxMenu 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.

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 publication

letters - 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 category

letters - 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 member

letters - an array of letters describing menus to display

Returns:

char[] reorganized chars

handleCtxMenuItems

int handleCtxMenuItems(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 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

int handleCtxMenuItems(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 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

int handleCtxMenuItems(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 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

void handleCtxMenuItems(StringBuffer sb,
                        PublicationCtxMenu ctxMenu,
                        Publication pub)

Handle the current StringBuffer to append custom content for the given Publication

Parameters:

sb - the StringBuffer to update

ctxMenu - the instance of the context menu created during initial request.

pub - the working publication

handleCtxMenuItems

void handleCtxMenuItems(StringBuffer sb,
                        CategoryCtxMenu ctxMenu,
                        Category cat)

Handle the current StringBuffer to append custom content for the given Category

Parameters:

sb - the StringBuffer to update

ctxMenu - the instance of the context menu created during initial request.

cat - the working category

handleCtxMenuItems

void handleCtxMenuItems(StringBuffer sb,
                        MemberCtxMenu ctxMenu,
                        Member mbr)

Handle the current StringBuffer to append custom content for the given Member

Parameters:

sb - the StringBuffer to update

ctxMenu - the instance of the context menu created during initial request.

mbr - the working member