Overlay Class
A basic Overlay 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.
Constructor
Item Index
Methods
- _addAttrs
- _addLazyAttr
- _addShimResizeHandlers
- _addStdModContent
- _afterAlignChange
- _afterAlignOnChange
- _afterBodyChange
- _afterChildSelectedChange
- _afterConstrainChange
- _afterFillHeightChange
- _afterFooterChange
- _afterHeaderChange
- _afterShimChange
- _afterXYChange
- _afterZIndexChange
- _aggregateAttrs
- _applyParsedConfig
- _applyParser
- _applyStdModParsedConfig
- _attachPosAlignUIHandles
- _attrCfgHash
- _baseDestroy
- _baseInit
- _bindAttrUI
- _bindDOM
- _bindUI
- _bindUIChild
- _bindUIPosAlign
- _bindUIPosConstrained
- _bindUIPosition
- _bindUIStack
- _bindUIStdMod
- _constrain
- _constrainOnXYChange
- _createUIEvent
- _defAttrChangeFn
- _defaultCB
- _defDestroyFn
- _defInitFn
- _defRenderFn
- _destroyBox
- _destroyHierarchy
- _destroyShim
- _destroyUIEvents
- _detachPosAlignUIHandles
- _detachStackHandles
- _doAlign
- _eraseStdMod
- _fillHeight
- _filterAdHocAttrs
- _filterAttrCfs
- _filterUIEvent
- _findStdModSection
- _fireAttrChange
- _getAttr
- _getAttrCfg
- _getAttrCfgs
- _getAttrInitVal
- _getAttrs
- _getClasses
- _getHtmlParser
- _getNodeToParse
- _getPreciseHeight
- _getRegion
- _getShimTemplate
- _getSrcNode
- _getStateVal
- _getStdModContent
- _getStdModTemplate
- _getStrings
- _getType
- _getUIEventNode
- _getX
- _getY
- _guid
- _initAttrHost
- _initAttribute
- _initAttrs
- _initBase
- _initHierarchy
- _initHierarchyData
- _initUIEvent
- _insertStdModSection
- _isLazyAttr
- _isUIEvent
- _mapInstance
- _monitor
- _normAttrVals
- _onDocFocus
- _onDocMouseDown
- _parseStdModHTML
- _parseType
- _parseZIndex
- _preInitEventCfg
- _preventOverlap
- _protectAttrs deprecated
- _removeLoadingClassNames
- _renderBox
- _renderBoxClassNames
- _renderShim
- _renderShimDeferred
- _renderStdMod
- _renderUI
- _renderUIPosition
- _renderUIStack
- _renderUIStdMod
- _set
- _setAlignCenter
- _setAttr
- _setAttrs
- _setAttrUI
- _setAttrVal
- _setBB
- _setBox
- _setCB
- _setConstrain
- _setStateVal
- _setStrings
- _setX
- _setY
- _setZIndex
- _strSetter
- _syncAttrUI
- _syncUI
- _syncUIChild
- _syncUIPosAlign
- _syncUIPosition
- _syncUIStack
- _syncUIStdMod
- _uiSetAlign
- _uiSetChildSelected
- _uiSetDim
- _uiSetDisabled
- _uiSetFillHeight
- _uiSetFocused
- _uiSetHeight
- _uiSetShim
- _uiSetStdMod
- _uiSetTabIndex
- _uiSetVisible
- _uiSetVisiblePosAlign
- _uiSetWidth
- _uiSetXY
- _uiSetZIndex
- _uiSizeCB
- _unbindDOM
- _unbindUI
- _validateFillHeight
- _validateXY
- _validTabIndex
- addAttr
- addAttrs
- 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
- getClassName
- getConstrainedXY
- getDefaultLocale
- getEvent
- getSkinName
- getStdModNode
- getString deprecated
- getStrings deprecated
- getTargets
- hide
- init
- initializer
- isRoot
- modifyAttr
- move
- next
- on
- once
- onceAfter
- parseType
- previous
- publish
- removeAttr
- removeTarget
- render
- renderer
- renderUI
- reset
- set
- setAttrs
- setStdModContent
- show
- sizeShim
- subscribe deprecated
- syncUI
- syncXY
- toString
- unsubscribe deprecated
- unsubscribeAll deprecated
Properties
Attributes
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:
-
cfgsObjectAn object with attribute name/configuration pairs.
-
valuesObjectAn 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.
-
lazyBooleanWhether 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
Finishes initializing an attribute which has been lazily added.
Parameters:
-
nameObjectThe name of the attribute
_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:
-
nodeNodeThe section Node to be updated.
-
childrenNode | NodeList | StringThe new content Node, NodeList or String to be added to section Node provided.
-
whereStringOptional. 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:
_afterAlignOnChange
-
e
Handles alignOnChange events by updating the alignment-syncing event
handlers.
Parameters:
_afterBodyChange
-
e
Default attribute change listener for the bodyContent attribute, responsible for updating the UI, in response to attribute changes.
Parameters:
-
eEventFacadeThe event facade for the attribute change
_afterChildSelectedChange
-
event
Default attribute change listener for the selected
attribute, responsible for updating the UI, in response to
attribute changes.
Parameters:
-
eventEventFacadeThe 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:
-
eEventFacadeThe event facade
_afterFillHeightChange
-
e
Default attribute change listener for the fillHeight attribute, responsible for updating the UI, in response to attribute changes.
Parameters:
-
eEventFacadeThe event facade for the attribute change
_afterHeaderChange
-
e
Default attribute change listener for the headerContent attribute, responsible for updating the UI, in response to attribute changes.
Parameters:
-
eEventFacadeThe event facade for the attribute change
_afterShimChange
-
e
Default attribute change listener for the shim attribute, responsible for updating the UI, in response to attribute changes.
Parameters:
-
eEventFacadeThe event facade for the attribute change
_afterXYChange
-
e
Default attribute change listener for the xy attribute, responsible for updating the UI, in response to attribute changes.
Parameters:
-
eEventFacadeThe 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:
-
eEventFacadeThe 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:
-
allAttrsArrayAn array of ATTRS definitions across classes in the hierarchy (subclass first, Base last)
Returns:
_applyParser
-
config
Utility method used to apply the HTML_PARSER configuration for the
instance, to retrieve config data values.
Parameters:
-
configObjectUser 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.
_attrCfgHash
()
private
Utility method to define the attribute hash used to filter/whitelist property mixes for this class.
_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:
-
attrsArray
_bindDOM
()
protected
Sets up DOM listeners, on elements rendered by the widget.
_bindUI
()
protected
Sets up DOM and CustomEvent listeners for the widget.
_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.
_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.
_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:
Returns:
_constrainOnXYChange
-
e
The on change listener for the "xy" attribute. Modifies the event facade's newVal property with the constrained XY value.
Parameters:
-
eEventFacadeThe event facade for the attribute change
_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:
-
typeStringString representing the name of the event
_defAttrChangeFn
-
e
Default function for attribute change events.
Parameters:
-
eEventFacadeThe 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)
_defInitFn
-
e
Default init event handler
Parameters:
-
eEventFacadeEvent object, with a cfg property which refers to the configuration object passed to the constructor.
_defRenderFn
-
e -
parentNode
Default render handler
Parameters:
-
eEventFacadeThe Event object
-
parentNodeNodeThe 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:
-
StringObjecthandleKey The key defining the group of handles which should be detached
_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:
-
sectionStringThe 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:
-
allAttrsObjectThe 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.
-
userValsObjectThe config object passed in by the user, from which adhoc attrs are to be filtered.
Returns:
_filterAttrCfs
-
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:
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:
-
evtDOMEventFacade
Returns:
_findStdModSection
-
section
Helper method to to find the rendered node for the given section, if it exists.
Parameters:
-
sectionStringThe 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
Utility method to help setup the event payload and fire the attribute change event.
Parameters:
-
attrNameStringThe name of the attribute
-
subAttrNameStringThe full path of the property being changed, if this is a sub-attribute value being change. Otherwise null.
-
currValAnyThe current value of the attribute
-
newValAnyThe new value of the attribute
-
optsObjectAny additional event data to mix into the attribute change event's event facade.
_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:
-
nameStringThe 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:
-
nameStringOptional. 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:
-
attrsArray | booleanOptional. 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:
_getClasses
()
Function[]
protected
Returns the class hierarchy for this object, with BaseCore being the last class in the array.
Returns:
_getHtmlParser
()
Object
private
Gets the HTMLPARSER definition for this instance, by merging HTMLPARSER definitions across the class hierarchy.
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:
-
nodeNodeThe 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 optionalThe 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:
_getStateVal
-
name
Gets the stored value for the attribute, from either the internal state object, or the state proxy if it exits
Parameters:
-
nameStringThe name of the attribute
Returns:
_getStdModContent
-
section
Retrieves the child nodes (content) of a standard module section
Parameters:
-
sectionStringThe 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:
-
sectionStringThe 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:
-
localeObject
_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:
-
attrsObjectThe 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.
-
valuesObjectThe 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.
-
lazyBooleanWhether 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:
-
attrsObjectThe 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.
-
valuesObjectThe 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.
-
lazyBooleanWhether or not to add attributes lazily (passed through to addAttrs).
_initBase
-
config
Internal construction logic for BaseCore.
Parameters:
-
configObjectThe 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:
-
userValsObjectObject 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:
-
typeStringString 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.
_isLazyAttr
-
name
Checks whether or not the attribute is one which has been added lazily and still requires initialization.
Parameters:
-
nameStringThe name of the attribute
Returns:
_isUIEvent
-
type
Determines if the specified event is a UI event.
Parameters:
-
typeStringString representing the name of the event
Returns:
_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:
-
TheStringboundingBox id
_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:
-
whatString'attach', 'detach', 'fire', or 'publish'
-
eventTypeString | CustomEventThe prefixed name of the event being monitored, or the CustomEvent object.
-
oObjectInformation about the event interaction, such as fire() args, subscription category, publish config
_normAttrVals
-
valueHash
Utility method to split out simple attribute name/value pairs ("x") from complex attribute name/value pairs ("x.y.z"), so that complex attributes can be keyed by the top level attribute name.
Parameters:
-
valueHashObjectAn 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:
-
evtEventFacadeThe event facade for the DOM focus event
_onDocMouseDown
-
evt
"mousedown" event handler for the owner document of the widget's bounding box.
Parameters:
-
evtEventFacadeThe event facade for the DOM focus event
_parseStdModHTML
-
section
Utility method, used by WidgetStdMods HTML_PARSER implementation to extract data for each section from markup.
Parameters:
-
sectionString
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:
-
srcNodeNodeThe 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:
-
configObjectThe 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:
Returns:
_protectAttrs
-
attrs
Utility method to protect an attribute configuration hash, by merging the entire object and the individual attr config objects.
Parameters:
-
attrsObjectA hash of attribute to configuration object pairs.
Returns:
_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:
-
parentNodeNodeThe 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:
-
sectionStringThe 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.
_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.
_set
-
name -
val
Allows setting of readOnly/writeOnce attributes. See set for argument details.
Parameters:
-
nameStringThe name of the attribute.
-
valAnyThe value to set the attribute to.
Returns:
_setAlignCenter
-
val
Default setter for center Attribute changes. Sets up the appropriate
value, and passes it through the to the align attribute.
_setAttr
-
name -
value -
opts -
force
Provides the common implementation for the public set and protected _set methods.
See set for argument details.
Parameters:
-
nameStringThe name of the attribute.
-
valueAnyThe value to set the attribute to.
-
optsObject(Optional) Optional event data to be mixed into the event facade passed to subscribers of the attribute's change event. This is currently a hack. There's no real need for the AttributeCore implementation to support this parameter, but breaking it out into AttributeObservable, results in additional function hops for the critical path.
-
forceBooleanIf true, allows the caller to set values for readOnly or writeOnce attributes which have already been set.
Returns:
_setAttrs
-
attrs
Implementation behind the public setAttrs method, to set multiple attribute values.
Parameters:
-
attrsObjectAn object with attributes name/value pairs.
Returns:
_setAttrVal
-
attrName -
subAttrName -
prevVal -
newVal
Updates the stored value of the attribute in the privately held State object, if validation and setter passes.
Parameters:
Returns:
_setBB
-
Node/String
Setter for the boundingBox attribute
Parameters:
-
Node/StringObject
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:
Returns:
_setCB
-
node
Setter for the contentBox attribute
Returns:
_setConstrain
-
val
The setter implementation for the "constrain" attribute.
Parameters:
-
valNode | booleanThe 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:
-
nameStringThe name of the attribute
-
valueAnyThe 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:
-
valNumberThe 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:
-
valNumberThe 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:
-
stringsObject
Returns:
_syncAttrUI
-
attrs
Invokes the _uiSet=ATTR NAME> method for the list of attributes provided
Parameters:
-
attrsArray
_syncUI
()
protected
Updates the widget UI to reflect the attribute state.
_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.
_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.
_uiSetAlign
-
[node] -
points
Updates the UI to reflect the align value passed in.
Note: See the align Attribute documentation, for the Object structure
expected.
_uiSetChildSelected
-
selected
Updates the UI to reflect the selected attribute value.
Parameters:
-
selectedNumberThe selected value to be reflected in the UI.
_uiSetDim
-
dim -
val
_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:
-
fillSectionStringA 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
_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:
-
enableBooleanIf 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:
-
sectionStringThe section to be updated. Either WidgetStdMod.HEADER, WidgetStdMod.BODY or WidgetStdMod.FOOTER.
-
contentString | NodeThe new content (either as an HTML string, or Node reference) to add to the section
-
whereStringOptional. 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:
-
NumberObject
_uiSetVisiblePosAlign
-
visible
Attaches or detaches alignment-syncing event handlers based on the widget's
visible Attribute state.
Parameters:
-
visibleBooleanThe current value of the widget's
visibleAttribute.
_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:
-
valStringThe XY page co-ordinates value to be reflected in the UI
_uiSetZIndex
-
zIndex
Updates the UI to reflect the zIndex value passed in.
Parameters:
-
zIndexNumberThe zindex to be reflected in the UI
_unbindDOM
()
protected
_unbindUI
()
protected
_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:
-
valStringThe section which should be setup to fill height, or false/null to disable fillHeight
Returns:
_validateXY
-
val
Default validator for the XY attribute
Parameters:
-
valArrayThe XY page co-ordinate value which is being set.
Returns:
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:
-
nameStringThe name of the attribute.
-
configObjectAn 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.
-
lazyBoolean(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:
-
cfgsObjectAn object with attribute name/configuration pairs.
-
valuesObjectAn 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.
-
lazyBooleanWhether 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:
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:
-
oEventTargetthe 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:
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 optionalA 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 optionalA 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 theNode/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:
-
depthNumberNumber representing the depth of the ancestor.
Returns:
attrAdded
-
name
Checks if the given attribute has been added to the host
Parameters:
-
nameStringThe 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:
-
evtCustomEventthe 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:
-
destroyAllNodesBooleanIf 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:
-
typeString | ObjectEither 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.
-
fnFunctionThe subscribed function to unsubscribe, if not supplied, all subscribers will be removed.
-
contextObjectThe 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:
-
typeStringThe 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:
-
enableBooleanEnable 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:
-
nodeNodeThe 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:
-
typeString | ObjectThe type of the event, or an object that contains a 'type' property.
-
argumentsObject*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:
-
nameStringThe 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:
-
attrsArray | booleanOptional. 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:
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:
-
argsString* multiple0..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
()
String
Returns the name of the skin that's currently applied to the widget. This is only really useful after the widget's DOM structure is in the document, either by render or by progressive enhancement. Searches up the Widget's ancestor axis for a class yui3-skin-(name), and returns the (name) portion. Otherwise, returns null.
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:
-
keyString
Returns:
getStrings
-
key
Helper method to get the complete set of strings for the widget
Parameters:
-
keyString
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:
-
cfgObjectObject 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:
-
configObjectConfiguration object literal for the widget
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:
-
circularBooleanBoolean 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:
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:
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:
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.
Returns:
previous
-
circular
Returns the Widget's previous sibling.
Parameters:
-
circularBooleanBoolean 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:
-
typeStringthe type, or name of the event
-
optsObjectoptional 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:
-
nameStringThe name of the attribute to be removed.
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:
-
parentNodeObject | StringOptional. 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:
-
nameStringOptional. The name of the attribute to reset. If omitted, all attributes are reset.
Returns:
set
-
name -
value
Sets the value of an attribute.
Parameters:
-
nameStringThe 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)). -
valueAnyThe value to set the attribute to.
Returns:
setAttrs
-
attrs
Sets multiple attribute values.
Parameters:
-
attrsObjectAn object with attributes name/value pairs.
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:
-
sectionStringThe standard module section whose content is to be updated. Either WidgetStdMod.HEADER, WidgetStdMod.BODY or WidgetStdMod.FOOTER.
-
contentString | NodeThe content to be added, either an HTML string or a Node reference.
-
whereStringOptional. 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:
-
typeStringThe 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)
_UI_ATTRS
Object
private
The lists of UI attributes to bind and sync for widget's _bindUI and _syncUI implementations
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.
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 tonull, 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 theNode/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:
-
eEventFacadeAn Event Facade object with the following attribute-specific properties added:
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 aNodereference or a selector String. This will default to the widget'sboundingBox.
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:
-
eEventFacadeAn Event Facade object with the following attribute-specific properties added:
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:
-
eEventFacadeAn Event Facade object with the following attribute-specific properties added:
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:
-
eEventFacadeAn Event Facade object with the following attribute-specific properties added:
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:
-
eEventFacadeAn Event Facade object with the following attribute-specific properties added:
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:
-
eEventFacadeAn Event Facade object with the following attribute-specific properties added:
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:
-
eEventFacadeAn Event Facade object with the following attribute-specific properties added:
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:
-
eEventFacadeAn Event Facade object with the following attribute-specific properties added:
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:
-
eEventFacadeAn Event Facade object with the following attribute-specific properties added:
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:
-
eEventFacadeAn Event Facade object with the following attribute-specific properties added:
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:
-
eEventFacadeAn Event Facade object with the following attribute-specific properties added:
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:
-
eEventFacadeAn Event Facade object with the following attribute-specific properties added:
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:
-
eEventFacadeAn Event Facade object with the following attribute-specific properties added:
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:
-
eEventFacadeAn Event Facade object with the following attribute-specific properties added:
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:
-
eEventFacadeAn Event Facade object with the following attribute-specific properties added:
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:
-
eEventFacadeAn Event Facade object with the following attribute-specific properties added:
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:
-
eEventFacadeAn Event Facade object with the following attribute-specific properties added:
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:
-
eEventFacadeAn Event Facade object with the following attribute-specific properties added:
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:
-
eEventFacadeAn Event Facade object with the following attribute-specific properties added:
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:
-
eEventFacadeAn Event Facade object with the following attribute-specific properties added:
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:
-
eEventFacadeAn Event Facade object with the following attribute-specific properties added:
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:
-
eEventFacadeAn Event Facade object with the following attribute-specific properties added:
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:
-
eEventFacadeAn Event Facade object with the following attribute-specific properties added:
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:
-
eEventFacadeAn Event Facade object with the following attribute-specific properties added:
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:
-
eEventFacadeAn Event Facade object with the following attribute-specific properties added:
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:
-
eEventFacadeAn Event Facade object with the following attribute-specific properties added:
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:
-
eEventFacadeAn Event Facade object with the following attribute-specific properties added:
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:
-
eEventFacadeAn Event Facade object with the following attribute-specific properties added:
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:
-
eEventFacadeAn Event Facade object with the following attribute-specific properties added:
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:
-
eEventFacadeEvent 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:
-
eEventFacadeEvent object, with a cfg property which refers to the configuration object passed to the constructor.
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:
-
eEventFacadeThe Event Facade
widget: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:
-
eEventFacadeThe Event Facade