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

Interface IWDAbstractButton

All Superinterfaces:

IWDAbstractCaption, IWDUIElement, IWDViewElement

All Known Subinterfaces:

IWDButton, IWDToolBarButton

public interface IWDAbstractButton

extends IWDAbstractCaption

Web Dynpro AbstractButton API. Abstract base class of all buttons.

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

Type Classification:

This interface is part of the Web Dynpro API, so applications may reference it or call any method of it, but they must not implement or extend it.

For a detailed explanation of API classification see the Web Dynpro Compatibility Guide

Field Summary

static String

DEFAULT_TEXT Default value of the text property is "".

Fields inherited from interface com.sap.tc.webdynpro.clientserver.uielib.standard.api.IWDAbstractCaption

DEFAULT_IMAGE_ALT, DEFAULT_IMAGE_FIRST, DEFAULT_IMAGE_SOURCE, DEFAULT_TEXT_DIRECTION

Fields inherited from interface com.sap.tc.webdynpro.progmodel.api.IWDUIElement

DEFAULT_ENABLED, DEFAULT_TOOLTIP, DEFAULT_VISIBLE

Method Summary

String	bindingOfText() Returns the binding path of the text property.
void	bindText(IWDAttributeInfo attributeInfo) Binds the text property to the context attribute specified by the given attribute info.
void	bindText(String path) Binds the text property to the context attribute specified by the given path.
IWDAction	getOnAction() Returns the action assigned to event onAction.
String	getText() Returns the value of the text property.
IWDParameterMapping	mappingOfOnAction() Returns the parameter mapping for event onAction.
void	setOnAction(IWDAction action) Assigns the given action to event onAction.
void	setText(String value) Sets the text property to the given value.

Methods inherited from interface com.sap.tc.webdynpro.clientserver.uielib.standard.api.IWDAbstractCaption

bindImageAlt, bindImageAlt, bindImageFirst, bindImageFirst, bindImageSource, bindImageSource, bindingOfImageAlt, bindingOfImageFirst, bindingOfImageSource, bindingOfTextDirection, bindTextDirection, bindTextDirection, getImageAlt, getImageFirst, getImageSource, getTextDirection, setImageAlt, setImageFirst, setImageSource, setTextDirection

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

bindEnabled, bindEnabled, bindingOfEnabled, bindingOfTooltip, bindingOfVisible, bindTooltip, bindTooltip, bindVisible, bindVisible, createLayoutData, getContainer, getEnabled, getLayoutData, getTooltip, getVisible, setEnabled, setTooltip, setVisible

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

destroy, getId, getView, requestFocus

Field Detail

DEFAULT_TEXT

public static final String DEFAULT_TEXT

Default value of the text property is "".

See Also:

Constant Field Values

Method Detail

getOnAction

public IWDAction getOnAction()

Returns the action assigned to event onAction. The action performed when the button is pressed.

Returns:

the action assigned to event onAction

See Also:

mappingOfOnAction()

setOnAction

public void setOnAction(IWDAction action)

Assigns the given action to event onAction.

Parameters:

action - the action assigned to the event

See Also:

getOnAction()

mappingOfOnAction

public IWDParameterMapping mappingOfOnAction()

Returns the parameter mapping for event onAction.

This event has no parameters.

Returns:

the parameter mapping for event onAction

See Also:

getOnAction()

bindText

public void bindText(String path)

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

Parameters:

path - the context path of the attribute to which the text property will be bound

bindText

public void bindText(IWDAttributeInfo attributeInfo)

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

Parameters:

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

bindingOfText

public String bindingOfText()

Returns the binding path of the text property.

Returns:

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

getText

public String getText()

Returns the value of the text property.

The initial value is null.

The text of the button.

Returns:

the current value of the text property

See Also:

setText(String)

setText

public void setText(String value)

Sets the text property to the given value.

Parameters:

value - the new value of the text property

See Also:

getText()