org.hippoecm.hst.mock.core.sitemenu
Class MockHstSiteMenu

java.lang.Object
  org.hippoecm.hst.mock.core.sitemenu.MockHstSiteMenu

All Implemented Interfaces:

CommonMenu, HstSiteMenu

public class MockHstSiteMenu
extends Object
implements HstSiteMenu

Mock implementation of HstSiteMenu.

Constructor Summary

MockHstSiteMenu()

Method Summary

void	addSiteMenuItem(HstSiteMenuItem siteMenuItem)
void	clearSiteMenuItems()
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()
String	getName() Returns the name of this SiteMenu.
HstSiteMenuItem	getSelectSiteMenuItem()
List<HstSiteMenuItem>	getSiteMenuItems()
boolean	isExpanded() Based on the request, the implementation should be able to indicate whether this HstSiteMenu is expanded
void	setDeepestExpandedItem(HstSiteMenuItem deepestExpandedItem)
void	setEditableMenu(EditableMenu editableMenu)
void	setExpanded(boolean expanded)
void	setHstSiteMenus(HstSiteMenus hstSiteMenus)
void	setName(String name)
void	setSelectSiteMenuItem(HstSiteMenuItem selectSiteMenuItem)
void	setSiteMenuItems(List<HstSiteMenuItem> siteMenuItems)

Methods inherited from class java.lang.Object

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

Constructor Detail

MockHstSiteMenu

public MockHstSiteMenu()

Method Detail

getSiteMenuItems

public List<HstSiteMenuItem> getSiteMenuItems()

Specified by:

getSiteMenuItems in interface HstSiteMenu

Returns:

returns all direct child HstSiteMenuItem's of this SiteMenu

setSiteMenuItems

public void setSiteMenuItems(List<HstSiteMenuItem> siteMenuItems)

addSiteMenuItem

public void addSiteMenuItem(HstSiteMenuItem siteMenuItem)

clearSiteMenuItems

public void clearSiteMenuItems()

getHstSiteMenus

public HstSiteMenus getHstSiteMenus()

Specified by:

getHstSiteMenus in interface HstSiteMenu

Returns:

the HstSiteMenus container for this HstSiteMenu

setHstSiteMenus

public void setHstSiteMenus(HstSiteMenus hstSiteMenus)

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

setDeepestExpandedItem

public void setDeepestExpandedItem(HstSiteMenuItem deepestExpandedItem)

getSelectSiteMenuItem

public HstSiteMenuItem getSelectSiteMenuItem()

Specified by:

getSelectSiteMenuItem in interface HstSiteMenu

Returns:

the currently selected HstSiteMenuItem or null if none is selected

setSelectSiteMenuItem

public void setSelectSiteMenuItem(HstSiteMenuItem selectSiteMenuItem)

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.

setEditableMenu

public void setEditableMenu(EditableMenu editableMenu)

getName

public String getName()

Description copied from interface: CommonMenu

Returns the name of this SiteMenu. For example, you could have a "topmenu", "leftmenu" and "footermenu" on your site/portal, where these names might be appropriate

Specified by:

getName in interface CommonMenu

Returns:

the name of this SiteMenu

setName

public void setName(String name)

isExpanded

public boolean isExpanded()

Description copied from interface: CommonMenu

Based on the request, the implementation should be able to indicate whether this HstSiteMenu is expanded

Specified by:

isExpanded in interface CommonMenu

Returns:

true when any HstSiteMenuItem in this HstSiteMenu container is selected

setExpanded

public void setExpanded(boolean expanded)