~smagoun/whoopsie/whoopsie-lp1017637

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>

1421

1422

1423

1424

1425

1426

<p>User configuration object.</p>

1427

</div>

1428

1429

1430

</li>

1431

1432

</ul>

1433

</div>

1434

1435

1436

1437

1438

1439

</div>

1440

1441

</div>

1442

1443

1444

1445

1446

<li class="api-class-tab index"><a href="#index">Index</a></li>

1447

1448

1449

<li class="api-class-tab methods"><a href="#methods">Methods</a></li>

1450

1451

1452

<li class="api-class-tab properties"><a href="#properties">Properties</a></li>

1453

1454

1455

<li class="api-class-tab attrs"><a href="#attrs">Attributes</a></li>

1456

1457

1458

<li class="api-class-tab events"><a href="#events">Events</a></li>

1459

1460

</ul>

1461

1462

<div>

1463

1464

<h2 class="off-left">Item Index</h2>

1465

1466

1467

1468

<h3>Methods</h3>

1469

1470

1471

1472

1473

1474

1475

1476

</li>

1477

1478

1479

<a href="#method__afterActiveDescendantChange">_afterActiveDescendantChange</a>

1480

1481

1482

</li>

1483

1484

1485

<a href="#method__afterDestroyChild">_afterDestroyChild</a>

1486

1487

1488

</li>

1489

1490

1491

<a href="#method__afterParentSelectedChange">_afterParentSelectedChange</a>

1492

1493

1494

</li>

1495

1496

1497

<a href="#method__afterSelectionChange">_afterSelectionChange</a>

1498

1499

1500

</li>

1501

1502

1503

<a href="#method__bindUIParent">_bindUIParent</a>

1504

1505

1506

</li>

1507

1508

1509

<a href="#method__createChild">_createChild</a>

1510

1511

1512

</li>

1513

1514

1515

<a href="#method__defAddChildFn">_defAddChildFn</a>

1516

1517

1518

</li>

1519

1520

1521

<a href="#method__defRemoveChildFn">_defRemoveChildFn</a>

1522

1523

1524

</li>

1525

1526

1527

<a href="#method__destroyChildren">_destroyChildren</a>

1528

1529

1530

</li>

1531

1532

1533

1534

1535

1536

</li>

1537

1538

1539

<a href="#method__renderChildren">_renderChildren</a>

1540

1541

1542

</li>

1543

1544

1545

<a href="#method__setSelection">_setSelection</a>

1546

1547

1548

</li>

1549

1550

1551

<a href="#method__uiAddChild">_uiAddChild</a>

1552

1553

1554

</li>

1555

1556

1557

<a href="#method__uiRemoveChild">_uiRemoveChild</a>

1558

1559

1560

</li>

1561

1562

1563

<a href="#method__updateActiveDescendant">_updateActiveDescendant</a>

1564

1565

1566

</li>

1567

1568

1569

<a href="#method__updateSelection">_updateSelection</a>

1570

1571

1572

</li>

1573

1574

1575

1576

1577

1578

</li>

1579

1580

1581

<a href="#method_deselectAll">deselectAll</a>

1582

1583

1584

</li>

1585

1586

1587

<a href="#method_destructor">destructor</a>

1588

1589

1590

</li>

1591

1592

1593

1594

1595

1596

</li>

1597

1598

1599

<a href="#method_filter">filter</a>

1600

1601

1602

</li>

1603

1604

1605

<a href="#method_indexOf">indexOf</a>

1606

1607

1608

</li>

1609

1610

1611

<a href="#method_isEmpty">isEmpty</a>

1612

1613

1614

</li>

1615

1616

1617

1618

1619

1620

</li>

1621

1622

1623

<a href="#method_itemsAreEqual">itemsAreEqual</a>

1624

1625

1626

</li>

1627

1628

1629

<a href="#method_remove">remove</a>

1630

1631

1632

</li>

1633

1634

1635

<a href="#method_removeAll">removeAll</a>

1636

1637

1638

</li>

1639

1640

1641

<a href="#method_selectAll">selectAll</a>

1642

1643

1644

</li>

1645

1646

1647

<a href="#method_selectChild">selectChild</a>

1648

1649

1650

</li>

1651

1652

1653

1654

1655

1656

</li>

1657

1658

1659

1660

1661

1662

</li>

1663

1664

1665

<a href="#method_toJSON">toJSON</a>

1666

1667

1668

</li>

1669

1670

</ul>

1671

</div>

1672

1673

1674

1675

1676

<h3>Properties</h3>

1677

1678

1679

1680

1681

<a href="#property__childrenContainer">_childrenContainer</a>

1682

1683

1684

</li>

1685

1686

</ul>

1687

</div>

1688

1689

1690

1691

1692

<h3>Attributes</h3>

1693

1694

1695

1696

1697

<a href="#attr_activeDescendant">activeDescendant</a>

1698

</li>

1699

1700

1701

<a href="#attr_defaultChildType">defaultChildType</a>

1702

</li>

1703

1704

1705

<a href="#attr_multiple">multiple</a>

1706

</li>

1707

1708

1709

<a href="#attr_selection">selection</a>

1710

</li>

1711

1712

</ul>

1713

</div>

1714

1715

1716

1717

1718

<h3>Events</h3>

1719

1720

1721

1722

1723

<a href="#event_addChild">addChild</a>

1724

1725

1726

</li>

1727

1728

1729

<a href="#event_removeChild">removeChild</a>

1730

1731

1732

</li>

1733

1734

</ul>

1735

</div>

1736

1737

</div>

1738

1739

1740

1741

<h2 class="off-left">Methods</h2>

1742

1743

1744

1745

1746

1747

1748

1749

1750

1751

1752

1753

<code>child</code>

1754

1755

</li>

1756

1757

1758

1759

<code>child</code>

1760

1761

</li>

1762

1763

1764

1765

<code>index</code>

1766

1767

</li>

1768

1769

</ul><span class="paren">)</span>

1770

</div>

1771

1772

1773

1774

1775

<span class="type"><a href="../classes/Widget.html" class="crosslink">Widget</a> | <a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Array" class="crosslink external" target="_blank">Array</a></span>

1776

</span>

1777

1778

1779

1780

1781

1782

<span class="flag protected">protected</span>

1783

1784

1785

1786

1787

1788

1789

1790

1791

1792

1793

1794

1795

<p>

1796

1797

Defined in

1798

1799

1800

1801

1802

<a href="../files/widget-parent_js_Widget-Parent.js.html#l533"><code>widget-parent/js/Widget-Parent.js:533</code></a>

1803

1804

</p>

1805

1806

1807

1808

1809

1810

</div>

1811

1812

1813

<p>Adds a Widget as a child. If the specified Widget already

1814

has a parent it will be removed from its current parent before

1815

being added as a child.</p>

1816

</div>

1817

1818

1819

1820

<h4>Parameters:</h4>

1821

1822

1823

1824

1825

1826

<code class="param-name">child</code>

1827

<span class="type"><a href="../classes/Widget.html" class="crosslink">Widget</a> | <a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>

1828

1829

1830

1831

1832

1833

<p>The Widget instance, or configuration

1834

object for the Widget to be added as a child.</p>

1835

</div>

1836

1837

1838

</li>

1839

1840

1841

1842

<code class="param-name">child</code>

1843

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Array" class="crosslink external" target="_blank">Array</a></span>

1844

1845

1846

1847

1848

1849

<p>Array of Widget instances, or configuration

1850

objects for the Widgets to be added as a children.</p>

1851

</div>

1852

1853

1854

</li>

1855

1856

1857

1858

<code class="param-name">index</code>

1859

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Number" class="crosslink external" target="_blank">Number</a></span>

1860

1861

1862

1863

1864

1865

<p>(Optional.) Number representing the position at

1866

which the child should be inserted.</p>

1867

</div>

1868

1869

1870

</li>

1871

1872

</ul>

1873

</div>

1874

1875

1876

1877

1878

<h4>Returns:</h4>

1879

1880

1881

1882

1883

1884

1885

Successfully added Widget or Array containing the

1886

successfully added Widget instance(s). If no children where added, will

1887

will return undefined.

1888

1889

</div>

1890

</div>

1891

1892

1893

1894

</div>

1895

1896

1897

1898

<h3 class="name"><code>_afterActiveDescendantChange</code></h3>

1899

1900

1901

1902

1903

