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 AbstractUIMenu

[contained in: com.sap.km.cm.ui.flex.par - km.shared.ui.flex.uicommand_api.jar] 
java.lang.Object
  |
  +--com.sapportals.wcm.rendering.uicommand.AbstractUIMenu
All Implemented Interfaces:
IUIMenu
Direct Known Subclasses:
UIButtonMenu, UIHoverMenu, UIIconMenu, UILinkMenu, UIMenuBar, UISmallButtonMenu, UITabMenu, UIToolbarButtonMenu, UIVerticalLinkMenu
public abstract class AbstractUIMenu
extends java.lang.Object
implements IUIMenu

This class can be used by IUIMenus to reduce coding overhead.

Fields inherited from interface com.sapportals.wcm.rendering.uicommand.IUIMenu
BUTTON_MENU_TYPE, HOVER_MENU_TYPE, ICON_MENU_TYPE, LINK_MENU_TYPE, MENU_BAR_TYPE, SMALL_BUTTON_MENU_TYPE, TAB_MENU_TYPE, TOOLBAR_BUTTON_MENU_TYPE, VERTICAL_LINK_MENU_TYPE
 
Constructor Summary
AbstractUIMenu()
           
 
Method Summary
 java.lang.String createTarget(IExecCommand command, AbstractProxyControl proxy)
          Creates a unique Id as String where are encoded the IExecCommand data
 java.lang.String createTarget(IMassExecCommand command, AbstractProxyControl proxy)
          Creates a unique Id as String where are encoded the IUIMassExecCommand data
 java.lang.String createTarget(IUIGroupCommand group, AbstractProxyControl proxy)
          Creates a unique Id as String where are encoded the IUIGroupCommand data
protected  com.sapportals.htmlb.Component getCommandLink(IExecCommand command, AbstractProxyControl proxy, boolean renderDots)
           
protected  com.sapportals.htmlb.Component getCommandLink(IResource resource, IExecCommand command, AbstractProxyControl proxy, boolean renderDots)
           
protected  java.lang.String getLinkLabel(java.lang.String commandLabel)
          Take out the '...' ending from the IExecCommand labels
protected  boolean renderGroup(IUIGroupCommand group, com.sapportals.htmlb.hovermenu.HoverMenu hoverMenu, IResource resource, AbstractProxyControl proxy, boolean showSeparator, boolean groupExpanded, boolean groupIncluded)
          Creates a hover menu component according with the input parameters
 com.sapportals.htmlb.hovermenu.HoverMenu renderHoverMenu(IUIGroupCommand group, IResource resource, AbstractProxyControl proxy)
          Render a hover menu for a IUIGroupCommand given
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface com.sapportals.wcm.rendering.uicommand.IUIMenu
getMenuType, getNewInstance, renderMenu
 

Constructor Detail

AbstractUIMenu

public AbstractUIMenu()
Method Detail

renderHoverMenu

public com.sapportals.htmlb.hovermenu.HoverMenu renderHoverMenu(IUIGroupCommand group,
                                                                IResource resource,
                                                                AbstractProxyControl proxy)
                                                         throws WcmException
Render a hover menu for a IUIGroupCommand given
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
group - Description of the param
Returns:
the resulted component
Throws:
WcmException - Description of the Exception

renderGroup

protected boolean renderGroup(IUIGroupCommand group,
                              com.sapportals.htmlb.hovermenu.HoverMenu hoverMenu,
                              IResource resource,
                              AbstractProxyControl proxy,
                              boolean showSeparator,
                              boolean groupExpanded,
                              boolean groupIncluded)
                       throws WcmException
Creates a hover menu component according with the input parameters
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
group - the given IUICommandGroup
hoverMenu - the parrent HoverMenu
showSeparator - true if a hover separator is needed
groupExpanded - true if a parent IUICommandGroup is expanded
Returns:
true if is needed a hover sepatator
Throws:
WcmException - Description of the Exception

createTarget

public java.lang.String createTarget(IUIGroupCommand group,
                                     AbstractProxyControl proxy)
                              throws WcmException
Creates a unique Id as String where are encoded the IUIGroupCommand data
Parameters:
proxy - the Control that called this method.
group - Description of the param
Returns:
an unique id
Throws:
WcmException - Description of the Exception

createTarget

public java.lang.String createTarget(IExecCommand command,
                                     AbstractProxyControl proxy)
                              throws WcmException
Creates a unique Id as String where are encoded the IExecCommand data
Parameters:
command - the IExecCommand
proxy - the Control that called this method.
Returns:
an unique id
Throws:
WcmException - Description of the Exception

createTarget

public java.lang.String createTarget(IMassExecCommand command,
                                     AbstractProxyControl proxy)
                              throws WcmException
Creates a unique Id as String where are encoded the IUIMassExecCommand data
Parameters:
command - the IUIMassExecCommand
proxy - the Control that called this method.
Returns:
an unique id
Throws:
WcmException - Description of the Exception

getCommandLink

protected com.sapportals.htmlb.Component getCommandLink(IExecCommand command,
                                                        AbstractProxyControl proxy,
                                                        boolean renderDots)

getCommandLink

protected com.sapportals.htmlb.Component getCommandLink(IResource resource,
                                                        IExecCommand command,
                                                        AbstractProxyControl proxy,
                                                        boolean renderDots)

getLinkLabel

protected java.lang.String getLinkLabel(java.lang.String commandLabel)
Take out the '...' ending from the IExecCommand labels
Parameters:
commandLabel - the IExecCommand's label as String
Returns:
the label without '...' ending
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.