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.base

Interface IUIBaseCommand

All Known Subinterfaces:
ICommand, IExecCommand, IMassCommand, IMassExecCommand, IUICommand, IUIGroupCommand, IUIMassCommand, IUIMenuCommand
All Known Implementing Classes:
AbstractCommand, AbstractMassCommand, AbstractUICommand, AbstractUIGroupCommand, AbstractUIMassCommand, UIMenuCommand
public interface IUIBaseCommand

Description of the Interface

Field Summary
static String ERR_MESSAGE_MISSING_CONFIG_ENTRY
          Message for exception when config settings are missing for a IUIBaseCommand.
static String ERR_MESSAGE_WRONG_METHOD_CALL
          Message for exception to show when a wrong method of a IUIBaseCommand was called.
static String KEY_INPUT_CONTROL_TEXT
           
static String KEY_INPUT_CONTROL_TEXT_2
           
static String KEY_INPUT_CONTROL_TEXT_2_DEFAULT_TEXT
           
static String KEY_INPUT_CONTROL_TEXT_3
           
static String KEY_INPUT_CONTROL_TEXT_DEFAULT_TEXT
           
static String KEY_LABEL
          Some Commands require a second screen to choose the resources that are needed to carry out the commands on the resources selected in the first screen.
static String KEY_MASS_EMBEDDED_COMMAND_TEXT
           
static String KEY_MASS_EMBEDDED_COMMANT_TOOLTIP
           
static String KEY_SINGLE_EMBEDDED_COMMAND_TEXT
           
static String KEY_SINGLE_EMBEDDED_COMMAND_TOOLTIP
           
static String KEY_TOOLTIP
           
static String LINE_BREAK
          Line break to format lists of information
static String[] TEXT_KEYS
           
static String VALUE_EMPTY_STRING
           
 
Method Summary
 Component getComponent()
           
 Properties getConfigurationProperties()
          Gets the configurationProperties attribute of the IUIBaseCommand object
 Hashtable getParameters()
          Gets the command parameters
 List getReplaceCommands()
          gets the list of commands which will be ignored when the command is executable
 String getText(TextKey key)
          Gets the text for a givven text key
 void setConfigurationProperties(Properties properties)
           
 void setLabelBundleKey(String groupLabel)
          Sets the labelBundleKey attribute of the IUIBaseCommand object
 void setParameters(Hashtable parameters)
          Sets parameters for the command.
 void setProxy(AbstractProxyControl proxy)
          Sets the proxy attribute of the IUIBaseCommand object
 void setReplaceCommands(List replaceCommandsList)
          Sets the list of commands which will be ignored when the command is executable
 void setResource(IResource resource)
           
 void setResourceBundle(ResourceBundles bundleFile)
           
 void setResourceContext(IResourceContext context)
          Sets the resourceContext for IUIBaseCommand
 void setTooltipBundleKey(String groupTooltip)
          Sets the tooltipBundleKey attribute of the IUIBaseCommand object
 

Field Detail

LINE_BREAK

public static final String LINE_BREAK
Line break to format lists of information

ERR_MESSAGE_WRONG_METHOD_CALL

public static final String ERR_MESSAGE_WRONG_METHOD_CALL
Message for exception to show when a wrong method of a IUIBaseCommand was called. This could be execute() for a command, that needs a complete screenflow and cannot operate properly with this call. It has three parameters: methodname, parameter-signature, classname

See Also:
Constant Field Values

ERR_MESSAGE_MISSING_CONFIG_ENTRY

public static final String ERR_MESSAGE_MISSING_CONFIG_ENTRY
Message for exception when config settings are missing for a IUIBaseCommand. It has two parameters: classname, parameter-name

See Also:
Constant Field Values

KEY_LABEL

public static final String KEY_LABEL
Some Commands require a second screen to choose the resources that are needed to carry out the commands on the resources selected in the first screen. In this case, the original command has to provide for the texts shown on the second screen. These constants are used to read out the texts from the internal hashmap of the commands.

