org.apache.jetspeed.portalsite.menu
Class StandardBackMenuDefinition

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

All Implemented Interfaces:

org.apache.jetspeed.om.folder.MenuDefinition

Direct Known Subclasses:

StandardBreadcrumbsMenuDefinition

public class StandardBackMenuDefinition
extends StandardMenuDefinitionImpl

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

Version:

$Id: StandardBackMenuDefinition.java 516448 2007-03-09 16:25:47Z ate $

Author:

Randy Watler

Field Summary

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

ANY_PROFILE_LOCATOR

Constructor Summary

StandardBackMenuDefinition()
StandardBackMenuDefinition - constructor

Method Summary

protected String	getMenuTitleText(Locale locale, String key) getMenuTitleText - lookup resource bundle based on locale and use to extract menu title text
String	getName() getName - get menu name
String	getOptions() getOptions - get comma separated menu options if not specified as elements
String	getSkin() getSkin - get skin name for menu element
String	getTitle() getTitle - get default title for menu
protected String	getTitle(Locale locale, boolean fallback) getTitle - get locale specific title for menu from metadata protocol, with or without falback enabled
protected String	getTitleResourceKey() getTitleResourceKey - get resource key used to lookup menu titles

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

getDepth, getMenuElements, getMetadata, getOrder, getProfile, getShortTitle, getShortTitle, 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

Constructor Detail

StandardBackMenuDefinition

public StandardBackMenuDefinition()

StandardBackMenuDefinition - 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

getOptions

public String getOptions()

getOptions - get comma separated menu options if not specified as elements

Specified by:

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

Overrides:

getOptions in class StandardMenuDefinitionImpl

Returns:

option paths specification

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

getTitle

public String getTitle()

getTitle - get default title for menu

Specified by:

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

Overrides:

getTitle in class StandardMenuDefinitionImpl

Returns:

title text

getTitle

protected String getTitle(Locale locale,
                          boolean fallback)

getTitle - get locale specific title for menu from metadata protocol, with or without falback enabled

Overrides:

getTitle in class StandardMenuDefinitionImpl

Parameters:

locale - preferred locale

fallback - whether to return default title

Returns:

title text

getTitleResourceKey

protected String getTitleResourceKey()

getTitleResourceKey - get resource key used to lookup menu titles

Returns:

resource key

getMenuTitleText

protected String getMenuTitleText(Locale locale,
                                  String key)

getMenuTitleText - lookup resource bundle based on locale and use to extract menu title text

Parameters:

locale - preferred locale

key - message key for text