|
||||||||||
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
public abstract class 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 |
java.util.List |
getMenuElements()
getMenuElements - get ordered list of menu options, nested menus, separators, included menu, and excluded menu elements |
GenericMetadata |
getMetadata()
getMetadata - get generic metadata instance for menu |
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 |
getOrder()
getOrder - get comma separated regexp ordering patterns for options |
java.lang.String |
getProfile()
getProfile - get profile locator used to filter specified options |
java.lang.String |
getShortTitle()
getShortTitle - get default short title for menu |
java.lang.String |
getShortTitle(java.util.Locale locale)
getShortTitle - get locale specific short title for menu from metadata |
java.lang.String |
getSkin()
getSkin - get skin name for menu |
java.lang.String |
getTitle()
getTitle - get default title for menu |
java.lang.String |
getTitle(java.util.Locale locale)
getTitle - get locale specific title for menu from metadata |
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 |
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(java.util.List elements)
setMenuElements - set ordered list of menu options |
void |
setName(java.lang.String name)
setName - set menu name |
void |
setOptions(java.lang.String options)
setOptions - set comma separated menu options if not specified as elements |
void |
setOrder(java.lang.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(java.lang.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(java.lang.String title)
setShortTitle - set default short title for menu |
void |
setSkin(java.lang.String name)
setSkin - set skin name for menu |
void |
setTitle(java.lang.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 java.lang.String getName()
getName
in interface MenuDefinition
public void setName(java.lang.String name)
setName
in interface MenuDefinition
name
- menu namepublic java.lang.String getOptions()
getOptions
in interface MenuDefinition
public void setOptions(java.lang.String options)
setOptions
in interface MenuDefinition
option
- option paths specificationpublic int getDepth()
getDepth
in interface MenuDefinition
public void setDepth(int depth)
setDepth
in interface MenuDefinition
depth
- inclusion depthpublic boolean isPaths()
isPaths
in interface MenuDefinition
public void setPaths(boolean paths)
setPaths
in interface MenuDefinition
paths
- paths options flagpublic boolean isRegexp()
isRegexp
in interface MenuDefinition
public void setRegexp(boolean regexp)
setRegexp
in interface MenuDefinition
regexp
- regexp flagpublic java.lang.String getProfile()
getProfile
in interface MenuDefinition
public void setProfile(java.lang.String locatorName)
setProfile
in interface MenuDefinition
locatorName
- profile locator namepublic java.lang.String getOrder()
getOrder
in interface MenuDefinition
public void setOrder(java.lang.String order)
setOrder
in interface MenuDefinition
order
- ordering patterns listpublic java.lang.String getSkin()
getSkin
in interface MenuDefinition
public void setSkin(java.lang.String name)
setSkin
in interface MenuDefinition
name
- skin namepublic java.lang.String getTitle()
getTitle
in interface MenuDefinition
public void setTitle(java.lang.String title)
setTitle
in interface MenuDefinition
title
- title textpublic java.lang.String getShortTitle()
getShortTitle
in interface MenuDefinition
public void setShortTitle(java.lang.String title)
setShortTitle
in interface MenuDefinition
title
- short title textpublic java.lang.String getTitle(java.util.Locale locale)
getTitle
in interface MenuDefinition
locale
- preferred locale
protected java.lang.String getTitle(java.util.Locale locale, boolean fallback)
locale
- preferred localefallback
- whether to return default title
public java.lang.String getShortTitle(java.util.Locale locale)
getShortTitle
in interface MenuDefinition
locale
- preferred locale
public GenericMetadata getMetadata()
getMetadata
in interface MenuDefinition
public java.util.List getMenuElements()
getMenuElements
in interface MenuDefinition
public void setMenuElements(java.util.List elements)
setMenuElements
in interface MenuDefinition
elements
- element list
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |