API Docs for: 1.0.0
Show:

Popup Class

Uses
Extends Overlay
Defined in: src/gallery-popup/js/popup.js:10
Module: gallery-popup

Popup provides an overlay which opens on a definable set of events, closes on ESC or clicks outside the popup, and which can block the overlay from closing based on a definable set of events which take precendence over the default close events.

Constructor

Popup

()

Defined in src/gallery-popup/js/popup.js:10

Item Index

Methods

Properties

Attributes

Events

Methods

_addAttrs

(
  • cfgs
  • values
  • lazy
)
private

Inherited from AttributeCore: attribute/js/AttributeCore.js:854

Implementation behind the public addAttrs method. This method is invoked directly by get if it encounters a scenario in which an attribute's valueFn attempts to obtain the value an attribute in the same group of attributes, which has not yet been added (on demand initialization).

Parameters:

  • cfgs Object
    An object with attribute name/configuration pairs.
  • values Object
    An object with attribute name/value pairs, defining the initial values to apply. Values defined in the cfgs argument will be over-written by values in this argument unless defined as read only.
  • lazy Boolean
    Whether or not to delay the intialization of these attributes until the first call to get/set. Individual attributes can over-ride this behavior by defining a lazyAdd configuration property in their configuration. See addAttr.

_addLazyAttr

(
  • name
  • [lazyCfg]
)
private

Inherited from AttributeCore: attribute/js/AttributeCore.js:360

Finishes initializing an attribute which has been lazily added.

Parameters:

  • name Object
    The name of the attribute
  • [lazyCfg] Object optional
    Optional config hash for the attribute. This is added for performance along the critical path, where the calling method has already obtained lazy config from state.

_addOutOfOrder

(
  • name
  • cfg
)
private

Inherited from AttributeCore: attribute/js/AttributeCore.js:527

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: ... } });

Parameters:

  • name String
    attribute name
  • cfg Object
    attribute configuration

_addShimResizeHandlers

() private

Inherited from WidgetStack: widget-stack/js/Widget-Stack.js:329

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
)
private

Inherited from WidgetStdMod: widget-stdmod/js/Widget-StdMod.js:546

Helper method to add content to a StdMod section node. The content is added either before, after or replaces the existing node content based on the value of the where argument.

Parameters:

  • node Node
    The section Node to be updated.
  • children Node | NodeList | String
    The new content Node, NodeList or String to be added to section Node provided.
  • where String
    Optional. Either WidgetStdMod.AFTER, WidgetStdMod.BEFORE or WidgetStdMod.REPLACE. If not provided, the content will replace existing content in the Node.

_afterAlignChange

(
  • e
)
protected

Inherited from WidgetPositionAlign: widget-position-align/js/Widget-PositionAlign.js:619

Handles alignChange events by updating the UI in response to align Attribute changes.

Parameters:

_afterAlignOnChange

(
  • e
)
protected

Inherited from WidgetPositionAlign: widget-position-align/js/Widget-PositionAlign.js:634

Handles alignOnChange events by updating the alignment-syncing event handlers.

Parameters:

_afterBodyChange

(
  • e
)
protected

Inherited from WidgetStdMod: widget-stdmod/js/Widget-StdMod.js:345

Default attribute change listener for the bodyContent attribute, responsible for updating the UI, in response to attribute changes.

Parameters:

  • e EventFacade
    The event facade for the attribute change

_afterChildSelectedChange

(
  • event
)
protected

Inherited from Widget: widget-child/js/Widget-Child.js:327

Default attribute change listener for the selected attribute, responsible for updating the UI, in response to attribute changes.

Parameters:

  • event EventFacade
    The event facade for the attribute change.

_afterConstrainChange

(
  • e
)
protected

Inherited from WidgetPositionConstrain: widget-position-constrain/js/Widget-PositionConstrain.js:277

After change listener for the "constrain" attribute, responsible for updating the UI, in response to attribute changes.

Parameters:

_afterFillHeightChange

(
  • e
)
protected

Inherited from WidgetStdMod: widget-stdmod/js/Widget-StdMod.js:373

Default attribute change listener for the fillHeight attribute, responsible for updating the UI, in response to attribute changes.

Parameters:

  • e EventFacade
    The event facade for the attribute change

_afterFooterChange

(
  • e
)
protected

Inherited from WidgetStdMod: widget-stdmod/js/Widget-StdMod.js:359

Default attribute change listener for the footerContent attribute, responsible for updating the UI, in response to attribute changes.

Parameters:

  • e EventFacade
    The event facade for the attribute change

_afterHeaderChange

(
  • e
)
protected

Inherited from WidgetStdMod: widget-stdmod/js/Widget-StdMod.js:331

Default attribute change listener for the headerContent attribute, responsible for updating the UI, in response to attribute changes.

Parameters:

  • e EventFacade
    The event facade for the attribute change

_afterHideOnChange

() protected

Inherited from WidgetAutohide: widget-autohide/js/Widget-Autohide.js:218

Default function called when hideOn Attribute is changed. Remove existing listeners and create new listeners.

_afterHostVisibleChangeAutohide

() protected

Inherited from WidgetAutohide: widget-autohide/js/Widget-Autohide.js:206

Default function called when the visibility of the widget changes. Determines whether to attach or detach event listeners based on the visibility of the widget.

_afterShimChange

(
  • e
)
protected

Inherited from WidgetStack: widget-stack/js/Widget-Stack.js:239

Default attribute change listener for the shim attribute, responsible for updating the UI, in response to attribute changes.

Parameters:

  • e EventFacade
    The event facade for the attribute change

_afterXYChange

(
  • e
)
protected

Inherited from WidgetPosition: widget-position/js/Widget-Position.js:245

Default attribute change listener for the xy attribute, responsible for updating the UI, in response to attribute changes.

Parameters:

  • e EventFacade
    The event facade for the attribute change

_afterZIndexChange

(
  • e
)
protected

Inherited from WidgetStack: widget-stack/js/Widget-Stack.js:251

Default attribute change listener for the zIndex attribute, responsible for updating the UI, in response to attribute changes.

Parameters:

  • e EventFacade
    The event facade for the attribute change

_aggregateAttrs

(
  • allAttrs
)
Object private

Inherited from BaseCore: base/js/BaseCore.js:618

A helper method, used by _initHierarchyData to aggregate attribute configuration across the instances class hierarchy. The method will protect the attribute configuration value to protect the statically defined default value in ATTRS if required (if the value is an object literal, array or the attribute configuration has cloneDefaultValue set to shallow or deep).

Parameters:

  • allAttrs Array
    An array of ATTRS definitions across classes in the hierarchy (subclass first, Base last)

Returns:

Object: The aggregate set of ATTRS definitions for the instance

_applyParsedConfig

() Object protected

Inherited from Widget: widget/js/WidgetHTMLParser.js:121

Returns:

Object: The merged configuration literal

_applyParser

(
  • config
)
protected

Inherited from Widget: widget/js/WidgetHTMLParser.js:130

Utility method used to apply the HTML_PARSER configuration for the instance, to retrieve config data values.

Parameters:

  • config Object
    User configuration object (will be populated with values from Node)

_applyStdModParsedConfig

() private

Inherited from WidgetStdMod: widget-stdmod/js/Widget-StdMod.js:638

This 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

_attachPosAlignUIHandles

() protected

Inherited from WidgetPositionAlign: widget-position-align/js/Widget-PositionAlign.js:461

Attaches the alignment-syncing event handlers.

_attachUIHandlesAutohide

() protected

Inherited from WidgetAutohide: widget-autohide/js/Widget-Autohide.js:143

Iterates through all objects in the hideOn attribute and creates event listeners.

_attrCfgHash

() private

Inherited from BaseCore: base/js/BaseCore.js:581

Utility method to define the attribute hash used to filter/whitelist property mixes for this class for iteration performance reasons.

_baseDestroy

() private

Inherited from BaseCore: base/js/BaseCore.js:364

Internal destroy implementation for BaseCore

_baseInit

() private

Inherited from BaseCore: base/js/BaseCore.js:336

Internal initialization implementation for BaseCore

_bindAttrUI

(
  • attrs
)
private

Inherited from Widget: widget/js/Widget.js:1185

Binds after listeners for the list of attributes provided

Parameters:

  • attrs Array

_bindDOM

() protected

Inherited from Widget: widget/js/Widget.js:917

Sets up DOM listeners, on elements rendered by the widget.

_bindUI

() protected

Inherited from Widget: widget/js/Widget.js:898

Sets up DOM and CustomEvent listeners for the widget.

_bindUIAutohide

() protected

Inherited from WidgetAutohide: widget-autohide/js/Widget-Autohide.js:95

Binds event listeners to the widget.

This method in invoked after bindUI is invoked for the Widget class using YUI's aop infrastructure.

_bindUIChild

() protected

Inherited from Widget: widget-child/js/Widget-Child.js:356

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

Inherited from WidgetPositionAlign: widget-position-align/js/Widget-PositionAlign.js:241

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

Inherited from WidgetPositionConstrain: widget-position-constrain/js/Widget-PositionConstrain.js:261

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

Inherited from WidgetPosition: widget-position/js/Widget-Position.js:146

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

Inherited from WidgetStack: widget-stack/js/Widget-Stack.js:157

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

Inherited from WidgetStdMod: widget-stdmod/js/Widget-StdMod.js:311

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.

_cloneDefaultValue

(
  • cfg
)
private

Inherited from BaseCore: base/js/BaseCore.js:592

This method assumes that the value has already been checked to be an object. Since it's on a critical path, we don't want to re-do the check.

Parameters:

  • cfg Object

_constrain

(
  • val
  • axis
  • nodeRegion
  • constrainingRegion
)
Number protected

Inherited from WidgetPositionConstrain: widget-position-constrain/js/Widget-PositionConstrain.js:166

