API Docs for: 3.18.1

WidgetStack Class

Defined in: widget-stack/js/Widget-Stack.js:46
Module: widget-stack

Widget extension, which can be used to add stackable (z-index) support to the base Widget class along with a shimming solution, through the Base.build method.

Item Index

Methods

Properties

Attributes

Methods

sizeShim

()

Defined in 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.

Properties

ATTRS

Object static

Defined in widget-stack/js/Widget-Stack.js:57

Static property used to define the default attribute configuration introduced by WidgetStack.

HTML_PARSER

Object static

Defined in widget-stack/js/Widget-Stack.js:91

The HTML parsing rules for the WidgetStack class.

SHIM_CLASS_NAME

String static

Defined in widget-stack/js/Widget-Stack.js:104

Default class used to mark the shim element

Default: "yui3-widget-shim"

SHIM_TEMPLATE

String static

Defined in widget-stack/js/Widget-Stack.js:124

Default markup template used to generate the shim element.

STACKED_CLASS_NAME

String static

Defined in widget-stack/js/Widget-Stack.js:114

Default class used to mark the boundingBox of a stacked widget.

Default: "yui3-widget-stacked"

Attributes

shim

Boolean

Defined in 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.

Fires event shimChange

Fires when the value for the configuration attribute shim is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed.

Parameters:

  • e EventFacade
    An Event Facade object with the following attribute-specific properties added:
    • prevVal Any
      The value of the attribute, prior to it being set.
    • newVal Any
      The value the attribute is to be set to.
    • attrName String
      The name of the attribute being set.
    • subAttrName String
      If setting a property within the attribute's value, the name of the sub-attribute property being set.

zIndex

Number

Defined in 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

Fires event zIndexChange

Fires when the value for the configuration attribute zIndex is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed.

Parameters:

  • e EventFacade
    An Event Facade object with the following attribute-specific properties added:
    • prevVal Any
      The value of the attribute, prior to it being set.
    • newVal Any
      The value the attribute is to be set to.
    • attrName String
      The name of the attribute being set.
    • subAttrName String
      If setting a property within the attribute's value, the name of the sub-attribute property being set.