org.apache.myfaces.custom.navmenu
Class NavigationMenuItem

java.lang.Object
  javax.faces.model.SelectItem
      org.apache.myfaces.custom.navmenu.NavigationMenuItem

All Implemented Interfaces:

Serializable

public class NavigationMenuItem
extends javax.faces.model.SelectItem

A node in a tree of menu items.

Version:

$Revision: 472638 $ $Date: 2006-11-08 15:54:13 -0500 (Wed, 08 Nov 2006) $

Author:

Thomas Spiegl (latest modification by $Author: grantsmith $)

See Also:

Serialized Form

Constructor Summary

NavigationMenuItem()

NavigationMenuItem(Object value, String label, String description, boolean disabled, boolean rendered, String action, String icon, boolean split)

NavigationMenuItem(Object value, String label, String description, boolean disabled, boolean rendered, String action, String icon, boolean split, String target)

NavigationMenuItem(Object value, String label, String description, boolean disabled, String action, String icon, boolean split)

NavigationMenuItem(String label, String action)

NavigationMenuItem(String label, String action, String icon, boolean split)

Method Summary

void	add(NavigationMenuItem navigationMenuItem) Add another node to the end of the list of child nodes of this menu item.
String	getAction()
String	getActionListener()
String	getActiveOnViewIds()
String	getDisabledStyle()
String	getDisabledStyleClass()
String	getExternalLink()
String	getIcon()
NavigationMenuItem[]	getNavigationMenuItems() Get the array of child nodes of this menu item.
String	getTarget()
boolean	isActive()
boolean	isOpen() Relevant only for types of menus which can leave a menu in an "expanded" state across requests.
boolean	isRendered()
boolean	isSplit()
void	setAction(String action)
void	setActionListener(String actionListener)
void	setActive(boolean active)
void	setActiveOnViewIds(String activeOnViewIds)
void	setDisabledStyle(String disabledStyle)
void	setDisabledStyleClass(String disabledStyleClass)
void	setExternalLink(String externalLink)
void	setIcon(String icon)
void	setNavigationMenuItems(List list) Set the child nodes of this menu item.
void	setNavigationMenuItems(NavigationMenuItem[] navigationMenuItems) Set the child nodes of this menu item.
void	setOpen(boolean open)
void	setSplit(boolean split)
void	setTarget(String target)

Methods inherited from class javax.faces.model.SelectItem

getDescription, getLabel, getValue, isDisabled, setDescription, setDisabled, setLabel, setValue

Methods inherited from class java.lang.Object

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

Constructor Detail

NavigationMenuItem

public NavigationMenuItem()

NavigationMenuItem

public NavigationMenuItem(String label,
                          String action)

NavigationMenuItem

public NavigationMenuItem(String label,
                          String action,
                          String icon,
                          boolean split)

NavigationMenuItem

public NavigationMenuItem(Object value,
                          String label,
                          String description,
                          boolean disabled,
                          String action,
                          String icon,
                          boolean split)

NavigationMenuItem

public NavigationMenuItem(Object value,
                          String label,
                          String description,
                          boolean disabled,
                          boolean rendered,
                          String action,
                          String icon,
                          boolean split)

NavigationMenuItem

public NavigationMenuItem(Object value,
                          String label,
                          String description,
                          boolean disabled,
                          boolean rendered,
                          String action,
                          String icon,
                          boolean split,
                          String target)

Method Detail

isRendered

public boolean isRendered()

getActiveOnViewIds

public String getActiveOnViewIds()

setActiveOnViewIds

public void setActiveOnViewIds(String activeOnViewIds)

getAction

public String getAction()

setAction

public void setAction(String action)

isSplit

public boolean isSplit()

setSplit

public void setSplit(boolean split)

getIcon

public String getIcon()

setIcon

public void setIcon(String icon)

isOpen

public boolean isOpen()

Relevant only for types of menus which can leave a menu in an "expanded" state across requests. Returns true if the menu is currently open (displaying its child items).

setOpen

public void setOpen(boolean open)

isActive

public boolean isActive()

setActive

public void setActive(boolean active)

getActionListener

public String getActionListener()

setActionListener

public void setActionListener(String actionListener)

getTarget

public String getTarget()

setTarget

public void setTarget(String target)

getDisabledStyle

public String getDisabledStyle()

setDisabledStyle

public void setDisabledStyle(String disabledStyle)

getDisabledStyleClass

public String getDisabledStyleClass()

setDisabledStyleClass

public void setDisabledStyleClass(String disabledStyleClass)

getExternalLink

public String getExternalLink()

setExternalLink

public void setExternalLink(String externalLink)

getNavigationMenuItems

public NavigationMenuItem[] getNavigationMenuItems()

Get the array of child nodes of this menu item. If this node has no children then an empty array is returned. The array is a copy of the internal data of this object, so changes to the array will not affect the state of this object. The members of the array are the actual children of this object, however (the copy is not a "deep clone").

setNavigationMenuItems

public void setNavigationMenuItems(NavigationMenuItem[] navigationMenuItems)

Set the child nodes of this menu item.

setNavigationMenuItems

public void setNavigationMenuItems(List list)

Set the child nodes of this menu item.

add

public void add(NavigationMenuItem navigationMenuItem)

Add another node to the end of the list of child nodes of this menu item.

Note that if setNavigationMenuItems(array) was called previously, then this method will throw an exception as the child list will be of fixed length.