The method which performs the actual constrain calculations for a given axis ("x" or "y") based on the regions provided.

Parameters:

  • val Number
    The value to constrain
  • axis String
    The axis to use for constrainment
  • nodeRegion Region
    The region of the node to constrain
  • constrainingRegion Region
    The region of the node (or viewport) to constrain to

Returns:

Number: The constrained value

_constrainOnXYChange

(
  • e
)
protected

Inherited from WidgetPositionConstrain: widget-position-constrain/js/Widget-PositionConstrain.js:307

The on change listener for the "xy" attribute. Modifies the event facade's newVal property with the constrained XY value.

Parameters:

  • e EventFacade
    The event facade for the attribute change

_createUIEvent

(
  • type
)
private

Inherited from Widget: widget/js/WidgetUIEvents.js:73

Binds a delegated DOM event listener of the specified type to the Widget's outtermost DOM element to facilitate the firing of a Custom Event of the same type for the Widget instance.

Parameters:

  • type String
    String representing the name of the event

_defAttrChangeFn

(
  • e
  • eventFastPath
)
private

Inherited from AttributeObservable: attribute/js/AttributeObservable.js:185

Default function for attribute change events.

Parameters:

  • 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

_defaultBB

() protected

Inherited from Widget: widget/js/Widget.js:776

Returns 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).

_defaultCB

() protected

Inherited from Widget: widget/js/Widget.js:795

Returns the default value for the contentBox attribute. For the Widget class, this will be the srcNode if provided, otherwise null (resulting in a new contentBox node instance being created)

_defDestroyFn

(
  • e
)
protected

Inherited from BaseObservable: base/js/BaseObservable.js:202

Default destroy event handler

Parameters:

_defInitFn

(
  • e
)
protected

Inherited from BaseObservable: base/js/BaseObservable.js:190

Default init event handler

Parameters:

  • e EventFacade
    Event object, with a cfg property which refers to the configuration object passed to the constructor.

_defRenderFn

(
  • e
  • parentNode
)
protected

Inherited from Widget: widget/js/Widget.js:567

Default render handler

Parameters:

  • e EventFacade
    The Event object
  • parentNode Node
    The parent node to render to, if passed in to the render method

_destroyBox

() protected

Inherited from Widget: widget/js/Widget.js:472

Removes and destroys the widgets rendered boundingBox, contentBox, and detaches bound UI events.

_destroyHierarchy

() private

Inherited from BaseCore: base/js/BaseCore.js:782

Destroys the class hierarchy for this instance by invoking the destructor method on the prototype of each class in the hierarchy.

_destroyShim

() private

Inherited from WidgetStack: widget-stack/js/Widget-Stack.js:389

Removes the shim from the DOM, and detaches any related event listeners.

_destroyUIEvents

() private

Inherited from Widget: widget/js/WidgetUIEvents.js:20

Destructor logic for UI event infrastructure, invoked during Widget destruction.

_detachPosAlignUIHandles

() protected

Inherited from WidgetPositionAlign: widget-position-align/js/Widget-PositionAlign.js:489

Detaches the alignment-syncing event handlers.

_detachStackHandles

(
  • String
)
private

Inherited from WidgetStack: widget-stack/js/Widget-Stack.js:352

Detaches any handles stored for the provided key

Parameters:

  • String Object
    handleKey The key defining the group of handles which should be detached

_detachUIHandlesAutohide

() protected

Inherited from WidgetAutohide: widget-autohide/js/Widget-Autohide.js:192

Detaches all event listeners created by this extension

_doAlign

(
  • widgetPoint
  • x
  • y
)
private

Inherited from WidgetPositionAlign: widget-position-align/js/Widget-PositionAlign.js:505

Helper method, used to align the given point on the widget, with the XY page coordinates provided.

Parameters:

  • widgetPoint String
    Supported point constant (e.g. WidgetPositionAlign.TL)
  • x Number
    X page coordinate to align to.
  • y Number
    Y page coordinate to align to.

_enableConstraints

(
  • enable
)
private

Inherited from WidgetPositionConstrain: widget-position-constrain/js/Widget-PositionConstrain.js:289

Updates the UI if enabling constraints, and sets up the xyChange event listeners to constrain whenever the widget is moved. Disabling constraints removes the listeners.

Parameters:

  • enable Boolean
    Enable or disable constraints

_eraseStdMod

(
  • section
)
protected

Inherited from WidgetStdMod: widget-stdmod/js/Widget-StdMod.js:490

Removes the DOM node for the given section.

Parameters:

  • section String
    The section to remove. Either WidgetStdMod.HEADER, WidgetStdMod.BODY or WidgetStdMod.FOOTER.

_fillHeight

() private

Inherited from WidgetStdMod: widget-stdmod/js/Widget-StdMod.js:423

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
)
Object private

Inherited from BaseCore: base/js/BaseCore.js:470

Parameters:

  • allAttrs Object
    The set of all attribute configurations for this instance. Attributes will be removed from this set, if they belong to the filtered class, so that by the time all classes are processed, allCfgs will be empty.
  • userVals Object
    The config object passed in by the user, from which adhoc attrs are to be filtered.

Returns:

Object: The set of adhoc attributes passed in, in the form of an object with attribute name/configuration pairs.

_filterUIEvent

(
  • evt
)
Boolean private

Inherited from Widget: widget/js/WidgetUIEvents.js:117

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:

Returns:

Boolean: true if it's OK to fire the custom UI event, false if not.

_findStdModSection

(
  • section
)
Node private

Inherited from WidgetStdMod: widget-stdmod/js/Widget-StdMod.js:599

Helper method to to find the rendered node for the given section, if it exists.

Parameters:

  • section String
    The section for which the render Node is to be found. Either WidgetStdMod.HEADER, WidgetStdMod.BODY or WidgetStdMod.FOOTER.

Returns:

Node: The rendered node for the given section, or null if not found.

_fireAttrChange

(
  • attrName
  • subAttrName
  • currVal
  • newVal
  • opts
  • [cfg]
)
private

Inherited from AttributeObservable: attribute/js/AttributeObservable.js:120

Utility method to help setup the event payload and fire the attribute change event.

Parameters:

  • attrName String
    The name of the attribute
  • subAttrName String
    The full path of the property being changed, if this is a sub-attribute value being change. Otherwise null.
  • currVal Any
    The current value of the attribute
  • newVal Any
    The new value of the attribute
  • opts Object
    Any additional event data to mix into the attribute change event's event facade.
  • [cfg] Object optional
    The attribute config stored in State, if already available.

_getAttr

(
  • name
)
Any protected chainable

Inherited from AttributeCore: attribute/js/AttributeCore.js:564

Provides the common implementation for the public get method, allowing Attribute hosts to over-ride either method. See get for argument details.

Parameters:

  • name String
    The name of the attribute.

Returns:

Any: The value of the attribute.

_getAttrCfg

(
  • name
)
Object protected

Inherited from AttributeExtras: attribute/js/AttributeExtras.js:125

Returns an object with the configuration properties (and value) for the given attribute. If attrName is not provided, returns the configuration properties for all attributes.

Parameters:

  • name String
    Optional. The attribute name. If not provided, the method will return the configuration for all attributes.

Returns:

Object: The configuration properties for the given attribute, or all attributes.

_getAttrCfgs

() Object protected

Inherited from BaseCore: base/js/BaseCore.js:394

Returns an aggregated set of attribute configurations, by traversing the class hierarchy.

Returns:

Object: 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.

_getAttrInitVal

(
  • attr
  • cfg
  • initValues
)
Any private

Inherited from AttributeCore: attribute/js/AttributeCore.js:963

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:

  • attr String
    The name of the attribute
  • cfg Object
    The attribute configuration object
  • initValues Object
    The object with simple and complex attribute name/value pairs returned from _normAttrVals

Returns:

Any: The initial value of the attribute.

_getAttrs

(
  • attrs
)
Object protected

Inherited from AttributeCore: attribute/js/AttributeCore.js:792

Implementation behind the public getAttrs method, to get multiple attribute values.

Parameters:

  • attrs String | Boolean
    Optional. An array of attribute names. If omitted, all attribute values are returned. If set to true, all attributes modified from their initial values are returned.

Returns:

Object: An object with attribute name/value pairs.

_getClasses

() Function protected

Inherited from BaseCore: base/js/BaseCore.js:378

Returns the class hierarchy for this object, with BaseCore being the last class in the array.

Returns:

Function: 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.

_getFullType

(
  • type
)
String private

Inherited from EventTarget: event-custom/js/event-target.js:564

Returns the fully qualified type, given a short type string. That is, returns "foo:bar" when given "bar" if "foo" is the configured prefix. NOTE: This method, unlike _getType, does no checking of the value passed in, and is designed to be used with the low level _publish() method, for critical path implementations which need to fast-track publish for performance reasons.

Parameters:

  • type String
    The short type to prefix

Returns:

String: The prefixed type, if a prefix is set, otherwise the type passed in

_getHtmlParser

() Object private

Inherited from Widget: widget/js/WidgetHTMLParser.js:187

Gets the HTML_PARSER definition for this instance, by merging HTML_PARSER definitions across the class hierarchy.

Returns:

Object: HTML_PARSER definition for this instance

_getInstanceAttrCfgs

(
  • allCfgs
)
Object private

Inherited from BaseCore: base/js/BaseCore.js:411

A helper method used to isolate the attrs config for this instance to pass to addAttrs, from the static cached ATTRS for the class.

Parameters:

  • allCfgs Object
    The set of all attribute configurations for this instance. Attributes will be removed from this set, if they belong to the filtered class, so that by the time all classes are processed, allCfgs will be empty.

Returns:

Object: The set of attributes to be added for this instance, suitable for passing through to addAttrs.

