|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.jetspeed.portalsite.impl.MenuElementImpl
org.apache.jetspeed.portalsite.impl.MenuImpl
public class MenuImpl
This class implements the portal-site menu elements constructed and returned to decorators.
Field Summary |
---|
Fields inherited from interface org.apache.jetspeed.portalsite.MenuElement |
---|
MENU_ELEMENT_TYPE, OPTION_ELEMENT_TYPE, SEPARATOR_ELEMENT_TYPE |
Constructor Summary | |
---|---|
MenuImpl(MenuDefinition definition,
PortalSiteRequestContextImpl context,
java.util.Set menus)
MenuImpl - request/session context dependent constructor |
|
MenuImpl(MenuImpl parent,
MenuDefinition definition,
PortalSiteRequestContextImpl context,
java.util.Set menus)
MenuImpl - request/session context dependent constructor |
Method Summary | |
---|---|
java.lang.Object |
clone()
clone - clone this instance |
java.util.List |
getElements()
getElements - get ordered list of menu elements that are members of this menu; possibly contains options, nested menus, or separators |
java.lang.String |
getElementType()
getElementType - get type of menu element |
GenericMetadata |
getMetadata()
getMetadata - get generic metadata for menu element |
java.lang.String |
getName()
getName - get name of menu |
MenuElement |
getSelectedElement(PortalSiteRequestContext context)
getSelectedElement - return selected option or nested menu within this menu selected by the specified request context |
java.lang.String |
getShortTitle()
getShortTitle - get default short title for menu element |
java.lang.String |
getShortTitle(java.util.Locale locale)
getShortTitle - get locale specific short title for menu element from metadata |
java.lang.String |
getSkin()
getSkin - get skin name for menu element |
java.lang.String |
getTitle()
getTitle - get default title for menu element |
java.lang.String |
getTitle(java.util.Locale locale)
getTitle - get locale specific title for menu element from metadata |
java.lang.String |
getUrl()
getUrl - get url of top level folder that defined menu options; only available for menus defined without multiple options, nested menus, or separators |
boolean |
isElementRelative()
isElementRelative - get flag that indicates whether any relative paths dependent on the current page in context were referenced while constructing menu elements |
boolean |
isEmpty()
isEmpty - get empty state of list of menu elements |
boolean |
isHidden()
isHidden - get hidden state of folder that defined menu options; only available for menus defined without multiple options, nested menus, or separators |
boolean |
isSelected(PortalSiteRequestContext context)
isSelected - return true if an option or nested menu within this menu are selected by the specified request context |
Methods inherited from class org.apache.jetspeed.portalsite.impl.MenuElementImpl |
---|
equals, getNode, getParentMenu, setNode, setParentMenu |
Methods inherited from class java.lang.Object |
---|
finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface org.apache.jetspeed.portalsite.MenuElement |
---|
getParentMenu |
Constructor Detail |
---|
public MenuImpl(MenuImpl parent, MenuDefinition definition, PortalSiteRequestContextImpl context, java.util.Set menus)
parent
- containing menu implementationdefinition
- menu definitioncontext
- request contextmenus
- related menu definition names setpublic MenuImpl(MenuDefinition definition, PortalSiteRequestContextImpl context, java.util.Set menus)
definition
- menu definitioncontext
- request contextmenus
- related menu definition names setMethod Detail |
---|
public java.lang.Object clone() throws java.lang.CloneNotSupportedException
clone
in class MenuElementImpl
java.lang.CloneNotSupportedException
public java.lang.String getElementType()
getElementType
in interface MenuElement
getElementType
in class MenuElementImpl
public java.lang.String getName()
getName
in interface Menu
getName
in class MenuElementImpl
public java.lang.String getTitle()
getTitle
in interface MenuElement
getTitle
in class MenuElementImpl
public java.lang.String getShortTitle()
getShortTitle
in interface MenuElement
getShortTitle
in class MenuElementImpl
public java.lang.String getTitle(java.util.Locale locale)
getTitle
in interface MenuElement
getTitle
in class MenuElementImpl
locale
- preferred locale
public java.lang.String getShortTitle(java.util.Locale locale)
getShortTitle
in interface MenuElement
getShortTitle
in class MenuElementImpl
locale
- preferred locale
public GenericMetadata getMetadata()
getMetadata
in interface MenuElement
getMetadata
in class MenuElementImpl
public java.lang.String getSkin()
getSkin
in interface MenuElement
getSkin
in class MenuElementImpl
public java.lang.String getUrl()
getUrl
in interface Menu
getUrl
in class MenuElementImpl
public boolean isHidden()
isHidden
in interface Menu
public boolean isSelected(PortalSiteRequestContext context)
isSelected
in interface Menu
context
- request context
public java.util.List getElements()
getElements
in interface Menu
public boolean isEmpty()
isEmpty
in interface Menu
public boolean isElementRelative()
public MenuElement getSelectedElement(PortalSiteRequestContext context)
getSelectedElement
in interface Menu
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |