com.sapportals.wcm.rendering.uicommand
Class UIMenuCommand

[contained in: com.sap.km.cm.ui.flex.par - km.shared.ui.flex.uicommand_api.jar]

java.lang.Object
  |
  +--com.sapportals.wcm.rendering.uicommand.UIMenuCommand

All Implemented Interfaces:

IUIBaseCommand, IUIMenuCommand

public final class UIMenuCommand

extends java.lang.Object

implements IUIMenuCommand

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
com.sapportals.htmlb.Component	getComponent()
java.util.Properties	getConfigurationProperties() Gets the configurationProperties attribute of the IUIBaseCommand object
java.lang.String	getLabel() Gets the label attribute of the UICopyCommand object
java.util.Hashtable	getParameters() Gets the command parameters
java.util.List	getReplaceCommands() gets the list of commands which will be ignored when the command is executable
java.lang.String	getText(TextKey key) Gets the text for a givven text key
java.lang.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(java.util.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(java.lang.String label) Sets the label attribute of the UIGroupCommand object
void	setLabelBundleKey(java.lang.String groupLabel) Sets the labelBundleKey attribute of the IUIBaseCommand object
void	setMandatory(boolean mandatory) Sets the mandatory attribute of the IUIMenuCommand object
void	setParameters(java.util.Hashtable parameters) Sets parameters for the command.
void	setProxy(AbstractProxyControl proxy) Sets the proxy attribute of the IUIBaseCommand object
void	setReplaceCommands(java.util.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(java.lang.String tooltip) Sets the tooltip attribute of the UIGroupCommand object
void	setTooltipBundleKey(java.lang.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

Following copied from interface: com.sapportals.wcm.rendering.base.IUIBaseCommand

Parameters:

bundleFile - The new resourceBundle value

setLabelBundleKey

public void setLabelBundleKey(java.lang.String groupLabel)

Description copied from interface: IUIBaseCommand

Sets the labelBundleKey attribute of the IUIBaseCommand object

Specified by:

setLabelBundleKey in interface IUIBaseCommand

Following copied from interface: com.sapportals.wcm.rendering.base.IUIBaseCommand

Parameters:

groupLabel - The new labelBundleKey value

setTooltipBundleKey

public void setTooltipBundleKey(java.lang.String groupTooltip)

Description copied from interface: IUIBaseCommand

Sets the tooltipBundleKey attribute of the IUIBaseCommand object

Specified by:

setTooltipBundleKey in interface IUIBaseCommand

Following copied from interface: com.sapportals.wcm.rendering.base.IUIBaseCommand

Parameters:

groupTooltip - The new tooltipBundleKey value

getLabel

public java.lang.String getLabel()

Gets the label attribute of the UICopyCommand object

Returns:

The label value

getText

public java.lang.String getText(TextKey key)

Description copied from interface: IUIBaseCommand

Gets the text for a givven text key

Specified by:

getText in interface IUIBaseCommand

Following copied from interface: com.sapportals.wcm.rendering.base.IUIBaseCommand

Parameters:

key - the input TextKey

Returns:

The text value

getTooltip

public java.lang.String getTooltip()

Gets the tooltip attribute of the UICopyCommand object

Returns:

The tooltip value

getComponent

public com.sapportals.htmlb.Component getComponent()

Specified by:

getComponent in interface IUIBaseCommand

Following copied from interface: com.sapportals.wcm.rendering.base.IUIBaseCommand

Returns:

a Component to use in a link or a button, e.g. a Trash-Can-Icon for delete

setLabel

public void setLabel(java.lang.String label)

Sets the label attribute of the UIGroupCommand object

Parameters:

label - The new label value

setTooltip

public void setTooltip(java.lang.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

Following copied from interface: com.sapportals.wcm.rendering.uicommand.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

Following copied from interface: com.sapportals.wcm.rendering.uicommand.IUIMenuCommand

Returns:

The mandatory value

setConfigurationProperties

public void setConfigurationProperties(java.util.Properties properties)

Specified by:

setConfigurationProperties in interface IUIBaseCommand

Following copied from interface: com.sapportals.wcm.rendering.base.IUIBaseCommand

Parameters:

properties - The new configurationProperties value

getConfigurationProperties

public java.util.Properties getConfigurationProperties()

Description copied from interface: IUIBaseCommand

Gets the configurationProperties attribute of the IUIBaseCommand object

Specified by:

getConfigurationProperties in interface IUIBaseCommand

Following copied from interface: com.sapportals.wcm.rendering.base.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

Following copied from interface: com.sapportals.wcm.rendering.uicommand.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

Following copied from interface: com.sapportals.wcm.rendering.uicommand.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 java.util.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(java.util.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(java.util.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

Parameters:

parameter - The new parameters value

getParameters

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

Parameters:

include - The new expanded value

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