_getNodeToParse

() Node private

Inherited from Widget: widget/js/WidgetHTMLParser.js:172

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:

Node: The node reference to apply HTML_PARSER to.

_getPreciseHeight

(
  • node
)
Number private

Inherited from WidgetStdMod: widget-stdmod/js/Widget-StdMod.js:576

Helper method to obtain the precise height of the node provided, including padding and border. The height could be a sub-pixel value for certain browsers, such as Firefox 3.

Parameters:

  • node Node
    The node for which the precise height is required.

Returns:

Number: The height of the Node including borders and padding, possibly a float.

_getRegion

(
  • [node]
)
Object private

Inherited from WidgetPositionConstrain but overwritten in widget-position-align/js/Widget-PositionAlign.js:593

Returns the region of the passed-in Node, or the viewport region if calling with passing in a Node.

Parameters:

  • [node] Node optional
    The node to get the region of.

Returns:

Object: The node's region.

_getShimTemplate

() Node private

Inherited from WidgetStack: widget-stack/js/Widget-Stack.js:423

Creates a cloned shim node, using the SHIM_TEMPLATE html template, for use on a new instance.

Returns:

Node: node A new shim Node instance.

_getSrcNode

() Node protected

Inherited from Widget: widget/js/WidgetHTMLParser.js:74

Returns:

Node: The Node to apply HTML_PARSER to

_getStateVal

(
  • name
  • [cfg]
)
Any private

Inherited from AttributeCore: attribute/js/AttributeCore.js:618

Gets the stored value for the attribute, from either the internal state object, or the state proxy if it exits

Parameters:

  • name String
    The name of the attribute
  • [cfg] Object optional
    Optional config hash for the attribute. This is added for performance along the critical path, where the calling method has already obtained the config from state.

Returns:

Any: The stored value of the attribute

_getStdModContent

(
  • section
)
Node private

Inherited from WidgetStdMod: widget-stdmod/js/Widget-StdMod.js:657

Retrieves the child nodes (content) of a standard module section

Parameters:

  • section String
    The standard module section whose child nodes are to be retrieved. Either WidgetStdMod.HEADER, WidgetStdMod.BODY or WidgetStdMod.FOOTER.

Returns:

Node: The child node collection of the standard module section.

_getStdModTemplate

(
  • section
)
Node protected

Inherited from WidgetStdMod: widget-stdmod/js/Widget-StdMod.js:533

Gets a new Node reference for the given standard module section, by cloning the stored template node.

Parameters:

  • section String
    The section to create a new node for. Either WidgetStdMod.HEADER, WidgetStdMod.BODY or WidgetStdMod.FOOTER.

Returns:

Node: The new Node instance for the section

_getType

() private

Inherited from EventTarget: event-custom/js/event-target.js:36

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

Inherited from Widget but overwritten in widget-child/js/Widget-Child.js:167

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

Inherited from WidgetPosition: widget-position/js/Widget-Position.js:221

Default getter for the X attribute. The value is retrieved from the XY attribute, which is the sole store for the XY state.

Returns:

Number: The X page co-ordinate value

_getY

() Number protected

Inherited from WidgetPosition: widget-position/js/Widget-Position.js:233

Default getter for the Y attribute. The value is retrieved from the XY attribute, which is the sole store for the XY state.

Returns:

Number: The Y page co-ordinate value

_guid

() protected

Inherited from Widget: widget/js/Widget.js:1168

_hasPotentialSubscribers

(
  • fullType
)
Boolean private

Inherited from EventTarget: event-custom/js/event-facade.js:643

Parameters:

  • fullType String
    The fully prefixed type name

Returns:

Boolean: Whether the event has potential subscribers or not

_initAttrHost

(
  • attrs
  • values
  • lazy
)
private

Inherited from AttributeCore: attribute/js/AttributeCore.js:140

Constructor logic for attributes. Initializes the host state, and sets up the inital attributes passed to the constructor.

Parameters:

  • attrs Object
    The attributes to add during construction (passed through to addAttrs). These can also be defined on the constructor being augmented with Attribute by defining the ATTRS property on the constructor.
  • values Object
    The initial attribute values to apply (passed through to addAttrs). These are not merged/cloned. The caller is responsible for isolating user provided values if required.
  • lazy Boolean
    Whether or not to add attributes lazily (passed through to addAttrs).

_initAttribute

() private

Inherited from BaseObservable but overwritten in base/js/BaseCore.js:309

Initializes AttributeCore

_initAttrs

(
  • attrs
  • values
  • lazy
)
protected

Inherited from AttributeCore: attribute/js/AttributeCore.js:1029

Utility method to set up initial attributes defined during construction, either through the constructor.ATTRS property, or explicitly passed in.

Parameters:

  • attrs Object
    The attributes to add during construction (passed through to addAttrs). These can also be defined on the constructor being augmented with Attribute by defining the ATTRS property on the constructor.
  • values Object
    The initial attribute values to apply (passed through to addAttrs). These are not merged/cloned. The caller is responsible for isolating user provided values if required.
  • lazy Boolean
    Whether or not to add attributes lazily (passed through to addAttrs).

_initBase

(
  • config
)
private

Inherited from BaseCore: base/js/BaseCore.js:274

Internal construction logic for BaseCore.

Parameters:

  • config Object
    The constructor configuration object

_initHierarchy

(
  • userVals
)
private

Inherited from BaseCore: base/js/BaseCore.js:702

Initializes the class hierarchy for the instance, which includes initializing attributes for each class defined in the class's static ATTRS property and invoking the initializer method on the prototype of each class in the hierarchy.

Parameters:

  • userVals Object
    Object with configuration property name/value pairs

_initHierarchyData

() private

Inherited from BaseCore: base/js/BaseCore.js:500

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
)
String private

Inherited from Widget: widget/js/WidgetUIEvents.js:176

Sets up infrastructure required to fire a UI event.

Parameters:

  • type String
    String representing the name of the event

Returns:

String:

_insertStdModSection

(
  • contentBox
  • section
  • sectionNode
)
private

Inherited from WidgetStdMod: widget-stdmod/js/Widget-StdMod.js:505

Helper method to insert the Node for the given section into the correct location in the contentBox.

Parameters:

  • contentBox Node
    A reference to the Widgets content box.
  • section String
    The section to create/render. Either WidgetStdMod.HEADER, WidgetStdMod.BODY or WidgetStdMod.FOOTER.
  • sectionNode Node
    The Node for the section.

_isLazyAttr

(
  • name
)
Boolean private

Inherited from AttributeCore: attribute/js/AttributeCore.js:347

Checks whether or not the attribute is one which has been added lazily and still requires initialization.

Parameters:

  • name String
    The name of the attribute

Returns:

Boolean: true if it's a lazily added attribute, false otherwise.

_isUIEvent

(
  • type
)
String private

Inherited from Widget: widget/js/WidgetUIEvents.js:143

Determines if the specified event is a UI event.

Parameters:

  • type String
    String representing the name of the event

Returns:

String: Event Returns the name of the UI Event, otherwise undefined.

_mapInstance

(
  • The
)
protected

Inherited from Widget: widget/js/Widget.js:410

Utility method used to add an entry to the boundingBox id to instance map. This method can be used to populate the instance with lazily created boundingBox Node references.

Parameters:

  • The String
    boundingBox id

_monitor

(
  • what
  • eventType
  • o
)
private

Inherited from EventTarget: event-custom/js/event-target.js:636

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.

Parameters:

  • what String
    'attach', 'detach', 'fire', or 'publish'
  • eventType String | CustomEvent
    The prefixed name of the event being monitored, or the CustomEvent object.
  • o Object
    Information about the event interaction, such as fire() args, subscription category, publish config

_normAttrVals

(
  • valueHash
)
Object private

Inherited from AttributeCore: attribute/js/AttributeCore.js:915

Utility method to normalize attribute values. The base implementation simply merges the hash to protect the original.

Parameters:

  • valueHash Object
    An object with attribute name/value pairs

Returns:

Object: 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.

_onDocFocus

(
  • evt
)
protected

Inherited from Widget: widget/js/Widget.js:1096

DOM focus event handler, used to sync the state of the Widget with the DOM

Parameters:

  • evt EventFacade
    The event facade for the DOM focus event

_onDocMouseDown

(
  • evt
)
protected

Inherited from Widget: widget/js/Widget.js:1083

"mousedown" event handler for the owner document of the widget's bounding box.

Parameters:

  • evt EventFacade
    The event facade for the DOM focus event

_parseStdModHTML

(
  • section
)
String private

Inherited from WidgetStdMod: widget-stdmod/js/Widget-StdMod.js:612

Utility method, used by WidgetStdMods HTML_PARSER implementation to extract data for each section from markup.

Parameters:

  • section String

Returns:

String: Inner HTML string with the contents of the section

_parseType

() private

Inherited from EventTarget: event-custom/js/event-target.js:52

Returns an array with the detach key (if provided), and the prefixed event name from _getType Y.on('detachcategory| menu:click', fn)

_parseZIndex

(
  • srcNode
)
Mixed protected

Inherited from WidgetStack: widget-stack/js/Widget-Stack.js:185

Parses a zIndex attribute value from this widget's srcNode.

Parameters:

  • srcNode Node
    The node to parse a zIndex value from.

Returns:

Mixed: The parsed zIndex value.

_preAddAttrs

(
  • attrs
  • userVals
  • lazy
)
protected

Inherited from Widget: widget/js/WidgetHTMLParser.js:83

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.

Parameters:

  • attrs Object
    The full hash of statically defined ATTRS attributes being added for this instance
  • userVals Object
    The hash of user values passed to the constructor
  • lazy Boolean
    Whether or not to add the attributes lazily

_preInitEventCfg

(
  • config
)
private

