AlloyUI - API Docs

  • API Docs for Version: 3.1.0-deprecated.60

    • Show:

    WidgetChild Class

    Defined in: yui3/src/widget-child/js/Widget-Child.js:9
    Module: widget-child

    Widget extension providing functionality enabling a Widget to be a child of another Widget.

    Index

    Properties

    Attributes

    Properties

    ROOT_TYPE

    Object

    Defined in yui3/src/widget-child/js/Widget-Child.js:152

    Constructor reference used to determine the root of a Widget-based object tree. <p> Currently used to control the behavior of the <code>root</code> attribute so that recursing up the object heirarchy can be constrained to a specific type of Widget. Widget authors should set this property to the constructor function for a given Widget implementation. </p>

    Attributes

    depth

    Number readonly

    Defined in yui3/src/widget-child/js/Widget-Child.js:82

    Number representing the depth of this Widget relative to the root Widget in the object heirarchy.

    Default: -1

    index

    Number readonly

    Defined in yui3/src/widget-child/js/Widget-Child.js:45

    Number representing the Widget's ordinal position in its parent Widget.

    parent

    Widget readonly

    Defined in yui3/src/widget-child/js/Widget-Child.js:70

    Retrieves the parent of the Widget in the object hierarchy.

    root

    Widget readonly

    Defined in yui3/src/widget-child/js/Widget-Child.js:116

    Returns the root Widget in the object hierarchy. If the ROOT_TYPE property is set, the search for the root Widget will be constrained to parent Widgets of the specified type.

    selected

    Number

    Defined in yui3/src/widget-child/js/Widget-Child.js:26

    Number indicating if the Widget is selected. Possible values are: <dl> <dt>0</dt> <dd>(Default) Not selected</dd> <dt>1</dt> <dd>Fully selected</dd> <dt>2</dt> <dd>Partially selected</dd> </dl>

    Default: 0