See Also:
Constant Field Values

KEY_TOOLTIP

public static final String KEY_TOOLTIP
See Also:
Constant Field Values

KEY_INPUT_CONTROL_TEXT

public static final String KEY_INPUT_CONTROL_TEXT
See Also:
Constant Field Values

KEY_INPUT_CONTROL_TEXT_DEFAULT_TEXT

public static final String KEY_INPUT_CONTROL_TEXT_DEFAULT_TEXT
See Also:
Constant Field Values

KEY_INPUT_CONTROL_TEXT_2_DEFAULT_TEXT

public static final String KEY_INPUT_CONTROL_TEXT_2_DEFAULT_TEXT
See Also:
Constant Field Values

KEY_INPUT_CONTROL_TEXT_2

public static final String KEY_INPUT_CONTROL_TEXT_2
See Also:
Constant Field Values

KEY_INPUT_CONTROL_TEXT_3

public static final String KEY_INPUT_CONTROL_TEXT_3
See Also:
Constant Field Values

KEY_SINGLE_EMBEDDED_COMMAND_TEXT

public static final String KEY_SINGLE_EMBEDDED_COMMAND_TEXT
See Also:
Constant Field Values

KEY_SINGLE_EMBEDDED_COMMAND_TOOLTIP

public static final String KEY_SINGLE_EMBEDDED_COMMAND_TOOLTIP
See Also:
Constant Field Values

KEY_MASS_EMBEDDED_COMMAND_TEXT

public static final String KEY_MASS_EMBEDDED_COMMAND_TEXT
See Also:
Constant Field Values

KEY_MASS_EMBEDDED_COMMANT_TOOLTIP

public static final String KEY_MASS_EMBEDDED_COMMANT_TOOLTIP
See Also:
Constant Field Values

VALUE_EMPTY_STRING

public static final String VALUE_EMPTY_STRING
See Also:
Constant Field Values

TEXT_KEYS

public static final String[] TEXT_KEYS
Method Detail

setResource

public void setResource(IResource resource)
Parameters:
resource - sets the resource the command shall operate on

setResourceBundle

public void setResourceBundle(ResourceBundles bundleFile)
Parameters:
bundleFile - The new resourceBundle value

setLabelBundleKey

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

Parameters:
groupLabel - The new labelBundleKey value

setTooltipBundleKey

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

Parameters:
groupTooltip - The new tooltipBundleKey value

getText

public String getText(TextKey key)
Gets the text for a givven text key

Parameters:
key - the input TextKey
Returns:
The text value

setConfigurationProperties

public void setConfigurationProperties(Properties properties)
Parameters:
properties - The new configurationProperties value

getConfigurationProperties

public Properties getConfigurationProperties()
Gets the configurationProperties attribute of the IUIBaseCommand object

Returns:
The configurationProperties value

getComponent

public Component getComponent()
Returns:
a Component to use in a link or a button, e.g. a Trash-Can-Icon for delete

setProxy

public void setProxy(AbstractProxyControl proxy)
Sets the proxy attribute of the IUIBaseCommand object

Parameters:
proxy - The new proxy value

setResourceContext

public void setResourceContext(IResourceContext context)
Sets the resourceContext for IUIBaseCommand

Parameters:
context - The new resourceContext value

getReplaceCommands

public List getReplaceCommands()
gets the list of commands which will be ignored when the command is executable

Returns:
The replaceCommands value

setReplaceCommands

public void setReplaceCommands(List replaceCommandsList)
Sets the list of commands which will be ignored when the command is executable

Parameters:
replaceCommandsList - The new replaceCommands value

setParameters

public void setParameters(Hashtable parameters)
Sets parameters for the command. Each parameters should have an unique key and one or more values.

getParameters

public Hashtable getParameters()
Gets the command parameters

Returns:
The parameters value
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.