com.sapportals.wcm.rendering.uicommand

Interface IUIMenu

All Known Implementing Classes:

AbstractUIMenu

public interface IUIMenu

Base class for rendering menus

Field Summary

static String	BUTTON_MENU_TYPE menu type for the buttonmenu
static String	HOVER_MENU_TYPE menu type for the hovermenu
static String	ICON_MENU_TYPE menu type for the icon menu
static String	LINK_MENU_TYPE menu type for the linkmenu
static String	MENU_BAR_TYPE menu type for the menubar
static String	SMALL_BUTTON_MENU_TYPE menu type for the small buttonmenu
static String	TAB_MENU_TYPE menu type for the icon menu
static String	TOOLBAR_BUTTON_MENU_TYPE menu type for the toolbar buttonmenu
static String	VERTICAL_LINK_MENU_TYPE menu type for the vertical links menu

Method Summary

String	getMenuType() Gets an unique menu type value of the menu
IUIMenu	getNewInstance() Gets a instance of the IUIMenu object
Component	renderMenu(IUIGroupCommand groupCommand, IResource resource, AbstractProxyControl newProxy) Creates a menu component according with the input parameters

Field Detail

MENU_BAR_TYPE

public static final String MENU_BAR_TYPE

menu type for the menubar

See Also:

Constant Field Values

HOVER_MENU_TYPE

public static final String HOVER_MENU_TYPE

menu type for the hovermenu

See Also:

Constant Field Values

LINK_MENU_TYPE

public static final String LINK_MENU_TYPE

menu type for the linkmenu

See Also:

Constant Field Values

BUTTON_MENU_TYPE

public static final String BUTTON_MENU_TYPE

menu type for the buttonmenu

See Also:

Constant Field Values

SMALL_BUTTON_MENU_TYPE

public static final String SMALL_BUTTON_MENU_TYPE

menu type for the small buttonmenu

See Also:

Constant Field Values

TOOLBAR_BUTTON_MENU_TYPE

public static final String TOOLBAR_BUTTON_MENU_TYPE

menu type for the toolbar buttonmenu

See Also:

Constant Field Values

VERTICAL_LINK_MENU_TYPE

public static final String VERTICAL_LINK_MENU_TYPE

menu type for the vertical links menu

See Also:

Constant Field Values

ICON_MENU_TYPE

public static final String ICON_MENU_TYPE

menu type for the icon menu

See Also:

Constant Field Values

TAB_MENU_TYPE

public static final String TAB_MENU_TYPE

menu type for the icon menu

See Also:

Constant Field Values

Method Detail

getNewInstance

public IUIMenu getNewInstance()

Gets a instance of the IUIMenu object

Returns:

the newInstance value

renderMenu

public Component renderMenu(IUIGroupCommand groupCommand,
                            IResource resource,
                            AbstractProxyControl newProxy)
                     throws WcmException

Creates a menu component according with the input parameters

Parameters:

resource - the IResource for which the component is requiered

newProxy - the Control that called this method

groupCommand - the given IUICommandGroup which will rendered

Returns:

the resulted component

Throws:

WdfException - Exception raised in failure situation

WcmException

getMenuType

public String getMenuType()

Gets an unique menu type value of the menu

Returns:

the menuType value