1904

1905

1906

<code>event</code>

1907

1908

</li>

1909

1910

</ul><span class="paren">)</span>

1911

</div>

1912

1913

1914

1915

1916

1917

1918

1919

<span class="flag protected">protected</span>

1920

1921

1922

1923

1924

1925

1926

1927

1928

1929

1930

1931

1932

<p>

1933

1934

Defined in

1935

1936

1937

1938

1939

<a href="../files/widget-parent_js_Widget-Parent.js.html#l271"><code>widget-parent/js/Widget-Parent.js:271</code></a>

1940

1941

</p>

1942

1943

1944

1945

1946

1947

</div>

1948

1949

1950

<p>Attribute change listener for the <code>activeDescendant</code>

1951

attribute, responsible for setting the value of the

1952

parent's <code>activeDescendant</code> attribute.</p>

1953

</div>

1954

1955

1956

1957

<h4>Parameters:</h4>

1958

1959

1960

1961

1962

1963

<code class="param-name">event</code>

1964

<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>

1965

1966

1967

1968

1969

1970

<p>The event facade for the attribute change.</p>

1971

</div>

1972

1973

1974

</li>

1975

1976

</ul>

1977

</div>

1978

1979

1980

1981

1982

1983

</div>

1984

1985

1986

1987

<h3 class="name"><code>_afterDestroyChild</code></h3>

1988

1989

1990

1991

1992

1993

1994

1995

<code>event</code>

1996

1997

</li>

1998

1999

</ul><span class="paren">)</span>

2000

</div>

2001

2002

2003

2004

2005

2006

2007

2008

<span class="flag protected">protected</span>

2009

2010

2011

2012

2013

2014

2015

2016

2017

2018

2019

2020

2021

<p>

2022

2023

Defined in

2024

2025

2026

2027

2028

<a href="../files/widget-parent_js_Widget-Parent.js.html#l217"><code>widget-parent/js/Widget-Parent.js:217</code></a>

2029

2030

</p>

2031

2032

2033

2034

2035

2036

</div>

2037

2038

2039

<p>Destroy event listener for each child Widget, responsible for removing

2040

the destroyed child Widget from the parent's internal array of children

2041

(_items property).</p>

2042

</div>

2043

2044

2045

2046

<h4>Parameters:</h4>

2047

2048

2049

2050

2051

2052

<code class="param-name">event</code>

2053

<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>

2054

2055

2056

2057

2058

2059

<p>The event facade for the attribute change.</p>

2060

</div>

2061

2062

2063

</li>

2064

2065

</ul>

2066

</div>

2067

2068

2069

2070

2071

2072

</div>

2073

2074

2075

2076

<h3 class="name"><code>_afterParentSelectedChange</code></h3>

2077

2078

2079

2080

2081

2082

2083

2084

<code>event</code>

2085

2086

</li>

2087

2088

</ul><span class="paren">)</span>

2089

</div>

2090

2091

2092

2093

2094

2095

2096

2097

<span class="flag protected">protected</span>

2098

2099

2100

2101

2102

2103

2104

2105

2106

2107

2108

2109

2110

<p>

2111

2112

Defined in

2113

2114

2115

2116

2117

<a href="../files/widget-parent_js_Widget-Parent.js.html#l288"><code>widget-parent/js/Widget-Parent.js:288</code></a>

2118

2119

</p>

2120

2121

2122

2123

2124

2125

</div>

2126

2127

2128

<p>Attribute change listener for the <code>selected</code>

2129

attribute, responsible for syncing the selected state of all children to

2130

match that of their parent Widget.</p>

2131

</div>

2132

2133

2134

2135

<h4>Parameters:</h4>

2136

2137

2138

2139

2140

2141

<code class="param-name">event</code>

2142

<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>

2143

2144

2145

2146

2147

2148

<p>The event facade for the attribute change.</p>

2149

</div>

2150

2151

2152

</li>

2153

2154

</ul>

2155

</div>

2156

2157

2158

2159

2160

2161

</div>

2162

2163

2164

2165

<h3 class="name"><code>_afterSelectionChange</code></h3>

2166

2167

2168

2169

2170

2171

2172

2173

<code>event</code>

2174

2175

</li>

2176

2177

</ul><span class="paren">)</span>

2178

</div>

2179

2180

2181

2182

2183

2184

2185

2186

<span class="flag protected">protected</span>

2187

2188

2189

2190

2191

2192

2193

2194

2195

2196

2197

2198

2199

<p>

2200

2201

Defined in

2202

2203

2204

2205

2206

<a href="../files/widget-parent_js_Widget-Parent.js.html#l234"><code>widget-parent/js/Widget-Parent.js:234</code></a>

2207

2208

</p>

2209

2210

2211

2212

2213

2214

</div>

2215

2216

2217

<p>Attribute change listener for the <code>selection</code>

2218

attribute, responsible for setting the value of the

2219

parent's <code>selected</code> attribute.</p>

2220

</div>

2221

2222

2223

2224

<h4>Parameters:</h4>

2225

2226

2227

2228

2229

2230

<code class="param-name">event</code>

2231

<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>

2232

2233

2234

2235

2236

2237

<p>The event facade for the attribute change.</p>

2238

</div>

2239

2240

2241

</li>

2242

2243

</ul>

2244

</div>

2245

2246

2247

2248

2249

2250

</div>

2251

2252

2253

2254

<h3 class="name"><code>_bindUIParent</code></h3>

2255

2256

2257

2258

2259

2260

2261

2262

2263

2264

2265

<span class="flag protected">protected</span>

2266

2267

2268

2269

2270

2271

2272

2273

2274

2275

2276

2277

2278

<p>

2279

2280

Defined in

2281

2282

2283

2284

2285

<a href="../files/widget-parent_js_Widget-Parent.js.html#l787"><code>widget-parent/js/Widget-Parent.js:787</code></a>

2286

2287

</p>

2288

2289

2290

2291

2292

2293

</div>

2294

2295

2296

<p>Sets up DOM and CustomEvent listeners for the parent widget.</p>

2297

2298

<p>

2299

This method in invoked after bindUI is invoked for the Widget class

2300

using YUI's aop infrastructure.

2301

</p>

2302

</div>

2303

2304

2305

2306

2307

2308

2309

</div>

2310

2311

2312

2313

<h3 class="name"><code>_createChild</code></h3>

2314

2315

2316

2317

2318

2319

2320

2321

<code>config</code>

2322

2323

</li>

2324

2325

</ul><span class="paren">)</span>

2326

</div>

2327

2328

2329

2330

2331

2332

2333

2334

<span class="flag protected">protected</span>

2335

2336

2337

2338

2339

2340

2341

2342

2343

2344

2345

2346

2347

<p>

2348

2349

Defined in

2350

2351

2352

2353

2354

<a href="../files/widget-parent_js_Widget-Parent.js.html#l419"><code>widget-parent/js/Widget-Parent.js:419</code></a>

2355

2356

</p>

2357

2358

2359

2360

2361

2362

</div>

2363

2364

2365

<p>Creates an instance of a child Widget using the specified configuration.

2366

By default Widget instances will be created of the type specified

2367

by the <code>defaultChildType</code> attribute. Types can be explicitly

2368

defined via the <code>childType</code> property of the configuration object

2369

literal. The use of the <code>type</code> property has been deprecated, but

2370

will still be used as a fallback, if <code>childType</code> is not defined,

2371

for backwards compatibility.</p>

2372

</div>

2373

2374

2375

2376

<h4>Parameters:</h4>

2377

2378

2379

2380

2381

2382

<code class="param-name">config</code>

2383

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>

2384

2385

2386

2387

2388

2389

<p>Object literal representing the configuration

2390

used to create an instance of a Widget.</p>

2391

</div>

2392

2393

2394

</li>

2395

2396

</ul>

2397

</div>

2398

2399

2400

2401

2402

2403

</div>

2404

2405

2406

2407

<h3 class="name"><code>_defAddChildFn</code></h3>

2408

2409

2410

2411

2412

2413

2414

2415

<code>event</code>

2416

2417

</li>

2418

2419

2420

2421

<code>child</code>

2422

2423

</li>

2424

2425

2426

2427

<code>index</code>

2428

2429

</li>

2430

2431

</ul><span class="paren">)</span>

2432

</div>

2433

2434

2435

2436

2437

2438

2439

2440

<span class="flag protected">protected</span>

