BiImage

This class is used for showing images.

Supported image types are GIF, JPEG and PNG (including support for 32-bit RGBA).

This class extends BiComponent and therefore all methods and fields available for BiComponent are also available for BiImage .

Constructor

new BiImage ( [ oUri [ ,nWidth [ ,nHeight ] ] ] )

Parameters

Name Type Optional Default Descripton
oUri BiUri checked The location of the file relative to the ADF path.
nWidth Number checked The width of the image in pixels. A value of null gives the component its desired width.
nHeight Number checked The height of the image in pixels. A value of null gives the component its desired height.

Properties

Name Type get set Descripton
alt String checked checked The alternate text which is read out instead of the image when Bindows is in accessibility mode.
loaded Boolean checked Whether the image file is loaded
uri BiUri checked checked The location of the image file. If this is set to a string a new URI is created from that string relative to the ADF path.

Methods

None.

Events

Name Type Bubbles Descripton
error BiEvent Fires when the image failed to load.
load BiEvent Fires when the image loads. Note that the image file may be loaded before the constructor finishes and you should not only rely on this event but also use loaded property.

Static Methods

Name Description
fromUri Returns a new BiImage from the given URI

Static Fields

Name Type Descripton
BLANK_IMAGE_URI String The location of a blank image

Remarks

When using PNG images it is recommended not to change the opacity because Internet Explorer cannot support the combination of these.

Static Method Details

fromUri

Returns a new BiImage from the given URI

Syntax

BiImage
 .
 fromUri
 (
 oUri
 )
 

Parameters

Name Type Optional Default Descripton
oUri BiUri The location of the image file

Return Type

BiImage