to.etc.domui.component.menu
Class MenuItemImpl

java.lang.Object
  extended by to.etc.domui.component.menu.MenuItemImpl
All Implemented Interfaces:
IMenuItem

public class MenuItemImpl
extends java.lang.Object
implements IMenuItem

A single item in the menu, as defined by the *code*.

Author:
Frits Jalvingh Created on Apr 3, 2009

Constructor Summary
MenuItemImpl(MenuManager m)
           
 
Method Summary
 java.util.List<IMenuItem> getChildren()
           
 java.lang.String getDescKey()
           
 java.lang.String getDescription()
           
 java.lang.String getIconPath()
           
 java.lang.String getId()
           
 java.lang.String getLabel()
           
 java.lang.String getLabelKey()
           
 BundleRef getMsgBundle()
           
 int getOrder()
           
 java.lang.Class<? extends UrlPage> getPageClass()
           
 PageParameters getPageParameters()
           
 MenuItemImpl getParent()
           
 java.lang.String getParentID()
           
 java.lang.String[] getRequiredRights()
           
 java.lang.String getRURL()
           
 java.lang.String getSearchKey()
           
 java.lang.String getSearchString()
           
 java.lang.String getTarget()
           
 java.lang.String getTitleKey()
           
 boolean isDisabled()
           
 boolean isSubMenu()
           
 void setChildren(java.util.List<IMenuItem> children)
           
 void setDescKey(java.lang.String descKey)
           
 void setDisabled(boolean disabled)
           
 void setIconPath(java.lang.String iconPath)
           
 void setId(java.lang.String id)
           
 MenuItemImpl setImage(java.lang.Class<?> res, java.lang.String name)
           
 MenuItemImpl setImage(java.lang.String name)
           
 void setLabelKey(java.lang.String labelKey)
           
 MenuItemImpl setLocation(MenuItemImpl parent, int order)
           
 void setMsgBundle(BundleRef msgBundle)
           
 void setOrder(int order)
           
 MenuItemImpl setPageClass(java.lang.Class<? extends UrlPage> pageClass)
           
 MenuItemImpl setPageParameters(PageParameters pageParameters)
           
 void setParentID(java.lang.String parentID)
           
 MenuItemImpl setRequiredRights(java.lang.String... rights)
          Defines the rights that the user MUST have to see this menu item.
 MenuItemImpl setRURL(java.lang.String rurl)
           
 void setSearchKey(java.lang.String searchKey)
           
 void setSubMenu(boolean subMenu)
           
 MenuItemImpl setTarget(java.lang.String target)
           
 void setTitleKey(java.lang.String titleKey)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

MenuItemImpl

public MenuItemImpl(MenuManager m)
Method Detail

setRequiredRights

public MenuItemImpl setRequiredRights(java.lang.String... rights)
Defines the rights that the user MUST have to see this menu item. If more than one Right is passed the user needs to possess *all* rights. When defined this overrides the rights in

Parameters:
name -
Returns:

setImage

public MenuItemImpl setImage(java.lang.String name)

setImage

public MenuItemImpl setImage(java.lang.Class<?> res,
                             java.lang.String name)

setLocation

public MenuItemImpl setLocation(MenuItemImpl parent,
                                int order)

getId

public java.lang.String getId()
Specified by:
getId in interface IMenuItem
See Also:
IMenuItem.getId()

setId

public void setId(java.lang.String id)

getMsgBundle

public BundleRef getMsgBundle()

setMsgBundle

public void setMsgBundle(BundleRef msgBundle)

getLabelKey

public java.lang.String getLabelKey()

setLabelKey

public void setLabelKey(java.lang.String labelKey)

getDescKey

public java.lang.String getDescKey()

setDescKey

public void setDescKey(java.lang.String descKey)

getSearchKey

public java.lang.String getSearchKey()

setSearchKey

public void setSearchKey(java.lang.String searchKey)

getParentID

public java.lang.String getParentID()
Specified by:
getParentID in interface IMenuItem
See Also:
IMenuItem.getParentID()

setParentID

public void setParentID(java.lang.String parentID)

getPageClass

public java.lang.Class<? extends UrlPage> getPageClass()
Specified by:
getPageClass in interface IMenuItem
See Also:
IMenuItem.getPageClass()

setPageClass

public MenuItemImpl setPageClass(java.lang.Class<? extends UrlPage> pageClass)

getPageParameters

public PageParameters getPageParameters()
Specified by:
getPageParameters in interface IMenuItem
See Also:
IMenuItem.getPageParameters()

setPageParameters

public MenuItemImpl setPageParameters(PageParameters pageParameters)

getIconPath

public java.lang.String getIconPath()
Specified by:
getIconPath in interface IMenuItem
See Also:
IMenuItem.getIconPath()

setIconPath

public void setIconPath(java.lang.String iconPath)

isDisabled

public boolean isDisabled()
Specified by:
isDisabled in interface IMenuItem
See Also:
IMenuItem.isDisabled()

setDisabled

public void setDisabled(boolean disabled)

getChildren

public java.util.List<IMenuItem> getChildren()
Specified by:
getChildren in interface IMenuItem
See Also:
IMenuItem.getChildren()

setChildren

public void setChildren(java.util.List<IMenuItem> children)

getSearchString

public java.lang.String getSearchString()
Specified by:
getSearchString in interface IMenuItem
See Also:
IMenuItem.getSearchString()

getRequiredRights

public java.lang.String[] getRequiredRights()
Specified by:
getRequiredRights in interface IMenuItem
See Also:
IMenuItem.getRequiredRights()

getLabel

public java.lang.String getLabel()
Specified by:
getLabel in interface IMenuItem
See Also:
IMenuItem.getLabel()

getDescription

public java.lang.String getDescription()
Specified by:
getDescription in interface IMenuItem
See Also:
IMenuItem.getDescription()

isSubMenu

public boolean isSubMenu()
Specified by:
isSubMenu in interface IMenuItem

setSubMenu

public void setSubMenu(boolean subMenu)

getOrder

public int getOrder()
Specified by:
getOrder in interface IMenuItem

setOrder

public void setOrder(int order)

getTitleKey

public java.lang.String getTitleKey()

setTitleKey

public void setTitleKey(java.lang.String titleKey)

getParent

public MenuItemImpl getParent()

getTarget

public java.lang.String getTarget()
Specified by:
getTarget in interface IMenuItem

setTarget

public MenuItemImpl setTarget(java.lang.String target)

getRURL

public java.lang.String getRURL()
Specified by:
getRURL in interface IMenuItem

setRURL

public MenuItemImpl setRURL(java.lang.String rurl)