com.cc.framework.ui.model.imp
Class MenuItemImp

java.lang.Object
  com.cc.framework.ui.model.imp.ClientHandlerImp
      com.cc.framework.ui.model.imp.MenuItemImp

All Implemented Interfaces:

AccessControlled, ClientHandler, DesignModel, MenuItem, java.io.Serializable

public class MenuItemImp

extends ClientHandlerImp

implements MenuItem

Designmodel for a menu item

Since:

1.0

Version:

$Revision: 1.1 $

Author:

Harald Schulz

See Also:

Serialized Form

Field Summary

private java.lang.String	action The action to process if the user clicks the item
private java.lang.String	id The unique Id of the menu item
private java.lang.String	imageRef Reference for an image in an ImageMap
private java.util.ArrayList	items A buffer for sub menu items
private java.lang.String	localeName Locale Setting
private java.lang.String	menuFilter A filter expression used to hide or show the menu item in different contexts
private java.lang.String	menuid The Menu item id
private OrientationType	orientation Specifies the orientation of sub menu items horizontal = from top to bottom vertical = from left to right
private MenuItem	parent Parent Menu item
private Permission	permission The permission for this menu item
private static long	serialVersionUID Serial Version UID
private java.lang.String	shortcut A shortcut
private int	state The state flags of the menu item
private java.lang.String	target The window target in which the resource requested by this hyperlink will be displayed, for example "blank, self, parent, ..."
private java.lang.String	text The display text
private java.lang.String	tooltip A tool tip
private java.lang.String	width The width of the menu item

Fields inherited from class com.cc.framework.ui.model.imp.ClientHandlerImp

Constructor Summary

MenuItemImp()
Constructor

Method Summary

MenuItem	addItem(MenuItem item) Adds a SubMenuItem to the MenuItem
java.lang.String	getAction() Returns the Action
MenuItem[]	getContent() Returns a List with all SubMenuItems
java.lang.String	getId()
java.lang.String	getImageRef() Returns the imageRef.
java.lang.String	getLocaleName() Gets the Local Setting for this element
java.lang.String	getMenuFilter() Returns the menu filter.
java.lang.String	getMenuId() Returns the Menu Id
OrientationType	getOrientation() Retrieves the orientation of sub menu items
MenuItem	getParent() Returns a reference to the parent element
Permission	getPermission() Returns the authorizations required to access an object If the method returns null no access rights is required.
java.lang.String	getShortcut() Returns the Shortcut
int	getState() Returns the Menu State flags (MenuState)
java.lang.String	getTarget() Returns the Target
java.lang.String	getText() Returns the Text
java.lang.String	getTooltip() Returns the static tooltip text
java.lang.String	getWidth() Returns the Width
MenuItem	removeItem(MenuItem item) Removes a SubMenuItem from the List
void	setAction(java.lang.String action) Sets the Action
void	setId(java.lang.String id)
void	setImageRef(java.lang.String imageRef) Sets the imageRef.
void	setLocaleName(java.lang.String locale) Sets the Locale configuration for this element
void	setMenuFilter(java.lang.String menuFilter) Sets the menu filter.
void	setMenuId(java.lang.String menuid) Sets the Menu Id
void	setOrientation(OrientationType orientation) Specifies the orientation of sub menu items: horizontal = from top to bottom vertical = from left to right
void	setParent(MenuItem parent) Sets the reference to the parent element
void	setPermission(Permission permission) Sets a list with permissions needed to access this object.
void	setShortcut(java.lang.String shortcut) Sets the Shortcut
void	setState(int state) Sets the Menu State
void	setTarget(java.lang.String target) Sets the Target
void	setText(java.lang.String text) sets the Text
void	setTooltip(java.lang.String tooltip) Sets the static tooltip text.
void	setWidth(java.lang.String width) Sets the Width
boolean	show(Principal principal) Checks if the Object has a required permission.
int	size() Returns the Number of SubMenuItems

Methods inherited from class com.cc.framework.ui.model.imp.ClientHandlerImp

evaluate, getHandler, getHandlers, setHandler

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.cc.framework.ui.model.ClientHandler

getHandler, getHandlers, setHandler

Field Detail

serialVersionUID

private static final long serialVersionUID

Serial Version UID

See Also:

Constant Field Values

menuid

private java.lang.String menuid

The Menu item id

parent

private MenuItem parent

Parent Menu item

items

private java.util.ArrayList items

A buffer for sub menu items

state

private int state

The state flags of the menu item

text

private java.lang.String text

The display text

tooltip

