Package com.jalios.jcms.shortcut

Class BasicShortcutPolicyFilter

java.lang.Object

com.jalios.jcms.policy.AbstractPolicyFilter

com.jalios.jcms.shortcut.BasicShortcutPolicyFilter

All Implemented Interfaces:

PluginComponent, PolicyFilter, ShortcutPolicyFilter, java.lang.Comparable

Direct Known Subclasses:

WorkspaceApplicationShortcutPolicyFilter

public class BasicShortcutPolicyFilter
extends AbstractPolicyFilter
implements ShortcutPolicyFilter

Field Summary

Fields inherited from class com.jalios.jcms.policy.AbstractPolicyFilter

order

Constructor Summary

Constructors

Constructor	Description
BasicShortcutPolicyFilter()

Method Summary

Modifier and Type	Method	Description
ApplicationMenuBadge	getApplicationMenuBadge(Member mbr)	Returns an ApplicationMenuBadge which will be displayed on topbar application menu item
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
AbstractShortcut	getShortcut()	Used for filtering on ShortcutPolicyFilter.getApplicationMenuBadge(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	init(Plugin plugin)	Initialize the component with the given plugin configuration
boolean	showShortcut(AbstractShortcut shortcut, Member mbr)	Show or hide the AbstractShortcut in the application menu

Methods inherited from class com.jalios.jcms.policy.AbstractPolicyFilter

compareTo, equals, getOrder, setOrder

Methods inherited from class java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.lang.Comparable

compareTo

Constructor Detail

BasicShortcutPolicyFilter

public BasicShortcutPolicyFilter()

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.

getShortcutInfo

public ShortcutInfo getShortcutInfo(AbstractShortcut shortcut,
                                    Member loggedMember)

Description copied from interface: ShortcutPolicyFilter

Returns a ShortcutInfo which is used to synchronously query the shortcut badge for topbar application menu items (When the menu is opened)

Specified by:

getShortcutInfo in interface ShortcutPolicyFilter

Parameters:

shortcut - the AbstractShortcut

loggedMember - the Member

Returns:

a ShortcutInfo for current Shortcut and given Member

getShortcutInfoAsync

public java.lang.String getShortcutInfoAsync(AbstractShortcut shortcut)

Description copied from interface: ShortcutPolicyFilter

Returns an url which is used to asynchronously query the shortcut badge for topbar application menu items (When the menu is opened)

Specified by:

getShortcutInfoAsync in interface ShortcutPolicyFilter

Parameters:

shortcut - the AbstractShortcut

Returns:

an url

getApplicationMenuBadge

public ApplicationMenuBadge getApplicationMenuBadge(Member mbr)

Description copied from interface: ShortcutPolicyFilter

Returns an ApplicationMenuBadge which will be displayed on topbar application menu item

Specified by:

getApplicationMenuBadge in interface ShortcutPolicyFilter

Parameters:

mbr - the Member

Returns:

an ApplicationMenuBadge for given user

getShortcut

public AbstractShortcut getShortcut()

Description copied from interface: ShortcutPolicyFilter

Used for filtering on ShortcutPolicyFilter.getApplicationMenuBadge(Member)

Specified by:

getShortcut in interface ShortcutPolicyFilter

Returns:

the AbstractShortcut

getApplicationMenuBadge

public ApplicationMenuBadge getApplicationMenuBadge(Member mbr,
                                                    javax.servlet.http.HttpServletRequest request,
                                                    javax.servlet.http.HttpSession session)

Description copied from interface: ShortcutPolicyFilter

Returns an ApplicationMenuBadge which will be displayed on topbar application menu item

Specified by:

getApplicationMenuBadge in interface ShortcutPolicyFilter

Parameters:

mbr - the Member

request - the current HttpServletRequest

session - the current HttpSession

Returns:

an ApplicationMenuBadge for given user

showShortcut

public boolean showShortcut(AbstractShortcut shortcut,
                            Member mbr)

Description copied from interface: ShortcutPolicyFilter

Show or hide the AbstractShortcut in the application menu

Specified by:

showShortcut in interface ShortcutPolicyFilter

Parameters:

shortcut - AbstractShortcut

Returns:

true if the AbstractShortcut must be displayed in the application menu