Package com.jalios.jcms.shortcut
Interface ShortcutPolicyFilter
-
- All Superinterfaces:
java.lang.Comparable
,PluginComponent
,PolicyFilter
- All Known Implementing Classes:
BasicShortcutPolicyFilter
,WorkspaceApplicationShortcutPolicyFilter
public interface ShortcutPolicyFilter extends PolicyFilter
This interface provides hooks for shortcut badge.- Since:
- jcms-10.0.0
- Author:
- kevin.bransard@jalios.com
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
REVISION
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description ApplicationMenuBadge
getApplicationMenuBadge(Member mbr)
Returns an ApplicationMenuBadge which will be displayed on topbar application menu itemApplicationMenuBadge
getApplicationMenuBadge(Member mbr, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpSession session)
Returns an ApplicationMenuBadge which will be displayed on topbar application menu itemAbstractShortcut
getShortcut()
Used for filtering ongetApplicationMenuBadge(Member)
ShortcutInfo
getShortcutInfo(AbstractShortcut shortcut, Member loggedMember)
Returns a ShortcutInfo which is used to synchronously query the shortcut badge for topbar application menu items (When the menu is opened)java.lang.String
getShortcutInfoAsync(AbstractShortcut shortcut)
Returns an url which is used to asynchronously query the shortcut badge for topbar application menu items (When the menu is opened)boolean
showShortcut(AbstractShortcut shortcut, Member mbr)
Show or hide theAbstractShortcut
in the application menu-
Methods inherited from interface com.jalios.jcms.plugin.PluginComponent
init
-
-
-
-
Field Detail
-
REVISION
static final java.lang.String REVISION
- See Also:
- Constant Field Values
-
-
Method Detail
-
getShortcutInfo
ShortcutInfo getShortcutInfo(AbstractShortcut shortcut, Member loggedMember)
Returns a ShortcutInfo which is used to synchronously query the shortcut badge for topbar application menu items (When the menu is opened)- Parameters:
shortcut
- theAbstractShortcut
loggedMember
- theMember
- Returns:
- a
ShortcutInfo
for current Shortcut and givenMember
-
getShortcutInfoAsync
java.lang.String getShortcutInfoAsync(AbstractShortcut shortcut)
Returns an url which is used to asynchronously query the shortcut badge for topbar application menu items (When the menu is opened)- Parameters:
shortcut
- theAbstractShortcut
- Returns:
- an url
-
getApplicationMenuBadge
ApplicationMenuBadge getApplicationMenuBadge(Member mbr)
Returns an ApplicationMenuBadge which will be displayed on topbar application menu item- Parameters:
mbr
- theMember
- Returns:
- an
ApplicationMenuBadge
for given user
-
getApplicationMenuBadge
ApplicationMenuBadge getApplicationMenuBadge(Member mbr, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpSession session)
Returns an ApplicationMenuBadge which will be displayed on topbar application menu item- Parameters:
mbr
- theMember
request
- the currentHttpServletRequest
session
- the currentHttpSession
- Returns:
- an
ApplicationMenuBadge
for given user
-
getShortcut
AbstractShortcut getShortcut()
Used for filtering ongetApplicationMenuBadge(Member)
- Returns:
- the
AbstractShortcut
-
showShortcut
boolean showShortcut(AbstractShortcut shortcut, Member mbr)
Show or hide theAbstractShortcut
in the application menu- Parameters:
shortcut
-AbstractShortcut
mbr
-- Returns:
- true if the
AbstractShortcut
must be displayed in the application menu
-
-