|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.jetspeed.om.folder.impl.StandardMenuDefinitionImpl
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.
Field Summary |
Fields inherited from interface org.apache.jetspeed.om.folder.MenuDefinition |
ANY_PROFILE_LOCATOR |
Constructor Summary | |
StandardMenuDefinitionImpl()
StandardMenuDefinitionImpl - constructor |
Method Summary | |
int |
getDepth()
getDepth - get depth of inclusion for folder menu options |
List |
getMenuElements()
getMenuElements - get ordered list of menu options, nested menus, separators, included menu, and excluded menu elements |
org.apache.jetspeed.om.common.GenericMetadata |
getMetadata()
getMetadata - get generic metadata instance for menu |
String |
getName()
getName - get menu name |
String |
getOptions()
getOptions - get comma separated menu options if not specified as elements |
String |
getOrder()
getOrder - get comma separated regexp ordering patterns for options |
String |
getProfile()
getProfile - get profile locator used to filter specified options |
String |
getShortTitle()
getShortTitle - get default short title for menu |
String |
getShortTitle(Locale locale)
getShortTitle - get locale specific short title for menu from metadata |
String |
getSkin()
getSkin - get skin name for menu |
String |
getTitle()
getTitle - get default title for menu |
String |
getTitle(Locale locale)
getTitle - get locale specific title for menu from metadata |
protected String |
getTitle(Locale locale,
boolean fallback)
getTitle - get locale specific title for menu from metadata protocol, with or without falback enabled |
boolean |
isPaths()
isPaths - get generate ordered path options for specified options |
boolean |
isRegexp()
isRegexp - get regexp flag for interpreting specified options |
void |
setDepth(int depth)
setDepth - set depth of inclusion for folder menu options |
void |
setMenuElements(List elements)
setMenuElements - set ordered list of menu options |
void |
setName(String name)
setName - set menu name |
void |
setOptions(String options)
setOptions - set comma separated menu options if not specified as elements |
void |
setOrder(String order)
setOrder - set comma separated regexp ordering patterns for options |
void |
setPaths(boolean paths)
setPaths - set generate ordered path options for specified options |
void |
setProfile(String locatorName)
setProfile - set profile locator used to filter specified options |
void |
setRegexp(boolean regexp)
setRegexp - set regexp flag for interpreting specified options |
void |
setShortTitle(String title)
setShortTitle - set default short title for menu |
void |
setSkin(String name)
setSkin - set skin name for menu |
void |
setTitle(String title)
setTitle - set default title for menu |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public StandardMenuDefinitionImpl()
Method Detail |
public String getName()
getName
in interface org.apache.jetspeed.om.folder.MenuDefinition
public void setName(String name)
setName
in interface org.apache.jetspeed.om.folder.MenuDefinition
name
- menu namepublic String getOptions()
getOptions
in interface org.apache.jetspeed.om.folder.MenuDefinition
public void setOptions(String options)
setOptions
in interface org.apache.jetspeed.om.folder.MenuDefinition
public int getDepth()
getDepth
in interface org.apache.jetspeed.om.folder.MenuDefinition
public void setDepth(int depth)
setDepth
in interface org.apache.jetspeed.om.folder.MenuDefinition
depth
- inclusion depthpublic boolean isPaths()
isPaths
in interface org.apache.jetspeed.om.folder.MenuDefinition
public void setPaths(boolean paths)
setPaths
in interface org.apache.jetspeed.om.folder.MenuDefinition
paths
- paths options flagpublic boolean isRegexp()
isRegexp
in interface org.apache.jetspeed.om.folder.MenuDefinition
public void setRegexp(boolean regexp)
setRegexp
in interface org.apache.jetspeed.om.folder.MenuDefinition
regexp
- regexp flagpublic String getProfile()
getProfile
in interface org.apache.jetspeed.om.folder.MenuDefinition
public void setProfile(String locatorName)
setProfile
in interface org.apache.jetspeed.om.folder.MenuDefinition
locatorName
- profile locator namepublic String getOrder()
getOrder
in interface org.apache.jetspeed.om.folder.MenuDefinition
public void setOrder(String order)
setOrder
in interface org.apache.jetspeed.om.folder.MenuDefinition
order
- ordering patterns listpublic String getSkin()
getSkin
in interface org.apache.jetspeed.om.folder.MenuDefinition
public void setSkin(String name)
setSkin
in interface org.apache.jetspeed.om.folder.MenuDefinition
name
- skin namepublic String getTitle()
getTitle
in interface org.apache.jetspeed.om.folder.MenuDefinition
public void setTitle(String title)
setTitle
in interface org.apache.jetspeed.om.folder.MenuDefinition
title
- title textpublic String getShortTitle()
getShortTitle
in interface org.apache.jetspeed.om.folder.MenuDefinition
public void setShortTitle(String title)
setShortTitle
in interface org.apache.jetspeed.om.folder.MenuDefinition
title
- short title textpublic String getTitle(Locale locale)
getTitle
in interface org.apache.jetspeed.om.folder.MenuDefinition
locale
- preferred locale
protected String getTitle(Locale locale, boolean fallback)
locale
- preferred localefallback
- whether to return default title
public String getShortTitle(Locale locale)
getShortTitle
in interface org.apache.jetspeed.om.folder.MenuDefinition
locale
- preferred locale
public org.apache.jetspeed.om.common.GenericMetadata getMetadata()
getMetadata
in interface org.apache.jetspeed.om.folder.MenuDefinition
public List getMenuElements()
getMenuElements
in interface org.apache.jetspeed.om.folder.MenuDefinition
public void setMenuElements(List elements)
setMenuElements
in interface org.apache.jetspeed.om.folder.MenuDefinition
elements
- element list
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |