public class PermissionMenuItemFactory extends AbstractJspActionFactory<MenuItemAction>
The permissions are checked for a given item type
(setItem(String)
). Permission levels can be
set for when the menu item should be:
prepareContext(InvokationContext)
method. Most
properties can have different values for the enabled/disabled state.
For example:
setTitle(String)
sets the title for both states
setDisabledTitle(String)
sets the title for the disabled state
setEnabledTitle(String)
sets the title for the enabled state
Modifier and Type | Field and Description |
---|---|
private java.lang.String |
disabledClazz |
private java.lang.String |
disabledIcon |
private java.lang.String |
disabledStyle |
private java.lang.String |
disabledTitle |
private java.lang.String |
disabledTooltip |
private java.lang.String |
enabledClazz |
private java.lang.String |
enabledIcon |
private Permission |
enabledPermission |
private java.lang.String |
enabledStyle |
private java.lang.String |
enabledTitle |
private java.lang.String |
enabledTooltip |
private java.lang.String |
id |
private Item |
itemToCheck |
private java.lang.String |
menuId |
private java.lang.String |
onClick
Deprecated.
|
private java.lang.String |
submenuId |
private MenuItemAction.MenuType |
type |
private Permission |
visiblePermission |
Constructor and Description |
---|
PermissionMenuItemFactory()
Create a new factory instance.
|
Modifier and Type | Method and Description |
---|---|
MenuItemAction[] |
getActions(InvokationContext<? super MenuItemAction> context)
This method may be called one or several times for each request.
|
private boolean |
hasPermission(SessionControl sc,
Permission permission) |
boolean |
prepareContext(InvokationContext<? super MenuItemAction> context)
If scripts and stylesheets has been added to the factory,
propagates those to the
JspContext . |
void |
setDisabledClazz(java.lang.String clazz)
Set the class to use when the menu is disabled.
|
void |
setDisabledIcon(java.lang.String icon)
Set the icon to use when the menu is disabled.
|
void |
setDisabledStyle(java.lang.String style)
Set the style to use when the menu is disabled.
|
void |
setDisabledTitle(java.lang.String title)
Set the title of the menu item when it is disabled.
|
void |
setDisabledTooltip(java.lang.String tooltip)
Set the tooltip of the menu item when it is disabled.
|
void |
setEnabledClazz(java.lang.String clazz)
Set the class to use when the menu is enabled.
|
void |
setEnabledIcon(java.lang.String icon)
Set the icon to use when the menu is enabled.
|
void |
setEnabledPermission(java.lang.String permission)
Set the minimum permission that is required to make the
menu item enabled.
|
void |
setEnabledStyle(java.lang.String style)
Set the style to use when the menu is enabled.
|
void |
setEnabledTitle(java.lang.String title)
Set the title of the menu item when it is enabled.
|
void |
setEnabledTooltip(java.lang.String tooltip)
Set the tooltip of the menu item when it is enabled.
|
void |
setIcon(java.lang.String icon)
Set the icon to use in all cases.
|
void |
setId(java.lang.String id) |
void |
setItem(java.lang.String item)
Set the item type to check the permission for.
|
void |
setMenuId(java.lang.String menuId) |
void |
setOnClick(java.lang.String onClick)
Deprecated.
|
void |
setStyle(java.lang.String style)
Set the style to use in all cases.
|
void |
setSubmenuId(java.lang.String submenuId) |
void |
setTitle(java.lang.String title)
Set the title of the menu item in all cases.
|
void |
setTooltip(java.lang.String tooltip)
Set the tooltip of the menu item in all cases.
|
void |
setType(MenuItemAction.MenuType type)
Set the type of the menu.
|
void |
setType(java.lang.String type)
Set the type of menu.
|
void |
setVisiblePermission(java.lang.String permission)
Set the minimum permission that is required to make the
menu item visible.
|
getDynamicActionAttributes, getParameter, getScripts, getStylesheets, prepareContext, setParameter, setScript, setStylesheet
private java.lang.String id
private java.lang.String enabledClazz
private java.lang.String disabledClazz
@Deprecated private java.lang.String onClick
private MenuItemAction.MenuType type
private java.lang.String menuId
private java.lang.String submenuId
private Permission visiblePermission
private Permission enabledPermission
private Item itemToCheck
private java.lang.String enabledIcon
private java.lang.String disabledIcon
private java.lang.String enabledStyle
private java.lang.String disabledStyle
private java.lang.String enabledTitle
private java.lang.String disabledTitle
private java.lang.String enabledTooltip
private java.lang.String disabledTooltip
public PermissionMenuItemFactory()
public MenuItemAction[] getActions(InvokationContext<? super MenuItemAction> context)
ActionFactory
context
- The current invokation contextpublic boolean prepareContext(InvokationContext<? super MenuItemAction> context)
AbstractJspActionFactory
JspContext
. A subclass that
overrides this method should call super.prepareContext()
if it hasn't decided to return FALSE already.prepareContext
in interface ActionFactory<MenuItemAction>
prepareContext
in class AbstractJspActionFactory<MenuItemAction>
context
- The current invokation contextpublic void setEnabledPermission(java.lang.String permission)
permission
- One of Permission
constantspublic void setVisiblePermission(java.lang.String permission)
permission
- One of Permission
constantspublic void setItem(java.lang.String item)
item
- One of Item
constants@VariableSetter @PathSetter public void setEnabledIcon(java.lang.String icon)
@VariableSetter @PathSetter public void setDisabledIcon(java.lang.String icon)
@VariableSetter @PathSetter public void setIcon(java.lang.String icon)
public void setMenuId(java.lang.String menuId)
@VariableSetter @Deprecated public void setOnClick(java.lang.String onClick)
public void setId(java.lang.String id)
public void setDisabledClazz(java.lang.String clazz)
public void setEnabledClazz(java.lang.String clazz)
public void setEnabledStyle(java.lang.String style)
public void setDisabledStyle(java.lang.String style)
public void setStyle(java.lang.String style)
public void setSubmenuId(java.lang.String submenuId)
public void setEnabledTitle(java.lang.String title)
public void setDisabledTitle(java.lang.String title)
public void setTitle(java.lang.String title)
public void setEnabledTooltip(java.lang.String tooltip)
public void setDisabledTooltip(java.lang.String tooltip)
public void setTooltip(java.lang.String tooltip)
public void setType(MenuItemAction.MenuType type)
public void setType(java.lang.String type)
private boolean hasPermission(SessionControl sc, Permission permission)