org.apache.jetspeed.portalsite.menu
Class StandardBackMenuDefinition

java.lang.Object
  extended by org.apache.jetspeed.om.folder.impl.StandardMenuDefinitionImpl
      extended by org.apache.jetspeed.portalsite.menu.StandardBackMenuDefinition
All Implemented Interfaces:
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  java.lang.String getMenuTitleText(java.util.Locale locale, java.lang.String key)
          getMenuTitleText - lookup resource bundle based on locale and use to extract menu title text
 java.lang.String getName()
          getName - get menu name
 java.lang.String getOptions()
          getOptions - get comma separated menu options if not specified as elements
 java.lang.String getSkin()
          getSkin - get skin name for menu element
 java.lang.String getTitle()
          getTitle - get default title for menu
protected  java.lang.String getTitle(java.util.Locale locale, boolean fallback)
          getTitle - get locale specific title for menu from metadata protocol, with or without falback enabled
protected  java.lang.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 java.lang.String getName()
getName - get menu name

Specified by:
getName in interface MenuDefinition
Overrides:
getName in class StandardMenuDefinitionImpl
Returns:
menu name

getOptions

public java.lang.String getOptions()
getOptions - get comma separated menu options if not specified as elements

Specified by:
getOptions in interface MenuDefinition
Overrides:
getOptions in class StandardMenuDefinitionImpl
Returns:
option paths specification

getSkin

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

Specified by:
getSkin in interface MenuDefinition
Overrides:
getSkin in class StandardMenuDefinitionImpl
Returns:
skin name

getTitle

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

Specified by:
getTitle in interface MenuDefinition
Overrides:
getTitle in class StandardMenuDefinitionImpl
Returns:
title text

getTitle

protected java.lang.String getTitle(java.util.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 java.lang.String getTitleResourceKey()
getTitleResourceKey - get resource key used to lookup menu titles

Returns:
resource key

getMenuTitleText

protected java.lang.String getMenuTitleText(java.util.Locale locale,
                                            java.lang.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


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