com.sapportals.wcm.rendering.uicommand
Interface IUIMenuCommand

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

All Superinterfaces:

IUIBaseCommand

All Known Implementing Classes:

UIMenuCommand

public interface IUIMenuCommand

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

IUIBaseCommand	getCommand() Gets the command attribute of the IUIMenuCommand 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	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 When command group is expanded, then its command will be rendered in the same hover menu generating a hover separator before the first command; otherwise a subhover menu will be rendered
void	setIncluded(boolean included) Sets the include attribute of the IUIMenuCommand object When the command group is expanded and included, then no separator in hover menu will be rendered
void	setMandatory(boolean mandatory) Sets the mandatory attribute of the IUIMenuCommand object

Methods inherited from interface com.sapportals.wcm.rendering.base.IUIBaseCommand

getComponent, getConfigurationProperties, getParameters, getReplaceCommands, getText, setConfigurationProperties, setLabelBundleKey, setParameters, setProxy, setReplaceCommands, setResource, setResourceBundle, setResourceContext, setTooltipBundleKey

Method Detail

setMandatory

public void setMandatory(boolean mandatory)

Sets the mandatory attribute of the IUIMenuCommand object

Parameters:

mandatory - The new mandatory value

isMandatory

public boolean isMandatory()

Gets the mandatory attribute of the IUIMenuCommand object

Returns:

The mandatory value

setEnabled

public void setEnabled(boolean enabled)

Sets the enabled attribute of the IUIMenuCommand object

Parameters:

enabled - The new enabled value

isEnabled

public boolean isEnabled()

Gets the enabled attribute of the IUIMenuCommand object

Returns:

The enabled value

getCommand

public IUIBaseCommand getCommand()

Gets the command attribute of the IUIMenuCommand object

Returns:

The command value

setExpanded

public void setExpanded(boolean expanded)

Sets the expanded attribute of the IUIMenuCommand object When command group is expanded, then its command will be rendered in the same hover menu generating a hover separator before the first command; otherwise a subhover menu will be rendered

Parameters:

expanded - The new expanded value

isExpanded

public boolean isExpanded()

Gets the expanded attribute of the IUIMenuCommand object

Returns:

The expanded value

setIncluded

public void setIncluded(boolean included)

Sets the include attribute of the IUIMenuCommand object When the command group is expanded and included, then no separator in hover menu will be rendered

Parameters:

include - The new expanded value

isIncluded

public boolean isIncluded()

Gets the include attribute of the IUIMenuCommand object

Returns:

The include value

isDefault

public boolean isDefault()

setDefault

public void setDefault(boolean flag)