Inherited from BaseObservable: base/js/BaseObservable.js:110

Handles the special on, after and target properties which allow the user to easily configure on and after listeners as well as bubble targets during construction, prior to init.

Parameters:

  • config Object
    The user configuration object

_preventOverlap

(
  • val
  • axis
  • nodeRegion
  • constrainingRegion
)
Number protected

Inherited from WidgetPositionConstrain: widget-position-constrain/js/Widget-PositionConstrain.js:210

The method which performs the preventOverlap calculations for a given axis ("x" or "y") based on the value and regions provided.

Parameters:

  • val Number
    The value being constrain
  • axis String
    The axis to being constrained
  • nodeRegion Region
    The region of the node being constrained
  • constrainingRegion Region
    The region of the node (or viewport) we need to constrain to

Returns:

Number: The constrained value

_protectAttrs

(
  • attrs
)
Object deprecated protected

Inherited from AttributeCore: attribute/js/AttributeCore.js:901

Deprecated: Use `AttributeCore.protectAttrs()` or `Attribute.protectAttrs()` which are the same static utility method.

Utility method to protect an attribute configuration hash, by merging the entire object and the individual attr config objects.

Parameters:

  • attrs Object
    A hash of attribute to configuration object pairs.

Returns:

Object: A protected version of the attrs argument.

_publish

(
  • fullType
  • etOpts
  • ceOpts
)
CustomEvent private

Inherited from EventTarget: event-custom/js/event-target.js:588

The low level event publish implementation. It expects all the massaging to have been done outside of this method. e.g. the type to fullType conversion. It's designed to be a fast path publish, which can be used by critical code paths to improve performance.

Parameters:

  • fullType String
    The prefixed type of the event to publish.
  • etOpts Object
    The EventTarget specific configuration to mix into the published event.
  • ceOpts Object
    The publish specific configuration to mix into the published event.

Returns:

CustomEvent: The published event. If called without etOpts or ceOpts, this will be the default CustomEvent instance, and can be configured independently.

_removeLoadingClassNames

() protected

Inherited from Widget: widget/js/Widget.js:877

Removes class names representative of the widget's loading state from the boundingBox.

_renderBox

(
  • parentNode
)
private

Inherited from Widget: widget/js/Widget.js:706

Helper method to collect the boundingBox and contentBox and append to the provided parentNode, if not already a child. The owner document of the boundingBox, or the owner document of the contentBox will be used as the document into which the Widget is rendered if a parentNode is node is not provided. If both the boundingBox and the contentBox are not currently in the document, and no parentNode is provided, the widget will be rendered to the current document's body.

Parameters:

  • parentNode Node
    The parentNode to render the widget to. If not provided, and both the boundingBox and the contentBox are not currently in the document, the widget will be rendered to the current document's body.

_renderBoxClassNames

() protected

Inherited from Widget: widget/js/Widget.js:853

Applies standard class names to the boundingBox and contentBox

_renderShim

() private

Inherited from WidgetStack: widget-stack/js/Widget-Stack.js:370

Creates the shim element and adds it to the DOM

_renderShimDeferred

() private

Inherited from WidgetStack: widget-stack/js/Widget-Stack.js:303

Sets up change handlers for the visible attribute, to defer shim creation/rendering until the Widget is made visible.

_renderStdMod

(
  • section
)
Node protected

Inherited from WidgetStdMod: widget-stdmod/js/Widget-StdMod.js:467

Creates the DOM node for the given section, and inserts it into the correct location in the contentBox.

Parameters:

  • section String
    The section to create/render. Either WidgetStdMod.HEADER, WidgetStdMod.BODY or WidgetStdMod.FOOTER.

Returns:

Node: A reference to the added section node

_renderUI

() protected

Inherited from Widget: widget/js/Widget.js:842

Initializes the UI state for the Widget's bounding/content boxes.

_renderUIPosition

() protected

Inherited from WidgetPosition: widget-position/js/Widget-Position.js:116

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

Inherited from WidgetStack: widget-stack/js/Widget-Stack.js:172

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

Inherited from WidgetStdMod: widget-stdmod/js/Widget-StdMod.js:285

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
  • [opts]
)
Object protected chainable

Inherited from AttributeObservable but overwritten in attribute/js/AttributeCore.js:405

Allows setting of readOnly/writeOnce attributes. See set for argument details.

Parameters:

  • name String
    The name of the attribute.
  • val Any
    The value to set the attribute to.
  • [opts] Object optional
    Optional data providing the circumstances for the change.

Returns:

Object: A reference to the host object.

_setAlignCenter

(
  • val
)
Boolean | Node protected

Inherited from WidgetPositionAlign: widget-position-align/js/Widget-PositionAlign.js:330

Default setter for center Attribute changes. Sets up the appropriate value, and passes it through the to the align attribute.

Parameters:

  • val Boolean | Node
    The Attribute value being set.

Returns:

Boolean | Node: the value passed in.

_setAttr

(
  • name
  • value
  • [opts]
  • force
)
Object protected chainable

Inherited from AttributeCore: attribute/js/AttributeCore.js:421

Provides the common implementation for the public set and protected _set methods. See set for argument details.

Parameters:

  • name String
    The name of the attribute.
  • value Any
    The value to set the attribute to.
  • [opts] Object optional
    Optional data providing the circumstances for the change.
  • force Boolean
    If true, allows the caller to set values for readOnly or writeOnce attributes which have already been set.

Returns:

Object: A reference to the host object.

_setAttrs

(
  • attrs
  • [opts]
)
Object protected chainable

Inherited from AttributeObservable but overwritten in attribute/js/AttributeCore.js:760

Implementation behind the public setAttrs method, to set multiple attribute values.

Parameters:

  • attrs Object
    An object with attributes name/value pairs.
  • [opts] Object optional
    Optional data providing the circumstances for the change

Returns:

Object: A reference to the host object.

_setAttrUI

(
  • e
)
private

Inherited from Widget: widget/js/Widget.js:1216

Parameters:

_setAttrVal

(
  • attrName
  • subAttrName
  • prevVal
  • newVal
  • [opts]
  • [attrCfg]
)
Boolean private

Inherited from AttributeCore: attribute/js/AttributeCore.js:658

Updates the stored value of the attribute in the privately held State object, if validation and setter passes.

Parameters:

  • attrName String
    The attribute name.
  • subAttrName String
    The sub-attribute name, if setting a sub-attribute property ("x.y.z").
  • prevVal Any
    The currently stored value of the attribute.
  • newVal Any
    The value which is going to be stored.
  • [opts] Object optional
    Optional data providing the circumstances for the change.
  • [attrCfg] Object optional
    Optional config hash for the attribute. This is added for performance along the critical path, where the calling method has already obtained the config from state.

Returns:

Boolean: true if the new attribute value was stored, false if not.

_setBB

(
  • node
)
private

Inherited from Widget: widget/js/Widget.js:752

Setter for the boundingBox attribute

Parameters:

  • node Node | String

Returns:

Node

_setBox

(
  • id
  • node
  • template
  • isBounding
)
Node private

Inherited from Widget: widget/js/Widget.js:808

Helper method to set the bounding/content box, or create it from the provided template if not found.

Parameters:

  • id String
    The node's id attribute
  • node Node | String
    The node reference
  • template String
    HTML string template for the node
  • isBounding Boolean
    true if this is the boundingBox, false if it's the contentBox

Returns:

Node: The node

_setCB

(
  • node
)
private

Inherited from Widget: widget/js/Widget.js:764

Setter for the contentBox attribute

Parameters:

  • node Node | String

Returns:

Node

_setConstrain

(
  • val
)
protected

Inherited from WidgetPositionConstrain: widget-position-constrain/js/Widget-PositionConstrain.js:155

The setter implementation for the "constrain" attribute.

Parameters:

  • val Node | boolean
    The attribute value

_setStateVal

(
  • name
  • value
)
private

Inherited from AttributeCore: attribute/js/AttributeCore.js:640

Sets the stored value for the attribute, in either the internal state object, or the state proxy if it exits

Parameters:

  • name String
    The name of the attribute
  • value Any
    The value of the attribute

_setX

(
  • val
)
protected

Inherited from WidgetPosition: widget-position/js/Widget-Position.js:197

Default setter for the X attribute. The setter passes the X value through to the XY attribute, which is the sole store for the XY state.

Parameters:

  • val Number
    The X page co-ordinate value

_setY

(
  • val
)
protected

Inherited from WidgetPosition: widget-position/js/Widget-Position.js:209

Default setter for the Y attribute. The setter passes the Y value through to the XY attribute, which is the sole store for the XY state.

Parameters:

  • val Number
    The Y page co-ordinate value

_setZIndex

(
  • zIndex
)
Number protected

Inherited from WidgetStack: widget-stack/js/Widget-Stack.js:220

Default setter for zIndex attribute changes. Normalizes zIndex values to numbers, converting non-numerical values to 0.

Parameters:

Returns:

Number: Normalized zIndex

_strSetter

(
  • strings
)
String protected

Inherited from Widget: widget/js/Widget.js:1227

The default setter for the strings attribute. Merges partial sets into the full string set, to allow users to partial sets of strings

Parameters:

  • strings Object

Returns:

String: The full set of strings to set

_syncAttrUI

(
  • attrs
)
private

Inherited from Widget: widget/js/Widget.js:1201

Invokes the _uiSet=ATTR NAME> method for the list of attributes provided

Parameters:

  • attrs Array

_syncUI

() protected

Inherited from Widget: widget/js/Widget.js:979

Updates the widget UI to reflect the attribute state.

_syncUIAutohide

() protected

Inherited from WidgetAutohide: widget-autohide/js/Widget-Autohide.js:110

Syncs up the widget based on its current state. In particular, removes event listeners if widget is not visible, and attaches them otherwise.

