Widget extension, which can be used to add modality support to the base Widget class, through the Base.create method.
_afterFocusOnChangeDefault function called when focusOn Attribute is changed. Remove existing listeners and create new listeners.
_afterHostVisibleChangeModale
Default function that is called when visibility is changed on the widget.
e
EventFacade
The event facade of the change
_afterHostZIndexChangeModale
Default function that is called when z-index is changed on the widget.
e
EventFacade
The event facade of the change
_attachUIHandlesModalAttaches UI Listeners for "clickoutside" and "focusoutside" on the widget. When these events occur, and the widget is modal, focus is shifted back onto the widget.
_bindUIModalHooks up methods to be executed when the widget's visibility or z-index changes
This method in invoked after bindUI is invoked for the Widget class using YUI's aop infrastructure.
_blurBlurs the widget.
_detachUIHandlesModalDetaches all UI Listeners that were set in _attachUIHandlesModal from the widget.
_focusProvides mouse and tab focus to the widget's bounding box.
_GET_MASKReturns the mask if it exists on the page - otherwise creates a mask. There's only one mask on a page at a given time.
This method in invoked internally by the getter of the maskNode ATTR.
_getMaskNodeReturns the Y.Node instance of the maskNode
The Y.Node instance of the mask, as returned from WidgetModal._GET_MASK
_renderUIModalAdds modal class to the bounding box of the widget
This method in invoked after renderUI is invoked for the Widget class using YUI's aop infrastructure.
_repositionMasknextElem
Repositions the mask in the DOM for nested modality cases.
nextElem
Widget
The Y.Widget instance that will be visible in the stack once the current widget is closed.
_resyncMasknextElem
Resyncs the mask in the viewport for browsers that don't support fixed positioning
nextElem
Y.Widget
The Y.Widget instance that will be visible in the stack once the current widget is closed.
_syncUIModalSyncs the mask with the widget's current state, namely the visibility and z-index of the widget
This method in invoked after syncUI is invoked for the Widget class using YUI's aop infrastructure.
_uiSetHostVisibleModalWhether
Performs events attaching/detaching, stack shifting and mask repositioning based on the visibility of the widget
Whether
Boolean
the widget is visible or not
_uiSetHostZIndexModalZ-Index
Sets the z-index of the mask node.
Z-Index
Number
of the widget
isNestedReturns a boolean representing whether the current widget is in a "nested modality" state. This is done by checking the number of widgets currently on the stack.
ATTRSStatic property used to define the default attribute configuration introduced by WidgetModality.
STACKA stack of Y.Widget objects representing the current hierarchy of modal widgets presently displayed on the screen
focusOnAn array of objects corresponding to the nodes and events that will trigger a re-focus back on the widget. The implementer can supply an array of objects, with each object having the following properties:
eventName: (string, required): The eventName to listen to.
node: (Y.Node, optional): The Y.Node that will fire the event (defaults to the boundingBox of the widget)
By default, this attribute consists of two objects which will cause the widget to re-focus if anything outside the widget is clicked on or focussed upon.
focusOnChange
Fires when the value for the configuration attribute focusOn is
changed. You can listen for the event using the on method if you
wish to be notified before the attribute's value has changed, or
using the after method if you wish to be notified after the
attribute's value has changed.
e
EventFacade
maskNodeReturns a Y.Node instance of the node being used as the mask.
maskNodeChange
Fires when the value for the configuration attribute maskNode is
changed. You can listen for the event using the on method if you
wish to be notified before the attribute's value has changed, or
using the after method if you wish to be notified after the
attribute's value has changed.
e
EventFacade
modalWhether the widget should be modal or not.
modalChange
Fires when the value for the configuration attribute modal is
changed. You can listen for the event using the on method if you
wish to be notified before the attribute's value has changed, or
using the after method if you wish to be notified after the
attribute's value has changed.
e
EventFacade