2441

2442

2443

2444

2445

2446

2447

2448

2449

2450

2451

2452

2453

<p>

2454

2455

Defined in

2456

2457

2458

2459

2460

<a href="../files/widget-parent_js_Widget-Parent.js.html#l462"><code>widget-parent/js/Widget-Parent.js:462</code></a>

2461

2462

</p>

2463

2464

2465

2466

2467

2468

</div>

2469

2470

2471

<p>Default addChild handler</p>

2472

</div>

2473

2474

2475

2476

<h4>Parameters:</h4>

2477

2478

2479

2480

2481

2482

<code class="param-name">event</code>

2483

<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>

2484

2485

2486

2487

2488

2489

<p>The Event object</p>

2490

</div>

2491

2492

2493

</li>

2494

2495

2496

2497

<code class="param-name">child</code>

2498

<span class="type"><a href="../classes/Widget.html" class="crosslink">Widget</a></span>

2499

2500

2501

2502

2503

2504

<p>The Widget instance, or configuration

2505

object for the Widget to be added as a child.</p>

2506

</div>

2507

2508

2509

</li>

2510

2511

2512

2513

<code class="param-name">index</code>

2514

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Number" class="crosslink external" target="_blank">Number</a></span>

2515

2516

2517

2518

2519

2520

<p>Number representing the position at

2521

which the child will be inserted.</p>

2522

</div>

2523

2524

2525

</li>

2526

2527

</ul>

2528

</div>

2529

2530

2531

2532

2533

2534

</div>

2535

2536

2537

2538

<h3 class="name"><code>_defRemoveChildFn</code></h3>

2539

2540

2541

2542

2543

2544

2545

2546

<code>event</code>

2547

2548

</li>

2549

2550

2551

2552

<code>child</code>

2553

2554

</li>

2555

2556

2557

2558

<code>index</code>

2559

2560

</li>

2561

2562

</ul><span class="paren">)</span>

2563

</div>

2564

2565

2566

2567

2568

2569

2570

2571

<span class="flag protected">protected</span>

2572

2573

2574

2575

2576

2577

2578

2579

2580

2581

2582

2583

2584

<p>

2585

2586

Defined in

2587

2588

2589

2590

2591

<a href="../files/widget-parent_js_Widget-Parent.js.html#l502"><code>widget-parent/js/Widget-Parent.js:502</code></a>

2592

2593

</p>

2594

2595

2596

2597

2598

2599

</div>

2600

2601

2602

<p>Default removeChild handler</p>

2603

</div>

2604

2605

2606

2607

<h4>Parameters:</h4>

2608

2609

2610

2611

2612

2613

<code class="param-name">event</code>

2614

<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>

2615

2616

2617

2618

2619

2620

<p>The Event object</p>

2621

</div>

2622

2623

2624

</li>

2625

2626

2627

2628

<code class="param-name">child</code>

2629

<span class="type"><a href="../classes/Widget.html" class="crosslink">Widget</a></span>

2630

2631

2632

2633

2634

2635

<p>The Widget instance to be removed.</p>

2636

</div>

2637

2638

2639

</li>

2640

2641

2642

2643

<code class="param-name">index</code>

2644

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Number" class="crosslink external" target="_blank">Number</a></span>

2645

2646

2647

2648

2649

2650

<p>Number representing the index of the Widget to

2651

be removed.</p>

2652

</div>

2653

2654

2655

</li>

2656

2657

</ul>

2658

</div>

2659

2660

2661

2662

2663

2664

</div>

2665

2666

2667

2668

<h3 class="name"><code>_destroyChildren</code></h3>

2669

2670

2671

2672

2673

2674

2675

2676

2677

2678

2679

<span class="flag protected">protected</span>

2680

2681

2682

2683

2684

2685

2686

2687

2688

2689

2690

2691

2692

<p>

2693

2694

Defined in

2695

2696

2697

2698

2699

<a href="../files/widget-parent_js_Widget-Parent.js.html#l835"><code>widget-parent/js/Widget-Parent.js:835</code></a>

2700

2701

</p>

2702

2703

2704

2705

2706

2707

</div>

2708

2709

2710

<p>Destroys all child Widgets for the parent.</p>

2711

2712

<p>

2713

This method is invoked before the destructor is invoked for the Widget

2714

class using YUI's aop infrastructure.

2715

</p>

2716

</div>

2717

2718

2719

2720

2721

2722

2723

</div>

2724

2725

2726

2727

2728

2729

2730

2731

2732

2733

2734

2735

2736

2737

</li>

2738

2739

</ul><span class="paren">)</span>

2740

</div>

2741

2742

2743

2744

2745

<span class="type">Mixed</span>

2746

</span>

2747

2748

2749

2750

2751

2752

<span class="flag protected">protected</span>

2753

2754

2755

2756

2757

2758

2759

2760

2761

2762

2763

2764

<p>Inherited from

2765

<a href="../classes/ArrayList.html#method__item">ArrayList</a>:

2766

2767

2768

2769

<a href="../files/collection_js_arraylist.js.html#l138"><code>collection/js/arraylist.js:138</code></a>

2770

2771

</p>

2772

2773

2774

2775

2776

2777

</div>

2778

2779

2780

<p>Protected method for optimizations that may be appropriate for API

2781

mirroring. Similar in functionality to <code>item</code>, but is used by

2782

methods added with <code>ArrayList.addMethod()</code>.</p>

2783

</div>

2784

2785

2786

2787

<h4>Parameters:</h4>

2788

2789

2790

2791

2792

2793

2794

<span class="type">Integer</span>

2795

2796

2797

2798

2799

2800

<p>Index of item to fetch</p>

2801

</div>

2802

2803

2804

</li>

2805

2806

</ul>

2807

</div>

2808

2809

2810

2811

2812

<h4>Returns:</h4>

2813

2814

2815

2816

2817

<span class="type">Mixed</span>:

2818

2819

The item appropriate for pass through API methods

2820

2821

</div>

2822

</div>

2823

2824

2825

2826

</div>

2827

2828

2829

2830

<h3 class="name"><code>_renderChildren</code></h3>

2831

2832

2833

2834

2835

2836

2837

2838

2839

2840

2841

<span class="flag protected">protected</span>

2842

2843

2844

2845

2846

2847

2848

2849

2850

2851

2852

2853

2854

<p>

2855

2856

Defined in

2857

2858

2859

2860

2861

<a href="../files/widget-parent_js_Widget-Parent.js.html#l802"><code>widget-parent/js/Widget-Parent.js:802</code></a>

2862

2863

</p>

2864

2865

2866

2867

2868

2869

</div>

2870

2871

2872

<p>Renders all child Widgets for the parent.</p>

2873

2874

<p>

2875

This method in invoked after renderUI is invoked for the Widget class

2876

using YUI's aop infrastructure.

2877

</p>

2878

</div>

2879

2880

2881

2882

2883

2884

2885

</div>

2886

2887

2888

2889

<h3 class="name"><code>_setSelection</code></h3>

2890

2891

2892

2893

2894

2895

2896

2897

<code>child</code>

2898

2899

</li>

2900

2901

</ul><span class="paren">)</span>

2902

</div>

2903

2904

2905

2906

2907

2908

</span>

2909

2910

2911

2912

2913

2914

<span class="flag protected">protected</span>

2915

2916

2917

2918

2919

2920

2921

2922

2923

2924

2925

2926

2927

<p>

2928

2929

Defined in

2930

2931

2932

2933

2934

<a href="../files/widget-parent_js_Widget-Parent.js.html#l320"><code>widget-parent/js/Widget-Parent.js:320</code></a>

2935

2936

</p>

2937

2938

2939

2940

2941

2942

</div>

2943

2944

2945

<p>Default setter for <code>selection</code> attribute changes.</p>

2946

</div>

2947

2948

2949

2950

<h4>Parameters:</h4>

2951

2952

2953

2954

2955

2956

<code class="param-name">child</code>

2957

2958

2959

2960

2961

2962

2963

<p>Widget or Array of Widget instances.</p>

2964

</div>

2965

2966

2967

</li>

2968

2969

</ul>

2970

</div>

2971

2972

2973

2974

2975

<h4>Returns:</h4>

2976

2977

2978

2979

2980

2981

2982

Widget or Array of Widget instances.

2983

2984

</div>

2985

</div>

2986

2987

2988

2989

</div>