This method in invoked after syncUI is invoked for the Widget class using YUI's aop infrastructure.

_syncUIChild

() protected

Inherited from Widget: widget-child/js/Widget-Child.js:341

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

Inherited from WidgetPositionAlign: widget-position-align/js/Widget-PositionAlign.js:257

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

Inherited from WidgetPosition: widget-position/js/Widget-Position.js:129

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

Inherited from WidgetStack: widget-stack/js/Widget-Stack.js:145

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

Inherited from WidgetStdMod: widget-stdmod/js/Widget-StdMod.js:258

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
)
protected

Inherited from WidgetPositionAlign: widget-position-align/js/Widget-PositionAlign.js:350

Updates the UI to reflect the align value passed in. **Note:** See the align Attribute documentation, for the Object structure expected.

Parameters:

  • [node] Node | String | Null optional
    The node to align to, or null to indicate the viewport.
  • points Array
    The alignment points.

_uiSetChildSelected

(
  • selected
)
protected

Inherited from Widget: widget-child/js/Widget-Child.js:305

Updates the UI to reflect the selected attribute value.

Parameters:

  • selected Number
    The selected value to be reflected in the UI.

_uiSetDim

(
  • dim
  • val
)
private

Inherited from Widget: widget/js/Widget.js:1012

Parameters:

  • dim String
    The dimension - "width" or "height"
  • val Number | String
    The value to set

_uiSetDisabled

(
  • val
)
protected

Inherited from Widget: widget/js/Widget.js:1033

Sets the disabled state for the UI

Parameters:

  • val Boolean

_uiSetFillHeight

(
  • fillSection
)
protected

Inherited from WidgetStdMod: widget-stdmod/js/Widget-StdMod.js:399

Updates the rendered UI, to resize the provided section so that the standard module fills out the specified widget height. Note: This method does not check whether or not a height is set on the Widget.

Parameters:

  • fillSection String
    A valid section specifier - one of WidgetStdMod.HEADER, WidgetStdMod.BODY or WidgetStdMod.FOOTER

_uiSetFocused

(
  • val
  • src
)
protected

Inherited from Widget: widget/js/Widget.js:1044

Sets the focused state for the UI

Parameters:

  • val Boolean
  • src String
    String representing the source that triggered an update to the UI.

_uiSetHeight

(
  • val
)
protected

Inherited from Widget: widget/js/Widget.js:989

Sets the height on the widget's bounding box element

Parameters:

_uiSetHostVisibleAutohide

() protected

Inherited from WidgetAutohide: widget-autohide/js/Widget-Autohide.js:127

Removes event listeners if widget is not visible, and attaches them otherwise.

_uiSetShim

(
  • enable
)
protected

Inherited from WidgetStack: widget-stack/js/Widget-Stack.js:274

Updates the UI to enable/disable the shim. If the widget is not currently visible, creation of the shim is deferred until it is made visible, for performance reasons.

Parameters:

  • enable Boolean
    If true, creates/renders the shim, if false, removes it.

_uiSetStdMod

(
  • section
  • content
  • where
)
protected

Inherited from WidgetStdMod: widget-stdmod/js/Widget-StdMod.js:440

Updates the rendered UI, adding the provided content (either an HTML string, or node reference), to the specified section. The content is either added before, after or replaces existing content in the section, based on the value of the where argument.

Parameters:

  • section String
    The section to be updated. Either WidgetStdMod.HEADER, WidgetStdMod.BODY or WidgetStdMod.FOOTER.
  • content String | Node
    The new content (either as an HTML string, or Node reference) to add to the section
  • where String
    Optional. Either WidgetStdMod.AFTER, WidgetStdMod.BEFORE or WidgetStdMod.REPLACE. If not provided, the content will replace existing content in the section.

_uiSetTabIndex

(
  • Number
)
protected

Inherited from Widget: widget/js/Widget.js:1066

Set the tabIndex on the widget's rendered UI

Parameters:

  • Number Object

_uiSetVisible

(
  • val
)
protected

Inherited from Widget: widget/js/Widget.js:1022

Sets the visible state for the UI

Parameters:

  • val Boolean

_uiSetVisiblePosAlign

(
  • visible
)
protected

Inherited from WidgetPositionAlign: widget-position-align/js/Widget-PositionAlign.js:444

Attaches or detaches alignment-syncing event handlers based on the widget's visible Attribute state.

Parameters:

  • visible Boolean
    The current value of the widget's visible Attribute.

_uiSetWidth

(
  • val
)
protected

Inherited from Widget: widget/js/Widget.js:1001

Sets the width on the widget's bounding box element

Parameters:

_uiSetXY

(
  • val
)
protected

Inherited from WidgetPosition: widget-position/js/Widget-Position.js:259

Updates the UI to reflect the XY page co-ordinates passed in.

Parameters:

  • val String
    The XY page co-ordinates value to be reflected in the UI

_uiSetZIndex

(
  • zIndex
)
protected

Inherited from WidgetStack: widget-stack/js/Widget-Stack.js:263

Updates the UI to reflect the zIndex value passed in.

Parameters:

  • zIndex Number
    The zindex to be reflected in the UI

_uiSizeCB

(
  • expand
)
protected

Inherited from Widget: widget/js/Widget.js:697

Parameters:

  • expand Boolean

_unbindDOM

() protected

Inherited from Widget: widget/js/Widget.js:948

_unbindUI

() protected

Inherited from Widget: widget/js/Widget.js:909

_validateFillHeight

(
  • val
)
protected

Inherited from WidgetStdMod: widget-stdmod/js/Widget-StdMod.js:385

Default validator for the fillHeight attribute. Verifies that the value set is a valid section specifier - one of WidgetStdMod.HEADER, WidgetStdMod.BODY or WidgetStdMod.FOOTER, or a falsey value if fillHeight is to be disabled.

Parameters:

  • val String
    The section which should be setup to fill height, or false/null to disable fillHeight

Returns:

true if valid, false if not

_validateXY

(
  • val
)
Boolean protected

Inherited from WidgetPosition: widget-position/js/Widget-Position.js:185

Default validator for the XY attribute

Parameters:

  • val Array
    The XY page co-ordinate value which is being set.

Returns:

Boolean: true if valid, false if not.

_validTabIndex

(
  • tabIndex
)
protected

Inherited from Widget: widget/js/Widget.js:1176

Parameters:

addAttr

(
  • name
  • config
  • lazy
)
Object chainable

Inherited from AttributeCore: attribute/js/AttributeCore.js:157

Adds an attribute with the provided configuration to the host object.

The config argument object supports the following properties:

value <Any>
The initial value to set on the attribute
valueFn <Function | String>

A function, which will return the initial value to set on the attribute. This is useful for cases where the attribute configuration is defined statically, but needs to reference the host instance ("this") to obtain an initial value. If both the value and valueFn properties are defined, the value returned by the valueFn has precedence over the value property, unless it returns undefined, in which case the value property is used.

valueFn can also be set to a string, representing the name of the instance method to be used to retrieve the value.

readOnly <boolean>
Whether or not the attribute is read only. Attributes having readOnly set to true cannot be modified by invoking the set method.
writeOnce <boolean> or <string>
Whether or not the attribute is "write once". Attributes having writeOnce set to true, can only have their values set once, be it through the default configuration, constructor configuration arguments, or by invoking set.

The writeOnce attribute can also be set to the string "initOnly", in which case the attribute can only be set during initialization (when used with Base, this means it can only be set during construction)

setter <Function | String>

The setter function used to massage or normalize the value passed to the set method for the attribute. The value returned by the setter will be the final stored value. Returning Attribute.INVALID_VALUE, from the setter will prevent the value from being stored.

setter can also be set to a string, representing the name of the instance method to be used as the setter function.

getter <Function | String>

The getter function used to massage or normalize the value returned by the get method for the attribute. The value returned by the getter function is the value which will be returned to the user when they invoke get.

getter can also be set to a string, representing the name of the instance method to be used as the getter function.

validator <Function | String>

The validator function invoked prior to setting the stored value. Returning false from the validator function will prevent the value from being stored.

validator can also be set to a string, representing the name of the instance method to be used as the validator function.

lazyAdd <boolean>
Whether or not to delay initialization of the attribute until the first call to get/set it. This flag can be used to over-ride lazy initialization on a per attribute basis, when adding multiple attributes through the addAttrs method.

The setter, getter and validator are invoked with the value and name passed in as the first and second arguments, and with the context ("this") set to the host object.

Configuration properties outside of the list mentioned above are considered private properties used internally by attribute, and are not intended for public use.

Parameters:

  • name String
    The name of the attribute.
  • config Object
    An object with attribute configuration property/value pairs, specifying the configuration for the attribute.

    NOTE: The configuration object is modified when adding an attribute, so if you need to protect the original values, you will need to merge the object.

  • lazy Boolean
    (optional) Whether or not to add this attribute lazily (on the first call to get/set).

Returns:

Object: A reference to the host object.

addAttrs

(
  • cfgs
  • values
  • lazy
)
Object chainable

Inherited from AttributeCore: attribute/js/AttributeCore.js:823

Configures a group of attributes, and sets initial values.

NOTE: This method does not isolate the configuration object by merging/cloning. The caller is responsible for merging/cloning the configuration object if required.

Parameters:

  • cfgs Object
    An object with attribute name/configuration pairs.
  • values Object
    An object with attribute name/value pairs, defining the initial values to apply. Values defined in the cfgs argument will be over-written by values in this argument unless defined as read only.
  • lazy Boolean
    Whether or not to delay the intialization of these attributes until the first call to get/set. Individual attributes can over-ride this behavior by defining a lazyAdd configuration property in their configuration. See addAttr.

Returns:

Object: A reference to the host object.

addTarget

(
  • o
)
chainable

