java.lang .Object org.apache.jetspeed.om.folder.impl .StandardMenuDefinitionImpl All known Subclasses: org.apache.jetspeed.portalsite.menu .StandardBackMenuDefinition , org.apache.jetspeed.portalsite.menu .StandardPagesMenuDefinition , org.apache.jetspeed.portalsite.menu .StandardNavigationsMenuDefinition , org.apache.jetspeed.portalsite.menu .DefaultMenuDefinition ,StandardMenuDefinitionImpl abstract public class StandardMenuDefinitionImpl implements MenuDefinition (Code) This abstract class implements the menu definition interface
in a default manner to allow derived classes to easily describe
standard menu definitions supported natively by the portal site
component.
author: Randy Watler version: $Id: StandardMenuDefinitionImpl.java 516448 2007-03-09 16:25:47Z ate $
StandardMenuDefinitionImpl public StandardMenuDefinitionImpl()(Code) StandardMenuDefinitionImpl - constructor
getDepth public int getDepth()(Code) getDepth - get depth of inclusion for folder menu options
inclusion depth
getMenuElements public List getMenuElements()(Code) getMenuElements - get ordered list of menu options,
nested menus, separators, included
menu, and excluded menu elements
element list
getMetadata public GenericMetadata getMetadata()(Code) getMetadata - get generic metadata instance for menu
metadata instance
getName public String getName()(Code) getName - get menu name
menu name
getOptions public String getOptions()(Code) getOptions - get comma separated menu options if not specified as elements
option paths specification
getOrder public String getOrder()(Code) getOrder - get comma separated regexp ordering patterns for options
ordering patterns list
getProfile public String getProfile()(Code) getProfile - get profile locator used to filter specified options
profile locator name
getShortTitle public String getShortTitle()(Code) getShortTitle - get default short title for menu
short title text
getShortTitle public String getShortTitle(Locale locale)(Code) getShortTitle - get locale specific short title for menu from metadata
Parameters: locale - preferred locale short title text
getSkin public String getSkin()(Code) getSkin - get skin name for menu
skin name
getTitle public String getTitle()(Code) getTitle - get default title for menu
title text
getTitle public String getTitle(Locale locale)(Code) getTitle - get locale specific title for menu from metadata
Parameters: locale - preferred locale title text
getTitle protected String getTitle(Locale locale, boolean fallback)(Code) getTitle - get locale specific title for menu from metadata
protocol, with or without falback enabled
Parameters: locale - preferred localeParameters: fallback - whether to return default title title text
isPaths public boolean isPaths()(Code) isPaths - get generate ordered path options for specified options
paths options flag
isRegexp public boolean isRegexp()(Code) isRegexp - get regexp flag for interpreting specified options
regexp flag
setDepth public void setDepth(int depth)(Code) setDepth - set depth of inclusion for folder menu options
Parameters: depth - inclusion depth
setMenuElements public void setMenuElements(List elements)(Code) setMenuElements - set ordered list of menu options
Parameters: elements - element list
setName public void setName(String name)(Code) setName - set menu name
Parameters: name - menu name
setOptions public void setOptions(String options)(Code) setOptions - set comma separated menu options if not specified as elements
Parameters: option - option paths specification
setOrder public void setOrder(String order)(Code) setOrder - set comma separated regexp ordering patterns for options
Parameters: order - ordering patterns list
setPaths public void setPaths(boolean paths)(Code) setPaths - set generate ordered path options for specified options
Parameters: paths - paths options flag
setProfile public void setProfile(String locatorName)(Code) setProfile - set profile locator used to filter specified options
Parameters: locatorName - profile locator name
setRegexp public void setRegexp(boolean regexp)(Code) setRegexp - set regexp flag for interpreting specified options
Parameters: regexp - regexp flag
setShortTitle public void setShortTitle(String title)(Code) setShortTitle - set default short title for menu
Parameters: title - short title text
setSkin public void setSkin(String name)(Code) setSkin - set skin name for menu
Parameters: name - skin name
setTitle public void setTitle(String title)(Code) setTitle - set default title for menu
Parameters: title - title text