Class MochiKit.Widget.Overlay
Extends
MochiKit.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.
Defined in: Widget.js.
Constructor Attributes | Constructor Name and Description |
---|---|
MochiKit.Widget.Overlay(attrs)
Creates a new overlay widget.
|
- Fields borrowed from class MochiKit.Widget:
- _id, Classes
Method Attributes | Method Name and Description |
---|---|
setAttrs(attrs)
Updates the widget or HTML DOM node attributes.
|
- Methods borrowed from class MochiKit.Widget:
- _animQueueId, _createWidgetTreeElem, _eventHandler, _widgetMixin, addAll, addChildNode, addClass, animate, blurAll, createWidget, createWidgetTree, destroy, destroyWidget, emitSignal, getChildNodes, hasClass, hide, isFormField, isHidden, isWidget, removeAll, removeChildNode, removeClass, setStyle, show, toggleClass
Class Detail
MochiKit.Widget.Overlay(attrs)
Creates a new overlay widget.
- 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..."
- {Widget} ... Optional
- the child widgets or DOM nodes
- 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