org.hippoecm.hst.core.sitemenu
Class HstSiteMenuImpl

java.lang.Object
  org.hippoecm.hst.core.sitemenu.AbstractMenu
      org.hippoecm.hst.core.sitemenu.HstSiteMenuImpl

All Implemented Interfaces:

CommonMenu, HstSiteMenu

public class HstSiteMenuImpl
extends AbstractMenu
implements HstSiteMenu

Field Summary

Fields inherited from class org.hippoecm.hst.core.sitemenu.AbstractMenu

expanded, name

Constructor Summary

HstSiteMenuImpl(HstSiteMenus hstSiteMenus, HstSiteMenuConfiguration siteMenuConfiguration, HstRequestContext hstRequestContext)

Method Summary

HstSiteMenuItem	getDeepestExpandedItem() This utility method is valuable for creating repository based navigations, as you can easily get the deepest selected item, which might in turn need repository based menu build below it
EditableMenu	getEditableMenu() Returns an EditableMenu instance from this HstSiteMenu.
HstSiteMenus	getHstSiteMenus()
HstSiteMenuItem	getSelectSiteMenuItem()
List<HstSiteMenuItem>	getSiteMenuItems()
void	setExpanded()
void	setSelectedSiteMenuItem(HstSiteMenuItem selectedSiteMenuItem)

Methods inherited from class org.hippoecm.hst.core.sitemenu.AbstractMenu

getName, isExpanded

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.hippoecm.hst.core.sitemenu.CommonMenu

getName, isExpanded

Constructor Detail

HstSiteMenuImpl

public HstSiteMenuImpl(HstSiteMenus hstSiteMenus,
                       HstSiteMenuConfiguration siteMenuConfiguration,
                       HstRequestContext hstRequestContext)

Method Detail

getSiteMenuItems

public List<HstSiteMenuItem> getSiteMenuItems()

Specified by:

getSiteMenuItems in interface HstSiteMenu

Returns:

returns all direct child HstSiteMenuItem's of this SiteMenu

getHstSiteMenus

public HstSiteMenus getHstSiteMenus()

Specified by:

getHstSiteMenus in interface HstSiteMenu

Returns:

the HstSiteMenus container for this HstSiteMenu

getSelectSiteMenuItem

public HstSiteMenuItem getSelectSiteMenuItem()

Specified by:

getSelectSiteMenuItem in interface HstSiteMenu

Returns:

the currently selected HstSiteMenuItem or null if none is selected

setSelectedSiteMenuItem

public void setSelectedSiteMenuItem(HstSiteMenuItem selectedSiteMenuItem)

setExpanded

public void setExpanded()

getDeepestExpandedItem

public HstSiteMenuItem getDeepestExpandedItem()

Description copied from interface: HstSiteMenu

This utility method is valuable for creating repository based navigations, as you can easily get the deepest selected item, which might in turn need repository based menu build below it

Specified by:

getDeepestExpandedItem in interface HstSiteMenu

Returns:

the HstSiteMenuItem that is the last one in the tree of expanded items, or null if none is expanded

getEditableMenu

public EditableMenu getEditableMenu()

Description copied from interface: HstSiteMenu

Returns an EditableMenu instance from this HstSiteMenu. Note that changing the EditableMenu using the setters and adders (like adding a EditableMenuItem) will not being reflected in this HstSiteMenu instance.

Specified by:

getEditableMenu in interface HstSiteMenu

Returns:

an EditableMenu instance of this HstSiteMenu.