BiPopup

A popup is a component that is displayed on top of all other components and is not limited by the parent components view port.

This class extends BiLabel and therefore all methods and fields available for BiLabel are also available for BiPopup .

Constructor

new BiPopup ( [ sText ] )

Parameters

Name	Type	Optional	Default	Descripton
sText	String		""	The text to show on the popup

Properties

Name	Type	get	set	Descripton
allowOffScreen	Boolean			Whether to allow the popup to be positioned off screen
autoHide	Boolean			Whether to let the system decide when to hide the popup. Setting this to false gives you better control but it also requires you to handle the closing of the popup.
clientLeft	Number			The position relative to the browser client area. Note that this can be both set and get for popups.
clientTop	Number			The position relative to the browser client area. Note that this can be both set and get for popups.
hideTimeStamp	Date			The time when the popup was hidden. This can be useful to find out whether the popup was just hidden.
opaque	Boolean			Whether to make the popup opaque. An opaque popup will not let plugins and other windowed controls show through. However, there is a price to this. This is achieved using an internal iframe and this makes the popup heavier and slower.
screenLeft	Number			The position relative to the screen. Note that this can be both set and get for popups.
screenTop	Number			The position relative to the screen. Note that this can be both set and get for popups.
showTimeStamp	Date			The time when the popup was shown.

Methods

Name	Description
bringToFront	Makes so that the popup is displayed on top of all other shown popups.
positionRelativeToComponent	Sets the popup to be positioned relative to another component. Valid values for the direction are vertical and horizontal.
sendToBack	Makes so that the current popup is displayed behind all other shown popups

Events

Name	Type	Bubbles	Descripton
beforeshow	BiEvent		Fires before the popup is shown. This is a good place to change the content of the popup and set the preferred size if the default preferred size is not wanted
hide	BiEvent		Fires when the popup is hidden
show	BiEvent		Fires when the popup is shown

Static Methods

None.

Static Fields

None.

Remarks

None.

Method Details

bringToFront

Makes so that the popup is displayed on top of all other shown popups.

Syntax

object.bringToFront ( )

Parameters

No arguments.

Return Type

void

positionRelativeToComponent

Sets the popup to be positioned relative to another component. Valid values for the direction are vertical and horizontal.

Syntax

object.positionRelativeToComponent ( oComponent [ ,sDir ] )

Parameters

Name	Type	Optional	Default	Descripton
oComponent	BiComponent			The component to position the popup relative to
sDir	String		"vertical"	The direction relative to the component

Return Type

void

sendToBack

Makes so that the current popup is displayed behind all other shown popups

Syntax

object.sendToBack ( )

Parameters

No arguments.

Return Type

void