com.sapportals.wcm.rendering.uicommand

Class UIMenuFactory

java.lang.Object
  com.sapportals.wcm.rendering.uicommand.UIMenuFactory

public final class UIMenuFactory

extends Object

The UIMenuFactory is a singleton factory, that allows other classes to retrieve instances of IUIMenus. When the factory is called for the first time or when it receives a ConfigEvent, it reads out information from the config framework.

Field Summary

static String

PLUGIN path to use for the ConfigFramework

Method Summary

void	configEvent(ConfigEvent parm1) is called by the configuration, if configuration for the factory was changed.
String	getConfigListenerId() Gets the configListenerId attribute of the UIMenuFactory object
static UIMenuFactory	getInstance() Gets the instance attribute of the UIMenuCommandFactory class
Component	getRenderMenu(IResource resource, String menuType, IParameterName group, IFlavor flavor, IProxy proxy) Renders a menu component ( menu bar, hover menu, button menu or link menu) according with the input data
Component	getRenderMenu(IResource resource, String menuType, IParameterName group, String groupID, IFlavor flavor) Renders a menu component ( menu bar, hover menu, button menu or link menu) for a command group which have only command which generate external links and no proxy is needed
Component	getRenderMenu(IResource resource, String menuType, IParameterName group, String groupID, IFlavor flavor, IProxy proxy) Renders a menu component ( menu bar, hover menu, button menu or link menu) according with the input data
Component	renderMenuForGroup(IResource resource, String menuType, IUIGroupCommand groupCommand, IProxy proxy) Renders a menu component ( menu bar, hover menu, button menu or link menu) according with the input data

Methods inherited from class java.lang.Object

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

Field Detail

PLUGIN

public static final String PLUGIN

path to use for the ConfigFramework

See Also:

Constant Field Values

Method Detail

getInstance

public static UIMenuFactory getInstance()

Gets the instance attribute of the UIMenuCommandFactory class

Returns:

The instance value

getRenderMenu

public Component getRenderMenu(IResource resource,
                               String menuType,
                               IParameterName group,
                               IFlavor flavor,
                               IProxy proxy)
                        throws WcmException

Renders a menu component ( menu bar, hover menu, button menu or link menu) according with the input data

Parameters:

resource - the IResource for which the component is requiered

proxy - the Control that called this method. It is set as parameter for the retrieved instance

menuType - a String which specify the menu type

group - a IParameterName which specify the group

flavor - a IFlavor which specify the flavor

Returns:

the resulted component

Throws:

WdfException - Exception raised in failure situation

WcmException

renderMenuForGroup

public Component renderMenuForGroup(IResource resource,
                                    String menuType,
                                    IUIGroupCommand groupCommand,
                                    IProxy proxy)
                             throws WcmException

Renders a menu component ( menu bar, hover menu, button menu or link menu) according with the input data

Parameters:

resource - the IResource for which the component is requiered

proxy - the Control that called this method. It is set as parameter for the retrieved instance

menuType - a String which specify the menu type

Returns:

the resulted component

Throws:

WdfException - Exception raised in failure situation

WcmException

getRenderMenu

public Component getRenderMenu(IResource resource,
                               String menuType,
                               IParameterName group,
                               String groupID,
                               IFlavor flavor,
                               IProxy proxy)
                        throws WcmException

Renders a menu component ( menu bar, hover menu, button menu or link menu) according with the input data

Parameters:

resource - the IResource for which the component is requiered

menuType - a String which specify the menu type

group - a IParameterName which specify the group

groupID - a String which specify the group ID

flavor - a IFlavor which specify the flavor

proxy - the Control that called this method. It is set as parameter for the retrieved instance

Returns:

the resulted component

Throws:

WdfException - Exception raised in failure situation

WcmException

getRenderMenu

public Component getRenderMenu(IResource resource,
                               String menuType,
                               IParameterName group,
                               String groupID,
                               IFlavor flavor)
                        throws WcmException

Renders a menu component ( menu bar, hover menu, button menu or link menu) for a command group which have only command which generate external links and no proxy is needed

Parameters:

resource - the IResource for which the component is requiered

menuType - a String which specify the menu type

group - a IParameterName which specify the group

groupID - a String which specify the group ID

flavor - a IFlavor which specify the flavor

Returns:

the resulted component

Throws:

WdfException - Exception raised in failure situation

WcmException

getConfigListenerId

public String getConfigListenerId()

Gets the configListenerId attribute of the UIMenuFactory object

Returns:

The configListenerId value

configEvent

public void configEvent(ConfigEvent parm1)

is called by the configuration, if configuration for the factory was changed. If the event is of type ConfigEvent.CONFIGURABLE_LOADED or ConfigEvent.CONFIGMANAGER_TERMINATED , the factory deletes all its entries and reloads the configuration, creating all commands anew.

Parameters:

parm1 - the event raised by the configuration