Web Dynpro Button API - IWDButton (SAP Library

Web Dynpro Button API - IWDButton

Definition

The Button UI element simulates a pushbutton on the screen. The user can execute statements and actions by clicking the pushbutton.

Description of the UI Element Properties

· design
Describes the style of the Button UI element - for example, the button size or the highlighting of the button label.
The design property can be filled with the following values and is represented by the enumeration type WDButtonDesign.

Values	Display	Short Description
emphasized	size: standard	Displays the UI element with highlighted left edge.
standard	size: standard	Displays the UI element with default background and text color.

· size
Specifies an abstract size of the button UI element.
The size property can be filled with the following values and is represented by the enumeration type WDButtonSize.

Values	Display	Short Description
small	design: standard	Half of the default size is displayed.
standard	design: standard	A default size is displayed.

· width
Specifies the width of the Button UI element and can be specified in CSS units like em, ex, pixels, or percentage.

Note

Additional properties are defined in the corresponding superclasses. Refer to IWDAbstractButton, IWDAbstractCaption, IWDUIElement,.IWDViewElement..

Overview of Inherited and Additional Properties

Name	Interface	Type	Initial Value	Bindable	Value Required
design	IWDButton	WDButtonDesign	standard	bindable	No
enabled	IWDUIElement	boolean	true	bindable	No
imageAlt	IWDAbstractCaption	String (TranslatableText)		bindable	No
imageFirst	IWDAbstractCaption	boolean	true	bindable	No
imageSource	IWDAbstractCaption	String		bindable	No
size	IWDButton	WDButtonSize	standard	bindable	No
text	IWDAbstractButton	String (TranslatableText)		bindable	No
tooltip	IWDUIElement	String (TranslatableText)		bindable	No
visible	IWDUIElement	WDVisibility	visible	bindable	No
width	IWDButton	String	No	bindable	No

Events

For information about events, refer to the description of the Web Dynpro AbstractButton API.

Mobile Characteristics

The UI element Button supports the development of mobile applications for pocket PCs and BlackBerry wireless handhelds ( Structure link see Mobile Web Dynpro).

For BlackBerry wireless handhelds, the button is displayed as a link. If you assign the value emphasized to the design property, the link is displayed with a softkey. A softkey is a device-dependent and browser-dependent function key that is normally displayed at the bottom of the screen of the mobile end device. You can execute an action using a built-in device key for the softkey.

However, several properties supported in the desktop browser cannot be used. These include:

Variances of the properties

Properties	Pocket PC	BlackBerry wireless handheld
design	ignored	ignored
enabled	ignored	ignored
imageAlt	ignored	ignored
imageFirst	ignored	ignored
tooltip	ignored	ignored
width	ignored	ignored

Methods in the Web Dynpro IWDButton API

Method Name	Parameter	Return Value	Short Description
bindDesign	(String path)		Binds the value of the design property to the context element specified by the path.
bindingOfDesign		String	Returns the path of the context element to which the design property is bound. Returns NULL if no binding exists.
bindingOfSize		String	Returns the path of the context element to which the size property is bound. Returns NULL if no binding exists.
bindingOfWidth		String	Returns the path of the context element to which the width property is bound. Returns NULL if no binding exists.
bindSize	(String path)		Binds the size property to the context node specified by a path.
bindWidth	(String path)		Binds the value of the width property to the context element specified by the path.
getDesign		WDButtonDesign	Returns the value of the design property.
getSize		WDButtonSize	Returns the value of the size property.
getWidth		String	Returns the value of the width property.
setDesign	(WDButtonDesign value)		Sets the value of the design property.
setSize	(WDButtonSize value)		Sets the value of the size property.
setWidth	(String value)		Sets the value of the width property.

Additional methods are available using inheritance:

IWDAbstractButton, IWDAbstractCaption, IWDUIElement, IWDViewElement.

Note

For detailed documentation of all inherited methods, see the documentation for the relevant APIs.