com.sapportals.wcm.rendering.uicommand

Class UIMenuFactory

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

Deprecated. As of NetWeaver 7.1

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 Deprecated. path to use for the ConfigFramework

Method Summary

static UIMenuFactory	getInstance() Deprecated. As of NetWeaver 7.1
com.sapportals.htmlb.Component	getRenderMenu(IResource resource, String menuType, IParameterName group, IFlavor flavor, IProxy proxy) Deprecated. As of NetWeaver 7.1
com.sapportals.htmlb.Component	getRenderMenu(IResource resource, String menuType, IParameterName group, String groupID, IFlavor flavor) Deprecated. As of NetWeaver 7.1
com.sapportals.htmlb.Component	getRenderMenu(IResource resource, String menuType, IParameterName group, String groupID, IFlavor flavor, IProxy proxy) Deprecated. As of NetWeaver 7.1
com.sapportals.htmlb.Component	getRenderMenu(RenderDataContainer rdc, String menuType, IParameterName group, String groupID) Deprecated. As of NetWeaver 7.1
com.sapportals.htmlb.Component	renderMenuForGroup(IResource resource, String menuType, IUIGroupCommand groupCommand, IProxy proxy) Deprecated. As of NetWeaver 7.1

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

Deprecated.

path to use for the ConfigFramework

See Also:

Constant Field Values

Method Detail

getInstance

public static UIMenuFactory getInstance()

Deprecated. As of NetWeaver 7.1

Gets the instance attribute of the UIMenuCommandFactory class

Returns:

The instance value

getRenderMenu

public com.sapportals.htmlb.Component getRenderMenu(IResource resource,
                                                    String menuType,
                                                    IParameterName group,
                                                    IFlavor flavor,
                                                    IProxy proxy)
                                             throws com.sapportals.wcm.WcmException

Deprecated. As of NetWeaver 7.1

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

com.sapportals.wcm.WcmException

renderMenuForGroup

public com.sapportals.htmlb.Component renderMenuForGroup(IResource resource,
                                                         String menuType,
                                                         IUIGroupCommand groupCommand,
                                                         IProxy proxy)
                                                  throws com.sapportals.wcm.WcmException

Deprecated. As of NetWeaver 7.1

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

com.sapportals.wcm.WcmException

getRenderMenu

public com.sapportals.htmlb.Component getRenderMenu(RenderDataContainer rdc,
                                                    String menuType,
                                                    IParameterName group,
                                                    String groupID)
                                             throws com.sapportals.wcm.WcmException

Deprecated. As of NetWeaver 7.1

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

com.sapportals.wcm.WcmException

getRenderMenu

public com.sapportals.htmlb.Component getRenderMenu(IResource resource,
                                                    String menuType,
                                                    IParameterName group,
                                                    String groupID,
                                                    IFlavor flavor,
                                                    IProxy proxy)
                                             throws com.sapportals.wcm.WcmException

Deprecated. As of NetWeaver 7.1

Throws:

com.sapportals.wcm.WcmException

getRenderMenu

public com.sapportals.htmlb.Component getRenderMenu(IResource resource,
                                                    String menuType,
                                                    IParameterName group,
                                                    String groupID,
                                                    IFlavor flavor)
                                             throws com.sapportals.wcm.WcmException

Deprecated. As of NetWeaver 7.1

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

com.sapportals.wcm.WcmException

Access Rights

This class can be accessed from:

SC	DC	Public Part	ACH
[sap.com] KMC-CM	[sap.com] tc/km/nonwduideprecated	api	EP-KM-CM
[sap.com] KMC-WPC	[sap.com] tc/kmc/wpc/wpcfacade	api	EP-PIN-WPC-WCM