TopMostLayer

[ Class ]

Provides functions for an overlay. This area is always above the normal visualization and independent of scrolling.

A jQuery object with one element is passed to the TopMostLayer. This is positioned by the TopMostLayer within an HTMLDivElement, which has the width and height of the browser window. Common CSS attributes for the element are min-width, min-height, padding. To make it easier for the user, an element can be centered on the screen.

It is also possible to react when clicking on the darkened background or when resizing.

If a control adds an element to the TopMostLayer, this control is monitored. If the control is removed (detached) from the DOM, the element is also removed.

Separate functions without this monitoring are available for use outside controls (e.g. codebehind).

Static functions

Name	Description
add	Appends an HTML element (from a control) to the overlay area
remove	Removes an HTML element (from a control) from the overlay area
addEx	Appends an HTML element to the overlay area (codebehind)
removeEx	Removes an HTML element from the overlay area (codebehind)

Interfaces

Name	Description
IOptions	Options for the add/addEx() function.
IResizeResultObject	Callback parameter for resizing.
IElemRemoveResultObject	Callback parameters for removing.

	Available from version 1.10

Further Information