2990

2991

2992

2993

<h3 class="name"><code>_uiAddChild</code></h3>

2994

2995

2996

2997

2998

2999

3000

3001

<code>child</code>

3002

3003

</li>

3004

3005

3006

3007

<code>parentNode</code>

3008

3009

</li>

3010

3011

</ul><span class="paren">)</span>

3012

</div>

3013

3014

3015

3016

3017

3018

3019

3020

<span class="flag protected">protected</span>

3021

3022

3023

3024

3025

3026

3027

3028

3029

3030

3031

3032

3033

<p>

3034

3035

Defined in

3036

3037

3038

3039

3040

<a href="../files/widget-parent_js_Widget-Parent.js.html#l704"><code>widget-parent/js/Widget-Parent.js:704</code></a>

3041

3042

</p>

3043

3044

3045

3046

3047

3048

</div>

3049

3050

3051

<p>Updates the UI in response to a child being added.</p>

3052

</div>

3053

3054

3055

3056

<h4>Parameters:</h4>

3057

3058

3059

3060

3061

3062

<code class="param-name">child</code>

3063

<span class="type"><a href="../classes/Widget.html" class="crosslink">Widget</a></span>

3064

3065

3066

3067

3068

3069

<p>The child Widget instance to render.</p>

3070

</div>

3071

3072

3073

</li>

3074

3075

3076

3077

<code class="param-name">parentNode</code>

3078

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>

3079

3080

3081

3082

3083

3084

<p>The Node under which the

3085

child Widget is to be rendered.</p>

3086

</div>

3087

3088

3089

</li>

3090

3091

</ul>

3092

</div>

3093

3094

3095

3096

3097

3098

</div>

3099

3100

3101

3102

<h3 class="name"><code>_uiRemoveChild</code></h3>

3103

3104

3105

3106

3107

3108

3109

3110

<code>child</code>

3111

3112

</li>

3113

3114

</ul><span class="paren">)</span>

3115

</div>

3116

3117

3118

3119

3120

3121

3122

3123

<span class="flag protected">protected</span>

3124

3125

3126

3127

3128

3129

3130

3131

3132

3133

3134

3135

3136

<p>

3137

3138

Defined in

3139

3140

3141

3142

3143

<a href="../files/widget-parent_js_Widget-Parent.js.html#l760"><code>widget-parent/js/Widget-Parent.js:760</code></a>

3144

3145

</p>

3146

3147

3148

3149

3150

3151

</div>

3152

3153

3154

<p>Updates the UI in response to a child being removed.</p>

3155

</div>

3156

3157

3158

3159

<h4>Parameters:</h4>

3160

3161

3162

3163

3164

3165

<code class="param-name">child</code>

3166

<span class="type"><a href="../classes/Widget.html" class="crosslink">Widget</a></span>

3167

3168

3169

3170

3171

3172

<p>The child Widget instance to render.</p>

3173

</div>

3174

3175

3176

</li>

3177

3178

</ul>

3179

</div>

3180

3181

3182

3183

3184

3185

</div>

3186

3187

3188

3189

<h3 class="name"><code>_updateActiveDescendant</code></h3>

3190

3191

3192

3193

3194

3195

3196

3197

<code>event</code>

3198

3199

</li>

3200

3201

</ul><span class="paren">)</span>

3202

</div>

3203

3204

3205

3206

3207

3208

3209

3210

<span class="flag protected">protected</span>

3211

3212

3213

3214

3215

3216

3217

3218

3219

3220

3221

3222

3223

<p>

3224

3225

Defined in

3226

3227

3228

3229

3230

<a href="../files/widget-parent_js_Widget-Parent.js.html#l405"><code>widget-parent/js/Widget-Parent.js:405</code></a>

3231

3232

</p>

3233

3234

3235

3236

3237

3238

</div>

3239

3240

3241

<p>Attribute change listener for the <code>focused</code>

3242

attribute of child Widgets, responsible for setting the value of the

3243

parent's <code>activeDescendant</code> attribute.</p>

3244

</div>

3245

3246

3247

3248

<h4>Parameters:</h4>

3249

3250

3251

3252

3253

3254

<code class="param-name">event</code>

3255

<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>

3256

3257

3258

3259

3260

3261

<p>The event facade for the attribute change.</p>

3262

</div>

3263

3264

3265

</li>

3266

3267

</ul>

3268

</div>

3269

3270

3271

3272

3273

3274

</div>

3275

3276

3277

3278

<h3 class="name"><code>_updateSelection</code></h3>

3279

3280

3281

3282

3283

3284

3285

3286

<code>event</code>

3287

3288

</li>

3289

3290

</ul><span class="paren">)</span>

3291

</div>

3292

3293

3294

3295

3296

3297

3298

3299

<span class="flag protected">protected</span>

3300

3301

3302

3303

3304

3305

3306

3307

3308

3309

3310

3311

3312

<p>

3313

3314

Defined in

3315

3316

3317

3318

3319

<a href="../files/widget-parent_js_Widget-Parent.js.html#l363"><code>widget-parent/js/Widget-Parent.js:363</code></a>

3320

3321

</p>

3322

3323

3324

3325

3326

3327

</div>

3328

3329

3330

<p>Attribute change listener for the <code>selected</code>

3331

attribute of child Widgets, responsible for setting the value of the

3332

parent's <code>selection</code> attribute.</p>

3333

</div>

3334

3335

3336

3337

<h4>Parameters:</h4>

3338

3339

3340

3341

3342

3343

<code class="param-name">event</code>

3344

<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>

3345

3346

3347

3348

3349

3350

<p>The event facade for the attribute change.</p>

3351

</div>

3352

3353

3354

</li>

3355

3356

</ul>

3357

</div>

3358

3359

3360

3361

3362

3363

</div>

3364

3365

3366

3367

3368

3369

3370

3371

3372

3373

3374

3375

<code>child</code>

3376

3377

</li>

3378

3379

3380

3381

<code>child</code>

3382

3383

</li>

3384

3385

3386

3387

<code>index</code>

3388

3389

</li>

3390

3391

</ul><span class="paren">)</span>

3392

</div>

3393

3394

3395

3396

3397

<span class="type"><a href="../classes/ArrayList.html" class="crosslink">ArrayList</a></span>

3398

</span>

3399

3400

3401

3402

3403

3404

3405

3406

3407

3408

3409

3410

3411

3412

3413

<p>Inherited from

3414

3415

ArrayList

3416

</a>

3417

3418

but overwritten in

3419

3420

3421

3422

<a href="../files/widget-parent_js_Widget-Parent.js.html#l596"><code>widget-parent/js/Widget-Parent.js:596</code></a>

3423

3424

</p>

3425

3426

3427

3428

3429

3430

</div>

3431

3432

3433

<p>Adds a Widget as a child. If the specified Widget already

3434

has a parent it will be removed from its current parent before

3435

being added as a child.</p>

3436

</div>

3437

3438

3439

3440

<h4>Parameters:</h4>

3441

3442

3443

3444

3445

3446

<code class="param-name">child</code>

3447

<span class="type"><a href="../classes/Widget.html" class="crosslink">Widget</a> | <a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>

3448

3449

3450

3451

3452

3453

<p>The Widget instance, or configuration

3454

object for the Widget to be added as a child. The configuration object

3455

for the child can include a <code>childType</code> property, which is either

3456

a constructor function or a string which names a constructor function on the

3457

