Web Dynpro API Documentation

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!


Field Summary
static java.lang.String DEFAULT_TEXT
          Default value of property text.
 
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
 java.lang.String bindingOfText()
          Binding path of property text.
 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.
 IWDAction getOnAction()
          Returns the action to which the event onAction is mapped.
 java.lang.String getText()
          Returns the value of the text property.
 IWDParameterMapping mappingOfOnAction()
          Returns the parameter mapping of event onAction.
 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.
 
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
getId, getView, requestFocus
 

Field Detail

DEFAULT_TEXT

public static final java.lang.String DEFAULT_TEXT
Default value of property text.
Method Detail

getOnAction

public IWDAction getOnAction()
Returns the action to which the event onAction is mapped. The action performed when the button is pressed.
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:
Returns:
parameter mapping list.
See Also:
getOnAction()

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 null. The text of the button.
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()

Web Dynpro API Documentation

Copyright © 2004 SAP AG. Automatically generated Thu Mar 3 2005, 22:15