Inherited from EventTarget: event-custom/js/event-facade.js:496

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:

after

(
  • type
  • fn
  • [context]
  • [arg*]
)
EventHandle

Inherited from EventTarget: event-custom/js/event-target.js:812

Subscribe to a custom event hosted by this object. The supplied callback will execute after any listeners add via the subscribe method, and after the default function, if configured for the event, has executed.

Parameters:

  • type String
    The name of the event
  • fn Function
    The callback to execute in response to the event
  • [context] Object optional
    Override this object in callback
  • [arg*] Any optional
    0..n additional arguments to supply to the subscriber

Returns:

EventHandle: A subscription handle capable of detaching the subscription

align

(
  • [node]
  • [points]
)
chainable

Inherited from WidgetPositionAlign: widget-position-align/js/Widget-PositionAlign.js:278

Aligns this widget to the provided Node (or viewport) using the provided points. This method can be invoked with no arguments which will cause the widget's current align Attribute value to be synced to the DOM.

Parameters:

  • [node] Node | String | Null optional
    A reference (or selector String) for the 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.

Example:

Aligning to the top-left corner of the <body>:

myWidget.align('body',
    [Y.WidgetPositionAlign.TL, Y.WidgetPositionAlign.TR]);

ancestor

(
  • depth
)
Widget

Inherited from Widget: widget-child/js/Widget-Child.js:279

Returns the Widget instance at the specified depth.

Parameters:

  • depth Number
    Number representing the depth of the ancestor.

Returns:

Widget: Widget instance.

appendHideOn

(
  • o
)
chainable

Defined in src/gallery-popup/js/popup.js:63

Add an additional event which should hide the popup.

Parameters:

  • o Object

    The event description (node, eventName, keyCode)

attrAdded

(
  • name
)
Boolean

Inherited from AttributeCore: attribute/js/AttributeCore.js:319

Checks if the given attribute has been added to the host

Parameters:

  • name String
    The name of the attribute to check.

Returns:

Boolean: 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.

before

()

Inherited from EventTarget: event-custom/js/event-target.js:849

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:

detach handle

bindUI

() protected

Inherited from Widget: widget/js/Widget.js:607

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

Inherited from Widget: widget/js/Widget.js:669

Causes the Widget to lose focus by setting the "focused" attribute to "false"

bubble

(
  • evt
)
Boolean

Inherited from EventTarget: event-custom/js/event-facade.js:554

Propagate an event. Requires the event-custom-complex module.

Parameters:

Returns:

Boolean: the aggregated return value from Event.Custom.fire

centered

(
  • [node]
)
chainable

Inherited from WidgetPositionAlign: widget-position-align/js/Widget-PositionAlign.js:314

Centers the widget in the viewport, or if a Node is passed in, it will be centered to that Node.

Parameters:

  • [node] Node | String optional
    A Node reference or selector String defining the Node which the widget should be centered. If a Node is not passed in, then the widget will be centered to the viewport.

constrain

(
  • xy
  • node
)

Inherited from WidgetPositionConstrain: widget-position-constrain/js/Widget-PositionConstrain.js:130

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.

Parameters:

  • xy Array
    Optional. The xy values to constrain
  • node Node | boolean
    Optional. The node to constrain to, or true for the viewport

destroy

(
  • destroyAllNodes
)
Widget chainable

Inherited from BaseObservable but overwritten in widget/js/Widget.js:448

Destroy lifecycle method. Fires the destroy event, prior to invoking destructors for the class hierarchy. Overrides Base's implementation, to support arguments to destroy

Subscribers to the destroy event can invoke preventDefault on the event object, to prevent destruction from proceeding.

Parameters:

  • destroyAllNodes Boolean
    If true, all nodes contained within the Widget are removed and destroyed. Defaults to false due to potentially high run-time cost.

Returns:

Widget: A reference to this object

destructor

() protected

Inherited from Widget: widget/js/Widget.js:423

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
)
EventTarget

Inherited from EventTarget: event-custom/js/event-target.js:356

Detach one or more listeners the from the specified event

Parameters:

  • type String | Object
    Either the handle to the subscriber or the type of event. If the type is not specified, it will attempt to remove the listener from all hosted events.
  • fn Function
    The subscribed function to unsubscribe, if not supplied, all subscribers will be removed.
  • context Object
    The custom object passed to subscribe. This is optional, but if supplied will be used to disambiguate multiple listeners that are the same (e.g., you subscribe many object using a function that lives on the prototype)

Returns:

EventTarget: the host

detachAll

(
  • type
)

Inherited from EventTarget: event-custom/js/event-target.js:479

Removes all listeners from the specified event. If the event type is not specified, all listeners from all hosted custom events will be removed.

Parameters:

  • type String
    The type, or name of the event

disable

() chainable

Inherited from Widget: widget/js/Widget.js:688

Set the Widget's "disabled" attribute to "true".

enable

() chainable

Inherited from Widget: widget/js/Widget.js:679

Set the Widget's "disabled" attribute to "false".

fillHeight

(
  • node
)

Inherited from WidgetStdMod: widget-stdmod/js/Widget-StdMod.js:713

Sets the height on the provided header, body or footer element to fill out the height of the Widget. It determines the height of the widgets bounding box, based on it's configured height value, and sets the height of the provided section to fill out any space remaining after the other standard module section heights have been accounted for.

NOTE: This method is not designed to work if an explicit height has not been set on the Widget, since for an "auto" height Widget, the heights of the header/body/footer will drive the height of the Widget.

Parameters:

  • node Node
    The node which should be resized to fill out the height of the Widget bounding box. Should be a standard module section node which belongs to the widget.

fire

(
  • type
  • arguments
)
Boolean

Inherited from EventTarget: event-custom/js/event-target.js:673

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.

Parameters:

  • type String | Object
    The type of the event, or an object that contains a 'type' property.
  • arguments Object
    an arbitrary set of parameters to pass to the handler. If the first of these is an object literal and the event is configured to emit an event facade, the event facade will replace that parameter after the properties the object literal contains are copied to the event facade.

Returns:

Boolean: True if the whole lifecycle of the event went through, false if at any point the event propagation was halted.

focus

() chainable

Inherited from Widget: widget/js/Widget.js:659

Causes the Widget to receive the focus by setting the "focused" attribute to "true".

get

(
  • name
)
Any

Inherited from AttributeCore: attribute/js/AttributeCore.js:331

Returns the current value of the attribute. If the attribute has been configured with a 'getter' function, this method will delegate to the 'getter' to obtain the value of the attribute.

Parameters:

  • name String
    The name of the attribute. If the value of the attribute is an Object, dot notation can be used to obtain the value of a property of the object (e.g. get("x.y.z"))

Returns:

Any: The value of the attribute

getAttrs

(
  • attrs
)
Object

Inherited from AttributeCore: attribute/js/AttributeCore.js:780

Gets multiple attribute values.

Parameters:

  • attrs String | Boolean
    Optional. An array of attribute names. If omitted, all attribute values are returned. If set to true, all attributes modified from their initial values are returned.

Returns:

Object: An object with attribute name/value pairs.

getClassName

(
  • args
)

Inherited from Widget but overwritten in widget/js/Widget.js:309

Generate a standard prefixed classname for the Widget, prefixed by the default prefix defined by the Y.config.classNamePrefix attribute used by ClassNameManager and Widget.NAME.toLowerCase() (e.g. "yui-widget-xxxxx-yyyyy", based on default values for the prefix and widget class name).

The instance based version of this method can be used to generate standard prefixed classnames, based on the instances NAME, as opposed to Widget.NAME. This method should be used when you need to use a constant class name across different types instances.

Parameters:

  • args String multiple
    0..n strings which should be concatenated, using the default separator defined by ClassNameManager, to create the class name

getConstrainedXY

(
  • xy
  • node
)
Array

Inherited from WidgetPositionConstrain: widget-position-constrain/js/Widget-PositionConstrain.js:108

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:

  • xy Array
    The xy values to constrain
  • node Node | boolean
    Optional. The node to constrain to, or true for the viewport

Returns:

Array: The constrained xy values

getEvent

(
  • type
  • prefixed
)
CustomEvent

Inherited from EventTarget: event-custom/js/event-target.js:793

Returns the custom event of the provided type has been created, a falsy value otherwise

Parameters:

  • type String
    the type, or name of the event
  • prefixed String
    if true, the type is prefixed already

Returns:

CustomEvent: the custom event or null

getSkinName

(
  • [skinPrefix]
)
String

Inherited from Widget: widget/js/WidgetSkin.js:12

Returns the name of the skin that's currently applied to the widget. Searches up the Widget's ancestor axis for, by default, a class yui3-skin-(name), and returns the (name) portion. Otherwise, returns null. This is only really useful after the widget's DOM structure is in the document, either by render or by progressive enhancement.

Parameters:

  • [skinPrefix] String optional
    The prefix which the implementation uses for the skin ("yui3-skin-" is the default). NOTE: skinPrefix will be used as part of a regular expression: new RegExp('\\b' + skinPrefix + '(\\S+)') Although an unlikely use case, literal characters which may result in an invalid regular expression should be escaped.

Returns:

String: The name of the skin, or null, if a matching skin class is not found.

getStdModNode

(
  • section
  • forceCreate
)
Node

Inherited from WidgetStdMod: widget-stdmod/js/Widget-StdMod.js:687

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:

  • section String
    The section whose node reference is required. Either WidgetStdMod.HEADER, WidgetStdMod.BODY, or WidgetStdMod.FOOTER.
  • forceCreate Boolean
    Whether the section node should be created if it does not already exist.

Returns:

Node: The node reference for the section, or null if not set.

getString

(
  • key
)
String deprecated

Inherited from Widget: widget/js/Widget.js:1240