Y instance (e.g. "Tab" would refer to Y.Tab) (<code>childType</code> used to be

3458

named <code>type</code>, support for which has been deprecated, but is still

3459

maintained for backward compatibility. <code>childType</code> takes precedence

3460

over <code>type</code> if both are defined.</p>

3461

</div>

3462

3463

3464

</li>

3465

3466

3467

3468

<code class="param-name">child</code>

3469

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Array" class="crosslink external" target="_blank">Array</a></span>

3470

3471

3472

3473

3474

3475

<p>Array of Widget instances, or configuration

3476

objects for the Widgets to be added as a children.</p>

3477

</div>

3478

3479

3480

</li>

3481

3482

3483

3484

<code class="param-name">index</code>

3485

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Number" class="crosslink external" target="_blank">Number</a></span>

3486

3487

3488

3489

3490

3491

<p>(Optional.) Number representing the position at

3492

which the child should be inserted.</p>

3493

</div>

3494

3495

3496

</li>

3497

3498

</ul>

3499

</div>

3500

3501

3502

3503

3504

<h4>Returns:</h4>

3505

3506

3507

3508

3509

<span class="type"><a href="../classes/ArrayList.html" class="crosslink">ArrayList</a></span>:

3510

3511

Y.ArrayList containing the successfully added

3512

Widget instance(s). If no children where added, will return an empty

3513

Y.ArrayList instance.

3514

3515

</div>

3516

</div>

3517

3518

3519

3520

</div>

3521

3522

3523

3524

<h3 class="name"><code>deselectAll</code></h3>

3525

3526

3527

3528

3529

3530

3531

3532

3533

3534

3535

3536

3537

3538

3539

3540

3541

3542

3543

3544

3545

3546

<p>

3547

3548

Defined in

3549

3550

3551

3552

3553

<a href="../files/widget-parent_js_Widget-Parent.js.html#l695"><code>widget-parent/js/Widget-Parent.js:695</code></a>

3554

3555

</p>

3556

3557

3558

3559

3560

3561

</div>

3562

3563

3564

<p>Deselects all children.</p>

3565

</div>

3566

3567

3568

3569

3570

3571

3572

</div>

3573

3574

3575

3576

<h3 class="name"><code>destructor</code></h3>

3577

3578

3579

3580

3581

3582

3583

3584

3585

3586

3587

3588

3589

3590

3591

3592

3593

3594

3595

3596

3597

3598

<p>

3599

3600

Defined in

3601

3602

3603

3604

3605

<a href="../files/widget-parent_js_Widget-Parent.js.html#l209"><code>widget-parent/js/Widget-Parent.js:209</code></a>

3606

3607

</p>

3608

3609

3610

3611

3612

3613

</div>

3614

3615

3616

<p>The destructor implementation for Parent widgets. Destroys all children.</p>

3617

</div>

3618

3619

3620

3621

3622

3623

3624

</div>

3625

3626

3627

3628

3629

3630

3631

3632

3633

3634

3635

3636

3637

3638

</li>

3639

3640

3641

3642

<code>context</code>

3643

3644

</li>

3645

3646

</ul><span class="paren">)</span>

3647

</div>

3648

3649

3650

3651

3652

<span class="type"><a href="../classes/ArrayList.html" class="crosslink">ArrayList</a></span>

3653

</span>

3654

3655

3656

3657

3658

3659

3660

3661

3662

3663

3664

3665

<span class="flag chainable">chainable</span>

3666

3667

3668

3669

3670

3671

<p>Inherited from

3672

<a href="../classes/ArrayList.html#method_each">ArrayList</a>:

3673

3674

3675

3676

<a href="../files/collection_js_arraylist.js.html#l51"><code>collection/js/arraylist.js:51</code></a>

3677

3678

</p>

3679

3680

3681

3682

3683

3684

</div>

3685

3686

3687

<p>Execute a function on each item of the list, optionally providing a

3688

custom execution context. Default context is the item.</p>

3689

3690

<p>The callback signature is <code>callback( item, index )</code>.</p>

3691

</div>

3692

3693

3694

3695

<h4>Parameters:</h4>

3696

3697

3698

3699

3700

3701

3702

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function</a></span>

3703

3704

3705

3706

3707

3708

<p>the function to execute</p>

3709

</div>

3710

3711

3712

</li>

3713

3714

3715

3716

<code class="param-name">context</code>

3717

<span class="type">Mixed</span>

3718

3719

3720

3721

3722

3723

<p>optional override 'this' in the function</p>

3724

</div>

3725

3726

3727

</li>

3728

3729

</ul>

3730

</div>

3731

3732

3733

3734

3735

<h4>Returns:</h4>

3736

3737

3738

3739

3740

<span class="type"><a href="../classes/ArrayList.html" class="crosslink">ArrayList</a></span>:

3741

3742

this instance

3743

3744

</div>

3745

</div>

3746

3747

3748

3749

</div>

3750

3751

3752

3753

<h3 class="name"><code>filter</code></h3>

3754

3755

3756

3757

3758

3759

3760

3761

<code>validator</code>

3762

3763

</li>

3764

3765

</ul><span class="paren">)</span>

3766

</div>

3767

3768

3769

3770

3771

<span class="type"><a href="../classes/ArrayList.html" class="crosslink">ArrayList</a></span>

3772

</span>

3773

3774

3775

3776

<span class="flag deprecated" title="Use ModelList or a custom subclass implementation">deprecated</span>

3777

3778

3779

3780

3781

3782

3783

3784

3785

3786

3787

3788

3789

3790

<p>Inherited from

3791

<a href="../classes/ArrayList.html#method_filter">ArrayList</a>:

3792

3793

3794

3795

<a href="../files/collection_js_arraylist-filter.js.html#l13"><code>collection/js/arraylist-filter.js:13</code></a>

3796

3797

</p>

3798

3799

3800

3801

<p>Deprecated: Use ModelList or a custom subclass implementation</p>

3802

3803

3804

3805

</div>

3806

3807

3808

<p>Create a new ArrayList (or augmenting class instance) from a subset

3809

of items as determined by the boolean function passed as the

3810

argument. The original ArrayList is unchanged.</p>

3811

3812

<p>The validator signature is <code>validator( item )</code>.</p>

3813

</div>

3814

3815

3816

3817

<h4>Parameters:</h4>

3818

3819

3820

3821

3822

3823

<code class="param-name">validator</code>

3824

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function</a></span>

3825

3826

3827

3828

3829

3830

<p>Boolean function to determine in or out.</p>

3831

</div>

3832

3833

3834

</li>

3835

3836

</ul>

3837

</div>

3838

3839

3840

3841

3842

<h4>Returns:</h4>

3843

3844

3845

3846

3847

<span class="type"><a href="../classes/ArrayList.html" class="crosslink">ArrayList</a></span>:

3848

3849

New instance based on who passed the validator.

3850

3851

</div>

3852

</div>

3853

3854

3855

3856

</div>

3857

3858

3859

3860

<h3 class="name"><code>indexOf</code></h3>

3861

3862

3863

3864

3865

3866

3867

3868

<code>needle</code>

3869

3870

</li>

3871

3872

</ul><span class="paren">)</span>

3873

</div>

3874

3875

3876

3877

3878

<span class="type">Integer</span>

3879

</span>

3880

3881

3882

3883

3884

3885

3886

3887

3888

3889

3890

3891

3892

3893

3894

3895

<p>Inherited from

3896

<a href="../classes/ArrayList.html#method_indexOf">ArrayList</a>:

3897

3898

3899

3900

<a href="../files/collection_js_arraylist.js.html#l95"><code>collection/js/arraylist.js:95</code></a>

3901

3902

</p>

3903

3904

3905

3906

3907

3908

</div>

3909

3910

3911

<p>Finds the first index of the needle in the managed array of items.</p>

3912

</div>

3913

3914

3915

3916

<h4>Parameters:</h4>

3917

3918

3919

3920

3921

3922

<code class="param-name">needle</code>

3923

<span class="type">Mixed</span>

3924

3925

3926

3927

3928

3929

<p>The item to search for</p>

3930

</div>

3931

3932

3933

</li>

3934

3935

</ul>

3936

</div>

3937

3938

3939

3940

3941

<h4>Returns:</h4>

3942

3943

3944

3945

3946

<span class="type">Integer</span>:

3947

3948

Array index if found. Otherwise -1

3949

3950

</div>

3951

</div>

3952

3953

3954

3955

</div>

3956

3957

3958

3959

<h3 class="name"><code>isEmpty</code></h3>

3960

3961

3962

3963

3964

3965

3966

3967

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>

3968

</span>

3969

3970

3971

3972

3973

3974

3975

3976

3977

3978

3979

3980

3981

3982

3983

3984

<p>Inherited from

3985

<a href="../classes/ArrayList.html#method_isEmpty">ArrayList</a>:

3986

3987

3988

3989

<a href="../files/collection_js_arraylist.js.html#l116"><code>collection/js/arraylist.js:116</code></a>

3990

3991

</p>

3992

3993

3994

3995

3996

3997

</div>

3998

3999

4000

<p>Is this instance managing any items?</p>

4001

</div>

4002

4003

4004

4005

4006

4007

<h4>Returns:</h4>

4008

4009

4010

4011

4012

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>:

4013

4014

true if 1 or more items are being managed

4015

4016

</div>