private java.lang.String tooltip

A tool tip

shortcut

private java.lang.String shortcut

A shortcut

target

private java.lang.String target

The window target in which the resource requested by this hyperlink will be displayed, for example "blank, self, parent, ..."

menuFilter

private java.lang.String menuFilter

A filter expression used to hide or show the menu item in different contexts

localeName

private java.lang.String localeName

Locale Setting

imageRef

private java.lang.String imageRef

Reference for an image in an ImageMap

action

private java.lang.String action

The action to process if the user clicks the item

id

private java.lang.String id

The unique Id of the menu item

width

private java.lang.String width

The width of the menu item

orientation

private OrientationType orientation

Specifies the orientation of sub menu items

• horizontal = from top to bottom
• vertical = from left to right

permission

private Permission permission

The permission for this menu item

Constructor Detail

MenuItemImp

public MenuItemImp()

Constructor

Method Detail

setState

public void setState(int state)

Description copied from interface: MenuItem

Sets the Menu State

Specified by:

setState in interface MenuItem

Parameters:

state - the state flags (MenuState)

See Also:

MenuItem.setState(int)

setText

public void setText(java.lang.String text)

Description copied from interface: MenuItem

sets the Text

Specified by:

setText in interface MenuItem

Parameters:

text - Text

See Also:

MenuItem.setText(String)

setShortcut

public void setShortcut(java.lang.String shortcut)

Description copied from interface: MenuItem

Sets the Shortcut

Specified by:

setShortcut in interface MenuItem

Parameters:

shortcut - String

See Also:

MenuItem.setShortcut(String)

setId

public final void setId(java.lang.String id)

Parameters:

id - The unique Id of the menu item

setWidth

public final void setWidth(java.lang.String width)

Description copied from interface: MenuItem

Sets the Width

Specified by:

setWidth in interface MenuItem

Parameters:

width - Width

See Also:

MenuItem.setWidth(java.lang.String)

setAction

public final void setAction(java.lang.String action)

Description copied from interface: MenuItem

Sets the Action

Specified by:

setAction in interface MenuItem

Parameters:

action - Action

See Also:

MenuItem.setAction(java.lang.String)

getId

public final java.lang.String getId()

Returns:

returns the id

getAction

public java.lang.String getAction()

Description copied from interface: MenuItem

Returns the Action

Specified by:

getAction in interface MenuItem

Returns:

String

See Also:

MenuItem.getAction()

getWidth

public final java.lang.String getWidth()

Description copied from interface: MenuItem

Returns the Width

Specified by:

getWidth in interface MenuItem

Returns:

String

See Also:

MenuItem.getWidth()

getState

public int getState()

Description copied from interface: MenuItem

Returns the Menu State flags (MenuState)

Specified by:

getState in interface MenuItem

Returns:

menu state flags

See Also:

MenuItem.getState()

getText

public java.lang.String getText()

Description copied from interface: MenuItem

Returns the Text

Specified by:

getText in interface MenuItem

Returns:

String

See Also:

MenuItem.getText()

getShortcut

public java.lang.String getShortcut()

Description copied from interface: MenuItem

Returns the Shortcut

Specified by:

getShortcut in interface MenuItem

Returns:

String

See Also:

MenuItem.getShortcut()

getParent

public MenuItem getParent()

Description copied from interface: MenuItem

Returns a reference to the parent element

Specified by:

getParent in interface MenuItem

Returns:

MenuItemDesignModel

See Also:

MenuItem.getParent()

setParent

public void setParent(MenuItem parent)

Description copied from interface: MenuItem

Sets the reference to the parent element

Specified by:

setParent in interface MenuItem

Parameters:

parent - MenuItemDesignModel

See Also:

MenuItem.setParent(com.cc.framework.ui.model.MenuItem)

addItem

public MenuItem addItem(MenuItem item)

Description copied from interface: MenuItem

Adds a SubMenuItem to the MenuItem

Specified by:

addItem in interface MenuItem

Parameters:

item - MenuItemDesignModel

Returns:

MenuItemDesignModel

See Also:

MenuItem.addItem(MenuItem)

removeItem

public MenuItem removeItem(MenuItem item)

Description copied from interface: MenuItem

Removes a SubMenuItem from the List

Specified by:

removeItem in interface MenuItem

Parameters:

item - MenuItemDesignModel

Returns:

MenuItemDesignModel

See Also:

MenuItem.removeItem(MenuItem)

getContent

public MenuItem[] getContent()

Description copied from interface: MenuItem

Returns a List with all SubMenuItems

