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

Class UIMenuCommand

java.lang.Object
  extended bycom.sapportals.wcm.rendering.uicommand.UIMenuCommand
All Implemented Interfaces:
IUIBaseCommand, IUIMenuCommand
public final class UIMenuCommand
extends Object
implements IUIMenuCommand

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
 
Constructor Summary
UIMenuCommand(IUIBaseCommand command)
           
UIMenuCommand(IUIBaseCommand command, boolean mandatory)
           
UIMenuCommand(IUIBaseCommand command, boolean mandatory, boolean defaultCommand)
           
 
Method Summary
 IUIBaseCommand getCommand()
          Gets the newInstance attribute of the UIRatingCommand object
 Component getComponent()
           
 Properties getConfigurationProperties()
          Gets the configurationProperties attribute of the IUIBaseCommand object
 String getLabel()
          Gets the label attribute of the UICopyCommand 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
 String getTooltip()
          Gets the tooltip attribute of the UICopyCommand object
 boolean isDefault()
           
 boolean isEnabled()
          Gets the enabled attribute of the IUIMenuCommand object
 boolean isExpanded()
          Gets the expanded attribute of the IUIMenuCommand object
 boolean isIncluded()
          Gets the include attribute of the IUIMenuCommand object
 boolean isMandatory()
          Gets the mandatory attribute of the IUIMenuCommand object
 void setConfigurationProperties(Properties properties)
           
 void setDefault(boolean flag)
           
 void setEnabled(boolean enabled)
          Sets the enabled attribute of the IUIMenuCommand object
 void setExpanded(boolean expanded)
          Sets the expanded attribute of the IUIMenuCommand object
 void setIncluded(boolean included)
          Sets the include attribute of the UIMenuCommand object
 void setLabel(String label)
          Sets the label attribute of the UIGroupCommand object
 void setLabelBundleKey(String groupLabel)
          Sets the labelBundleKey attribute of the IUIBaseCommand object
 void setMandatory(boolean mandatory)
          Sets the mandatory attribute of the IUIMenuCommand 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)
          set 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 attribute of the UIGroupCommand object
 void setTooltip(String tooltip)
          Sets the tooltip attribute of the UIGroupCommand object
 void setTooltipBundleKey(String groupTooltip)
          Sets the tooltipBundleKey attribute of the IUIBaseCommand object
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

UIMenuCommand

public UIMenuCommand(IUIBaseCommand command)

UIMenuCommand

public UIMenuCommand(IUIBaseCommand command,
                     boolean mandatory)

UIMenuCommand

public UIMenuCommand(IUIBaseCommand command,
                     boolean mandatory,
                     boolean defaultCommand)
Method Detail

setResourceBundle

public void setResourceBundle(ResourceBundles bundleFile)
Specified by:
setResourceBundle in interface IUIBaseCommand
Parameters:
bundleFile - The new resourceBundle value

setLabelBundleKey

public void setLabelBundleKey(String groupLabel)
Description copied from interface: IUIBaseCommand
Sets the labelBundleKey attribute of the IUIBaseCommand object

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

setTooltipBundleKey

public void setTooltipBundleKey(String groupTooltip)
Description copied from interface: IUIBaseCommand
Sets the tooltipBundleKey attribute of the IUIBaseCommand object

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

getLabel

public String getLabel()
Gets the label attribute of the UICopyCommand object

Returns:
The label value

getText

public String getText(TextKey key)
Description copied from interface: IUIBaseCommand
Gets the text for a givven text key

Specified by:
getText in interface IUIBaseCommand
Parameters:
key - the input TextKey
Returns:
The text value

getTooltip

public String getTooltip()
Gets the tooltip attribute of the UICopyCommand object

Returns:
The tooltip value

getComponent

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

setLabel

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

Parameters:
label - The new label value

setTooltip

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

Parameters:
tooltip - The new tooltip value

getCommand

public IUIBaseCommand getCommand()
Gets the newInstance attribute of the UIRatingCommand object

Specified by:
getCommand in interface IUIMenuCommand
Returns:
The newInstance value

setMandatory

public void setMandatory(boolean mandatory)
Description copied from interface: IUIMenuCommand
Sets the mandatory attribute of the IUIMenuCommand object

Specified by:
setMandatory in interface IUIMenuCommand
Parameters:
mandatory - The new mandatory value

isMandatory

public boolean isMandatory()
Description copied from interface: IUIMenuCommand
Gets the mandatory attribute of the IUIMenuCommand object

Specified by:
isMandatory in interface IUIMenuCommand
Returns:
The mandatory value

setConfigurationProperties

public void setConfigurationProperties(Properties properties)
Specified by:
setConfigurationProperties in interface IUIBaseCommand
Parameters:
properties - The new configurationProperties value

getConfigurationProperties

public Properties getConfigurationProperties()
Description copied from interface: IUIBaseCommand
Gets the configurationProperties attribute of the IUIBaseCommand object

Specified by:
getConfigurationProperties in interface IUIBaseCommand
Returns:
The configurationProperties value

setEnabled

public void setEnabled(boolean enabled)
Description copied from interface: IUIMenuCommand
Sets the enabled attribute of the IUIMenuCommand object

Specified by:
setEnabled in interface IUIMenuCommand
Parameters:
enabled - The new enabled value

isEnabled

public boolean isEnabled()
Description copied from interface: IUIMenuCommand
Gets the enabled attribute of the IUIMenuCommand object

Specified by:
isEnabled in interface IUIMenuCommand
Returns:
The enabled value

setResource

public void setResource(IResource resource)
Specified by:
setResource in interface IUIBaseCommand
Parameters:
resource - sets the resource the command shall operate on

setProxy

public void setProxy(AbstractProxyControl proxy)
Description copied from interface: IUIBaseCommand
Sets the proxy attribute of the IUIBaseCommand object

Specified by:
setProxy in interface IUIBaseCommand
Parameters:
proxy - The new proxy value

setResourceContext

public void setResourceContext(IResourceContext context)
Sets the resourceContext attribute of the UIGroupCommand object

Specified by:
setResourceContext in interface IUIBaseCommand
Parameters:
context - The new resourceContext value

setExpanded

public void setExpanded(boolean expanded)
Sets the expanded attribute of the IUIMenuCommand object

Specified by:
setExpanded in interface IUIMenuCommand
Parameters:
expanded - The new expanded value

isExpanded

public boolean isExpanded()
Gets the expanded attribute of the IUIMenuCommand object

Specified by:
isExpanded in interface IUIMenuCommand
Returns:
The expanded value

getReplaceCommands

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

Specified by:
getReplaceCommands in interface IUIBaseCommand
Returns:
The replaceCommands value

setReplaceCommands

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

Specified by:
setReplaceCommands in interface IUIBaseCommand
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.

Specified by:
setParameters in interface IUIBaseCommand

getParameters

public Hashtable getParameters()
Gets the command parameters

Specified by:
getParameters in interface IUIBaseCommand
Returns:
The parameters value

setIncluded

public void setIncluded(boolean included)
Sets the include attribute of the UIMenuCommand object

Specified by:
setIncluded in interface IUIMenuCommand

isIncluded

public boolean isIncluded()
Gets the include attribute of the IUIMenuCommand object

Specified by:
isIncluded in interface IUIMenuCommand
Returns:
The include value

isDefault

public boolean isDefault()
Specified by:
isDefault in interface IUIMenuCommand

setDefault

public void setDefault(boolean flag)
Specified by:
setDefault in interface IUIMenuCommand
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.