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.
Panel_addAttrscfgs
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).
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.
_addLazyAttrname
[lazyCfg]
Finishes initializing an attribute which has been lazily added.
_addOutOfOrdername
cfg
Utility method used by get/set to add attributes encountered out of order when calling addAttrs().
For example, if:
this.addAttrs({
foo: {
setter: function() {
// make sure this bar is available when foo is added
this.get("bar");
}
},
bar: {
value: ...
}
});_addShimResizeHandlersSets 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.
_addStdModContentnode
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.
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.
_afterAlignChangee
Handles alignChange events by updating the UI in response to align
Attribute changes.
_afterAlignOnChangee
Handles alignOnChange events by updating the alignment-syncing event
handlers.
_afterBodyChangee
Default attribute change listener for the bodyContent attribute, responsible for updating the UI, in response to attribute changes.
e
EventFacade
The event facade for the attribute change
_afterButtonsChangee
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.
_afterChildSelectedChangeevent
Default attribute change listener for the selected
attribute, responsible for updating the UI, in response to
attribute changes.
event
EventFacade
The event facade for the attribute change.
_afterConstrainChangee
After change listener for the "constrain" attribute, responsible for updating the UI, in response to attribute changes.
e
EventFacade
The event facade
_afterContentChangeButtonse
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.
_afterDefaultButtonChangee
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.
_afterFillHeightChangee
Default attribute change listener for the fillHeight attribute, responsible for updating the UI, in response to attribute changes.
e
EventFacade
The event facade for the attribute change
_afterFocusOnChangeDefault function called when focusOn Attribute is changed. Remove existing listeners and create new listeners.
_afterHeaderChangee
Default attribute change listener for the headerContent attribute, responsible for updating the UI, in response to attribute changes.
e
EventFacade
The event facade for the attribute change
_afterHideOnChangeDefault function called when hideOn Attribute is changed. Remove existing listeners and create new listeners.
_afterHostVisibleChangeAutohideDefault function called when the visibility of the widget changes. Determines whether to attach or detach event listeners based on the visibility of the widget.
_afterHostVisibleChangeModale
Default function that is called when visibility is changed on the widget.
e
EventFacade
The event facade of the change
_afterHostZIndexChangeModale
Default function that is called when z-index is changed on the widget.
e
EventFacade
The event facade of the change
_afterShimChangee
Default attribute change listener for the shim attribute, responsible for updating the UI, in response to attribute changes.
e
EventFacade
The event facade for the attribute change
_afterVisibleChangeButtonse
Handles this widget's visibleChange event by focusing the defaultButton
if there is one.
_afterXYChangee
Default attribute change listener for the xy attribute, responsible for updating the UI, in response to attribute changes.
e
EventFacade
The event facade for the attribute change
_afterZIndexChangee
Default attribute change listener for the zIndex attribute, responsible for updating the UI, in response to attribute changes.
e
EventFacade
The event facade for the attribute change
_aggregateAttrsallAttrs
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).
allAttrs
Array
An array of ATTRS definitions across classes in the hierarchy (subclass first, Base last)
The aggregate set of ATTRS definitions for the instance
_applyParserconfig
Utility method used to apply the HTML_PARSER configuration for the
instance, to retrieve config data values.
config
Object
User configuration object (will be populated with values from Node)
_applyStdModParsedConfigThis method is injected before the _applyParsedConfig step in the application of HTML_PARSER, 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
_attachPosAlignUIHandlesAttaches the alignment-syncing event handlers.
_attachUIHandlesAutohideIterates through all objects in the hideOn attribute and creates event listeners.
_attachUIHandlesModalAttaches UI Listeners for "clickoutside" and "focusoutside" on the widget. When these events occur, and the widget is modal, focus is shifted back onto the widget.
_attrCfgHashUtility method to define the attribute hash used to filter/whitelist property mixes for this class for iteration performance reasons.
_baseDestroyInternal destroy implementation for BaseCore
_baseInitInternal initialization implementation for BaseCore
_bindAttrUIattrs
Binds after listeners for the list of attributes provided
attrs
Array
_bindDOMSets up DOM listeners, on elements rendered by the widget.
_bindUISets up DOM and CustomEvent listeners for the widget.
_bindUIAutohideBinds event listeners to the widget.
This method in invoked after bindUI is invoked for the Widget class using YUI's aop infrastructure.
_bindUIButtonsBinds UI event listeners. This method is inserted via AOP, and will execute
after bindUI().
_bindUIChildBinds 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.
_bindUIModalHooks up methods to be executed when the widget's visibility or z-index changes
This method in invoked after bindUI is invoked for the Widget class using YUI's aop infrastructure.
_bindUIPosAlignBind 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.
_bindUIPosConstrainedBinds 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.
_bindUIPositionBinds 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.
_bindUIStackBinds 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.
_bindUIStdModBinds 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.
_blurBlurs the widget.
_cloneDefaultValuecfg
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.
cfg
Object
_constrainval
axis
nodeRegion
constrainingRegion
The method which performs the actual constrain calculations for a given axis ("x" or "y") based on the regions provided.
The constrained value
_constrainOnXYChangee
The on change listener for the "xy" attribute. Modifies the event facade's newVal property with the constrained XY value.
e
EventFacade
The event facade for the attribute change
_createButtonbutton
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.
The button node.
_createUIEventtype
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.
type
String
String representing the name of the event
_defAttrChangeFne
eventFastPath
Default function for attribute change events.
e
EventFacade
The event object for attribute change events.
eventFastPath
Boolean
Whether or not we're using this as a fast path in the case of no listeners or not
_defaultBBReturns the default value for the boundingBox attribute.
For the Widget class, this will most commonly be null (resulting in a new boundingBox node instance being created), unless a srcNode was provided and CONTENT_TEMPLATE is null, in which case it will be srcNode. This behavior was introduced in @VERSION@ to accomodate single-box widgets whose BB & CB both point to srcNode (e.g. Y.Button).
_defaultCBReturns 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)
_defInitFne
Default init event handler
e
EventFacade
Event object, with a cfg property which refers to the configuration object passed to the constructor.
_defRenderFne
parentNode
Default render handler
e
EventFacade
The Event object
parentNode
Node
The parent node to render to, if passed in to the render method
_destroyBoxRemoves and destroys the widgets rendered boundingBox, contentBox, and detaches bound UI events.
_destroyHierarchyDestroys the class hierarchy for this instance by invoking the destructor method on the prototype of each class in the hierarchy.
_destroyShimRemoves the shim from the DOM, and detaches any related event listeners.
_destroyUIEventsDestructor logic for UI event infrastructure, invoked during Widget destruction.
_detachPosAlignUIHandlesDetaches the alignment-syncing event handlers.
_detachStackHandlesString
Detaches any handles stored for the provided key
String
Object
handleKey The key defining the group of handles which should be detached
_detachUIHandlesAutohideDetaches all event listeners created by this extension
_detachUIHandlesModalDetaches all UI Listeners that were set in _attachUIHandlesModal from the widget.
_doAlignwidgetPoint
x
y
Helper method, used to align the given point on the widget, with the XY page coordinates provided.
_enableConstraintsenable
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.
enable
Boolean
Enable or disable constraints
_eraseStdModsection
Removes the DOM node for the given section.
section
String
The section to remove. Either WidgetStdMod.HEADER, WidgetStdMod.BODY or WidgetStdMod.FOOTER.
_fillHeightUpdates 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").
_filterAdHocAttrsallAttrs
userVals
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.
The set of adhoc attributes passed in, in the form of an object with attribute name/configuration pairs.
_filterUIEventevt
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.
evt
DOMEventFacade
true if it's OK to fire the custom UI event, false if not.
_findStdModSectionsection
Helper method to to find the rendered node for the given section, if it exists.
section
String
The section for which the render Node is to be found. Either WidgetStdMod.HEADER, WidgetStdMod.BODY or WidgetStdMod.FOOTER.
The rendered node for the given section, or null if not found.
_fireAttrChangeattrName
subAttrName
currVal
newVal
opts
[cfg]
Utility method to help setup the event payload and fire the attribute change event.
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.
_focusProvides mouse and tab focus to the widget's bounding box.
_getAttrname
Provides the common implementation for the public get method, allowing Attribute hosts to over-ride either method.
See get for argument details.
name
String
The name of the attribute.
The value of the attribute.
_getAttrCfgname
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.
name
String
Optional. The attribute name. If not provided, the method will return the configuration for all attributes.
The configuration properties for the given attribute, or all attributes.
_getAttrCfgsReturns an aggregated set of attribute configurations, by traversing the class hierarchy.
The hash of attribute configurations, aggregated across classes in the hierarchy This value is cached the first time the method, or _getClasses, is invoked. Subsequent invocations return the cached value.
_getAttrInitValattr
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.
The initial value of the attribute.
_getAttrsattrs
Implementation behind the public getAttrs method, to get multiple attribute values.
An object with attribute name/value pairs.
_getButtonContainersection
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.
The buttons container node for the specified section.
_getButtonDefaultbutton
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.
Whether the button is configured to be the default button.
_getButtonNamebutton
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.
The name of the button.
_getButtonsbuttons
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.)
buttons
Object
The widget's current buttons state.
A copy of the widget's current buttons state.
_getClassesReturns the class hierarchy for this object, with BaseCore being the last class in the array.
An array of classes (constructor functions), making up the class hierarchy for this object. This value is cached the first time the method, or _getAttrCfgs, is invoked. Subsequent invocations return the cached value.
_getFullTypetype
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.
type
String
The short type to prefix
The prefixed type, if a prefix is set, otherwise the type passed in
_getHtmlParserGets the HTML_PARSER definition for this instance, by merging HTML_PARSER definitions across the class hierarchy.
HTML_PARSER definition for this instance
_getInstanceAttrCfgsallCfgs
A helper method used to isolate the attrs config for this instance to pass to addAttrs,
from the static cached ATTRS for the class.
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.
The set of attributes to be added for this instance, suitable
for passing through to addAttrs.
_getMaskNodeReturns the Y.Node instance of the maskNode
The Y.Node instance of the mask, as returned from WidgetModal._GET_MASK
_getNodeToParseDetermines 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.
The node reference to apply HTML_PARSER to.
_getPreciseHeightnode
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.
node
Node
The node for which the precise height is required.
The height of the Node including borders and padding, possibly a float.
_getRegion[node]
Returns the region of the passed-in Node, or the viewport region if
calling with passing in a Node.
[node]
Node
optional
The node to get the region of.
The node's region.
_getShimTemplateCreates a cloned shim node, using the SHIM_TEMPLATE html template, for use on a new instance.
node A new shim Node instance.
_getStateValname
[cfg]
Gets the stored value for the attribute, from either the internal state object, or the state proxy if it exits
The stored value of the attribute
_getStdModContentsection
Retrieves the child nodes (content) of a standard module section
section
String
The standard module section whose child nodes are to be retrieved. Either WidgetStdMod.HEADER, WidgetStdMod.BODY or WidgetStdMod.FOOTER.
The child node collection of the standard module section.
_getStdModTemplatesection
Gets a new Node reference for the given standard module section, by cloning the stored template node.
section
String
The section to create a new node for. Either WidgetStdMod.HEADER, WidgetStdMod.BODY or WidgetStdMod.FOOTER.
The new Node instance for the section
_getTypeIf the instance has a prefix attribute and the event type is not prefixed, the instance prefix is applied to the supplied type.
_getUIEventNodeReturns 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.
_getXDefault getter for the X attribute. The value is retrieved from the XY attribute, which is the sole store for the XY state.
The X page co-ordinate value
_getYDefault getter for the Y attribute. The value is retrieved from the XY attribute, which is the sole store for the XY state.
The Y page co-ordinate value
_guid_hasPotentialSubscribersfullType
fullType
String
The fully prefixed type name
Whether the event has potential subscribers or not
_initAttrHostattrs
values
lazy
Constructor logic for attributes. Initializes the host state, and sets up the inital attributes passed to the constructor.
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).
_initAttributeInitializes AttributeCore
_initAttrsattrs
values
lazy
Utility method to set up initial attributes defined during construction, either through the constructor.ATTRS property, or explicitly passed in.
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).
_initBaseconfig
Internal construction logic for BaseCore.
config
Object
The constructor configuration object
_initHierarchyuserVals
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.
userVals
Object
Object with configuration property name/value pairs
_initHierarchyDataA 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.
_initUIEventtype
Sets up infrastructure required to fire a UI event.
type
String
String representing the name of the event
_insertStdModSectioncontentBox
section
sectionNode
Helper method to insert the Node for the given section into the correct location in the contentBox.
_isLazyAttrname
Checks whether or not the attribute is one which has been added lazily and still requires initialization.
name
String
The name of the attribute
true if it's a lazily added attribute, false otherwise.
_isUIEventtype
Determines if the specified event is a UI event.
type
String
String representing the name of the event
Event Returns the name of the UI Event, otherwise undefined.
_mapButtonbutton
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.
_mapButtonsbuttons
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.
buttons
Node[]
The button nodes to map.
_mapInstanceThe
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.
The
String
boundingBox id
_mergeButtonConfigconfig
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.
A copy of the button configuration object merged with any defaults.
_monitorwhat
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 -> click_attach, click_detach, 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.
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
_normAttrValsvalueHash
Utility method to normalize attribute values. The base implementation simply merges the hash to protect the original.
valueHash
Object
An object with attribute name/value pairs
An object literal with 2 properties - "simple" and "complex", containing simple and complex attribute values respectively keyed by the top level attribute name, or null, if valueHash is falsey.
_onDocFocusevt
DOM focus event handler, used to sync the state of the Widget with the DOM
evt
EventFacade
The event facade for the DOM focus event
_onDocMouseDownevt
"mousedown" event handler for the owner document of the widget's bounding box.
evt
EventFacade
The event facade for the DOM focus event
_parseButtonssrcNode
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.
srcNode
Node
This widget's srcNode to search for buttons.
buttons Config object parsed from this widget's DOM.
_parseStdModHTMLsection
Utility method, used by WidgetStdMods HTML_PARSER implementation to extract data for each section from markup.
section
String
Inner HTML string with the contents of the section
_parseTypeReturns an array with the detach key (if provided), and the prefixed event name from _getType Y.on('detachcategory| menu:click', fn)
_parseZIndexsrcNode
Parses a zIndex attribute value from this widget's srcNode.
srcNode
Node
The node to parse a zIndex value from.
The parsed zIndex value.
_preAddAttrsattrs
userVals
lazy
Implement the BaseCore _preAddAttrs method hook, to add
the srcNode and related attributes, so that HTML_PARSER
(which relies on this.get("srcNode")) can merge in it's
results before the rest of the attributes are added.
_preInitEventCfgconfig
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.
config
Object
The user configuration object
_preventOverlapval
axis
nodeRegion
constrainingRegion
The method which performs the preventOverlap calculations for a given axis ("x" or "y") based on the value and regions provided.
The constrained value
_protectAttrsattrs
Utility method to protect an attribute configuration hash, by merging the entire object and the individual attr config objects.
attrs
Object
A hash of attribute to configuration object pairs.
A protected version of the attrs argument.
_publishfullType
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.
The published event. If called without etOpts or ceOpts, this will
be the default CustomEvent instance, and can be configured independently.
_removeLoadingClassNamesRemoves class names representative of the widget's loading state from the boundingBox.
_renderBoxparentNode
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.
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.
_renderBoxClassNamesApplies standard class names to the boundingBox and contentBox
_renderShimCreates the shim element and adds it to the DOM
_renderShimDeferredSets up change handlers for the visible attribute, to defer shim creation/rendering until the Widget is made visible.
_renderStdModsection
Creates the DOM node for the given section, and inserts it into the correct location in the contentBox.
section
String
The section to create/render. Either WidgetStdMod.HEADER, WidgetStdMod.BODY or WidgetStdMod.FOOTER.
A reference to the added section node
_renderUIInitializes the UI state for the Widget's bounding/content boxes.
_renderUIModalAdds modal class to the bounding box of the widget
This method in invoked after renderUI is invoked for the Widget class using YUI's aop infrastructure.
_renderUIPositionCreates/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.
_renderUIStackCreates/Initializes the DOM to support stackability.
This method in invoked after renderUI is invoked for the Widget class using YUI's aop infrastructure.
_renderUIStdModCreates/Initializes the DOM for standard module support.
This method is invoked after renderUI is invoked for the Widget class using YUI's aop infrastructure.
_repositionMasknextElem
Repositions the mask in the DOM for nested modality cases.
nextElem
Widget
The Y.Widget instance that will be visible in the stack once the current widget is closed.
_resyncMasknextElem
Resyncs the mask in the viewport for browsers that don't support fixed positioning
nextElem
Y.Widget
The Y.Widget instance that will be visible in the stack once the current widget is closed.
_setname
val
[opts]
Allows setting of readOnly/writeOnce attributes. See set for argument details.
A reference to the host object.
_setAlignCenterval
Default setter for center Attribute changes. Sets up the appropriate
value, and passes it through the to the align attribute.
_setAttrname
value
[opts]
force
Provides the common implementation for the public set and protected _set methods.
See set for argument details.
A reference to the host object.
_setAttrsattrs
[opts]
Implementation behind the public setAttrs method, to set multiple attribute values.
A reference to the host object.
_setAttrValattrName
subAttrName
prevVal
newVal
[opts]
[attrCfg]
Updates the stored value of the attribute in the privately held State object, if validation and setter passes.
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.
true if the new attribute value was stored, false if not.
_setBBnode
Setter for the boundingBox attribute
Node
_setBoxid
node
template
isBounding
Helper method to set the bounding/content box, or create it from the provided template if not found.
The node
_setButtonsconfig
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.
The processed buttons object which represents the new
state.
_setCBnode
Setter for the contentBox attribute
Node
_setConstrainval
The setter implementation for the "constrain" attribute.
val
Node | boolean
The attribute value
_setStateValname
value
Sets the stored value for the attribute, in either the internal state object, or the state proxy if it exits
name
String
The name of the attribute
value
Any
The value of the attribute
_setXval
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.
val
Number
The X page co-ordinate value
_setYval
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.
val
Number
The Y page co-ordinate value
_setZIndexzIndex
Default setter for zIndex attribute changes. Normalizes zIndex values to numbers, converting non-numerical values to 0.
Normalized zIndex
_strSetterstrings
The default setter for the strings attribute. Merges partial sets into the full string set, to allow users to partial sets of strings
strings
Object
The full set of strings to set
_syncAttrUIattrs
Invokes the _uiSet=ATTR NAME> method for the list of attributes provided
attrs
Array
_syncUIUpdates the widget UI to reflect the attribute state.
_syncUIAutohideSyncs 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.
_syncUIButtonsSyncs this widget's current button-related state to its DOM. This method is
inserted via AOP, and will execute after syncUI().
_syncUIChildSynchronizes the UI to match the WidgetChild state.
This method is invoked after bindUI is invoked for the Widget class using YUI's aop infrastructure.
_syncUIModalSyncs the mask with the widget's current state, namely the visibility and z-index of the widget
This method in invoked after syncUI is invoked for the Widget class using YUI's aop infrastructure.
_syncUIPosAlignSynchronizes 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.
_syncUIPositionSynchronizes 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.
_syncUIStackSynchronizes 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.
_syncUIStdModSynchronizes 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.
_uiInsertButtonbutton
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.
_uiRemoveButtonbutton
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.
_uiSetAlign[node]
points
Updates the UI to reflect the align value passed in.
Note: See the align Attribute documentation, for the Object structure
expected.
_uiSetButtonsbuttons
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.
buttons
Object
The current buttons state to visually represent.
_uiSetChildSelectedselected
Updates the UI to reflect the selected attribute value.
selected
Number
The selected value to be reflected in the UI.
_uiSetDefaultButtonnewButton
oldButton
Adds the "yui3-button-primary" CSS class to the new defaultButton and
removes it from the old default button.
_uiSetDimdim
val
_uiSetFillHeightfillSection
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.
fillSection
String
A valid section specifier - one of WidgetStdMod.HEADER, WidgetStdMod.BODY or WidgetStdMod.FOOTER
_uiSetFocusedval
src
Sets the focused state for the UI
_uiSetHeightval
Sets the height on the widget's bounding box element
_uiSetHostVisibleAutohideRemoves event listeners if widget is not visible, and attaches them otherwise.
_uiSetHostVisibleModalWhether
Performs events attaching/detaching, stack shifting and mask repositioning based on the visibility of the widget
Whether
Boolean
the widget is visible or not
_uiSetHostZIndexModalZ-Index
Sets the z-index of the mask node.
Z-Index
Number
of the widget
_uiSetShimenable
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.
enable
Boolean
If true, creates/renders the shim, if false, removes it.
_uiSetStdModsection
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.
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.
_uiSetTabIndexNumber
Set the tabIndex on the widget's rendered UI
Number
Object
_uiSetVisibleButtonsvisible
Focuses this widget's defaultButton if there is one and this widget is
visible.
visible
Boolean
Whether this widget is visible.
_uiSetVisiblePosAlignvisible
Attaches or detaches alignment-syncing event handlers based on the widget's
visible Attribute state.
visible
Boolean
The current value of the widget's visible
Attribute.
_uiSetWidthval
Sets the width on the widget's bounding box element
_uiSetXYval
Updates the UI to reflect the XY page co-ordinates passed in.
val
String
The XY page co-ordinates value to be reflected in the UI
_uiSetZIndexzIndex
Updates the UI to reflect the zIndex value passed in.
zIndex
Number
The zindex to be reflected in the UI
_unbindDOM_unbindUI_unMapButtonbutton
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.
_updateContentButtonssection
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.
section
String
The WidgetStdMod section (header/body/footer) to
update.
_updateDefaultButtonUpdates the defaultButton attribute if it needs to be updated by comparing
its current value with the protected _defaultButton property.
_validateFillHeightval
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.
val
String
The section which should be setup to fill height, or false/null to disable fillHeight
true if valid, false if not
_validateXYval
Default validator for the XY attribute
val
Array
The XY page co-ordinate value which is being set.
true if valid, false if not.
addAttrname
config
lazy
Adds an attribute with the provided configuration to the host object.
The config argument object supports the following properties:
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.
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)
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.
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.
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.
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.
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).
A reference to the host object.
addAttrscfgs
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.
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.
A reference to the host object.
addButtonbutton
[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: The WidgetStdMod section (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.
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
BUTTONS prototype property. When a config Object is provided, it will
be merged with any defaults provided by any srcNode and/or a button
with the same name defined on the BUTTONS property. 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 context object can also be provided. Note:
Specifying a set of events will override this setting.
[classNames]
String | String[]
optional
Additional CSS classes to add to the button node.
[context=this]
Object
optional
Context which any events or
action should be called with. Defaults to this, the widget.
Note: e.target will 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 to on().
[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 BUTTONS property with this
same name, its configuration properties will be merged in as defaults.
[section]
String
optional
The WidgetStdMod section (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 WidgetStdMod section
(header/body/footer) where the button should be added. This takes
precedence over the button.section configuration 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 the button that many items from the end.
addTargeto
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.
o
EventTarget
the target to add
aftertype
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.
A subscription handle capable of detaching the subscription
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.
[node]
Node | String | Null
optional
A reference (or selector String) for the
Node which 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
the WidgetPositionAlign extension.
Aligning to the top-left corner of the <body>:
myWidget.align('body',
[Y.WidgetPositionAlign.TL, Y.WidgetPositionAlign.TR]);ancestordepth
Returns the Widget instance at the specified depth.
depth
Number
Number representing the depth of the ancestor.
Widget instance.
attrAddedname
Checks if the given attribute has been added to the host
name
String
The name of the attribute to check.
true if an attribute with the given name has been added, false if it hasn't. This method will return true for lazily added attributes.
beforeExecutes 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
detach handle
bindUIConfigures/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.
blurCauses the Widget to lose focus by setting the "focused" attribute to "false"
bubbleevt
Propagate an event. Requires the event-custom-complex module.
evt
CustomEvent
the custom event to propagate
the aggregated return value from Event.Custom.fire
centered[node]
Centers the widget in the viewport, or if a Node is passed in, it will
be centered to that Node.
constrainxy
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.
destroydestroyAllNodes
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.
destroyAllNodes
Boolean
If true, all nodes contained within the Widget are removed and destroyed. Defaults to false due to potentially high run-time cost.
A reference to this object
destructorDestructor 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.
detachtype
fn
context
Detach one or more listeners the from the specified event
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)
the host
detachAlltype
Removes all listeners from the specified event. If the event type is not specified, all listeners from all hosted custom events will be removed.
type
String
The type, or name of the event
disableSet the Widget's "disabled" attribute to "true".
enableSet the Widget's "disabled" attribute to "false".
fillHeightnode
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.
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.
firetype
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.
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.
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.
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.
True if the whole lifecycle of the event went through, false if at any point the event propagation was halted.
focusCauses the Widget to receive the focus by setting the "focused" attribute to "true".
getname
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.
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"))
The value of the attribute
getAttrsattrs
Gets multiple attribute values.
An object with attribute name/value pairs.
getButtonname
[section="footer"]
Returns a button node from this widget's buttons.
The button node.
getClassNameargs
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.
args
String*
multiple
0..n strings which should be concatenated, using the default separator defined by ClassNameManager, to create the class name
getConstrainedXYxy
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.
The constrained xy values
getEventtype
prefixed
Returns the custom event of the provided type has been created, a falsy value otherwise
the custom event or null
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.
[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.
The name of the skin, or null, if a matching skin class is not found.
getStdModNodesection
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.
The node reference for the section, or null if not set.
getStringkey
Helper method to get a specific string value
key
String
The string
getStringskey
Helper method to get the complete set of strings for the widget
key
String
The strings
getTargetsReturns an array of bubble targets for this object.
EventTarget[]
hideHides the Widget by setting the "visible" attribute to "false".
initcfg
Init lifecycle method, invoked during construction. Sets up attributes and invokes initializers for the class hierarchy.
cfg
Object
Object with configuration property name/value pairs
A reference to this object
initializerconfig
Initializer lifecycle implementation for the Widget class. Registers the widget instance, and runs through the Widget's HTML_PARSER definition.
config
Object
Configuration object literal for the widget
isNestedReturns a boolean representing whether the current widget is in a "nested modality" state. This is done by checking the number of widgets currently on the stack.
isRootDetermines if the Widget is the root Widget in the object hierarchy.
Boolean indicating if Widget is the root Widget in the object hierarchy.
modifyAttrname
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:
Note: New attributes cannot be added using this interface. New attributes must be added using addAttr, or an appropriate manner for a class which utilises Attributes (e.g. the ATTRS property in Base).
movex
[y]
Moves the Widget to the specified page xy co-ordinate position.
nextcircular
Returns the Widget's next sibling.
circular
Boolean
Boolean indicating if the parent's first child should be returned if the child has no next sibling.
Widget instance.
ontype
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.
A subscription handle capable of detaching that subscription
oncetype
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.
A subscription handle capable of detaching the subscription
onceAftertype
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.
A subscription handle capable of detaching that subscription
parseTypetype
[pre]
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.
an array containing:
previouscircular
Returns the Widget's previous sibling.
circular
Boolean
Boolean indicating if the parent's last child should be returned if the child has no previous sibling.
Widget instance.
publishtype
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.
type
String
the type, or name of the event
opts
Object
optional config params. Valid properties are:
the custom event
removeAttrname
Removes an attribute from the host object
name
String
The name of the attribute to be removed.
removeButtonbutton
[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: The WidgetStdMod section (header/body/footer) where the
button should be removed from.
index: The index at which the button exists in the section.
src: "remove"
button
Node | Number | String
The button to remove. This can be a
Y.Node instance, index, or String name of a button.
[section="footer"]
String
optional
The WidgetStdMod section
(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.
renderparentNode
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.
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.
rendererCreates 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.
renderUIAdds nodes to the DOM
This method is not called by framework and is not chained automatically for the class hierarchy.
resetname
Resets the attribute (or all attributes) to its initial value, as long as the attribute is not readOnly, or writeOnce.
name
String
Optional. The name of the attribute to reset. If omitted, all attributes are reset.
A reference to the host object.
setname
value
[opts]
Sets the value of an attribute.
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.
A reference to the host object.
setAttrsattrs
[opts]
Sets multiple attribute values.
A reference to the host object.
setStdModContentsection
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.
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.
showShows the Widget by setting the "visible" attribute to "true".
sizeShimFor 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.
subscribesubscribe to an event
syncUIRefreshes the rendered UI, based on Widget State
This method is not called by framework and is not chained automatically for the class hierarchy.
syncXYSynchronizes the Panel's "xy", "x", and "y" properties with the Widget's position in the DOM.
toStringGeneric toString implementation for all widgets.
The default string value for the widget [ displays the NAME of the instance, and the unique id ]
unsubscribedetach a listener
unsubscribeAlltype
Removes all listeners from the specified event. If the event type is not specified, all listeners from all hosted custom events will be removed.
type
String
The type, or name of the event
_allowAdHocAttrsThis 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._NON_ATTRS_CFG
Default: undefined (false)
_UI_ATTRSThe lists of UI attributes to bind and sync for widget's _bindUI and _syncUI implementations
BUTTONSCollection 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: {}}
// 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_TEMPLATEThe 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_TEMPLATEProperty 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_NODEDefault node to render the bounding box to. If not set, will default to the current document body.
DEFAULT_BUTTONS_SECTIONThe default section to render buttons in when no section is specified.
Default: Y.WidgetStdMod.FOOTER
STACKA stack of Y.Widget objects representing the current hierarchy of modal widgets presently displayed on the screen
alignThe 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: The Node to 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
and Node/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 on WidgetPositionAlign.
Default: null
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.
e
EventFacade
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]
});alignOnAn 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 optional Node that will fire the event, it can be a
Node reference or a selector String. This will default to the widget's
boundingBox.
Default: []
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.
e
EventFacade
Sync this widget's alignment on window resize:
myWidget.set('alignOn', [
{
node : Y.one('win'),
eventName: 'resize'
}
]);bodyContentThe 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
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.
e
EventFacade
boundingBoxThe 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.
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.
e
EventFacade
centeredA 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
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.
e
EventFacade
constrainThe 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
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.
e
EventFacade
contentBoxA DOM node that is a direct descendant of a Widget's bounding box that houses its content.
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.
e
EventFacade
defaultButtonThe 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 isDefault property:
{label: 'Okay', isDefault: true}.
As a Node with a data-default attribute:
<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
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.
e
EventFacade
destroyedFlag indicating whether or not this object has been through the destroy lifecycle phase.
Default: false
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.
e
EventFacade
disabledBoolean indicating if the Widget should be disabled. The disabled implementation is left to the specific classes extending widget.
Default: false
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.
e
EventFacade
fillHeightThe 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
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.
e
EventFacade
focusedBoolean indicating if the Widget, or one of its descendants, has focus.
Default: false
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.
e
EventFacade
focusOnAn array of objects corresponding to the nodes and events that will trigger a re-focus back on the widget. The implementer can supply an array of objects, with each object having the following properties:
eventName: (string, required): The eventName to listen to.
node: (Y.Node, optional): The Y.Node that will fire the event (defaults to the boundingBox of the widget)
By default, this attribute consists of two objects which will cause the widget to re-focus if anything outside the widget is clicked on or focussed upon.
focusOnChange
Fires when the value for the configuration attribute focusOn is
changed. You can listen for the event using the on method if you
wish to be notified before the attribute's value has changed, or
using the after method if you wish to be notified after the
attribute's value has changed.
e
EventFacade
headerContentThe 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
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.
e
EventFacade
heightString 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
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.
e
EventFacade
hideOnAn 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.
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.
e
EventFacade
idDefault: Generated using guid()
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.
e
EventFacade
initializedFlag indicating whether or not this object has been through the init lifecycle phase.
Default: false
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.
e
EventFacade
maskNodeReturns a Y.Node instance of the node being used as the mask.
maskNodeChange
Fires when the value for the configuration attribute maskNode is
changed. You can listen for the event using the on method if you
wish to be notified before the attribute's value has changed, or
using the after method if you wish to be notified after the
attribute's value has changed.
e
EventFacade
modalWhether the widget should be modal or not.
modalChange
Fires when the value for the configuration attribute modal is
changed. You can listen for the event using the on method if you
wish to be notified before the attribute's value has changed, or
using the after method if you wish to be notified after the
attribute's value has changed.
e
EventFacade
preventOverlapIf 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
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.
e
EventFacade
renderWhether or not to render the widget automatically after init, and optionally, to which parent node.
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.
e
EventFacade
renderedFlag indicating whether or not this Widget has been through the render lifecycle phase.
Default: false
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.
e
EventFacade
shimBoolean 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.
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.
e
EventFacade
srcNodeThe DOM node to parse for configuration values, passed to the Widget's HTML_PARSER definition
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.
e
EventFacade
stringsCollection of strings used to label elements of the Widget's UI.
Default: null
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.
e
EventFacade
tabIndexNumber (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
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.
e
EventFacade
visibleBoolean indicating whether or not the Widget is visible.
Default: TRUE
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.
e
EventFacade
widthString 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
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.
e
EventFacade
xPage 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
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.
e
EventFacade
xyPage XY co-ordinate pair for the widget.
Default: [0,0]
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.
e
EventFacade
yPage 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
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.
e
EventFacade
zIndexThe z-index to apply to the Widgets boundingBox. Non-numerical values for zIndex will be converted to 0
Default: 0
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.
e
EventFacade
destroyLifecycle 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).
e
EventFacade
Event object
initLifecycle 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).
e
EventFacade
Event object, with a cfg property which refers to the configuration object passed to the constructor.
renderLifecycle 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.
e
EventFacade
The Event Facade
widget:contentUpdateNotification 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).
e
EventFacade
The Event Facade