com.sap.tc.webdynpro.clientserver.uielib.standard.api
Interface IWDMenuActionItem

All Superinterfaces:

IWDMenuItem, IWDViewElement

public interface IWDMenuActionItem

extends IWDMenuItem

Web Dynpro MenuActionItem API. The MenuActionItem element is a subelement of the MenuItem element. You can use this subelement to define an action for a menu item (or MenuItem object). You can link this view element to a graphic using the imageSource property.

This type can be called by applications using Web Dynpro, but DO NOT EXTEND OR IMPLEMENT IT!

Field Summary

static boolean	DEFAULT_ENABLED Default value of property enabled.
static java.lang.String	DEFAULT_IMAGE_SOURCE Default value of property imageSource.
static java.lang.String	DEFAULT_TEXT Default value of property text.
static WDTextDirection	DEFAULT_TEXT_DIRECTION Default value of property textDirection.

Method Summary

void	bindEnabled(IWDAttributeInfo attributeInfo) Binds property enabled to the context attribute specified by the given attribute info.
void	bindEnabled(java.lang.String path) Binds property enabled to the context attribute specified by path.
void	bindImageSource(IWDAttributeInfo attributeInfo) Binds property imageSource to the context attribute specified by the given attribute info.
void	bindImageSource(java.lang.String path) Binds property imageSource to the context attribute specified by path.
java.lang.String	bindingOfEnabled() Binding path of property enabled.
java.lang.String	bindingOfImageSource() Binding path of property imageSource.
java.lang.String	bindingOfText() Binding path of property text.
java.lang.String	bindingOfTextDirection() Binding path of property textDirection.
void	bindText(IWDAttributeInfo attributeInfo) Binds property text to the context attribute specified by the given attribute info.
void	bindText(java.lang.String path) Binds property text to the context attribute specified by path.
void	bindTextDirection(IWDAttributeInfo attributeInfo) Binds property textDirection to the context attribute specified by the given attribute info.
void	bindTextDirection(java.lang.String path) Binds property textDirection to the context attribute specified by path.
boolean	getEnabled() Returns the value of the enabled property.
java.lang.String	getImageSource() Returns the value of the imageSource property.
IWDAction	getOnAction() Returns the action to which the event onAction is mapped.
java.lang.String	getText() Returns the value of the text property.
WDTextDirection	getTextDirection() Returns the value of the textDirection property.
IWDParameterMapping	mappingOfOnAction() Returns the parameter mapping of event onAction.
void	setEnabled(boolean value) Sets property enabled to the new value.
void	setImageSource(java.lang.String value) Sets property imageSource to the new value.
void	setOnAction(IWDAction action) Maps the event onAction to the given action.
void	setText(java.lang.String value) Sets property text to the new value.
void	setTextDirection(WDTextDirection value) Sets property textDirection to the new value.

Methods inherited from interface com.sap.tc.webdynpro.progmodel.api.IWDViewElement

getId, getView, requestFocus

Field Detail

DEFAULT_ENABLED

public static final boolean DEFAULT_ENABLED

Default value of property enabled.

DEFAULT_IMAGE_SOURCE

public static final java.lang.String DEFAULT_IMAGE_SOURCE

Default value of property imageSource.

DEFAULT_TEXT

public static final java.lang.String DEFAULT_TEXT

Default value of property text.

DEFAULT_TEXT_DIRECTION

public static final WDTextDirection DEFAULT_TEXT_DIRECTION

Default value of property textDirection.

Method Detail

getOnAction

public IWDAction getOnAction()

Returns the action to which the event onAction is mapped. This property contains the action that is executed when the user selects MenuActionItem element.

Returns:

the action to which the event is mapped

See Also:

mappingOfOnAction()

setOnAction

public void setOnAction(IWDAction action)

Maps the event onAction to the given action.

Parameters:

action - the action for the event

See Also:

getOnAction()

mappingOfOnAction

public IWDParameterMapping mappingOfOnAction()

Returns the parameter mapping of event onAction.

