org.apache.jetspeed.portalsite
Interface Menu

All Superinterfaces:
MenuElement

public interface Menu
extends MenuElement

This interface describes the portal-site menu elements constructed and returned to decorators.

Version:
$Id: Menu.java 516448 2007-03-09 16:25:47Z ate $
Author:
Randy Watler

Field Summary
 
Fields inherited from interface org.apache.jetspeed.portalsite.MenuElement
MENU_ELEMENT_TYPE, OPTION_ELEMENT_TYPE, SEPARATOR_ELEMENT_TYPE
 
Method Summary
 List getElements()
          getElements - get ordered list of menu elements that are members of this menu; possibly contains options, nested menus, or separators
 String getName()
          getName - get name of menu
 MenuElement getSelectedElement(PortalSiteRequestContext context)
          getSelectedElement - return selected option or nested menu within this menu selected by the specified request context
 String getUrl()
          getUrl - get url of top level folder that defined menu options; only available for menus defined without multiple options, nested menus, or separators
 boolean isEmpty()
          isEmpty - get empty state of list of menu elements
 boolean isHidden()
          isHidden - get hidden state of folder that defined menu options; only available for menus defined without multiple options, nested menus, or separators
 boolean isSelected(PortalSiteRequestContext context)
          isSelected - return true if an option or nested menu within this menu are selected by the specified request context
 
Methods inherited from interface org.apache.jetspeed.portalsite.MenuElement
getElementType, getMetadata, getParentMenu, getShortTitle, getShortTitle, getSkin, getTitle, getTitle
 

Method Detail

getName

String getName()
getName - get name of menu

Returns:
menu name

getUrl

String getUrl()
getUrl - get url of top level folder that defined menu options; only available for menus defined without multiple options, nested menus, or separators

Returns:
folder url

isHidden

boolean isHidden()
isHidden - get hidden state of folder that defined menu options; only available for menus defined without multiple options, nested menus, or separators

Returns:
hidden state

isSelected

boolean isSelected(PortalSiteRequestContext context)
isSelected - return true if an option or nested menu within this menu are selected by the specified request context

Parameters:
context - request context
Returns:
selected state

getElements

List getElements()
getElements - get ordered list of menu elements that are members of this menu; possibly contains options, nested menus, or separators

Returns:
menu elements list

isEmpty

boolean isEmpty()
isEmpty - get empty state of list of menu elements

Returns:
menu elements list empty state

getSelectedElement

MenuElement getSelectedElement(PortalSiteRequestContext context)
getSelectedElement - return selected option or nested menu within this menu selected by the specified request context

Returns:
selected menu element


Copyright © 1999-2007 Apache Software Foundation. All Rights Reserved.