Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
SAP NetWeaver '04
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD
com.sapportals.wcm.rendering.uicommand

Interface IUIGroupCommand

All Superinterfaces:
IUIBaseCommand
All Known Implementing Classes:
AbstractUIGroupCommand
public interface IUIGroupCommand
extends IUIBaseCommand

Description of the Interface

Field Summary
 
Fields inherited from interface com.sapportals.wcm.rendering.base.IUIBaseCommand
ERR_MESSAGE_MISSING_CONFIG_ENTRY, ERR_MESSAGE_WRONG_METHOD_CALL, KEY_INPUT_CONTROL_TEXT, KEY_INPUT_CONTROL_TEXT_2, KEY_INPUT_CONTROL_TEXT_2_DEFAULT_TEXT, KEY_INPUT_CONTROL_TEXT_3, KEY_INPUT_CONTROL_TEXT_DEFAULT_TEXT, KEY_LABEL, KEY_MASS_EMBEDDED_COMMAND_TEXT, KEY_MASS_EMBEDDED_COMMANT_TOOLTIP, KEY_SINGLE_EMBEDDED_COMMAND_TEXT, KEY_SINGLE_EMBEDDED_COMMAND_TOOLTIP, KEY_TOOLTIP, LINE_BREAK, TEXT_KEYS, VALUE_EMPTY_STRING
 
Method Summary
 UIBaseCommandList getGroupCommandsList()
          Gets the groupCommandsList attribute of the IUIGroupCommand object
 String getGroupID()
          Gets the groupID attribute of the IUIGroupCommand object
 String getLabelBundleKey()
          Gets the labelBundleKey attribute of the IUIGroupCommand object
 UIBaseCommandList getListWithReplaceCommands(IResource resource, AbstractProxyControl proxy)
          Parses the commans list and
 IUIGroupCommand getNewInstance()
           
 IUIGroupCommand getNewInstance(String groupID)
           
 ResourceBundles getResourceBundle()
          Gets the bundleFile attribute of the IUIGroupCommand object
 UIBaseCommandList getResourceCommands(IResource resource, AbstractProxyControl proxy)
          Gets the IUIBaseCommands list for the givven resource
 String getTooltipBundleKey()
          Gets the tooltipBundleKey attribute of the IUIGroupCommand object
 void setGroupCommandsList(UIBaseCommandList groupCommandsList)
          Sets the groupCommandsList attribute of the IUIGroupCommand object
 void setLabel(String groupLabel)
          Sets the label attribute of the IUIGroupCommand object
 void setLabelBundleKey(String groupLabel)
          Sets the labelBundleKey attribute of the IUIGroupCommand object
 void setResourceBundle(ResourceBundles bundleFile)
          Sets the bundleFile attribute of the IUIGroupCommand object
 void setTooltip(String groupTooltip)
          Sets the tooltip attribute of the IUIGroupCommand object
 void setTooltipBundleKey(String groupTooltip)
          Sets the tooltipBundleKey attribute of the IUIGroupCommand object
 void writePresentConfiguration(List list, int depth, IResourceContext context)
          for debug purpose
 
Methods inherited from interface com.sapportals.wcm.rendering.base.IUIBaseCommand
getComponent, getConfigurationProperties, getParameters, getReplaceCommands, getText, setConfigurationProperties, setParameters, setProxy, setReplaceCommands, setResource, setResourceContext
 

Method Detail

getResourceCommands

public UIBaseCommandList getResourceCommands(IResource resource,
                                             AbstractProxyControl proxy)
Gets the IUIBaseCommands list for the givven resource

Parameters:
resource - the IResource for which the command list is requiered
proxy - the proxy where the group is rendered
Returns:
The UIBaseCommandList resulted

getNewInstance

public IUIGroupCommand getNewInstance(String groupID)
Parameters:
groupID - the group Id as StringReturns:
a new Instance of the class - this is needed by the UICommandFactory

getGroupID

public String getGroupID()
Gets the groupID attribute of the IUIGroupCommand object

Returns:
The groupID value

setLabel

public void setLabel(String groupLabel)
Sets the label attribute of the IUIGroupCommand object

Parameters:
groupLabel - The new label value

setTooltip

public void setTooltip(String groupTooltip)
Sets the tooltip attribute of the IUIGroupCommand object

Parameters:
groupTooltip - The new tooltip value

setGroupCommandsList

public void setGroupCommandsList(UIBaseCommandList groupCommandsList)
Sets the groupCommandsList attribute of the IUIGroupCommand object

Parameters:
groupCommandsList - The new groupCommandsList value

getGroupCommandsList

public UIBaseCommandList getGroupCommandsList()
Gets the groupCommandsList attribute of the IUIGroupCommand object

Returns:
The groupCommandsList value

getNewInstance

public IUIGroupCommand getNewInstance()
Returns:
a new Instance of the class - this is needed by the UICommandFactory

setLabelBundleKey

public void setLabelBundleKey(String groupLabel)
Sets the labelBundleKey attribute of the IUIGroupCommand object

Specified by:
setLabelBundleKey in interface IUIBaseCommand
Parameters:
groupLabel - The new labelBundleKey value

getLabelBundleKey

public String getLabelBundleKey()
Gets the labelBundleKey attribute of the IUIGroupCommand object

Returns:
The labelBundleKey value

setTooltipBundleKey

public void setTooltipBundleKey(String groupTooltip)
Sets the tooltipBundleKey attribute of the IUIGroupCommand object

Specified by:
setTooltipBundleKey in interface IUIBaseCommand
Parameters:
groupTooltip - The new tooltipBundleKey value

getTooltipBundleKey

public String getTooltipBundleKey()
Gets the tooltipBundleKey attribute of the IUIGroupCommand object

Returns:
The tooltipBundleKey value

setResourceBundle

public void setResourceBundle(ResourceBundles bundleFile)
Sets the bundleFile attribute of the IUIGroupCommand object

Specified by:
setResourceBundle in interface IUIBaseCommand
Parameters:
bundleFile - The new bundleFile value

getResourceBundle

public ResourceBundles getResourceBundle()
Gets the bundleFile attribute of the IUIGroupCommand object

Returns:
The bundleFile value

writePresentConfiguration

public void writePresentConfiguration(List list,
                                      int depth,
                                      IResourceContext context)
for debug purpose

Parameters:
list -
depth -
context -

getListWithReplaceCommands

public UIBaseCommandList getListWithReplaceCommands(IResource resource,
                                                    AbstractProxyControl proxy)
Parses the commans list and

Parameters:
resource - the IResource for which the command list is requiered
proxy - the proxy where the group is rendered
Returns:
The UIBaseCommandList resulted
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
SAP NetWeaver '04
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD
Copyright 2006 SAP AG. All rights reserved. No part of this publication may be reproduced or transmitted in any form or for any purpose without the express permission of SAP AG. The information contained herein may be changed without prior notice. Microsoft, Windows, Outlook, and PowerPoint are registered trademarks of Microsoft Corporation. Oracle is a registered trademark of Oracle Corporation. UNIX, X/Open, OSF/1, and Motif are registered trademarks of the Open Group. Citrix, ICA, Program Neighborhood, MetaFrame, WinFrame, VideoFrame, and MultiWin are trademarks or registered trademarks of Citrix Systems, Inc. HTML, XML, XHTML and W3C are trademarks or registered trademarks of W3C, World Wide Web Consortium, Massachusetts Institute of Technology. Java is a registered trademark of Sun Microsystems, Inc. JavaScript is a registered trademark of Sun Microsystems, Inc., used under license for technology invented and implemented by Netscape. MaxDB is a trademark of MySQL AB, Sweden. 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.