To be accessible in a view controller, a UI element event parameter has to be mapped to a controller event handler parameter. This is done by defining a parameter mapping.

Event parameters:

• none

Returns:

parameter mapping list.

See Also:

getOnAction()

bindEnabled

public void bindEnabled(java.lang.String path)

Binds property enabled to the context attribute specified by path.

Parameters:

path - the path of the context attribute to which the enabled property is bound

bindEnabled

public void bindEnabled(IWDAttributeInfo attributeInfo)

Binds property enabled to the context attribute specified by the given attribute info.

Parameters:

attributeInfo - the info of the context attribute to which the enabled property is bound

bindingOfEnabled

public java.lang.String bindingOfEnabled()

Binding path of property enabled.

Returns:

the path of the context attribute to which the enabled is currently bound

getEnabled

public boolean getEnabled()

Returns the value of the enabled property. The initial value is true. Specifies whether the menu item is selectable.

Returns:

the current value of the enabled property

See Also:

setEnabled(boolean)

setEnabled

public void setEnabled(boolean value)

Sets property enabled to the new value.

Parameters:

value - the new value of the enabled property

See Also:

getEnabled()

bindImageSource

public void bindImageSource(java.lang.String path)

Binds property imageSource to the context attribute specified by path.

Parameters:

path - the path of the context attribute to which the imageSource property is bound

bindImageSource

public void bindImageSource(IWDAttributeInfo attributeInfo)

Binds property imageSource to the context attribute specified by the given attribute info.

Parameters:

attributeInfo - the info of the context attribute to which the imageSource property is bound

bindingOfImageSource

public java.lang.String bindingOfImageSource()

Binding path of property imageSource.

Returns:

the path of the context attribute to which the imageSource is currently bound

getImageSource

public java.lang.String getImageSource()

Returns the value of the imageSource property. The initial value is "". Specifies the Web address (URL) of the graphic to be displayed.

Returns:

the current value of the imageSource property

See Also:

setImageSource(String)

setImageSource

public void setImageSource(java.lang.String value)

Sets property imageSource to the new value.

Parameters:

value - the new value of the imageSource property

See Also:

getImageSource()

bindText

public void bindText(java.lang.String path)

Binds property text to the context attribute specified by path.

Parameters:

path - the path of the context attribute to which the text property is bound

bindText

public void bindText(IWDAttributeInfo attributeInfo)

Binds property text to the context attribute specified by the given attribute info.

Parameters:

attributeInfo - the info of the context attribute to which the text property is bound

bindingOfText

public java.lang.String bindingOfText()

Binding path of property text.

Returns:

the path of the context attribute to which the text is currently bound

getText

public java.lang.String getText()

Returns the value of the text property. The initial value is "". Describes the text to be displayed.

Returns:

the current value of the text property

See Also:

setText(String)

setText

public void setText(java.lang.String value)

Sets property text to the new value.

Parameters:

value - the new value of the text property

See Also:

getText()

bindTextDirection

public void bindTextDirection(java.lang.String path)

Binds property textDirection to the context attribute specified by path.

Parameters:

path - the path of the context attribute to which the textDirection property is bound

bindTextDirection

public void bindTextDirection(IWDAttributeInfo attributeInfo)

Binds property textDirection to the context attribute specified by the given attribute info.

Parameters:

attributeInfo - the info of the context attribute to which the textDirection property is bound

bindingOfTextDirection

public java.lang.String bindingOfTextDirection()

Binding path of property textDirection.

Returns:

the path of the context attribute to which the textDirection is currently bound

getTextDirection

public WDTextDirection getTextDirection()

Returns the value of the textDirection property. The initial value is WDTextDirection.INHERIT. Determines the direction of displayed text.

Returns:

the current value of the textDirection property

See Also:

setTextDirection(WDTextDirection)

setTextDirection

public void setTextDirection(WDTextDirection value)

Sets property textDirection to the new value.

Parameters:

value - the new value of the textDirection property

See Also:

getTextDirection()