4017

</div>

4018

4019

4020

4021

</div>

4022

4023

4024

4025

4026

4027

4028

4029

4030

4031

4032

4033

4034

4035

</li>

4036

4037

</ul><span class="paren">)</span>

4038

</div>

4039

4040

4041

4042

4043

<span class="type">Mixed</span>

4044

</span>

4045

4046

4047

4048

4049

4050

4051

4052

4053

4054

4055

4056

4057

4058

4059

4060

<p>Inherited from

4061

<a href="../classes/ArrayList.html#method_item">ArrayList</a>:

4062

4063

4064

4065

<a href="../files/collection_js_arraylist.js.html#l37"><code>collection/js/arraylist.js:37</code></a>

4066

4067

</p>

4068

4069

4070

4071

4072

4073

</div>

4074

4075

4076

<p>Get an item by index from the list. Override this method if managing a

4077

list of objects that have a different public representation (e.g. Node

4078

instances vs DOM nodes). The iteration methods that accept a user

4079

function will use this method for access list items for operation.</p>

4080

</div>

4081

4082

4083

4084

<h4>Parameters:</h4>

4085

4086

4087

4088

4089

4090

4091

<span class="type">Integer</span>

4092

4093

4094

4095

4096

4097

<p>index to fetch</p>

4098

</div>

4099

4100

4101

</li>

4102

4103

</ul>

4104

</div>

4105

4106

4107

4108

4109

<h4>Returns:</h4>

4110

4111

4112

4113

4114

<span class="type">Mixed</span>:

4115

4116

the item at the requested index

4117

4118

</div>

4119

</div>

4120

4121

4122

4123

</div>

4124

4125

4126

4127

<h3 class="name"><code>itemsAreEqual</code></h3>

4128

4129

4130

4131

4132

4133

4134

4135

4136

4137

</li>

4138

4139

4140

4141

4142

4143

</li>

4144

4145

</ul><span class="paren">)</span>

4146

</div>

4147

4148

4149

4150

4151

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>

4152

</span>

4153

4154

4155

4156

<span class="flag deprecated" title="Use ModelList or a custom ArrayList subclass">deprecated</span>

4157

4158

4159

4160

4161

4162

4163

4164

4165

4166

4167

4168

4169

4170

<p>Inherited from

4171

<a href="../classes/ArrayList.html#method_itemsAreEqual">ArrayList</a>:

4172

4173

4174

4175

<a href="../files/collection_js_arraylist-add.js.html#l68"><code>collection/js/arraylist-add.js:68</code></a>

4176

4177

</p>

4178

4179

4180

4181

<p>Deprecated: Use ModelList or a custom ArrayList subclass</p>

4182

4183

4184

4185

</div>

4186

4187

4188

<p>Default comparator for items stored in this list. Used by remove().</p>

4189

</div>

4190

4191

4192

4193

<h4>Parameters:</h4>

4194

4195

4196

4197

4198

4199

4200

<span class="type">Mixed</span>

4201

4202

4203

4204

4205

4206

<p>item to test equivalence with.</p>

4207

</div>

4208

4209

4210

</li>

4211

4212

4213

4214

4215

<span class="type">Mixed</span>

4216

4217

4218

4219

4220

4221

<p>other item to test equivalance.</p>

4222

</div>

4223

4224

4225

</li>

4226

4227

</ul>

4228

</div>

4229

4230

4231

4232

4233

<h4>Returns:</h4>

4234

4235

4236

4237

4238

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>:

4239

4240

true if items are deemed equivalent.

4241

4242

</div>

4243

</div>

4244

4245

4246

4247

</div>

4248

4249

4250

4251

<h3 class="name"><code>remove</code></h3>

4252

4253

4254

4255

4256

4257

4258

4259

<code>index</code>

4260

4261

</li>

4262

4263

</ul><span class="paren">)</span>

4264

</div>

4265

4266

4267

4268

4269

<span class="type"><a href="../classes/Widget.html" class="crosslink">Widget</a></span>

4270

</span>

4271

4272

4273

4274

4275

4276

4277

4278

4279

4280

4281

4282

4283

4284

4285

<p>Inherited from

4286

4287

ArrayList

4288

</a>

4289

4290

but overwritten in

4291

4292

4293

4294

<a href="../files/widget-parent_js_Widget-Parent.js.html#l627"><code>widget-parent/js/Widget-Parent.js:627</code></a>

4295

4296

</p>

4297

4298

4299

4300

4301

4302

</div>

4303

4304

4305

<p>Removes the Widget from its parent. Optionally, can remove

4306

a child by specifying its index.</p>

4307

</div>

4308

4309

4310

4311

<h4>Parameters:</h4>

4312

4313

4314

4315

4316

4317

<code class="param-name">index</code>

4318

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Number" class="crosslink external" target="_blank">Number</a></span>

4319

4320

4321

4322

4323

4324

<p>(Optional.) Number representing the index of the

4325

child to be removed.</p>

4326

</div>

4327

4328

4329

</li>

4330

4331

</ul>

4332

</div>

4333

4334

4335

4336

4337

<h4>Returns:</h4>

4338

4339

4340

4341

4342

<span class="type"><a href="../classes/Widget.html" class="crosslink">Widget</a></span>:

4343

4344

Widget instance that was successfully removed, otherwise

4345

undefined.

4346

4347

</div>

4348

</div>

4349

4350

4351

4352

</div>

4353

4354

4355

4356

<h3 class="name"><code>removeAll</code></h3>

4357

4358

4359

4360

4361

4362

4363

4364

<span class="type"><a href="../classes/ArrayList.html" class="crosslink">ArrayList</a></span>

4365

</span>

4366

4367

4368

4369

4370

4371

4372

4373

4374

4375

4376

4377

4378

4379

4380

4381

4382

<p>

4383

4384

Defined in

4385

4386

4387

4388

4389

<a href="../files/widget-parent_js_Widget-Parent.js.html#l650"><code>widget-parent/js/Widget-Parent.js:650</code></a>

4390

4391

</p>

4392

4393

4394

4395

4396

4397

</div>

4398

4399

4400

<p>Removes all of the children from the Widget.</p>

4401

</div>

4402

4403

4404

4405

4406

4407

<h4>Returns:</h4>

4408

4409

4410

4411

4412

<span class="type"><a href="../classes/ArrayList.html" class="crosslink">ArrayList</a></span>:

4413

4414

Y.ArrayList instance containing Widgets that were

4415

successfully removed. If no children where removed, will return an empty

4416

Y.ArrayList instance.

4417

4418

</div>

4419

</div>

4420

4421

4422

4423

</div>

4424

4425

4426

4427

<h3 class="name"><code>selectAll</code></h3>

4428

4429

4430

4431

4432

4433

4434

4435

4436

4437

4438

4439

4440

4441

4442

4443

4444

4445

4446

4447

4448

4449

<p>

4450

4451

Defined in

4452

4453

4454

4455

4456

<a href="../files/widget-parent_js_Widget-Parent.js.html#l686"><code>widget-parent/js/Widget-Parent.js:686</code></a>

4457

4458

</p>

4459

4460

4461

4462

4463

4464

</div>

4465

4466

4467

<p>Selects all children.</p>

4468

</div>

4469

4470

4471

4472

4473

4474

4475

</div>

4476

4477

4478

4479

<h3 class="name"><code>selectChild</code></h3>

4480

4481

4482

4483

4484

4485

4486

4487

4488

4489

</li>

4490

4491

</ul><span class="paren">)</span>

4492

</div>

4493

4494

4495

4496

4497

4498

4499

4500

4501

4502

4503

4504

4505

4506

4507

4508

4509

4510

4511

<p>

4512

4513

Defined in

4514

4515

4516

4517

4518

<a href="../files/widget-parent_js_Widget-Parent.js.html#l676"><code>widget-parent/js/Widget-Parent.js:676</code></a>

4519

4520

</p>

4521

4522

4523

4524

4525

4526

</div>

4527

4528

4529

<p>Selects the child at the given index (zero-based).</p>

4530

</div>

4531

4532

4533

4534

<h4>Parameters:</h4>

4535

4536

4537

4538

4539

4540

4541

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Number" class="crosslink external" target="_blank">Number</a></span>

4542

4543

4544

4545

4546

4547

<p>the index of the child to be selected</p>

4548

</div>

4549

4550

4551

</li>

4552

4553

</ul>