Deprecated: Used by deprecated WidgetLocale implementations.

Helper method to get a specific string value

Parameters:

  • key String

Returns:

String: The string

getStrings

(
  • key
)
String deprecated

Inherited from Widget: widget/js/Widget.js:1252

Deprecated: Used by deprecated WidgetLocale implementations.

Helper method to get the complete set of strings for the widget

Parameters:

  • key String

Returns:

String: The strings

getTargets

()

Inherited from EventTarget: event-custom/js/event-facade.js:523

Returns an array of bubble targets for this object.

Returns:

EventTarget[]

hide

() chainable

Inherited from Widget: widget/js/Widget.js:641

Hides the Widget by setting the "visible" attribute to "false".

init

(
  • cfg
)
BaseCore chainable

Inherited from BaseObservable but overwritten in base/js/BaseCore.js:319

Init lifecycle method, invoked during construction. Sets up attributes and invokes initializers for the class hierarchy.

Parameters:

  • cfg Object
    Object with configuration property name/value pairs

Returns:

BaseCore: A reference to this object

initializer

(
  • config
)
protected

Inherited from Widget: widget/js/Widget.js:380

Initializer lifecycle implementation for the Widget class. Registers the widget instance, and runs through the Widget's HTML_PARSER definition.

Parameters:

  • config Object
    Configuration object literal for the widget

isRoot

() Boolean

Inherited from Widget: widget-child/js/Widget-Child.js:267

Determines if the Widget is the root Widget in the object hierarchy.

Returns:

Boolean: Boolean indicating if Widget is the root Widget in the object hierarchy.

modifyAttr

(
  • name
  • config
)

Inherited from AttributeExtras: attribute/js/AttributeExtras.js:40

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.

