Panel Class
+ + + + +A basic Panel Widget, which can be positioned based on Page XY co-ordinates and +is stackable (z-index support). It also provides alignment and centering support +and uses a standard module format for it's content, with header, body and footer +section support. It can be made modal, and has functionality to hide and focus +on different events. The header and footer sections can be modified to allow for +button support.
+Constructor
+Panel
+
+
+ ()
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ -
+
- Index + + +
- Methods + + +
- Properties + + +
- Attributes + + +
- Events + +
Item Index
+ + +Methods
+ +-
+
+
- + _addAttrs + + + + + +
- + _addLazyAttr + + + + + +
- + _addShimResizeHandlers + + + + + +
- + _addStdModContent + + + + + +
- + _afterAlignChange + + + + + +
- + _afterAlignOnChange + + + + + +
- + _afterBodyChange + + + + + +
- + _afterButtonsChange + + + + + +
- + _afterChildSelectedChange + + + + + +
- + _afterConstrainChange + + + + + +
- + _afterContentChangeButtons + + + + + +
- + _afterDefaultButtonChange + + + + + +
- + _afterFillHeightChange + + + + + +
- + _afterFocusOnChange + + + + + +
- + _afterFooterChange + + + + + +
- + _afterHeaderChange + + + + + +
- + _afterHideOnChange + + + + + +
- + _afterHostVisibleChangeAutohide + + + + + +
- + _afterHostVisibleChangeModal + + + + + +
- + _afterHostZIndexChangeModal + + + + + +
- + _afterShimChange + + + + + +
- + _afterVisibleChangeButtons + + + + + +
- + _afterXYChange + + + + + +
- + _afterZIndexChange + + + + + +
- + _aggregateAttrs + + + + + +
- + _applyParsedConfig + + + + + +
- + _applyParser + + + + + +
- + _applyStdModParsedConfig + + + + + +
- + _attachPosAlignUIHandles + + + + + +
- + _attachUIHandlesAutohide + + + + + +
- + _attachUIHandlesModal + + + + + +
- + _attrCfgHash + + + + + +
- + _baseDestroy + + + + + +
- + _baseInit + + + + + +
- + _bindAttrUI + + + + + +
- + _bindDOM + + + + + +
- + _bindUI + + + + + +
- + _bindUIAutohide + + + + + +
- + _bindUIButtons + + + + + +
- + _bindUIChild + + + + + +
- + _bindUIModal + + + + + +
- + _bindUIPosAlign + + + + + +
- + _bindUIPosConstrained + + + + + +
- + _bindUIPosition + + + + + +
- + _bindUIStack + + + + + +
- + _bindUIStdMod + + + + + +
- + _blur + + + + + +
- + _cloneDefaultValue + + + + + +
- + _constrain + + + + + +
- + _constrainOnXYChange + + + + + +
- + _createButton + + + + + +
- + _createUIEvent + + + + + +
- + _defAttrChangeFn + + + + + +
- + _defaultCB + + + + + +
- + _defDestroyFn + + + + + +
- + _defInitFn + + + + + +
- + _defRenderFn + + + + + +
- + _destroyBox + + + + + +
- + _destroyHierarchy + + + + + +
- + _destroyShim + + + + + +
- + _destroyUIEvents + + + + + +
- + _detachPosAlignUIHandles + + + + + +
- + _detachStackHandles + + + + + +
- + _detachUIHandlesAutohide + + + + + +
- + _detachUIHandlesModal + + + + + +
- + _doAlign + + + + + +
- + _eraseStdMod + + + + + +
- + _fillHeight + + + + + +
- + _filterAdHocAttrs + + + + + +
- + _filterAttrCfgs + + + + + +
- + _filterUIEvent + + + + + +
- + _findStdModSection + + + + + +
- + _fireAttrChange + + + + + +
- + _focus + + + + + +
- + _getAttr + + + + + +
- + _getAttrCfg + + + + + +
- + _getAttrCfgs + + + + + +
- + _getAttrInitVal + + + + + +
- + _getAttrs + + + + + +
- + _getButtonContainer + + + + + +
- + _getButtonDefault + + + + + +
- + _getButtonName + + + + + +
- + _getButtons + + + + + +
- + _getClasses + + + + + +
- + _getFullType + + + + + +
- + _getHtmlParser + + + + + +
- + _getMaskNode + + + + + +
- + _getNodeToParse + + + + + +
- + _getPreciseHeight + + + + + +
- + _getRegion + + + + + +
- + _getShimTemplate + + + + + +
- + _getSrcNode + + + + + +
- + _getStateVal + + + + + +
- + _getStdModContent + + + + + +
- + _getStdModTemplate + + + + + +
- + _getStrings + + + + + +
- + _getType + + + + + +
- + _getUIEventNode + + + + + +
- + _getX + + + + + +
- + _getY + + + + + +
- + _guid + + + + + +
- + _initAttrHost + + + + + +
- + _initAttribute + + + + + +
- + _initAttrs + + + + + +
- + _initBase + + + + + +
- + _initHierarchy + + + + + +
- + _initHierarchyData + + + + + +
- + _initUIEvent + + + + + +
- + _insertStdModSection + + + + + +
- + _isLazyAttr + + + + + +
- + _isUIEvent + + + + + +
- + _mapButton + + + + + +
- + _mapButtons + + + + + +
- + _mapInstance + + + + + +
- + _mergeButtonConfig + + + + + +
- + _monitor + + + + + +
- + _normAttrVals + + + + + +
- + _onDocFocus + + + + + +
- + _onDocMouseDown + + + + + +
- + _parseButtons + + + + + +
- + _parseStdModHTML + + + + + +
- + _parseType + + + + + +
- + _parseZIndex + + + + + +
- + _preInitEventCfg + + + + + +
- + _preventOverlap + + + + + +
- + _protectAttrs + + + + deprecated + + + +
- + _publish + + + + + +
- + _removeLoadingClassNames + + + + + +
- + _renderBox + + + + + +
- + _renderBoxClassNames + + + + + +
- + _renderShim + + + + + +
- + _renderShimDeferred + + + + + +
- + _renderStdMod + + + + + +
- + _renderUI + + + + + +
- + _renderUIModal + + + + + +
- + _renderUIPosition + + + + + +
- + _renderUIStack + + + + + +
- + _renderUIStdMod + + + + + +
- + _repositionMask + + + + + +
- + _resyncMask + + + + + +
- + _set + + + + + +
- + _setAlignCenter + + + + + +
- + _setAttr + + + + + +
- + _setAttrs + + + + + +
- + _setAttrUI + + + + + +
- + _setAttrVal + + + + + +
- + _setBB + + + + + +
- + _setBox + + + + + +
- + _setButtons + + + + + +
- + _setCB + + + + + +
- + _setConstrain + + + + + +
- + _setStateVal + + + + + +
- + _setStrings + + + + + +
- + _setX + + + + + +
- + _setY + + + + + +
- + _setZIndex + + + + + +
- + _strSetter + + + + + +
- + _syncAttrUI + + + + + +
- + _syncUI + + + + + +
- + _syncUIAutohide + + + + + +
- + _syncUIButtons + + + + + +
- + _syncUIChild + + + + + +
- + _syncUIModal + + + + + +
- + _syncUIPosAlign + + + + + +
- + _syncUIPosition + + + + + +
- + _syncUIStack + + + + + +
- + _syncUIStdMod + + + + + +
- + _uiInsertButton + + + + + +
- + _uiRemoveButton + + + + + +
- + _uiSetAlign + + + + + +
- + _uiSetButtons + + + + + +
- + _uiSetChildSelected + + + + + +
- + _uiSetDefaultButton + + + + + +
- + _uiSetDim + + + + + +
- + _uiSetDisabled + + + + + +
- + _uiSetFillHeight + + + + + +
- + _uiSetFocused + + + + + +
- + _uiSetHeight + + + + + +
- + _uiSetHostVisibleAutohide + + + + + +
- + _uiSetHostVisibleModal + + + + + +
- + _uiSetHostZIndexModal + + + + + +
- + _uiSetShim + + + + + +
- + _uiSetStdMod + + + + + +
- + _uiSetTabIndex + + + + + +
- + _uiSetVisible + + + + + +
- + _uiSetVisibleButtons + + + + + +
- + _uiSetVisiblePosAlign + + + + + +
- + _uiSetWidth + + + + + +
- + _uiSetXY + + + + + +
- + _uiSetZIndex + + + + + +
- + _uiSizeCB + + + + + +
- + _unbindDOM + + + + + +
- + _unbindUI + + + + + +
- + _unMapButton + + + + + +
- + _updateContentButtons + + + + + +
- + _updateDefaultButton + + + + + +
- + _validateFillHeight + + + + + +
- + _validateXY + + + + + +
- + _validTabIndex + + + + + +
- + addAttr + + + + + +
- + addAttrs + + + + + +
- + addButton + + + + + +
- + addTarget + + + + + +
- + after + + + + + +
- + align + + + + + +
- + ancestor + + + + + +
- + attrAdded + + + + + +
- + before + + + + + +
- + bindUI + + + + + +
- + blur + + + + + +
- + bubble + + + + + +
- + centered + + + + + +
- + constrain + + + + + +
- + destroy + + + + + +
- + destructor + + + + + +
- + detach + + + + + +
- + detachAll + + + + + +
- + disable + + + + + +
- + enable + + + + + +
- + enable or disable constraints listeners + + + + + +
- + fillHeight + + + + + +
- + fire + + + + + +
- + focus + + + + + +
- + get + + + + + +
- + getAttrs + + + + + +
- + getButton + + + + + +
- + getClassName + + + + + +
- + getConstrainedXY + + + + + +
- + getDefaultLocale + + + + + +
- + getEvent + + + + + +
- + getSkinName + + + + + +
- + getStdModNode + + + + + +
- + getString + + + + deprecated + + + +
- + getStrings + + + + deprecated + + + +
- + getTargets + + + + + +
- + hide + + + + + +
- + init + + + + + +
- + initializer + + + + + +
- + isNested + + + + + +
- + isRoot + + + + + +
- + modifyAttr + + + + + +
- + move + + + + + +
- + next + + + + + +
- + on + + + + + +
- + once + + + + + +
- + onceAfter + + + + + +
- + parseType + + + + + +
- + previous + + + + + +
- + publish + + + + + +
- + removeAttr + + + + + +
- + removeButton + + + + + +
- + removeTarget + + + + + +
- + render + + + + + +
- + renderer + + + + + +
- + renderUI + + + + + +
- + reset + + + + + +
- + set + + + + + +
- + setAttrs + + + + + +
- + setStdModContent + + + + + +
- + show + + + + + +
- + sizeShim + + + + + +
- + subscribe + + + + deprecated + + + +
- + syncUI + + + + + +
- + syncXY + + + + + +
- + toString + + + + + +
- + unsubscribe + + + + deprecated + + + +
- + unsubscribeAll + + + + deprecated + + + +
Properties
+ +-
+
+
- + _allowAdHocAttrs + + + + + +
- + _buttonsHandles + + + + + +
- + _buttonsMap + + + + + +
- + _defaultButton + + + + + +
- + _posAlignUIHandles + + + + + +
- + _UI_ATTRS + + + + + +
- + BOUNDING_TEMPLATE + + + + + +
- + BUTTONS + + + + + +
- + BUTTONS_TEMPLATE + + + + + +
- + CONTENT_TEMPLATE + + + + + +
- + DEF_PARENT_NODE + + + + + +
- + DEF_UNIT + + + + + +
- + DEFAULT_BUTTONS_SECTION + + + + + +
- + name + + + + deprecated + + + +
- + STACK + + + + + +
- + UI_EVENTS + + + + + +
Attributes
+ +-
+
+
- + align + + +
- + alignOn + + +
- + bodyContent + + +
- + boundingBox + + +
- + buttons + + +
- + centered + + +
- + constrain + + +
- + contentBox + + +
- + defaultButton + + +
- + destroyed + + +
- + disabled + + +
- + fillHeight + + +
- + focused + + +
- + focusOn + + +
- + footerContent + + +
- + headerContent + + +
- + height + + +
- + hideOn + + +
- + id + + +
- + initialized + + +
- + locale + + +
- + maskNode + + +
- + modal + + +
- + preventOverlap + + +
- + render + + +
- + rendered + + +
- + shim + + +
- + srcNode + + +
- + strings + + +
- + tabIndex + + +
- + visible + + +
- + width + + +
- + x + + +
- + xy + + +
- + y + + +
- + zIndex + + +
Events
+ +-
+
+
- + destroy + + + + + +
- + init + + + + + +
- + render + + + + + +
- + widget:contentUpdate + + + + + +
Methods
+ + +_addAttrs
+
+
+ -
+
+
-
+
+
cfgs+ +
+
+ -
+
+
values+ +
+
+ -
+
+
lazy+ +
+
+
Implementation behind the public addAttrs method.
+ +This method is invoked directly by get if it encounters a scenario +in which an attribute's valueFn attempts to obtain the +value an attribute in the same group of attributes, which has not yet +been added (on demand initialization).
+Parameters:
+ +-
+
+
-
+
+
cfgs+ Object + + + + +++ + +An object with attribute name/configuration pairs.
+
+
+ -
+
+
values+ Object + + + + +++ + +An object with attribute name/value pairs, defining the initial values to apply. +Values defined in the cfgs argument will be over-written by values in this argument unless defined as read only.
+
+
+ -
+
+
lazy+ Boolean + + + + +++ + +Whether or not to delay the intialization of these attributes until the first call to get/set. +Individual attributes can over-ride this behavior by defining a lazyAdd configuration property in their configuration. +See addAttr.
+
+
+
_addLazyAttr
+
+
+ -
+
+
-
+
+
name+ +
+
+ -
+
+
[lazyCfg]+ +
+
+
Finishes initializing an attribute which has been lazily added.
+Parameters:
+ + +_addShimResizeHandlers
+
+
+ ()
+
+
+
+
+
+
+
+ private
+
+
+
+
+
+
+
+
+
+
+
+
+ Sets up event listeners to resize the shim when the size of the Widget changes.
+ ++NOTE: This method is only used for IE6 currently, since IE6 doesn't support a way to +resize the shim purely through CSS, when the Widget does not have an explicit width/height +set. +
+_addStdModContent
+
+
+ -
+
+
-
+
+
node+ +
+
+ -
+
+
children+ +
+
+ -
+
+
where+ +
+
+
Helper method to add content to a StdMod section node.
+The content is added either before, after or replaces the existing node content
+based on the value of the where argument.
Parameters:
+ +-
+
+
-
+
+
node+ Node + + + + +++ + +The section Node to be updated.
+
+
+ -
+
+
children+ Node | NodeList | String + + + + +++ + +The new content Node, NodeList or String to be added to section Node provided.
+
+
+ -
+
+
where+ String + + + + +++ + +Optional. Either WidgetStdMod.AFTER, WidgetStdMod.BEFORE or WidgetStdMod.REPLACE. +If not provided, the content will replace existing content in the Node.
+
+
+
_afterAlignChange
+
+
+ -
+
+
-
+
+
e+ +
+
+
Handles alignChange events by updating the UI in response to align
+Attribute changes.
Parameters:
+ +-
+
+
-
+
+
e+ EventFacade + + + + ++ ++ + +
+
+
_afterAlignOnChange
+
+
+ -
+
+
-
+
+
e+ +
+
+
Handles alignOnChange events by updating the alignment-syncing event
+handlers.
Parameters:
+ +-
+
+
-
+
+
e+ EventFacade + + + + ++ ++ + +
+
+
_afterBodyChange
+
+
+ -
+
+
-
+
+
e+ +
+
+
Default attribute change listener for the bodyContent attribute, responsible +for updating the UI, in response to attribute changes.
+Parameters:
+ +-
+
+
-
+
+
e+ EventFacade + + + + +++ + +The event facade for the attribute change
+
+
+
_afterButtonsChange
+
+
+ -
+
+
-
+
+
e+ +
+
+
Handles this widget's buttonsChange event which fires anytime the
+buttons attribute is modified.
Note: This method special-cases the buttons modifications caused by
+addButton() and removeButton(), both of which set the src property on
+the event facade to "add" and "remove" respectively.
Parameters:
+ +-
+
+
-
+
+
e+ EventFacade + + + + ++ ++ + +
+
+
_afterChildSelectedChange
+
+
+ -
+
+
-
+
+
event+ +
+
+
Default attribute change listener for the selected
+attribute, responsible for updating the UI, in response to
+attribute changes.
Parameters:
+ +-
+
+
-
+
+
event+ EventFacade + + + + +++ + +The event facade for the attribute change.
+
+
+
_afterConstrainChange
+
+
+ -
+
+
-
+
+
e+ +
+
+
After change listener for the "constrain" attribute, responsible +for updating the UI, in response to attribute changes.
+Parameters:
+ +-
+
+
-
+
+
e+ EventFacade + + + + +++ + +The event facade
+
+
+
_afterContentChangeButtons
+
+
+ -
+
+
-
+
+
e+ +
+
+
Handles this widget's headerContentChange, bodyContentChange,
+footerContentChange events by making sure the buttons remain rendered
+after changes to the content areas.
These events are very chatty, so extra caution is taken to avoid doing extra +work or getting into an infinite loop.
+Parameters:
+ +-
+
+
-
+
+
e+ EventFacade + + + + ++ ++ + +
+
+
_afterDefaultButtonChange
+
+
+ -
+
+
-
+
+
e+ +
+
+
Handles this widget's defaultButtonChange event by adding the
+"yui3-button-primary" CSS class to the new defaultButton and removing it
+from the old default button.
Parameters:
+ +-
+
+
-
+
+
e+ EventFacade + + + + ++ ++ + +
+
+
_afterFillHeightChange
+
+
+ -
+
+
-
+
+
e+ +
+
+
Default attribute change listener for the fillHeight attribute, responsible +for updating the UI, in response to attribute changes.
+Parameters:
+ +-
+
+
-
+
+
e+ EventFacade + + + + +++ + +The event facade for the attribute change
+
+
+
_afterFocusOnChange
+
+
+ ()
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Default function called when focusOn Attribute is changed. Remove existing listeners and create new listeners.
+_afterHeaderChange
+
+
+ -
+
+
-
+
+
e+ +
+
+
Default attribute change listener for the headerContent attribute, responsible +for updating the UI, in response to attribute changes.
+Parameters:
+ +-
+
+
-
+
+
e+ EventFacade + + + + +++ + +The event facade for the attribute change
+
+
+
_afterHideOnChange
+
+
+ ()
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Default function called when hideOn Attribute is changed. Remove existing listeners and create new listeners.
+_afterHostVisibleChangeAutohide
+
+
+ ()
+
+
+
+
+
+
+
+ protected
+
+
+
+
+
+
+
+
+
+
+
+
+ Default function called when the visibility of the widget changes. Determines +whether to attach or detach event listeners based on the visibility of the widget.
+_afterHostVisibleChangeModal
+
+
+ -
+
+
-
+
+
e+ +
+
+
Default function that is called when visibility is changed on the widget.
+Parameters:
+ +-
+
+
-
+
+
e+ EventFacade + + + + +++ + +The event facade of the change
+
+
+
_afterHostZIndexChangeModal
+
+
+ -
+
+
-
+
+
e+ +
+
+
Default function that is called when z-index is changed on the widget.
+Parameters:
+ +-
+
+
-
+
+
e+ EventFacade + + + + +++ + +The event facade of the change
+
+
+
_afterShimChange
+
+
+ -
+
+
-
+
+
e+ +
+
+
Default attribute change listener for the shim attribute, responsible +for updating the UI, in response to attribute changes.
+Parameters:
+ +-
+
+
-
+
+
e+ EventFacade + + + + +++ + +The event facade for the attribute change
+
+
+
_afterVisibleChangeButtons
+
+
+ -
+
+
-
+
+
e+ +
+
+
Handles this widget's visibleChange event by focusing the defaultButton
+if there is one.
Parameters:
+ +-
+
+
-
+
+
e+ EventFacade + + + + ++ ++ + +
+
+
_afterXYChange
+
+
+ -
+
+
-
+
+
e+ +
+
+
Default attribute change listener for the xy attribute, responsible +for updating the UI, in response to attribute changes.
+Parameters:
+ +-
+
+
-
+
+
e+ EventFacade + + + + +++ + +The event facade for the attribute change
+
+
+
_afterZIndexChange
+
+
+ -
+
+
-
+
+
e+ +
+
+
Default attribute change listener for the zIndex attribute, responsible +for updating the UI, in response to attribute changes.
+Parameters:
+ +-
+
+
-
+
+
e+ EventFacade + + + + +++ + +The event facade for the attribute change
+
+
+
_aggregateAttrs
+
+
+ -
+
+
-
+
+
allAttrs+ +
+
+
A helper method, used by _initHierarchyData to aggregate +attribute configuration across the instances class hierarchy.
+ +The method will protect the attribute configuration value to protect the statically defined +default value in ATTRS if required (if the value is an object literal, array or the +attribute configuration has cloneDefaultValue set to shallow or deep).
+Parameters:
+ +-
+
+
-
+
+
allAttrs+ Array + + + + +++ + +An array of ATTRS definitions across classes in the hierarchy +(subclass first, Base last)
+
+
+
Returns:
+ +_applyParsedConfig
+
+
+ ()
+
+
+
+
+ Object
+
+
+
+
+
+
+ protected
+
+
+
+
+
+
+
+
+
+
+
+
+ Returns:
+ +_applyParser
+
+
+ -
+
+
-
+
+
config+ +
+
+
Utility method used to apply the HTML_PARSER configuration for the
+instance, to retrieve config data values.
Parameters:
+ +-
+
+
-
+
+
config+ Object + + + + +++ + +User configuration object (will be populated with values from Node)
+
+
+
_applyStdModParsedConfig
+
+
+ ()
+
+
+
+
+
+
+
+ private
+
+
+
+
+
+
+
+
+
+
+
+
+ This method is injected before the applyParsedConfig step in +the application of HTMLPARSER, and sets up the state to +identify whether or not we should remove the current DOM content +or not, based on whether or not the current content attribute value +was extracted from the DOM, or provided by the user configuration
+_attachPosAlignUIHandles
+
+
+ ()
+
+
+
+
+
+
+
+ protected
+
+
+
+
+
+
+
+
+
+
+
+
+ Attaches the alignment-syncing event handlers.
+_attachUIHandlesAutohide
+
+
+ ()
+
+
+
+
+
+
+
+ protected
+
+
+
+
+
+
+
+
+
+
+
+
+ Iterates through all objects in the hideOn attribute and creates event listeners.
+_attachUIHandlesModal
+
+
+ ()
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Attaches 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.
+_attrCfgHash
+
+
+ ()
+
+
+
+
+
+
+
+ private
+
+
+
+
+
+
+
+
+
+
+
+
+ Utility method to define the attribute hash used to filter/whitelist property mixes for +this class for iteration performance reasons.
+_baseDestroy
+
+
+ ()
+
+
+
+
+
+
+
+ private
+
+
+
+
+
+
+
+
+
+
+
+
+ Internal destroy implementation for BaseCore
+_baseInit
+
+
+ ()
+
+
+
+
+
+
+
+ private
+
+
+
+
+
+
+
+
+
+
+
+
+ Internal initialization implementation for BaseCore
+_bindAttrUI
+
+
+ -
+
+
-
+
+
attrs+ +
+
+
Binds after listeners for the list of attributes provided
+Parameters:
+ +-
+
+
-
+
+
attrs+ Array + + + + ++ ++ + +
+
+
_bindDOM
+
+
+ ()
+
+
+
+
+
+
+
+ protected
+
+
+
+
+
+
+
+
+
+
+
+
+ Sets up DOM listeners, on elements rendered by the widget.
+_bindUI
+
+
+ ()
+
+
+
+
+
+
+
+ protected
+
+
+
+
+
+
+
+
+
+
+
+
+ Sets up DOM and CustomEvent listeners for the widget.
+_bindUIAutohide
+
+
+ ()
+
+
+
+
+
+
+
+ protected
+
+
+
+
+
+
+
+
+
+
+
+
+ Binds event listeners to the widget.
+ ++This method in invoked after bindUI is invoked for the Widget class +using YUI's aop infrastructure. +
+_bindUIButtons
+
+
+ ()
+
+
+
+
+
+
+
+ protected
+
+
+
+
+
+
+
+
+
+
+
+
+ Binds UI event listeners. This method is inserted via AOP, and will execute
+after bindUI().
_bindUIChild
+
+
+ ()
+
+
+
+
+
+
+
+ protected
+
+
+
+
+
+
+
+
+
+
+
+
+ Binds event listeners responsible for updating the UI state in response +to WidgetChild related state changes.
+ ++This method is invoked after bindUI is invoked for the Widget class +using YUI's aop infrastructure. +
+_bindUIModal
+
+
+ ()
+
+
+
+
+
+
+
+ protected
+
+
+
+
+
+
+
+
+
+
+
+
+ Hooks 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. +
+_bindUIPosAlign
+
+
+ ()
+
+
+
+
+
+
+
+ protected
+
+
+
+
+
+
+
+
+
+
+
+
+ Bind event listeners responsible for updating the UI state in response to +the widget's position-align related state changes.
+ +This method is invoked after bindUI has been invoked for the Widget
+class using the AOP infrastructure.
_bindUIPosConstrained
+
+
+ ()
+
+
+
+
+
+
+
+ protected
+
+
+
+
+
+
+
+
+
+
+
+
+ Binds event listeners responsible for updating the UI state in response to +Widget constrained positioning related state changes.
+ ++This method is invoked after bindUI is invoked for the Widget class +using YUI's aop infrastructure. +
+_bindUIPosition
+
+
+ ()
+
+
+
+
+
+
+
+ protected
+
+
+
+
+
+
+
+
+
+
+
+
+ Binds event listeners responsible for updating the UI state in response to +Widget position related state changes.
+ ++This method in invoked after bindUI is invoked for the Widget class +using YUI's aop infrastructure. +
+_bindUIStack
+
+
+ ()
+
+
+
+
+
+
+
+ protected
+
+
+
+
+
+
+
+
+
+
+
+
+ Binds event listeners responsible for updating the UI state in response to +Widget stack related state changes.
+ ++This method is invoked after bindUI is invoked for the Widget class +using YUI's aop infrastructure. +
+_bindUIStdMod
+
+
+ ()
+
+
+
+
+
+
+
+ protected
+
+
+
+
+
+
+
+
+
+
+
+
+ Binds event listeners responsible for updating the UI state in response to +Widget standard module related state changes.
+ ++This method is invoked after bindUI is invoked for the Widget class +using YUI's aop infrastructure. +
+_blur
+
+
+ ()
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Blurs the widget.
+_cloneDefaultValue
+
+
+ -
+
+
-
+
+
cfg+ +
+
+
This method assumes that the value has already been checked to be an object. +Since it's on a critical path, we don't want to re-do the check.
+Parameters:
+ +-
+
+
-
+
+
cfg+ Object + + + + ++ ++ + +
+
+
_constrain
+
+
+ -
+
+
-
+
+
val+ +
+
+ -
+
+
axis+ +
+
+ -
+
+
nodeRegion+ +
+
+ -
+
+
constrainingRegion+ +
+
+
The method which performs the actual constrain calculations for a given axis ("x" or "y") based +on the regions provided.
+Parameters:
+ +-
+
+
-
+
+
val+ Number + + + + +++ + +The value to constrain
+
+
+ -
+
+
axis+ String + + + + +++ + +The axis to use for constrainment
+
+
+ -
+
+
nodeRegion+ Region + + + + +++ + +The region of the node to constrain
+
+
+ -
+
+
constrainingRegion+ Region + + + + +++ + +The region of the node (or viewport) to constrain to
+
+
+
Returns:
+ +_constrainOnXYChange
+
+
+ -
+
+
-
+
+
e+ +
+
+
The on change listener for the "xy" attribute. Modifies the event facade's +newVal property with the constrained XY value.
+Parameters:
+ +-
+
+
-
+
+
e+ EventFacade + + + + +++ + +The event facade for the attribute change
+
+
+
_createButton
+
+
+ -
+
+
-
+
+
button+ +
+
+
Returns a button node based on the specified button node or configuration.
The button node will either be created via Y.Plugin.Button.createNode(),
+or when button is specified as a node already, it will by plug()ed with
+Y.Plugin.Button.
Parameters:
+ + +Returns:
+ +_createUIEvent
+
+
+ -
+
+
-
+
+
type+ +
+
+
Binds a delegated DOM event listener of the specified type to the +Widget's outtermost DOM element to facilitate the firing of a Custom +Event of the same type for the Widget instance.
+Parameters:
+ +-
+
+
-
+
+
type+ String + + + + +++ + +String representing the name of the event
+
+
+
_defAttrChangeFn
+
+
+ -
+
+
-
+
+
e+ +
+
+
Default function for attribute change events.
+Parameters:
+ +-
+
+
-
+
+
e+ EventFacade + + + + +++ + +The event object for attribute change events.
+
+
+
_defaultCB
+
+
+ ()
+
+
+
+
+
+
+
+ protected
+
+
+
+
+
+
+
+
+
+
+
+
+ Returns the default value for the contentBox attribute.
+ +For the Widget class, this will be the srcNode if provided, otherwise null (resulting in +a new contentBox node instance being created)
+_defDestroyFn
+
+
+ -
+
+
-
+
+
e+ +
+
+
Default destroy event handler
+Parameters:
+ +-
+
+
-
+
+
e+ EventFacade + + + + +++ + +Event object
+
+
+
_defInitFn
+
+
+ -
+
+
-
+
+
e+ +
+
+
Default init event handler
+Parameters:
+ +-
+
+
-
+
+
e+ EventFacade + + + + +++ + +Event object, with a cfg property which +refers to the configuration object passed to the constructor.
+
+
+
_defRenderFn
+
+
+ -
+
+
-
+
+
e+ +
+
+ -
+
+
parentNode+ +
+
+
Default render handler
+Parameters:
+ +-
+
+
-
+
+
e+ EventFacade + + + + +++ + +The Event object
+
+
+ -
+
+
parentNode+ Node + + + + +++ + +The parent node to render to, if passed in to the
+rendermethod
+
+
_destroyBox
+
+
+ ()
+
+
+
+
+
+
+
+ protected
+
+
+
+
+
+
+
+
+
+
+
+
+ Removes and destroys the widgets rendered boundingBox, contentBox, +and detaches bound UI events.
+_destroyHierarchy
+
+
+ ()
+
+
+
+
+
+
+
+ private
+
+
+
+
+
+
+
+
+
+
+
+
+ Destroys the class hierarchy for this instance by invoking +the destructor method on the prototype of each class in the hierarchy.
+_destroyShim
+
+
+ ()
+
+
+
+
+
+
+
+ private
+
+
+
+
+
+
+
+
+
+
+
+
+ Removes the shim from the DOM, and detaches any related event +listeners.
+_destroyUIEvents
+
+
+ ()
+
+
+
+
+
+
+
+ private
+
+
+
+
+
+
+
+
+
+
+
+
+ Destructor logic for UI event infrastructure, +invoked during Widget destruction.
+_detachPosAlignUIHandles
+
+
+ ()
+
+
+
+
+
+
+
+ protected
+
+
+
+
+
+
+
+
+
+
+
+
+ Detaches the alignment-syncing event handlers.
+_detachStackHandles
+
+
+ -
+
+
-
+
+
String+ +
+
+
Detaches any handles stored for the provided key
+Parameters:
+ +-
+
+
-
+
+
String+ Object + + + + +++ + +handleKey The key defining the group of handles which should be detached
+
+
+
_detachUIHandlesAutohide
+
+
+ ()
+
+
+
+
+
+
+
+ protected
+
+
+
+
+
+
+
+
+
+
+
+
+ Detaches all event listeners created by this extension
+_detachUIHandlesModal
+
+
+ ()
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Detaches all UI Listeners that were set in _attachUIHandlesModal from the widget.
+_doAlign
+
+
+ -
+
+
-
+
+
widgetPoint+ +
+
+ -
+
+
x+ +
+
+ -
+
+
y+ +
+
+
Helper method, used to align the given point on the widget, with the XY page +coordinates provided.
+_eraseStdMod
+
+
+ -
+
+
-
+
+
section+ +
+
+
Removes the DOM node for the given section.
+Parameters:
+ +-
+
+
-
+
+
section+ String + + + + +++ + +The section to remove. Either WidgetStdMod.HEADER, WidgetStdMod.BODY or WidgetStdMod.FOOTER.
+
+
+
_fillHeight
+
+
+ ()
+
+
+
+
+
+
+
+ private
+
+
+
+
+
+
+
+
+
+
+
+
+ Updates the rendered UI, to resize the current section specified by the fillHeight attribute, so +that the standard module fills out the Widget height. If a height has not been set on Widget, +the section is not resized (height is set to "auto").
+_filterAdHocAttrs
+
+
+ -
+
+
-
+
+
allAttrs+ +
+
+ -
+
+
userVals+ +
+
+
Parameters:
+ +-
+
+
-
+
+
allAttrs+ Object + + + + +++ + +The set of all attribute configurations for this instance. +Attributes will be removed from this set, if they belong to the filtered class, so +that by the time all classes are processed, allCfgs will be empty.
+
+
+ -
+
+
userVals+ Object + + + + +++ + +The config object passed in by the user, from which adhoc attrs are to be filtered.
+
+
+
Returns:
+ +_filterAttrCfgs
+
+
+ -
+
+
-
+
+
clazz+ +
+
+ -
+
+
allCfgs+ +
+
+
A helper method used when processing ATTRS across the class hierarchy during +initialization. Returns a disposable object with the attributes defined for +the provided class, extracted from the set of all attributes passed in.
+Parameters:
+ +-
+
+
-
+
+
clazz+ Function + + + + +++ + +The class for which the desired attributes are required.
+
+
+ -
+
+
allCfgs+ Object + + + + +++ + +The set of all attribute configurations for this instance. +Attributes will be removed from this set, if they belong to the filtered class, so +that by the time all classes are processed, allCfgs will be empty.
+
+
+
Returns:
+ +_filterUIEvent
+
+
+ -
+
+
-
+
+
evt+ +
+
+
This method is used to determine if we should fire +the UI Event or not. The default implementation makes sure +that for nested delegates (nested unrelated widgets), we don't +fire the UI event listener more than once at each level.
+ +For example, without the additional filter, if you have nested +widgets, each widget will have a delegate listener. If you +click on the inner widget, the inner delegate listener's +filter will match once, but the outer will match twice +(based on delegate's design) - once for the inner widget, +and once for the outer.
+Parameters:
+ +-
+
+
-
+
+
evt+ DOMEventFacade + + + + ++ ++ + +
+
+
Returns:
+ +_findStdModSection
+
+
+ -
+
+
-
+
+
section+ +
+
+
Helper method to to find the rendered node for the given section, +if it exists.
+Parameters:
+ +-
+
+
-
+
+
section+ String + + + + +++ + +The section for which the render Node is to be found. Either WidgetStdMod.HEADER, WidgetStdMod.BODY or WidgetStdMod.FOOTER.
+
+
+
Returns:
+ +_fireAttrChange
+
+
+ -
+
+
-
+
+
attrName+ +
+
+ -
+
+
subAttrName+ +
+
+ -
+
+
currVal+ +
+
+ -
+
+
newVal+ +
+
+ -
+
+
opts+ +
+
+ -
+
+
[cfg]+ +
+
+
Utility method to help setup the event payload and fire the attribute change event.
+Parameters:
+ +-
+
+
-
+
+
attrName+ String + + + + +++ + +The name of the attribute
+
+
+ -
+
+
subAttrName+ String + + + + +++ + +The full path of the property being changed, +if this is a sub-attribute value being change. Otherwise null.
+
+
+ -
+
+
currVal+ Any + + + + +++ + +The current value of the attribute
+
+
+ -
+
+
newVal+ Any + + + + +++ + +The new value of the attribute
+
+
+ -
+
+
opts+ Object + + + + +++ + +Any additional event data to mix into the attribute change event's event facade.
+
+
+ -
+
+
[cfg]+ Object + optional + + + + +++ + +The attribute config stored in State, if already available.
+
+
+
_focus
+
+
+ ()
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Provides mouse and tab focus to the widget's bounding box.
+_getAttr
+
+
+ -
+
+
-
+
+
name+ +
+
+
Provides the common implementation for the public get method, +allowing Attribute hosts to over-ride either method.
+ +See get for argument details.
+Parameters:
+ +-
+
+
-
+
+
name+ String + + + + +++ + +The name of the attribute.
+
+
+
Returns:
+ +_getAttrCfg
+
+
+ -
+
+
-
+
+
name+ +
+
+
Returns an object with the configuration properties (and value) +for the given attribute. If attrName is not provided, returns the +configuration properties for all attributes.
+Parameters:
+ +-
+
+
-
+
+
name+ String + + + + +++ + +Optional. The attribute name. If not provided, the method will return the configuration for all attributes.
+
+
+
Returns:
+ +_getAttrCfgs
+
+
+ ()
+
+
+
+
+ Object
+
+
+
+
+
+
+ protected
+
+
+
+
+
+
+
+
+
+
+
+
+ Returns an aggregated set of attribute configurations, by traversing +the class hierarchy.
+Returns:
+ +_getAttrInitVal
+
+
+ -
+
+
-
+
+
attr+ +
+
+ -
+
+
cfg+ +
+
+ -
+
+
initValues+ +
+
+
Returns the initial value of the given attribute from +either the default configuration provided, or the +over-ridden value if it exists in the set of initValues +provided and the attribute is not read-only.
+Parameters:
+ + +Returns:
+ +_getAttrs
+
+
+ -
+
+
-
+
+
attrs+ +
+
+
Implementation behind the public getAttrs method, to get multiple attribute values.
+Parameters:
+ +-
+
+
-
+
+
attrs+ Array | boolean + + + + +++ + +Optional. An array of attribute names. If omitted, all attribute values are +returned. If set to true, all attributes modified from their initial values are returned.
+
+
+
Returns:
+ +_getButtonContainer
+
+
+ -
+
+
-
+
+
section+ +
+
+ -
+
+
create+ +
+
+
Returns the buttons container for the specified section, passing a truthy
+value for create will create the node if it does not already exist.
Note: It is up to the caller to properly insert the returned container +node into the content section.
+Parameters:
+ + +Returns:
+ +section.
+
+ _getButtonDefault
+
+
+ -
+
+
-
+
+
button+ +
+
+
Returns whether or not the specified button is configured to be the
+default button.
When a button node is specified, the button's getData() method will be
+used to determine if the button is configured to be the default. When a
+button config object is specified, the isDefault prop will determine
+whether the button is the default.
Note: <button data-default="true"></button> is supported via the
+button.getData('default') API call.
Parameters:
+ + +Returns:
+ +_getButtonName
+
+
+ -
+
+
-
+
+
button+ +
+
+
Returns the name of the specified button.
When a button node is specified, the button's getData('name') method is
+preferred, but will fallback to get('name'), and the result will determine
+the button's name. When a button config object is specified, the name prop
+will determine the button's name.
Note: <button data-name="foo"></button> is supported via the
+button.getData('name') API call.
Parameters:
+ + +Returns:
+ +_getButtons
+
+
+ -
+
+
-
+
+
buttons+ +
+
+
Getter for the buttons attribute. A copy of the buttons object is
+returned so the stored state cannot be modified by the callers of
+get('buttons').
This will recreate a copy of the buttons object, and each section array
+(the button nodes are not copied/cloned.)
Parameters:
+ +-
+
+
-
+
+
buttons+ Object + + + + +++ + +The widget's current
+buttonsstate.
+
+
Returns:
+ +buttons state.
+
+ _getClasses
+
+
+ ()
+
+
+
+
+ Function[]
+
+
+
+
+
+
+ protected
+
+
+
+
+
+
+
+
+
+
+
+
+ Returns the class hierarchy for this object, with BaseCore being the last class in the array.
+Returns:
+ +_getFullType
+
+
+ -
+
+
-
+
+
type+ +
+
+
Returns the fully qualified type, given a short type string. +That is, returns "foo:bar" when given "bar" if "foo" is the configured prefix.
+ +NOTE: This method, unlike _getType, does no checking of the value passed in, and +is designed to be used with the low level _publish() method, for critical path +implementations which need to fast-track publish for performance reasons.
+Parameters:
+ +-
+
+
-
+
+
type+ String + + + + +++ + +The short type to prefix
+
+
+
Returns:
+ +_getHtmlParser
+
+
+ ()
+
+
+
+
+ Object
+
+
+
+
+
+
+ private
+
+
+
+
+
+
+
+
+
+
+
+
+ Gets the HTMLPARSER definition for this instance, by merging HTMLPARSER +definitions across the class hierarchy.
+Returns:
+ +_getMaskNode
+
+
+ ()
+
+
+
+
+ Node
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Returns the Y.Node instance of the maskNode
+Returns:
+ +_getNodeToParse
+
+
+ ()
+
+
+
+
+ Node
+
+
+
+
+
+
+ private
+
+
+
+
+
+
+
+
+
+
+
+
+ Determines whether we have a node reference which we should try and parse.
+ +The current implementation does not parse nodes generated from CONTENT_TEMPLATE, +only explicitly set srcNode, or contentBox attributes.
+Returns:
+ +_getPreciseHeight
+
+
+ -
+
+
-
+
+
node+ +
+
+
Helper method to obtain the precise height of the node provided, including padding and border. +The height could be a sub-pixel value for certain browsers, such as Firefox 3.
+Parameters:
+ +-
+
+
-
+
+
node+ Node + + + + +++ + +The node for which the precise height is required.
+
+
+
Returns:
+ +_getRegion
+
+
+ -
+
+
-
+
+
[node]+ +
+
+
Returns the region of the passed-in Node, or the viewport region if
+calling with passing in a Node.
Parameters:
+ +-
+
+
-
+
+
[node]+ Node + optional + + + + +++ + +The node to get the region of.
+
+
+
Returns:
+ +_getShimTemplate
+
+
+ ()
+
+
+
+
+ Node
+
+
+
+
+
+
+ private
+
+
+
+
+
+
+
+
+
+
+
+
+ Creates a cloned shim node, using the SHIM_TEMPLATE html template, for use on a new instance.
+Returns:
+ +_getSrcNode
+
+
+ ()
+
+
+
+
+ Node
+
+
+
+
+
+
+ protected
+
+
+
+
+
+
+
+
+
+
+
+
+ Returns:
+ +_getStateVal
+
+
+ -
+
+
-
+
+
name+ +
+
+ -
+
+
[cfg]+ +
+
+
Gets the stored value for the attribute, from either the +internal state object, or the state proxy if it exits
+Parameters:
+ + +Returns:
+ +_getStdModContent
+
+
+ -
+
+
-
+
+
section+ +
+
+
Retrieves the child nodes (content) of a standard module section
+Parameters:
+ +-
+
+
-
+
+
section+ String + + + + +++ + +The standard module section whose child nodes are to be retrieved. Either WidgetStdMod.HEADER, WidgetStdMod.BODY or WidgetStdMod.FOOTER.
+
+
+
Returns:
+ +_getStdModTemplate
+
+
+ -
+
+
-
+
+
section+ +
+
+
Gets a new Node reference for the given standard module section, by cloning +the stored template node.
+Parameters:
+ +-
+
+
-
+
+
section+ String + + + + +++ + +The section to create a new node for. Either WidgetStdMod.HEADER, WidgetStdMod.BODY or WidgetStdMod.FOOTER.
+
+
+
Returns:
+ +_getStrings
+
+
+ -
+
+
-
+
+
locale+ +
+
+
Returns the strings key/value hash for a paricular locale, without locale lookup applied.
+Parameters:
+ +-
+
+
-
+
+
locale+ Object + + + + ++ ++ + +
+
+
_getType
+
+
+ ()
+
+
+
+
+
+
+
+ private
+
+
+
+
+
+
+
+
+
+
+
+
+ If the instance has a prefix attribute and the +event type is not prefixed, the instance prefix is +applied to the supplied type.
+_getUIEventNode
+
+
+ ()
+
+
+
+
+
+
+
+ protected
+
+
+
+
+
+
+
+
+
+
+
+
+ Returns the node on which to bind delegate listeners.
+ +Override of Widget's implementation of _getUIEventNode() to ensure that +all event listeners are bound to the Widget's topmost DOM element. +This ensures that the firing of each type of Widget UI event (click, +mousedown, etc.) is facilitated by a single, top-level, delegated DOM +event listener.
+_getX
+
+
+ ()
+
+
+
+
+ Number
+
+
+
+
+
+
+ protected
+
+
+
+
+
+
+
+
+
+
+
+
+ Default getter for the X attribute. The value is retrieved from +the XY attribute, which is the sole store for the XY state.
+Returns:
+ +_getY
+
+
+ ()
+
+
+
+
+ Number
+
+
+
+
+
+
+ protected
+
+
+
+
+
+
+
+
+
+
+
+
+ Default getter for the Y attribute. The value is retrieved from +the XY attribute, which is the sole store for the XY state.
+Returns:
+ +_guid
+
+
+ ()
+
+
+
+
+
+
+
+ protected
+
+
+
+
+
+
+
+
+
+
+
+
+ _initAttrHost
+
+
+ -
+
+
-
+
+
attrs+ +
+
+ -
+
+
values+ +
+
+ -
+
+
lazy+ +
+
+
Constructor logic for attributes. Initializes the host state, and sets up the inital attributes passed to the +constructor.
+Parameters:
+ +-
+
+
-
+
+
attrs+ Object + + + + +++ + +The attributes to add during construction (passed through to addAttrs). + These can also be defined on the constructor being augmented with Attribute by defining the ATTRS property on the constructor.
+
+
+ -
+
+
values+ Object + + + + +++ + +The initial attribute values to apply (passed through to addAttrs). + These are not merged/cloned. The caller is responsible for isolating user provided values if required.
+
+
+ -
+
+
lazy+ Boolean + + + + +++ + +Whether or not to add attributes lazily (passed through to addAttrs).
+
+
+
_initAttribute
+
+
+ ()
+
+
+
+
+
+
+
+ private
+
+
+
+
+
+
+
+
+
+
+
+
+ Initializes AttributeCore
+_initAttrs
+
+
+ -
+
+
-
+
+
attrs+ +
+
+ -
+
+
values+ +
+
+ -
+
+
lazy+ +
+
+
Utility method to set up initial attributes defined during construction, +either through the constructor.ATTRS property, or explicitly passed in.
+Parameters:
+ +-
+
+
-
+
+
attrs+ Object + + + + +++ + +The attributes to add during construction (passed through to addAttrs). + These can also be defined on the constructor being augmented with Attribute by defining the ATTRS property on the constructor.
+
+
+ -
+
+
values+ Object + + + + +++ + +The initial attribute values to apply (passed through to addAttrs). + These are not merged/cloned. The caller is responsible for isolating user provided values if required.
+
+
+ -
+
+
lazy+ Boolean + + + + +++ + +Whether or not to add attributes lazily (passed through to addAttrs).
+
+
+
_initBase
+
+
+ -
+
+
-
+
+
config+ +
+
+
Internal construction logic for BaseCore.
+Parameters:
+ +-
+
+
-
+
+
config+ Object + + + + +++ + +The constructor configuration object
+
+
+
_initHierarchy
+
+
+ -
+
+
-
+
+
userVals+ +
+
+
Initializes the class hierarchy for the instance, which includes +initializing attributes for each class defined in the class's +static ATTRS property and +invoking the initializer method on the prototype of each class in the hierarchy.
+Parameters:
+ +-
+
+
-
+
+
userVals+ Object + + + + +++ + +Object with configuration property name/value pairs
+
+
+
_initHierarchyData
+
+
+ ()
+
+
+
+
+
+
+
+ private
+
+
+
+
+
+
+
+
+
+
+
+
+ A helper method used by _getClasses and _getAttrCfgs, which determines both +the array of classes and aggregate set of attribute configurations +across the class hierarchy for the instance.
+_initUIEvent
+
+
+ -
+
+
-
+
+
type+ +
+
+
Sets up infrastructure required to fire a UI event.
+Parameters:
+ +-
+
+
-
+
+
type+ String + + + + +++ + +String representing the name of the event
+
+
+
Returns:
+ +_insertStdModSection
+
+
+ -
+
+
-
+
+
contentBox+ +
+
+ -
+
+
section+ +
+
+ -
+
+
sectionNode+ +
+
+
Helper method to insert the Node for the given section into the correct location in the contentBox.
+Parameters:
+ +-
+
+
-
+
+
contentBox+ Node + + + + +++ + +A reference to the Widgets content box.
+
+
+ -
+
+
section+ String + + + + +++ + +The section to create/render. Either WidgetStdMod.HEADER, WidgetStdMod.BODY or WidgetStdMod.FOOTER.
+
+
+ -
+
+
sectionNode+ Node + + + + +++ + +The Node for the section.
+
+
+
_isLazyAttr
+
+
+ -
+
+
-
+
+
name+ +
+
+
Checks whether or not the attribute is one which has been +added lazily and still requires initialization.
+Parameters:
+ +-
+
+
-
+
+
name+ String + + + + +++ + +The name of the attribute
+
+
+
Returns:
+ +_isUIEvent
+
+
+ -
+
+
-
+
+
type+ +
+
+
Determines if the specified event is a UI event.
+Parameters:
+ +-
+
+
-
+
+
type+ String + + + + +++ + +String representing the name of the event
+
+
+
Returns:
+ +_mapButton
+
+
+ -
+
+
-
+
+
button+ +
+
+ -
+
+
section+ +
+
+
Adds the specified button to the buttons map (both name -> button and
+section:name -> button), and sets the button as the default if it is
+configured as the default button.
Note: If two or more buttons are configured with the same name and/or
+configured to be the default button, the last one wins.
_mapButtons
+
+
+ -
+
+
-
+
+
buttons+ +
+
+
Adds the specified buttons to the buttons map (both name -> button and
+section:name -> button), and set the a button as the default if one is
+configured as the default button.
Note: This will clear all previous button mappings and null-out any
+previous default button! If two or more buttons are configured with the same
+name and/or configured to be the default button, the last one wins.
Parameters:
+ +-
+
+
-
+
+
buttons+ Node[] + + + + +++ + +The button nodes to map.
+
+
+
_mapInstance
+
+
+ -
+
+
-
+
+
The+ +
+
+
Utility method used to add an entry to the boundingBox id to instance map.
+ +This method can be used to populate the instance with lazily created boundingBox Node references.
+Parameters:
+ +-
+
+
-
+
+
The+ String + + + + +++ + +boundingBox id
+
+
+
_mergeButtonConfig
+
+
+ -
+
+
-
+
+
config+ +
+
+
Returns a copy of the specified config object merged with any defaults
+provided by a srcNode and/or a predefined configuration for a button
+with the same name on the BUTTONS property.
Parameters:
+ + +Returns:
+ +_monitor
+
+
+ -
+
+
-
+
+
what+ +
+
+ -
+
+
eventType+ +
+
+ -
+
+
o+ +
+
+
This is the entry point for the event monitoring system. +You can monitor 'attach', 'detach', 'fire', and 'publish'. +When configured, these events generate an event. click -> +clickattach, clickdetach, click_publish -- these can +be subscribed to like other events to monitor the event +system. Inividual published events can have monitoring +turned on or off (publish can't be turned off before it +it published) by setting the events 'monitor' config.
+Parameters:
+ +-
+
+
-
+
+
what+ String + + + + +++ + +'attach', 'detach', 'fire', or 'publish'
+
+
+ -
+
+
eventType+ String | CustomEvent + + + + +++ + +The prefixed name of the event being monitored, or the CustomEvent object.
+
+
+ -
+
+
o+ Object + + + + +++ + +Information about the event interaction, such as + fire() args, subscription category, publish config
+
+
+
_normAttrVals
+
+
+ -
+
+
-
+
+
valueHash+ +
+
+
Utility method to normalize attribute values. The base implementation +simply merges the hash to protect the original.
+Parameters:
+ +-
+
+
-
+
+
valueHash+ Object + + + + +++ + +An object with attribute name/value pairs
+
+
+
Returns:
+ +_onDocFocus
+
+
+ -
+
+
-
+
+
evt+ +
+
+
DOM focus event handler, used to sync the state of the Widget with the DOM
+Parameters:
+ +-
+
+
-
+
+
evt+ EventFacade + + + + +++ + +The event facade for the DOM focus event
+
+
+
_onDocMouseDown
+
+
+ -
+
+
-
+
+
evt+ +
+
+
"mousedown" event handler for the owner document of the +widget's bounding box.
+Parameters:
+ +-
+
+
-
+
+
evt+ EventFacade + + + + +++ + +The event facade for the DOM focus event
+
+
+
_parseButtons
+
+
+ -
+
+
-
+
+
srcNode+ +
+
+
HTML_PARSER implementation for the buttons attribute.
Note: To determine a button node's name its data-name and name
+attributes are examined. Whether the button should be the default is
+determined by its data-default attribute.
Parameters:
+ +-
+
+
-
+
+
srcNode+ Node + + + + +++ + +This widget's srcNode to search for buttons.
+
+
+
Returns:
+ +buttons Config object parsed from this widget's DOM.
+
+ _parseStdModHTML
+
+
+ -
+
+
-
+
+
section+ +
+
+
Utility method, used by WidgetStdMods HTML_PARSER implementation +to extract data for each section from markup.
+Parameters:
+ +-
+
+
-
+
+
section+ String + + + + ++ ++ + +
+
+
Returns:
+ +_parseType
+
+
+ ()
+
+
+
+
+
+
+
+ private
+
+
+
+
+
+
+
+
+
+
+
+
+ Returns an array with the detach key (if provided), +and the prefixed event name from _getType +Y.on('detachcategory| menu:click', fn)
+_parseZIndex
+
+
+ -
+
+
-
+
+
srcNode+ +
+
+
Parses a zIndex attribute value from this widget's srcNode.
Parameters:
+ +-
+
+
-
+
+
srcNode+ Node + + + + +++ + +The node to parse a
+zIndexvalue from.
+
+
Returns:
+ +zIndex value.
+
+ _preInitEventCfg
+
+
+ -
+
+
-
+
+
config+ +
+
+
Handles the special on, after and target properties which allow the user to +easily configure on and after listeners as well as bubble targets during +construction, prior to init.
+Parameters:
+ +-
+
+
-
+
+
config+ Object + + + + +++ + +The user configuration object
+
+
+
_preventOverlap
+
+
+ -
+
+
-
+
+
val+ +
+
+ -
+
+
axis+ +
+
+ -
+
+
nodeRegion+ +
+
+ -
+
+
constrainingRegion+ +
+
+
The method which performs the preventOverlap calculations for a given axis ("x" or "y") based +on the value and regions provided.
+Parameters:
+ +-
+
+
-
+
+
val+ Number + + + + +++ + +The value being constrain
+
+
+ -
+
+
axis+ String + + + + +++ + +The axis to being constrained
+
+
+ -
+
+
nodeRegion+ Region + + + + +++ + +The region of the node being constrained
+
+
+ -
+
+
constrainingRegion+ Region + + + + +++ + +The region of the node (or viewport) we need to constrain to
+
+
+
Returns:
+ +_protectAttrs
+
+
+ -
+
+
-
+
+
attrs+ +
+
+
Utility method to protect an attribute configuration +hash, by merging the entire object and the individual +attr config objects.
+Parameters:
+ +-
+
+
-
+
+
attrs+ Object + + + + +++ + +A hash of attribute to configuration object pairs.
+
+
+
Returns:
+ +_publish
+
+
+ -
+
+
-
+
+
fullType+ +
+
+ -
+
+
etOpts+ +
+
+ -
+
+
ceOpts+ +
+
+
The low level event publish implementation. It expects all the massaging to have been done
+outside of this method. e.g. the type to fullType conversion. It's designed to be a fast
+path publish, which can be used by critical code paths to improve performance.
Parameters:
+ +-
+
+
-
+
+
fullType+ String + + + + +++ + +The prefixed type of the event to publish.
+
+
+ -
+
+
etOpts+ Object + + + + +++ + +The EventTarget specific configuration to mix into the published event.
+
+
+ -
+
+
ceOpts+ Object + + + + +++ + +The publish specific configuration to mix into the published event.
+
+
+
Returns:
+ +etOpts or ceOpts, this will
+be the default CustomEvent instance, and can be configured independently.
+
+ _removeLoadingClassNames
+
+
+ ()
+
+
+
+
+
+
+
+ protected
+
+
+
+
+
+
+
+
+
+
+
+
+ Removes class names representative of the widget's loading state from +the boundingBox.
+_renderBox
+
+
+ -
+
+
-
+
+
parentNode+ +
+
+
Helper method to collect the boundingBox and contentBox and append to the provided parentNode, if not +already a child. The owner document of the boundingBox, or the owner document of the contentBox will be used +as the document into which the Widget is rendered if a parentNode is node is not provided. If both the boundingBox and +the contentBox are not currently in the document, and no parentNode is provided, the widget will be rendered +to the current document's body.
+Parameters:
+ +-
+
+
-
+
+
parentNode+ Node + + + + +++ + +The parentNode to render the widget to. If not provided, and both the boundingBox and +the contentBox are not currently in the document, the widget will be rendered to the current document's body.
+
+
+
_renderBoxClassNames
+
+
+ ()
+
+
+
+
+
+
+
+ protected
+
+
+
+
+
+
+
+
+
+
+
+
+ Applies standard class names to the boundingBox and contentBox
+_renderShim
+
+
+ ()
+
+
+
+
+
+
+
+ private
+
+
+
+
+
+
+
+
+
+
+
+
+ Creates the shim element and adds it to the DOM
+_renderShimDeferred
+
+
+ ()
+
+
+
+
+
+
+
+ private
+
+
+
+
+
+
+
+
+
+
+
+
+ Sets up change handlers for the visible attribute, to defer shim creation/rendering +until the Widget is made visible.
+_renderStdMod
+
+
+ -
+
+
-
+
+
section+ +
+
+
Creates the DOM node for the given section, and inserts it into the correct location in the contentBox.
+Parameters:
+ +-
+
+
-
+
+
section+ String + + + + +++ + +The section to create/render. Either WidgetStdMod.HEADER, WidgetStdMod.BODY or WidgetStdMod.FOOTER.
+
+
+
Returns:
+ +_renderUI
+
+
+ ()
+
+
+
+
+
+
+
+ protected
+
+
+
+
+
+
+
+
+
+
+
+
+ Initializes the UI state for the Widget's bounding/content boxes.
+_renderUIModal
+
+
+ ()
+
+
+
+
+
+
+
+ protected
+
+
+
+
+
+
+
+
+
+
+
+
+ Adds 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. +
+_renderUIPosition
+
+
+ ()
+
+
+
+
+
+
+
+ protected
+
+
+
+
+
+
+
+
+
+
+
+
+ Creates/Initializes the DOM to support xy page positioning.
+ ++This method in invoked after renderUI is invoked for the Widget class +using YUI's aop infrastructure. +
+_renderUIStack
+
+
+ ()
+
+
+
+
+
+
+
+ protected
+
+
+
+
+
+
+
+
+
+
+
+
+ Creates/Initializes the DOM to support stackability.
+ ++This method in invoked after renderUI is invoked for the Widget class +using YUI's aop infrastructure. +
+_renderUIStdMod
+
+
+ ()
+
+
+
+
+
+
+
+ protected
+
+
+
+
+
+
+
+
+
+
+
+
+ Creates/Initializes the DOM for standard module support.
+ ++This method is invoked after renderUI is invoked for the Widget class +using YUI's aop infrastructure. +
+_repositionMask
+
+
+ -
+
+
-
+
+
nextElem+ +
+
+
Repositions the mask in the DOM for nested modality cases.
+Parameters:
+ +-
+
+
-
+
+
nextElem+ Widget + + + + +++ + +The Y.Widget instance that will be visible in the stack once the current widget is closed.
+
+
+
_resyncMask
+
+
+ -
+
+
-
+
+
nextElem+ +
+
+
Resyncs the mask in the viewport for browsers that don't support fixed positioning
+Parameters:
+ +-
+
+
-
+
+
nextElem+ Y.Widget + + + + +++ + +The Y.Widget instance that will be visible in the stack once the current widget is closed.
+
+
+
_set
+
+
+ -
+
+
-
+
+
name+ +
+
+ -
+
+
val+ +
+
+ -
+
+
[opts]+ +
+
+
Allows setting of readOnly/writeOnce attributes. See set for argument details.
+Parameters:
+ + +Returns:
+ +_setAlignCenter
+
+
+ -
+
+
-
+
+
val+ +
+
+
Default setter for center Attribute changes. Sets up the appropriate
+value, and passes it through the to the align attribute.
Parameters:
+ + +_setAttr
+
+
+ -
+
+
-
+
+
name+ +
+
+ -
+
+
value+ +
+
+ -
+
+
[opts]+ +
+
+ -
+
+
force+ +
+
+
Provides the common implementation for the public set and protected _set methods.
+ +See set for argument details.
+Parameters:
+ +-
+
+
-
+
+
name+ String + + + + +++ + +The name of the attribute.
+
+
+ -
+
+
value+ Any + + + + +++ + +The value to set the attribute to.
+
+
+ -
+
+
[opts]+ Object + optional + + + + +++ + +Optional data providing the circumstances for the change.
+
+
+ -
+
+
force+ Boolean + + + + +++ + +If true, allows the caller to set values for +readOnly or writeOnce attributes which have already been set.
+
+
+
Returns:
+ +_setAttrs
+
+
+ -
+
+
-
+
+
attrs+ +
+
+ -
+
+
[opts]+ +
+
+
Implementation behind the public setAttrs method, to set multiple attribute values.
+Parameters:
+ + +Returns:
+ +_setAttrUI
+
+
+ -
+
+
-
+
+
e+ +
+
+
Parameters:
+ +-
+
+
-
+
+
e+ EventFacade + + + + ++ ++ + +
+
+
_setAttrVal
+
+
+ -
+
+
-
+
+
attrName+ +
+
+ -
+
+
subAttrName+ +
+
+ -
+
+
prevVal+ +
+
+ -
+
+
newVal+ +
+
+ -
+
+
[opts]+ +
+
+ -
+
+
[attrCfg]+ +
+
+
Updates the stored value of the attribute in the privately held State object, +if validation and setter passes.
+Parameters:
+ +-
+
+
-
+
+
attrName+ String + + + + +++ + +The attribute name.
+
+
+ -
+
+
subAttrName+ String + + + + +++ + +The sub-attribute name, if setting a sub-attribute property ("x.y.z").
+
+
+ -
+
+
prevVal+ Any + + + + +++ + +The currently stored value of the attribute.
+
+
+ -
+
+
newVal+ Any + + + + +++ + +The value which is going to be stored.
+
+
+ -
+
+
[opts]+ Object + optional + + + + +++ + +Optional data providing the circumstances for the change.
+
+
+ -
+
+
[attrCfg]+ Object + optional + + + + +++ + +Optional config hash for the attribute. This is added for performance along the critical path, +where the calling method has already obtained the config from state.
+
+
+
Returns:
+ +_setBB
+
+
+ -
+
+
-
+
+
Node/String+ +
+
+
Setter for the boundingBox attribute
+Parameters:
+ +-
+
+
-
+
+
Node/String+ Object + + + + ++ ++ + +
+
+
Returns:
+ +_setBox
+
+
+ -
+
+
-
+
+
id+ +
+
+ -
+
+
node+ +
+
+ -
+
+
template+ +
+
+ -
+
+
true+ +
+
+
Helper method to set the bounding/content box, or create it from +the provided template if not found.
+Parameters:
+ +-
+
+
-
+
+
id+ String + + + + +++ + +The node's id attribute
+
+
+ -
+
+
node+ Node | String + + + + +++ + +The node reference
+
+
+ -
+
+
template+ String + + + + +++ + +HTML string template for the node
+
+
+ -
+
+
true+ Boolean + + + + +++ + +if this is the boundingBox, false if it's the contentBox
+
+
+
Returns:
+ +_setButtons
+
+
+ -
+
+
-
+
+
config+ +
+
+
Setter for the buttons attribute. This processes the specified config
+and returns a new buttons object which is stored as the new state; leaving
+the original, specified config unmodified.
The button nodes will either be created via Y.Plugin.Button.createNode(),
+or when a button is already a Node already, it will by plug()ed with
+Y.Plugin.Button.
Parameters:
+ + +Returns:
+ +buttons object which represents the new
+ state.
+
+ _setCB
+
+
+ -
+
+
-
+
+
node+ +
+
+
Setter for the contentBox attribute
+Returns:
+ +_setConstrain
+
+
+ -
+
+
-
+
+
val+ +
+
+
The setter implementation for the "constrain" attribute.
+Parameters:
+ +-
+
+
-
+
+
val+ Node | boolean + + + + +++ + +The attribute value
+
+
+
_setStateVal
+
+
+ -
+
+
-
+
+
name+ +
+
+ -
+
+
value+ +
+
+
Sets the stored value for the attribute, in either the +internal state object, or the state proxy if it exits
+Parameters:
+ +-
+
+
-
+
+
name+ String + + + + +++ + +The name of the attribute
+
+
+ -
+
+
value+ Any + + + + +++ + +The value of the attribute
+
+
+
_setStrings
+
+
+ -
+
+
-
+
+
strings+ +
+
+ -
+
+
locale+ +
+
+
Sets strings for a particular locale, merging with any existing +strings which may already be defined for the locale.
+_setX
+
+
+ -
+
+
-
+
+
val+ +
+
+
Default setter for the X attribute. The setter passes the X value through +to the XY attribute, which is the sole store for the XY state.
+Parameters:
+ +-
+
+
-
+
+
val+ Number + + + + +++ + +The X page co-ordinate value
+
+
+
_setY
+
+
+ -
+
+
-
+
+
val+ +
+
+
Default setter for the Y attribute. The setter passes the Y value through +to the XY attribute, which is the sole store for the XY state.
+Parameters:
+ +-
+
+
-
+
+
val+ Number + + + + +++ + +The Y page co-ordinate value
+
+
+
_setZIndex
+
+
+ -
+
+
-
+
+
zIndex+ +
+
+
Default setter for zIndex attribute changes. Normalizes zIndex values to +numbers, converting non-numerical values to 0.
+Returns:
+ +_strSetter
+
+
+ -
+
+
-
+
+
strings+ +
+
+
The default setter for the strings attribute. Merges partial sets +into the full string set, to allow users to partial sets of strings
+Parameters:
+ +-
+
+
-
+
+
strings+ Object + + + + ++ ++ + +
+
+
Returns:
+ +_syncAttrUI
+
+
+ -
+
+
-
+
+
attrs+ +
+
+
Invokes the _uiSet=ATTR NAME> method for the list of attributes provided
+Parameters:
+ +-
+
+
-
+
+
attrs+ Array + + + + ++ ++ + +
+
+
_syncUI
+
+
+ ()
+
+
+
+
+
+
+
+ protected
+
+
+
+
+
+
+
+
+
+
+
+
+ Updates the widget UI to reflect the attribute state.
+_syncUIAutohide
+
+
+ ()
+
+
+
+
+
+
+
+ protected
+
+
+
+
+
+
+
+
+
+
+
+
+ Syncs up the widget based on its current state. In particular, removes event listeners if +widget is not visible, and attaches them otherwise.
+ ++This method in invoked after syncUI is invoked for the Widget class +using YUI's aop infrastructure. +
+_syncUIButtons
+
+
+ ()
+
+
+
+
+
+
+
+ protected
+
+
+
+
+
+
+
+
+
+
+
+
+ Syncs this widget's current button-related state to its DOM. This method is
+inserted via AOP, and will execute after syncUI().
_syncUIChild
+
+
+ ()
+
+
+
+
+
+
+
+ protected
+
+
+
+
+
+
+
+
+
+
+
+
+ Synchronizes the UI to match the WidgetChild state.
+ ++This method is invoked after bindUI is invoked for the Widget class +using YUI's aop infrastructure. +
+_syncUIModal
+
+
+ ()
+
+
+
+
+
+
+
+ protected
+
+
+
+
+
+
+
+
+
+
+
+
+ Syncs 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. +
+_syncUIPosAlign
+
+
+ ()
+
+
+
+
+
+
+
+ protected
+
+
+
+
+
+
+
+
+
+
+
+
+ Synchronizes the current align Attribute value to the DOM.
This method is invoked after syncUI has been invoked for the Widget
+class using the AOP infrastructure.
_syncUIPosition
+
+
+ ()
+
+
+
+
+
+
+
+ protected
+
+
+
+
+
+
+
+
+
+
+
+
+ Synchronizes the UI to match the Widgets xy page position state.
+ ++This method in invoked after syncUI is invoked for the Widget class +using YUI's aop infrastructure. +
+_syncUIStack
+
+
+ ()
+
+
+
+
+
+
+
+ protected
+
+
+
+
+
+
+
+
+
+
+
+
+ Synchronizes the UI to match the Widgets stack state. This method in +invoked after syncUI is invoked for the Widget class using YUI's aop infrastructure.
+_syncUIStdMod
+
+
+ ()
+
+
+
+
+
+
+
+ protected
+
+
+
+
+
+
+
+
+
+
+
+
+ Synchronizes the UI to match the Widgets standard module state.
+ ++This method is invoked after syncUI is invoked for the Widget class +using YUI's aop infrastructure. +
+_uiInsertButton
+
+
+ -
+
+
-
+
+
button+ +
+
+ -
+
+
section+ +
+
+ -
+
+
index+ +
+
+
Inserts the specified button node into this widget's DOM at the specified
+section and index and updates the section content.
The section and button container nodes will be created if they do not +already exist.
+_uiRemoveButton
+
+
+ -
+
+
-
+
+
button+ +
+
+ -
+
+
section+ +
+
+ -
+
+
[options]+ +
+
+
Removes the button node from this widget's DOM and detaches any event
+subscriptions on the button that were created by this widget. The section
+content will be updated unless {preserveContent: true} is passed in the
+options.
By default the button container node will be removed when this removes the
+last button of the specified section; and if no other content remains in
+the section node, it will also be removed.
Parameters:
+ +-
+
+
-
+
+
button+ Node + + + + +++ + +The button to remove and destroy.
+
+
+ -
+
+
section+ String + + + + +++ + +The
+WidgetStdModsection (header/body/footer).
+
+ -
+
+
[options]+ Object + optional + + + + +++ + +Additional options.
+-
+
+
-
+
+
[preserveContent=false]+ Boolean + optional + + +++ + +Whether the section + content should be updated.
+
+
+
+
+ -
+
+
_uiSetAlign
+
+
+ -
+
+
-
+
+
[node]+ +
+
+ -
+
+
points+ +
+
+
Updates the UI to reflect the align value passed in.
Note: See the align Attribute documentation, for the Object structure
+expected.
_uiSetButtons
+
+
+ -
+
+
-
+
+
buttons+ +
+
+
Sets the current buttons state to this widget's DOM by rendering the
+specified collection of buttons and updates the contents of each section
+as needed.
Button nodes which already exist in the DOM will remain intact, or will be
+moved if they should be in a new position. Old button nodes which are no
+longer represented in the specified buttons collection will be removed,
+and any event subscriptions on the button which were created by this widget
+will be detached.
If the button nodes in this widget's DOM actually change, then each content +section will be updated (or removed) appropriately.
+Parameters:
+ +-
+
+
-
+
+
buttons+ Object + + + + +++ + +The current
+buttonsstate to visually represent.
+
+
_uiSetChildSelected
+
+
+ -
+
+
-
+
+
selected+ +
+
+
Updates the UI to reflect the selected attribute value.
Parameters:
+ +-
+
+
-
+
+
selected+ Number + + + + +++ + +The selected value to be reflected in the UI.
+
+
+
_uiSetDefaultButton
+
+
+ -
+
+
-
+
+
newButton+ +
+
+ -
+
+
oldButton+ +
+
+
Adds the "yui3-button-primary" CSS class to the new defaultButton and
+removes it from the old default button.
_uiSetDim
+
+
+ -
+
+
-
+
+
dim+ +
+
+ -
+
+
val+ +
+
+
_uiSetDisabled
+
+
+ -
+
+
-
+
+
val+ +
+
+
Sets the disabled state for the UI
+Parameters:
+ +-
+
+
-
+
+
val+ Boolean + + + + ++ ++ + +
+
+
_uiSetFillHeight
+
+
+ -
+
+
-
+
+
fillSection+ +
+
+
Updates the rendered UI, to resize the provided section so that the standard module fills out +the specified widget height. Note: This method does not check whether or not a height is set +on the Widget.
+Parameters:
+ +-
+
+
-
+
+
fillSection+ String + + + + +++ + +A valid section specifier - one of WidgetStdMod.HEADER, WidgetStdMod.BODY or WidgetStdMod.FOOTER
+
+
+
_uiSetFocused
+
+
+ -
+
+
-
+
+
val+ +
+
+ -
+
+
src+ +
+
+
Sets the focused state for the UI
+_uiSetHeight
+
+
+ -
+
+
-
+
+
val+ +
+
+
Sets the height on the widget's bounding box element
+_uiSetHostVisibleAutohide
+
+
+ ()
+
+
+
+
+
+
+
+ protected
+
+
+
+
+
+
+
+
+
+
+
+
+ Removes event listeners if widget is not visible, and attaches them otherwise.
+_uiSetHostVisibleModal
+
+
+ -
+
+
-
+
+
Whether+ +
+
+
Performs events attaching/detaching, stack shifting and mask repositioning based on the visibility of the widget
+Parameters:
+ +-
+
+
-
+
+
Whether+ Boolean + + + + +++ + +the widget is visible or not
+
+
+
_uiSetHostZIndexModal
+
+
+ -
+
+
-
+
+
Z-Index+ +
+
+
Sets the z-index of the mask node.
+Parameters:
+ +-
+
+
-
+
+
Z-Index+ Number + + + + +++ + +of the widget
+
+
+
_uiSetShim
+
+
+ -
+
+
-
+
+
enable+ +
+
+
Updates the UI to enable/disable the shim. If the widget is not currently visible, +creation of the shim is deferred until it is made visible, for performance reasons.
+Parameters:
+ +-
+
+
-
+
+
enable+ Boolean + + + + +++ + +If true, creates/renders the shim, if false, removes it.
+
+
+
_uiSetStdMod
+
+
+ -
+
+
-
+
+
section+ +
+
+ -
+
+
content+ +
+
+ -
+
+
where+ +
+
+
Updates the rendered UI, adding the provided content (either an HTML string, or node reference),
+to the specified section. The content is either added before, after or replaces existing content
+in the section, based on the value of the where argument.
Parameters:
+ +-
+
+
-
+
+
section+ String + + + + +++ + +The section to be updated. Either WidgetStdMod.HEADER, WidgetStdMod.BODY or WidgetStdMod.FOOTER.
+
+
+ -
+
+
content+ String | Node + + + + +++ + +The new content (either as an HTML string, or Node reference) to add to the section
+
+
+ -
+
+
where+ String + + + + +++ + +Optional. Either WidgetStdMod.AFTER, WidgetStdMod.BEFORE or WidgetStdMod.REPLACE. +If not provided, the content will replace existing content in the section.
+
+
+
_uiSetTabIndex
+
+
+ -
+
+
-
+
+
Number+ +
+
+
Set the tabIndex on the widget's rendered UI
+Parameters:
+ +-
+
+
-
+
+
Number+ Object + + + + ++ ++ + +
+
+
_uiSetVisible
+
+
+ -
+
+
-
+
+
val+ +
+
+
Sets the visible state for the UI
+Parameters:
+ +-
+
+
-
+
+
val+ Boolean + + + + ++ ++ + +
+
+
_uiSetVisibleButtons
+
+
+ -
+
+
-
+
+
visible+ +
+
+
Focuses this widget's defaultButton if there is one and this widget is
+visible.
Parameters:
+ +-
+
+
-
+
+
visible+ Boolean + + + + +++ + +Whether this widget is visible.
+
+
+
_uiSetVisiblePosAlign
+
+
+ -
+
+
-
+
+
visible+ +
+
+
Attaches or detaches alignment-syncing event handlers based on the widget's
+visible Attribute state.
Parameters:
+ +-
+
+
-
+
+
visible+ Boolean + + + + +++ + +The current value of the widget's
+visible+ Attribute.
+
+
_uiSetWidth
+
+
+ -
+
+
-
+
+
val+ +
+
+
Sets the width on the widget's bounding box element
+_uiSetXY
+
+
+ -
+
+
-
+
+
val+ +
+
+
Updates the UI to reflect the XY page co-ordinates passed in.
+Parameters:
+ +-
+
+
-
+
+
val+ String + + + + +++ + +The XY page co-ordinates value to be reflected in the UI
+
+
+
_uiSetZIndex
+
+
+ -
+
+
-
+
+
zIndex+ +
+
+
Updates the UI to reflect the zIndex value passed in.
+Parameters:
+ +-
+
+
-
+
+
zIndex+ Number + + + + +++ + +The zindex to be reflected in the UI
+
+
+
_uiSizeCB
+
+
+ -
+
+
-
+
+
expand+ +
+
+
Parameters:
+ +-
+
+
-
+
+
expand+ Boolean + + + + ++ ++ + +
+
+
_unbindDOM
+
+
+ ()
+
+
+
+
+
+
+
+ protected
+
+
+
+
+
+
+
+
+
+
+
+
+ _unbindUI
+
+
+ ()
+
+
+
+
+
+
+
+ protected
+
+
+
+
+
+
+
+
+
+
+
+
+ _unMapButton
+
+
+ -
+
+
-
+
+
button+ +
+
+ -
+
+
section+ +
+
+
Removes the specified button from the buttons map (both name -> button and
+section:name -> button), and nulls-out the defaultButton if it is
+currently the default button.
_updateContentButtons
+
+
+ -
+
+
-
+
+
section+ +
+
+
Updates the content attribute which corresponds to the specified section.
The method updates the section's content to its current childNodes
+(text and/or HTMLElement), or will null-out its contents if the section is
+empty. It also specifies a src of buttons on the change event facade.
Parameters:
+ +-
+
+
-
+
+
section+ String + + + + +++ + +The
+WidgetStdModsection (header/body/footer) to + update.
+
+
_updateDefaultButton
+
+
+ ()
+
+
+
+
+
+
+
+ protected
+
+
+
+
+
+
+
+
+
+
+
+
+ Updates the defaultButton attribute if it needs to be updated by comparing
+its current value with the protected _defaultButton property.
_validateFillHeight
+
+
+ -
+
+
-
+
+
val+ +
+
+
Default validator for the fillHeight attribute. Verifies that the +value set is a valid section specifier - one of WidgetStdMod.HEADER, WidgetStdMod.BODY or WidgetStdMod.FOOTER, +or a falsey value if fillHeight is to be disabled.
+Parameters:
+ +-
+
+
-
+
+
val+ String + + + + +++ + +The section which should be setup to fill height, or false/null to disable fillHeight
+
+
+
Returns:
+ +_validateXY
+
+
+ -
+
+
-
+
+
val+ +
+
+
Default validator for the XY attribute
+Parameters:
+ +-
+
+
-
+
+
val+ Array + + + + +++ + +The XY page co-ordinate value which is being set.
+
+
+
Returns:
+ +_validTabIndex
+
+
+ -
+
+
-
+
+
tabIndex+ +
+
+
Parameters:
+ +-
+
+
-
+
+
tabIndex+ Number + + + + ++ ++ + +
+
+
addAttr
+
+
+ -
+
+
-
+
+
name+ +
+
+ -
+
+
config+ +
+
+ -
+
+
lazy+ +
+
+
+Adds an attribute with the provided configuration to the host object. +
+ ++The config argument object supports the following properties: +
+ +-
+
- value <Any> +
- The initial value to set on the attribute + +
- valueFn <Function | String> +
-
+
A function, which will return the initial value to set on the attribute. This is useful + for cases where the attribute configuration is defined statically, but needs to + reference the host instance ("this") to obtain an initial value. If both the value and valueFn properties are defined, + the value returned by the valueFn has precedence over the value property, unless it returns undefined, in which + case the value property is used.
+ +valueFn can also be set to a string, representing the name of the instance method to be used to retrieve the value.
+
+
+ - readOnly <boolean> +
- Whether or not the attribute is read only. Attributes having readOnly set to true + cannot be modified by invoking the set method. + +
- writeOnce <boolean> or <string> +
-
+ Whether or not the attribute is "write once". Attributes having writeOnce set to true,
+ can only have their values set once, be it through the default configuration,
+ constructor configuration arguments, or by invoking set.
+
The writeOnce attribute can also be set to the string "initOnly", + in which case the attribute can only be set during initialization + (when used with Base, this means it can only be set during construction)
+
+
+ - setter <Function | String> +
-
+
The setter function used to massage or normalize the value passed to the set method for the attribute. + The value returned by the setter will be the final stored value. Returning + Attribute.INVALID_VALUE, from the setter will prevent + the value from being stored. +
+ +setter can also be set to a string, representing the name of the instance method to be used as the setter function.
+
+
+ - getter <Function | String> +
-
+
+ The getter function used to massage or normalize the value returned by the get method for the attribute. + The value returned by the getter function is the value which will be returned to the user when they + invoke get. +
+ +getter can also be set to a string, representing the name of the instance method to be used as the getter function.
+
+
+ - validator <Function | String> +
-
+
+ The validator function invoked prior to setting the stored value. Returning + false from the validator function will prevent the value from being stored. +
+ +validator can also be set to a string, representing the name of the instance method to be used as the validator function.
+
+
+ - lazyAdd <boolean> +
- Whether or not to delay initialization of the attribute until the first call to get/set it. + This flag can be used to over-ride lazy initialization on a per attribute basis, when adding multiple attributes through + the addAttrs method. + +
The setter, getter and validator are invoked with the value and name passed in as the first and second arguments, and with +the context ("this") set to the host object.
+ +Configuration properties outside of the list mentioned above are considered private properties used internally by attribute, +and are not intended for public use.
+Parameters:
+ +-
+
+
-
+
+
name+ String + + + + +++ + +The name of the attribute.
+
+
+ -
+
+
config+ Object + + + + +++ + +An object with attribute configuration property/value pairs, specifying the configuration for the attribute.
+ ++NOTE: The configuration object is modified when adding an attribute, so if you need +to protect the original values, you will need to merge the object. +
+
+
+ -
+
+
lazy+ Boolean + + + + +++ + +(optional) Whether or not to add this attribute lazily (on the first call to get/set).
+
+
+
Returns:
+ +addAttrs
+
+
+ -
+
+
-
+
+
cfgs+ +
+
+ -
+
+
values+ +
+
+ -
+
+
lazy+ +
+
+
Configures a group of attributes, and sets initial values.
+ ++NOTE: This method does not isolate the configuration object by merging/cloning. +The caller is responsible for merging/cloning the configuration object if required. +
+Parameters:
+ +-
+
+
-
+
+
cfgs+ Object + + + + +++ + +An object with attribute name/configuration pairs.
+
+
+ -
+
+
values+ Object + + + + +++ + +An object with attribute name/value pairs, defining the initial values to apply. +Values defined in the cfgs argument will be over-written by values in this argument unless defined as read only.
+
+
+ -
+
+
lazy+ Boolean + + + + +++ + +Whether or not to delay the intialization of these attributes until the first call to get/set. +Individual attributes can over-ride this behavior by defining a lazyAdd configuration property in their configuration. +See addAttr.
+
+
+
Returns:
+ +addButton
+
+
+ -
+
+
-
+
+
button+ +
+
+ -
+
+
[section="footer"]+ +
+
+ -
+
+
[index]+ +
+
+
Adds a button to this widget.
+ +The new button node will have the Y.Plugin.Button plugin applied, be added
+to this widget's buttons, and rendered in the specified section at the
+specified index (or end of the section when no index is provided). If
+the section does not exist, it will be created.
This fires the buttonsChange event and adds the following properties to
+the event facade:
-
+
button: The button node or config object to add.
+section: TheWidgetStdModsection (header/body/footer) where the +button will be added.
+index: The index at which the button will be in the section.
+src: "add"
+
Note: The index argument will be passed to the Array splice()
+method, therefore a negative value will insert the button that many items
+from the end. The index property on the buttonsChange event facade is
+the index at which the button was added.
Parameters:
+ +-
+
+
-
+
+
button+ Node | Object | String + + + + +++ + +The button to add. This can be a
+Y.Node+ instance, config Object, or String name for a predefined button on the +BUTTONSprototype property. When a config Object is provided, it will + be merged with any defaults provided by anysrcNodeand/or a button + with the samenamedefined on theBUTTONSproperty. The following + are the possible configuration properties beyond what Node plugins + accept by default:-
+
+
-
+
+
[action]+ Function | String + optional + + +++ + +The default handler that should + be called when the button is clicked. A String name of a Function that + exists on the
+contextobject can also be provided. Note: + Specifying a set ofeventswill override this setting.
+
+ -
+
+
[classNames]+ String | String[] + optional + + +++ + +Additional CSS classes to add + to the button node.
+
+
+ -
+
+
[context=this]+ Object + optional + + +++ + +Context which any
+eventsor +actionshould be called with. Defaults tothis, the widget. + Note:e.targetwill access the button node in the event handlers.
+
+ -
+
+
[disabled=false]+ Boolean + optional + + +++ + +Whether the button should be + disabled.
+
+
+ -
+
+
[events="click"]+ String | Object + optional + + +++ + +Event name, or set of + events and handlers to bind to the button node. See:
+Y.Node.on(), + this value is passed as the first argument toon().
+
+ -
+
+
[isDefault=false]+ Boolean + optional + + +++ + +Whether the button is the + default button.
+
+
+ -
+
+
[label]+ String + optional + + +++ + +The visible text/value displayed in the + button.
+
+
+ -
+
+
[name]+ String + optional + + +++ + +A name which can later be used to reference + this button. If a button is defined on the
+BUTTONSproperty with this + same name, its configuration properties will be merged in as defaults.
+
+ -
+
+
[section]+ String + optional + + +++ + +The
+WidgetStdModsection (header, body, + footer) where the button should be added.
+
+ -
+
+
[srcNode]+ Node + optional + + +++ + +An existing Node to use for the button, + default values will be seeded from this node, but are overriden by any + values specified in the config object. By default a new <button> + node will be created.
+
+
+ -
+
+
[template]+ String + optional + + +++ + +A specific template to use when creating + a new button node (e.g. "<a />"). Note: Specifying a
+srcNode+ will overide this.
+
+
+
+ -
+
+
-
+
+
[section="footer"]+ String + optional + + + + +++ + +The
+WidgetStdModsection + (header/body/footer) where the button should be added. This takes + precedence over thebutton.sectionconfiguration property.
+
+ -
+
+
[index]+ Number + optional + + + + +++ + +The index at which the button should be inserted. If + not specified, the button will be added to the end of the section. This + value is passed to the Array
+splice()method, therefore a negative + value will insert thebuttonthat many items from the end.
+
+
addTarget
+
+
+ -
+
+
-
+
+
o+ +
+
+
Registers another EventTarget as a bubble target. Bubble order +is determined by the order registered. Multiple targets can +be specified.
+ +Events can only bubble if emitFacade is true.
+ +Included in the event-custom-complex submodule.
+Parameters:
+ +-
+
+
-
+
+
o+ EventTarget + + + + +++ + +the target to add
+
+
+
after
+
+
+ -
+
+
-
+
+
type+ +
+
+ -
+
+
fn+ +
+
+ -
+
+
[context]+ +
+
+ -
+
+
[arg*]+ +
+
+
Subscribe to a custom event hosted by this object. The +supplied callback will execute after any listeners add +via the subscribe method, and after the default function, +if configured for the event, has executed.
+Parameters:
+ +-
+
+
-
+
+
type+ String + + + + +++ + +The name of the event
+
+
+ -
+
+
fn+ Function + + + + +++ + +The callback to execute in response to the event
+
+
+ -
+
+
[context]+ Object + optional + + + + +++ + +Override
+thisobject in callback
+
+ -
+
+
[arg*]+ Any + optional + + + + +++ + +0..n additional arguments to supply to the subscriber
+
+
+
Returns:
+ +align
+
+
+ -
+
+
-
+
+
[node]+ +
+
+ -
+
+
[points]+ +
+
+
Aligns this widget to the provided Node (or viewport) using the provided
+points. This method can be invoked with no arguments which will cause the
+widget's current align Attribute value to be synced to the DOM.
Parameters:
+ +-
+
+
-
+
+
[node]+ Node | String | Null + optional + + + + +++ + +A reference (or selector String) for the +
+Nodewhich with the widget is to be aligned. If null is passed in, the + widget will be aligned with the viewport.
+
+ -
+
+
[points]+ Array2 + optional + + + + +++ + +A two item array specifying the points on the + widget and
+Node/viewport which will to be aligned. The first entry is + the point on the widget, and the second entry is the point on the +Node/viewport. Valid point references are defined as static constants on + theWidgetPositionAlignextension.
+
+
Example:
+ +Aligning to the top-left corner of the <body>:
myWidget.align('body',
+ [Y.WidgetPositionAlign.TL, Y.WidgetPositionAlign.TR]);
+ancestor
+
+
+ -
+
+
-
+
+
depth+ +
+
+
Returns the Widget instance at the specified depth.
+Parameters:
+ +-
+
+
-
+
+
depth+ Number + + + + +++ + +Number representing the depth of the ancestor.
+
+
+
Returns:
+ +attrAdded
+
+
+ -
+
+
-
+
+
name+ +
+
+
Checks if the given attribute has been added to the host
+Parameters:
+ +-
+
+
-
+
+
name+ String + + + + +++ + +The name of the attribute to check.
+
+
+
Returns:
+ +before
+
+
+ ()
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Executes the callback before a DOM event, custom event +or method. If the first argument is a function, it +is assumed the target is a method. For DOM and custom +events, this is an alias for Y.on.
+ +For DOM and custom events: +type, callback, context, 0-n arguments
+ +For methods: +callback, object (method host), methodName, context, 0-n arguments
+Returns:
+ +bindUI
+
+
+ ()
+
+
+
+
+
+
+
+ protected
+
+
+
+
+
+
+
+
+
+
+
+
+ Configures/Sets up listeners to bind Widget State to UI/DOM
+ +This method is not called by framework and is not chained +automatically for the class hierarchy.
+blur
+
+
+ ()
+
+
+
+
+
+
+
+
+
+
+
+
+
+ chainable
+
+
+
+
+
+
+ Causes the Widget to lose focus by setting the "focused" attribute +to "false"
+bubble
+
+
+ -
+
+
-
+
+
evt+ +
+
+
Propagate an event. Requires the event-custom-complex module.
+Parameters:
+ +-
+
+
-
+
+
evt+ CustomEvent + + + + +++ + +the custom event to propagate
+
+
+
Returns:
+ +centered
+
+
+ -
+
+
-
+
+
[node]+ +
+
+
Centers the widget in the viewport, or if a Node is passed in, it will
+be centered to that Node.
constrain
+
+
+ -
+
+
-
+
+
xy+ +
+
+ -
+
+
node+ +
+
+
Constrains the widget's bounding box to a node (or the viewport). If xy or node are not +passed in, the current position and the value of "constrain" will be used respectively.
+ +The widget's position will be changed to the constrained position.
+destroy
+
+
+ -
+
+
-
+
+
destroyAllNodes+ +
+
+
+Destroy lifecycle method. Fires the destroy +event, prior to invoking destructors for the +class hierarchy. + +Overrides Base's implementation, to support arguments to destroy +
+ ++Subscribers to the destroy +event can invoke preventDefault on the event object, to prevent destruction +from proceeding. +
+Parameters:
+ +-
+
+
-
+
+
destroyAllNodes+ Boolean + + + + +++ + +If true, all nodes contained within the Widget are +removed and destroyed. Defaults to false due to potentially high run-time cost.
+
+
+
Returns:
+ +destructor
+
+
+ ()
+
+
+
+
+
+
+
+ protected
+
+
+
+
+
+
+
+
+
+
+
+
+ Destructor lifecycle implementation for the Widget class. Purges events attached +to the bounding box and content box, removes them from the DOM and removes +the Widget from the list of registered widgets.
+detach
+
+
+ -
+
+
-
+
+
type+ +
+
+ -
+
+
fn+ +
+
+ -
+
+
context+ +
+
+
Detach one or more listeners the from the specified event
+Parameters:
+ +-
+
+
-
+
+
type+ String | Object + + + + +++ + +Either the handle to the subscriber or the + type of event. If the type + is not specified, it will attempt to remove + the listener from all hosted events.
+
+
+ -
+
+
fn+ Function + + + + +++ + +The subscribed function to unsubscribe, if not + supplied, all subscribers will be removed.
+
+
+ -
+
+
context+ Object + + + + +++ + +The custom object passed to subscribe. This is + optional, but if supplied will be used to + disambiguate multiple listeners that are the same + (e.g., you subscribe many object using a function + that lives on the prototype)
+
+
+
Returns:
+ +detachAll
+
+
+ -
+
+
-
+
+
type+ +
+
+
Removes all listeners from the specified event. If the event type +is not specified, all listeners from all hosted custom events will +be removed.
+Parameters:
+ +-
+
+
-
+
+
type+ String + + + + +++ + +The type, or name of the event
+
+
+
disable
+
+
+ ()
+
+
+
+
+
+
+
+
+
+
+
+
+
+ chainable
+
+
+
+
+
+
+ Set the Widget's "disabled" attribute to "true".
+enable
+
+
+ ()
+
+
+
+
+
+
+
+
+
+
+
+
+
+ chainable
+
+
+
+
+
+
+ Set the Widget's "disabled" attribute to "false".
+enable or disable constraints listeners
+
+
+ -
+
+
-
+
+
enable+ +
+
+
Updates the UI if enabling constraints, and sets up the xyChange event listeners +to constrain whenever the widget is moved. Disabling constraints removes the listeners.
+Parameters:
+ +-
+
+
-
+
+
enable+ Boolean + + + + +++ + +Enable or disable constraints
+
+
+
fillHeight
+
+
+ -
+
+
-
+
+
node+ +
+
+
Sets the height on the provided header, body or footer element to +fill out the height of the Widget. It determines the height of the +widgets bounding box, based on it's configured height value, and +sets the height of the provided section to fill out any +space remaining after the other standard module section heights +have been accounted for.
+ +NOTE: This method is not designed to work if an explicit +height has not been set on the Widget, since for an "auto" height Widget, +the heights of the header/body/footer will drive the height of the Widget.
+Parameters:
+ +-
+
+
-
+
+
node+ Node + + + + +++ + +The node which should be resized to fill out the height +of the Widget bounding box. Should be a standard module section node which belongs +to the widget.
+
+
+
fire
+
+
+ -
+
+
-
+
+
type+ +
+
+ -
+
+
arguments+ +
+
+
Fire a custom event by name. The callback functions will be executed +from the context specified when the event was created, and with the +following parameters.
+ +If the custom event object hasn't been created, then the event hasn't +been published and it has no subscribers. For performance sake, we +immediate exit in this case. This means the event won't bubble, so +if the intention is that a bubble target be notified, the event must +be published on this object first.
+ +The first argument is the event type, and any additional arguments are +passed to the listeners as parameters. If the first of these is an +object literal, and the event is configured to emit an event facade, +that object is mixed into the event facade and the facade is provided +in place of the original object.
+Parameters:
+ +-
+
+
-
+
+
type+ String | Object + + + + +++ + +The type of the event, or an object that contains +a 'type' property.
+
+
+ -
+
+
arguments+ Object* + + + + +++ + +an arbitrary set of parameters to pass to +the handler. If the first of these is an object literal and the event is +configured to emit an event facade, the event facade will replace that +parameter after the properties the object literal contains are copied to +the event facade.
+
+
+
Returns:
+ +focus
+
+
+ ()
+
+
+
+
+
+
+
+
+
+
+
+
+
+ chainable
+
+
+
+
+
+
+ Causes the Widget to receive the focus by setting the "focused" +attribute to "true".
+get
+
+
+ -
+
+
-
+
+
name+ +
+
+
Returns the current value of the attribute. If the attribute +has been configured with a 'getter' function, this method will delegate +to the 'getter' to obtain the value of the attribute.
+Parameters:
+ +-
+
+
-
+
+
name+ String + + + + +++ + +The name of the attribute. If the value of the attribute is an Object, +dot notation can be used to obtain the value of a property of the object (e.g.
+get("x.y.z"))
+
+
Returns:
+ +getAttrs
+
+
+ -
+
+
-
+
+
attrs+ +
+
+
Gets multiple attribute values.
+Parameters:
+ +-
+
+
-
+
+
attrs+ Array | boolean + + + + +++ + +Optional. An array of attribute names. If omitted, all attribute values are +returned. If set to true, all attributes modified from their initial values are returned.
+
+
+
Returns:
+ +getButton
+
+
+ -
+
+
-
+
+
name+ +
+
+ -
+
+
[section="footer"]+ +
+
+
Returns a button node from this widget's buttons.
Parameters:
+ +-
+
+
-
+
+
name+ Number | String + + + + +++ + +The string name or index of the button.
+
+
+ -
+
+
[section="footer"]+ String + optional + + + + +++ + +The
+WidgetStdModsection + (header/body/footer) where the button exists. Only applicable when + looking for a button by numerical index, or by name but scoped to a + particular section.
+
+
Returns:
+ +getClassName
+
+
+ -
+
+
-
+
+
args+ +
+
+
Generate a standard prefixed classname for the Widget, prefixed by the default prefix defined
+by the Y.config.classNamePrefix attribute used by ClassNameManager and
+Widget.NAME.toLowerCase() (e.g. "yui-widget-xxxxx-yyyyy", based on default values for
+the prefix and widget class name).
+The instance based version of this method can be used to generate standard prefixed classnames, +based on the instances NAME, as opposed to Widget.NAME. This method should be used when you +need to use a constant class name across different types instances. +
+Parameters:
+ +-
+
+
-
+
+
args+ String* + + + + multiple + + +++ + +0..n strings which should be concatenated, using the default separator defined by ClassNameManager, to create the class name
+
+
+
getConstrainedXY
+
+
+ -
+
+
-
+
+
xy+ +
+
+ -
+
+
node+ +
+
+
Calculates the constrained positions for the XY positions provided, using +the provided node argument is passed in. If no node value is passed in, the value of +the "constrain" attribute is used.
+Parameters:
+ + +Returns:
+ +getDefaultLocale
+
+
+ ()
+
+
+
+
+ String
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Returns the default locale for the widget (the locale value defined by the +widget class, or provided by the user during construction).
+Returns:
+ +getEvent
+
+
+ -
+
+
-
+
+
type+ +
+
+ -
+
+
prefixed+ +
+
+
Returns the custom event of the provided type has been created, a +falsy value otherwise
+Parameters:
+ + +Returns:
+ +getSkinName
+
+
+ -
+
+
-
+
+
[skinPrefix]+ +
+
+
Returns the name of the skin that's currently applied to the widget.
+ +Searches up the Widget's ancestor axis for, by default, a class +yui3-skin-(name), and returns the (name) portion. Otherwise, returns null.
+ +This is only really useful after the widget's DOM structure is in the +document, either by render or by progressive enhancement.
+Parameters:
+ +-
+
+
-
+
+
[skinPrefix]+ String + optional + + + + +++ + +The prefix which the implementation uses for the skin +("yui3-skin-" is the default).
+ +NOTE: skinPrefix will be used as part of a regular expression:
+ +
+ +new RegExp('\\b' + skinPrefix + '(\\S+)') +Although an unlikely use case, literal characters which may result in an invalid +regular expression should be escaped.
+
+
+
Returns:
+ +getStdModNode
+
+
+ -
+
+
-
+
+
section+ +
+
+ -
+
+
forceCreate+ +
+
+
Returns the node reference for the specified section.
Note: The DOM is not queried for the node reference. The reference
+stored by the widget instance is returned if it was set. Passing a
+truthy for forceCreate will create the section node if it does not
+already exist.
Parameters:
+ + +Returns:
+ +section, or null if not set.
+
+ getString
+
+
+ -
+
+
-
+
+
key+ +
+
+
Helper method to get a specific string value
+Parameters:
+ +-
+
+
-
+
+
key+ String + + + + ++ ++ + +
+
+
Returns:
+ +getStrings
+
+
+ -
+
+
-
+
+
key+ +
+
+
Helper method to get the complete set of strings for the widget
+Parameters:
+ +-
+
+
-
+
+
key+ String + + + + ++ ++ + +
+
+
Returns:
+ +getTargets
+
+
+ ()
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Returns an array of bubble targets for this object.
+Returns:
+ +hide
+
+
+ ()
+
+
+
+
+
+
+
+
+
+
+
+
+
+ chainable
+
+
+
+
+
+
+ Hides the Widget by setting the "visible" attribute to "false".
+init
+
+
+ -
+
+
-
+
+
cfg+ +
+
+
Init lifecycle method, invoked during construction. Sets up attributes +and invokes initializers for the class hierarchy.
+Parameters:
+ +-
+
+
-
+
+
cfg+ Object + + + + +++ + +Object with configuration property name/value pairs
+
+
+
Returns:
+ +initializer
+
+
+ -
+
+
-
+
+
config+ +
+
+
Initializer lifecycle implementation for the Widget class. Registers the +widget instance, and runs through the Widget's HTML_PARSER definition.
+Parameters:
+ +-
+
+
-
+
+
config+ Object + + + + +++ + +Configuration object literal for the widget
+
+
+
isNested
+
+
+ ()
+
+
+
+
+
+
+
+ public
+
+
+
+
+
+
+
+
+
+
+
+
+ Returns 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.
+isRoot
+
+
+ ()
+
+
+
+
+ Boolean
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Determines if the Widget is the root Widget in the +object hierarchy.
+Returns:
+ +modifyAttr
+
+
+ -
+
+
-
+
+
name+ +
+
+ -
+
+
config+ +
+
+
Updates the configuration of an attribute which has already been added.
+ ++The properties which can be modified through this interface are limited +to the following subset of attributes, which can be safely modified +after a value has already been set on the attribute: readOnly, writeOnce, +broadcast and getter. +
+move
+
+
+ -
+
+
-
+
+
x+ +
+
+ -
+
+
y+ +
+
+ -
+
+
x,+ +
+
+
Moves the Widget to the specified page xy co-ordinate position.
+next
+
+
+ -
+
+
-
+
+
circular+ +
+
+
Returns the Widget's next sibling.
+Parameters:
+ +-
+
+
-
+
+
circular+ Boolean + + + + +++ + +Boolean indicating if the parent's first child +should be returned if the child has no next sibling.
+
+
+
Returns:
+ +on
+
+
+ -
+
+
-
+
+
type+ +
+
+ -
+
+
fn+ +
+
+ -
+
+
[context]+ +
+
+ -
+
+
[arg*]+ +
+
+
Subscribe a callback function to a custom event fired by this object or +from an object that bubbles its events to this object.
+ +Callback functions for events published with emitFacade = true will
+receive an EventFacade as the first argument (typically named "e").
+These callbacks can then call e.preventDefault() to disable the
+behavior published to that event's defaultFn. See the EventFacade
+API for all available properties and methods. Subscribers to
+non-emitFacade events will receive the arguments passed to fire()
+after the event name.
To subscribe to multiple events at once, pass an object as the first +argument, where the key:value pairs correspond to the eventName:callback, +or pass an array of event names as the first argument to subscribe to +all listed events with the same callback.
+ +Returning false from a callback is supported as an alternative to
+calling e.preventDefault(); e.stopPropagation();. However, it is
+recommended to use the event methods whenever possible.
Parameters:
+ +-
+
+
-
+
+
type+ String + + + + +++ + +The name of the event
+
+
+ -
+
+
fn+ Function + + + + +++ + +The callback to execute in response to the event
+
+
+ -
+
+
[context]+ Object + optional + + + + +++ + +Override
+thisobject in callback
+
+ -
+
+
[arg*]+ Any + optional + + + + +++ + +0..n additional arguments to supply to the subscriber
+
+
+
Returns:
+ +once
+
+
+ -
+
+
-
+
+
type+ +
+
+ -
+
+
fn+ +
+
+ -
+
+
[context]+ +
+
+ -
+
+
[arg*]+ +
+
+
Listen to a custom event hosted by this object one time.
+This is the equivalent to on except the
+listener is immediatelly detached when it is executed.
Parameters:
+ +-
+
+
-
+
+
type+ String + + + + +++ + +The name of the event
+
+
+ -
+
+
fn+ Function + + + + +++ + +The callback to execute in response to the event
+
+
+ -
+
+
[context]+ Object + optional + + + + +++ + +Override
+thisobject in callback
+
+ -
+
+
[arg*]+ Any + optional + + + + +++ + +0..n additional arguments to supply to the subscriber
+
+
+
Returns:
+ +onceAfter
+
+
+ -
+
+
-
+
+
type+ +
+
+ -
+
+
fn+ +
+
+ -
+
+
[context]+ +
+
+ -
+
+
[arg*]+ +
+
+
Listen to a custom event hosted by this object one time.
+This is the equivalent to after except the
+listener is immediatelly detached when it is executed.
Parameters:
+ +-
+
+
-
+
+
type+ String + + + + +++ + +The name of the event
+
+
+ -
+
+
fn+ Function + + + + +++ + +The callback to execute in response to the event
+
+
+ -
+
+
[context]+ Object + optional + + + + +++ + +Override
+thisobject in callback
+
+ -
+
+
[arg*]+ Any + optional + + + + +++ + +0..n additional arguments to supply to the subscriber
+
+
+
Returns:
+ +parseType
+
+
+ -
+
+
-
+
+
type+ +
+
+ -
+
+
[pre=this._yuievt.config.prefix]+ +
+
+
Takes the type parameter passed to 'on' and parses out the +various pieces that could be included in the type. If the +event type is passed without a prefix, it will be expanded +to include the prefix one is supplied or the event target +is configured with a default prefix.
+Parameters:
+ + +Returns:
+ +previous
+
+
+ -
+
+
-
+
+
circular+ +
+
+
Returns the Widget's previous sibling.
+Parameters:
+ +-
+
+
-
+
+
circular+ Boolean + + + + +++ + +Boolean indicating if the parent's last child +should be returned if the child has no previous sibling.
+
+
+
Returns:
+ +publish
+
+
+ -
+
+
-
+
+
type+ +
+
+ -
+
+
opts+ +
+
+
Creates a new custom event of the specified type. If a custom event +by that name already exists, it will not be re-created. In either +case the custom event is returned.
+Parameters:
+ +-
+
+
-
+
+
type+ String + + + + +++ + +the type, or name of the event
+
+
+ -
+
+
opts+ Object + + + + +++ + +optional config params. Valid properties are:
+ +-
+
- + 'broadcast': whether or not the YUI instance and YUI global are notified when the event is fired (false) + +
- + 'bubbles': whether or not this event bubbles (true) + Events can only bubble if emitFacade is true. + +
- + 'context': the default execution context for the listeners (this) + +
- + 'defaultFn': the default function to execute when this event fires if preventDefault was not called + +
- + 'emitFacade': whether or not this event emits a facade (false) + +
- + 'prefix': the prefix for this targets events, e.g., 'menu' in 'menu:click' + +
- + 'fireOnce': if an event is configured to fire once, new subscribers after + the fire will be notified immediately. + +
- + 'async': fireOnce event listeners will fire synchronously if the event has already + fired unless async is true. + +
- + 'preventable': whether or not preventDefault() has an effect (true) + +
- + 'preventedFn': a function that is executed when preventDefault is called + +
- + 'queuable': whether or not this event can be queued during bubbling (false) + +
- + 'silent': if silent is true, debug messages are not provided for this event. + +
- + 'stoppedFn': a function that is executed when stopPropagation is called + + +
- + 'monitored': specifies whether or not this event should send notifications about + when the event has been attached, detached, or published. + +
- + 'type': the event type (valid option if not provided as the first parameter to publish) + +
+
+
Returns:
+ +removeAttr
+
+
+ -
+
+
-
+
+
name+ +
+
+
Removes an attribute from the host object
+Parameters:
+ +-
+
+
-
+
+
name+ String + + + + +++ + +The name of the attribute to be removed.
+
+
+
removeButton
+
+
+ -
+
+
-
+
+
button+ +
+
+ -
+
+
[section="footer"]+ +
+
+
Removes a button from this widget.
+ +The button will be removed from this widget's buttons and its DOM. Any
+event subscriptions on the button which were created by this widget will be
+detached. If the content section becomes empty after removing the button
+node, then the section will also be removed.
This fires the buttonsChange event and adds the following properties to
+the event facade:
-
+
button: The button node to remove.
+section: TheWidgetStdModsection (header/body/footer) where the +button should be removed from.
+index: The index at which the button exists in the section.
+src: "remove"
+
Parameters:
+ +-
+
+
-
+
+
button+ Node | Number | String + + + + +++ + +The button to remove. This can be a +
+Y.Nodeinstance, index, or String name of a button.
+
+ -
+
+
[section="footer"]+ String + optional + + + + +++ + +The
+WidgetStdModsection + (header/body/footer) where the button exists. Only applicable when + removing a button by numerical index, or by name but scoped to a + particular section.
+
+
removeTarget
+
+
+ -
+
+
-
+
+
o+ +
+
+
Removes a bubble target
+Parameters:
+ +-
+
+
-
+
+
o+ EventTarget + + + + +++ + +the target to remove
+
+
+
render
+
+
+ -
+
+
-
+
+
parentNode+ +
+
+
Establishes the initial DOM for the widget. Invoking this +method will lead to the creating of all DOM elements for +the widget (or the manipulation of existing DOM elements +for the progressive enhancement use case).
+ ++This method should only be invoked once for an initialized +widget. +
+ ++It delegates to the widget specific renderer method to do +the actual work. +
+Parameters:
+ +-
+
+
-
+
+
parentNode+ Object | String + + + + +++ + +Optional. The Node under which the +Widget is to be rendered. This can be a Node instance or a CSS selector string.
+ ++If the selector string returns more than one Node, the first node will be used +as the parentNode. NOTE: This argument is required if both the boundingBox and contentBox +are not currently in the document. If it's not provided, the Widget will be rendered +to the body of the current document in this case. +
+
+
+
renderer
+
+
+ ()
+
+
+
+
+
+
+
+ protected
+
+
+
+
+
+
+
+
+
+
+
+
+ Creates DOM (or manipulates DOM for progressive enhancement) +This method is invoked by render() and is not chained +automatically for the class hierarchy (unlike initializer, destructor) +so it should be chained manually for subclasses if required.
+renderUI
+
+
+ ()
+
+
+
+
+
+
+
+ protected
+
+
+
+
+
+
+
+
+
+
+
+
+ Adds nodes to the DOM
+ +This method is not called by framework and is not chained +automatically for the class hierarchy.
+reset
+
+
+ -
+
+
-
+
+
name+ +
+
+
Resets the attribute (or all attributes) to its initial value, as long as +the attribute is not readOnly, or writeOnce.
+Parameters:
+ +-
+
+
-
+
+
name+ String + + + + +++ + +Optional. The name of the attribute to reset. If omitted, all attributes are reset.
+
+
+
Returns:
+ +set
+
+
+ -
+
+
-
+
+
name+ +
+
+ -
+
+
value+ +
+
+ -
+
+
[opts]+ +
+
+
Sets the value of an attribute.
+Parameters:
+ +-
+
+
-
+
+
name+ String + + + + +++ + +The name of the attribute. If the +current value of the attribute is an Object, dot notation can be used +to set the value of a property within the object (e.g.
+set("x.y.z", 5)).
+
+ -
+
+
value+ Any + + + + +++ + +The value to set the attribute to.
+
+
+ -
+
+
[opts]+ Object + optional + + + + +++ + +Optional data providing the circumstances for the change.
+
+
+
Returns:
+ +setAttrs
+
+
+ -
+
+
-
+
+
attrs+ +
+
+ -
+
+
[opts]+ +
+
+
Sets multiple attribute values.
+Parameters:
+ + +Returns:
+ +setStdModContent
+
+
+ -
+
+
-
+
+
section+ +
+
+ -
+
+
content+ +
+
+ -
+
+
where+ +
+
+
Updates the body section of the standard module with the content provided (either an HTML string, or node reference).
+ +
+This method can be used instead of the corresponding section content attribute if you'd like to retain the current content of the section,
+and insert content before or after it, by specifying the where argument.
+
Parameters:
+ +-
+
+
-
+
+
section+ String + + + + +++ + +The standard module section whose content is to be updated. Either WidgetStdMod.HEADER, WidgetStdMod.BODY or WidgetStdMod.FOOTER.
+
+
+ -
+
+
content+ String | Node + + + + +++ + +The content to be added, either an HTML string or a Node reference.
+
+
+ -
+
+
where+ String + + + + +++ + +Optional. Either WidgetStdMod.AFTER, WidgetStdMod.BEFORE or WidgetStdMod.REPLACE. +If not provided, the content will replace existing content in the section.
+
+
+
show
+
+
+ ()
+
+
+
+
+
+
+
+
+
+
+
+
+
+ chainable
+
+
+
+
+
+
+ Shows the Widget by setting the "visible" attribute to "true".
+sizeShim
+
+
+ ()
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ For IE6, synchronizes the size and position of iframe shim to that of +Widget bounding box which it is protecting. For all other browsers, +this method does not do anything.
+subscribe
+
+
+ ()
+
+
+
+
+
+ deprecated
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ subscribe to an event
+syncUI
+
+
+ ()
+
+
+
+
+
+
+
+ protected
+
+
+
+
+
+
+
+
+
+
+
+
+ Refreshes the rendered UI, based on Widget State
+ +This method is not called by framework and is not chained +automatically for the class hierarchy.
+syncXY
+
+
+ ()
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Synchronizes the Panel's "xy", "x", and "y" properties with the +Widget's position in the DOM.
+toString
+
+
+ ()
+
+
+
+
+ String
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Generic toString implementation for all widgets.
+Returns:
+ +unsubscribe
+
+
+ ()
+
+
+
+
+
+ deprecated
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ detach a listener
+unsubscribeAll
+
+
+ -
+
+
-
+
+
type+ +
+
+
Removes all listeners from the specified event. If the event type +is not specified, all listeners from all hosted custom events will +be removed.
+Parameters:
+ +-
+
+
-
+
+
type+ String + + + + +++ + +The type, or name of the event
+
+
+
Properties
+ + +_allowAdHocAttrs
+ Boolean
+
+
+
+
+ protected
+
+
+
+
+
+
+
+
+ This property controls whether or not instances of this class should +allow users to add ad-hoc attributes through the constructor configuration +hash.
+ +AdHoc attributes are attributes which are not defined by the class, and are +not handled by the MyClass.NONATTRS_CFG
+Default: undefined (false)
+ + + + + +_defaultButton
+ Node
+
+
+
+
+ protected
+
+
+
+
+
+
+
+
+ Internal reference to this widget's default button.
+_posAlignUIHandles
+ Array
+
+
+
+
+ protected
+
+
+
+
+
+
+
+
+ Holds the alignment-syncing event handles.
+Default: null
+ + + + + +_UI_ATTRS
+ Object
+
+
+
+
+ private
+
+
+
+
+
+
+
+
+ The lists of UI attributes to bind and sync for widget's _bindUI and _syncUI implementations
+BOUNDING_TEMPLATE
+ String
+
+
+
+
+
+
+
+
+
+
+
+ Property defining the markup template for bounding box.
+BUTTONS
+ Object
+
+
+
+
+
+
+
+
+
+
+
+ Collection of predefined buttons mapped from name => config.
+ +Panel includes a "close" button which can be use by name. When the close +button is in the header (which is the default), it will look like: [x].
+ +See addButton() for a list of possible configuration values.
Default: {close: {}}
+ + + +Example:
+ +// Panel with close button in header.
+var panel = new Y.Panel({
+ buttons: ['close']
+});
+
+// Panel with close button in footer.
+var otherPanel = new Y.Panel({
+ buttons: {
+ footer: ['close']
+ }
+});
+BUTTONS_TEMPLATE
+ String
+
+
+
+
+
+
+
+
+
+
+
+ The HTML template to use when creating the node which wraps all buttons of a +section. By default it will have the CSS class: "yui3-widget-buttons".
+Default: "<span />"
+ + + + + +CONTENT_TEMPLATE
+ String
+
+
+
+
+
+
+
+
+
+
+
+ Property defining the markup template for content box. If your Widget doesn't +need the dual boundingBox/contentBox structure, set CONTENT_TEMPLATE to null, +and contentBox and boundingBox will both point to the same Node.
+DEF_PARENT_NODE
+ String | Node
+
+
+
+
+
+
+
+
+
+
+
+ Default node to render the bounding box to. If not set, +will default to the current document body.
+DEF_UNIT
+ String
+
+
+
+
+
+
+
+
+
+
+
+ Default unit to use for dimension values
+DEFAULT_BUTTONS_SECTION
+ String
+
+
+
+
+
+
+
+
+
+
+
+ The default section to render buttons in when no section is specified.
+Default: Y.WidgetStdMod.FOOTER
+ + + + + +name
+ String
+
+
+ deprecated
+
+
+
+
+
+
+
+
+
+
+ The string used to identify the class of this object.
+STACK
+ Unknown
+
+
+
+
+
+
+
+
+
+
+
+ A stack of Y.Widget objects representing the current hierarchy of modal widgets presently displayed on the screen
+UI_EVENTS
+ Object
+
+
+
+
+
+
+
+
+
+
+
+ Map of DOM events that should be fired as Custom Events by the +Widget instance.
+Attributes
+ + +align
+ Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ The alignment configuration for this widget.
+ +The align attribute is used to align a reference point on the widget, with
+the reference point on another Node, or the viewport. The object which
+align expects has the following properties:
-
+
node: TheNodeto which the widget is to be aligned. If set to +null, or not provided, the widget is aligned to the viewport.
+points: A two element Array, defining the two points on the widget +andNode/viewport which are to be aligned. The first element is the +point on the widget, and the second element is the point on the +Node/viewport. Supported alignment points are defined as static +properties onWidgetPositionAlign.
+
Default: null
+ + + +Fires event alignChange
+
+
+ Fires when the value for the configuration attribute align 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.
+
Parameters:
+ +-
+
-
+
e+ EventFacade + ++ An Event Facade object with the following + attribute-specific properties added: ++ +-
+
-
+
prevVal+ Any +The value of the attribute, prior to it being set.+
+ -
+
newVal+ Any +The value the attribute is to be set to.+
+ -
+
attrName+ String +The name of the attribute being set.+
+ -
+
subAttrName+ String +If setting a property within the attribute's value, the name of the sub-attribute property being set.+
+
+ -
+
Example:
+ +Aligns the top-right corner of the widget with the top-left corner +of the viewport:
+ +myWidget.set('align', {
+ points: [Y.WidgetPositionAlign.TR, Y.WidgetPositionAlign.TL]
+});
+alignOn
+ Array
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ An Array of Objects corresponding to the Nodes and events that will cause
+the alignment of this widget to be synced to the DOM.
The alignOn Attribute is expected to be an Array of Objects with the
+following properties:
-
+
eventName: The String event name to listen for.
+node: The optionalNodethat will fire the event, it can be a +Nodereference or a selector String. This will default to the widget's +boundingBox.
+
Default: []
+ + + +Fires event alignOnChange
+
+
+ Fires when the value for the configuration attribute alignOn 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.
+
Parameters:
+ +-
+
-
+
e+ EventFacade + ++ An Event Facade object with the following + attribute-specific properties added: ++ +-
+
-
+
prevVal+ Any +The value of the attribute, prior to it being set.+
+ -
+
newVal+ Any +The value the attribute is to be set to.+
+ -
+
attrName+ String +The name of the attribute being set.+
+ -
+
subAttrName+ String +If setting a property within the attribute's value, the name of the sub-attribute property being set.+
+
+ -
+
Example:
+ +Sync this widget's alignment on window resize:
+ +myWidget.set('alignOn', [
+ {
+ node : Y.one('win'),
+ eventName: 'resize'
+ }
+]);
+bodyContent
+ HTML
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ The content to be added to the body section. This will replace any existing content +in the body. If you want to append, or insert new content, use the setStdModContent method.
+Default: undefined
+ + + +Fires event bodyContentChange
+
+
+ Fires when the value for the configuration attribute bodyContent 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.
+
Parameters:
+ +-
+
-
+
e+ EventFacade + ++ An Event Facade object with the following + attribute-specific properties added: ++ +-
+
-
+
prevVal+ Any +The value of the attribute, prior to it being set.+
+ -
+
newVal+ Any +The value the attribute is to be set to.+
+ -
+
attrName+ String +The name of the attribute being set.+
+ -
+
subAttrName+ String +If setting a property within the attribute's value, the name of the sub-attribute property being set.+
+
+ -
+
boundingBox
+ String | Node
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ The outermost DOM node for the Widget, used for sizing and positioning +of a Widget as well as a containing element for any decorator elements used +for skinning.
+Fires event boundingBoxChange
+
+
+ Fires when the value for the configuration attribute boundingBox 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.
+
Parameters:
+ +-
+
-
+
e+ EventFacade + ++ An Event Facade object with the following + attribute-specific properties added: ++ +-
+
-
+
prevVal+ Any +The value of the attribute, prior to it being set.+
+ -
+
newVal+ Any +The value the attribute is to be set to.+
+ -
+
attrName+ String +The name of the attribute being set.+
+ -
+
subAttrName+ String +If setting a property within the attribute's value, the name of the sub-attribute property being set.+
+
+ -
+
centered
+ Boolean | Node
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ A convenience Attribute, which can be used as a shortcut for the align
+Attribute.
If set to true, the widget is centered in the viewport. If set to a Node
+reference or valid selector String, the widget will be centered within the
+Node. If set to false, no center positioning is applied.
Default: false
+ + + +Fires event centeredChange
+
+
+ Fires when the value for the configuration attribute centered 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.
+
Parameters:
+ +-
+
-
+
e+ EventFacade + ++ An Event Facade object with the following + attribute-specific properties added: ++ +-
+
-
+
prevVal+ Any +The value of the attribute, prior to it being set.+
+ -
+
newVal+ Any +The value the attribute is to be set to.+
+ -
+
attrName+ String +The name of the attribute being set.+
+ -
+
subAttrName+ String +If setting a property within the attribute's value, the name of the sub-attribute property being set.+
+
+ -
+
constrain
+ Boolean | Node
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ The node to constrain the widget's bounding box to, when setting xy. Can also be +set to true, to constrain to the viewport.
+Default: null
+ + + +Fires event constrainChange
+
+
+ Fires when the value for the configuration attribute constrain 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.
+
Parameters:
+ +-
+
-
+
e+ EventFacade + ++ An Event Facade object with the following + attribute-specific properties added: ++ +-
+
-
+
prevVal+ Any +The value of the attribute, prior to it being set.+
+ -
+
newVal+ Any +The value the attribute is to be set to.+
+ -
+
attrName+ String +The name of the attribute being set.+
+ -
+
subAttrName+ String +If setting a property within the attribute's value, the name of the sub-attribute property being set.+
+
+ -
+
contentBox
+ String | Node
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ A DOM node that is a direct descendant of a Widget's bounding box that +houses its content.
+Fires event contentBoxChange
+
+
+ Fires when the value for the configuration attribute contentBox 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.
+
Parameters:
+ +-
+
-
+
e+ EventFacade + ++ An Event Facade object with the following + attribute-specific properties added: ++ +-
+
-
+
prevVal+ Any +The value of the attribute, prior to it being set.+
+ -
+
newVal+ Any +The value the attribute is to be set to.+
+ -
+
attrName+ String +The name of the attribute being set.+
+ -
+
subAttrName+ String +If setting a property within the attribute's value, the name of the sub-attribute property being set.+
+
+ -
+
defaultButton
+ Node
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ readonly
+
+
+
+
+ The current default button as configured through this widget's buttons.
A button can be configured as the default button in the following ways:
+ +-
+
As a config Object with an
isDefaultproperty: +{label: 'Okay', isDefault: true}.
+As a Node with a
data-defaultattribute: +<button data-default="true">Okay</button>.
+
This attribute is read-only; anytime there are changes to this widget's
+buttons, the defaultButton will be updated if needed.
Note: If two or more buttons are configured to be the default button, +the last one wins.
+Default: null
+ + + +Fires event defaultButtonChange
+
+
+ Fires when the value for the configuration attribute defaultButton 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.
+
Parameters:
+ +-
+
-
+
e+ EventFacade + ++ An Event Facade object with the following + attribute-specific properties added: ++ +-
+
-
+
prevVal+ Any +The value of the attribute, prior to it being set.+
+ -
+
newVal+ Any +The value the attribute is to be set to.+
+ -
+
attrName+ String +The name of the attribute being set.+
+ -
+
subAttrName+ String +If setting a property within the attribute's value, the name of the sub-attribute property being set.+
+
+ -
+
destroyed
+ Boolean
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ readonly
+
+
+
+
+ Flag indicating whether or not this object +has been through the destroy lifecycle phase.
+Default: false
+ + + +Fires event destroyedChange
+
+
+ Fires when the value for the configuration attribute destroyed 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.
+
Parameters:
+ +-
+
-
+
e+ EventFacade + ++ An Event Facade object with the following + attribute-specific properties added: ++ +-
+
-
+
prevVal+ Any +The value of the attribute, prior to it being set.+
+ -
+
newVal+ Any +The value the attribute is to be set to.+
+ -
+
attrName+ String +The name of the attribute being set.+
+ -
+
subAttrName+ String +If setting a property within the attribute's value, the name of the sub-attribute property being set.+
+
+ -
+
disabled
+ Boolean
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Boolean indicating if the Widget should be disabled. The disabled implementation +is left to the specific classes extending widget.
+Default: false
+ + + +Fires event disabledChange
+
+
+ Fires when the value for the configuration attribute disabled 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.
+
Parameters:
+ +-
+
-
+
e+ EventFacade + ++ An Event Facade object with the following + attribute-specific properties added: ++ +-
+
-
+
prevVal+ Any +The value of the attribute, prior to it being set.+
+ -
+
newVal+ Any +The value the attribute is to be set to.+
+ -
+
attrName+ String +The name of the attribute being set.+
+ -
+
subAttrName+ String +If setting a property within the attribute's value, the name of the sub-attribute property being set.+
+
+ -
+
fillHeight
+ String
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ The section (WidgetStdMod.HEADER, WidgetStdMod.BODY or WidgetStdMod.FOOTER) which should be resized to fill the height of the standard module, when a +height is set on the Widget. If a height is not set on the widget, then all sections are sized based on +their content.
+Default: WidgetStdMod.BODY
+ + + +Fires event fillHeightChange
+
+
+ Fires when the value for the configuration attribute fillHeight 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.
+
Parameters:
+ +-
+
-
+
e+ EventFacade + ++ An Event Facade object with the following + attribute-specific properties added: ++ +-
+
-
+
prevVal+ Any +The value of the attribute, prior to it being set.+
+ -
+
newVal+ Any +The value the attribute is to be set to.+
+ -
+
attrName+ String +The name of the attribute being set.+
+ -
+
subAttrName+ String +If setting a property within the attribute's value, the name of the sub-attribute property being set.+
+
+ -
+
focused
+ Boolean
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ readonly
+
+
+
+
+ Boolean indicating if the Widget, or one of its descendants, +has focus.
+Default: false
+ + + +Fires event focusedChange
+
+
+ Fires when the value for the configuration attribute focused 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.
+
Parameters:
+ +-
+
-
+
e+ EventFacade + ++ An Event Facade object with the following + attribute-specific properties added: ++ +-
+
-
+
prevVal+ Any +The value of the attribute, prior to it being set.+
+ -
+
newVal+ Any +The value the attribute is to be set to.+
+ -
+
attrName+ String +The name of the attribute being set.+
+ -
+
subAttrName+ String +If setting a property within the attribute's value, the name of the sub-attribute property being set.+
+
+ -
+
focusOn
+ Array
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ An 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.
+Fires event 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.
+
Parameters:
+ +-
+
-
+
e+ EventFacade + ++ An Event Facade object with the following + attribute-specific properties added: ++ +-
+
-
+
prevVal+ Any +The value of the attribute, prior to it being set.+
+ -
+
newVal+ Any +The value the attribute is to be set to.+
+ -
+
attrName+ String +The name of the attribute being set.+
+ -
+
subAttrName+ String +If setting a property within the attribute's value, the name of the sub-attribute property being set.+
+
+ -
+
headerContent
+ HTML
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ The content to be added to the header section. This will replace any existing content +in the header. If you want to append, or insert new content, use the setStdModContent method.
+Default: undefined
+ + + +Fires event headerContentChange
+
+
+ Fires when the value for the configuration attribute headerContent 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.
+
Parameters:
+ +-
+
-
+
e+ EventFacade + ++ An Event Facade object with the following + attribute-specific properties added: ++ +-
+
-
+
prevVal+ Any +The value of the attribute, prior to it being set.+
+ -
+
newVal+ Any +The value the attribute is to be set to.+
+ -
+
attrName+ String +The name of the attribute being set.+
+ -
+
subAttrName+ String +If setting a property within the attribute's value, the name of the sub-attribute property being set.+
+
+ -
+
height
+ String | Number
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ String with units, or number, representing the height of the Widget. If a number is provided, +the default unit, defined by the Widgets DEF_UNIT, property is used.
+Default: EMPTY_STR
+ + + +Fires event heightChange
+
+
+ Fires when the value for the configuration attribute height 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.
+
Parameters:
+ +-
+
-
+
e+ EventFacade + ++ An Event Facade object with the following + attribute-specific properties added: ++ +-
+
-
+
prevVal+ Any +The value of the attribute, prior to it being set.+
+ -
+
newVal+ Any +The value the attribute is to be set to.+
+ -
+
attrName+ String +The name of the attribute being set.+
+ -
+
subAttrName+ String +If setting a property within the attribute's value, the name of the sub-attribute property being set.+
+
+ -
+
hideOn
+ Array
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ An array of objects corresponding to the nodes, events, and keycodes to hide the widget on. +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)
+ +keyCode: (string, optional): If listening for key events, specify the keyCode
+ +By default, this attribute consists of one object which will cause the widget to hide if the +escape key is pressed.
+Fires event hideOnChange
+
+
+ Fires when the value for the configuration attribute hideOn 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.
+
Parameters:
+ +-
+
-
+
e+ EventFacade + ++ An Event Facade object with the following + attribute-specific properties added: ++ +-
+
-
+
prevVal+ Any +The value of the attribute, prior to it being set.+
+ -
+
newVal+ Any +The value the attribute is to be set to.+
+ -
+
attrName+ String +The name of the attribute being set.+
+ -
+
subAttrName+ String +If setting a property within the attribute's value, the name of the sub-attribute property being set.+
+
+ -
+
id
+ String
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Default: Generated using guid()
+ + + +Fires event idChange
+
+
+ Fires when the value for the configuration attribute id 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.
+
Parameters:
+ +-
+
-
+
e+ EventFacade + ++ An Event Facade object with the following + attribute-specific properties added: ++ +-
+
-
+
prevVal+ Any +The value of the attribute, prior to it being set.+
+ -
+
newVal+ Any +The value the attribute is to be set to.+
+ -
+
attrName+ String +The name of the attribute being set.+
+ -
+
subAttrName+ String +If setting a property within the attribute's value, the name of the sub-attribute property being set.+
+
+ -
+
initialized
+ Boolean
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ readonly
+
+
+
+
+ Flag indicating whether or not this object +has been through the init lifecycle phase.
+Default: false
+ + + +Fires event initializedChange
+
+
+ Fires when the value for the configuration attribute initialized 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.
+
Parameters:
+ +-
+
-
+
e+ EventFacade + ++ An Event Facade object with the following + attribute-specific properties added: ++ +-
+
-
+
prevVal+ Any +The value of the attribute, prior to it being set.+
+ -
+
newVal+ Any +The value the attribute is to be set to.+
+ -
+
attrName+ String +The name of the attribute being set.+
+ -
+
subAttrName+ String +If setting a property within the attribute's value, the name of the sub-attribute property being set.+
+
+ -
+
locale
+ String
+
+
+ deprecated
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ The default locale for the widget. NOTE: Using get/set on the "strings" attribute will +return/set strings for this locale.
+Default: "en"
+ + + +Fires event localeChange
+
+
+ Fires when the value for the configuration attribute locale 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.
+
Parameters:
+ +-
+
-
+
e+ EventFacade + ++ An Event Facade object with the following + attribute-specific properties added: ++ +-
+
-
+
prevVal+ Any +The value of the attribute, prior to it being set.+
+ -
+
newVal+ Any +The value the attribute is to be set to.+
+ -
+
attrName+ String +The name of the attribute being set.+
+ -
+
subAttrName+ String +If setting a property within the attribute's value, the name of the sub-attribute property being set.+
+
+ -
+
maskNode
+ Y.Node
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Returns a Y.Node instance of the node being used as the mask.
+Fires event 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.
+
Parameters:
+ +-
+
-
+
e+ EventFacade + ++ An Event Facade object with the following + attribute-specific properties added: ++ +-
+
-
+
prevVal+ Any +The value of the attribute, prior to it being set.+
+ -
+
newVal+ Any +The value the attribute is to be set to.+
+ -
+
attrName+ String +The name of the attribute being set.+
+ -
+
subAttrName+ String +If setting a property within the attribute's value, the name of the sub-attribute property being set.+
+
+ -
+
modal
+ Boolean
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Whether the widget should be modal or not.
+Fires event 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.
+
Parameters:
+ +-
+
-
+
e+ EventFacade + ++ An Event Facade object with the following + attribute-specific properties added: ++ +-
+
-
+
prevVal+ Any +The value of the attribute, prior to it being set.+
+ -
+
newVal+ Any +The value the attribute is to be set to.+
+ -
+
attrName+ String +The name of the attribute being set.+
+ -
+
subAttrName+ String +If setting a property within the attribute's value, the name of the sub-attribute property being set.+
+
+ -
+
preventOverlap
+ Boolean
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ If set to true, and WidgetPositionAlign is also added to the Widget, +constrained positioning will attempt to prevent the widget's bounding box from overlapping +the element to which it has been aligned, by flipping the orientation of the alignment +for corner based alignments
+Fires event preventOverlapChange
+
+
+ Fires when the value for the configuration attribute preventOverlap 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.
+
Parameters:
+ +-
+
-
+
e+ EventFacade + ++ An Event Facade object with the following + attribute-specific properties added: ++ +-
+
-
+
prevVal+ Any +The value of the attribute, prior to it being set.+
+ -
+
newVal+ Any +The value the attribute is to be set to.+
+ -
+
attrName+ String +The name of the attribute being set.+
+ -
+
subAttrName+ String +If setting a property within the attribute's value, the name of the sub-attribute property being set.+
+
+ -
+
render
+ Boolean | Node
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Whether or not to render the widget automatically after init, and optionally, to which parent node.
+Fires event renderChange
+
+
+ Fires when the value for the configuration attribute render 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.
+
Parameters:
+ +-
+
-
+
e+ EventFacade + ++ An Event Facade object with the following + attribute-specific properties added: ++ +-
+
-
+
prevVal+ Any +The value of the attribute, prior to it being set.+
+ -
+
newVal+ Any +The value the attribute is to be set to.+
+ -
+
attrName+ String +The name of the attribute being set.+
+ -
+
subAttrName+ String +If setting a property within the attribute's value, the name of the sub-attribute property being set.+
+
+ -
+
rendered
+ Boolean
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ readonly
+
+
+
+
+ Flag indicating whether or not this Widget +has been through the render lifecycle phase.
+Default: false
+ + + +Fires event renderedChange
+
+
+ Fires when the value for the configuration attribute rendered 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.
+
Parameters:
+ +-
+
-
+
e+ EventFacade + ++ An Event Facade object with the following + attribute-specific properties added: ++ +-
+
-
+
prevVal+ Any +The value of the attribute, prior to it being set.+
+ -
+
newVal+ Any +The value the attribute is to be set to.+
+ -
+
attrName+ String +The name of the attribute being set.+
+ -
+
subAttrName+ String +If setting a property within the attribute's value, the name of the sub-attribute property being set.+
+
+ -
+
shim
+ Boolean
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Boolean flag to indicate whether or not a shim should be added to the Widgets +boundingBox, to protect it from select box bleedthrough.
+Default: false, for all browsers other than IE6, for which a shim is enabled by default.
+ + + +Fires event shimChange
+
+
+ Fires when the value for the configuration attribute shim 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.
+
Parameters:
+ +-
+
-
+
e+ EventFacade + ++ An Event Facade object with the following + attribute-specific properties added: ++ +-
+
-
+
prevVal+ Any +The value of the attribute, prior to it being set.+
+ -
+
newVal+ Any +The value the attribute is to be set to.+
+ -
+
attrName+ String +The name of the attribute being set.+
+ -
+
subAttrName+ String +If setting a property within the attribute's value, the name of the sub-attribute property being set.+
+
+ -
+
srcNode
+ String | Node
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ The DOM node to parse for configuration values, passed to the Widget's HTML_PARSER definition
+Fires event srcNodeChange
+
+
+ Fires when the value for the configuration attribute srcNode 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.
+
Parameters:
+ +-
+
-
+
e+ EventFacade + ++ An Event Facade object with the following + attribute-specific properties added: ++ +-
+
-
+
prevVal+ Any +The value of the attribute, prior to it being set.+
+ -
+
newVal+ Any +The value the attribute is to be set to.+
+ -
+
attrName+ String +The name of the attribute being set.+
+ -
+
subAttrName+ String +If setting a property within the attribute's value, the name of the sub-attribute property being set.+
+
+ -
+
strings
+ Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Collection of strings used to label elements of the Widget's UI.
+Default: null
+ + + +Fires event stringsChange
+
+
+ Fires when the value for the configuration attribute strings 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.
+
Parameters:
+ +-
+
-
+
e+ EventFacade + ++ An Event Facade object with the following + attribute-specific properties added: ++ +-
+
-
+
prevVal+ Any +The value of the attribute, prior to it being set.+
+ -
+
newVal+ Any +The value the attribute is to be set to.+
+ -
+
attrName+ String +The name of the attribute being set.+
+ -
+
subAttrName+ String +If setting a property within the attribute's value, the name of the sub-attribute property being set.+
+
+ -
+
tabIndex
+ Number
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Number (between -32767 to 32767) indicating the widget's +position in the default tab flow. The value is used to set the +"tabIndex" attribute on the widget's bounding box. Negative values allow +the widget to receive DOM focus programmatically (by calling the focus +method), while being removed from the default tab flow. A value of +null removes the "tabIndex" attribute from the widget's bounding box.
+Default: null
+ + + +Fires event tabIndexChange
+
+
+ Fires when the value for the configuration attribute tabIndex 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.
+
Parameters:
+ +-
+
-
+
e+ EventFacade + ++ An Event Facade object with the following + attribute-specific properties added: ++ +-
+
-
+
prevVal+ Any +The value of the attribute, prior to it being set.+
+ -
+
newVal+ Any +The value the attribute is to be set to.+
+ -
+
attrName+ String +The name of the attribute being set.+
+ -
+
subAttrName+ String +If setting a property within the attribute's value, the name of the sub-attribute property being set.+
+
+ -
+
visible
+ Boolean
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Boolean indicating whether or not the Widget is visible.
+Default: TRUE
+ + + +Fires event visibleChange
+
+
+ Fires when the value for the configuration attribute visible 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.
+
Parameters:
+ +-
+
-
+
e+ EventFacade + ++ An Event Facade object with the following + attribute-specific properties added: ++ +-
+
-
+
prevVal+ Any +The value of the attribute, prior to it being set.+
+ -
+
newVal+ Any +The value the attribute is to be set to.+
+ -
+
attrName+ String +The name of the attribute being set.+
+ -
+
subAttrName+ String +If setting a property within the attribute's value, the name of the sub-attribute property being set.+
+
+ -
+
width
+ String | Number
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ String with units, or number, representing the width of the Widget. If a number is provided, +the default unit, defined by the Widgets DEF_UNIT, property is used.
+Default: EMPTY_STR
+ + + +Fires event widthChange
+
+
+ Fires when the value for the configuration attribute width 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.
+
Parameters:
+ +-
+
-
+
e+ EventFacade + ++ An Event Facade object with the following + attribute-specific properties added: ++ +-
+
-
+
prevVal+ Any +The value of the attribute, prior to it being set.+
+ -
+
newVal+ Any +The value the attribute is to be set to.+
+ -
+
attrName+ String +The name of the attribute being set.+
+ -
+
subAttrName+ String +If setting a property within the attribute's value, the name of the sub-attribute property being set.+
+
+ -
+
x
+ Number
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Page X co-ordinate for the widget. This attribute acts as a facade for the +xy attribute. Changes in position can be monitored by listening for xyChange events.
+Default: 0
+ + + +Fires event xChange
+
+
+ Fires when the value for the configuration attribute x 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.
+
Parameters:
+ +-
+
-
+
e+ EventFacade + ++ An Event Facade object with the following + attribute-specific properties added: ++ +-
+
-
+
prevVal+ Any +The value of the attribute, prior to it being set.+
+ -
+
newVal+ Any +The value the attribute is to be set to.+
+ -
+
attrName+ String +The name of the attribute being set.+
+ -
+
subAttrName+ String +If setting a property within the attribute's value, the name of the sub-attribute property being set.+
+
+ -
+
xy
+ Array
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Page XY co-ordinate pair for the widget.
+Default: [0,0]
+ + + +Fires event xyChange
+
+
+ Fires when the value for the configuration attribute xy 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.
+
Parameters:
+ +-
+
-
+
e+ EventFacade + ++ An Event Facade object with the following + attribute-specific properties added: ++ +-
+
-
+
prevVal+ Any +The value of the attribute, prior to it being set.+
+ -
+
newVal+ Any +The value the attribute is to be set to.+
+ -
+
attrName+ String +The name of the attribute being set.+
+ -
+
subAttrName+ String +If setting a property within the attribute's value, the name of the sub-attribute property being set.+
+
+ -
+
y
+ Number
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Page Y co-ordinate for the widget. This attribute acts as a facade for the +xy attribute. Changes in position can be monitored by listening for xyChange events.
+Default: 0
+ + + +Fires event yChange
+
+
+ Fires when the value for the configuration attribute y 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.
+
Parameters:
+ +-
+
-
+
e+ EventFacade + ++ An Event Facade object with the following + attribute-specific properties added: ++ +-
+
-
+
prevVal+ Any +The value of the attribute, prior to it being set.+
+ -
+
newVal+ Any +The value the attribute is to be set to.+
+ -
+
attrName+ String +The name of the attribute being set.+
+ -
+
subAttrName+ String +If setting a property within the attribute's value, the name of the sub-attribute property being set.+
+
+ -
+
zIndex
+ Number
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ The z-index to apply to the Widgets boundingBox. Non-numerical values for +zIndex will be converted to 0
+Default: 0
+ + + +Fires event zIndexChange
+
+
+ Fires when the value for the configuration attribute zIndex 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.
+
Parameters:
+ +-
+
-
+
e+ EventFacade + ++ An Event Facade object with the following + attribute-specific properties added: ++ +-
+
-
+
prevVal+ Any +The value of the attribute, prior to it being set.+
+ -
+
newVal+ Any +The value the attribute is to be set to.+
+ -
+
attrName+ String +The name of the attribute being set.+
+ -
+
subAttrName+ String +If setting a property within the attribute's value, the name of the sub-attribute property being set.+
+
+ -
+
Events
+ + +destroy
+
+
+
+
+
+
+
+
+
+
+
+
+ +Lifecycle event for the destroy phase, +fired prior to destruction. Invoking the preventDefault +method on the event object provided to subscribers will +prevent destruction from proceeding. +
+ ++Subscribers to the "after" moment of this event, will be notified +after destruction is complete (and as a result cannot prevent +destruction). +
+Event Payload:
+ +-
+
+
-
+
+
e+ EventFacade + + + + +++ + +Event object
+
+
+
init
+
+
+
+
+
+
+
+
+
+
+
+
+ +Lifecycle event for the init phase, fired prior to initialization. +Invoking the preventDefault() method on the event object provided +to subscribers will prevent initialization from occuring. +
+ ++Subscribers to the "after" momemt of this event, will be notified +after initialization of the object is complete (and therefore +cannot prevent initialization). +
+Event Payload:
+ +-
+
+
-
+
+
e+ EventFacade + + + + +++ + +Event object, with a cfg property which +refers to the configuration object passed to the constructor.
+
+
+
render
+
+
+
+
+
+
+
+
+
+
+
+
+ Lifecycle event for the render phase, fired prior to rendering the UI +for the widget (prior to invoking the widget's renderer method).
+ ++Subscribers to the "on" moment of this event, will be notified +before the widget is rendered. +
+ ++Subscribers to the "after" moment of this event, will be notified +after rendering is complete. +
+Event Payload:
+ +-
+
+
-
+
+
e+ EventFacade + + + + +++ + +The Event Facade
+
+
+
widget:contentUpdate
+
+
+
+
+
+
+
+
+
+
+
+
+ Notification event, which widget implementations can fire, when +they change the content of the widget. This event has no default +behavior and cannot be prevented, so the "on" or "after" +moments are effectively equivalent (with on listeners being invoked before +after listeners).
+Event Payload:
+ +-
+
+
-
+
+
e+ EventFacade + + + + +++ + +The Event Facade
+
+
+