org.apache.jetspeed.portalsite.impl
Class MenuImpl

java.lang.Object
  extended by org.apache.jetspeed.portalsite.impl.MenuElementImpl
      extended by org.apache.jetspeed.portalsite.impl.MenuImpl
All Implemented Interfaces:
java.lang.Cloneable, Menu, MenuElement

public class MenuImpl
extends MenuElementImpl
implements Menu, java.lang.Cloneable

This class implements the portal-site menu elements constructed and returned to decorators.

Version:
$Id: MenuImpl.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
 
Constructor Summary
MenuImpl(MenuDefinition definition, PortalSiteRequestContextImpl context, java.util.Set menus)
          MenuImpl - request/session context dependent constructor
MenuImpl(MenuImpl parent, MenuDefinition definition, PortalSiteRequestContextImpl context, java.util.Set menus)
          MenuImpl - request/session context dependent constructor
 
Method Summary
 java.lang.Object clone()
          clone - clone this instance
 java.util.List getElements()
          getElements - get ordered list of menu elements that are members of this menu; possibly contains options, nested menus, or separators
 java.lang.String getElementType()
          getElementType - get type of menu element
 GenericMetadata getMetadata()
          getMetadata - get generic metadata for menu element
 java.lang.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
 java.lang.String getShortTitle()
          getShortTitle - get default short title for menu element
 java.lang.String getShortTitle(java.util.Locale locale)
          getShortTitle - get locale specific short title for menu element from metadata
 java.lang.String getSkin()
          getSkin - get skin name for menu element
 java.lang.String getTitle()
          getTitle - get default title for menu element
 java.lang.String getTitle(java.util.Locale locale)
          getTitle - get locale specific title for menu element from metadata
 java.lang.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 isElementRelative()
          isElementRelative - get flag that indicates whether any relative paths dependent on the current page in context were referenced while constructing menu elements
 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 class org.apache.jetspeed.portalsite.impl.MenuElementImpl
equals, getNode, getParentMenu, setNode, setParentMenu
 
Methods inherited from class java.lang.Object
finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface org.apache.jetspeed.portalsite.MenuElement
getParentMenu
 

Constructor Detail

MenuImpl

public MenuImpl(MenuImpl parent,
                MenuDefinition definition,
                PortalSiteRequestContextImpl context,
                java.util.Set menus)
MenuImpl - request/session context dependent constructor

Parameters:
parent - containing menu implementation
definition - menu definition
context - request context
menus - related menu definition names set

MenuImpl

public MenuImpl(MenuDefinition definition,
                PortalSiteRequestContextImpl context,
                java.util.Set menus)
MenuImpl - request/session context dependent constructor

Parameters:
definition - menu definition
context - request context
menus - related menu definition names set
Method Detail

clone

public java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException
clone - clone this instance

Overrides:
clone in class MenuElementImpl
Returns:
unparented deep copy
Throws:
java.lang.CloneNotSupportedException

getElementType

public java.lang.String getElementType()
getElementType - get type of menu element

Specified by:
getElementType in interface MenuElement
Specified by:
getElementType in class MenuElementImpl
Returns:
MENU_ELEMENT_TYPE

getName

public java.lang.String getName()
getName - get name of menu

Specified by:
getName in interface Menu
Overrides:
getName in class MenuElementImpl
Returns:
menu name

getTitle

public java.lang.String getTitle()
getTitle - get default title for menu element

Specified by:
getTitle in interface MenuElement
Overrides:
getTitle in class MenuElementImpl
Returns:
title text

getShortTitle

public java.lang.String getShortTitle()
getShortTitle - get default short title for menu element

Specified by:
getShortTitle in interface MenuElement
Overrides:
getShortTitle in class MenuElementImpl
Returns:
short title text

getTitle

public java.lang.String getTitle(java.util.Locale locale)
getTitle - get locale specific title for menu element from metadata

Specified by:
getTitle in interface MenuElement
Overrides:
getTitle in class MenuElementImpl
Parameters:
locale - preferred locale
Returns:
title text

getShortTitle

public java.lang.String getShortTitle(java.util.Locale locale)
getShortTitle - get locale specific short title for menu element from metadata

Specified by:
getShortTitle in interface MenuElement
Overrides:
getShortTitle in class MenuElementImpl
Parameters:
locale - preferred locale
Returns:
short title text

getMetadata

public GenericMetadata getMetadata()
getMetadata - get generic metadata for menu element

Specified by:
getMetadata in interface MenuElement
Overrides:
getMetadata in class MenuElementImpl
Returns:
metadata

getSkin

public java.lang.String getSkin()
getSkin - get skin name for menu element

Specified by:
getSkin in interface MenuElement
Overrides:
getSkin in class MenuElementImpl
Returns:
skin name

getUrl

public java.lang.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

Specified by:
getUrl in interface Menu
Overrides:
getUrl in class MenuElementImpl
Returns:
folder url

isHidden

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

Specified by:
isHidden in interface Menu
Returns:
hidden state

isSelected

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

Specified by:
isSelected in interface Menu
Parameters:
context - request context
Returns:
selected state

getElements

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

Specified by:
getElements in interface Menu
Returns:
menu elements list

isEmpty

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

Specified by:
isEmpty in interface Menu
Returns:
menu elements list empty state

isElementRelative

public boolean isElementRelative()
isElementRelative - get flag that indicates whether any relative paths dependent on the current page in context were referenced while constructing menu elements

Returns:
relative element status

getSelectedElement

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

Specified by:
getSelectedElement in interface Menu
Returns:
selected menu element


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