Specified by:

getContent in interface MenuItem

Returns:

MenuItemDesignModel

See Also:

MenuItem.getContent()

size

public int size()

Description copied from interface: MenuItem

Returns the Number of SubMenuItems

Specified by:

size in interface MenuItem

Returns:

integer

See Also:

MenuItem.size()

setTarget

public void setTarget(java.lang.String target)

Description copied from interface: MenuItem

Sets the Target

Specified by:

setTarget in interface MenuItem

Parameters:

target - Target

See Also:

MenuItem.setTarget(String)

getTarget

public java.lang.String getTarget()

Description copied from interface: MenuItem

Returns the Target

Specified by:

getTarget in interface MenuItem

Returns:

String

See Also:

MenuItem.getTarget()

getMenuFilter

public java.lang.String getMenuFilter()

Returns the menu filter.

Specified by:

getMenuFilter in interface MenuItem

Returns:

String

setMenuFilter

public void setMenuFilter(java.lang.String menuFilter)

Sets the menu filter.

Specified by:

setMenuFilter in interface MenuItem

Parameters:

menuFilter - The filter to set

getImageRef

public java.lang.String getImageRef()

Returns the imageRef.

Specified by:

getImageRef in interface MenuItem

Returns:

String

setImageRef

public void setImageRef(java.lang.String imageRef)

Sets the imageRef.

Specified by:

setImageRef in interface MenuItem

Parameters:

imageRef - The imageRef to set

getPermission

public Permission getPermission()

Description copied from interface: AccessControlled

Returns the authorizations required to access an object If the method returns null no access rights is required.

Specified by:

getPermission in interface AccessControlled

Returns:

Permission A list with required permissions separated by ";"

See Also:

AccessControlled.getPermission()

setPermission

public void setPermission(Permission permission)

Description copied from interface: MenuItem

Sets a list with permissions needed to access this object. The list is separated by ';'

Specified by:

setPermission in interface MenuItem

Parameters:

permission - Permission

See Also:

MenuItem.setPermission(com.cc.framework.security.Permission)

show

public boolean show(Principal principal)

Description copied from interface: AccessControlled

Checks if the Object has a required permission.

Specified by:

show in interface AccessControlled

Parameters:

principal - the users principal object

Returns:

true if the permission exists

See Also:

AccessControlled.show(Principal)

getMenuId

public java.lang.String getMenuId()

Description copied from interface: MenuItem

Returns the Menu Id

Specified by:

getMenuId in interface MenuItem

Returns:

String

See Also:

MenuItem.getMenuId()

setMenuId

public void setMenuId(java.lang.String menuid)

Description copied from interface: MenuItem

Sets the Menu Id

Specified by:

setMenuId in interface MenuItem

Parameters:

menuid - menu id

See Also:

MenuItem.setMenuId(java.lang.String)

getTooltip

public java.lang.String getTooltip()

Description copied from interface: MenuItem

Returns the static tooltip text

Specified by:

getTooltip in interface MenuItem

Returns:

String

See Also:

MenuItem.getTooltip()

setTooltip

public void setTooltip(java.lang.String tooltip)

Description copied from interface: MenuItem

Sets the static tooltip text.

Specified by:

setTooltip in interface MenuItem

Parameters:

tooltip - Tooltip text

See Also:

MenuItem.setTooltip(java.lang.String)

getLocaleName

public java.lang.String getLocaleName()

Description copied from interface: MenuItem

Gets the Local Setting for this element

Specified by:

getLocaleName in interface MenuItem

Returns:

Locale Setting

See Also:

MenuItem.getLocaleName()

setLocaleName

public void setLocaleName(java.lang.String locale)

Description copied from interface: MenuItem

Sets the Locale configuration for this element

Specified by:

setLocaleName in interface MenuItem

Parameters:

locale - Locale Identifier or true|false

See Also:

MenuItem.setLocaleName(java.lang.String)

setOrientation

public void setOrientation(OrientationType orientation)

Description copied from interface: MenuItem

Specifies the orientation of sub menu items:

• horizontal = from top to bottom
• vertical = from left to right

Specified by:

setOrientation in interface MenuItem

Parameters:

orientation - The orientation of sub menu items

See Also:

MenuItem.setOrientation(com.cc.framework.ui.OrientationType)

getOrientation

public OrientationType getOrientation()

Description copied from interface: MenuItem

Retrieves the orientation of sub menu items

Specified by:

getOrientation in interface MenuItem

Returns:

the orientation

See Also:

MenuItem.getOrientation()