com.sap.tc.webdynpro.progmodel.api
Interface IWDAction

public interface IWDAction

Offers access to actions of a controller.

Version:

$Id: //tc/WebDynproRuntime/630_VAL_REL/src/_webdynpro_progmodel/java/com/sap/tc/webdynpro/progmodel/api/IWDAction.java#1 $

Method Summary

IWDParameters	getActionParameters() Get access to action parameters for this action's next eventhandler call.
IWDController	getController() method returns this action's controller.
java.lang.String	getImage() Returns this action's image url.
java.lang.String	getText() Returns this action's descriptive localized text.
boolean	isEnabled() method tells whether the action is currently enabled.
boolean	isValidating() This method tells whether the action is a validating actions.
void	setEnabled(boolean enabled) Determines whether the action is enabled.
void	setImage(java.lang.String imageUrl) Set this action's image url.
void	setText(java.lang.String text) Set this action's descriptive localized text.

Method Detail

getController

public IWDController getController()

method returns this action's controller.

Returns:

this action's IWDController

getText

public java.lang.String getText()

Returns this action's descriptive localized text.

Returns:

Action's text

setText

public void setText(java.lang.String text)

Set this action's descriptive localized text.

getImage

public java.lang.String getImage()

Returns this action's image url.

Returns:

image url

setImage

public void setImage(java.lang.String imageUrl)

Set this action's image url.

isEnabled

public boolean isEnabled()

method tells whether the action is currently enabled.

Returns:

whether the action is currently enabled

setEnabled

public void setEnabled(boolean enabled)

Determines whether the action is enabled.

Parameters:

enabled - flag which indicates whether the action is enabled

isValidating

public boolean isValidating()

This method tells whether the action is a validating actions.

Returns:

true, if this action is validating.

getActionParameters

public IWDParameters getActionParameters()

Get access to action parameters for this action's next eventhandler call. This method is only needed in case a non validating actions returns a validatating action and the returned validating action needs parameters. In that case it is legal to fill the parameters of the returned validating action within the non validating event handler. In all other cases this method does nothing

Parameters:

name - is the name of the parameter

value - is the parameter value.