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
Interface IUIGroupCommand

[contained in: com.sap.km.cm.ui.flex.par - km.shared.ui.flex.uicommand_api.jar]
All Superinterfaces:
IUIBaseCommand
All Known Implementing Classes:
AbstractUIGroupCommand
public interface IUIGroupCommand
extends IUIBaseCommand

Description of the Interface

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
 java.lang.String getGroupID()
          Gets the groupID attribute of the IUIGroupCommand object
 java.lang.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(java.lang.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
 java.lang.String getTooltipBundleKey()
          Gets the tooltipBundleKey attribute of the IUIGroupCommand object
 void setGroupCommandsList(UIBaseCommandList groupCommandsList)
          Sets the groupCommandsList attribute of the IUIGroupCommand object
 void setLabel(java.lang.String groupLabel)
          Sets the label attribute of the IUIGroupCommand object
 void setLabelBundleKey(java.lang.String groupLabel)
          Sets the labelBundleKey attribute of the IUIGroupCommand object
 void setResourceBundle(ResourceBundles bundleFile)
          Sets the bundleFile attribute of the IUIGroupCommand object
 void setTooltip(java.lang.String groupTooltip)
          Sets the tooltip attribute of the IUIGroupCommand object
 void setTooltipBundleKey(java.lang.String groupTooltip)
          Sets the tooltipBundleKey attribute of the IUIGroupCommand object
 void writePresentConfiguration(java.util.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(java.lang.String groupID)
Parameters:
groupID - the group Id as StringReturns:
a new Instance of the class - this is needed by the UICommandFactory

getGroupID

public java.lang.String getGroupID()
Gets the groupID attribute of the IUIGroupCommand object
Returns:
The groupID value

setLabel

public void setLabel(java.lang.String groupLabel)
Sets the label attribute of the IUIGroupCommand object
Parameters:
groupLabel - The new label value

setTooltip

public void setTooltip(java.lang.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(java.lang.String groupLabel)
Sets the labelBundleKey attribute of the IUIGroupCommand object
Specified by:
setLabelBundleKey in interface IUIBaseCommand
Parameters:
groupLabel - The new labelBundleKey value

getLabelBundleKey

public java.lang.String getLabelBundleKey()
Gets the labelBundleKey attribute of the IUIGroupCommand object
Returns:
The labelBundleKey value

setTooltipBundleKey

public void setTooltipBundleKey(java.lang.String groupTooltip)
Sets the tooltipBundleKey attribute of the IUIGroupCommand object
Specified by:
setTooltipBundleKey in interface IUIBaseCommand
Parameters:
groupTooltip - The new tooltipBundleKey value

getTooltipBundleKey

public java.lang.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(java.util.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:  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.