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 ] ] ] )

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

Name	Type	get	set	Descripton
`alt`	`String`			The alternate text which is read out instead of the image when `Bindows` is in accessibility mode.
`loaded`	`Boolean`			Whether the image file is loaded
`uri`	`BiUri`			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`.

Name	Description
`getIconHtml`	This method is used to generate the HTML code used as the icon for `labels`.

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.

Name	Description
`fromUri`	Returns a new `BiImage` from the given URI

Name	Type	Descripton
`BLANK_IMAGE_URI`	`String`	The location of a blank image

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

This method is used to generate the HTML code used as the icon for labels.

object.getIconHtml ( bHasText,bEnabled,sIconPosition,nIconTextGap [ ,sClassName ] )

Name	Type	Optional	Default	Descripton
`bHasText`	`Boolean`			Whether the icon should be used with text
`bEnabled`	`Boolean`			Whether the icon is enabled
`sIconPosition`	`String`			The position of the icon. Valid values are "left", "right" "top" and "bottom".
`nIconTextGap`	`Number`			The gap between the text and the icon.
`sClassName`	`String`			Optional class name to put on the HTML element representing the icon.

String

Returns a new BiImage from the given URI

BiImage . fromUri ( oUri )

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