Note: New attributes cannot be added using this interface. New attributes must be added using {{#crossLink "AttributeCore/addAttr:method"}}addAttr{{/crossLink}}, or an appropriate manner for a class which utilises Attributes (e.g. the {{#crossLink "Base/ATTRS:property"}}ATTRS{{/crossLink}} property in {{#crossLink "Base"}}Base{{/crossLink}}).

Parameters:

  • name String
    The name of the attribute whose configuration is to be updated.
  • config Object
    An object with configuration property/value pairs, specifying the configuration properties to modify.

move

(
  • x
  • [y]
)

Inherited from WidgetPosition: widget-position/js/Widget-Position.js:160

Moves the Widget to the specified page xy co-ordinate position.

Parameters:

  • x Number | Number[]
    The new x position or [x, y] values passed as an array to support simple pass through of Node.getXY results
  • [y] Number optional
    The new y position

next

(
  • circular
)
Widget

Inherited from Widget: widget-child/js/Widget-Child.js:191

Returns the Widget's next sibling.

Parameters:

  • circular Boolean
    Boolean indicating if the parent's first child should be returned if the child has no next sibling.

Returns:

Widget: Widget instance.

on

(
  • type
  • fn
  • [context]
  • [arg*]
)
EventHandle

Inherited from EventTarget: event-custom/js/event-target.js:188

Subscribe a callback function to a custom event fired by this object or from an object that bubbles its events to this object. this.on("change", this._onChange, this); 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. this.on({ "attrChange" : this._onAttrChange, "change" : this._onChange }); You can also pass an array of event names as the first argument to subscribe to all listed events with the same callback. this.on([ "change", "attrChange" ], this._onChange); Returning false from a callback is supported as an alternative to calling e.preventDefault(); e.stopPropagation();. However, it is recommended to use the event methods whenever possible.

Parameters:

  • type String
    The name of the event
  • fn Function
    The callback to execute in response to the event
  • [context] Object optional
    Override this object in callback
  • [arg*] Any optional
    0..n additional arguments to supply to the subscriber

Returns:

EventHandle: A subscription handle capable of detaching that subscription

once

(
  • type
  • fn
  • [context]
  • [arg*]
)
EventHandle

Inherited from EventTarget: event-custom/js/event-target.js:124

Listen to a custom event hosted by this object one time. This is the equivalent to on except the listener is immediatelly detached when it is executed.

Parameters:

  • type String
    The name of the event
  • fn Function
    The callback to execute in response to the event
  • [context] Object optional
    Override this object in callback
  • [arg*] Any optional
    0..n additional arguments to supply to the subscriber

Returns:

EventHandle: A subscription handle capable of detaching the subscription

onceAfter

(
  • type
  • fn
  • [context]
  • [arg*]
)
EventHandle

Inherited from EventTarget: event-custom/js/event-target.js:146

Listen to a custom event hosted by this object one time. This is the equivalent to after except the listener is immediatelly detached when it is executed.

Parameters:

  • type String
    The name of the event
  • fn Function
    The callback to execute in response to the event
  • [context] Object optional
    Override this object in callback
  • [arg*] Any optional
    0..n additional arguments to supply to the subscriber

Returns:

EventHandle: A subscription handle capable of detaching that subscription

parseType

(
  • type
  • [pre]
)
Array

Inherited from EventTarget: event-custom/js/event-target.js:168

Available since 3.3.0

Takes the type parameter passed to 'on' and parses out the various pieces that could be included in the type. If the event type is passed without a prefix, it will be expanded to include the prefix one is supplied or the event target is configured with a default prefix.

Parameters:

  • type String
    the type
  • [pre] String optional
    The prefix. Defaults to this._yuievt.config.prefix

Returns:

Array: an array containing: * the detach category, if supplied, * the prefixed event type, * whether or not this is an after listener, * the supplied event type

previous

(
  • circular
)
Widget

Inherited from Widget: widget-child/js/Widget-Child.js:216

Returns the Widget's previous sibling.

Parameters:

  • circular Boolean
    Boolean indicating if the parent's last child should be returned if the child has no previous sibling.

Returns:

Widget: Widget instance.

publish

(
  • type
  • opts
)
CustomEvent

Inherited from EventTarget: event-custom/js/event-target.js:503

Creates a new custom event of the specified type. If a custom event by that name already exists, it will not be re-created. In either case the custom event is returned.

Parameters:

  • type String
    the type, or name of the event
  • opts Object
    optional config params. Valid properties are:
    • [broadcast=false] Boolean optional

      whether or not the YUI instance and YUI global are notified when the event is fired.

    • [bubbles=true] Boolean optional

      Whether or not this event bubbles. Events can only bubble if emitFacade is true.

    • [context=this] Object optional

      the default execution context for the listeners.

    • [defaultFn] Function optional

      the default function to execute when this event fires if preventDefault was not called.

    • [emitFacade=false] Boolean optional

      whether or not this event emits a facade.

    • [prefix] String optional

      the prefix for this targets events, e.g., 'menu' in 'menu:click'.

    • [fireOnce=false] Boolean optional

      if an event is configured to fire once, new subscribers after the fire will be notified immediately.

    • [async=false] Boolean optional

      fireOnce event listeners will fire synchronously if the event has already fired unless async is true.

    • [preventable=true] Boolean optional

      whether or not preventDefault() has an effect.

    • [preventedFn] Function optional

      a function that is executed when preventDefault() is called.

    • [queuable=false] Boolean optional

      whether or not this event can be queued during bubbling.

    • [silent] Boolean optional

      if silent is true, debug messages are not provided for this event.

    • [stoppedFn] Function optional

      a function that is executed when stopPropagation is called.

    • [monitored] Boolean optional

      specifies whether or not this event should send notifications about when the event has been attached, detached, or published.

    • [type] String optional

      the event type (valid option if not provided as the first parameter to publish).

Returns:

CustomEvent: the custom event

removeAttr

(
  • name
)

Inherited from AttributeExtras: attribute/js/AttributeExtras.js:90

Removes an attribute from the host object

Parameters:

  • name String
    The name of the attribute to be removed.

removeTarget

(
  • o
)
chainable

Inherited from EventTarget: event-custom/js/event-facade.js:533

Removes a bubble target

Parameters:

render

(
  • parentNode
)
final chainable

Inherited from Widget: widget/js/Widget.js:509

Establishes the initial DOM for the widget. Invoking this method will lead to the creating of all DOM elements for the widget (or the manipulation of existing DOM elements for the progressive enhancement use case).

This method should only be invoked once for an initialized widget.

It delegates to the widget specific renderer method to do the actual work.

Parameters:

  • parentNode Object | String
    Optional. The Node under which the Widget is to be rendered. This can be a Node instance or a CSS selector string.

    If the selector string returns more than one Node, the first node will be used as the parentNode. NOTE: This argument is required if both the boundingBox and contentBox are not currently in the document. If it's not provided, the Widget will be rendered to the body of the current document in this case.

renderer

() protected

Inherited from Widget: widget/js/Widget.js:584

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

Inherited from Widget: widget/js/Widget.js:618

Adds nodes to the DOM This method is not called by framework and is not chained automatically for the class hierarchy.

reset

(
  • name
)
Object chainable

Inherited from AttributeExtras: attribute/js/AttributeExtras.js:100

Resets the attribute (or all attributes) to its initial value, as long as the attribute is not readOnly, or writeOnce.

Parameters:

  • name String
    Optional. The name of the attribute to reset. If omitted, all attributes are reset.

Returns:

Object: A reference to the host object.

set

(
  • name
  • value
  • [opts]
)
Object chainable

Inherited from AttributeObservable but overwritten in attribute/js/AttributeCore.js:388

Sets the value of an attribute.

Parameters:

  • name String
    The name of the attribute. If the current value of the attribute is an Object, dot notation can be used to set the value of a property within the object (e.g. set("x.y.z", 5)).
  • value Any
    The value to set the attribute to.
  • [opts] Object optional
    Optional data providing the circumstances for the change.

Returns:

Object: A reference to the host object.

setAttrs

(
  • attrs
  • [opts]
)
Object chainable

Inherited from AttributeObservable but overwritten in attribute/js/AttributeCore.js:747

Sets multiple attribute values.

Parameters:

  • attrs Object
    An object with attributes name/value pairs.
  • [opts] Object optional
    Optional data providing the circumstances for the change.

Returns:

Object: A reference to the host object.

setStdModContent

(
  • section
  • content
  • where
)

Inherited from WidgetStdMod: widget-stdmod/js/Widget-StdMod.js:669

Updates the body section of the standard module with the content provided (either an HTML string, or node reference).

This method can be used instead of the corresponding section content attribute if you'd like to retain the current content of the section, and insert content before or after it, by specifying the where argument.

Parameters:

  • section String
    The standard module section whose content is to be updated. Either WidgetStdMod.HEADER, WidgetStdMod.BODY or WidgetStdMod.FOOTER.
  • content String | Node
    The content to be added, either an HTML string or a Node reference.
  • where String
    Optional. Either WidgetStdMod.AFTER, WidgetStdMod.BEFORE or WidgetStdMod.REPLACE. If not provided, the content will replace existing content in the section.

show

() chainable

Inherited from Widget: widget/js/Widget.js:650

Shows the Widget by setting the "visible" attribute to "true".

sizeShim

()

Inherited from WidgetStack: widget-stack/js/Widget-Stack.js:406

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

Inherited from EventTarget: event-custom/js/event-target.js:346

Deprecated: use on

subscribe to an event

syncUI

() protected

Inherited from Widget: widget/js/Widget.js:629

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

()

Inherited from WidgetPosition: widget-position/js/Widget-Position.js:175

Synchronizes the Panel's "xy", "x", and "y" properties with the Widget's position in the DOM.

toString

() String

Inherited from BaseCore but overwritten in widget/js/Widget.js:1122

Generic toString implementation for all widgets.

Returns:

String: The default string value for the widget [ displays the NAME of the instance, and the unique id ]

unsubscribe

() deprecated

Inherited from EventTarget: event-custom/js/event-target.js:469

Deprecated: use detach

detach a listener

unsubscribeAll

(
  • type
)
deprecated

Inherited from EventTarget: event-custom/js/event-target.js:490

Deprecated: use detachAll

Removes all listeners from the specified event. If the event type is not specified, all listeners from all hosted custom events will be removed.

Parameters:

  • type String
    The type, or name of the event

Properties

_allowAdHocAttrs

Boolean protected

Inherited from BaseCore: base/js/BaseCore.js:155

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._NON_ATTRS_CFG

Default: undefined (false)

_posAlignUIHandles

Array protected

Inherited from WidgetPositionAlign: widget-position-align/js/Widget-PositionAlign.js:225

Holds the alignment-syncing event handles.

Default: null

_UI_ATTRS

Object private

Inherited from Widget: widget/js/Widget.js:1264

The lists of UI attributes to bind and sync for widget's _bindUI and _syncUI implementations

BOUNDING_TEMPLATE

String

Inherited from Widget: widget/js/Widget.js:1160

Property defining the markup template for bounding box.

CONTENT_TEMPLATE

String

Inherited from Widget: widget/js/Widget.js:1150

Property defining the markup template for content box. If your Widget doesn't need the dual boundingBox/contentBox structure, set CONTENT_TEMPLATE to null, and contentBox and boundingBox will both point to the same Node.

DEF_PARENT_NODE

String | Node

Inherited from Widget: widget/js/Widget.js:1141

Default node to render the bounding box to. If not set, will default to the current document body.

DEF_UNIT

String

Inherited from Widget: widget/js/Widget.js:1133

Default unit to use for dimension values

name

String deprecated

Inherited from BaseCore: base/js/BaseCore.js:297

Deprecated: Use this.constructor.NAME

The string used to identify the class of this object.

UI_EVENTS

Object

Inherited from Widget: widget/js/WidgetUIEvents.js:52

Map of DOM events that should be fired as Custom Events by the Widget instance.

Attributes

align

Object

Inherited from WidgetPositionAlign: widget-position-align/js/Widget-PositionAlign.js:40

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__: 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

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

Inherited from WidgetPositionAlign: widget-position-align/js/Widget-PositionAlign.js:89

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 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: []

Example:

Sync this widget's alignment on window resize:

myWidget.set('alignOn', [
                        {
                            node     : Y.one('win'),
                            eventName: 'resize'
                        }
                    ]);

bodyContent

HTML

Inherited from WidgetStdMod: widget-stdmod/js/Widget-StdMod.js:164

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

boundingBox

String | Node

Inherited from Widget: widget/js/Widget.js:175

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.

centered

Boolean | Node

Inherited from WidgetPositionAlign: widget-position-align/js/Widget-PositionAlign.js:71

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

constrain

Boolean | Node

Inherited from WidgetPositionConstrain: widget-position-constrain/js/Widget-PositionConstrain.js:51

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

contentBox

String | Node

Inherited from Widget: widget/js/Widget.js:189

A DOM node that is a direct descendant of a Widget's bounding box that houses its content.

destroyed

Boolean readonly

Inherited from BaseCore: base/js/BaseCore.js:212

Flag indicating whether or not this object has been through the destroy lifecycle phase.

Default: false

disabled

Boolean

Inherited from Widget: widget/js/Widget.js:231

Boolean indicating if the Widget should be disabled. The disabled implementation is left to the specific classes extending widget.

Default: false

fillHeight

String

Inherited from WidgetStdMod: widget-stdmod/js/Widget-StdMod.js:175

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

focused

Boolean readonly

Inherited from Widget: widget/js/Widget.js:218

Boolean indicating if the Widget, or one of its descendants, has focus.

Default: false

footerContent

HTML

Inherited from WidgetStdMod: widget-stdmod/js/Widget-StdMod.js:153

The content to be added to the footer section. This will replace any existing content in the footer. If you want to append, or insert new content, use the setStdModContent method.

Default: undefined

headerContent

HTML

Inherited from WidgetStdMod: widget-stdmod/js/Widget-StdMod.js:142

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

height

String | Number

Inherited from Widget: widget/js/Widget.js:252

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

hideOn

Array

Inherited from WidgetAutohide: widget-autohide/js/Widget-Autohide.js:57

An array of objects corresponding to the nodes, events, and keycodes to hide the widget on. The implementer can supply an array of objects, with each object having the following properties:

eventName: (string, required): The eventName to listen to.

node: (Y.Node, optional): The Y.Node that will fire the event (defaults to the boundingBox of the widget)

keyCode: (string, optional): If listening for key events, specify the keyCode

By default, this attribute consists of one object which will cause the widget to hide if the escape key is pressed.

id

String

Inherited from Widget: widget/js/Widget.js:149

Default: Generated using guid()

initialized

Boolean readonly

Inherited from BaseCore: base/js/BaseCore.js:198

Flag indicating whether or not this object has been through the init lifecycle phase.

Default: false

preventOverlap

Boolean

Inherited from WidgetPositionConstrain: widget-position-constrain/js/Widget-PositionConstrain.js:63

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

render

Boolean | Node

Inherited from Widget: widget/js/Widget.js:286

Whether or not to render the widget automatically after init, and optionally, to which parent node.

rendered

Boolean readonly

Inherited from Widget: widget/js/Widget.js:161

Flag indicating whether or not this Widget has been through the render lifecycle phase.

Default: false

reparentToBody

Boolean

Defined in src/gallery-popup/js/popup.js:161

Set to true to reparent the popup to the body element.

Default: false

shim

Boolean

Inherited from WidgetStack: widget-stack/js/Widget-Stack.js:66

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.

showOn

Array

Defined in src/gallery-popup/js/popup.js:133

List of { node, eventName, keyCode } describing the events that should trigger showing the popup. node and eventName are required.

srcNode

String | Node

Inherited from Widget: widget/js/WidgetHTMLParser.js:58

The DOM node to parse for configuration values, passed to the Widget's HTML_PARSER definition

stayOpenOn

Array

Defined in src/gallery-popup/js/popup.js:147

List of { node, eventName, keyCode } describing the events that should keep the popup open. These block hideOn from being triggered. node and eventName are required.

strings

Object

Inherited from Widget: widget/js/Widget.js:274

Collection of strings used to label elements of the Widget's UI.

Default: null

tabIndex

Number

Inherited from Widget: widget/js/Widget.js:202

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

visible

Boolean

Inherited from Widget: widget/js/Widget.js:242

Boolean indicating whether or not the Widget is visible.

Default: TRUE

width

String | Number

Inherited from Widget: widget/js/Widget.js:263

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

x

Number

Inherited from WidgetPosition: widget-position/js/Widget-Position.js:44

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

xy

Array

Inherited from WidgetPosition: widget-position/js/Widget-Position.js:80

Page XY co-ordinate pair for the widget.

Default: [0,0]

y

Number

Inherited from WidgetPosition: widget-position/js/Widget-Position.js:62

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

zIndex

Number

Inherited from WidgetStack: widget-stack/js/Widget-Stack.js:78

The z-index to apply to the Widgets boundingBox. Non-numerical values for zIndex will be converted to 0

Default: 0

Events

destroy

Inherited from BaseObservable: base/js/BaseObservable.js:163

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:

init

Inherited from BaseObservable: base/js/BaseObservable.js:62

Lifecycle event for the init phase, fired prior to initialization. Invoking the preventDefault() method on the event object provided to subscribers will prevent initialization from occuring.

Subscribers to the "after" momemt of this event, will be notified after initialization of the object is complete (and therefore cannot prevent initialization).

Event Payload:

  • e EventFacade
    Event object, with a cfg property which refers to the configuration object passed to the constructor.

render

Inherited from Widget: widget/js/Widget.js:539

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:

widget:contentUpdate

Inherited from Widget: widget/js/Widget.js:397

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: