Class RapidContext.Widget.Overlay

Extends: RapidContext.Widget

The overlay widget class. Used to provide a layer on top of the parent node, using a <div> HTML element. This widget is useful for disabling the user interface during an operation.

Source code: RapidContext_Widget_Overlay.js

Class Summary
 
Creates a new overlay widget.
Method Summary
 
setAttrs(attrs)
Updates the widget or HTML DOM node attributes.
Methods borrowed from class RapidContext.Widget:
addAll, addChildNode, addClass, animate, blurAll, destroy, disable, enable, getChildNodes, hasClass, hide, isDisabled, isHidden, removeAll, removeChildNode, removeClass, setStyle, show, toggleClass, uid
Class Detail
RapidContext.Widget.Overlay(attrs)
Creates a new overlay widget.
JavaScript:
var workOverlay = RapidContext.WidgetOverlay({ message: "Doing Stuff..." });
User Interface XML:
<Overlay id="workOverlay" message="Doing Stuff..." />
Parameters:
{Object} attrs
the widget and node attributes
{Boolean} attrs.loading Optional
the display loading icon flag, defaults to true
{String} attrs.message Optional
the overlay message text, defaults to Working...
{Boolean} attrs.dark Optional
the dark overlay flag, defaults to false
{Boolean} attrs.hidden Optional
the hidden widget flag, defaults to true
Returns:
{Widget} the widget DOM node
Method Detail
setAttrs(attrs)
Updates the widget or HTML DOM node attributes.
Parameters:
{Object} attrs
the widget and node attributes to set
{Boolean} attrs.loading Optional
the display loading icon flag
{String} attrs.message Optional
the overlay message text
{Boolean} attrs.hidden Optional
the hidden widget flag