4554

</div>

4555

4556

4557

4558

4559

4560

</div>

4561

4562

4563

4564

4565

4566

4567

4568

4569

4570

4571

4572

<span class="type">Integer</span>

4573

</span>

4574

4575

4576

4577

4578

4579

4580

4581

4582

4583

4584

4585

4586

4587

4588

4589

<p>Inherited from

4590

<a href="../classes/ArrayList.html#method_size">ArrayList</a>:

4591

4592

4593

4594

<a href="../files/collection_js_arraylist.js.html#l106"><code>collection/js/arraylist.js:106</code></a>

4595

4596

</p>

4597

4598

4599

4600

4601

4602

</div>

4603

4604

4605

<p>How many items are in this list?</p>

4606

</div>

4607

4608

4609

4610

4611

4612

<h4>Returns:</h4>

4613

4614

4615

4616

4617

<span class="type">Integer</span>:

4618

4619

Number of items in the list

4620

4621

</div>

4622

</div>

4623

4624

4625

4626

</div>

4627

4628

4629

4630

4631

4632

4633

4634

4635

4636

4637

4638

4639

4640

</li>

4641

4642

4643

4644

<code>context</code>

4645

4646

</li>

4647

4648

</ul><span class="paren">)</span>

4649

</div>

4650

4651

4652

4653

4654

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>

4655

</span>

4656

4657

4658

4659

4660

4661

4662

4663

4664

4665

4666

4667

4668

4669

4670

4671

<p>Inherited from

4672

<a href="../classes/ArrayList.html#method_some">ArrayList</a>:

4673

4674

4675

4676

<a href="../files/collection_js_arraylist.js.html#l73"><code>collection/js/arraylist.js:73</code></a>

4677

4678

</p>

4679

4680

4681

4682

4683

4684

</div>

4685

4686

4687

<p>Execute a function on each item of the list, optionally providing a

4688

custom execution context. Default context is the item.</p>

4689

4690

<p>The callback signature is <code>callback( item, index )</code>.</p>

4691

4692

<p>Unlike <code>each</code>, if the callback returns true, the

4693

iteratation will stop.</p>

4694

</div>

4695

4696

4697

4698

<h4>Parameters:</h4>

4699

4700

4701

4702

4703

4704

4705

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function</a></span>

4706

4707

4708

4709

4710

4711

<p>the function to execute</p>

4712

</div>

4713

4714

4715

</li>

4716

4717

4718

4719

<code class="param-name">context</code>

4720

<span class="type">Mixed</span>

4721

4722

4723

4724

4725

4726

<p>optional override 'this' in the function</p>

4727

</div>

4728

4729

4730

</li>

4731

4732

</ul>

4733

</div>

4734

4735

4736

4737

4738

<h4>Returns:</h4>

4739

4740

4741

4742

4743

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>:

4744

4745

True if the function returned true on an item

4746

4747

</div>

4748

</div>

4749

4750

4751

4752

</div>

4753

4754

4755

4756

<h3 class="name"><code>toJSON</code></h3>

4757

4758

4759

4760

4761

4762

4763

4764

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Array" class="crosslink external" target="_blank">Array</a></span>

4765

</span>

4766

4767

4768

4769

4770

4771

4772

4773

4774

4775

4776

4777

4778

4779

4780

4781

<p>Inherited from

4782

<a href="../classes/ArrayList.html#method_toJSON">ArrayList</a>:

4783

4784

4785

4786

<a href="../files/collection_js_arraylist.js.html#l126"><code>collection/js/arraylist.js:126</code></a>

4787

4788

</p>

4789

4790

4791

4792

4793

4794

</div>

4795

4796

4797

<p>Provides an array-like representation for JSON.stringify.</p>

4798

</div>

4799

4800

4801

4802

4803

4804

<h4>Returns:</h4>

4805

4806

4807

4808

4809

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Array" class="crosslink external" target="_blank">Array</a></span>:

4810

4811

an array representation of the ArrayList

4812

4813

</div>

4814

</div>

4815

4816

4817

4818

</div>

4819

4820

4821

</div>

4822

4823

4824

4825

4826

<h2 class="off-left">Properties</h2>

4827

4828

4829

4830

<h3 class="name"><code>_childrenContainer</code></h3>

4831

4832

4833

4834

4835

4836

<span class="flag protected">protected</span>

4837

4838

4839

4840

4841

4842

4843

4844

4845

4846

4847

<p>

4848

4849

Defined in

4850

4851

4852

4853

4854

<a href="../files/widget-parent_js_Widget-Parent.js.html#l813"><code>widget-parent/js/Widget-Parent.js:813</code></a>

4855

4856

</p>

4857

4858

4859

4860

4861

</div>

4862

4863

4864

<p>By default WidgetParent will render it's children to the parent's content box.</p>

4865

4866

<p>If the children need to be rendered somewhere else, the _childrenContainer property

4867

can be set to the Node which the children should be rendered to. This property should be

4868

set before the _renderChildren method is invoked, ideally in your renderUI method,

4869

as soon as you create the element to be rendered to.</p>

4870

</div>

4871

4872

4873

4874

4875

4876

4877

</div>

4878

4879

4880

</div>

4881

4882

4883

4884

4885

<h2 class="off-left">Attributes</h2>

4886

4887

4888

4889

4890

<h3 class="name"><code>activeDescendant</code></h3>

4891

<span class="type"><a href="../classes/Widget.html" class="crosslink">Widget</a></span>

4892

4893

4894

4895

4896

4897

4898

4899

4900

4901

4902

4903

4904

4905

<p>

4906

4907

Defined in

4908

4909

4910

4911

4912

<a href="../files/widget-parent_js_Widget-Parent.js.html#l128"><code>widget-parent/js/Widget-Parent.js:128</code></a>

4913

4914

</p>

4915

4916

4917

4918

4919

</div>

4920

4921

4922

<p>Returns the Widget's currently focused descendant Widget.</p>

4923

</div>

4924

4925

4926

4927

4928

4929

<h4>Fires event <code>activeDescendantChange</code></h4>

4930

4931

<p>

4932

Fires when the value for the configuration attribute <code>activeDescendant</code> is

4933

changed. You can listen for the event using the <code>on</code> method if you

4934

wish to be notified before the attribute's value has changed, or

4935

using the <code>after</code> method if you wish to be notified after the

4936

attribute's value has changed.

4937

</p>

4938

4939

4940

<h4>Parameters:</h4>

4941

4942

4943

4944

4945

<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>

4946

4947

4948

An Event Facade object with the following

4949

attribute-specific properties added:

4950

</div>

4951

4952

4953

4954

<code class="param-name">prevVal</code>

4955

4956

<div class="param-description">The value of the attribute, prior to it being set.</div>

4957

</li>

4958

4959

<code class="param-name">newVal</code>

4960

4961

<div class="param-description">The value the attribute is to be set to.</div>

4962

</li>

4963

4964

<code class="param-name">attrName</code>

4965

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

4966

<div class="param-description">The name of the attribute being set.</div>

4967

</li>

4968

4969

<code class="param-name">subAttrName</code>

4970

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

4971

<div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div>

4972

</li>

4973

</ul>

4974

</li>

4975

</ul>

4976

</div>

4977

</div>

4978

4979

4980

4981

</div>

4982

4983

4984

4985

4986

<h3 class="name"><code>defaultChildType</code></h3>

4987

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a> | <a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>

4988

4989

4990

4991

4992

4993

4994

4995

4996

4997

4998

4999

5000

5001

<p>

5002

5003

Defined in

5004

5005

5006

5007

5008

<a href="../files/widget-parent_js_Widget-Parent.js.html#l106"><code>widget-parent/js/Widget-Parent.js:106</code></a>

5009

5010

</p>

5011

5012

5013

5014

5015

</div>

5016

5017

5018

<p>String representing the default type of the children

5019

managed by this Widget. Can also supply default type as a constructor

5020

reference.</p>

5021

</div>

5022

5023

5024

5025

5026

5027

<h4>Fires event <code>defaultChildTypeChange</code></h4>

5028

5029

<p>

5030

Fires when the value for the configuration attribute <code>defaultChildType</code> is

5031

changed. You can listen for the event using the <code>on</code> method if you

5032

wish to be notified before the attribute's value has changed, or

5033

using the <code>after</code> method if you wish to be notified after the

5034

attribute's value has changed.

