com.sapportals.wcm.rendering.uicommand
Class AbstractUIGroupCommand

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

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

All Implemented Interfaces:

IUIBaseCommand, IUIGroupCommand

Direct Known Subclasses:

UIGroupCommand

public abstract class AbstractUIGroupCommand

extends java.lang.Object

implements IUIGroupCommand

Description of the Interface

Field Summary

protected ResourceBundles	bundleFile
protected UIBaseCommandList	commandsList
protected java.util.Properties	configproperties
protected IResourceContext	context
protected java.lang.String	groupID
protected java.lang.String	groupLabel
protected java.lang.String	groupLabelBundleKey
protected java.lang.String	groupTooltip
protected java.lang.String	groupTooltipBundleKey
protected java.util.List	replaceCommand
protected IResource	resource

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

AbstractUIGroupCommand()

Method Summary

com.sapportals.htmlb.Component	getComponent() Gets the component attribute of the UIStatemanagementGroupCommand object
java.util.Properties	getConfigurationProperties() Gets the configurationProperties attribute of the IUIBaseCommand object
UIBaseCommandList	getGroupCommandsList() Gets the groupCommandsList attribute of the UIGroupCommand object
java.lang.String	getGroupID() Gets the groupID attribute of the UIGroupCommand object
java.lang.String	getLabel() Gets the label attribute of the UICopyCommand object
java.lang.String	getLabelBundleKey() Gets the labelBundleKey attribute of the IUIGroupCommand object
UIBaseCommandList	getListWithReplaceCommands(IResource resource, AbstractProxyControl proxy) Parses the commans list and
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
ResourceBundles	getResourceBundle() Gets the bundleFile attribute of the UIGroupCommand object
UIBaseCommandList	getResourceCommands(IResource resource, AbstractProxyControl proxy) Gets the IUIBaseCommands list for the givven resource
IResourceContext	getResourceContext() Sets the resourceContext attribute of the UIGroupCommand object
java.lang.String	getText(TextKey key) Gets the text for a givven text key
java.lang.String	getTooltip() Gets the tooltip attribute of the IUIGroupCommand object
java.lang.String	getTooltipBundleKey() Gets the tooltipBundleKey attribute of the IUIGroupCommand object
void	setConfigurationProperties(java.util.Properties properties)
void	setGroupCommandsList(UIBaseCommandList groupCommandsList) Sets the groupCommandsList attribute of the UIGroupCommand object
void	setGroupID(java.lang.String groupID) Sets the groupID attribute of the UIGroupCommand object
void	setLabel(java.lang.String label) Sets the label attribute of the UIGroupCommand object
void	setLabelBundleKey(java.lang.String groupLabelBundleKey) Sets the labelBundleKey attribute of the IUIGroupCommand object
void	setParameters(java.util.Hashtable parameters) Sets parameters for the command.
void	setProxy(AbstractProxyControl proxy) Sets the proxy attribute of the UIStatemanagementGroupCommand 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) Sets the bundleFile attribute of the UIGroupCommand object
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 groupTooltipBundleKey) Sets the tooltipBundleKey attribute of the IUIGroupCommand object
void	writePresentConfiguration(java.util.List list, int depth, IResourceContext context) for debug purpose

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.sapportals.wcm.rendering.uicommand.IUIGroupCommand

getNewInstance, getNewInstance

Field Detail

commandsList

protected UIBaseCommandList commandsList

groupID

protected java.lang.String groupID

configproperties

protected java.util.Properties configproperties

replaceCommand

protected java.util.List replaceCommand

groupLabel

protected java.lang.String groupLabel

groupTooltip

protected java.lang.String groupTooltip

groupLabelBundleKey

protected java.lang.String groupLabelBundleKey

groupTooltipBundleKey

protected java.lang.String groupTooltipBundleKey

bundleFile

protected ResourceBundles bundleFile

context

protected IResourceContext context

resource

protected IResource resource

Constructor Detail

AbstractUIGroupCommand

public AbstractUIGroupCommand()

Method Detail

setGroupID

public void setGroupID(java.lang.String groupID)

Sets the groupID attribute of the UIGroupCommand object

Parameters:

groupID - The new groupID 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

getGroupID

public java.lang.String getGroupID()

Gets the groupID attribute of the UIGroupCommand object

Specified by:

getGroupID in interface IUIGroupCommand

Returns:

The groupID 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

getGroupCommandsList

public UIBaseCommandList getGroupCommandsList()

Gets the groupCommandsList attribute of the UIGroupCommand object

