Start of Content Area

Object documentation Web Dynpro Image API - IWDImage  Locate the document in its SAP Library structure

Definition

The UI element Image enables you to integrate graphics into the Web application in a format that is processed by the Web Server – for example, GIF, JPG, and PNG format. Height and width of the graphic can be specified using the properties height and width. The graphic is displayed without borders.

Use

When using an Image UI element, you should always add a label to ensure accessibility.

Description of UI Element Properties

        alt
Describes an alternative text that is displayed when the graphic cannot be opened or found.

        border
Specifies whether or not the graphic is displayed with borders.

        height
Specifies the height of the graphic. You can specify the height in CSS units like em, ex, pixels, or percentage.

        source
Specifies the Web address (URL) of the graphic used for the data transfer to the UI element.

        width
Specifies the width of the graphic. You can specify the width in CSS units like em, ex, pixel, or percentage.

Overview of Inherited and Additional Properties

Name

Interface

Type

Initial Value

Bindable

Value Required

alt

IWDImage

String (TranslatableText)

 

bindable

Yes

border

IWDImage

int

0

bindable

No

enabled

IWDUIElement

boolean

true

bindable

No

height

IWDImage

String (CSS size)

 

bindable

No

source

IWDImage

String

 

bindable

Yes

tooltip

IWDUIElement

String (TranslatableText)

 

bindable

No

visible

IWDUIElement

WDVisibility

visible

bindable

No

width

IWDImage

String (CSS size)

 

bindable

No

Note

The inherited enabled property is ignored and does not affect the browser.

Mobile Characteristics

The UI element Image supports the development of mobile applications for pocket PCs, BlackBerry wireless handhelds, and Nokia Series 80 devices (see Mobile Web Dynpro). The graphic format WBMP, which is normally used for mobile end devices, is supported by all mobile end devices and displays the images in black and white only. The graphic format GIF is only supported by the BlackBerry wireless handhelds of the series 7200.

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

Variances of the properties

Properties

Pocket PC

BlackBerry Wireless Handheld

Nokia Series 80 Devices

Old

ignored

ignored

supported

Enabled

ignored

ignored

ignored

Tooltip

ignored

ignored

ignored

Methods in the Web Dynpro IWDImage API

Method Name

Parameter

Return Value

Short Description

bindAlt

(String path)

 

Binds the value of the alt property to the context element specified by the path.

bindBorder

(String path)

 

Binds the border property to the context node specified by a path.

bindHeight

(String path)

 

Binds the value of the height property to the context element specified by the path.

bindingOfAlt

 

String

Returns the path of the context attribute to which the alt property is bound. Returns NULL if no binding exists.

bindingOfBorder

 

String

Returns the path of the context element to which the border property is bound. Returns NULL if no binding exists.

bindingOfHeight

 

String

Returns the path of the context element to which the height property is bound. Returns NULL if no binding exists.

bindingOfSource

 

String

Returns the path of the context element to which the source 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.

bindSource

(String path)

 

Binds the value of the source property to the context element specified by the path.

bindWidth

(String path)

 

Binds the value of the width property to the context element specified by the path.

getAlt

 

String

Returns the value of the alt property.

getBorder

 

int

Returns the value of the border property.

getHeight

 

String

Returns the value of the height property.

getSource

 

String

Returns the value of the source property.

getWidth

 

String

Returns the value of the width property.

setAlt

(String value)

 

Sets the value of the alt property.

setBorder

(int value)

 

Sets the value of the border property.

setHeight

(String value)

 

Sets the value of the height property.

setSource

(String value)

 

Sets the value of the source property.

setWidth

(String value)

 

Sets the value of the width property.

Additional methods described in the following APIs are available using inheritance:

IWDUIElement, IWDViewElement.

Note

For further information about all inherited methods, refer to the documentation for the relevant APIs.

  

  

 

End of Content Area