com.cc.framework.ui.model
Interface MenuItem

All Superinterfaces:

AccessControlled, ClientHandler, DesignModel

All Known Implementing Classes:

MenuItemImp

public interface MenuItem

extends DesignModel, ClientHandler, AccessControlled

Menu item

Version:

$Revision: 1.1 $

Author:

Gernot Schulz

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	getImageRef() Returns the Role which specifies an Image in an ImageMap
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
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	setImageRef(java.lang.String ref) Assigns an Image from an image map to the MenuItem
void	setLocaleName(java.lang.String locale) Sets the Locale configuration for this element
void	setMenuFilter(java.lang.String filter) 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
int	size() Returns the Number of SubMenuItems

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

getHandler, getHandlers, setHandler

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

getPermission, show

Method Detail

getParent

public MenuItem getParent()

Returns a reference to the parent element

Returns:

MenuItemDesignModel

setParent

public void setParent(MenuItem parent)

Sets the reference to the parent element

Parameters:

parent - MenuItemDesignModel

setMenuId

public void setMenuId(java.lang.String menuid)

Sets the Menu Id

Parameters:

menuid - menu id

setAction

public void setAction(java.lang.String action)

Sets the Action

Parameters:

action - Action

setState

public void setState(int state)

Sets the Menu State

Parameters:

state - the state flags (MenuState)

setText

public void setText(java.lang.String text)

sets the Text

Parameters:

text - Text

setShortcut

public void setShortcut(java.lang.String shortcut)

Sets the Shortcut

Parameters:

shortcut - String

setWidth

public void setWidth(java.lang.String width)

Sets the Width

Parameters:

width - Width

setTarget

public void setTarget(java.lang.String target)

Sets the Target

Parameters:

target - Target

setMenuFilter

public void setMenuFilter(java.lang.String filter)

Sets the menu Filter

Parameters:

filter - Filter

setImageRef

public void setImageRef(java.lang.String ref)

Assigns an Image from an image map to the MenuItem

Parameters:

ref - ImageRef

getMenuId

public java.lang.String getMenuId()

Returns the Menu Id

Returns:

String

getAction

public java.lang.String getAction()

Returns the Action

Returns:

String

getState

public int getState()

Returns the Menu State flags (MenuState)

Returns:

menu state flags

getText

public java.lang.String getText()

Returns the Text

Returns:

String

getShortcut

public java.lang.String getShortcut()

Returns the Shortcut

Returns:

String

getWidth

public java.lang.String getWidth()

Returns the Width

Returns:

String

getTarget

public java.lang.String getTarget()

Returns the Target

Returns:

String

getMenuFilter

public java.lang.String getMenuFilter()

Returns the menu Filter

Returns:

String

setLocaleName

public void setLocaleName(java.lang.String locale)

Sets the Locale configuration for this element

Parameters:

locale - Locale Identifier or true|false

getLocaleName

public java.lang.String getLocaleName()

Gets the Local Setting for this element

Returns:

Locale Setting

getImageRef

public java.lang.String getImageRef()

Returns the Role which specifies an Image in an ImageMap

Returns:

String

addItem

public MenuItem addItem(MenuItem item)

Adds a SubMenuItem to the MenuItem

Parameters:

item - MenuItemDesignModel

Returns:

MenuItemDesignModel

removeItem

public MenuItem removeItem(MenuItem item)

Removes a SubMenuItem from the List

Parameters:

item - MenuItemDesignModel

Returns:

MenuItemDesignModel

getContent

public MenuItem[] getContent()

Returns a List with all SubMenuItems

Returns:

MenuItemDesignModel

size

public int size()

Returns the Number of SubMenuItems

Returns:

integer

setPermission

public void setPermission(Permission permission)

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

Parameters:

permission - Permission

setTooltip

public void setTooltip(java.lang.String tooltip)

Sets the static tooltip text.

Parameters:

tooltip - Tooltip text

getTooltip

public java.lang.String getTooltip()

Returns the static tooltip text

Returns:

String

setOrientation

public void setOrientation(OrientationType orientation)

Specifies the orientation of sub menu items:

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

Parameters:

orientation - The orientation of sub menu items

getOrientation

public OrientationType getOrientation()

Retrieves the orientation of sub menu items

Returns:

the orientation