fr.paris.lutece.portal.service.portal

Class PortalMenuService

java.lang.Object

fr.paris.lutece.portal.service.cache.AbstractCacheableService

fr.paris.lutece.portal.service.portal.PortalMenuService

All Implemented Interfaces:

CacheableService, PageEventListener, LuteceService, Cloneable, EventListener, net.sf.ehcache.event.CacheEventListener

public final class PortalMenuService
extends AbstractCacheableService
implements PageEventListener

This Service build the portal menu

Field Summary

Fields

Modifier and Type	Field and Description
static int	MENU_INIT
static int	MENU_MAIN
static int	MODE_ADMIN
static int	MODE_NORMAL

Method Summary

Modifier and Type	Method and Description
static PortalMenuService	getInstance() Get the unique instance of the service
String	getMenuContent(int nCurrentPageId, int nMode, int nPart, javax.servlet.http.HttpServletRequest request) Returns the menu bar from the cache or builds it if it not stored in it
String	getName() Returns the service name
void	processPageEvent(PageEvent event) Process a page event

Methods inherited from class fr.paris.lutece.portal.service.cache.AbstractCacheableService

clone, dispose, enableCache, getCache, getCacheSize, getFromCache, getInfos, getKeys, getMaxElements, getMemorySize, getTimeToLive, initCache, initCache, isCacheEnable, notifyElementEvicted, notifyElementExpired, notifyElementPut, notifyElementRemoved, notifyElementUpdated, notifyRemoveAll, putInCache, removeKey, resetCache

Methods inherited from class java.lang.Object

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

Field Detail

MENU_INIT

public static final int MENU_INIT

See Also:

Constant Field Values

MENU_MAIN

public static final int MENU_MAIN

See Also:

Constant Field Values

MODE_NORMAL

public static final int MODE_NORMAL

See Also:

Constant Field Values

MODE_ADMIN

public static final int MODE_ADMIN

See Also:

Constant Field Values

Method Detail

getInstance

public static PortalMenuService getInstance()

Get the unique instance of the service

Returns:

The unique instance

getName

public String getName()

Returns the service name

Specified by:

getName in interface LuteceService

Returns:

The service name

getMenuContent

public String getMenuContent(int nCurrentPageId,
                             int nMode,
                             int nPart,
                             javax.servlet.http.HttpServletRequest request)

Returns the menu bar from the cache or builds it if it not stored in it

Parameters:

request - The HTTP request

nMode - The selected mode

nPart - The part of the menu to build

nCurrentPageId - The current page ID

Returns:

The list of the menus layed out with the stylesheet correpsonding to the mode

processPageEvent

public void processPageEvent(PageEvent event)

Description copied from interface: PageEventListener

Process a page event

Specified by:

processPageEvent in interface PageEventListener

Parameters:

event - The event to process