org.apache.jetspeed.portalsite.menu
Class StandardNavigationsMenuDefinition

java.lang.Object
  org.apache.jetspeed.om.folder.impl.StandardMenuDefinitionImpl
      org.apache.jetspeed.portalsite.menu.StandardNavigationsMenuDefinition

All Implemented Interfaces:

org.apache.jetspeed.om.folder.MenuDefinition

public class StandardNavigationsMenuDefinition
extends StandardMenuDefinitionImpl

This class provides a menu definition for the standard navigations menu.

Version:

$Id: StandardNavigationsMenuDefinition.java 568811 2007-08-23 03:00:37Z woonsan $

Author:

Randy Watler

Field Summary

private List

menuElements menuElements - ordered polymorphic list of menu option, nested menu, separator, include, and exclude definitions

Fields inherited from interface org.apache.jetspeed.om.folder.MenuDefinition

ANY_PROFILE_LOCATOR

Constructor Summary

StandardNavigationsMenuDefinition()
StandardNavigationsMenuDefinition - constructor

Method Summary

List	getMenuElements() getMenuElements - get ordered list of menu options, nested menus, separators, included menu, and excluded menu elements
protected String	getMenuSeparatorText(Locale locale, String key) getMenuSeparatorText - lookup resource bundle based on locale and use to extract menu separator text
String	getName() getName - get menu name
String	getSkin() getSkin - get skin name for menu element

Methods inherited from class org.apache.jetspeed.om.folder.impl.StandardMenuDefinitionImpl

getDepth, getMetadata, getOptions, getOrder, getProfile, getShortTitle, getShortTitle, getTitle, getTitle, getTitle, isPaths, isRegexp, setDepth, setMenuElements, setName, setOptions, setOrder, setPaths, setProfile, setRegexp, setShortTitle, setSkin, setTitle

Methods inherited from class java.lang.Object

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

Field Detail

menuElements

private List menuElements

menuElements - ordered polymorphic list of menu option, nested menu, separator, include, and exclude definitions

Constructor Detail

StandardNavigationsMenuDefinition

public StandardNavigationsMenuDefinition()

StandardNavigationsMenuDefinition - constructor

Method Detail

getName

public String getName()

getName - get menu name

Specified by:

getName in interface org.apache.jetspeed.om.folder.MenuDefinition

Overrides:

getName in class StandardMenuDefinitionImpl

Returns:

menu name

getMenuElements

public List getMenuElements()

getMenuElements - get ordered list of menu options, nested menus, separators, included menu, and excluded menu elements

Specified by:

getMenuElements in interface org.apache.jetspeed.om.folder.MenuDefinition

Overrides:

getMenuElements in class StandardMenuDefinitionImpl

Returns:

element list

getSkin

public String getSkin()

getSkin - get skin name for menu element

Specified by:

getSkin in interface org.apache.jetspeed.om.folder.MenuDefinition

Overrides:

getSkin in class StandardMenuDefinitionImpl

Returns:

skin name

getMenuSeparatorText

protected String getMenuSeparatorText(Locale locale,
                                      String key)

getMenuSeparatorText - lookup resource bundle based on locale and use to extract menu separator text

Parameters:

locale - preferred locale

key - message key for text