org.osivia.portal.api.menubar

Interface IMenubarService

public interface IMenubarService

Menubar service interface.

Author:

Cédric Krommenhoek

Field Summary

Fields

Modifier and Type	Field and Description
static String	MBEAN_NAME MBean name.
static String	MENUBAR_REGION_NAME Menubar region name.
static String	MENUBAR_WINDOW_ID Menubar window identifier.

Method Summary

Modifier and Type	Method and Description
void	addDropdown(PortalControllerContext portalControllerContext, MenubarDropdown dropdown) Add menubar dropdown menu.
String	generateNavbarContent(PortalControllerContext portalControllerContext) Generate navbar actions menubar HTML content.
String	generatePortletContent(PortalControllerContext portalControllerContext, List<MenubarItem> items) Generate portlet menubar HTML content.
MenubarDropdown	getDropdown(PortalControllerContext portalControllerContext, String id) Get menubar dropdown menu.
Map<MenubarGroup,Set<MenubarItem>>	getNavbarSortedItems(PortalControllerContext portalControllerContext) Get navbar menubar items, sorted by groups.
Map<MenubarGroup,Set<MenubarItem>>	getPortletSortedItems(List<MenubarItem> items) Get portlet menubar items, sorted by groups.
List<MenubarItem>	getStateItems(PortalControllerContext portalControllerContext) Get state menubar items.

Field Detail

MBEAN_NAME

static final String MBEAN_NAME

MBean name.

See Also:

Constant Field Values

MENUBAR_WINDOW_ID

static final String MENUBAR_WINDOW_ID

Menubar window identifier.

See Also:

Constant Field Values

MENUBAR_REGION_NAME

static final String MENUBAR_REGION_NAME

Menubar region name.

See Also:

Constant Field Values

Method Detail

getDropdown

MenubarDropdown getDropdown(PortalControllerContext portalControllerContext,
                            String id)

Get menubar dropdown menu.

Parameters:

portalControllerContext - portal controller context

id - menubar dropdown menu identifier

Returns:

menubar dropdown menu

addDropdown

void addDropdown(PortalControllerContext portalControllerContext,
                 MenubarDropdown dropdown)

Add menubar dropdown menu.

Parameters:

portalControllerContext - portal controller context

dropdown - menubar dropdown menu

generateNavbarContent

String generateNavbarContent(PortalControllerContext portalControllerContext)

Generate navbar actions menubar HTML content.

Parameters:

portalControllerContext - portal controller context

Returns:

HTML content

getNavbarSortedItems

Map<MenubarGroup,Set<MenubarItem>> getNavbarSortedItems(PortalControllerContext portalControllerContext)

Get navbar menubar items, sorted by groups.

Parameters:

portalControllerContext - portal controller context

Returns:

sorted menubar items

generatePortletContent

String generatePortletContent(PortalControllerContext portalControllerContext,
                              List<MenubarItem> items)

Generate portlet menubar HTML content.

Parameters:

portalControllerContext - portal controller context

items - portlet menubar items

Returns:

HTML content

getPortletSortedItems

Map<MenubarGroup,Set<MenubarItem>> getPortletSortedItems(List<MenubarItem> items)

Get portlet menubar items, sorted by groups.

Parameters:

items - menubar items

Returns:

sorted menubar items

getStateItems

List<MenubarItem> getStateItems(PortalControllerContext portalControllerContext)

Get state menubar items.

Parameters:

portalControllerContext - portal controller context

Returns:

menubar items