5035

</p>

5036

5037

5038

<h4>Parameters:</h4>

5039

5040

5041

5042

5043

<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>

5044

5045

5046

An Event Facade object with the following

5047

attribute-specific properties added:

5048

</div>

5049

5050

5051

5052

<code class="param-name">prevVal</code>

5053

5054

<div class="param-description">The value of the attribute, prior to it being set.</div>

5055

</li>

5056

5057

<code class="param-name">newVal</code>

5058

5059

<div class="param-description">The value the attribute is to be set to.</div>

5060

</li>

5061

5062

<code class="param-name">attrName</code>

5063

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

5064

<div class="param-description">The name of the attribute being set.</div>

5065

</li>

5066

5067

<code class="param-name">subAttrName</code>

5068

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

5069

<div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div>

5070

</li>

5071

</ul>

5072

</li>

5073

</ul>

5074

</div>

5075

</div>

5076

5077

5078

5079

</div>

5080

5081

5082

5083

5084

<h3 class="name"><code>multiple</code></h3>

5085

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>

5086

5087

5088

5089

5090

5091

5092

5093

5094

5095

5096

5097

5098

5099

<p>

5100

5101

Defined in

5102

5103

5104

5105

5106

<a href="../files/widget-parent_js_Widget-Parent.js.html#l139"><code>widget-parent/js/Widget-Parent.js:139</code></a>

5107

5108

</p>

5109

5110

5111

5112

5113

</div>

5114

5115

5116

<p>Boolean indicating if multiple children can be selected at

5117

once. Whether or not multiple selection is enabled is always delegated

5118

to the value of the <code>multiple</code> attribute of the root widget

5119

in the object hierarchy.</p>

5120

</div>

5121

5122

5123

<p><strong>Default:</strong> false</p>

5124

5125

5126

5127

5128

<h4>Fires event <code>multipleChange</code></h4>

5129

5130

<p>

5131

Fires when the value for the configuration attribute <code>multiple</code> is

5132

changed. You can listen for the event using the <code>on</code> method if you

5133

wish to be notified before the attribute's value has changed, or

5134

using the <code>after</code> method if you wish to be notified after the

5135

attribute's value has changed.

5136

</p>

5137

5138

5139

<h4>Parameters:</h4>

5140

5141

5142

5143

5144

<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>

5145

5146

5147

An Event Facade object with the following

5148

attribute-specific properties added:

5149

</div>

5150

5151

5152

5153

<code class="param-name">prevVal</code>

5154

5155

<div class="param-description">The value of the attribute, prior to it being set.</div>

5156

</li>

5157

5158

<code class="param-name">newVal</code>

5159

5160

<div class="param-description">The value the attribute is to be set to.</div>

5161

</li>

5162

5163

<code class="param-name">attrName</code>

5164

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

5165

<div class="param-description">The name of the attribute being set.</div>

5166

</li>

5167

5168

<code class="param-name">subAttrName</code>

5169

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

5170

<div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div>

5171

</li>

5172

</ul>

5173

</li>

5174

</ul>

5175

</div>

5176

</div>

5177

5178

5179

5180

</div>

5181

5182

5183

5184

5185

<h3 class="name"><code>selection</code></h3>

5186

<span class="type"><a href="../classes/ArrayList.html" class="crosslink">ArrayList</a> | <a href="../classes/Widget.html" class="crosslink">Widget</a></span>

5187

5188

5189

5190

5191

5192

5193

5194

5195

5196

5197

5198

5199

5200

<p>

5201

5202

Defined in

5203

5204

5205

5206

5207

<a href="../files/widget-parent_js_Widget-Parent.js.html#l161"><code>widget-parent/js/Widget-Parent.js:161</code></a>

5208

5209

</p>

5210

5211

5212

5213

5214

</div>

5215

5216

5217

<p>Returns the currently selected child Widget. If the

5218

<code>mulitple</code> attribte is set to <code>true</code> will

5219

return an Y.ArrayList instance containing the currently selected

5220

children. If no children are selected, will return null.</p>

5221

</div>

5222

5223

5224

5225

5226

5227

<h4>Fires event <code>selectionChange</code></h4>

5228

5229

<p>

5230

Fires when the value for the configuration attribute <code>selection</code> is

5231

changed. You can listen for the event using the <code>on</code> method if you

5232

wish to be notified before the attribute's value has changed, or

5233

using the <code>after</code> method if you wish to be notified after the

5234

attribute's value has changed.

5235

</p>

5236

5237

5238

<h4>Parameters:</h4>

5239

5240

5241

5242

5243

<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>

5244

5245

5246

An Event Facade object with the following

5247

attribute-specific properties added:

5248

</div>

5249

5250

5251

5252

<code class="param-name">prevVal</code>

5253

5254

<div class="param-description">The value of the attribute, prior to it being set.</div>

5255

</li>

5256

5257

<code class="param-name">newVal</code>

5258

5259

<div class="param-description">The value the attribute is to be set to.</div>

5260

</li>

5261

5262

<code class="param-name">attrName</code>

5263

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

5264

<div class="param-description">The name of the attribute being set.</div>

5265

</li>

5266

5267

<code class="param-name">subAttrName</code>

5268

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

5269

<div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div>

5270

</li>

5271

</ul>

5272

</li>

5273

</ul>

5274

</div>

5275

</div>

5276

5277

5278

5279

</div>

5280

5281

5282

</div>

5283

5284

5285

5286

5287

<h2 class="off-left">Events</h2>

5288

5289

5290

5291

<h3 class="name"><code>addChild</code></h3>

5292

5293

5294

5295

5296

5297

5298

5299

5300

5301

5302

5303

5304

5305

5306

<p>

5307

5308

Defined in

5309

5310

5311

5312

5313

<a href="../files/widget-parent_js_Widget-Parent.js.html#l29"><code>widget-parent/js/Widget-Parent.js:29</code></a>

5314

5315

</p>

5316

5317

5318

5319

5320

</div>

5321

5322

5323

<p>Fires when a Widget is add as a child. The event object will have a

5324

'child' property that returns a reference to the child Widget, as well

5325

as an 'index' property that returns a reference to the index specified

5326

when the add() method was called.</p>

5327

5328

<p>

5329

Subscribers to the "on" moment of this event, will be notified

5330

before a child is added.

5331

</p>

5332

5333

<p>

5334

Subscribers to the "after" moment of this event, will be notified

5335

after a child is added.

5336

</p>

5337

</div>

5338

5339

5340

5341

<h4>Event Payload:</h4>

5342

5343

5344

5345

5346

5347

5348

<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>

5349

5350

5351

5352

5353

5354

<p>The Event Facade</p>

5355

</div>

5356

5357

5358

</li>

5359

5360

</ul>

5361

</div>

5362

5363

5364

5365

5366

</div>

5367

5368

5369

5370

<h3 class="name"><code>removeChild</code></h3>

5371

5372

5373

5374

5375

5376

5377

5378

5379

5380

5381

5382

5383

5384

5385

<p>

5386

5387

Defined in

5388

5389

5390

5391

5392

<a href="../files/widget-parent_js_Widget-Parent.js.html#l53"><code>widget-parent/js/Widget-Parent.js:53</code></a>

5393

5394

</p>

5395

5396

5397

5398

5399

</div>

5400

5401

5402

<p>Fires when a child Widget is removed. The event object will have a

5403

'child' property that returns a reference to the child Widget, as well

5404

as an 'index' property that returns a reference child's ordinal position.</p>

5405

5406

<p>

5407

Subscribers to the "on" moment of this event, will be notified

5408

before a child is removed.

5409

</p>

5410

5411

<p>

5412

Subscribers to the "after" moment of this event, will be notified

5413

after a child is removed.

5414

</p>

5415

</div>

5416

5417

5418

5419

<h4>Event Payload:</h4>

5420

5421

5422

5423

5424

5425

5426

<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>

5427

5428

5429

5430

5431

5432

<p>The Event Facade</p>

5433

</div>

5434

5435

5436

</li>

5437

5438

</ul>

5439

</div>

5440

5441

5442

5443

5444

</div>

5445

5446

5447

</div>

5448

5449

</div>

5450

</div>

5451

5452

</div>

5453

</div>

5454

</div>

5455

</div>

5456

</div>

5457

</div>

5458

5459

5460

5461

5462

5463

5464

5465

5466

</body>

5467

</html>

Older »