Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
SAP NetWeaver '04
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES
SUMMARY:  INNER | FIELD | CONSTR | METHOD DETAIL:  FIELD | CONSTR | METHOD

com.sapportals.wcm.rendering.uicommand
Class UIMenuFactory

[contained in: com.sap.km.cm.ui.flex.par - km.shared.ui.flex.uicommand_api.jar] 
com.sapportals.wcm.rendering.uicommand.UIMenuFactory
public final class UIMenuFactory

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 java.lang.String PLUGIN
          path to use for the ConfigFramework
 
Method Summary
 void configEvent(com.sapportals.config.event.ConfigEvent parm1)
          is called by the configuration, if configuration for the factory was changed.
 java.lang.String getConfigListenerId()
          Gets the configListenerId attribute of the UIMenuFactory object
static UIMenuFactory getInstance()
          Gets the instance attribute of the UIMenuCommandFactory class
 com.sapportals.htmlb.Component getRenderMenu(IResource resource, java.lang.String menuType, com.sapportals.wcm.repository.service.layout.customizing.IParameterName group, com.sapportals.wcm.repository.service.layout.customizing.flavor.IFlavor flavor, IProxy proxy)
          Renders a menu component ( menu bar, hover menu, button menu or link menu) according with the input data
 com.sapportals.htmlb.Component getRenderMenu(IResource resource, java.lang.String menuType, com.sapportals.wcm.repository.service.layout.customizing.IParameterName group, java.lang.String groupID, com.sapportals.wcm.repository.service.layout.customizing.flavor.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
 com.sapportals.htmlb.Component getRenderMenu(IResource resource, java.lang.String menuType, com.sapportals.wcm.repository.service.layout.customizing.IParameterName group, java.lang.String groupID, com.sapportals.wcm.repository.service.layout.customizing.flavor.IFlavor flavor, IProxy proxy)
          Renders a menu component ( menu bar, hover menu, button menu or link menu) according with the input data
 com.sapportals.htmlb.Component renderMenuForGroup(IResource resource, java.lang.String menuType, IUIGroupCommand groupCommand, IProxy proxy)
          Renders a menu component ( menu bar, hover menu, button menu or link menu) according with the input data
 

Field Detail

PLUGIN

public static final java.lang.String PLUGIN
path to use for the ConfigFramework
Method Detail

getInstance

public static UIMenuFactory getInstance()
Gets the instance attribute of the UIMenuCommandFactory class
Returns:
The instance value

getRenderMenu

public com.sapportals.htmlb.Component getRenderMenu(IResource resource,
                                                    java.lang.String menuType,
                                                    com.sapportals.wcm.repository.service.layout.customizing.IParameterName group,
                                                    com.sapportals.wcm.repository.service.layout.customizing.flavor.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

renderMenuForGroup

public com.sapportals.htmlb.Component renderMenuForGroup(IResource resource,
                                                         java.lang.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
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

getRenderMenu

public com.sapportals.htmlb.Component getRenderMenu(IResource resource,
                                                    java.lang.String menuType,
                                                    com.sapportals.wcm.repository.service.layout.customizing.IParameterName group,
                                                    java.lang.String groupID,
                                                    com.sapportals.wcm.repository.service.layout.customizing.flavor.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

getRenderMenu

public com.sapportals.htmlb.Component getRenderMenu(IResource resource,
                                                    java.lang.String menuType,
                                                    com.sapportals.wcm.repository.service.layout.customizing.IParameterName group,
                                                    java.lang.String groupID,
                                                    com.sapportals.wcm.repository.service.layout.customizing.flavor.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

getConfigListenerId

public java.lang.String getConfigListenerId()
Gets the configListenerId attribute of the UIMenuFactory object
Returns:
The configListenerId value

configEvent

public void configEvent(com.sapportals.config.event.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
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
SAP NetWeaver '04
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES
SUMMARY:  INNER | FIELD | CONSTR | METHOD DETAIL:  FIELD | CONSTR | METHOD
Copyright © 2004 by SAP AG. All Rights Reserved.
SAP, R/3, mySAP, mySAP.com, xApps, xApp, SAP NetWeaver, and other SAP products and services mentioned herein as well as their respective logos are trademarks or registered trademarks of SAP AG in Germany and in several other countries all over the world. All other product and service names mentioned are the trademarks of their respective companies. Data contained in this document serves informational purposes only. National product specifications may vary.

These materials are subject to change without notice. These materials are provided by SAP AG and its affiliated companies ("SAP Group") for informational purposes only, without representation or warranty of any kind, and SAP Group shall not be liable for errors or omissions with respect to the materials. The only warranties for SAP Group products and services are those that are set forth in the express warranty statements accompanying such products and services, if any. Nothing herein should be construed as constituting an additional warranty.