Specified by:

getGroupCommandsList in interface IUIGroupCommand

Returns:

The groupCommandsList value

setGroupCommandsList

public void setGroupCommandsList(UIBaseCommandList groupCommandsList)

Sets the groupCommandsList attribute of the UIGroupCommand object

Specified by:

setGroupCommandsList in interface IUIGroupCommand

Parameters:

groupCommandsList - The new groupCommandsList value

writePresentConfiguration

public void writePresentConfiguration(java.util.List list,
                                      int depth,
                                      IResourceContext context)

Description copied from interface: IUIGroupCommand

for debug purpose

Specified by:

writePresentConfiguration in interface IUIGroupCommand

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

Parameters:

list -

depth -

context -

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

getListWithReplaceCommands

public UIBaseCommandList getListWithReplaceCommands(IResource resource,
                                                    AbstractProxyControl proxy)

Description copied from interface: IUIGroupCommand

Parses the commans list and

Specified by:

getListWithReplaceCommands in interface IUIGroupCommand

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

Parameters:

resource - the IResource for which the command list is requiered

proxy - the proxy where the group is rendered

Returns:

The UIBaseCommandList resulted

getResourceCommands

public UIBaseCommandList getResourceCommands(IResource resource,
                                             AbstractProxyControl proxy)

Description copied from interface: IUIGroupCommand

Gets the IUIBaseCommands list for the givven resource

Specified by:

getResourceCommands in interface IUIGroupCommand

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

Parameters:

resource - the IResource for which the command list is requiered

proxy - the proxy where the group is rendered

Returns:

The UIBaseCommandList resulted

getLabel

public java.lang.String getLabel()

Gets the label attribute of the UICopyCommand object

Returns:

The label value

getComponent

public com.sapportals.htmlb.Component getComponent()

Gets the component attribute of the UIStatemanagementGroupCommand object

Specified by:

getComponent in interface IUIBaseCommand

Returns:

The component value

getTooltip

public java.lang.String getTooltip()

Gets the tooltip attribute of the IUIGroupCommand object

Returns:

The tooltip value

setLabel

public void setLabel(java.lang.String label)

Sets the label attribute of the UIGroupCommand object

Specified by:

setLabel in interface IUIGroupCommand

Parameters:

label - The new label value

setTooltip

public void setTooltip(java.lang.String tooltip)

Sets the tooltip attribute of the UIGroupCommand object

Specified by:

setTooltip in interface IUIGroupCommand

Parameters:

tooltip - The new tooltip 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)

Sets the proxy attribute of the UIStatemanagementGroupCommand object

Specified by:

setProxy in interface IUIBaseCommand

Parameters:

proxy - The new proxy value

setLabelBundleKey

public void setLabelBundleKey(java.lang.String groupLabelBundleKey)

Sets the labelBundleKey attribute of the IUIGroupCommand object

Specified by:

setLabelBundleKey in interface IUIGroupCommand

Parameters:

groupLabelBundleKey - The new labelBundleKey value

getLabelBundleKey

public java.lang.String getLabelBundleKey()

Gets the labelBundleKey attribute of the IUIGroupCommand object

Specified by:

getLabelBundleKey in interface IUIGroupCommand

Returns:

The labelBundleKey value

setTooltipBundleKey

public void setTooltipBundleKey(java.lang.String groupTooltipBundleKey)

Sets the tooltipBundleKey attribute of the IUIGroupCommand object

Specified by:

setTooltipBundleKey in interface IUIGroupCommand

Parameters:

groupTooltipBundleKey - The new tooltipBundleKey value

getTooltipBundleKey

public java.lang.String getTooltipBundleKey()

Gets the tooltipBundleKey attribute of the IUIGroupCommand object

Specified by:

getTooltipBundleKey in interface IUIGroupCommand

Returns:

The tooltipBundleKey value

setResourceBundle

public void setResourceBundle(ResourceBundles bundleFile)

Sets the bundleFile attribute of the UIGroupCommand object

Specified by:

setResourceBundle in interface IUIGroupCommand

Parameters:

bundleFile - The new bundleFile value

getResourceBundle

public ResourceBundles getResourceBundle()

Gets the bundleFile attribute of the UIGroupCommand object

Specified by:

getResourceBundle in interface IUIGroupCommand

Returns:

The bundleFile 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

getResourceContext

public IResourceContext getResourceContext()

Sets the resourceContext attribute of the UIGroupCommand object

Parameters:

context - The new resourceContext 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