~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>

1416

1417

1418

1419

1420

1421

<p>Object literal specifying tabview configuration properties.</p>

1422

</div>

1423

1424

1425

</li>

1426

1427

</ul>

1428

</div>

1429

1430

1431

1432

1433

1434

</div>

1435

1436

</div>

1437

1438

1439

1440

1441

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

1442

1443

1444

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

1445

1446

1447

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

1448

1449

1450

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

1451

1452

1453

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

1454

1455

</ul>

1456

1457

<div>

1458

1459

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

1460

1461

1462

1463

<h3>Methods</h3>

1464

1465

1466

1467

1468

<a href="#method__addAttrs">_addAttrs</a>

1469

1470

1471

</li>

1472

1473

1474

<a href="#method__addLazyAttr">_addLazyAttr</a>

1475

1476

1477

</li>

1478

1479

1480

<a href="#method__afterChildSelectedChange">_afterChildSelectedChange</a>

1481

1482

1483

</li>

1484

1485

1486

<a href="#method__aggregateAttrs">_aggregateAttrs</a>

1487

1488

1489

</li>

1490

1491

1492

<a href="#method__applyParsedConfig">_applyParsedConfig</a>

1493

1494

1495

</li>

1496

1497

1498

<a href="#method__applyParser">_applyParser</a>

1499

1500

1501

</li>

1502

1503

1504

<a href="#method__attrCfgHash">_attrCfgHash</a>

1505

1506

1507

</li>

1508

1509

1510

<a href="#method__baseDestroy">_baseDestroy</a>

1511

1512

1513

</li>

1514

1515

1516

<a href="#method__baseInit">_baseInit</a>

1517

1518

1519

</li>

1520

1521

1522

<a href="#method__bindAttrUI">_bindAttrUI</a>

1523

1524

1525

</li>

1526

1527

1528

<a href="#method__bindDOM">_bindDOM</a>

1529

1530

1531

</li>

1532

1533

1534

<a href="#method__bindUI">_bindUI</a>

1535

1536

1537

</li>

1538

1539

1540

<a href="#method__bindUIChild">_bindUIChild</a>

1541

1542

1543

</li>

1544

1545

1546

<a href="#method__createUIEvent">_createUIEvent</a>

1547

1548

1549

</li>

1550

1551

1552

<a href="#method__defAttrChangeFn">_defAttrChangeFn</a>

1553

1554

1555

</li>

1556

1557

1558

<a href="#method__defaultCB">_defaultCB</a>

1559

1560

1561

</li>

1562

1563

1564

<a href="#method__defDestroyFn">_defDestroyFn</a>

1565

1566

1567

</li>

1568

1569

1570

<a href="#method__defInitFn">_defInitFn</a>

1571

1572

1573

</li>

1574

1575

1576

<a href="#method__defRenderFn">_defRenderFn</a>

1577

1578

1579

</li>

1580

1581

1582

<a href="#method__destroyBox">_destroyBox</a>

1583

1584

1585

</li>

1586

1587

1588

<a href="#method__destroyHierarchy">_destroyHierarchy</a>

1589

1590

1591

</li>

1592

1593

1594

<a href="#method__destroyUIEvents">_destroyUIEvents</a>

1595

1596

1597

</li>

1598

1599

1600

<a href="#method__filterAdHocAttrs">_filterAdHocAttrs</a>

1601

1602

1603

</li>

1604

1605

1606

<a href="#method__filterAttrCfs">_filterAttrCfs</a>

1607

1608

1609

</li>

1610

1611

1612

<a href="#method__filterUIEvent">_filterUIEvent</a>

1613

1614

1615

</li>

1616

1617

1618

<a href="#method__fireAttrChange">_fireAttrChange</a>

1619

1620

1621

</li>

1622

1623

1624

<a href="#method__getAttr">_getAttr</a>

1625

1626

1627

</li>

1628

1629

1630

<a href="#method__getAttrCfg">_getAttrCfg</a>

1631

1632

1633

</li>

1634

1635

1636

<a href="#method__getAttrCfgs">_getAttrCfgs</a>

1637

1638

1639

</li>

1640

1641

1642

<a href="#method__getAttrInitVal">_getAttrInitVal</a>

1643

1644

1645

</li>

1646

1647

1648

<a href="#method__getAttrs">_getAttrs</a>

1649

1650

1651

</li>

1652

1653

1654

<a href="#method__getClasses">_getClasses</a>

1655

1656

1657

</li>

1658

1659

1660

<a href="#method__getHtmlParser">_getHtmlParser</a>

1661

1662

1663

</li>

1664

1665

1666

<a href="#method__getSrcNode">_getSrcNode</a>

1667

1668

1669

</li>

1670

1671

1672

<a href="#method__getStateVal">_getStateVal</a>

1673

1674

1675

</li>

1676

1677

1678

<a href="#method__getStrings">_getStrings</a>

1679

1680

1681

</li>

1682

1683

1684

<a href="#method__getType">_getType</a>

1685

1686

1687

</li>

1688

1689

1690

<a href="#method__getUIEventNode">_getUIEventNode</a>

1691

1692

1693

</li>

1694

1695

1696

1697

1698

1699

</li>

1700

1701

1702

<a href="#method__initAttrHost">_initAttrHost</a>

1703

1704

1705

</li>

1706

1707

1708

<a href="#method__initAttribute">_initAttribute</a>

1709

1710

1711

</li>

1712

1713

1714

<a href="#method__initAttrs">_initAttrs</a>

1715

1716

1717

</li>

1718

1719

1720

<a href="#method__initBase">_initBase</a>

1721

1722

1723

</li>

1724

1725

1726

<a href="#method__initHierarchy">_initHierarchy</a>

1727

1728

1729

</li>

1730

1731

1732

<a href="#method__initHierarchyData">_initHierarchyData</a>

1733

1734

1735

</li>

1736

1737

1738

<a href="#method__initUIEvent">_initUIEvent</a>

1739

1740

1741

</li>

1742

1743

1744

<a href="#method__isLazyAttr">_isLazyAttr</a>

1745

1746

1747

</li>

1748

1749

1750

<a href="#method__isUIEvent">_isUIEvent</a>

1751

1752

1753

</li>

1754

1755

1756

<a href="#method__mapInstance">_mapInstance</a>

1757

1758

1759

</li>

1760

1761

1762

<a href="#method__monitor">_monitor</a>

1763

1764

1765

</li>

1766

1767

1768

<a href="#method__normAttrVals">_normAttrVals</a>

1769

1770

1771

</li>

1772

1773

1774

<a href="#method__onDocFocus">_onDocFocus</a>

1775

1776

1777

</li>

1778

1779

1780

<a href="#method__onDocMouseDown">_onDocMouseDown</a>

1781

1782

1783

</li>

1784

1785

1786

<a href="#method__parseType">_parseType</a>

1787

1788

1789

</li>

1790

1791

1792

<a href="#method__preInitEventCfg">_preInitEventCfg</a>

1793

1794

1795

</li>

1796

1797

1798

<a href="#method__protectAttrs">_protectAttrs</a>

1799

1800

1801

</li>

1802

1803

1804

<a href="#method__removeLoadingClassNames">_removeLoadingClassNames</a>

1805

1806

1807

</li>

1808

1809

1810

<a href="#method__renderBox">_renderBox</a>

1811

1812

1813

</li>

1814

1815

1816

<a href="#method__renderBoxClassNames">_renderBoxClassNames</a>

1817

1818

1819

</li>

1820

1821

1822

<a href="#method__renderUI">_renderUI</a>

1823

1824

1825

</li>

1826

1827

1828

1829

1830

1831

</li>

1832

1833

1834

<a href="#method__setAttr">_setAttr</a>

1835

1836

1837

</li>

1838

1839

1840

<a href="#method__setAttrs">_setAttrs</a>

1841

1842

1843

</li>

1844

1845

1846

<a href="#method__setAttrUI">_setAttrUI</a>

1847

1848

1849

</li>

1850

1851

1852

<a href="#method__setAttrVal">_setAttrVal</a>

1853

1854

1855

</li>

1856

1857

1858

<a href="#method__setBB">_setBB</a>

1859

1860

1861

</li>

1862

1863

1864

<a href="#method__setBox">_setBox</a>

1865

1866

1867

</li>

1868

1869

1870

<a href="#method__setCB">_setCB</a>

1871

1872

1873

</li>

1874

1875

1876

<a href="#method__setStateVal">_setStateVal</a>

1877

1878

1879

</li>

1880

1881

1882

<a href="#method__setStrings">_setStrings</a>

1883

1884

1885

</li>

1886

1887

1888

<a href="#method__strSetter">_strSetter</a>

1889

1890

1891

</li>

1892

1893

1894

<a href="#method__syncAttrUI">_syncAttrUI</a>

1895

1896

1897

</li>

1898

1899

1900

<a href="#method__syncUI">_syncUI</a>

1901

1902

1903

</li>

1904

1905

1906

<a href="#method__syncUIChild">_syncUIChild</a>

1907

1908

1909

</li>

1910

1911

1912

<a href="#method__uiSetChildSelected">_uiSetChildSelected</a>

1913

1914

1915

</li>

1916

1917

1918

<a href="#method__uiSetDim">_uiSetDim</a>

1919

1920

1921

</li>

1922

1923

1924

<a href="#method__uiSetDisabled">_uiSetDisabled</a>

1925

1926

1927

</li>

1928

1929

1930

<a href="#method__uiSetFocused">_uiSetFocused</a>

1931

1932

1933

</li>

1934

1935

1936

<a href="#method__uiSetHeight">_uiSetHeight</a>

1937

1938

1939

</li>

1940

1941

1942

<a href="#method__uiSetTabIndex">_uiSetTabIndex</a>

1943

1944

1945

</li>

1946

1947

1948

<a href="#method__uiSetVisible">_uiSetVisible</a>

1949

1950

1951

</li>

1952

1953

1954

<a href="#method__uiSetWidth">_uiSetWidth</a>

1955

1956

1957

</li>

1958

1959

1960

<a href="#method__uiSizeCB">_uiSizeCB</a>

1961

1962

1963

</li>

1964

1965

1966

<a href="#method__unbindDOM">_unbindDOM</a>

1967

1968

1969

</li>

1970

1971

1972

<a href="#method__unbindUI">_unbindUI</a>

1973

1974

1975

</li>

1976

1977

1978

<a href="#method__validTabIndex">_validTabIndex</a>

1979

1980

1981

</li>

1982

1983

1984

<a href="#method_addAttr">addAttr</a>

1985

1986

1987

</li>

1988

1989

1990

<a href="#method_addAttrs">addAttrs</a>

1991

1992

1993

</li>

1994

1995

1996

<a href="#method_addTarget">addTarget</a>

1997

1998

1999

</li>

2000

2001

2002

<a href="#method_after">after</a>

2003

2004

2005

</li>

2006

2007

2008

<a href="#method_ancestor">ancestor</a>

2009

2010

2011

</li>

2012

2013

2014

<a href="#method_attrAdded">attrAdded</a>

2015

2016

2017

</li>

2018

2019

2020

<a href="#method_before">before</a>

2021

2022

2023

</li>

2024

2025

2026

<a href="#method_bindUI">bindUI</a>

2027

2028

2029

</li>

2030

2031

2032

2033

2034

2035

</li>

2036

2037

2038

<a href="#method_bubble">bubble</a>

2039

2040

2041

</li>

2042

2043

2044

<a href="#method_destroy">destroy</a>

2045

2046

2047

</li>

2048

2049

2050

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

2051

2052

2053

</li>

2054

2055

2056

<a href="#method_detach">detach</a>

2057

2058

2059

</li>

2060

2061

2062

<a href="#method_detachAll">detachAll</a>

2063

2064

2065

</li>

2066

2067

2068

<a href="#method_disable">disable</a>

2069

2070

2071

</li>

2072

2073

2074

<a href="#method_enable">enable</a>

2075

2076

2077

</li>

2078

2079

2080

2081

2082

2083

</li>

2084

2085

2086

<a href="#method_focus">focus</a>

2087

2088

2089

</li>

2090

2091

2092

2093

2094

2095

</li>

2096

2097

2098

<a href="#method_getAttrs">getAttrs</a>

2099

2100

2101

</li>

2102

2103

2104

<a href="#method_getClassName">getClassName</a>

2105

2106

2107

</li>

2108

2109

2110

<a href="#method_getDefaultLocale">getDefaultLocale</a>

2111

2112

2113

</li>

2114

2115

2116

<a href="#method_getEvent">getEvent</a>

2117

2118

2119

</li>

2120

2121

2122

<a href="#method_getSkinName">getSkinName</a>

2123

2124

2125

</li>

2126

2127

2128

<a href="#method_getString">getString</a>

2129

2130

2131

</li>

2132

2133

2134

<a href="#method_getStrings">getStrings</a>

2135

2136

2137

</li>

2138

2139

2140

<a href="#method_getTargets">getTargets</a>

2141

2142

2143

</li>

2144

2145

2146

2147

2148

2149

</li>

2150

2151

2152

2153

2154

2155

</li>

2156

2157

2158

<a href="#method_initializer">initializer</a>

2159

2160

2161

</li>

2162

2163

2164

<a href="#method_isRoot">isRoot</a>

2165

2166

2167

</li>

2168

2169

2170

<a href="#method_modifyAttr">modifyAttr</a>

2171

2172

2173

</li>

2174

2175

2176

2177

2178

2179

</li>

2180

2181

2182

2183

2184

2185

</li>

2186

2187

2188

2189

2190

2191

</li>

2192

2193

2194

<a href="#method_onceAfter">onceAfter</a>

2195

2196

2197

</li>

2198

2199

2200

<a href="#method_parseType">parseType</a>

2201

2202

2203

</li>

2204

2205

2206

<a href="#method_previous">previous</a>

2207

2208

2209

</li>

2210

2211

2212

<a href="#method_publish">publish</a>

2213

2214

2215

</li>

2216

2217

2218

<a href="#method_removeAttr">removeAttr</a>

2219

2220

2221

</li>

2222

2223

2224

<a href="#method_removeTarget">removeTarget</a>

2225

2226

2227

</li>

2228

2229

2230

<a href="#method_render">render</a>

2231

2232

2233

</li>

2234

2235

2236

<a href="#method_renderer">renderer</a>

2237

2238

2239

</li>

2240

2241

2242

<a href="#method_renderUI">renderUI</a>

2243

2244

2245

</li>

2246

2247

2248

<a href="#method_reset">reset</a>

2249

2250

2251

</li>

2252

2253

2254

2255

2256

2257

</li>

2258

2259

2260

<a href="#method_setAttrs">setAttrs</a>

2261

2262

2263

</li>

2264

2265

2266

2267

2268

2269

</li>

2270

2271

2272

<a href="#method_subscribe">subscribe</a>

2273

2274

2275

</li>

2276

2277

2278

<a href="#method_syncUI">syncUI</a>

2279

2280

2281

</li>

2282

2283

2284

<a href="#method_toString">toString</a>

2285

2286

2287

</li>

2288

2289

2290

<a href="#method_unsubscribe">unsubscribe</a>

2291

2292

2293

</li>

2294

2295

2296

<a href="#method_unsubscribeAll">unsubscribeAll</a>

2297

2298

2299

</li>

2300

2301

</ul>

2302

</div>

2303

2304

2305

2306

2307

<h3>Properties</h3>

2308

2309

2310

2311

2312

<a href="#property__allowAdHocAttrs">_allowAdHocAttrs</a>

2313

2314

2315

</li>

2316

2317

2318

<a href="#property__UI_ATTRS">_UI_ATTRS</a>

2319

2320

2321

</li>

2322

2323

2324

<a href="#property_BOUNDING_TEMPLATE">BOUNDING_TEMPLATE</a>

2325

2326

2327

</li>

2328

2329

2330

<a href="#property_CONTENT_TEMPLATE">CONTENT_TEMPLATE</a>

2331

2332

2333

</li>

2334

2335

2336

<a href="#property_DEF_PARENT_NODE">DEF_PARENT_NODE</a>

2337

2338

2339

</li>

2340

2341

2342

2343

2344

2345

</li>

2346

2347

2348

2349

2350

2351

</li>

2352

2353

2354

2355

2356

2357

</li>

2358

2359

2360

<a href="#property_UI_EVENTS">UI_EVENTS</a>

2361

2362

2363

</li>

2364

2365

</ul>

2366

</div>

2367

2368

2369

2370

2371

<h3>Attributes</h3>

2372

2373

2374

2375

2376

<a href="#attr_boundingBox">boundingBox</a>

2377

</li>

2378

2379

2380

<a href="#attr_content">content</a>

2381

</li>

2382

2383

2384

<a href="#attr_contentBox">contentBox</a>

2385

</li>

2386

2387

2388

<a href="#attr_depth">depth</a>

2389

</li>

2390

2391

2392

<a href="#attr_destroyed">destroyed</a>

2393

</li>

2394

2395

2396

<a href="#attr_disabled">disabled</a>

2397

</li>

2398

2399

2400

<a href="#attr_focused">focused</a>

2401

</li>

2402

2403

2404

<a href="#attr_height">height</a>

2405

</li>

2406

2407

2408

2409

</li>

2410

2411

2412

<a href="#attr_index">index</a>

2413

</li>

2414

2415

2416

<a href="#attr_initialized">initialized</a>

2417

</li>

2418

2419

2420

<a href="#attr_label">label</a>

2421

</li>

2422

2423

2424

<a href="#attr_locale">locale</a>

2425

</li>

2426

2427

2428

<a href="#attr_panelNode">panelNode</a>

2429

</li>

2430

2431

2432

<a href="#attr_parent">parent</a>

2433

</li>

2434

2435

2436

<a href="#attr_render">render</a>

2437

</li>

2438

2439

2440

<a href="#attr_rendered">rendered</a>

2441

</li>

2442

2443

2444

2445

</li>

2446

2447

2448

<a href="#attr_selected">selected</a>

2449

</li>

2450

2451

2452

<a href="#attr_srcNode">srcNode</a>

2453

</li>

2454

2455

2456

<a href="#attr_strings">strings</a>

2457

</li>

2458

2459

2460

<a href="#attr_tabIndex">tabIndex</a>

2461

</li>

2462

2463

2464

<a href="#attr_triggerEvent">triggerEvent</a>

2465

</li>

2466

2467

2468

<a href="#attr_visible">visible</a>

2469

</li>

2470

2471

2472

<a href="#attr_width">width</a>

2473

</li>

2474

2475

</ul>

2476

</div>

2477

2478

2479

2480

2481

<h3>Events</h3>

2482

2483

2484

2485

2486

<a href="#event_destroy">destroy</a>

2487

2488

2489

</li>

2490

2491

2492

2493

2494

2495

</li>

2496

2497

2498

<a href="#event_widget:contentUpdate">widget:contentUpdate</a>

2499

2500

2501

</li>

2502

2503

2504

<a href="#event_widget:render">widget:render</a>

2505

2506

2507

</li>

2508

2509

</ul>

2510

</div>

2511

2512

</div>

2513

2514

2515

2516

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

2517

2518

2519

2520

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

2521

2522

2523

2524

2525

2526

2527

2528

2529

2530

</li>

2531

2532

2533

2534

<code>values</code>

2535

2536

</li>

2537

2538

2539

2540

2541

2542

</li>

2543

2544

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

2545

</div>

2546

2547

2548

2549

2550

2551

2552

2553

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

2554

2555

2556

2557

2558

2559

2560

2561

2562

2563

2564

2565

<p>Inherited from

2566

<a href="../classes/AttributeCore.html#method__addAttrs">AttributeCore</a>:

2567

2568

2569

2570

<a href="../files/attribute_js_AttributeCore.js.html#l740"><code>attribute/js/AttributeCore.js:740</code></a>

2571

2572

</p>

2573

2574

2575

2576

2577

2578

</div>

2579

2580

2581

<p>Implementation behind the public addAttrs method. </p>

2582

2583

<p>This method is invoked directly by get if it encounters a scenario

2584

in which an attribute's valueFn attempts to obtain the

2585

value an attribute in the same group of attributes, which has not yet

2586

been added (on demand initialization).</p>

2587

</div>

2588

2589

2590

2591

<h4>Parameters:</h4>

2592

2593

2594

2595

2596

2597

2598

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

2599

2600

2601

2602

2603

2604

<p>An object with attribute name/configuration pairs.</p>

2605

</div>

2606

2607

2608

</li>

2609

2610

2611

2612

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

2613

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

2614

2615

2616

2617

2618

2619

<p>An object with attribute name/value pairs, defining the initial values to apply.

2620

Values defined in the cfgs argument will be over-written by values in this argument unless defined as read only.</p>

2621

</div>

2622

2623

2624

</li>

2625

2626

2627

2628

2629

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

2630

2631

2632

2633

2634

2635

<p>Whether or not to delay the intialization of these attributes until the first call to get/set.

2636

Individual attributes can over-ride this behavior by defining a lazyAdd configuration property in their configuration.

2637

See <a href="#method_addAttr">addAttr</a>.</p>

2638

</div>

2639

2640

2641

</li>

2642

2643

</ul>

2644

</div>

2645

2646

2647

2648

2649

2650

</div>

2651

2652

2653

2654

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

2655

2656

2657

2658

2659

2660

2661

2662

2663

2664

</li>

2665

2666

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

2667

</div>

2668

2669

2670

2671

2672

2673

2674

2675

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

2676

2677

2678

2679

2680

2681

2682

2683

2684

2685

2686

2687

<p>Inherited from

2688

<a href="../classes/AttributeCore.html#method__addLazyAttr">AttributeCore</a>:

2689

2690

2691

2692

<a href="../files/attribute_js_AttributeCore.js.html#l312"><code>attribute/js/AttributeCore.js:312</code></a>

2693

2694

</p>

2695

2696

2697

2698

2699

2700

</div>

2701

2702

2703

<p>Finishes initializing an attribute which has been lazily added.</p>

2704

</div>

2705

2706

2707

2708

<h4>Parameters:</h4>

2709

2710

2711

2712

2713

2714

2715

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

2716

2717

2718

2719

2720

2721

<p>The name of the attribute</p>

2722

</div>

2723

2724

2725

</li>

2726

2727

</ul>

2728

</div>

2729

2730

2731

2732

2733

2734

</div>

2735

2736

2737

2738

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

2739

2740

2741

2742

2743

2744

2745

2746

<code>event</code>

2747

2748

</li>

2749

2750

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

2751

</div>

2752

2753

2754

2755

2756

2757

2758

2759

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

2760

2761

2762

2763

2764

2765

2766

2767

2768

2769

2770

2771

<p>Inherited from

2772

<a href="../classes/Widget.html#method__afterChildSelectedChange">Widget</a>:

2773

2774

2775

2776

<a href="../files/widget-child_js_Widget-Child.js.html#l327"><code>widget-child/js/Widget-Child.js:327</code></a>

2777

2778

</p>

2779

2780

2781

2782

2783

2784

</div>

2785

2786

2787

<p>Default attribute change listener for the <code>selected</code>

2788

attribute, responsible for updating the UI, in response to

2789

attribute changes.</p>

2790

</div>

2791

2792

2793

2794

<h4>Parameters:</h4>

2795

2796

2797

2798

2799

2800

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

2801

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

2802

2803

2804

2805

2806

2807

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

2808

</div>

2809

2810

2811

</li>

2812

2813

</ul>

2814

</div>

2815

2816

2817

2818

2819

2820

</div>

2821

2822

2823

2824

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

2825

2826

2827

2828

2829

2830

2831

2832

<code>allAttrs</code>

2833

2834

</li>

2835

2836

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

2837

</div>

2838

2839

2840

2841

2842

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

2843

</span>

2844

2845

2846

2847

2848

2849

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

2850

2851

2852

2853

2854

2855

2856

2857

2858

2859

2860

2861

<p>Inherited from

2862

<a href="../classes/BaseCore.html#method__aggregateAttrs">BaseCore</a>:

2863

2864

2865

2866

<a href="../files/base_js_BaseCore.js.html#l426"><code>base/js/BaseCore.js:426</code></a>

2867

2868

</p>

2869

2870

2871

2872

2873

2874

</div>

2875

2876

2877

<p>A helper method, used by _initHierarchyData to aggregate

2878

attribute configuration across the instances class hierarchy.</p>

2879

2880

<p>The method will protect the attribute configuration value to protect the statically defined

2881

default value in ATTRS if required (if the value is an object literal, array or the

2882

attribute configuration has cloneDefaultValue set to shallow or deep).</p>

2883

</div>

2884

2885

2886

2887

<h4>Parameters:</h4>

2888

2889

2890

2891

2892

2893

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

2894

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

2895

2896

2897

2898

2899

2900

<p>An array of ATTRS definitions across classes in the hierarchy

2901

(subclass first, Base last)</p>

2902

</div>

2903

2904

2905

</li>

2906

2907

</ul>

2908

</div>

2909

2910

2911

2912

2913

<h4>Returns:</h4>

2914

2915

2916

2917

2918

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

2919

2920

The aggregate set of ATTRS definitions for the instance

2921

2922

</div>

2923

</div>

2924

2925

2926

2927

</div>

2928

2929

2930

2931

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

2932

2933

2934

2935

2936

2937

2938

2939

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

2940

</span>

2941

2942

2943

2944

2945

2946

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

2947

2948

2949

2950

2951

2952

2953

2954

2955

2956

2957

2958

<p>Inherited from

2959

<a href="../classes/Widget.html#method__applyParsedConfig">Widget</a>:

2960

2961

2962

2963

<a href="../files/widget_js_WidgetHTMLParser.js.html#l84"><code>widget/js/WidgetHTMLParser.js:84</code></a>

2964

2965

</p>

2966

2967

2968

2969

2970

2971

</div>

2972

2973

2974

2975

</div>

2976

2977

2978

2979

2980

2981

<h4>Returns:</h4>

2982

2983

2984

2985

2986

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

2987

2988

The merged configuration literal

2989

2990

</div>

2991

</div>

2992

2993

2994

2995

</div>

2996

2997

2998

2999

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

3000

3001

3002

3003

3004

3005

3006

3007

<code>config</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

<p>Inherited from

3033

<a href="../classes/Widget.html#method__applyParser">Widget</a>:

3034

3035

3036

3037

<a href="../files/widget_js_WidgetHTMLParser.js.html#l93"><code>widget/js/WidgetHTMLParser.js:93</code></a>

3038

3039

</p>

3040

3041

3042

3043

3044

3045

</div>

3046

3047

3048

<p>Utilitity method used to apply the <code>HTML_PARSER</code> configuration for the

3049

instance, to retrieve config data values.</p>

3050

</div>

3051

3052

3053

3054

<h4>Parameters:</h4>

3055

3056

3057

3058

3059

3060

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

3061

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

3062

3063

3064

3065

3066

3067

<p>User configuration object (will be populated with values from Node)</p>

3068

</div>

3069

3070

3071

</li>

3072

3073

</ul>

3074

</div>

3075

3076

3077

3078

3079

3080

</div>

3081

3082

3083

3084

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

3085

3086

3087

3088

3089

3090

3091

3092

3093

3094

3095

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

3096

3097

3098

3099

3100

3101

3102

3103

3104

3105

3106

<p>Inherited from

3107

3108

BaseCore

3109

</a>

3110

3111

but overwritten in

3112

3113

3114

3115

3116

3117

</p>

3118

3119

3120

3121

3122

3123

</div>

3124

3125

3126

<p>Utility method to define the attribute hash used to filter/whitelist property mixes for

3127

this class.</p>

3128

</div>

3129

3130

3131

3132

3133

3134

3135

</div>

3136

3137

3138

3139

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

3140

3141

3142

3143

3144

3145

3146

3147

3148

3149

3150

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

3151

3152

3153

3154

3155

3156

3157

3158

3159

3160

3161

3162

<p>Inherited from

3163

<a href="../classes/BaseCore.html#method__baseDestroy">BaseCore</a>:

3164

3165

3166

3167

<a href="../files/base_js_BaseCore.js.html#l263"><code>base/js/BaseCore.js:263</code></a>

3168

3169

</p>

3170

3171

3172

3173

3174

3175

</div>

3176

3177

3178

<p>Internal destroy implementation for BaseCore</p>

3179

</div>

3180

3181

3182

3183

3184

3185

3186

</div>

3187

3188

3189

3190

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

3191

3192

3193

3194

3195

3196

3197

3198

3199

3200

3201

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

3202

3203

3204

3205

3206

3207

3208

3209

3210

3211

3212

3213

<p>Inherited from

3214

<a href="../classes/BaseCore.html#method__baseInit">BaseCore</a>:

3215

3216

3217

3218

<a href="../files/base_js_BaseCore.js.html#l235"><code>base/js/BaseCore.js:235</code></a>

3219

3220

</p>

3221

3222

3223

3224

3225

3226

</div>

3227

3228

3229

<p>Internal initialization implementation for BaseCore</p>

3230

</div>

3231

3232

3233

3234

3235

3236

3237

</div>

3238

3239

3240

3241

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

3242

3243

3244

3245

3246

3247

3248

3249

<code>attrs</code>

3250

3251

</li>

3252

3253

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

3254

</div>

3255

3256

3257

3258

3259

3260

3261

3262

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

3263

3264

3265

3266

3267

3268

3269

3270

3271

3272

3273

3274

<p>Inherited from

3275

<a href="../classes/Widget.html#method__bindAttrUI">Widget</a>:

3276

3277

3278

3279

<a href="../files/widget_js_Widget.js.html#l1146"><code>widget/js/Widget.js:1146</code></a>

3280

3281

</p>

3282

3283

3284

3285

3286

3287

</div>

3288

3289

3290

<p>Binds after listeners for the list of attributes provided</p>

3291

</div>

3292

3293

3294

3295

<h4>Parameters:</h4>

3296

3297

3298

3299

3300

3301

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

3302

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

3303

3304

3305

3306

3307

3308

3309

</div>

3310

3311

3312

</li>

3313

3314

</ul>

3315

</div>

3316

3317

3318

3319

3320

3321

</div>

3322

3323

3324

3325

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

3326

3327

3328

3329

3330

3331

3332

3333

3334

3335

3336

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

3337

3338

3339

3340

3341

3342

3343

3344

3345

3346

3347

3348

<p>Inherited from

3349

<a href="../classes/Widget.html#method__bindDOM">Widget</a>:

3350

3351

3352

3353

<a href="../files/widget_js_Widget.js.html#l889"><code>widget/js/Widget.js:889</code></a>

3354

3355

</p>

3356

3357

3358

3359

3360

3361

</div>

3362

3363

3364

<p>Sets up DOM listeners, on elements rendered by the widget.</p>

3365

</div>

3366

3367

3368

3369

3370

3371

3372

</div>

3373

3374

3375

3376

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

3377

3378

3379

3380

3381

3382

3383

3384

3385

3386

3387

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

3388

3389

3390

3391

3392

3393

3394

3395

3396

3397

3398

3399

<p>Inherited from

3400

<a href="../classes/Widget.html#method__bindUI">Widget</a>:

3401

3402

3403

3404

<a href="../files/widget_js_Widget.js.html#l870"><code>widget/js/Widget.js:870</code></a>

3405

3406

</p>

3407

3408

3409

3410

3411

3412

</div>

3413

3414

3415

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

3416

</div>

3417

3418

3419

3420

3421

3422

3423

</div>

3424

3425

3426

3427

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

3428

3429

3430

3431

3432

3433

3434

3435

3436

3437

3438

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

3439

3440

3441

3442

3443

3444

3445

3446

3447

3448

3449

3450

<p>Inherited from

3451

<a href="../classes/Widget.html#method__bindUIChild">Widget</a>:

3452

3453

3454

3455

<a href="../files/widget-child_js_Widget-Child.js.html#l356"><code>widget-child/js/Widget-Child.js:356</code></a>

3456

3457

</p>

3458

3459

3460

3461

3462

3463

</div>

3464

3465

3466

<p>Binds event listeners responsible for updating the UI state in response

3467

to WidgetChild related state changes.</p>

3468

3469

<p>

3470

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

3471

using YUI's aop infrastructure.

3472

</p>

3473

</div>

3474

3475

3476

3477

3478

3479

3480

</div>

3481

3482

3483

3484

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

3485

3486

3487

3488

3489

3490

3491

3492

3493

3494

</li>

3495

3496

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

3497

</div>

3498

3499

3500

3501

3502

3503

3504

3505

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

3506

3507

3508

3509

3510

3511

3512

3513

3514

3515

3516

3517

<p>Inherited from

3518

<a href="../classes/Widget.html#method__createUIEvent">Widget</a>:

3519

3520

3521

3522

<a href="../files/widget_js_WidgetUIEvents.js.html#l73"><code>widget/js/WidgetUIEvents.js:73</code></a>

3523

3524

</p>

3525

3526

3527

3528

3529

3530

</div>

3531

3532

3533

<p>Binds a delegated DOM event listener of the specified type to the

3534

Widget's outtermost DOM element to facilitate the firing of a Custom

3535

Event of the same type for the Widget instance.</p>

3536

</div>

3537

3538

3539

3540

<h4>Parameters:</h4>

3541

3542

3543

3544

3545

3546

3547

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

3548

3549

3550

3551

3552

3553

<p>String representing the name of the event</p>

3554

</div>

3555

3556

3557

</li>

3558

3559

</ul>

3560

</div>

3561

3562

3563

3564

3565

3566

</div>

3567

3568

3569

3570

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

3571

3572

3573

3574

3575

3576

3577

3578

3579

3580

</li>

3581

3582

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

3583

</div>

3584

3585

3586

3587

3588

3589

3590

3591

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

3592

3593

3594

3595

3596

3597

3598

3599

3600

3601

3602

3603

<p>Inherited from

3604

<a href="../classes/AttributeEvents.html#method__defAttrChangeFn">AttributeEvents</a>:

3605

3606

3607

3608

<a href="../files/attribute_js_AttributeEvents.js.html#l148"><code>attribute/js/AttributeEvents.js:148</code></a>

3609

3610

</p>

3611

3612

3613

3614

3615

3616

</div>

3617

3618

3619

<p>Default function for attribute change events.</p>

3620

</div>

3621

3622

3623

3624

<h4>Parameters:</h4>

3625

3626

3627

3628

3629

3630

3631

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

3632

3633

3634

3635

3636

3637

<p>The event object for attribute change events.</p>

3638

</div>

3639

3640

3641

</li>

3642

3643

</ul>

3644

</div>

3645

3646

3647

3648

3649

3650

</div>

3651

3652

3653

3654

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

3655

3656

3657

3658

3659

3660

3661

3662

3663

3664

3665

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

3666

3667

3668

3669

3670

3671

3672

3673

3674

3675

3676

3677

<p>Inherited from

3678

<a href="../classes/Widget.html#method__defaultCB">Widget</a>:

3679

3680

3681

3682

<a href="../files/widget_js_Widget.js.html#l781"><code>widget/js/Widget.js:781</code></a>

3683

3684

</p>

3685

3686

3687

3688

3689

3690

</div>

3691

3692

3693

<p>Returns the default value for the contentBox attribute. </p>

3694

3695

<p>For the Widget class, this will be the srcNode if provided, otherwise null (resulting in

3696

a new contentBox node instance being created)</p>

3697

</div>

3698

3699

3700

3701

3702

3703

3704

</div>

3705

3706

3707

3708

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

3709

3710

3711

3712

3713

3714

3715

3716

3717

3718

</li>

3719

3720

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

3721

</div>

3722

3723

3724

3725

3726

3727

3728

3729

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

3730

3731

3732

3733

3734

3735

3736

3737

3738

3739

3740

3741

<p>Inherited from

3742

<a href="../classes/Base.html#method__defDestroyFn">Base</a>:

3743

3744

3745

3746

3747

3748

</p>

3749

3750

3751

3752

3753

3754

</div>

3755

3756

3757

<p>Default destroy event handler</p>

3758

</div>

3759

3760

3761

3762

<h4>Parameters:</h4>

3763

3764

3765

3766

3767

3768

3769

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

3770

3771

3772

3773

3774

3775

<p>Event object</p>

3776

</div>

3777

3778

3779

</li>

3780

3781

</ul>

3782

</div>

3783

3784

3785

3786

3787

3788

</div>

3789

3790

3791

3792

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

3793

3794

3795

3796

3797

3798

3799

3800

3801

3802

</li>

3803

3804

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

3805

</div>

3806

3807

3808

3809

3810

3811

3812

3813

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

3814

3815

3816

3817

3818

3819

3820

3821

3822

3823

3824

3825

<p>Inherited from

3826

<a href="../classes/Base.html#method__defInitFn">Base</a>:

3827

3828

3829

3830

3831

3832

</p>

3833

3834

3835

3836

3837

3838

</div>

3839

3840

3841

<p>Default init event handler</p>

3842

</div>

3843

3844

3845

3846

<h4>Parameters:</h4>

3847

3848

3849

3850

3851

3852

3853

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

3854

3855

3856

3857

3858

3859

<p>Event object, with a cfg property which

3860

refers to the configuration object passed to the constructor.</p>

3861

</div>

3862

3863

3864

</li>

3865

3866

</ul>

3867

</div>

3868

3869

3870

3871

3872

3873

</div>

3874

3875

3876

3877

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

3878

3879

3880

3881

3882

3883

3884

3885

3886

3887

</li>

3888

3889

3890

3891

<code>parentNode</code>

3892

3893

</li>

3894

3895

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

3896

</div>

3897

3898

3899

3900

3901

3902

3903

3904

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

3905

3906

3907

3908

3909

3910

3911

3912

3913

3914

3915

3916

<p>Inherited from

3917

<a href="../classes/Widget.html#method__defRenderFn">Widget</a>:

3918

3919

3920

3921

<a href="../files/widget_js_Widget.js.html#l572"><code>widget/js/Widget.js:572</code></a>

3922

3923

</p>

3924

3925

3926

3927

3928

3929

</div>

3930

3931

3932

<p>Default render handler</p>

3933

</div>

3934

3935

3936

3937

<h4>Parameters:</h4>

3938

3939

3940

3941

3942

3943

3944

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

3945

3946

3947

3948

3949

3950

<p>The Event object</p>

3951

</div>

3952

3953

3954

</li>

3955

3956

3957

3958

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

3959

3960

3961

3962

3963

3964

3965

<p>The parent node to render to, if passed in to the <code>render</code> method</p>

3966

</div>

3967

3968

3969

</li>

3970

3971

</ul>

3972

</div>

3973

3974

3975

3976

3977

3978

</div>

3979

3980

3981

3982

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

3983

3984

3985

3986

3987

3988

3989

3990

3991

3992

3993

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

3994

3995

3996

3997

3998

3999

4000

4001

4002

4003

4004

4005

<p>Inherited from

4006

<a href="../classes/Widget.html#method__destroyBox">Widget</a>:

4007

4008

4009

4010

<a href="../files/widget_js_Widget.js.html#l478"><code>widget/js/Widget.js:478</code></a>

4011

4012

</p>

4013

4014

4015

4016

4017

4018

</div>

4019

4020

4021

<p>Removes and destroys the widgets rendered boundingBox, contentBox,

4022

and detaches bound UI events.</p>

4023

</div>

4024

4025

4026

4027

4028

4029

4030

</div>

4031

4032

4033

4034

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

4035

4036

4037

4038

4039

4040

4041

4042

4043

4044

4045

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

4046

4047

4048

4049

4050

4051

4052

4053

4054

4055

4056

4057

<p>Inherited from

4058

<a href="../classes/BaseCore.html#method__destroyHierarchy">BaseCore</a>:

4059

4060

4061

4062

<a href="../files/base_js_BaseCore.js.html#l559"><code>base/js/BaseCore.js:559</code></a>

4063

4064

</p>

4065

4066

4067

4068

4069

4070

</div>

4071

4072

4073

<p>Destroys the class hierarchy for this instance by invoking

4074

the destructor method on the prototype of each class in the hierarchy.</p>

4075

</div>

4076

4077

4078

4079

4080

4081

4082

</div>

4083

4084

4085

4086

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

4087

4088

4089

4090

4091

4092

4093

4094

4095

4096

4097

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

4098

4099

4100

4101

4102

4103

4104

4105

4106

4107

4108

4109

<p>Inherited from

4110

<a href="../classes/Widget.html#method__destroyUIEvents">Widget</a>:

4111

4112

4113

4114

<a href="../files/widget_js_WidgetUIEvents.js.html#l20"><code>widget/js/WidgetUIEvents.js:20</code></a>

4115

4116

</p>

4117

4118

4119

4120

4121

4122

</div>

4123

4124

4125

<p>Destructor logic for UI event infrastructure,

4126

invoked during Widget destruction.</p>

4127

</div>

4128

4129

4130

4131

4132

4133

4134

</div>

4135

4136

4137

4138

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

4139

4140

4141

4142

4143

4144

4145

4146

<code>allAttrs</code>

4147

4148

</li>

4149

4150

4151

4152

<code>userVals</code>

4153

4154

</li>

4155

4156

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

4157

</div>

4158

4159

4160

4161

4162

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

4163

</span>

4164

4165

4166

4167

4168

4169

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

4170

4171

4172

4173

4174

4175

4176

4177

4178

4179

4180

4181

<p>Inherited from

4182

<a href="../classes/BaseCore.html#method__filterAdHocAttrs">BaseCore</a>:

4183

4184

4185

4186

<a href="../files/base_js_BaseCore.js.html#l342"><code>base/js/BaseCore.js:342</code></a>

4187

4188

</p>

4189

4190

4191

4192

4193

4194

</div>

4195

4196

4197

4198

</div>

4199

4200

4201

4202

<h4>Parameters:</h4>

4203

4204

4205

4206

4207

4208

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

4209

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

4210

4211

4212

4213

4214

4215

<p>The set of all attribute configurations for this instance.

4216

Attributes will be removed from this set, if they belong to the filtered class, so

4217

that by the time all classes are processed, allCfgs will be empty.</p>

4218

</div>

4219

4220

4221

</li>

4222

4223

4224

4225

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

4226

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

4227

4228

4229

4230

4231

4232

<p>The config object passed in by the user, from which adhoc attrs are to be filtered.</p>

4233

</div>

4234

4235

4236

</li>

4237

4238

</ul>

4239

</div>

4240

4241

4242

4243

4244

<h4>Returns:</h4>

4245

4246

4247

4248

4249

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

4250

4251

The set of adhoc attributes passed in, in the form

4252

of an object with attribute name/configuration pairs.

4253

4254

</div>

4255

</div>

4256

4257

4258

4259

</div>

4260

4261

4262

4263

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

4264

4265

4266

4267

4268

4269

4270

4271

<code>clazz</code>

4272

4273

</li>

4274

4275

4276

4277

<code>allCfgs</code>

4278

4279

</li>

4280

4281

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

4282

</div>

4283

4284

4285

4286

4287

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

4288

</span>

4289

4290

4291

4292

4293

4294

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

4295

4296

4297

4298

4299

4300

4301

4302

4303

4304

4305

4306

<p>Inherited from

4307

<a href="../classes/BaseCore.html#method__filterAttrCfs">BaseCore</a>:

4308

4309

4310

4311

<a href="../files/base_js_BaseCore.js.html#l310"><code>base/js/BaseCore.js:310</code></a>

4312

4313

</p>

4314

4315

4316

4317

4318

4319

</div>

4320

4321

4322

<p>A helper method used when processing ATTRS across the class hierarchy during

4323

initialization. Returns a disposable object with the attributes defined for

4324

the provided class, extracted from the set of all attributes passed in.</p>

4325

</div>

4326

4327

4328

4329

<h4>Parameters:</h4>

4330

4331

4332

4333

4334

4335

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

4336

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

4337

4338

4339

4340

4341

4342

<p>The class for which the desired attributes are required.</p>

4343

</div>

4344

4345

4346

</li>

4347

4348

4349

4350

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

4351

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

4352

4353

4354

4355

4356

4357

<p>The set of all attribute configurations for this instance.

4358

Attributes will be removed from this set, if they belong to the filtered class, so

4359

that by the time all classes are processed, allCfgs will be empty.</p>

4360

</div>

4361

4362

4363

</li>

4364

4365

</ul>

4366

</div>

4367

4368

4369

4370

4371

<h4>Returns:</h4>

4372

4373

4374

4375

4376

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

4377

4378

The set of attributes belonging to the class passed in, in the form

4379

of an object with attribute name/configuration pairs.

4380

4381

</div>

4382

</div>

4383

4384

4385

4386

</div>

4387

4388

4389

4390

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

4391

4392

4393

4394

4395

4396

4397

4398

4399

4400

</li>

4401

4402

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

4403

</div>

4404

4405

4406

4407

4408

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

4409

</span>

4410

4411

4412

4413

4414

4415

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

4416

4417

4418

4419

4420

4421

4422

4423

4424

4425

4426

4427

<p>Inherited from

4428

<a href="../classes/Widget.html#method__filterUIEvent">Widget</a>:

4429

4430

4431

4432

<a href="../files/widget_js_WidgetUIEvents.js.html#l117"><code>widget/js/WidgetUIEvents.js:117</code></a>

4433

4434

</p>

4435

4436

4437

4438

4439

4440

</div>

4441

4442

4443

<p>This method is used to determine if we should fire

4444

the UI Event or not. The default implementation makes sure

4445

that for nested delegates (nested unrelated widgets), we don't

4446

fire the UI event listener more than once at each level.</p>

4447

4448

<p>For example, without the additional filter, if you have nested

4449

widgets, each widget will have a delegate listener. If you

4450

click on the inner widget, the inner delegate listener's

4451

filter will match once, but the outer will match twice

4452

(based on delegate's design) - once for the inner widget,

4453

and once for the outer.</p>

4454

</div>

4455

4456

4457

4458

<h4>Parameters:</h4>

4459

4460

4461

4462

4463

4464

4465

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

4466

4467

4468

4469

4470

4471

4472

</div>

4473

4474

4475

</li>

4476

4477

</ul>

4478

</div>

4479

4480

4481

4482

4483

<h4>Returns:</h4>

4484

4485

4486

4487

4488

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

4489

4490

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

4491

4492

</div>

4493

</div>

4494

4495

4496

4497

</div>

4498

4499

4500

4501

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

4502

4503

4504

4505

4506

4507

4508

4509

<code>attrName</code>

4510

4511

</li>

4512

4513

4514

4515

<code>subAttrName</code>

4516

4517

</li>

4518

4519

4520

4521

<code>currVal</code>

4522

4523

</li>

4524

4525

4526

4527

<code>newVal</code>

4528

4529

</li>

4530

4531

4532

4533

4534

4535

</li>

4536

4537

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

4538

</div>

4539

4540

4541

4542

4543

4544

4545

4546

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

4547

4548

4549

4550

4551

4552

4553

4554

4555

4556

4557

4558

<p>Inherited from

4559

<a href="../classes/AttributeEvents.html#method__fireAttrChange">AttributeEvents</a>:

4560

4561

4562

4563

<a href="../files/attribute_js_AttributeEvents.js.html#l94"><code>attribute/js/AttributeEvents.js:94</code></a>

4564

4565

</p>

4566

4567

4568

4569

4570

4571

</div>

4572

4573

4574

<p>Utility method to help setup the event payload and fire the attribute change event.</p>

4575

</div>

4576

4577

4578

4579

<h4>Parameters:</h4>

4580

4581

4582

4583

4584

4585

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

4586

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

4587

4588

4589

4590

4591

4592

<p>The name of the attribute</p>

4593

</div>

4594

4595

4596

</li>

4597

4598

4599

4600

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

4601

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

4602

4603

4604

4605

4606

4607

<p>The full path of the property being changed,

4608

if this is a sub-attribute value being change. Otherwise null.</p>

4609

</div>

4610

4611

4612

</li>

4613

4614

4615

4616

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

4617

4618

4619

4620

4621

4622

4623

<p>The current value of the attribute</p>

4624

</div>

4625

4626

4627

</li>

4628

4629

4630

4631

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

4632

4633

4634

4635

4636

4637

4638

<p>The new value of the attribute</p>

4639

</div>

4640

4641

4642

</li>

4643

4644

4645

4646

4647

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

4648

4649

4650

4651

4652

4653

<p>Any additional event data to mix into the attribute change event's event facade.</p>

4654

</div>

4655

4656

4657

</li>

4658

4659

</ul>

4660

</div>

4661

4662

4663

4664

4665

4666

</div>

4667

4668

4669

4670

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

4671

4672

4673

4674

4675

4676

4677

4678

4679

4680

</li>

4681

4682

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

4683

</div>

4684

4685

4686

4687

4688

4689

</span>

4690

4691

4692

4693

4694

4695

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

4696

4697

4698

4699

4700

4701

4702

4703

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

4704

4705

4706

4707

4708

4709

<p>Inherited from

4710

<a href="../classes/AttributeCore.html#method__getAttr">AttributeCore</a>:

4711

4712

4713

4714

<a href="../files/attribute_js_AttributeCore.js.html#l468"><code>attribute/js/AttributeCore.js:468</code></a>

4715

4716

</p>

4717

4718

4719

4720

4721

4722

</div>

4723

4724

4725

<p>Provides the common implementation for the public get method,

4726

allowing Attribute hosts to over-ride either method.</p>

4727

4728

<p>See <a href="#method_get">get</a> for argument details.</p>

4729

</div>

4730

4731

4732

4733

<h4>Parameters:</h4>

4734

4735

4736

4737

4738

4739

4740

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

4741

4742

4743

4744

4745

4746

<p>The name of the attribute.</p>

4747

</div>

4748

4749

4750

</li>

4751

4752

</ul>

4753

</div>

4754

4755

4756

4757

4758

<h4>Returns:</h4>

4759

4760

4761

4762

4763

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

4764

4765

The value of the attribute.

4766

4767

</div>

4768

</div>

4769

4770

4771

4772

</div>

4773

4774

4775

4776

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

4777

4778

4779

4780

4781

4782

4783

4784

4785

4786

</li>

4787

4788

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

4789

</div>

4790

4791

4792

4793

4794

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

4795

</span>

4796

4797

4798

4799

4800

4801

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

4802

4803

4804

4805

4806

4807

4808

4809

4810

4811

4812

4813

<p>Inherited from

4814

<a href="../classes/AttributeExtras.html#method__getAttrCfg">AttributeExtras</a>:

4815

4816

4817

4818

<a href="../files/attribute_js_AttributeExtras.js.html#l112"><code>attribute/js/AttributeExtras.js:112</code></a>

4819

4820

</p>

4821

4822

4823

4824

4825

4826

</div>

4827

4828

4829

<p>Returns an object with the configuration properties (and value)

4830

for the given attribute. If attrName is not provided, returns the

4831

configuration properties for all attributes.</p>

4832

</div>

4833

4834

4835

4836

<h4>Parameters:</h4>

4837

4838

4839

4840

4841

4842

4843

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

4844

4845

4846

4847

4848

4849

<p>Optional. The attribute name. If not provided, the method will return the configuration for all attributes.</p>

4850

</div>

4851

4852

4853

</li>

4854

4855

</ul>

4856

</div>

4857

4858

4859

4860

4861

<h4>Returns:</h4>

4862

4863

4864

4865

4866

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

4867

4868

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

4869

4870

</div>

4871

</div>

4872

4873

4874

4875

</div>

4876

4877

4878

4879

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

4880

4881

4882

4883

4884

4885

4886

4887

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

4888

</span>

4889

4890

4891

4892

4893

4894

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

4895

4896

4897

4898

4899

4900

4901

4902

4903

4904

4905

4906

<p>Inherited from

4907

<a href="../classes/BaseCore.html#method__getAttrCfgs">BaseCore</a>:

4908

4909

4910

4911

<a href="../files/base_js_BaseCore.js.html#l293"><code>base/js/BaseCore.js:293</code></a>

4912

4913

</p>

4914

4915

4916

4917

4918

4919

</div>

4920

4921

4922

<p>Returns an aggregated set of attribute configurations, by traversing

4923

the class hierarchy.</p>

4924

</div>

4925

4926

4927

4928

4929

4930

<h4>Returns:</h4>

4931

4932

4933

4934

4935

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

4936

4937

The hash of attribute configurations, aggregated across classes in the hierarchy

4938

This value is cached the first time the method, or _getClasses, is invoked. Subsequent invocations return

4939

the cached value.

4940

4941

</div>

4942

</div>

4943

4944

4945

4946

</div>

4947

4948

4949

4950

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

4951

4952

4953

4954

4955

4956

4957

4958

4959

4960

</li>

4961

4962

4963

4964

4965

4966

</li>

4967

4968

4969

4970

<code>initValues</code>

4971

4972

</li>

4973

4974

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

4975

</div>

4976

4977

4978

4979

4980

4981

</span>

4982

4983

4984

4985

4986

4987

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

4988

4989

4990

4991

4992

4993

4994

4995

4996

4997

4998

<p>Inherited from

4999

5000

AttributeCore

5001

</a>

5002

5003

but overwritten in

5004

5005

5006

5007

<a href="../files/attribute_js_ComplexAttribute.js.html#l58"><code>attribute/js/ComplexAttribute.js:58</code></a>

5008

5009

</p>

5010

5011

5012

5013

5014

5015

</div>

5016

5017

5018

<p>Returns the initial value of the given attribute from

5019

either the default configuration provided, or the

5020

over-ridden value if it exists in the set of initValues

5021

provided and the attribute is not read-only.</p>

5022

</div>

5023

5024

5025

5026

<h4>Parameters:</h4>

5027

5028

5029

5030

5031

5032

5033

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

5034

5035

5036

5037

5038

5039

<p>The name of the attribute</p>

5040

</div>

5041

5042

5043

</li>

5044

5045

5046

5047

5048

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

5049

5050

5051

5052

5053

5054

<p>The attribute configuration object</p>

5055

</div>

5056

5057

5058

</li>

5059

5060

5061

5062

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

5063

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

5064

5065

5066

5067

5068

5069

<p>The object with simple and complex attribute name/value pairs returned from _normAttrVals</p>

5070

</div>

5071

5072

5073

</li>

5074

5075

</ul>

5076

</div>

5077

5078

5079

5080

5081

<h4>Returns:</h4>

5082

5083

5084

5085

5086

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

5087

5088

The initial value of the attribute.

5089

5090

</div>

5091

</div>

5092

5093

5094

5095

</div>

5096

5097

5098

5099

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

5100

5101

5102

5103

5104

5105

5106

5107

<code>attrs</code>

5108

5109

</li>

5110

5111

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

5112

</div>

5113

5114

5115

5116

5117

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

5118

</span>

5119

5120

5121

5122

5123

5124

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

5125

5126

5127

5128

5129

5130

5131

5132

5133

5134

5135

5136

<p>Inherited from

5137

<a href="../classes/AttributeCore.html#method__getAttrs">AttributeCore</a>:

5138

5139

5140

5141

<a href="../files/attribute_js_AttributeCore.js.html#l677"><code>attribute/js/AttributeCore.js:677</code></a>

5142

5143

</p>

5144

5145

5146

5147

5148

5149

</div>

5150

5151

5152

<p>Implementation behind the public getAttrs method, to get multiple attribute values.</p>

5153

</div>

5154

5155

5156

5157

<h4>Parameters:</h4>

5158

5159

5160

5161

5162

5163

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

5164

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

5165

5166

5167

5168

5169

5170

<p>Optional. An array of attribute names. If omitted, all attribute values are

5171

returned. If set to true, all attributes modified from their initial values are returned.</p>

5172

</div>

5173

5174

5175

</li>

5176

5177

</ul>

5178

</div>

5179

5180

5181

5182

5183

<h4>Returns:</h4>

5184

5185

5186

5187

5188

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

5189

5190

An object with attribute name/value pairs.

5191

5192

</div>

5193

</div>

5194

5195

5196

5197

</div>

5198

5199

5200

5201

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

5202

5203

5204

5205

5206

5207

5208

5209

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

5210

</span>

5211

5212

5213

5214

5215

5216

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

5217

5218

5219

5220

5221

5222

5223

5224

5225

5226

5227

5228

<p>Inherited from

5229

<a href="../classes/BaseCore.html#method__getClasses">BaseCore</a>:

5230

5231

5232

5233

<a href="../files/base_js_BaseCore.js.html#l277"><code>base/js/BaseCore.js:277</code></a>

5234

5235

</p>

5236

5237

5238

5239

5240

5241

</div>

5242

5243

5244

<p>Returns the class hierarchy for this object, with BaseCore being the last class in the array.</p>

5245

</div>

5246

5247

5248

5249

5250

5251

<h4>Returns:</h4>

5252

5253

5254

5255

5256

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

5257

5258

An array of classes (constructor functions), making up the class hierarchy for this object.

5259

This value is cached the first time the method, or _getAttrCfgs, is invoked. Subsequent invocations return the

5260

cached value.

5261

5262

</div>

5263

</div>

5264

5265

5266

5267

</div>

5268

5269

5270

5271

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

5272

5273

5274

5275

5276

5277

5278

5279

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

5280

</span>

5281

5282

5283

5284

5285

5286

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

5287

5288

5289

5290

5291

5292

5293

5294

5295

5296

5297

5298

<p>Inherited from

5299

<a href="../classes/Widget.html#method__getHtmlParser">Widget</a>:

5300

5301

5302

5303

<a href="../files/widget_js_WidgetHTMLParser.js.html#l135"><code>widget/js/WidgetHTMLParser.js:135</code></a>

5304

5305

</p>

5306

5307

5308

5309

5310

5311

</div>

5312

5313

5314

<p>Gets the HTML<em>PARSER definition for this instance, by merging HTML</em>PARSER

5315

definitions across the class hierarchy.</p>

5316

</div>

5317

5318

5319

5320

5321

5322

<h4>Returns:</h4>

5323

5324

5325

5326

5327

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

5328

5329

HTML_PARSER definition for this instance

5330

5331

</div>

5332

</div>

5333

5334

5335

5336

</div>

5337

5338

5339

5340

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

5341

5342

5343

5344

5345

5346

5347

5348

5349

</span>

5350

5351

5352

5353

5354

5355

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

5356

5357

5358

5359

5360

5361

5362

5363

5364

5365

5366

5367

<p>Inherited from

5368

<a href="../classes/Widget.html#method__getSrcNode">Widget</a>:

5369

5370

5371

5372

<a href="../files/widget_js_WidgetHTMLParser.js.html#l75"><code>widget/js/WidgetHTMLParser.js:75</code></a>

5373

5374

</p>

5375

5376

5377

5378

5379

5380

</div>

5381

5382

5383

5384

</div>

5385

5386

5387

5388

5389

5390

<h4>Returns:</h4>

5391

5392

5393

5394

5395

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

5396

5397

The Node to apply HTML_PARSER to

5398

5399

</div>

5400

</div>

5401

5402

5403

5404

</div>

5405

5406

5407

5408

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

5409

5410

5411

5412

5413

5414

5415

5416

5417

5418

</li>

5419

5420

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

5421

</div>

5422

5423

5424

5425

5426

5427

</span>

5428

5429

5430

5431

5432

5433

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

5434

5435

5436

5437

5438

5439

5440

5441

5442

5443

5444

5445

<p>Inherited from

5446

<a href="../classes/AttributeCore.html#method__getStateVal">AttributeCore</a>:

5447

5448

5449

5450

<a href="../files/attribute_js_AttributeCore.js.html#l522"><code>attribute/js/AttributeCore.js:522</code></a>

5451

5452

</p>

5453

5454

5455

5456

5457

5458

</div>

5459

5460

5461

<p>Gets the stored value for the attribute, from either the

5462

internal state object, or the state proxy if it exits</p>

5463

</div>

5464

5465

5466

5467

<h4>Parameters:</h4>

5468

5469

5470

5471

5472

5473

5474

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

5475

5476

5477

5478

5479

5480

<p>The name of the attribute</p>

5481

</div>

5482

5483

5484

</li>

5485

5486

</ul>

5487

</div>

5488

5489

5490

5491

5492

<h4>Returns:</h4>

5493

5494

5495

5496

5497

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

5498

5499

The stored value of the attribute

5500

5501

</div>

5502

</div>

5503

5504

5505

5506

</div>

5507

5508

5509

5510

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

5511

5512

5513

5514

5515

5516

5517

5518

<code>locale</code>

5519

5520

</li>

5521

5522

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

5523

</div>

5524

5525

5526

5527

5528

5529

5530

5531

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

5532

5533

5534

5535

5536

5537

5538

5539

5540

5541

5542

5543

<p>Inherited from

5544

<a href="../classes/Widget.html#method__getStrings">Widget</a>:

5545

5546

5547

5548

<a href="../files/widget_js_WidgetLocale.js.html#l53"><code>widget/js/WidgetLocale.js:53</code></a>

5549

5550

</p>

5551

5552

5553

5554

5555

5556

</div>

5557

5558

5559

<p>Returns the strings key/value hash for a paricular locale, without locale lookup applied.</p>

5560

</div>

5561

5562

5563

5564

<h4>Parameters:</h4>

5565

5566

5567

5568

5569

5570

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

5571

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

5572

5573

5574

5575

5576

5577

5578

</div>

5579

5580

5581

</li>

5582

5583

</ul>

5584

</div>

5585

5586

5587

5588

5589

5590

</div>

5591

5592

5593

5594

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

5595

5596

5597

5598

5599

5600

5601

5602

5603

5604

5605

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

5606

5607

5608

5609

5610

5611

5612

5613

5614

5615

5616

5617

<p>Inherited from

5618

<a href="../classes/EventTarget.html#method__getType">EventTarget</a>:

5619

5620

5621

5622

<a href="../files/event-custom_js_event-target.js.html#l36"><code>event-custom/js/event-target.js:36</code></a>

5623

5624

</p>

5625

5626

5627

5628

5629

5630

</div>

5631

5632

5633

<p>If the instance has a prefix attribute and the

5634

event type is not prefixed, the instance prefix is

5635

applied to the supplied type.</p>

5636

</div>

5637

5638

5639

5640

5641

5642

5643

</div>

5644

5645

5646

5647

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

5648

5649

5650

5651

5652

5653

5654

5655

5656

5657

5658

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

5659

5660

5661

5662

5663

5664

5665

5666

5667

5668

5669

<p>Inherited from

5670

5671

Widget

5672

</a>

5673

5674

but overwritten in

5675

5676

5677

5678

<a href="../files/widget-child_js_Widget-Child.js.html#l167"><code>widget-child/js/Widget-Child.js:167</code></a>

5679

5680

</p>

5681

5682

5683

5684

5685

5686

</div>

5687

5688

5689

<p>Returns the node on which to bind delegate listeners.</p>

5690

5691

<p>Override of Widget's implementation of _getUIEventNode() to ensure that

5692

all event listeners are bound to the Widget's topmost DOM element.

5693

This ensures that the firing of each type of Widget UI event (click,

5694

mousedown, etc.) is facilitated by a single, top-level, delegated DOM

5695

event listener.</p>

5696

</div>

5697

5698

5699

5700

5701

5702

5703

</div>

5704

5705

5706

5707

5708

5709

5710

5711

5712

5713

5714

5715

5716

5717

5718

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

5719

5720

5721

5722

5723

5724

5725

5726

5727

5728

5729

5730

<p>Inherited from

5731

<a href="../classes/Widget.html#method__guid">Widget</a>:

5732

5733

5734

5735

<a href="../files/widget_js_Widget.js.html#l1129"><code>widget/js/Widget.js:1129</code></a>

5736

5737

</p>

5738

5739

5740

5741

5742

5743

</div>

5744

5745

5746

5747

</div>

5748

5749

5750

5751

5752

5753

5754

</div>

5755

5756

5757

5758

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

5759

5760

5761

5762

5763

5764

5765

5766

<code>attrs</code>

5767

5768

</li>

5769

5770

5771

5772

<code>values</code>

5773

5774

</li>

5775

5776

5777

5778

5779

5780

</li>

5781

5782

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

5783

</div>

5784

5785

5786

5787

5788

5789

5790

5791

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

5792

5793

5794

5795

5796

5797

5798

5799

5800

5801

5802

5803

<p>Inherited from

5804

<a href="../classes/AttributeCore.html#method__initAttrHost">AttributeCore</a>:

5805

5806

5807

5808

<a href="../files/attribute_js_AttributeCore.js.html#l109"><code>attribute/js/AttributeCore.js:109</code></a>

5809

5810

</p>

5811

5812

5813

5814

5815

5816

</div>

5817

5818

5819

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

5820

constructor.</p>

5821

</div>

5822

5823

5824

5825

<h4>Parameters:</h4>

5826

5827

5828

5829

5830

5831

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

5832

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

5833

5834

5835

5836

5837

5838

<p>The attributes to add during construction (passed through to <a href="#method_addAttrs">addAttrs</a>). These can also be defined on the constructor being augmented with Attribute by defining the ATTRS property on the constructor.</p>

5839

</div>

5840

5841

5842

</li>

5843

5844

5845

5846

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

5847

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

5848

5849

5850

5851

5852

5853

<p>The initial attribute values to apply (passed through to <a href="#method_addAttrs">addAttrs</a>). These are not merged/cloned. The caller is responsible for isolating user provided values if required.</p>

5854

</div>

5855

5856

5857

</li>

5858

5859

5860

5861

5862

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

5863

5864

5865

5866

5867

5868

<p>Whether or not to add attributes lazily (passed through to <a href="#method_addAttrs">addAttrs</a>).</p>

5869

</div>

5870

5871

5872

</li>

5873

5874

</ul>

5875

</div>

5876

5877

5878

5879

5880

5881

</div>

5882

5883

5884

5885

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

5886

5887

5888

5889

5890

5891

5892

5893

5894

5895

5896

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

5897

5898

5899

5900

5901

5902

5903

5904

5905

5906

5907

<p>Inherited from

5908

5909

BaseCore

5910

</a>

5911

5912

but overwritten in

5913

5914

5915

5916

5917

5918

</p>

5919

5920

5921

5922

5923

5924

</div>

5925

5926

5927

<p>Initializes Attribute</p>

5928

</div>

5929

5930

5931

5932

5933

5934

5935

</div>

5936

5937

5938

5939

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

5940

5941

5942

5943

5944

5945

5946

5947

<code>attrs</code>

5948

5949

</li>

5950

5951

5952

5953

<code>values</code>

5954

5955

</li>

5956

5957

5958

5959

5960

5961

</li>

5962

5963

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

5964

</div>

5965

5966

5967

5968

5969

5970

5971

5972

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

5973

5974

5975

5976

5977

5978

5979

5980

5981

5982

5983

5984

<p>Inherited from

5985

<a href="../classes/AttributeCore.html#method__initAttrs">AttributeCore</a>:

5986

5987

5988

5989

<a href="../files/attribute_js_AttributeCore.js.html#l862"><code>attribute/js/AttributeCore.js:862</code></a>

5990

5991

</p>

5992

5993

5994

5995

5996

5997

</div>

5998

5999

6000

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

6001

</div>

6002

6003

6004

6005

<h4>Parameters:</h4>

6006

6007

6008

6009

6010

6011

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

6012

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

6013

6014

6015

6016

6017

6018

6019

</div>

6020

6021

6022

</li>

6023

6024

6025

6026

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

6027

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

6028

6029

6030

6031

6032

6033

6034

</div>

6035

6036

6037

</li>

6038

6039

6040

6041

6042

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

6043

6044

6045

6046

6047

6048

<p>Whether or not to add attributes lazily (passed through to <a href="#method_addAttrs">addAttrs</a>).</p>

6049

</div>

6050

6051

6052

</li>

6053

6054

</ul>

6055

</div>

6056

6057

6058

6059

6060

6061

</div>

6062

6063

6064

6065

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

6066

6067

6068

6069

6070

6071

6072

6073

<code>config</code>

6074

6075

</li>

6076

6077

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

6078

</div>

6079

6080

6081

6082

6083

6084

6085

6086

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

6087

6088

6089

6090

6091

6092

6093

6094

6095

6096

6097

<p>Inherited from

6098

6099

BaseCore

6100

</a>

6101

6102

but overwritten in

6103

6104

6105

6106

6107

6108

</p>

6109

6110

6111

6112

6113

6114

</div>

6115

6116

6117

<p>Internal construction logic for Base.</p>

6118

</div>

6119

6120

6121

6122

<h4>Parameters:</h4>

6123

6124

6125

6126

6127

6128

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

6129

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

6130

6131

6132

6133

6134

6135

<p>The constructor configuration object</p>

6136

</div>

6137

6138

6139

</li>

6140

6141

</ul>

6142

</div>

6143

6144

6145

6146

6147

6148

</div>

6149

6150

6151

6152

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

6153

6154

6155

6156

6157

6158

6159

6160

<code>userVals</code>

6161

6162

</li>

6163

6164

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

6165

</div>

6166

6167

6168

6169

6170

6171

6172

6173

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

6174

6175

6176

6177

6178

6179

6180

6181

6182

6183

6184

6185

<p>Inherited from

6186

<a href="../classes/BaseCore.html#method__initHierarchy">BaseCore</a>:

6187

6188

6189

6190

<a href="../files/base_js_BaseCore.js.html#l501"><code>base/js/BaseCore.js:501</code></a>

6191

6192

</p>

6193

6194

6195

6196

6197

6198

</div>

6199

6200

6201

<p>Initializes the class hierarchy for the instance, which includes

6202

initializing attributes for each class defined in the class's

6203

static <a href="#property_BaseCore.ATTRS">ATTRS</a> property and

6204

invoking the initializer method on the prototype of each class in the hierarchy.</p>

6205

</div>

6206

6207

6208

6209

<h4>Parameters:</h4>

6210

6211

6212

6213

6214

6215

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

6216

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

6217

6218

6219

6220

6221

6222

<p>Object with configuration property name/value pairs</p>

6223

</div>

6224

6225

6226

</li>

6227

6228

</ul>

6229

</div>

6230

6231

6232

6233

6234

6235

</div>

6236

6237

6238

6239

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

6240

6241

6242

6243

6244

6245

6246

6247

6248

6249

6250

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

6251

6252

6253

6254

6255

6256

6257

6258

6259

6260

6261

6262

<p>Inherited from

6263

<a href="../classes/BaseCore.html#method__initHierarchyData">BaseCore</a>:

6264

6265

6266

6267

<a href="../files/base_js_BaseCore.js.html#l372"><code>base/js/BaseCore.js:372</code></a>

6268

6269

</p>

6270

6271

6272

6273

6274

6275

</div>

6276

6277

6278

<p>A helper method used by _getClasses and _getAttrCfgs, which determines both

6279

the array of classes and aggregate set of attribute configurations

6280

across the class hierarchy for the instance.</p>

6281

</div>

6282

6283

6284

6285

6286

6287

6288

</div>

6289

6290

6291

6292

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

6293

6294

6295

6296

6297

6298

6299

6300

6301

6302

</li>

6303

6304

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

6305

</div>

6306

6307

6308

6309

6310

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

6311

</span>

6312

6313

6314

6315

6316

6317

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

6318

6319

6320

6321

6322

6323

6324

6325

6326

6327

6328

6329

<p>Inherited from

6330

<a href="../classes/Widget.html#method__initUIEvent">Widget</a>:

6331

6332

6333

6334

<a href="../files/widget_js_WidgetUIEvents.js.html#l176"><code>widget/js/WidgetUIEvents.js:176</code></a>

6335

6336

</p>

6337

6338

6339

6340

6341

6342

</div>

6343

6344

6345

<p>Sets up infrastructure required to fire a UI event.</p>

6346

</div>

6347

6348

6349

6350

<h4>Parameters:</h4>

6351

6352

6353

6354

6355

6356

6357

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

6358

6359

6360

6361

6362

6363

<p>String representing the name of the event</p>

6364

</div>

6365

6366

6367

</li>

6368

6369

</ul>

6370

</div>

6371

6372

6373

6374

6375

<h4>Returns:</h4>

6376

6377

6378

6379

6380

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

6381

6382

6383

</div>

6384

</div>

6385

6386

6387

6388

</div>

6389

6390

6391

6392

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

6393

6394

6395

6396

6397

6398

6399

6400

6401

6402

</li>

6403

6404

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

6405

</div>

6406

6407

6408

6409

6410

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

6411

</span>

6412

6413

6414

6415

6416

6417

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

6418

6419

6420

6421

6422

6423

6424

6425

6426

6427

6428

6429

<p>Inherited from

6430

<a href="../classes/AttributeCore.html#method__isLazyAttr">AttributeCore</a>:

6431

6432

6433

6434

<a href="../files/attribute_js_AttributeCore.js.html#l299"><code>attribute/js/AttributeCore.js:299</code></a>

6435

6436

</p>

6437

6438

6439

6440

6441

6442

</div>

6443

6444

6445

<p>Checks whether or not the attribute is one which has been

6446

added lazily and still requires initialization.</p>

6447

</div>

6448

6449

6450

6451

<h4>Parameters:</h4>

6452

6453

6454

6455

6456

6457

6458

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

6459

6460

6461

6462

6463

6464

<p>The name of the attribute</p>

6465

</div>

6466

6467

6468

</li>

6469

6470

</ul>

6471

</div>

6472

6473

6474

6475

6476

<h4>Returns:</h4>

6477

6478

6479

6480

6481

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

6482

6483

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

6484

6485

</div>

6486

</div>

6487

6488

6489

6490

</div>

6491

6492

6493

6494

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

6495

6496

6497

6498

6499

6500

6501

6502

6503

6504

</li>

6505

6506

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

6507

</div>

6508

6509

6510

6511

6512

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

6513

</span>

6514

6515

6516

6517

6518

6519

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

6520

6521

6522

6523

6524

6525

6526

6527

6528

6529

6530

6531

<p>Inherited from

6532

<a href="../classes/Widget.html#method__isUIEvent">Widget</a>:

6533

6534

6535

6536

<a href="../files/widget_js_WidgetUIEvents.js.html#l143"><code>widget/js/WidgetUIEvents.js:143</code></a>

6537

6538

</p>

6539

6540

6541

6542

6543

6544

</div>

6545

6546

6547

<p>Determines if the specified event is a UI event.</p>

6548

</div>

6549

6550

6551

6552

<h4>Parameters:</h4>

6553

6554

6555

6556

6557

6558

6559

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

6560

6561

6562

6563

6564

6565

<p>String representing the name of the event</p>

6566

</div>

6567

6568

6569

</li>

6570

6571

</ul>

6572

</div>

6573

6574

6575

6576

6577

<h4>Returns:</h4>

6578

6579

6580

6581

6582

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

6583

6584

Event Returns the name of the UI Event, otherwise

6585

undefined.

6586

6587

</div>

6588

</div>

6589

6590

6591

6592

</div>

6593

6594

6595

6596

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

6597

6598

6599

6600

6601

6602

6603

6604

6605

6606

</li>

6607

6608

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

6609

</div>

6610

6611

6612

6613

6614

6615

6616

6617

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

6618

6619

6620

6621

6622

6623

6624

6625

6626

6627

6628

6629

<p>Inherited from

6630

<a href="../classes/Widget.html#method__mapInstance">Widget</a>:

6631

6632

6633

6634

<a href="../files/widget_js_Widget.js.html#l415"><code>widget/js/Widget.js:415</code></a>

6635

6636

</p>

6637

6638

6639

6640

6641

6642

</div>

6643

6644

6645

<p>Utility method used to add an entry to the boundingBox id to instance map. </p>

6646

6647

<p>This method can be used to populate the instance with lazily created boundingBox Node references.</p>

6648

</div>

6649

6650

6651

6652

<h4>Parameters:</h4>

6653

6654

6655

6656

6657

6658

6659

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

6660

6661

6662

6663

6664

6665

<p>boundingBox id</p>

6666

</div>

6667

6668

6669

</li>

6670

6671

</ul>

6672

</div>

6673

6674

6675

6676

6677

6678

</div>

6679

6680

6681

6682

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

6683

6684

6685

6686

6687

6688

6689

6690

6691

6692

</li>

6693

6694

6695

6696

6697

6698

</li>

6699

6700

6701

6702

6703

6704

</li>

6705

6706

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

6707

</div>

6708

6709

6710

6711

6712

6713

6714

6715

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

6716

6717

6718

6719

6720

6721

6722

6723

6724

6725

6726

6727

<p>Inherited from

6728

<a href="../classes/EventTarget.html#method__monitor">EventTarget</a>:

6729

6730

6731

6732

<a href="../files/event-custom_js_event-target.js.html#l602"><code>event-custom/js/event-target.js:602</code></a>

6733

6734

</p>

6735

6736

6737

6738

6739

6740

</div>

6741

6742

6743

<p>This is the entry point for the event monitoring system.

6744

You can monitor 'attach', 'detach', 'fire', and 'publish'.

6745

When configured, these events generate an event. click ->

6746

click<em>attach, click</em>detach, click_publish -- these can

6747

be subscribed to like other events to monitor the event

6748

system. Inividual published events can have monitoring

6749

turned on or off (publish can't be turned off before it

6750

it published) by setting the events 'monitor' config.</p>

6751

</div>

6752

6753

6754

6755

<h4>Parameters:</h4>

6756

6757

6758

6759

6760

6761

6762

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

6763

6764

6765

6766

6767

6768

<p>'attach', 'detach', 'fire', or 'publish'</p>

6769

</div>

6770

6771

6772

</li>

6773

6774

6775

6776

6777

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

6778

6779

6780

6781

6782

6783

<p>Name of the event being monitored</p>

6784

</div>

6785

6786

6787

</li>

6788

6789

6790

6791

6792

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

6793

6794

6795

6796

6797

6798

<p>Information about the event interaction, such as

6799

fire() args, subscription category, publish config</p>

6800

</div>

6801

6802

6803

</li>

6804

6805

</ul>

6806

</div>

6807

6808

6809

6810

6811

6812

</div>

6813

6814

6815

6816

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

6817

6818

6819

6820

6821

6822

6823

6824

<code>valueHash</code>

6825

6826

</li>

6827

6828

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

6829

</div>

6830

6831

6832

6833

6834

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

6835

</span>

6836

6837

6838

6839

6840

6841

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

6842

6843

6844

6845

6846

6847

6848

6849

6850

6851

6852

<p>Inherited from

6853

6854

AttributeCore

6855

</a>

6856

6857

but overwritten in

6858

6859

6860

6861

<a href="../files/attribute_js_ComplexAttribute.js.html#l15"><code>attribute/js/ComplexAttribute.js:15</code></a>

6862

6863

</p>

6864

6865

6866

6867

6868

6869

</div>

6870

6871

6872

<p>Utility method to split out simple attribute name/value pairs ("x")

6873

from complex attribute name/value pairs ("x.y.z"), so that complex

6874

attributes can be keyed by the top level attribute name.</p>

6875

</div>

6876

6877

6878

6879

<h4>Parameters:</h4>

6880

6881

6882

6883

6884

6885

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

6886

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

6887

6888

6889

6890

6891

6892

<p>An object with attribute name/value pairs</p>

6893

</div>

6894

6895

6896

</li>

6897

6898

</ul>

6899

</div>

6900

6901

6902

6903

6904

<h4>Returns:</h4>

6905

6906

6907

6908

6909

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

6910

6911

An object literal with 2 properties - "simple" and "complex",

6912

containing simple and complex attribute values respectively keyed

6913

by the top level attribute name, or null, if valueHash is falsey.

6914

6915

</div>

6916

</div>

6917

6918

6919

6920

</div>

6921

6922

6923

6924

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

6925

6926

6927

6928

6929

6930

6931

6932

6933

6934

</li>

6935

6936

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

6937

</div>

6938

6939

6940

6941

6942

6943

6944

6945

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

6946

6947

6948

6949

6950

6951

6952

6953

6954

6955

6956

6957

<p>Inherited from

6958

<a href="../classes/Widget.html#method__onDocFocus">Widget</a>:

6959

6960

6961

6962

<a href="../files/widget_js_Widget.js.html#l1057"><code>widget/js/Widget.js:1057</code></a>

6963

6964

</p>

6965

6966

6967

6968

6969

6970

</div>

6971

6972

6973

<p>DOM focus event handler, used to sync the state of the Widget with the DOM</p>

6974

</div>

6975

6976

6977

6978

<h4>Parameters:</h4>

6979

6980

6981

6982

6983

6984

6985

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

6986

6987

6988

6989

6990

6991

<p>The event facade for the DOM focus event</p>

6992

</div>

6993

6994

6995

</li>

6996

6997

</ul>

6998

</div>

6999

7000

7001

7002

7003

7004

</div>

7005

7006

7007

7008

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

7009

7010

7011

7012

7013

7014

7015

7016

7017

7018

</li>

7019

7020

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

7021

</div>

7022

7023

7024

7025

7026

7027

7028

7029

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

7030

7031

7032

7033

7034

7035

7036

7037

7038

7039

7040

7041

<p>Inherited from

7042

<a href="../classes/Widget.html#method__onDocMouseDown">Widget</a>:

7043

7044

7045

7046

<a href="../files/widget_js_Widget.js.html#l1044"><code>widget/js/Widget.js:1044</code></a>

7047

7048

</p>

7049

7050

7051

7052

7053

7054

</div>

7055

7056

7057

<p>"mousedown" event handler for the owner document of the

7058

widget's bounding box.</p>

7059

</div>

7060

7061

7062

7063

<h4>Parameters:</h4>

7064

7065

7066

7067

7068

7069

7070

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

7071

7072

7073

7074

7075

7076

<p>The event facade for the DOM focus event</p>

7077

</div>

7078

7079

7080

</li>

7081

7082

</ul>

7083

</div>

7084

7085

7086

7087

7088

7089

</div>

7090

7091

7092

7093

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

7094

7095

7096

7097

7098

7099

7100

7101

7102

7103

7104

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

7105

7106

7107

7108

7109

7110

7111

7112

7113

7114

7115

7116

<p>Inherited from

7117

<a href="../classes/EventTarget.html#method__parseType">EventTarget</a>:

7118

7119

7120

7121

<a href="../files/event-custom_js_event-target.js.html#l52"><code>event-custom/js/event-target.js:52</code></a>

7122

7123

</p>

7124

7125

7126

7127

7128

7129

</div>

7130

7131

7132

<p>Returns an array with the detach key (if provided),

7133

and the prefixed event name from _getType

7134

Y.on('detachcategory| menu:click', fn)</p>

7135

</div>

7136

7137

7138

7139

7140

7141

7142

</div>

7143

7144

7145

7146

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

7147

7148

7149

7150

7151

7152

7153

7154

<code>config</code>

7155

7156

</li>

7157

7158

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

7159

</div>

7160

7161

7162

7163

7164

7165

7166

7167

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

7168

7169

7170

7171

7172

7173

7174

7175

7176

7177

7178

7179

<p>Inherited from

7180

<a href="../classes/Base.html#method__preInitEventCfg">Base</a>:

7181

7182

7183

7184

7185

7186

</p>

7187

7188

7189

7190

7191

7192

</div>

7193

7194

7195

<p>Handles the special on, after and target properties which allow the user to

7196

easily configure on and after listeners as well as bubble targets during

7197

construction, prior to init.</p>

7198

</div>

7199

7200

7201

7202

<h4>Parameters:</h4>

7203

7204

7205

7206

7207

7208

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

7209

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

7210

7211

7212

7213

7214

7215

<p>The user configuration object</p>

7216

</div>

7217

7218

7219

</li>

7220

7221

</ul>

7222

</div>

7223

7224

7225

7226

7227

7228

</div>

7229

7230

7231

7232

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

7233

7234

7235

7236

7237

7238

7239

7240

<code>attrs</code>

7241

7242

</li>

7243

7244

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

7245

</div>

7246

7247

7248

7249

7250

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

7251

</span>

7252

7253

7254

7255

7256

7257

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

7258

7259

7260

7261

7262

7263

7264

7265

7266

7267

7268

7269

<p>Inherited from

7270

<a href="../classes/AttributeCore.html#method__protectAttrs">AttributeCore</a>:

7271

7272

7273

7274

<a href="../files/attribute_js_AttributeCore.js.html#l786"><code>attribute/js/AttributeCore.js:786</code></a>

7275

7276

</p>

7277

7278

7279

7280

7281

7282

</div>

7283

7284

7285

<p>Utility method to protect an attribute configuration

7286

hash, by merging the entire object and the individual

7287

attr config objects.</p>

7288

</div>

7289

7290

7291

7292

<h4>Parameters:</h4>

7293

7294

7295

7296

7297

7298

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

7299

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

7300

7301

7302

7303

7304

7305

<p>A hash of attribute to configuration object pairs.</p>

7306

</div>

7307

7308

7309

</li>

7310

7311

</ul>

7312

</div>

7313

7314

7315

7316

7317

<h4>Returns:</h4>

7318

7319

7320

7321

7322

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

7323

7324

A protected version of the attrs argument.

7325

7326

</div>

7327

</div>

7328

7329

7330

7331

</div>

7332

7333

7334

7335

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

7336

7337

7338

7339

7340

7341

7342

7343

7344

7345

7346

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

7347

7348

7349

7350

7351

7352

7353

7354

7355

7356

7357

7358

<p>Inherited from

7359

<a href="../classes/Widget.html#method__removeLoadingClassNames">Widget</a>:

7360

7361

7362

7363

<a href="../files/widget_js_Widget.js.html#l849"><code>widget/js/Widget.js:849</code></a>

7364

7365

</p>

7366

7367

7368

7369

7370

7371

</div>

7372

7373

7374

<p>Removes class names representative of the widget's loading state from

7375

the boundingBox.</p>

7376

</div>

7377

7378

7379

7380

7381

7382

7383

</div>

7384

7385

7386

7387

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

7388

7389

7390

7391

7392

7393

7394

7395

<code>parentNode</code>

7396

7397

</li>

7398

7399

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

7400

</div>

7401

7402

7403

7404

7405

7406

7407

7408

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

7409

7410

7411

7412

7413

7414

7415

7416

7417

7418

7419

7420

<p>Inherited from

7421

<a href="../classes/Widget.html#method__renderBox">Widget</a>:

7422

7423

7424

7425

<a href="../files/widget_js_Widget.js.html#l711"><code>widget/js/Widget.js:711</code></a>

7426

7427

</p>

7428

7429

7430

7431

7432

7433

</div>

7434

7435

7436

<p>Helper method to collect the boundingBox and contentBox and append to the provided parentNode, if not

7437

already a child. The owner document of the boundingBox, or the owner document of the contentBox will be used

7438

as the document into which the Widget is rendered if a parentNode is node is not provided. If both the boundingBox and

7439

the contentBox are not currently in the document, and no parentNode is provided, the widget will be rendered

7440

to the current document's body.</p>

7441

</div>

7442

7443

7444

7445

<h4>Parameters:</h4>

7446

7447

7448

7449

7450

7451

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

7452

7453

7454

7455

7456

7457

7458

<p>The parentNode to render the widget to. If not provided, and both the boundingBox and

7459

the contentBox are not currently in the document, the widget will be rendered to the current document's body.</p>

7460

</div>

7461

7462

7463

</li>

7464

7465

</ul>

7466

</div>

7467

7468

7469

7470

7471

7472

</div>

7473

7474

7475

7476

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

7477

7478

7479

7480

7481

7482

7483

7484

7485

7486

7487

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

7488

7489

7490

7491

7492

7493

7494

7495

7496

7497

7498

7499

<p>Inherited from

7500

<a href="../classes/Widget.html#method__renderBoxClassNames">Widget</a>:

7501

7502

7503

7504

<a href="../files/widget_js_Widget.js.html#l825"><code>widget/js/Widget.js:825</code></a>

7505

7506

</p>

7507

7508

7509

7510

7511

7512

</div>

7513

7514

7515

<p>Applies standard class names to the boundingBox and contentBox</p>

7516

</div>

7517

7518

7519

7520

7521

7522

7523

</div>

7524

7525

7526

7527

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

7528

7529

7530

7531

7532

7533

7534

7535

7536

7537

7538

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

7539

7540

7541

7542

7543

7544

7545

7546

7547

7548

7549

7550

<p>Inherited from

7551

<a href="../classes/Widget.html#method__renderUI">Widget</a>:

7552

7553

7554

7555

<a href="../files/widget_js_Widget.js.html#l814"><code>widget/js/Widget.js:814</code></a>

7556

7557

</p>

7558

7559

7560

7561

7562

7563

</div>

7564

7565

7566

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

7567

</div>

7568

7569

7570

7571

7572

7573

7574

</div>

7575

7576

7577

7578

7579

7580

7581

7582

7583

7584

7585

7586

7587

7588

</li>

7589

7590

7591

7592

7593

7594

</li>

7595

7596

7597

7598

7599

7600

</li>

7601

7602

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

7603

</div>

7604

7605

7606

7607

7608

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

7609

</span>

7610

7611

7612

7613

7614

7615

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

7616

7617

7618

7619

7620

7621

7622

7623

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

7624

7625

7626

7627

7628

<p>Inherited from

7629

7630

AttributeCore

7631

</a>

7632

7633

but overwritten in

7634

7635

7636

7637

<a href="../files/attribute_js_AttributeEvents.js.html#l65"><code>attribute/js/AttributeEvents.js:65</code></a>

7638

7639

</p>

7640

7641

7642

7643

7644

7645

</div>

7646

7647

7648

<p>Allows setting of readOnly/writeOnce attributes. See <a href="#method_set">set</a> for argument details.</p>

7649

</div>

7650

7651

7652

7653

<h4>Parameters:</h4>

7654

7655

7656

7657

7658

7659

7660

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

7661

7662

7663

7664

7665

7666

<p>The name of the attribute.</p>

7667

</div>

7668

7669

7670

</li>

7671

7672

7673

7674

7675

7676

7677

7678

7679

7680

7681

<p>The value to set the attribute to.</p>

7682

</div>

7683

7684

7685

</li>

7686

7687

7688

7689

7690

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

7691

7692

7693

7694

7695

7696

<p>(Optional) Optional event data to be mixed into

7697

the event facade passed to subscribers of the attribute's change event.</p>

7698

</div>

7699

7700

7701

</li>

7702

7703

</ul>

7704

</div>

7705

7706

7707

7708

7709

<h4>Returns:</h4>

7710

7711

7712

7713

7714

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

7715

7716

A reference to the host object.

7717

7718

</div>

7719

</div>

7720

7721

7722

7723

</div>

7724

7725

7726

7727

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

7728

7729

7730

7731

7732

7733

7734

7735

7736

7737

</li>

7738

7739

7740

7741

<code>value</code>

7742

7743

</li>

7744

7745

7746

7747

7748

7749

</li>

7750

7751

7752

7753

<code>force</code>

7754

7755

</li>

7756

7757

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

7758

</div>

7759

7760

7761

7762

7763

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

7764

</span>

7765

7766

7767

7768

7769

7770

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

7771

7772

7773

7774

7775

7776

7777

7778

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

7779

7780

7781

7782

7783

7784

<p>Inherited from

7785

<a href="../classes/AttributeCore.html#method__setAttr">AttributeCore</a>:

7786

7787

7788

7789

<a href="../files/attribute_js_AttributeCore.js.html#l361"><code>attribute/js/AttributeCore.js:361</code></a>

7790

7791

</p>

7792

7793

7794

7795

7796

7797

</div>

7798

7799

7800

<p>Provides the common implementation for the public set and protected _set methods.</p>

7801

7802

<p>See <a href="#method_set">set</a> for argument details.</p>

7803

</div>

7804

7805

7806

7807

<h4>Parameters:</h4>

7808

7809

7810

7811

7812

7813

7814

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

7815

7816

7817

7818

7819

7820

<p>The name of the attribute.</p>

7821

</div>

7822

7823

7824

</li>

7825

7826

7827

7828

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

7829

7830

7831

7832

7833

7834

7835

<p>The value to set the attribute to.</p>

7836

</div>

7837

7838

7839

</li>

7840

7841

7842

7843

7844

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

7845

7846

7847

7848

7849

7850

<p>(Optional) Optional event data to be mixed into

7851

the event facade passed to subscribers of the attribute's change event.

7852

This is currently a hack. There's no real need for the AttributeCore implementation

7853

to support this parameter, but breaking it out into AttributeEvents, results in

7854

additional function hops for the critical path. May change in 3.5.0 PR3.</p>

7855

</div>

7856

7857

7858

</li>

7859

7860

7861

7862

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

7863

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

7864

7865

7866

7867

7868

7869

<p>If true, allows the caller to set values for

7870

readOnly or writeOnce attributes which have already been set.</p>

7871

</div>

7872

7873

7874

</li>

7875

7876

</ul>

7877

</div>

7878

7879

7880

7881

7882

<h4>Returns:</h4>

7883

7884

7885

7886

7887

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

7888

7889

A reference to the host object.

7890

7891

</div>

7892

</div>

7893

7894

7895

7896

</div>

7897

7898

7899

7900

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

7901

7902

7903

7904

7905

7906

7907

7908

<code>attrs</code>

7909

7910

</li>

7911

7912

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

7913

</div>

7914

7915

7916

7917

7918

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

7919

</span>

7920

7921

7922

7923

7924

7925

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

7926

7927

7928

7929

7930

7931

7932

7933

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

7934

7935

7936

7937

7938

7939

<p>Inherited from

7940

<a href="../classes/AttributeCore.html#method__setAttrs">AttributeCore</a>:

7941

7942

7943

7944

<a href="../files/attribute_js_AttributeCore.js.html#l647"><code>attribute/js/AttributeCore.js:647</code></a>

7945

7946

</p>

7947

7948

7949

7950

7951

7952

</div>

7953

7954

7955

<p>Implementation behind the public setAttrs method, to set multiple attribute values.</p>

7956

</div>

7957

7958

7959

7960

<h4>Parameters:</h4>

7961

7962

7963

7964

7965

7966

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

7967

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

7968

7969

7970

7971

7972

7973

<p>An object with attributes name/value pairs.</p>

7974

</div>

7975

7976

7977

</li>

7978

7979

</ul>

7980

</div>

7981

7982

7983

7984

7985

<h4>Returns:</h4>

7986

7987

7988

7989

7990

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

7991

7992

A reference to the host object.

7993

7994

</div>

7995

</div>

7996

7997

7998

7999

</div>

8000

8001

8002

8003

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

8004

8005

8006

8007

8008

8009

8010

8011

8012

8013

</li>

8014

8015

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

8016

</div>

8017

8018

8019

8020

8021

8022

8023

8024

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

8025

8026

8027

8028

8029

8030

8031

8032

8033

8034

8035

8036

<p>Inherited from

8037

<a href="../classes/Widget.html#method__setAttrUI">Widget</a>:

8038

8039

8040

8041

<a href="../files/widget_js_Widget.js.html#l1177"><code>widget/js/Widget.js:1177</code></a>

8042

8043

</p>

8044

8045

8046

8047

8048

8049

</div>

8050

8051

8052

8053

</div>

8054

8055

8056

8057

<h4>Parameters:</h4>

8058

8059

8060

8061

8062

8063

8064

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

8065

8066

8067

8068

8069

8070

8071

</div>

8072

8073

8074

</li>

8075

8076

</ul>

8077

</div>

8078

8079

8080

8081

8082

8083

</div>

8084

8085

8086

8087

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

8088

8089

8090

8091

8092

8093

8094

8095

<code>attrName</code>

8096

8097

</li>

8098

8099

8100

8101

<code>subAttrName</code>

8102

8103

</li>

8104

8105

8106

8107

<code>prevVal</code>

8108

8109

</li>

8110

8111

8112

8113

<code>newVal</code>

8114

8115

</li>

8116

8117

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

8118

</div>

8119

8120

8121

8122

8123

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

8124

</span>

8125

8126

8127

8128

8129

8130

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

8131

8132

8133

8134

8135

8136

8137

8138

8139

8140

8141

8142

<p>Inherited from

8143

<a href="../classes/AttributeCore.html#method__setAttrVal">AttributeCore</a>:

8144

8145

8146

8147

<a href="../files/attribute_js_AttributeCore.js.html#l554"><code>attribute/js/AttributeCore.js:554</code></a>

8148

8149

</p>

8150

8151

8152

8153

8154

8155

</div>

8156

8157

8158

<p>Updates the stored value of the attribute in the privately held State object,

8159

if validation and setter passes.</p>

8160

</div>

8161

8162

8163

8164

<h4>Parameters:</h4>

8165

8166

8167

8168

8169

8170

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

8171

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

8172

8173

8174

8175

8176

8177

<p>The attribute name.</p>

8178

</div>

8179

8180

8181

</li>

8182

8183

8184

8185

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

8186

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

8187

8188

8189

8190

8191

8192

<p>The sub-attribute name, if setting a sub-attribute property ("x.y.z").</p>

8193

</div>

8194

8195

8196

</li>

8197

8198

8199

8200

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

8201

8202

8203

8204

8205

8206

8207

<p>The currently stored value of the attribute.</p>

8208

</div>

8209

8210

8211

</li>

8212

8213

8214

8215

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

8216

8217

8218

8219

8220

8221

8222

<p>The value which is going to be stored.</p>

8223

</div>

8224

8225

8226

</li>

8227

8228

</ul>

8229

</div>

8230

8231

8232

8233

8234

<h4>Returns:</h4>

8235

8236

8237

8238

8239

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

8240

8241

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

8242

8243

</div>

8244

</div>

8245

8246

8247

8248

</div>

8249

8250

8251

8252

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

8253

8254

8255

8256

8257

8258

8259

8260

<code>Node/String</code>

8261

8262

</li>

8263

8264

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

8265

</div>

8266

8267

8268

8269

8270

8271

</span>

8272

8273

8274

8275

8276

8277

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

8278

8279

8280

8281

8282

8283

8284

8285

8286

8287

8288

8289

<p>Inherited from

8290

<a href="../classes/Widget.html#method__setBB">Widget</a>:

8291

8292

8293

8294

<a href="../files/widget_js_Widget.js.html#l757"><code>widget/js/Widget.js:757</code></a>

8295

8296

</p>

8297

8298

8299

8300

8301

8302

</div>

8303

8304

8305

<p>Setter for the boundingBox attribute</p>

8306

</div>

8307

8308

8309

8310

<h4>Parameters:</h4>

8311

8312

8313

8314

8315

8316

<code class="param-name">Node/String</code>

8317

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

8318

8319

8320

8321

8322

8323

8324

</div>

8325

8326

8327

</li>

8328

8329

</ul>

8330

</div>

8331

8332

8333

8334

8335

<h4>Returns:</h4>

8336

8337

8338

8339

8340

Node

8341

8342

</div>

8343

</div>

8344

8345

8346

8347

</div>

8348

8349

8350

8351

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

8352

8353

8354

8355

8356

8357

8358

8359

8360

8361

</li>

8362

8363

8364

8365

8366

8367

</li>

8368

8369

8370

8371

<code>template</code>

8372

8373

</li>

8374

8375

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

8376

</div>

8377

8378

8379

8380

8381

8382

</span>

8383

8384

8385

8386

8387

8388

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

8389

8390

8391

8392

8393

8394

8395

8396

8397

8398

8399

8400

<p>Inherited from

8401

<a href="../classes/Widget.html#method__setBox">Widget</a>:

8402

8403

8404

8405

<a href="../files/widget_js_Widget.js.html#l794"><code>widget/js/Widget.js:794</code></a>

8406

8407

</p>

8408

8409

8410

8411

8412

8413

</div>

8414

8415

8416

<p>Helper method to set the bounding/content box, or create it from

8417

the provided template if not found.</p>

8418

</div>

8419

8420

8421

8422

<h4>Parameters:</h4>

8423

8424

8425

8426

8427

8428

8429

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

8430

8431

8432

8433

8434

8435

<p>The node's id attribute</p>

8436

</div>

8437

8438

8439

</li>

8440

8441

8442

8443

8444

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

8445

8446

8447

8448

8449

8450

<p>The node reference</p>

8451

</div>

8452

8453

8454

</li>

8455

8456

8457

8458

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

8459

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

8460

8461

8462

8463

8464

8465

<p>HTML string template for the node</p>

8466

</div>

8467

8468

8469

</li>

8470

8471

</ul>

8472

</div>

8473

8474

8475

8476

8477

<h4>Returns:</h4>

8478

8479

8480

8481

8482

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

8483

8484

The node

8485

8486

</div>

8487

</div>

8488

8489

8490

8491

</div>

8492

8493

8494

8495

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

8496

8497

8498

8499

8500

8501

8502

8503

8504

8505

</li>

8506

8507

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

8508

</div>

8509

8510

8511

8512

8513

8514

</span>

8515

8516

8517

8518

8519

8520

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

8521

8522

8523

8524

8525

8526

8527

8528

8529

8530

8531

8532

<p>Inherited from

8533

<a href="../classes/Widget.html#method__setCB">Widget</a>:

8534

8535

8536

8537

<a href="../files/widget_js_Widget.js.html#l769"><code>widget/js/Widget.js:769</code></a>

8538

8539

</p>

8540

8541

8542

8543

8544

8545

</div>

8546

8547

8548

<p>Setter for the contentBox attribute</p>

8549

</div>

8550

8551

8552

8553

<h4>Parameters:</h4>

8554

8555

8556

8557

8558

8559

8560

8561

8562

8563

8564

8565

8566

8567

</div>

8568

8569

8570

</li>

8571

8572

</ul>

8573

</div>

8574

8575

8576

8577

8578

<h4>Returns:</h4>

8579

8580

8581

8582

8583

Node

8584

8585

</div>

8586

</div>

8587

8588

8589

8590

</div>

8591

8592

8593

8594

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

8595

8596

8597

8598

8599

8600

8601

8602

8603

8604

</li>

8605

8606

8607

8608

<code>value</code>

8609

8610

</li>

8611

8612

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

8613

</div>

8614

8615

8616

8617

8618

8619

8620

8621

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

8622

8623

8624

8625

8626

8627

8628

8629

8630

8631

8632

8633

<p>Inherited from

8634

<a href="../classes/AttributeCore.html#method__setStateVal">AttributeCore</a>:

8635

8636

8637

8638

<a href="../files/attribute_js_AttributeCore.js.html#l536"><code>attribute/js/AttributeCore.js:536</code></a>

8639

8640

</p>

8641

8642

8643

8644

8645

8646

</div>

8647

8648

8649

<p>Sets the stored value for the attribute, in either the

8650

internal state object, or the state proxy if it exits</p>

8651

</div>

8652

8653

8654

8655

<h4>Parameters:</h4>

8656

8657

8658

8659

8660

8661

8662

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

8663

8664

8665

8666

8667

8668

<p>The name of the attribute</p>

8669

</div>

8670

8671

8672

</li>

8673

8674

8675

8676

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

8677

8678

8679

8680

8681

8682

8683

<p>The value of the attribute</p>

8684

</div>

8685

8686

8687

</li>

8688

8689

</ul>

8690

</div>

8691

8692

8693

8694

8695

8696

</div>

8697

8698

8699

8700

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

8701

8702

8703

8704

8705

8706

8707

8708

<code>strings</code>

8709

8710

</li>

8711

8712

8713

8714

<code>locale</code>

8715

8716

</li>

8717

8718

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

8719

</div>

8720

8721

8722

8723

8724

8725

8726

8727

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

8728

8729

8730

8731

8732

8733

8734

8735

8736

8737

8738

8739

<p>Inherited from

8740

<a href="../classes/Widget.html#method__setStrings">Widget</a>:

8741

8742

8743

8744

<a href="../files/widget_js_WidgetLocale.js.html#l32"><code>widget/js/WidgetLocale.js:32</code></a>

8745

8746

</p>

8747

8748

8749

8750

8751

8752

</div>

8753

8754

8755

<p>Sets strings for a particular locale, merging with any existing

8756

strings which may already be defined for the locale.</p>

8757

</div>

8758

8759

8760

8761

<h4>Parameters:</h4>

8762

8763

8764

8765

8766

8767

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

8768

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

8769

8770

8771

8772

8773

8774

<p>The hash of string key/values to set</p>

8775

</div>

8776

8777

8778

</li>

8779

8780

8781

8782

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

8783

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

8784

8785

8786

8787

8788

8789

<p>The locale for the string values being set</p>

8790

</div>

8791

8792

8793

</li>

8794

8795

</ul>

8796

</div>

8797

8798

8799

8800

8801

8802

</div>

8803

8804

8805

8806

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

8807

8808

8809

8810

8811

8812

8813

8814

<code>strings</code>

8815

8816

</li>

8817

8818

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

8819

</div>

8820

8821

8822

8823

8824

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

8825

</span>

8826

8827

8828

8829

8830

8831

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

8832

8833

8834

8835

8836

8837

8838

8839

8840

8841

8842

8843

<p>Inherited from

8844

<a href="../classes/Widget.html#method__strSetter">Widget</a>:

8845

8846

8847

8848

<a href="../files/widget_js_Widget.js.html#l1188"><code>widget/js/Widget.js:1188</code></a>

8849

8850

</p>

8851

8852

8853

8854

8855

8856

</div>

8857

8858

8859

<p>The default setter for the strings attribute. Merges partial sets

8860

into the full string set, to allow users to partial sets of strings</p>

8861

</div>

8862

8863

8864

8865

<h4>Parameters:</h4>

8866

8867

8868

8869

8870

8871

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

8872

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

8873

8874

8875

8876

8877

8878

8879

</div>

8880

8881

8882

</li>

8883

8884

</ul>

8885

</div>

8886

8887

8888

8889

8890

<h4>Returns:</h4>

8891

8892

8893

8894

8895

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

8896

8897

The full set of strings to set

8898

8899

</div>

8900

</div>

8901

8902

8903

8904

</div>

8905

8906

8907

8908

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

8909

8910

8911

8912

8913

8914

8915

8916

<code>attrs</code>

8917

8918

</li>

8919

8920

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

8921

</div>

8922

8923

8924

8925

8926

8927

8928

8929

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

8930

8931

8932

8933

8934

8935

8936

8937

8938

8939

8940

8941

<p>Inherited from

8942

<a href="../classes/Widget.html#method__syncAttrUI">Widget</a>:

8943

8944

8945

8946

<a href="../files/widget_js_Widget.js.html#l1162"><code>widget/js/Widget.js:1162</code></a>

8947

8948

</p>

8949

8950

8951

8952

8953

8954

</div>

8955

8956

8957

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

8958

</div>

8959

8960

8961

8962

<h4>Parameters:</h4>

8963

8964

8965

8966

8967

8968

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

8969

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

8970

8971

8972

8973

8974

8975

8976

</div>

8977

8978

8979

</li>

8980

8981

</ul>

8982

</div>

8983

8984

8985

8986

8987

8988

</div>

8989

8990

8991

8992

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

8993

8994

8995

8996

8997

8998

8999

9000

9001

9002

9003

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

9004

9005

9006

9007

9008

9009

9010

9011

9012

9013

9014

9015

<p>Inherited from

9016

<a href="../classes/Widget.html#method__syncUI">Widget</a>:

9017

9018

9019

9020

<a href="../files/widget_js_Widget.js.html#l940"><code>widget/js/Widget.js:940</code></a>

9021

9022

</p>

9023

9024

9025

9026

9027

9028

</div>

9029

9030

9031

<p>Updates the widget UI to reflect the attribute state.</p>

9032

</div>

9033

9034

9035

9036

9037

9038

9039

</div>

9040

9041

9042

9043

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

9044

9045

9046

9047

9048

9049

9050

9051

9052

9053

9054

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

9055

9056

9057

9058

9059

9060

9061

9062

9063

9064

9065

9066

<p>Inherited from

9067

<a href="../classes/Widget.html#method__syncUIChild">Widget</a>:

9068

9069

9070

9071

<a href="../files/widget-child_js_Widget-Child.js.html#l341"><code>widget-child/js/Widget-Child.js:341</code></a>

9072

9073

</p>

9074

9075

9076

9077

9078

9079

</div>

9080

9081

9082

<p>Synchronizes the UI to match the WidgetChild state.</p>

9083

9084

<p>

9085

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

9086

using YUI's aop infrastructure.

9087

</p>

9088

</div>

9089

9090

9091

9092

9093

9094

9095

</div>

9096

9097

9098

9099

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

9100

9101

9102

9103

9104

9105

9106

9107

<code>selected</code>

9108

9109

</li>

9110

9111

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

9112

</div>

9113

9114

9115

9116

9117

9118

9119

9120

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

9121

9122

9123

9124

9125

9126

9127

9128

9129

9130

9131

9132

<p>Inherited from

9133

<a href="../classes/Widget.html#method__uiSetChildSelected">Widget</a>:

9134

9135

9136

9137

<a href="../files/widget-child_js_Widget-Child.js.html#l305"><code>widget-child/js/Widget-Child.js:305</code></a>

9138

9139

</p>

9140

9141

9142

9143

9144

9145

</div>

9146

9147

9148

<p>Updates the UI to reflect the <code>selected</code> attribute value.</p>

9149

</div>

9150

9151

9152

9153

<h4>Parameters:</h4>

9154

9155

9156

9157

9158

9159

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

9160

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

9161

9162

9163

9164

9165

9166

<p>The selected value to be reflected in the UI.</p>

9167

</div>

9168

9169

9170

</li>

9171

9172

</ul>

9173

</div>

9174

9175

9176

9177

9178

9179

</div>

9180

9181

9182

9183

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

9184

9185

9186

9187

9188

9189

9190

9191

9192

9193

</li>

9194

9195

9196

9197

9198

9199

</li>

9200

9201

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

9202

</div>

9203

9204

9205

9206

9207

9208

9209

9210

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

9211

9212

9213

9214

9215

9216

9217

9218

9219

9220

9221

9222

<p>Inherited from

9223

<a href="../classes/Widget.html#method__uiSetDim">Widget</a>:

9224

9225

9226

9227

<a href="../files/widget_js_Widget.js.html#l973"><code>widget/js/Widget.js:973</code></a>

9228

9229

</p>

9230

9231

9232

9233

9234

9235

</div>

9236

9237

9238

9239

</div>

9240

9241

9242

9243

<h4>Parameters:</h4>

9244

9245

9246

9247

9248

9249

9250

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

9251

9252

9253

9254

9255

9256

<p>The dimension - "width" or "height"</p>

9257

</div>

9258

9259

9260

</li>

9261

9262

9263

9264

9265

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

9266

9267

9268

9269

9270

9271

<p>The value to set</p>

9272

</div>

9273

9274

9275

</li>

9276

9277

</ul>

9278

</div>

9279

9280

9281

9282

9283

9284

</div>

9285

9286

9287

9288

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

9289

9290

9291

9292

9293

9294

9295

9296

9297

9298

</li>

9299

9300

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

9301

</div>

9302

9303

9304

9305

9306

9307

9308

9309

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

9310

9311

9312

9313

9314

9315

9316

9317

9318

9319

9320

9321

<p>Inherited from

9322

<a href="../classes/Widget.html#method__uiSetDisabled">Widget</a>:

9323

9324

9325

9326

<a href="../files/widget_js_Widget.js.html#l994"><code>widget/js/Widget.js:994</code></a>

9327

9328

</p>

9329

9330

9331

9332

9333

9334

</div>

9335

9336

9337

<p>Sets the disabled state for the UI</p>

9338

</div>

9339

9340

9341

9342

<h4>Parameters:</h4>

9343

9344

9345

9346

9347

9348

9349

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

9350

9351

9352

9353

9354

9355

9356

</div>

9357

9358

9359

</li>

9360

9361

</ul>

9362

</div>

9363

9364

9365

9366

9367

9368

</div>

9369

9370

9371

9372

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

9373

9374

9375

9376

9377

9378

9379

9380

9381

9382

</li>

9383

9384

9385

9386

9387

9388

</li>

9389

9390

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

9391

</div>

9392

9393

9394

9395

9396

9397

9398

9399

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

9400

9401

9402

9403

9404

9405

9406

9407

9408

9409

9410

9411

<p>Inherited from

9412

<a href="../classes/Widget.html#method__uiSetFocused">Widget</a>:

9413

9414

9415

9416

<a href="../files/widget_js_Widget.js.html#l1005"><code>widget/js/Widget.js:1005</code></a>

9417

9418

</p>

9419

9420

9421

9422

9423

9424

</div>

9425

9426

9427

<p>Sets the focused state for the UI</p>

9428

</div>

9429

9430

9431

9432

<h4>Parameters:</h4>

9433

9434

9435

9436

9437

9438

9439

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

9440

9441

9442

9443

9444

9445

9446

</div>

9447

9448

9449

</li>

9450

9451

9452

9453

9454

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

9455

9456

9457

9458

9459

9460

<p>String representing the source that triggered an update to

9461

the UI.</p>

9462

</div>

9463

9464

9465

</li>

9466

9467

</ul>

9468

</div>

9469

9470

9471

9472

9473

9474

</div>

9475

9476

9477

9478

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

9479

9480

9481

9482

9483

9484

9485

9486

9487

9488

</li>

9489

9490

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

9491

</div>

9492

9493

9494

9495

9496

9497

9498

9499

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

9500

9501

9502

9503

9504

9505

9506

9507

9508

9509

9510

9511

<p>Inherited from

9512

<a href="../classes/Widget.html#method__uiSetHeight">Widget</a>:

9513

9514

9515

9516

<a href="../files/widget_js_Widget.js.html#l950"><code>widget/js/Widget.js:950</code></a>

9517

9518

</p>

9519

9520

9521

9522

9523

9524

</div>

9525

9526

9527

<p>Sets the height on the widget's bounding box element</p>

9528

</div>

9529

9530

9531

9532

<h4>Parameters:</h4>

9533

9534

9535

9536

9537

9538

9539

<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/Number" class="crosslink external" target="_blank">Number</a></span>

9540

9541

9542

9543

9544

9545

9546

</div>

9547

9548

9549

</li>

9550

9551

</ul>

9552

</div>

9553

9554

9555

9556

9557

9558

</div>

9559

9560

9561

9562

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

9563

9564

9565

9566

9567

9568

9569

9570

<code>Number</code>

9571

9572

</li>

9573

9574

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

9575

</div>

9576

9577

9578

9579

9580

9581

9582

9583

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

9584

9585

9586

9587

9588

9589

9590

9591

9592

9593

9594

9595

<p>Inherited from

9596

<a href="../classes/Widget.html#method__uiSetTabIndex">Widget</a>:

9597

9598

9599

9600

<a href="../files/widget_js_Widget.js.html#l1027"><code>widget/js/Widget.js:1027</code></a>

9601

9602

</p>

9603

9604

9605

9606

9607

9608

</div>

9609

9610

9611

<p>Set the tabIndex on the widget's rendered UI</p>

9612

</div>

9613

9614

9615

9616

<h4>Parameters:</h4>

9617

9618

9619

9620

9621

9622

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

9623

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

9624

9625

9626

9627

9628

9629

9630

</div>

9631

9632

9633

</li>

9634

9635

</ul>

9636

</div>

9637

9638

9639

9640

9641

9642

</div>

9643

9644

9645

9646

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

9647

9648

9649

9650

9651

9652

9653

9654

9655

9656

</li>

9657

9658

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

9659

</div>

9660

9661

9662

9663

9664

9665

9666

9667

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

9668

9669

9670

9671

9672

9673

9674

9675

9676

9677

9678

9679

<p>Inherited from

9680

<a href="../classes/Widget.html#method__uiSetVisible">Widget</a>:

9681

9682

9683

9684

<a href="../files/widget_js_Widget.js.html#l983"><code>widget/js/Widget.js:983</code></a>

9685

9686

</p>

9687

9688

9689

9690

9691

9692

</div>

9693

9694

9695

<p>Sets the visible state for the UI</p>

9696

</div>

9697

9698

9699

9700

<h4>Parameters:</h4>

9701

9702

9703

9704

9705

9706

9707

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

9708

9709

9710

9711

9712

9713

9714

</div>

9715

9716

9717

</li>

9718

9719

</ul>

9720

</div>

9721

9722

9723

9724

9725

9726

</div>

9727

9728

9729

9730

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

9731

9732

9733

9734

9735

9736

9737

9738

9739

9740

</li>

9741

9742

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

9743

</div>

9744

9745

9746

9747

9748

9749

9750

9751

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

9752

9753

9754

9755

9756

9757

9758

9759

9760

9761

9762

9763

<p>Inherited from

9764

<a href="../classes/Widget.html#method__uiSetWidth">Widget</a>:

9765

9766

9767

9768

<a href="../files/widget_js_Widget.js.html#l962"><code>widget/js/Widget.js:962</code></a>

9769

9770

</p>

9771

9772

9773

9774

9775

9776

</div>

9777

9778

9779

<p>Sets the width on the widget's bounding box element</p>

9780

</div>

9781

9782

9783

9784

<h4>Parameters:</h4>

9785

9786

9787

9788

9789

9790

9791

9792

9793

9794

9795

9796

9797

9798

</div>

9799

9800

9801

</li>

9802

9803

</ul>

9804

</div>

9805

9806

9807

9808

9809

9810

</div>

9811

9812

9813

9814

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

9815

9816

9817

9818

9819

9820

9821

9822

<code>expand</code>

9823

9824

</li>

9825

9826

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

9827

</div>

9828

9829

9830

9831

9832

9833

9834

9835

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

9836

9837

9838

9839

9840

9841

9842

9843

9844

9845

9846

9847

<p>Inherited from

9848

<a href="../classes/Widget.html#method__uiSizeCB">Widget</a>:

9849

9850

9851

9852

<a href="../files/widget_js_Widget.js.html#l702"><code>widget/js/Widget.js:702</code></a>

9853

9854

</p>

9855

9856

9857

9858

9859

9860

</div>

9861

9862

9863

9864

</div>

9865

9866

9867

9868

<h4>Parameters:</h4>

9869

9870

9871

9872

9873

9874

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

9875

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

9876

9877

9878

9879

9880

9881

9882

</div>

9883

9884

9885

</li>

9886

9887

</ul>

9888

</div>

9889

9890

9891

9892

9893

9894

</div>

9895

9896

9897

9898

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

9899

9900

9901

9902

9903

9904

9905

9906

9907

9908

9909

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

9910

9911

9912

9913

9914

9915

9916

9917

9918

9919

9920

9921

<p>Inherited from

9922

<a href="../classes/Widget.html#method__unbindDOM">Widget</a>:

9923

9924

9925

9926

<a href="../files/widget_js_Widget.js.html#l917"><code>widget/js/Widget.js:917</code></a>

9927

9928

</p>

9929

9930

9931

9932

9933

9934

</div>

9935

9936

9937

9938

</div>

9939

9940

9941

9942

9943

9944

9945

</div>

9946

9947

9948

9949

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

9950

9951

9952

9953

9954

9955

9956

9957

9958

9959

9960

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

9961

9962

9963

9964

9965

9966

9967

9968

9969

9970

9971

9972

<p>Inherited from

9973

<a href="../classes/Widget.html#method__unbindUI">Widget</a>:

9974

9975

9976

9977

<a href="../files/widget_js_Widget.js.html#l881"><code>widget/js/Widget.js:881</code></a>

9978

9979

</p>

9980

9981

9982

9983

9984

9985

</div>

9986

9987

9988

9989

</div>

9990

9991

9992

9993

9994

9995

9996

</div>

9997

9998

9999

10000

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

10001

10002

10003

10004

10005

10006

10007

10008

<code>tabIndex</code>

10009

10010

</li>

10011

10012

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

10013

</div>

10014

10015

10016

10017

10018

10019

10020

10021

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

10022

10023

10024

10025

10026

10027

10028

10029

10030

10031

10032

10033

<p>Inherited from

10034

<a href="../classes/Widget.html#method__validTabIndex">Widget</a>:

10035

10036

10037

10038

<a href="../files/widget_js_Widget.js.html#l1137"><code>widget/js/Widget.js:1137</code></a>

10039

10040

</p>

10041

10042

10043

10044

10045

10046

</div>

10047

10048

10049

10050

</div>

10051

10052

10053

10054

<h4>Parameters:</h4>

10055

10056

10057

10058

10059

10060

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

10061

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

10062

10063

10064

10065

10066

10067

10068

</div>

10069

10070

10071

</li>

10072

10073

</ul>

10074

</div>

10075

10076

10077

10078

10079

10080

</div>

10081

10082

10083

10084

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

10085

10086

10087

10088

10089

10090

10091

10092

10093

10094

</li>

10095

10096

10097

10098

<code>config</code>

10099

10100

</li>

10101

10102

10103

10104

10105

10106

</li>

10107

10108

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

10109

</div>

10110

10111

10112

10113

10114

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

10115

</span>

10116

10117

10118

10119

10120

10121

10122

10123

10124

10125

10126

10127

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

10128

10129

10130

10131

10132

10133

<p>Inherited from

10134

<a href="../classes/AttributeCore.html#method_addAttr">AttributeCore</a>:

10135

10136

10137

10138

<a href="../files/attribute_js_AttributeCore.js.html#l124"><code>attribute/js/AttributeCore.js:124</code></a>

10139

10140

</p>

10141

10142

10143

10144

10145

10146

</div>

10147

10148

10149

<p>

10150

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

10151

</p>

10152

10153

<p>

10154

The config argument object supports the following properties:

10155

</p>

10156

10157

<dl>

10158

<dt>value <Any></dt>

10159

<dd>The initial value to set on the attribute</dd>

10160

10161

<dt>valueFn <Function | String></dt>

10162

<dd>

10163

<p>A function, which will return the initial value to set on the attribute. This is useful

10164

for cases where the attribute configuration is defined statically, but needs to

10165

reference the host instance ("this") to obtain an initial value. If both the value and valueFn properties are defined,

10166

the value returned by the valueFn has precedence over the value property, unless it returns undefined, in which

10167

case the value property is used.</p>

10168

10169

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

10170

</dd>

10171

10172

<dt>readOnly <boolean></dt>

10173

<dd>Whether or not the attribute is read only. Attributes having readOnly set to true

10174

cannot be modified by invoking the set method.</dd>

10175

10176

<dt>writeOnce <boolean> or <string></dt>

10177

<dd>

10178

Whether or not the attribute is "write once". Attributes having writeOnce set to true,

10179

can only have their values set once, be it through the default configuration,

10180

constructor configuration arguments, or by invoking set.

10181

<p>The writeOnce attribute can also be set to the string "initOnly", in which case the attribute can only be set during initialization

10182

(when used with Base, this means it can only be set during construction)</p>

10183

</dd>

10184

10185

<dt>setter <Function | String></dt>

10186

<dd>

10187

<p>The setter function used to massage or normalize the value passed to the set method for the attribute.

10188

The value returned by the setter will be the final stored value. Returning

10189

<a href="#property_Attribute.INVALID_VALUE">Attribute.INVALID_VALUE</a>, from the setter will prevent

10190

the value from being stored.

10191

</p>

10192

10193

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

10194

</dd>

10195

10196

<dt>getter <Function | String></dt>

10197

<dd>

10198

<p>

10199

The getter function used to massage or normalize the value returned by the get method for the attribute.

10200

The value returned by the getter function is the value which will be returned to the user when they

10201

invoke get.

10202

</p>

10203

10204

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

10205

</dd>

10206

10207

<dt>validator <Function | String></dt>

10208

<dd>

10209

<p>

10210

The validator function invoked prior to setting the stored value. Returning

10211

false from the validator function will prevent the value from being stored.

10212

</p>

10213

10214

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

10215

</dd>

10216

10217

<dt>lazyAdd <boolean></dt>

10218

<dd>Whether or not to delay initialization of the attribute until the first call to get/set it.

10219

This flag can be used to over-ride lazy initialization on a per attribute basis, when adding multiple attributes through

10220

the <a href="#method_addAttrs">addAttrs</a> method.</dd>

10221

10222

</dl>

10223

10224

<p>The setter, getter and validator are invoked with the value and name passed in as the first and second arguments, and with

10225

the context ("this") set to the host object.</p>

10226

10227

<p>Configuration properties outside of the list mentioned above are considered private properties used internally by attribute,

10228

and are not intended for public use.</p>

10229

</div>

10230

10231

10232

10233

<h4>Parameters:</h4>

10234

10235

10236

10237

10238

10239

10240

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

10241

10242

10243

10244

10245

10246

<p>The name of the attribute.</p>

10247

</div>

10248

10249

10250

</li>

10251

10252

10253

10254

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

10255

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

10256

10257

10258

10259

10260

10261

<p>An object with attribute configuration property/value pairs, specifying the configuration for the attribute.</p>

10262

10263

<p>

10264

<strong>NOTE:</strong> The configuration object is modified when adding an attribute, so if you need

10265

to protect the original values, you will need to merge the object.

10266

</p>

10267

</div>

10268

10269

10270

</li>

10271

10272

10273

10274

10275

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

10276

10277

10278

10279

10280

10281

<p>(optional) Whether or not to add this attribute lazily (on the first call to get/set).</p>

10282

</div>

10283

10284

10285

</li>

10286

10287

</ul>

10288

</div>

10289

10290

10291

10292

10293

<h4>Returns:</h4>

10294

10295

10296

10297

10298

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

10299

10300

A reference to the host object.

10301

10302

</div>

10303

</div>

10304

10305

10306

10307

</div>

10308

10309

10310

10311

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

10312

10313

10314

10315

10316

10317

10318

10319

10320

10321

</li>

10322

10323

10324

10325

<code>values</code>

10326

10327

</li>

10328

10329

10330

10331

10332

10333

</li>

10334

10335

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

10336

</div>

10337

10338

10339

10340

10341

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

10342

</span>

10343

10344

10345

10346

10347

10348

10349

10350

10351

10352

10353

10354

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

10355

10356

10357

10358

10359

10360

<p>Inherited from

10361

<a href="../classes/AttributeCore.html#method_addAttrs">AttributeCore</a>:

10362

10363

10364

10365

<a href="../files/attribute_js_AttributeCore.js.html#l708"><code>attribute/js/AttributeCore.js:708</code></a>

10366

10367

</p>

10368

10369

10370

10371

10372

10373

</div>

10374

10375

10376

<p>Configures a group of attributes, and sets initial values.</p>

10377

10378

<p>

10379

<strong>NOTE:</strong> This method does not isolate the configuration object by merging/cloning.

10380

The caller is responsible for merging/cloning the configuration object if required.

10381

</p>

10382

</div>

10383

10384

10385

10386

<h4>Parameters:</h4>

10387

10388

10389

10390

10391

10392

10393

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

10394

10395

10396

10397

10398

10399

<p>An object with attribute name/configuration pairs.</p>

10400

</div>

10401

10402

10403

</li>

10404

10405

10406

10407

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

10408

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

10409

10410

10411

10412

10413

10414

<p>An object with attribute name/value pairs, defining the initial values to apply.

10415

Values defined in the cfgs argument will be over-written by values in this argument unless defined as read only.</p>

10416

</div>

10417

10418

10419

</li>

10420

10421

10422

10423

10424

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

10425

10426

10427

10428

10429

10430

<p>Whether or not to delay the intialization of these attributes until the first call to get/set.

10431

Individual attributes can over-ride this behavior by defining a lazyAdd configuration property in their configuration.

10432

See <a href="#method_addAttr">addAttr</a>.</p>

10433

</div>

10434

10435

10436

</li>

10437

10438

</ul>

10439

</div>

10440

10441

10442

10443

10444

<h4>Returns:</h4>

10445

10446

10447

10448

10449

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

10450

10451

A reference to the host object.

10452

10453

</div>

10454

</div>

10455

10456

10457

10458

</div>

10459

10460

10461

10462

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

10463

10464

10465

10466

10467

10468

10469

10470

10471

10472

</li>

10473

10474

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

10475

</div>

10476

10477

10478

10479

10480

10481

10482

10483

10484

10485

10486

10487

10488

10489

10490

10491

10492

10493

<p>Inherited from

10494

<a href="../classes/EventTarget.html#method_addTarget">EventTarget</a>:

10495

10496

10497

10498

<a href="../files/event-custom_js_event-facade.js.html#l382"><code>event-custom/js/event-facade.js:382</code></a>

10499

10500

</p>

10501

10502

10503

10504

10505

10506

</div>

10507

10508

10509

<p>Registers another EventTarget as a bubble target. Bubble order

10510

is determined by the order registered. Multiple targets can

10511

be specified.</p>

10512

10513

<p>Events can only bubble if emitFacade is true.</p>

10514

10515

<p>Included in the event-custom-complex submodule.</p>

10516

</div>

10517

10518

10519

10520

<h4>Parameters:</h4>

10521

10522

10523

10524

10525

10526

10527

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

10528

10529

10530

10531

10532

10533

<p>the target to add</p>

10534

</div>

10535

10536

10537

</li>

10538

10539

</ul>

10540

</div>

10541

10542

10543

10544

10545

10546

</div>

10547

10548

10549

10550

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

10551

10552

10553

10554

10555

10556

10557

10558

10559

10560

</li>

10561

10562

10563

10564

10565

10566

</li>

10567

10568

10569

10570

<code class="optional">[context]</code>

10571

10572

</li>

10573

10574

10575

10576

10577

10578

</li>

10579

10580

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

10581

</div>

10582

10583

10584

10585

10586

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

10587

</span>

10588

10589

10590

10591

10592

10593

10594

10595

10596

10597

10598

10599

10600

10601

10602

10603

<p>Inherited from

10604

<a href="../classes/EventTarget.html#method_after">EventTarget</a>:

10605

10606

10607

10608

<a href="../files/event-custom_js_event-target.js.html#l730"><code>event-custom/js/event-target.js:730</code></a>

10609

10610

</p>

10611

10612

10613

10614

10615

10616

</div>

10617

10618

10619

<p>Subscribe to a custom event hosted by this object. The

10620

supplied callback will execute after any listeners add

10621

via the subscribe method, and after the default function,

10622

if configured for the event, has executed.</p>

10623

</div>

10624

10625

10626

10627

<h4>Parameters:</h4>

10628

10629

10630

10631

10632

10633

10634

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

10635

10636

10637

10638

10639

10640

<p>The name of the event</p>

10641

</div>

10642

10643

10644

</li>

10645

10646

10647

10648

10649

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

10650

10651

10652

10653

10654

10655

<p>The callback to execute in response to the event</p>

10656

</div>

10657

10658

10659

</li>

10660

10661

10662

10663

<code class="param-name optional">[context]</code>

10664

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

10665

<span class="flag optional" title="This parameter is optional.">optional</span>

10666

10667

10668

10669

10670

10671

<p>Override <code>this</code> object in callback</p>

10672

</div>

10673

10674

10675

</li>

10676

10677

10678

10679

10680

10681

<span class="flag optional" title="This parameter is optional.">optional</span>

10682

10683

10684

10685

10686

10687

<p>0..n additional arguments to supply to the subscriber</p>

10688

</div>

10689

10690

10691

</li>

10692

10693

</ul>

10694

</div>

10695

10696

10697

10698

10699

<h4>Returns:</h4>

10700

10701

10702

10703

10704

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

10705

10706

A subscription handle capable of detaching the

10707

subscription

10708

10709

</div>

10710

</div>

10711

10712

10713

10714

</div>

10715

10716

10717

10718

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

10719

10720

10721

10722

10723

10724

10725

10726

<code>depth</code>

10727

10728

</li>

10729

10730

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

10731

</div>

10732

10733

10734

10735

10736

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

10737

</span>

10738

10739

10740

10741

10742

10743

10744

10745

10746

10747

10748

10749

10750

10751

10752

10753

<p>Inherited from

10754

<a href="../classes/Widget.html#method_ancestor">Widget</a>:

10755

10756

10757

10758

<a href="../files/widget-child_js_Widget-Child.js.html#l279"><code>widget-child/js/Widget-Child.js:279</code></a>

10759

10760

</p>

10761

10762

10763

10764

10765

10766

</div>

10767

10768

10769

<p>Returns the Widget instance at the specified depth.</p>

10770

</div>

10771

10772

10773

10774

<h4>Parameters:</h4>

10775

10776

10777

10778

10779

10780

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

10781

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

10782

10783

10784

10785

10786

10787

<p>Number representing the depth of the ancestor.</p>

10788

</div>

10789

10790

10791

</li>

10792

10793

</ul>

10794

</div>

10795

10796

10797

10798

10799

<h4>Returns:</h4>

10800

10801

10802

10803

10804

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

10805

10806

Widget instance.

10807

10808

</div>

10809

</div>

10810

10811

10812

10813

</div>

10814

10815

10816

10817

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

10818

10819

10820

10821

10822

10823

10824

10825

10826

10827

</li>

10828

10829

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

10830

</div>

10831

10832

10833

10834

10835

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

10836

</span>

10837

10838

10839

10840

10841

10842

10843

10844

10845

10846

10847

10848

10849

10850

10851

10852

<p>Inherited from

10853

<a href="../classes/AttributeCore.html#method_attrAdded">AttributeCore</a>:

10854

10855

10856

10857

<a href="../files/attribute_js_AttributeCore.js.html#l272"><code>attribute/js/AttributeCore.js:272</code></a>

10858

10859

</p>

10860

10861

10862

10863

10864

10865

</div>

10866

10867

10868

<p>Checks if the given attribute has been added to the host</p>

10869

</div>

10870

10871

10872

10873

<h4>Parameters:</h4>

10874

10875

10876

10877

10878

10879

10880

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

10881

10882

10883

10884

10885

10886

<p>The name of the attribute to check.</p>

10887

</div>

10888

10889

10890

</li>

10891

10892

</ul>

10893

</div>

10894

10895

10896

10897

10898

<h4>Returns:</h4>

10899

10900

10901

10902

10903

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

10904

10905

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.

10906

10907

</div>

10908

</div>

10909

10910

10911

10912

</div>

10913

10914

10915

10916

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

10917

10918

10919

10920

10921

10922

10923

10924

10925

</span>

10926

10927

10928

10929

10930

10931

10932

10933

10934

10935

10936

10937

10938

10939

10940

10941

<p>Inherited from

10942

<a href="../classes/EventTarget.html#method_before">EventTarget</a>:

10943

10944

10945

10946

<a href="../files/event-custom_js_event-target.js.html#l767"><code>event-custom/js/event-target.js:767</code></a>

10947

10948

</p>

10949

10950

10951

10952

10953

10954

</div>

10955

10956

10957

<p>Executes the callback before a DOM event, custom event

10958

or method. If the first argument is a function, it

10959

is assumed the target is a method. For DOM and custom

10960

events, this is an alias for Y.on.</p>

10961

10962

<p>For DOM and custom events:

10963

type, callback, context, 0-n arguments</p>

10964

10965

<p>For methods:

10966

callback, object (method host), methodName, context, 0-n arguments</p>

10967

</div>

10968

10969

10970

10971

10972

10973

<h4>Returns:</h4>

10974

10975

10976

10977

10978

detach handle

10979

10980

</div>

10981

</div>

10982

10983

10984

10985

</div>

10986

10987

10988

10989

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

10990

10991

10992

10993

10994

10995

10996

10997

10998

10999

11000

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

11001

11002

11003

11004

11005

11006

11007

11008

11009

11010

11011

11012

<p>Inherited from

11013

<a href="../classes/Widget.html#method_bindUI">Widget</a>:

11014

11015

11016

11017

<a href="../files/widget_js_Widget.js.html#l612"><code>widget/js/Widget.js:612</code></a>

11018

11019

</p>

11020

11021

11022

11023

11024

11025

</div>

11026

11027

11028

<p>Configures/Sets up listeners to bind Widget State to UI/DOM</p>

11029

11030

<p>This method is not called by framework and is not chained

11031

automatically for the class hierarchy.</p>

11032

</div>

11033

11034

11035

11036

11037

11038

11039

</div>

11040

11041

11042

11043

11044

11045

11046

11047

11048

11049

11050

11051

11052

11053

11054

11055

11056

11057

11058

11059

11060

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

11061

11062

11063

11064

11065

11066

<p>Inherited from

11067

<a href="../classes/Widget.html#method_blur">Widget</a>:

11068

11069

11070

11071

<a href="../files/widget_js_Widget.js.html#l674"><code>widget/js/Widget.js:674</code></a>

11072

11073

</p>

11074

11075

11076

11077

11078

11079

</div>

11080

11081

11082

<p>Causes the Widget to lose focus by setting the "focused" attribute

11083

to "false"</p>

11084

</div>

11085

11086

11087

11088

11089

11090

11091

</div>

11092

11093

11094

11095

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

11096

11097

11098

11099

11100

11101

11102

11103

11104

11105

</li>

11106

11107

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

11108

</div>

11109

11110

11111

11112

11113

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

11114

</span>

11115

11116

11117

11118

11119

11120

11121

11122

11123

11124

11125

11126

11127

11128

11129

11130

<p>Inherited from

11131

<a href="../classes/EventTarget.html#method_bubble">EventTarget</a>:

11132

11133

11134

11135

<a href="../files/event-custom_js_event-facade.js.html#l419"><code>event-custom/js/event-facade.js:419</code></a>

11136

11137

</p>

11138

11139

11140

11141

11142

11143

</div>

11144

11145

11146

<p>Propagate an event. Requires the event-custom-complex module.</p>

11147

</div>

11148

11149

11150

11151

<h4>Parameters:</h4>

11152

11153

11154

11155

11156

11157

11158

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

11159

11160

11161

11162

11163

11164

<p>the custom event to propagate</p>

11165

</div>

11166

11167

11168

</li>

11169

11170

</ul>

11171

</div>

11172

11173

11174

11175

11176

<h4>Returns:</h4>

11177

11178

11179

11180

11181

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

11182

11183

the aggregated return value from Event.Custom.fire

11184

11185

</div>

11186

</div>

11187

11188

11189

11190

</div>

11191

11192

11193

11194

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

11195

11196

11197

11198

11199

11200

11201

11202

<code>destroyAllNodes</code>

11203

11204

</li>

11205

11206

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

11207

</div>

11208

11209

11210

11211

11212

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

11213

</span>

11214

11215

11216

11217

11218

11219

11220

11221

11222

11223

11224

11225

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

11226

11227

11228

11229

11230

<p>Inherited from

11231

11232

BaseCore

11233

</a>

11234

11235

but overwritten in

11236

11237

11238

11239

<a href="../files/widget_js_Widget.js.html#l455"><code>widget/js/Widget.js:455</code></a>

11240

11241

</p>

11242

11243

11244

11245

11246

11247

</div>

11248

11249

11250

<p>

11251

Destroy lifecycle method. Fires the destroy

11252

event, prior to invoking destructors for the

11253

class hierarchy.

11254

11255

Overrides Base's implementation, to support arguments to destroy

11256

</p>

11257

11258

<p>

11259

Subscribers to the destroy

11260

event can invoke preventDefault on the event object, to prevent destruction

11261

from proceeding.

11262

</p>

11263

</div>

11264

11265

11266

11267

<h4>Parameters:</h4>

11268

11269

11270

11271

11272

11273

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

11274

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

11275

11276

11277

11278

11279

11280

<p>If true, all nodes contained within the Widget are removed and destroyed. Defaults to false due to potentially high run-time cost.</p>

11281

</div>

11282

11283

11284

</li>

11285

11286

</ul>

11287

</div>

11288

11289

11290

11291

11292

<h4>Returns:</h4>

11293

11294

11295

11296

11297

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

11298

11299

A reference to this object

11300

11301

</div>

11302

</div>

11303

11304

11305

11306

</div>

11307

11308

11309

11310

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

11311

11312

11313

11314

11315

11316

11317

11318

11319

11320

11321

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

11322

11323

11324

11325

11326

11327

11328

11329

11330

11331

11332

11333

<p>Inherited from

11334

<a href="../classes/Widget.html#method_destructor">Widget</a>:

11335

11336

11337

11338

<a href="../files/widget_js_Widget.js.html#l430"><code>widget/js/Widget.js:430</code></a>

11339

11340

</p>

11341

11342

11343

11344

11345

11346

</div>

11347

11348

11349

<p>Destructor lifecycle implementation for the Widget class. Purges events attached

11350

to the bounding box and content box, removes them from the DOM and removes

11351

the Widget from the list of registered widgets.</p>

11352

</div>

11353

11354

11355

11356

11357

11358

11359

</div>

11360

11361

11362

11363

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

11364

11365

11366

11367

11368

11369

11370

11371

11372

11373

</li>

11374

11375

11376

11377

11378

11379

</li>

11380

11381

11382

11383

<code>context</code>

11384

11385

</li>

11386

11387

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

11388

</div>

11389

11390

11391

11392

11393

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

11394

</span>

11395

11396

11397

11398

11399

11400

11401

11402

11403

11404

11405

11406

11407

11408

11409

11410

<p>Inherited from

11411

<a href="../classes/EventTarget.html#method_detach">EventTarget</a>:

11412

11413

11414

11415

<a href="../files/event-custom_js_event-target.js.html#l345"><code>event-custom/js/event-target.js:345</code></a>

11416

11417

</p>

11418

11419

11420

11421

11422

11423

</div>

11424

11425

11426

<p>Detach one or more listeners the from the specified event</p>

11427

</div>

11428

11429

11430

11431

<h4>Parameters:</h4>

11432

11433

11434

11435

11436

11437

11438

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

11439

11440

11441

11442

11443

11444

<p>Either the handle to the subscriber or the

11445

type of event. If the type

11446

is not specified, it will attempt to remove

11447

the listener from all hosted events.</p>

11448

</div>

11449

11450

11451

</li>

11452

11453

11454

11455

11456

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

11457

11458

11459

11460

11461

11462

<p>The subscribed function to unsubscribe, if not

11463

supplied, all subscribers will be removed.</p>

11464

</div>

11465

11466

11467

</li>

11468

11469

11470

11471

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

11472

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

11473

11474

11475

11476

11477

11478

<p>The custom object passed to subscribe. This is

11479

optional, but if supplied will be used to

11480

disambiguate multiple listeners that are the same

11481

(e.g., you subscribe many object using a function

11482

that lives on the prototype)</p>

11483

</div>

11484

11485

11486

</li>

11487

11488

</ul>

11489

</div>

11490

11491

11492

11493

11494

<h4>Returns:</h4>

11495

11496

11497

11498

11499

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

11500

11501

the host

11502

11503

</div>

11504

</div>

11505

11506

11507

11508

</div>

11509

11510

11511

11512

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

11513

11514

11515

11516

11517

11518

11519

11520

11521

11522

</li>

11523

11524

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

11525

</div>

11526

11527

11528

11529

11530

11531

11532

11533

11534

11535

11536

11537

11538

11539

11540

11541

11542

11543

<p>Inherited from

11544

<a href="../classes/EventTarget.html#method_detachAll">EventTarget</a>:

11545

11546

11547

11548

<a href="../files/event-custom_js_event-target.js.html#l465"><code>event-custom/js/event-target.js:465</code></a>

11549

11550

</p>

11551

11552

11553

11554

11555

11556

</div>

11557

11558

11559

<p>Removes all listeners from the specified event. If the event type

11560

is not specified, all listeners from all hosted custom events will

11561

be removed.</p>

11562

</div>

11563

11564

11565

11566

<h4>Parameters:</h4>

11567

11568

11569

11570

11571

11572

11573

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

11574

11575

11576

11577

11578

11579

<p>The type, or name of the event</p>

11580

</div>

11581

11582

11583

</li>

11584

11585

</ul>

11586

</div>

11587

11588

11589

11590

11591

11592

</div>

11593

11594

11595

11596

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

11597

11598

11599

11600

11601

11602

11603

11604

11605

11606

11607

11608

11609

11610

11611

11612

11613

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

11614

11615

11616

11617

11618

11619

<p>Inherited from

11620

<a href="../classes/Widget.html#method_disable">Widget</a>:

11621

11622

11623

11624

<a href="../files/widget_js_Widget.js.html#l693"><code>widget/js/Widget.js:693</code></a>

11625

11626

</p>

11627

11628

11629

11630

11631

11632

</div>

11633

11634

11635

<p>Set the Widget's "disabled" attribute to "true".</p>

11636

</div>

11637

11638

11639

11640

11641

11642

11643

</div>

11644

11645

11646

11647

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

11648

11649

11650

11651

11652

11653

11654

11655

11656

11657

11658

11659

11660

11661

11662

11663

11664

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

11665

11666

11667

11668

11669

11670

<p>Inherited from

11671

<a href="../classes/Widget.html#method_enable">Widget</a>:

11672

11673

11674

11675

<a href="../files/widget_js_Widget.js.html#l684"><code>widget/js/Widget.js:684</code></a>

11676

11677

</p>

11678

11679

11680

11681

11682

11683

</div>

11684

11685

11686

<p>Set the Widget's "disabled" attribute to "false".</p>

11687

</div>

11688

11689

11690

11691

11692

11693

11694

</div>

11695

11696

11697

11698

11699

11700

11701

11702

11703

11704

11705

11706

11707

11708

</li>

11709

11710

11711

11712

<code>arguments</code>

11713

11714

</li>

11715

11716

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

11717

</div>

11718

11719

11720

11721

11722

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

11723

</span>

11724

11725

11726

11727

11728

11729

11730

11731

11732

11733

11734

11735

11736

11737

11738

11739

<p>Inherited from

11740

<a href="../classes/EventTarget.html#method_fire">EventTarget</a>:

11741

11742

11743

11744

<a href="../files/event-custom_js_event-target.js.html#l629"><code>event-custom/js/event-target.js:629</code></a>

11745

11746

</p>

11747

11748

11749

11750

11751

11752

</div>

11753

11754

11755

<p>Fire a custom event by name. The callback functions will be executed

11756

from the context specified when the event was created, and with the

11757

following parameters.</p>

11758

11759

<p>If the custom event object hasn't been created, then the event hasn't

11760

been published and it has no subscribers. For performance sake, we

11761

immediate exit in this case. This means the event won't bubble, so

11762

if the intention is that a bubble target be notified, the event must

11763

be published on this object first.</p>

11764

11765

<p>The first argument is the event type, and any additional arguments are

11766

passed to the listeners as parameters. If the first of these is an

11767

object literal, and the event is configured to emit an event facade,

11768

that object is mixed into the event facade and the facade is provided

11769

in place of the original object.</p>

11770

</div>

11771

11772

11773

11774

<h4>Parameters:</h4>

11775

11776

11777

11778

11779

11780

11781

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

11782

11783

11784

11785

11786

11787

<p>The type of the event, or an object that contains

11788

a 'type' property.</p>

11789

</div>

11790

11791

11792

</li>

11793

11794

11795

11796

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

11797

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

11798

11799

11800

11801

11802

11803

<p>an arbitrary set of parameters to pass to

11804

the handler. If the first of these is an object literal and the event is

11805

configured to emit an event facade, the event facade will replace that

11806

parameter after the properties the object literal contains are copied to

11807

the event facade.</p>

11808

</div>

11809

11810

11811

</li>

11812

11813

</ul>

11814

</div>

11815

11816

11817

11818

11819

<h4>Returns:</h4>

11820

11821

11822

11823

11824

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

11825

11826

the event host

11827

11828

</div>

11829

</div>

11830

11831

11832

11833

</div>

11834

11835

11836

11837

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

11838

11839

11840

11841

11842

11843

11844

11845

11846

11847

11848

11849

11850

11851

11852

11853

11854

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

11855

11856

11857

11858

11859

11860

<p>Inherited from

11861

<a href="../classes/Widget.html#method_focus">Widget</a>:

11862

11863

11864

11865

<a href="../files/widget_js_Widget.js.html#l664"><code>widget/js/Widget.js:664</code></a>

11866

11867

</p>

11868

11869

11870

11871

11872

11873

</div>

11874

11875

11876

<p>Causes the Widget to receive the focus by setting the "focused"

11877

attribute to "true".</p>

11878

</div>

11879

11880

11881

11882

11883

11884

11885

</div>

11886

11887

11888

11889

11890

11891

11892

11893

11894

11895

11896

11897

11898

11899

</li>

11900

11901

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

11902

</div>

11903

11904

11905

11906

11907

11908

</span>

11909

11910

11911

11912

11913

11914

11915

11916

11917

11918

11919

11920

11921

11922

11923

11924

<p>Inherited from

11925

<a href="../classes/AttributeCore.html#method_get">AttributeCore</a>:

11926

11927

11928

11929

<a href="../files/attribute_js_AttributeCore.js.html#l283"><code>attribute/js/AttributeCore.js:283</code></a>

11930

11931

</p>

11932

11933

11934

11935

11936

11937

</div>

11938

11939

11940

<p>Returns the current value of the attribute. If the attribute

11941

has been configured with a 'getter' function, this method will delegate

11942

to the 'getter' to obtain the value of the attribute.</p>

11943

</div>

11944

11945

11946

11947

<h4>Parameters:</h4>

11948

11949

11950

11951

11952

11953

11954

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

11955

11956

11957

11958

11959

11960

<p>The name of the attribute. If the value of the attribute is an Object,

11961

dot notation can be used to obtain the value of a property of the object (e.g. <code>get("x.y.z")</code>)</p>

11962

</div>

11963

11964

11965

</li>

11966

11967

</ul>

11968

</div>

11969

11970

11971

11972

11973

<h4>Returns:</h4>

11974

11975

11976

11977

11978

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

11979

11980

The value of the attribute

11981

11982

</div>

11983

</div>

11984

11985

11986

11987

</div>

11988

11989

11990

11991

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

11992

11993

11994

11995

11996

11997

11998

11999

<code>attrs</code>

12000

12001

</li>

12002

12003

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

12004

</div>

12005

12006

12007

12008

12009

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

12010

</span>

12011

12012

12013

12014

12015

12016

12017

12018

12019

12020

12021

12022

12023

12024

12025

12026

<p>Inherited from

12027

<a href="../classes/AttributeCore.html#method_getAttrs">AttributeCore</a>:

12028

12029

12030

12031

<a href="../files/attribute_js_AttributeCore.js.html#l665"><code>attribute/js/AttributeCore.js:665</code></a>

12032

12033

</p>

12034

12035

12036

12037

12038

12039

</div>

12040

12041

12042

<p>Gets multiple attribute values.</p>

12043

</div>

12044

12045

12046

12047

<h4>Parameters:</h4>

12048

12049

12050

12051

12052

12053

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

12054

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

12055

12056

12057

12058

12059

12060

<p>Optional. An array of attribute names. If omitted, all attribute values are

12061

returned. If set to true, all attributes modified from their initial values are returned.</p>

12062

</div>

12063

12064

12065

</li>

12066

12067

</ul>

12068

</div>

12069

12070

12071

12072

12073

<h4>Returns:</h4>

12074

12075

12076

12077

12078

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

12079

12080

An object with attribute name/value pairs.

12081

12082

</div>

12083

</div>

12084

12085

12086

12087

</div>

12088

12089

12090

12091

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

12092

12093

12094

12095

12096

12097

12098

12099

12100

12101

</li>

12102

12103

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

12104

</div>

12105

12106

12107

12108

12109

12110

12111

12112

12113

12114

12115

12116

12117

12118

12119

12120

12121

<p>Inherited from

12122

12123

Widget

12124

</a>

12125

12126

but overwritten in

12127

12128

12129

12130

<a href="../files/widget_js_Widget.js.html#l309"><code>widget/js/Widget.js:309</code></a>

12131

12132

</p>

12133

12134

12135

12136

12137

12138

</div>

12139

12140

12141

<p>Generate a standard prefixed classname for the Widget, prefixed by the default prefix defined

12142

by the <code>Y.config.classNamePrefix</code> attribute used by <code>ClassNameManager</code> and

12143

<code>Widget.NAME.toLowerCase()</code> (e.g. "yui-widget-xxxxx-yyyyy", based on default values for

12144

the prefix and widget class name).</p>

12145

12146

<p>

12147

The instance based version of this method can be used to generate standard prefixed classnames,

12148

based on the instances NAME, as opposed to Widget.NAME. This method should be used when you

12149

need to use a constant class name across different types instances.

12150

</p>

12151

</div>

12152

12153

12154

12155

<h4>Parameters:</h4>

12156

12157

12158

12159

12160

12161

12162

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

12163

12164

12165

12166

<span class="flag multiple" title="This argument may occur one or more times.">multiple</span>

12167

12168

12169

12170

<p>0..n strings which should be concatenated, using the default separator defined by ClassNameManager, to create the class name</p>

12171

</div>

12172

12173

12174

</li>

12175

12176

</ul>

12177

</div>

12178

12179

12180

12181

12182

12183

</div>

12184

12185

12186

12187

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

12188

12189

12190

12191

12192

12193

12194

12195

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

12196

</span>

12197

12198

12199

12200

12201

12202

12203

12204

12205

12206

12207

12208

12209

12210

12211

12212

<p>Inherited from

12213

<a href="../classes/Widget.html#method_getDefaultLocale">Widget</a>:

12214

12215

12216

12217

<a href="../files/widget_js_WidgetLocale.js.html#l150"><code>widget/js/WidgetLocale.js:150</code></a>

12218

12219

</p>

12220

12221

12222

12223

12224

12225

</div>

12226

12227

12228

<p>Returns the default locale for the widget (the locale value defined by the

12229

widget class, or provided by the user during construction).</p>

12230

</div>

12231

12232

12233

12234

12235

12236

<h4>Returns:</h4>

12237

12238

12239

12240

12241

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

12242

12243

The default locale for the widget

12244

12245

</div>

12246

</div>

12247

12248

12249

12250

</div>

12251

12252

12253

12254

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

12255

12256

12257

12258

12259

12260

12261

12262

12263

12264

</li>

12265

12266

12267

12268

<code>prefixed</code>

12269

12270

</li>

12271

12272

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

12273

</div>

12274

12275

12276

12277

12278

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

12279

</span>

12280

12281

12282

12283

12284

12285

12286

12287

12288

12289

12290

12291

12292

12293

12294

12295

<p>Inherited from

12296

<a href="../classes/EventTarget.html#method_getEvent">EventTarget</a>:

12297

12298

12299

12300

<a href="../files/event-custom_js_event-target.js.html#l712"><code>event-custom/js/event-target.js:712</code></a>

12301

12302

</p>

12303

12304

12305

12306

12307

12308

</div>

12309

12310

12311

<p>Returns the custom event of the provided type has been created, a

12312

falsy value otherwise</p>

12313

</div>

12314

12315

12316

12317

<h4>Parameters:</h4>

12318

12319

12320

12321

12322

12323

12324

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

12325

12326

12327

12328

12329

12330

<p>the type, or name of the event</p>

12331

</div>

12332

12333

12334

</li>

12335

12336

12337

12338

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

12339

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

12340

12341

12342

12343

12344

12345

<p>if true, the type is prefixed already</p>

12346

</div>

12347

12348

12349

</li>

12350

12351

</ul>

12352

</div>

12353

12354

12355

12356

12357

<h4>Returns:</h4>

12358

12359

12360

12361

12362

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

12363

12364

the custom event or null

12365

12366

</div>

12367

</div>

12368

12369

12370

12371

</div>

12372

12373

12374

12375

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

12376

12377

12378

12379

12380

12381

12382

12383

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

12384

</span>

12385

12386

12387

12388

12389

12390

12391

12392

12393

12394

12395

12396

12397

12398

12399

12400

<p>Inherited from

12401

<a href="../classes/Widget.html#method_getSkinName">Widget</a>:

12402

12403

12404

12405

<a href="../files/widget_js_WidgetSkin.js.html#l13"><code>widget/js/WidgetSkin.js:13</code></a>

12406

12407

</p>

12408

12409

12410

12411

12412

12413

</div>

12414

12415

12416

<p>Returns the name of the skin that's currently applied to the widget.

12417

This is only really useful after the widget's DOM structure is in the

12418

document, either by render or by progressive enhancement. Searches up

12419

the Widget's ancestor axis for a class yui3-skin-(name), and returns the

12420

(name) portion. Otherwise, returns null.</p>

12421

</div>

12422

12423

12424

12425

12426

12427

<h4>Returns:</h4>

12428

12429

12430

12431

12432

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

12433

12434

the name of the skin, or null (yui3-skin-sam => sam)

12435

12436

</div>

12437

</div>

12438

12439

12440

12441

</div>

12442

12443

12444

12445

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

12446

12447

12448

12449

12450

12451

12452

12453

12454

12455

</li>

12456

12457

12458

12459

<code>locale</code>

12460

12461

</li>

12462

12463

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

12464

</div>

12465

12466

12467

12468

12469

12470

12471

12472

12473

12474

12475

12476

12477

12478

12479

12480

12481

<p>Inherited from

12482

12483

Widget

12484

</a>

12485

12486

but overwritten in

12487

12488

12489

12490

<a href="../files/widget_js_WidgetLocale.js.html#l107"><code>widget/js/WidgetLocale.js:107</code></a>

12491

12492

</p>

12493

12494

12495

12496

12497

12498

</div>

12499

12500

12501

<p>Gets the string for a particular key, for a particular locale, performing locale lookup.</p>

12502

12503

<p>

12504

If no values if defined for the key, for the given locale, the value for the

12505

default locale (in initial locale set for the class) is returned.

12506

</p>

12507

</div>

12508

12509

12510

12511

<h4>Parameters:</h4>

12512

12513

12514

12515

12516

12517

12518

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

12519

12520

12521

12522

12523

12524

12525

</div>

12526

12527

12528

</li>

12529

12530

12531

12532

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

12533

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

12534

12535

12536

12537

12538

12539

<p>(optional) The locale for which the string value is required. Defaults to the current locale, if not provided.</p>

12540

</div>

12541

12542

12543

</li>

12544

12545

</ul>

12546

</div>

12547

12548

12549

12550

12551

12552

</div>

12553

12554

12555

12556

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

12557

12558

12559

12560

12561

12562

12563

12564

<code>locale</code>

12565

12566

</li>

12567

12568

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

12569

</div>

12570

12571

12572

12573

12574

12575

12576

12577

12578

12579

12580

12581

12582

12583

12584

12585

12586

<p>Inherited from

12587

12588

Widget

12589

</a>

12590

12591

but overwritten in

12592

12593

12594

12595

<a href="../files/widget_js_WidgetLocale.js.html#l64"><code>widget/js/WidgetLocale.js:64</code></a>

12596

12597

</p>

12598

12599

12600

12601

12602

12603

</div>

12604

12605

12606

<p>Gets the entire strings hash for a particular locale, performing locale lookup.</p>

12607

12608

<p>

12609

If no values of the key are defined for a particular locale the value for the

12610

default locale (in initial locale set for the class) is returned.

12611

</p>

12612

</div>

12613

12614

12615

12616

<h4>Parameters:</h4>

12617

12618

12619

12620

12621

12622

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

12623

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

12624

12625

12626

12627

12628

12629

<p>(optional) The locale for which the string value is required. Defaults to the current locale, if not provided.</p>

12630

</div>

12631

12632

12633

</li>

12634

12635

</ul>

12636

</div>

12637

12638

12639

12640

12641

12642

</div>

12643

12644

12645

12646

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

12647

12648

12649

12650

12651

12652

12653

12654

12655

</span>

12656

12657

12658

12659

12660

12661

12662

12663

12664

12665

12666

12667

12668

12669

12670

12671

<p>Inherited from

12672

<a href="../classes/EventTarget.html#method_getTargets">EventTarget</a>:

12673

12674

12675

12676

<a href="../files/event-custom_js_event-facade.js.html#l400"><code>event-custom/js/event-facade.js:400</code></a>

12677

12678

</p>

12679

12680

12681

12682

12683

12684

</div>

12685

12686

12687

<p>Returns an array of bubble targets for this object.</p>

12688

</div>

12689

12690

12691

12692

12693

12694

<h4>Returns:</h4>

12695

12696

12697

12698

12699

EventTarget[]

12700

12701

</div>

12702

</div>

12703

12704

12705

12706

</div>

12707

12708

12709

12710

12711

12712

12713

12714

12715

12716

12717

12718

12719

12720

12721

12722

12723

12724

12725

12726

12727

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

12728

12729

12730

12731

12732

12733

<p>Inherited from

12734

<a href="../classes/Widget.html#method_hide">Widget</a>:

12735

12736

12737

12738

<a href="../files/widget_js_Widget.js.html#l646"><code>widget/js/Widget.js:646</code></a>

12739

12740

</p>

12741

12742

12743

12744

12745

12746

</div>

12747

12748

12749

<p>Hides the Widget by setting the "visible" attribute to "false".</p>

12750

</div>

12751

12752

12753

12754

12755

12756

12757

</div>

12758

12759

12760

12761

12762

12763

12764

12765

12766

12767

12768

12769

<code>config</code>

12770

12771

</li>

12772

12773

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

12774

</div>

12775

12776

12777

12778

12779

12780

</span>

12781

12782

12783

12784

12785

12786

12787

12788

12789

12790

12791

12792

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

12793

12794

12795

12796

12797

<p>Inherited from

12798

12799

BaseCore

12800

</a>

12801

12802

but overwritten in

12803

12804

12805

12806

12807

12808

</p>

12809

12810

12811

12812

12813

12814

</div>

12815

12816

12817

<p>Init lifecycle method, invoked during construction.

12818

Fires the init event prior to setting up attributes and

12819

invoking initializers for the class hierarchy.</p>

12820

</div>

12821

12822

12823

12824

<h4>Parameters:</h4>

12825

12826

12827

12828

12829

12830

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

12831

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

12832

12833

12834

12835

12836

12837

<p>Object with configuration property name/value pairs</p>

12838

</div>

12839

12840

12841

</li>

12842

12843

</ul>

12844

</div>

12845

12846

12847

12848

12849

<h4>Returns:</h4>

12850

12851

12852

12853

12854

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

12855

12856

A reference to this object

12857

12858

</div>

12859

</div>

12860

12861

12862

12863

</div>

12864

12865

12866

12867

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

12868

12869

12870

12871

12872

12873

12874

12875

<code>config</code>

12876

12877

</li>

12878

12879

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

12880

</div>

12881

12882

12883

12884

12885

12886

12887

12888

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

12889

12890

12891

12892

12893

12894

12895

12896

12897

12898

12899

12900

<p>Inherited from

12901

<a href="../classes/Widget.html#method_initializer">Widget</a>:

12902

12903

12904

12905

<a href="../files/widget_js_Widget.js.html#l382"><code>widget/js/Widget.js:382</code></a>

12906

12907

</p>

12908

12909

12910

12911

12912

12913

</div>

12914

12915

12916

<p>Initializer lifecycle implementation for the Widget class. Registers the

12917

widget instance, and runs through the Widget's HTML_PARSER definition.</p>

12918

</div>

12919

12920

12921

12922

<h4>Parameters:</h4>

12923

12924

12925

12926

12927

12928

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

12929

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

12930

12931

12932

12933

12934

12935

<p>Configuration object literal for the widget</p>

12936

</div>

12937

12938

12939

</li>

12940

12941

</ul>

12942

</div>

12943

12944

12945

12946

12947

12948

</div>

12949

12950

12951

12952

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

12953

12954

12955

12956

12957

12958

12959

12960

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

12961

</span>

12962

12963

12964

12965

12966

12967

12968

12969

12970

12971

12972

12973

12974

12975

12976

12977

<p>Inherited from

12978

<a href="../classes/Widget.html#method_isRoot">Widget</a>:

12979

12980

12981

12982

<a href="../files/widget-child_js_Widget-Child.js.html#l267"><code>widget-child/js/Widget-Child.js:267</code></a>

12983

12984

</p>

12985

12986

12987

12988

12989

12990

</div>

12991

12992

12993

<p>Determines if the Widget is the root Widget in the

12994

object hierarchy.</p>

12995

</div>

12996

12997

12998

12999

13000

13001

<h4>Returns:</h4>

13002

13003

13004

13005

13006

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

13007

13008

Boolean indicating if Widget is the root Widget in the

13009

object hierarchy.

13010

13011

</div>

13012

</div>

13013

13014

13015

13016

</div>

13017

13018

13019

13020

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

13021

13022

13023

13024

13025

13026

13027

13028

13029

13030

</li>

13031

13032

13033

13034

<code>config</code>

13035

13036

</li>

13037

13038

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

13039

</div>

13040

13041

13042

13043

13044

13045

13046

13047

13048

13049

13050

13051

13052

13053

13054

13055

13056

13057

<p>Inherited from

13058

<a href="../classes/AttributeExtras.html#method_modifyAttr">AttributeExtras</a>:

13059

13060

13061

13062

<a href="../files/attribute_js_AttributeExtras.js.html#l39"><code>attribute/js/AttributeExtras.js:39</code></a>

13063

13064

</p>

13065

13066

13067

13068

13069

13070

</div>

13071

13072

13073

<p>Updates the configuration of an attribute which has already been added.</p>

13074

13075

<p>

13076

The properties which can be modified through this interface are limited

13077

to the following subset of attributes, which can be safely modified

13078

after a value has already been set on the attribute: readOnly, writeOnce,

13079

broadcast and getter.

13080

</p>

13081

</div>

13082

13083

13084

13085

<h4>Parameters:</h4>

13086

13087

13088

13089

13090

13091

13092

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

13093

13094

13095

13096

13097

13098

<p>The name of the attribute whose configuration is to be updated.</p>

13099

</div>

13100

13101

13102

</li>

13103

13104

13105

13106

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

13107

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

13108

13109

13110

13111

13112

13113

<p>An object with configuration property/value pairs, specifying the configuration properties to modify.</p>

13114

</div>

13115

13116

13117

</li>

13118

13119

</ul>

13120

</div>

13121

13122

13123

13124

13125

13126

</div>

13127

13128

13129

13130

13131

13132

13133

13134

13135

13136

13137

13138

<code>circular</code>

13139

13140

</li>

13141

13142

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

13143

</div>

13144

13145

13146

13147

13148

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

13149

</span>

13150

13151

13152

13153

13154

13155

13156

13157

13158

13159

13160

13161

13162

13163

13164

13165

<p>Inherited from

13166

<a href="../classes/Widget.html#method_next">Widget</a>:

13167

13168

13169

13170

<a href="../files/widget-child_js_Widget-Child.js.html#l191"><code>widget-child/js/Widget-Child.js:191</code></a>

13171

13172

</p>

13173

13174

13175

13176

13177

13178

</div>

13179

13180

13181

<p>Returns the Widget's next sibling.</p>

13182

</div>

13183

13184

13185

13186

<h4>Parameters:</h4>

13187

13188

13189

13190

13191

13192

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

13193

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

13194

13195

13196

13197

13198

13199

<p>Boolean indicating if the parent's first child

13200

should be returned if the child has no next sibling.</p>

13201

</div>

13202

13203

13204

</li>

13205

13206

</ul>

13207

</div>

13208

13209

13210

13211

13212

<h4>Returns:</h4>

13213

13214

13215

13216

13217

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

13218

13219

Widget instance.

13220

13221

</div>

13222

</div>

13223

13224

13225

13226

</div>

13227

13228

13229

13230

13231

13232

13233

13234

13235

13236

13237

13238

13239

13240

</li>

13241

13242

13243

13244

13245

13246

</li>

13247

13248

13249

13250

<code class="optional">[context]</code>

13251

13252

</li>

13253

13254

13255

13256

13257

13258

</li>

13259

13260

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

13261

</div>

13262

13263

13264

13265

13266

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

13267

</span>

13268

13269

13270

13271

13272

13273

13274

13275

13276

13277

13278

13279

13280

13281

13282

13283

<p>Inherited from

13284

<a href="../classes/EventTarget.html#method_on">EventTarget</a>:

13285

13286

13287

13288

<a href="../files/event-custom_js_event-target.js.html#l192"><code>event-custom/js/event-target.js:192</code></a>

13289

13290

</p>

13291

13292

13293

13294

13295

13296

</div>

13297

13298

13299

<p>Subscribe a callback function to a custom event fired by this object or

13300

from an object that bubbles its events to this object.</p>

13301

13302

<p>Callback functions for events published with <code>emitFacade = true</code> will

13303

receive an <code>EventFacade</code> as the first argument (typically named "e").

13304

These callbacks can then call <code>e.preventDefault()</code> to disable the

13305

behavior published to that event's <code>defaultFn</code>. See the <code>EventFacade</code>

13306

API for all available properties and methods. Subscribers to

13307

non-<code>emitFacade</code> events will receive the arguments passed to <code>fire()</code>

13308

after the event name.</p>

13309

13310

<p>To subscribe to multiple events at once, pass an object as the first

13311

argument, where the key:value pairs correspond to the eventName:callback,

13312

or pass an array of event names as the first argument to subscribe to

13313

all listed events with the same callback.</p>

13314

13315

<p>Returning <code>false</code> from a callback is supported as an alternative to

13316

calling <code>e.preventDefault(); e.stopPropagation();</code>. However, it is

13317

recommended to use the event methods whenever possible.</p>

13318

</div>

13319

13320

13321

13322

<h4>Parameters:</h4>

13323

13324

13325

13326

13327

13328

13329

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

13330

13331

13332

13333

13334

13335

<p>The name of the event</p>

13336

</div>

13337

13338

13339

</li>

13340

13341

13342

13343

13344

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

13345

13346

13347

13348

13349

13350

<p>The callback to execute in response to the event</p>

13351

</div>

13352

13353

13354

</li>

13355

13356

13357

13358

<code class="param-name optional">[context]</code>

13359

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

13360

<span class="flag optional" title="This parameter is optional.">optional</span>

13361

13362

13363

13364

13365

13366

<p>Override <code>this</code> object in callback</p>

13367

</div>

13368

13369

13370

</li>

13371

13372

13373

13374

13375

13376

<span class="flag optional" title="This parameter is optional.">optional</span>

13377

13378

13379

13380

13381

13382

<p>0..n additional arguments to supply to the subscriber</p>

13383

</div>

13384

13385

13386

</li>

13387

13388

</ul>

13389

</div>

13390

13391

13392

13393

13394

<h4>Returns:</h4>

13395

13396

13397

13398

13399

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

13400

13401

A subscription handle capable of detaching that

13402

subscription

13403

13404

</div>

13405

</div>

13406

13407

13408

13409

</div>

13410

13411

13412

13413

13414

13415

13416

13417

13418

13419

13420

13421

13422

13423

</li>

13424

13425

13426

13427

13428

13429

</li>

13430

13431

13432

13433

<code class="optional">[context]</code>

13434

13435

</li>

13436

13437

13438

13439

13440

13441

</li>

13442

13443

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

13444

</div>

13445

13446

13447

13448

13449

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

13450

</span>

13451

13452

13453

13454

13455

13456

13457

13458

13459

13460

13461

13462

13463

13464

13465

13466

<p>Inherited from

13467

<a href="../classes/EventTarget.html#method_once">EventTarget</a>:

13468

13469

13470

13471

<a href="../files/event-custom_js_event-target.js.html#l128"><code>event-custom/js/event-target.js:128</code></a>

13472

13473

</p>

13474

13475

13476

13477

13478

13479

</div>

13480

13481

13482

<p>Listen to a custom event hosted by this object one time.

13483

This is the equivalent to <code>on</code> except the

13484

listener is immediatelly detached when it is executed.</p>

13485

</div>

13486

13487

13488

13489

<h4>Parameters:</h4>

13490

13491

13492

13493

13494

13495

13496

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

13497

13498

13499

13500

13501

13502

<p>The name of the event</p>

13503

</div>

13504

13505

13506

</li>

13507

13508

13509

13510

13511

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

13512

13513

13514

13515

13516

13517

<p>The callback to execute in response to the event</p>

13518

</div>

13519

13520

13521

</li>

13522

13523

13524

13525

<code class="param-name optional">[context]</code>

13526

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

13527

<span class="flag optional" title="This parameter is optional.">optional</span>

13528

13529

13530

13531

13532

13533

<p>Override <code>this</code> object in callback</p>

13534

</div>

13535

13536

13537

</li>

13538

13539

13540

13541

13542

13543

<span class="flag optional" title="This parameter is optional.">optional</span>

13544

13545

13546

13547

13548

13549

<p>0..n additional arguments to supply to the subscriber</p>

13550

</div>

13551

13552

13553

</li>

13554

13555

</ul>

13556

</div>

13557

13558

13559

13560

13561

<h4>Returns:</h4>

13562

13563

13564

13565

13566

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

13567

13568

A subscription handle capable of detaching the

13569

subscription

13570

13571

</div>

13572

</div>

13573

13574

13575

13576

</div>

13577

13578

13579

13580

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

13581

13582

13583

13584

13585

13586

13587

13588

13589

13590

</li>

13591

13592

13593

13594

13595

13596

</li>

13597

13598

13599

13600

<code class="optional">[context]</code>

13601

13602

</li>

13603

13604

13605

13606

13607

13608

</li>

13609

13610

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

13611

</div>

13612

13613

13614

13615

13616

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

13617

</span>

13618

13619

13620

13621

13622

13623

13624

13625

13626

13627

13628

13629

13630

13631

13632

13633

<p>Inherited from

13634

<a href="../classes/EventTarget.html#method_onceAfter">EventTarget</a>:

13635

13636

13637

13638

<a href="../files/event-custom_js_event-target.js.html#l150"><code>event-custom/js/event-target.js:150</code></a>

13639

13640

</p>

13641

13642

13643

13644

13645

13646

</div>

13647

13648

13649

<p>Listen to a custom event hosted by this object one time.

13650

This is the equivalent to <code>after</code> except the

13651

listener is immediatelly detached when it is executed.</p>

13652

</div>

13653

13654

13655

13656

<h4>Parameters:</h4>

13657

13658

13659

13660

13661

13662

13663

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

13664

13665

13666

13667

13668

13669

<p>The name of the event</p>

13670

</div>

13671

13672

13673

</li>

13674

13675

13676

13677

13678

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

13679

13680

13681

13682

13683

13684

<p>The callback to execute in response to the event</p>

13685

</div>

13686

13687

13688

</li>

13689

13690

13691

13692

<code class="param-name optional">[context]</code>

13693

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

13694

<span class="flag optional" title="This parameter is optional.">optional</span>

13695

13696

13697

13698

13699

13700

<p>Override <code>this</code> object in callback</p>

13701

</div>

13702

13703

13704

</li>

13705

13706

13707

13708

13709

13710

<span class="flag optional" title="This parameter is optional.">optional</span>

13711

13712

13713

13714

13715

13716

<p>0..n additional arguments to supply to the subscriber</p>

13717

</div>

13718

13719

13720

</li>

13721

13722

</ul>

13723

</div>

13724

13725

13726

13727

13728

<h4>Returns:</h4>

13729

13730

13731

13732

13733

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

13734

13735

A subscription handle capable of detaching that

13736

subscription

13737

13738

</div>

13739

</div>

13740

13741

13742

13743

</div>

13744

13745

13746

13747

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

13748

13749

13750

13751

13752

13753

13754

13755

13756

13757

</li>

13758

13759

13760

13761

<code class="optional">[pre=this._yuievt.config.prefix]</code>

13762

13763

</li>

13764

13765

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

13766

</div>

13767

13768

13769

13770

13771

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

13772

</span>

13773

13774

13775

13776

13777

13778

13779

13780

13781

13782

13783

13784

13785

13786

13787

13788

<p>Inherited from

13789

<a href="../classes/EventTarget.html#method_parseType">EventTarget</a>:

13790

13791

13792

13793

<a href="../files/event-custom_js_event-target.js.html#l172"><code>event-custom/js/event-target.js:172</code></a>

13794

13795

</p>

13796

13797

13798

13799

13800

13801

<p>Available since 3.3.0</p>

13802

13803

</div>

13804

13805

13806

<p>Takes the type parameter passed to 'on' and parses out the

13807

various pieces that could be included in the type. If the

13808

event type is passed without a prefix, it will be expanded

13809

to include the prefix one is supplied or the event target

13810

is configured with a default prefix.</p>

13811

</div>

13812

13813

13814

13815

<h4>Parameters:</h4>

13816

13817

13818

13819

13820

13821

13822

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

13823

13824

13825

13826

13827

13828

13829

</div>

13830

13831

13832

</li>

13833

13834

13835

13836

<code class="param-name optional">[pre=this._yuievt.config.prefix]</code>

13837

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

13838

<span class="flag optional" title="This parameter is optional.">optional</span>

13839

13840

13841

13842

13843

13844

<p>the prefix</p>

13845

</div>

13846

13847

13848

</li>

13849

13850

</ul>

13851

</div>

13852

13853

13854

13855

13856

<h4>Returns:</h4>

13857

13858

13859

13860

13861

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

13862

13863

an array containing:

13864

* the detach category, if supplied,

13865

* the prefixed event type,

13866

* whether or not this is an after listener,

13867

* the supplied event type

13868

13869

</div>

13870

</div>

13871

13872

13873

13874

</div>

13875

13876

13877

13878

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

13879

13880

13881

13882

13883

13884

13885

13886

<code>circular</code>

13887

13888

</li>

13889

13890

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

13891

</div>

13892

13893

13894

13895

13896

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

13897

</span>

13898

13899

13900

13901

13902

13903

13904

13905

13906

13907

13908

13909

13910

13911

13912

13913

<p>Inherited from

13914

<a href="../classes/Widget.html#method_previous">Widget</a>:

13915

13916

13917

13918

<a href="../files/widget-child_js_Widget-Child.js.html#l216"><code>widget-child/js/Widget-Child.js:216</code></a>

13919

13920

</p>

13921

13922

13923

13924

13925

13926

</div>

13927

13928

13929

<p>Returns the Widget's previous sibling.</p>

13930

</div>

13931

13932

13933

13934

<h4>Parameters:</h4>

13935

13936

13937

13938

13939

13940

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

13941

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

13942

13943

13944

13945

13946

13947

<p>Boolean indicating if the parent's last child

13948

should be returned if the child has no previous sibling.</p>

13949

</div>

13950

13951

13952

</li>

13953

13954

</ul>

13955

</div>

13956

13957

13958

13959

13960

<h4>Returns:</h4>

13961

13962

13963

13964

13965

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

13966

13967

Widget instance.

13968

13969

</div>

13970

</div>

13971

13972

13973

13974

</div>

13975

13976

13977

13978

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

13979

13980

13981

13982

13983

13984

13985

13986

13987

13988

</li>

13989

13990

13991

13992

13993

13994

</li>

13995

13996

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

13997

</div>

13998

13999

14000

14001

14002

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

14003

</span>

14004

14005

14006

14007

14008

14009

14010

14011

14012

14013

14014

14015

14016

14017

14018

14019

<p>Inherited from

14020

<a href="../classes/EventTarget.html#method_publish">EventTarget</a>:

14021

14022

14023

14024

<a href="../files/event-custom_js_event-target.js.html#l489"><code>event-custom/js/event-target.js:489</code></a>

14025

14026

</p>

14027

14028

14029

14030

14031

14032

</div>

14033

14034

14035

<p>Creates a new custom event of the specified type. If a custom event

14036

by that name already exists, it will not be re-created. In either

14037

case the custom event is returned.</p>

14038

</div>

14039

14040

14041

14042

<h4>Parameters:</h4>

14043

14044

14045

14046

14047

14048

14049

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

14050

14051

14052

14053

14054

14055

<p>the type, or name of the event</p>

14056

</div>

14057

14058

14059

</li>

14060

14061

14062

14063

14064

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

14065

14066

14067

14068

14069

14070

<p>optional config params. Valid properties are:</p>

14071

14072

<p><ul>

14073

<li>

14074

'broadcast': whether or not the YUI instance and YUI global are notified when the event is fired (false)

14075

</li>

14076

<li>

14077

'bubbles': whether or not this event bubbles (true)

14078

Events can only bubble if emitFacade is true.

14079

</li>

14080

<li>

14081

'context': the default execution context for the listeners (this)

14082

</li>

14083

<li>

14084

'defaultFn': the default function to execute when this event fires if preventDefault was not called

14085

</li>

14086

<li>

14087

'emitFacade': whether or not this event emits a facade (false)

14088

</li>

14089

<li>

14090

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

14091

</li>

14092

<li>

14093

'fireOnce': if an event is configured to fire once, new subscribers after

14094

the fire will be notified immediately.

14095

</li>

14096

<li>

14097

'async': fireOnce event listeners will fire synchronously if the event has already

14098

fired unless async is true.

14099

</li>

14100

<li>

14101

'preventable': whether or not preventDefault() has an effect (true)

14102

</li>

14103

<li>

14104

'preventedFn': a function that is executed when preventDefault is called

14105

</li>

14106

<li>

14107

'queuable': whether or not this event can be queued during bubbling (false)

14108

</li>

14109

<li>

14110

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

14111

</li>

14112

<li>

14113

'stoppedFn': a function that is executed when stopPropagation is called

14114

</li></p>

14115

14116

<p><li>

14117

'monitored': specifies whether or not this event should send notifications about

14118

when the event has been attached, detached, or published.

14119

</li>

14120

<li>

14121

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

14122

</li>

14123

</ul></p>

14124

</div>

14125

14126

14127

</li>

14128

14129

</ul>

14130

</div>

14131

14132

14133

14134

14135

<h4>Returns:</h4>

14136

14137

14138

14139

14140

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

14141

14142

the custom event

14143

14144

</div>

14145

</div>

14146

14147

14148

14149

</div>

14150

14151

14152

14153

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

14154

14155

14156

14157

14158

14159

14160

14161

14162

14163

</li>

14164

14165

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

14166

</div>

14167

14168

14169

14170

14171

14172

14173

14174

14175

14176

14177

14178

14179

14180

14181

14182

14183

14184

<p>Inherited from

14185

<a href="../classes/AttributeExtras.html#method_removeAttr">AttributeExtras</a>:

14186

14187

14188

14189

<a href="../files/attribute_js_AttributeExtras.js.html#l77"><code>attribute/js/AttributeExtras.js:77</code></a>

14190

14191

</p>

14192

14193

14194

14195

14196

14197

</div>

14198

14199

14200

<p>Removes an attribute from the host object</p>

14201

</div>

14202

14203

14204

14205

<h4>Parameters:</h4>

14206

14207

14208

14209

14210

14211

14212

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

14213

14214

14215

14216

14217

14218

<p>The name of the attribute to be removed.</p>

14219

</div>

14220

14221

14222

</li>

14223

14224

</ul>

14225

</div>

14226

14227

14228

14229

14230

14231

</div>

14232

14233

14234

14235

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

14236

14237

14238

14239

14240

14241

14242

14243

14244

14245

</li>

14246

14247

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

14248

</div>

14249

14250

14251

14252

14253

14254

14255

14256

14257

14258

14259

14260

14261

14262

14263

14264

14265

14266

<p>Inherited from

14267

<a href="../classes/EventTarget.html#method_removeTarget">EventTarget</a>:

14268

14269

14270

14271

<a href="../files/event-custom_js_event-facade.js.html#l409"><code>event-custom/js/event-facade.js:409</code></a>

14272

14273

</p>

14274

14275

14276

14277

14278

14279

</div>

14280

14281

14282

<p>Removes a bubble target</p>

14283

</div>

14284

14285

14286

14287

<h4>Parameters:</h4>

14288

14289

14290

14291

14292

14293

14294

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

14295

14296

14297

14298

14299

14300

<p>the target to remove</p>

14301

</div>

14302

14303

14304

</li>

14305

14306

</ul>

14307

</div>

14308

14309

14310

14311

14312

14313

</div>

14314

14315

14316

14317

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

14318

14319

14320

14321

14322

14323

14324

14325

<code>parentNode</code>

14326

14327

</li>

14328

14329

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

14330

</div>

14331

14332

14333

14334

14335

14336

14337

14338

14339

14340

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

14341

14342

14343

14344

14345

14346

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

14347

14348

14349

14350

14351

14352

<p>Inherited from

14353

<a href="../classes/Widget.html#method_render">Widget</a>:

14354

14355

14356

14357

<a href="../files/widget_js_Widget.js.html#l514"><code>widget/js/Widget.js:514</code></a>

14358

14359

</p>

14360

14361

14362

14363

14364

14365

</div>

14366

14367

14368

<p>Establishes the initial DOM for the widget. Invoking this

14369

method will lead to the creating of all DOM elements for

14370

the widget (or the manipulation of existing DOM elements

14371

for the progressive enhancement use case).</p>

14372

14373

<p>

14374

This method should only be invoked once for an initialized

14375

widget.

14376

</p>

14377

14378

<p>

14379

It delegates to the widget specific renderer method to do

14380

the actual work.

14381

</p>

14382

</div>

14383

14384

14385

14386

<h4>Parameters:</h4>

14387

14388

14389

14390

14391

14392

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

14393

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

14394

14395

14396

14397

14398

14399

<p>Optional. The Node under which the

14400

Widget is to be rendered. This can be a Node instance or a CSS selector string. </p>

14401

14402

<p>

14403

If the selector string returns more than one Node, the first node will be used

14404

as the parentNode. NOTE: This argument is required if both the boundingBox and contentBox

14405

are not currently in the document. If it's not provided, the Widget will be rendered

14406

to the body of the current document in this case.

14407

</p>

14408

</div>

14409

14410

14411

</li>

14412

14413

</ul>

14414

</div>

14415

14416

14417

14418

14419

14420

</div>

14421

14422

14423

14424

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

14425

14426

14427

14428

14429

14430

14431

14432

14433

14434

14435

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

14436

14437

14438

14439

14440

14441

14442

14443

14444

14445

14446

14447

<p>Inherited from

14448

<a href="../classes/Widget.html#method_renderer">Widget</a>:

14449

14450

14451

14452

<a href="../files/widget_js_Widget.js.html#l589"><code>widget/js/Widget.js:589</code></a>

14453

14454

</p>

14455

14456

14457

14458

14459

14460

</div>

14461

14462

14463

<p>Creates DOM (or manipulates DOM for progressive enhancement)

14464

This method is invoked by render() and is not chained

14465

automatically for the class hierarchy (unlike initializer, destructor)

14466

so it should be chained manually for subclasses if required.</p>

14467

</div>

14468

14469

14470

14471

14472

14473

14474

</div>

14475

14476

14477

14478

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

14479

14480

14481

14482

14483

14484

14485

14486

14487

14488

14489

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

14490

14491

14492

14493

14494

14495

14496

14497

14498

14499

14500

14501

<p>Inherited from

14502

<a href="../classes/Widget.html#method_renderUI">Widget</a>:

14503

14504

14505

14506

<a href="../files/widget_js_Widget.js.html#l623"><code>widget/js/Widget.js:623</code></a>

14507

14508

</p>

14509

14510

14511

14512

14513

14514

</div>

14515

14516

14517

<p>Adds nodes to the DOM </p>

14518

14519

<p>This method is not called by framework and is not chained

14520

automatically for the class hierarchy.</p>

14521

</div>

14522

14523

14524

14525

14526

14527

14528

</div>

14529

14530

14531

14532

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

14533

14534

14535

14536

14537

14538

14539

14540

14541

14542

</li>

14543

14544

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

14545

</div>

14546

14547

14548

14549

14550

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

14551

</span>

14552

14553

14554

14555

14556

14557

14558

14559

14560

14561

14562

14563

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

14564

14565

14566

14567

14568

14569

<p>Inherited from

14570

<a href="../classes/AttributeExtras.html#method_reset">AttributeExtras</a>:

14571

14572

14573

14574

<a href="../files/attribute_js_AttributeExtras.js.html#l87"><code>attribute/js/AttributeExtras.js:87</code></a>

14575

14576

</p>

14577

14578

14579

14580

14581

14582

</div>

14583

14584

14585

<p>Resets the attribute (or all attributes) to its initial value, as long as

14586

the attribute is not readOnly, or writeOnce.</p>

14587

</div>

14588

14589

14590

14591

<h4>Parameters:</h4>

14592

14593

14594

14595

14596

14597

14598

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

14599

14600

14601

14602

14603

14604

<p>Optional. The name of the attribute to reset. If omitted, all attributes are reset.</p>

14605

</div>

14606

14607

14608

</li>

14609

14610

</ul>

14611

</div>

14612

14613

14614

14615

14616

<h4>Returns:</h4>

14617

14618

14619

14620

14621

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

14622

14623

A reference to the host object.

14624

14625

</div>

14626

</div>

14627

14628

14629

14630

</div>

14631

14632

14633

14634

14635

14636

14637

14638

14639

14640

14641

14642

14643

14644

</li>

14645

14646

14647

14648

<code>value</code>

14649

14650

</li>

14651

14652

14653

14654

14655

14656

</li>

14657

14658

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

14659

</div>

14660

14661

14662

14663

14664

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

14665

</span>

14666

14667

14668

14669

14670

14671

14672

14673

14674

14675

14676

14677

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

14678

14679

14680

14681

14682

<p>Inherited from

14683

14684

AttributeCore

14685

</a>

14686

14687

but overwritten in

14688

14689

14690

14691

<a href="../files/attribute_js_AttributeEvents.js.html#l41"><code>attribute/js/AttributeEvents.js:41</code></a>

14692

14693

</p>

14694

14695

14696

14697

14698

14699

</div>

14700

14701

14702

<p>Sets the value of an attribute.</p>

14703

</div>

14704

14705

14706

14707

<h4>Parameters:</h4>

14708

14709

14710

14711

14712

14713

14714

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

14715

14716

14717

14718

14719

14720

<p>The name of the attribute. If the

14721

current value of the attribute is an Object, dot notation can be used

14722

to set the value of a property within the object (e.g. <code>set("x.y.z", 5)</code>).</p>

14723

</div>

14724

14725

14726

</li>

14727

14728

14729

14730

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

14731

14732

14733

14734

14735

14736

14737

<p>The value to set the attribute to.</p>

14738

</div>

14739

14740

14741

</li>

14742

14743

14744

14745

14746

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

14747

14748

14749

14750

14751

14752

<p>(Optional) Optional event data to be mixed into

14753

the event facade passed to subscribers of the attribute's change event. This

14754

can be used as a flexible way to identify the source of a call to set, allowing

14755

the developer to distinguish between set called internally by the host, vs.

14756

set called externally by the application developer.</p>

14757

</div>

14758

14759

14760

</li>

14761

14762

</ul>

14763

</div>

14764

14765

14766

14767

14768

<h4>Returns:</h4>

14769

14770

14771

14772

14773

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

14774

14775

A reference to the host object.

14776

14777

</div>

14778

</div>

14779

14780

14781

14782

</div>

14783

14784

14785

14786

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

14787

14788

14789

14790

14791

14792

14793

14794

<code>attrs</code>

14795

14796

</li>

14797

14798

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

14799

</div>

14800

14801

14802

14803

14804

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

14805

</span>

14806

14807

14808

14809

14810

14811

14812

14813

14814

14815

14816

14817

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

14818

14819

14820

14821

14822

<p>Inherited from

14823

14824

AttributeCore

14825

</a>

14826

14827

but overwritten in

14828

14829

14830

14831

<a href="../files/attribute_js_AttributeEvents.js.html#l82"><code>attribute/js/AttributeEvents.js:82</code></a>

14832

14833

</p>

14834

14835

14836

14837

14838

14839

</div>

14840

14841

14842

<p>Sets multiple attribute values.</p>

14843

</div>

14844

14845

14846

14847

<h4>Parameters:</h4>

14848

14849

14850

14851

14852

14853

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

14854

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

14855

14856

14857

14858

14859

14860

<p>An object with attributes name/value pairs.</p>

14861

</div>

14862

14863

14864

</li>

14865

14866

</ul>

14867

</div>

14868

14869

14870

14871

14872

<h4>Returns:</h4>

14873

14874

14875

14876

14877

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

14878

14879

A reference to the host object.

14880

14881

</div>

14882

</div>

14883

14884

14885

14886

</div>

14887

14888

14889

14890

14891

14892

14893

14894

14895

14896

14897

14898

14899

14900

14901

14902

14903

14904

14905

14906

14907

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

14908

14909

14910

14911

14912

14913

<p>Inherited from

14914

<a href="../classes/Widget.html#method_show">Widget</a>:

14915

14916

14917

14918

<a href="../files/widget_js_Widget.js.html#l655"><code>widget/js/Widget.js:655</code></a>

14919

14920

</p>

14921

14922

14923

14924

14925

14926

</div>

14927

14928

14929

<p>Shows the Widget by setting the "visible" attribute to "true".</p>

14930

</div>

14931

14932

14933

14934

14935

14936

14937

</div>

14938

14939

14940

14941

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

14942

14943

14944

14945

14946

14947

14948

14949

14950

<span class="flag deprecated" title="use on">deprecated</span>

14951

14952

14953

14954

14955

14956

14957

14958

14959

14960

14961

14962

14963

14964

<p>Inherited from

14965

<a href="../classes/EventTarget.html#method_subscribe">EventTarget</a>:

14966

14967

14968

14969

<a href="../files/event-custom_js_event-target.js.html#l335"><code>event-custom/js/event-target.js:335</code></a>

14970

14971

</p>

14972

14973

14974

14975

<p>Deprecated: use on</p>

14976

14977

14978

14979

</div>

14980

14981

14982

<p>subscribe to an event</p>

14983

</div>

14984

14985

14986

14987

14988

14989

14990

</div>

14991

14992

14993

14994

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

14995

14996

14997

14998

14999

15000

15001

15002

15003

15004

15005

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

15006

15007

15008

15009

15010

15011

15012

15013

15014

15015

15016

15017

<p>Inherited from

15018

<a href="../classes/Widget.html#method_syncUI">Widget</a>:

15019

15020

15021

15022

<a href="../files/widget_js_Widget.js.html#l634"><code>widget/js/Widget.js:634</code></a>

15023

15024

</p>

15025

15026

15027

15028

15029

15030

</div>

15031

15032

15033

<p>Refreshes the rendered UI, based on Widget State</p>

15034

15035

<p>This method is not called by framework and is not chained

15036

automatically for the class hierarchy.</p>

15037

</div>

15038

15039

15040

15041

15042

15043

15044

</div>

15045

15046

15047

15048

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

15049

15050

15051

15052

15053

15054

15055

15056

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

15057

</span>

15058

15059

15060

15061

15062

15063

15064

15065

15066

15067

15068

15069

15070

15071

15072

<p>Inherited from

15073

15074

BaseCore

15075

</a>

15076

15077

but overwritten in

15078

15079

15080

15081

<a href="../files/widget_js_Widget.js.html#l1083"><code>widget/js/Widget.js:1083</code></a>

15082

15083

</p>

15084

15085

15086

15087

15088

15089

</div>

15090

15091

15092

<p>Generic toString implementation for all widgets.</p>

15093

</div>

15094

15095

15096

15097

15098

15099

<h4>Returns:</h4>

15100

15101

15102

15103

15104

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

15105

15106

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

15107

15108

</div>

15109

</div>

15110

15111

15112

15113

</div>

15114

15115

15116

15117

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

15118

15119

15120

15121

15122

15123

15124

15125

15126

<span class="flag deprecated" title="use detach">deprecated</span>

15127

15128

15129

15130

15131

15132

15133

15134

15135

15136

15137

15138

15139

15140

<p>Inherited from

15141

<a href="../classes/EventTarget.html#method_unsubscribe">EventTarget</a>:

15142

15143

15144

15145

<a href="../files/event-custom_js_event-target.js.html#l455"><code>event-custom/js/event-target.js:455</code></a>

15146

15147

</p>

15148

15149

15150

15151

<p>Deprecated: use detach</p>

15152

15153

15154

15155

</div>

15156

15157

15158

<p>detach a listener</p>

15159

</div>

15160

15161

15162

15163

15164

15165

15166

</div>

15167

15168

15169

15170

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

15171

15172

15173

15174

15175

15176

15177

15178

15179

15180

</li>

15181

15182

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

15183

</div>

15184

15185

15186

15187

15188

15189

<span class="flag deprecated" title="use detachAll">deprecated</span>

15190

15191

15192

15193

15194

15195

15196

15197

15198

15199

15200

15201

15202

15203

<p>Inherited from

15204

<a href="../classes/EventTarget.html#method_unsubscribeAll">EventTarget</a>:

15205

15206

15207

15208

<a href="../files/event-custom_js_event-target.js.html#l476"><code>event-custom/js/event-target.js:476</code></a>

15209

15210

</p>

15211

15212

15213

15214

<p>Deprecated: use detachAll</p>

15215

15216

15217

15218

</div>

15219

15220

15221

<p>Removes all listeners from the specified event. If the event type

15222

is not specified, all listeners from all hosted custom events will

15223

be removed.</p>

15224

</div>

15225

15226

15227

15228

<h4>Parameters:</h4>

15229

15230

15231

15232

15233

15234

15235

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

15236

15237

15238

15239

15240

15241

<p>The type, or name of the event</p>

15242

</div>

15243

15244

15245

</li>

15246

15247

</ul>

15248

</div>

15249

15250

15251

15252

15253

15254

</div>

15255

15256

15257

</div>

15258

15259

15260

15261

15262

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

15263

15264

15265

15266

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

15267

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

15268

15269

15270

15271

15272

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

15273

15274

15275

15276

15277

15278

15279

15280

15281

15282

<p>Inherited from

15283

<a href="../classes/BaseCore.html#property__allowAdHocAttrs">BaseCore</a>:

15284

15285

15286

15287

<a href="../files/base_js_BaseCore.js.html#l100"><code>base/js/BaseCore.js:100</code></a>

15288

15289

</p>

15290

15291

15292

15293

15294

</div>

15295

15296

15297

<p>This property controls whether or not instances of this class should

15298

allow users to add ad-hoc attributes through the constructor configuration

15299

hash.</p>

15300

15301

<p>AdHoc attributes are attributes which are not defined by the class, and are

15302

not handled by the MyClass.<em>NON</em>ATTRS_CFG</p>

15303

</div>

15304

15305

15306

<p><strong>Default:</strong> undefined (false)</p>

15307

15308

15309

15310

15311

15312

</div>

15313

15314

15315

15316

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

15317

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

15318

15319

15320

15321

15322

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

15323

15324

15325

15326

15327

15328

15329

15330

15331

15332

<p>Inherited from

15333

<a href="../classes/Widget.html#property__UI_ATTRS">Widget</a>:

15334

15335

15336

15337

<a href="../files/widget_js_Widget.js.html#l1225"><code>widget/js/Widget.js:1225</code></a>

15338

15339

</p>

15340

15341

15342

15343

15344

</div>

15345

15346

15347

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

15348

</div>

15349

15350

15351

15352

15353

15354

15355

</div>

15356

15357

15358

15359

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

15360

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

15361

15362

15363

15364

15365

15366

15367

15368

15369

15370

15371

15372

15373

<p>Inherited from

15374

<a href="../classes/Widget.html#property_BOUNDING_TEMPLATE">Widget</a>:

15375

15376

15377

15378

<a href="../files/widget_js_Widget.js.html#l1121"><code>widget/js/Widget.js:1121</code></a>

15379

15380

</p>

15381

15382

15383

15384

15385

</div>

15386

15387

15388

<p>Property defining the markup template for bounding box.</p>

15389

</div>

15390

15391

15392

15393

15394

15395

15396

</div>

15397

15398

15399

15400

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

15401

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

15402

15403

15404

15405

15406

15407

15408

15409

15410

15411

15412

15413

15414

<p>Inherited from

15415

<a href="../classes/Widget.html#property_CONTENT_TEMPLATE">Widget</a>:

15416

15417

15418

15419

<a href="../files/widget_js_Widget.js.html#l1111"><code>widget/js/Widget.js:1111</code></a>

15420

15421

</p>

15422

15423

15424

15425

15426

</div>

15427

15428

15429

<p>Property defining the markup template for content box. If your Widget doesn't

15430

need the dual boundingBox/contentBox structure, set CONTENT_TEMPLATE to null,

15431

and contentBox and boundingBox will both point to the same Node.</p>

15432

</div>

15433

15434

15435

15436

15437

15438

15439

</div>

15440

15441

15442

15443

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

15444

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

15445

15446

15447

15448

15449

15450

15451

15452

15453

15454

15455

15456

15457

<p>Inherited from

15458

<a href="../classes/Widget.html#property_DEF_PARENT_NODE">Widget</a>:

15459

15460

15461

15462

<a href="../files/widget_js_Widget.js.html#l1102"><code>widget/js/Widget.js:1102</code></a>

15463

15464

</p>

15465

15466

15467

15468

15469

</div>

15470

15471

15472

<p>Default node to render the bounding box to. If not set,

15473

will default to the current document body.</p>

15474

</div>

15475

15476

15477

15478

15479

15480

15481

</div>

15482

15483

15484

15485

15486

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

15487

15488

15489

15490

15491

15492

15493

15494

15495

15496

15497

15498

15499

<p>Inherited from

15500

<a href="../classes/Widget.html#property_DEF_UNIT">Widget</a>:

15501

15502

15503

15504

<a href="../files/widget_js_Widget.js.html#l1094"><code>widget/js/Widget.js:1094</code></a>

15505

15506

</p>

15507

15508

15509

15510

15511

</div>

15512

15513

15514

<p>Default unit to use for dimension values</p>

15515

</div>

15516

15517

15518

15519

15520

15521

15522

</div>

15523

15524

15525

15526

15527

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

15528

15529

15530

<span class="flag deprecated" title="Use this.constructor.NAME">deprecated</span>

15531

15532

15533

15534

15535

15536

15537

15538

15539

15540

15541

15542

<p>Inherited from

15543

<a href="../classes/BaseCore.html#property_name">BaseCore</a>:

15544

15545

15546

15547

<a href="../files/base_js_BaseCore.js.html#l196"><code>base/js/BaseCore.js:196</code></a>

15548

15549

</p>

15550

15551

15552

<p>Deprecated: Use this.constructor.NAME</p>

15553

15554

15555

15556

</div>

15557

15558

15559

<p>The string used to identify the class of this object.</p>

15560

</div>

15561

15562

15563

15564

15565

15566

15567

</div>

15568

15569

15570

15571

15572

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

15573

15574

15575

15576

15577

15578

15579

15580

15581

15582

15583

15584

15585

<p>Inherited from

15586

<a href="../classes/WidgetChild.html#property_ROOT_TYPE">WidgetChild</a>:

15587

15588

15589

15590

<a href="../files/widget-child_js_Widget-Child.js.html#l152"><code>widget-child/js/Widget-Child.js:152</code></a>

15591

15592

</p>

15593

15594

15595

15596

15597

</div>

15598

15599

15600

<p>Constructor reference used to determine the root of a Widget-based

15601

object tree.</p>

15602

15603

<p>

15604

Currently used to control the behavior of the <code>root</code>

15605

attribute so that recursing up the object heirarchy can be constrained

15606

to a specific type of Widget. Widget authors should set this property

15607

to the constructor function for a given Widget implementation.

15608

</p>

15609

</div>

15610

15611

15612

15613

15614

15615

15616

</div>

15617

15618

15619

15620

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

15621

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

15622

15623

15624

15625

15626

15627

15628

15629

15630

15631

15632

15633

15634

<p>Inherited from

15635

<a href="../classes/Widget.html#property_UI_EVENTS">Widget</a>:

15636

15637

15638

15639

<a href="../files/widget_js_WidgetUIEvents.js.html#l52"><code>widget/js/WidgetUIEvents.js:52</code></a>

15640

15641

</p>

15642

15643

15644

15645

15646

</div>

15647

15648

15649

<p>Map of DOM events that should be fired as Custom Events by the

15650

Widget instance.</p>

15651

</div>

15652

15653

15654

15655

15656

15657

15658

</div>

15659

15660

15661

</div>

15662

15663

15664

15665

15666

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

15667

15668

15669

15670

15671

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

15672

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

15673

15674

15675

15676

15677

15678

15679

15680

15681

15682

15683

15684

15685

<p>Inherited from

15686

<a href="../classes/Widget.html#attr_boundingBox">Widget</a>:

15687

15688

15689

15690

<a href="../files/widget_js_Widget.js.html#l175"><code>widget/js/Widget.js:175</code></a>

15691

15692

</p>

15693

15694

15695

15696

15697

</div>

15698

15699

15700

<p>The outermost DOM node for the Widget, used for sizing and positioning

15701

of a Widget as well as a containing element for any decorator elements used

15702

for skinning.</p>

15703

</div>

15704

15705

15706

15707

15708

15709

<h4>Fires event <code>boundingBoxChange</code></h4>

15710

15711

<p>

15712

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

15713

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

15714

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

15715

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

15716

attribute's value has changed.

15717

</p>

15718

15719

15720

<h4>Parameters:</h4>

15721

15722

15723

15724

15725

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

15726

15727

15728

An Event Facade object with the following

15729

attribute-specific properties added:

15730

</div>

15731

15732

15733

15734

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

15735

15736

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

15737

</li>

15738

15739

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

15740

15741

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

15742

</li>

15743

15744

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

15745

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

15746

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

15747

</li>

15748

15749

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

15750

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

15751

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

15752

</li>

15753

</ul>

15754

</li>

15755

</ul>

15756

</div>

15757

</div>

15758

15759

15760

15761

</div>

15762

15763

15764

15765

15766

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

15767

15768

15769

15770

15771

15772

15773

15774

15775

15776

15777

15778

15779

15780

15781

<p>

15782

15783

Defined in

15784

15785

15786

15787

15788

<a href="../files/tabview_js_tab.js.html#l173"><code>tabview/js/tab.js:173</code></a>

15789

15790

</p>

15791

15792

15793

15794

15795

</div>

15796

15797

15798

15799

</div>

15800

15801

15802

15803

15804

15805

<h4>Fires event <code>contentChange</code></h4>

15806

15807

<p>

15808

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

15809

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

15810

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

15811

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

15812

attribute's value has changed.

15813

</p>

15814

15815

15816

<h4>Parameters:</h4>

15817

15818

15819

15820

15821

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

15822

15823

15824

An Event Facade object with the following

15825

attribute-specific properties added:

15826

</div>

15827

15828

15829

15830

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

15831

15832

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

15833

</li>

15834

15835

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

15836

15837

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

15838

</li>

15839

15840

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

15841

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

15842

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

15843

</li>

15844

15845

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

15846

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

15847

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

15848

</li>

15849

</ul>

15850

</li>

15851

</ul>

15852

</div>

15853

</div>

15854

15855

15856

15857

</div>

15858

15859

15860

15861

15862

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

15863

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

15864

15865

15866

15867

15868

15869

15870

15871

15872

15873

15874

15875

15876

<p>Inherited from

15877

<a href="../classes/Widget.html#attr_contentBox">Widget</a>:

15878

15879

15880

15881

<a href="../files/widget_js_Widget.js.html#l189"><code>widget/js/Widget.js:189</code></a>

15882

15883

</p>

15884

15885

15886

15887

15888

</div>

15889

15890

15891

<p>A DOM node that is a direct descendant of a Widget's bounding box that

15892

houses its content.</p>

15893

</div>

15894

15895

15896

15897

15898

15899

<h4>Fires event <code>contentBoxChange</code></h4>

15900

15901

<p>

15902

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

15903

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

15904

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

15905

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

15906

attribute's value has changed.

15907

</p>

15908

15909

15910

<h4>Parameters:</h4>

15911

15912

15913

15914

15915

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

15916

15917

15918

An Event Facade object with the following

15919

attribute-specific properties added:

15920

</div>

15921

15922

15923

15924

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

15925

15926

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

15927

</li>

15928

15929

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

15930

15931

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

15932

</li>

15933

15934

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

15935

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

15936

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

15937

</li>

15938

15939

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

15940

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

15941

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

15942

</li>

15943

</ul>

15944

</li>

15945

</ul>

15946

</div>

15947

</div>

15948

15949

15950

15951

</div>

15952

15953

15954

15955

15956

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

15957

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

15958

15959

15960

15961

15962

15963

15964

15965

15966

15967

15968

15969

15970

<p>Inherited from

15971

<a href="../classes/WidgetChild.html#attr_depth">WidgetChild</a>:

15972

15973

15974

15975

<a href="../files/widget-child_js_Widget-Child.js.html#l82"><code>widget-child/js/Widget-Child.js:82</code></a>

15976

15977

</p>

15978

15979

15980

15981

15982

</div>

15983

15984

15985

<p>Number representing the depth of this Widget relative to

15986

the root Widget in the object heirarchy.</p>

15987

</div>

15988

15989

15990

<p><strong>Default:</strong> -1</p>

15991

15992

15993

15994

15995

<h4>Fires event <code>depthChange</code></h4>

15996

15997

<p>

15998

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

15999

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

16000

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

16001

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

16002

attribute's value has changed.

16003

</p>

16004

16005

16006

<h4>Parameters:</h4>

16007

16008

16009

16010

16011

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

16012

16013

16014

An Event Facade object with the following

16015

attribute-specific properties added:

16016

</div>

16017

16018

16019

16020

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

16021

16022

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

16023

</li>

16024

16025

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

16026

16027

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

16028

</li>

16029

16030

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

16031

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

16032

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

16033

</li>

16034

16035

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

16036

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

16037

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

16038

</li>

16039

</ul>

16040

</li>

16041

</ul>

16042

</div>

16043

</div>

16044

16045

16046

16047

</div>

16048

16049

16050

16051

16052

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

16053

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

16054

16055

16056

16057

16058

16059

16060

16061

16062

16063

16064

16065

16066

<p>Inherited from

16067

<a href="../classes/BaseCore.html#attr_destroyed">BaseCore</a>:

16068

16069

16070

16071

<a href="../files/base_js_BaseCore.js.html#l157"><code>base/js/BaseCore.js:157</code></a>

16072

16073

</p>

16074

16075

16076

16077

16078

</div>

16079

16080

16081

<p>Flag indicating whether or not this object

16082

has been through the destroy lifecycle phase.</p>

16083

</div>

16084

16085

16086

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

16087

16088

16089

16090

16091

<h4>Fires event <code>destroyedChange</code></h4>

16092

16093

<p>

16094

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

16095

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

16096

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

16097

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

16098

attribute's value has changed.

16099

</p>

16100

16101

16102

<h4>Parameters:</h4>

16103

16104

16105

16106

16107

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

16108

16109

16110

An Event Facade object with the following

16111

attribute-specific properties added:

16112

</div>

16113

16114

16115

16116

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

16117

16118

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

16119

</li>

16120

16121

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

16122

16123

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

16124

</li>

16125

16126

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

16127

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

16128

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

16129

</li>

16130

16131

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

16132

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

16133

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

16134

</li>

16135

</ul>

16136

</li>

16137

</ul>

16138

</div>

16139

</div>

16140

16141

16142

16143

</div>

16144

16145

16146

16147

16148

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

16149

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

16150

16151

16152

16153

16154

16155

16156

16157

16158

16159

16160

16161

16162

<p>Inherited from

16163

<a href="../classes/Widget.html#attr_disabled">Widget</a>:

16164

16165

16166

16167

<a href="../files/widget_js_Widget.js.html#l231"><code>widget/js/Widget.js:231</code></a>

16168

16169

</p>

16170

16171

16172

16173

16174

</div>

16175

16176

16177

<p>Boolean indicating if the Widget should be disabled. The disabled implementation

16178

is left to the specific classes extending widget.</p>

16179

</div>

16180

16181

16182

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

16183

16184

16185

16186

16187

<h4>Fires event <code>disabledChange</code></h4>

16188

16189

<p>

16190

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

16191

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

16192

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

16193

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

16194

attribute's value has changed.

16195

</p>

16196

16197

16198

<h4>Parameters:</h4>

16199

16200

16201

16202

16203

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

16204

16205

16206

An Event Facade object with the following

16207

attribute-specific properties added:

16208

</div>

16209

16210

16211

16212

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

16213

16214

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

16215

</li>

16216

16217

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

16218

16219

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

16220

</li>

16221

16222

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

16223

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

16224

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

16225

</li>

16226

16227

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

16228

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

16229

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

16230

</li>

16231

</ul>

16232

</li>

16233

</ul>

16234

</div>

16235

</div>

16236

16237

16238

16239

</div>

16240

16241

16242

16243

16244

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

16245

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

16246

16247

16248

16249

16250

16251

16252

16253

16254

16255

16256

16257

16258

<p>Inherited from

16259

<a href="../classes/Widget.html#attr_focused">Widget</a>:

16260

16261

16262

16263

<a href="../files/widget_js_Widget.js.html#l218"><code>widget/js/Widget.js:218</code></a>

16264

16265

</p>

16266

16267

16268

16269

16270

</div>

16271

16272

16273

<p>Boolean indicating if the Widget, or one of its descendants,

16274

has focus.</p>

16275

</div>

16276

16277

16278

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

16279

16280

16281

16282

16283

<h4>Fires event <code>focusedChange</code></h4>

16284

16285

<p>

16286

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

16287

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

16288

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

16289

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

16290

attribute's value has changed.

16291

</p>

16292

16293

16294

<h4>Parameters:</h4>

16295

16296

16297

16298

16299

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

16300

16301

16302

An Event Facade object with the following

16303

attribute-specific properties added:

16304

</div>

16305

16306

16307

16308

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

16309

16310

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

16311

</li>

16312

16313

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

16314

16315

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

16316

</li>

16317

16318

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

16319

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

16320

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

16321

</li>

16322

16323

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

16324

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

16325

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

16326

</li>

16327

</ul>

16328

</li>

16329

</ul>

16330

</div>

16331

</div>

16332

16333

16334

16335

</div>

16336

16337

16338

16339

16340

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

16341

16342

16343

16344

16345

16346

16347

16348

16349

16350

16351

16352

16353

16354

<p>Inherited from

16355

<a href="../classes/Widget.html#attr_height">Widget</a>:

16356

16357

16358

16359

<a href="../files/widget_js_Widget.js.html#l252"><code>widget/js/Widget.js:252</code></a>

16360

16361

</p>

16362

16363

16364

16365

16366

</div>

16367

16368

16369

<p>String with units, or number, representing the height of the Widget. If a number is provided,

16370

the default unit, defined by the Widgets DEF_UNIT, property is used.</p>

16371

</div>

16372

16373

16374

<p><strong>Default:</strong> EMPTY_STR</p>

16375

16376

16377

16378

16379

<h4>Fires event <code>heightChange</code></h4>

16380

16381

<p>

16382

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

16383

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

16384

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

16385

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

16386

attribute's value has changed.

16387

</p>

16388

16389

16390

<h4>Parameters:</h4>

16391

16392

16393

16394

16395

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

16396

16397

16398

An Event Facade object with the following

16399

attribute-specific properties added:

16400

</div>

16401

16402

16403

16404

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

16405

16406

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

16407

</li>

16408

16409

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

16410

16411

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

16412

</li>

16413

16414

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

16415

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

16416

<div class="param-description">The name of the attribute being set.</div>

16417

</li>

16418

16419

<code class="param-name">subAttrName</code>

16420

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

16421

<div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div>

16422

</li>

16423

</ul>

16424

</li>

16425

</ul>

16426

</div>

16427

</div>

16428

16429

16430

16431

</div>

16432

16433

16434

16435

16436

16437

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

16438

16439

16440

16441

16442

16443

16444

16445

16446

16447

16448

16449

16450

<p>Inherited from

16451

<a href="../classes/Widget.html#attr_id">Widget</a>:

16452

16453

16454

16455

<a href="../files/widget_js_Widget.js.html#l149"><code>widget/js/Widget.js:149</code></a>

16456

16457

</p>

16458

16459

16460

16461

16462

</div>

16463

16464

16465

16466

</div>

16467

16468

16469

<p><strong>Default:</strong> Generated using guid()</p>

16470

16471

16472

16473

16474

<h4>Fires event <code>idChange</code></h4>

16475

16476

<p>

16477

Fires when the value for the configuration attribute <code>id</code> is

16478

changed. You can listen for the event using the <code>on</code> method if you

16479

wish to be notified before the attribute's value has changed, or

16480

using the <code>after</code> method if you wish to be notified after the

16481

attribute's value has changed.

16482

</p>

16483

16484

16485

<h4>Parameters:</h4>

16486

16487

16488

16489

16490

<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>

16491

16492

16493

An Event Facade object with the following

16494

attribute-specific properties added:

16495

</div>

16496

16497

16498

16499

<code class="param-name">prevVal</code>

16500

16501

<div class="param-description">The value of the attribute, prior to it being set.</div>

16502

</li>

16503

16504

<code class="param-name">newVal</code>

16505

16506

<div class="param-description">The value the attribute is to be set to.</div>

16507

</li>

16508

16509

<code class="param-name">attrName</code>

16510

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

16511

<div class="param-description">The name of the attribute being set.</div>

16512

</li>

16513

16514

<code class="param-name">subAttrName</code>

16515

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

16516

<div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div>

16517

</li>

16518

</ul>

16519

</li>

16520

</ul>

16521

</div>

16522

</div>

16523

16524

16525

16526

</div>

16527

16528

16529

16530

16531

<h3 class="name"><code>index</code></h3>

16532

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Number" class="crosslink external" target="_blank">Number</a></span>

16533

16534

16535

16536

16537

16538

16539

16540

16541

16542

16543

16544

16545

<p>Inherited from

16546

<a href="../classes/WidgetChild.html#attr_index">WidgetChild</a>:

16547

16548

16549

16550

<a href="../files/widget-child_js_Widget-Child.js.html#l45"><code>widget-child/js/Widget-Child.js:45</code></a>

16551

16552

</p>

16553

16554

16555

16556

16557

</div>

16558

16559

16560

<p>Number representing the Widget's ordinal position in its

16561

parent Widget.</p>

16562

</div>

16563

16564

16565

16566

16567

16568

<h4>Fires event <code>indexChange</code></h4>

16569

16570

<p>

16571

Fires when the value for the configuration attribute <code>index</code> is

16572

changed. You can listen for the event using the <code>on</code> method if you

16573

wish to be notified before the attribute's value has changed, or

16574

using the <code>after</code> method if you wish to be notified after the

16575

attribute's value has changed.

16576

</p>

16577

16578

16579

<h4>Parameters:</h4>

16580

16581

16582

16583

16584

<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>

16585

16586

16587

An Event Facade object with the following

16588

attribute-specific properties added:

16589

</div>

16590

16591

16592

16593

<code class="param-name">prevVal</code>

16594

16595

<div class="param-description">The value of the attribute, prior to it being set.</div>

16596

</li>

16597

16598

<code class="param-name">newVal</code>

16599

16600

<div class="param-description">The value the attribute is to be set to.</div>

16601

</li>

16602

16603

<code class="param-name">attrName</code>

16604

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

16605

<div class="param-description">The name of the attribute being set.</div>

16606

</li>

16607

16608

<code class="param-name">subAttrName</code>

16609

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

16610

<div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div>

16611

</li>

16612

</ul>

16613

</li>

16614

</ul>

16615

</div>

16616

</div>

16617

16618

16619

16620

</div>

16621

16622

16623

16624

16625

<h3 class="name"><code>initialized</code></h3>

16626

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>

16627

16628

16629

16630

16631

16632

16633

16634

16635

16636

16637

16638

16639

<p>Inherited from

16640

<a href="../classes/BaseCore.html#attr_initialized">BaseCore</a>:

16641

16642

16643

16644

<a href="../files/base_js_BaseCore.js.html#l143"><code>base/js/BaseCore.js:143</code></a>

16645

16646

</p>

16647

16648

16649

16650

16651

</div>

16652

16653

16654

<p>Flag indicating whether or not this object

16655

has been through the init lifecycle phase.</p>

16656

</div>

16657

16658

16659

<p><strong>Default:</strong> false</p>

16660

16661

16662

16663

16664

<h4>Fires event <code>initializedChange</code></h4>

16665

16666

<p>

16667

Fires when the value for the configuration attribute <code>initialized</code> is

16668

changed. You can listen for the event using the <code>on</code> method if you

16669

wish to be notified before the attribute's value has changed, or

16670

using the <code>after</code> method if you wish to be notified after the

16671

attribute's value has changed.

16672

</p>

16673

16674

16675

<h4>Parameters:</h4>

16676

16677

16678

16679

16680

<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>

16681

16682

16683

An Event Facade object with the following

16684

attribute-specific properties added:

16685

</div>

16686

16687

16688

16689

<code class="param-name">prevVal</code>

16690

16691

<div class="param-description">The value of the attribute, prior to it being set.</div>

16692

</li>

16693

16694

<code class="param-name">newVal</code>

16695

16696

<div class="param-description">The value the attribute is to be set to.</div>

16697

</li>

16698

16699

<code class="param-name">attrName</code>

16700

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

16701

<div class="param-description">The name of the attribute being set.</div>

16702

</li>

16703

16704

<code class="param-name">subAttrName</code>

16705

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

16706

<div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div>

16707

</li>

16708

</ul>

16709

</li>

16710

</ul>

16711

</div>

16712

</div>

16713

16714

16715

16716

</div>

16717

16718

16719

16720

16721

<h3 class="name"><code>label</code></h3>

16722

16723

16724

16725

16726

16727

16728

16729

16730

16731

16732

16733

16734

16735

16736

<p>

16737

16738

Defined in

16739

16740

16741

16742

16743

<a href="../files/tabview_js_tab.js.html#l164"><code>tabview/js/tab.js:164</code></a>

16744

16745

</p>

16746

16747

16748

16749

16750

</div>

16751

16752

16753

16754

</div>

16755

16756

16757

16758

16759

16760

<h4>Fires event <code>labelChange</code></h4>

16761

16762

<p>

16763

Fires when the value for the configuration attribute <code>label</code> is

16764

changed. You can listen for the event using the <code>on</code> method if you

16765

wish to be notified before the attribute's value has changed, or

16766

using the <code>after</code> method if you wish to be notified after the

16767

attribute's value has changed.

16768

</p>

16769

16770

16771

<h4>Parameters:</h4>

16772

16773

16774

16775

16776

<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>

16777

16778

16779

An Event Facade object with the following

16780

attribute-specific properties added:

16781

</div>

16782

16783

16784

16785

<code class="param-name">prevVal</code>

16786

16787

<div class="param-description">The value of the attribute, prior to it being set.</div>

16788

</li>

16789

16790

<code class="param-name">newVal</code>

16791

16792

<div class="param-description">The value the attribute is to be set to.</div>

16793

</li>

16794

16795

<code class="param-name">attrName</code>

16796

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

16797

<div class="param-description">The name of the attribute being set.</div>

16798

</li>

16799

16800

<code class="param-name">subAttrName</code>

16801

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

16802

<div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div>

16803

</li>

16804

</ul>

16805

</li>

16806

</ul>

16807

</div>

16808

</div>

16809

16810

16811

16812

</div>

16813

16814

16815

16816

16817

<h3 class="name"><code>locale</code></h3>

16818

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

16819

16820

16821

<span class="flag deprecated" title="Use Y.config.lang and Y.Intl externalization support">deprecated</span>

16822

16823

16824

16825

16826

16827

16828

16829

16830

16831

16832

16833

<p>Inherited from

16834

<a href="../classes/Widget.html#attr_locale">Widget</a>:

16835

16836

16837

16838

<a href="../files/widget_js_WidgetLocale.js.html#l14"><code>widget/js/WidgetLocale.js:14</code></a>

16839

16840

</p>

16841

16842

16843

<p>Deprecated: Use Y.config.lang and Y.Intl externalization support</p>

16844

16845

16846

16847

</div>

16848

16849

16850

<p>The default locale for the widget. NOTE: Using get/set on the "strings" attribute will

16851

return/set strings for this locale.</p>

16852

</div>

16853

16854

16855

<p><strong>Default:</strong> "en"</p>

16856

16857

16858

16859

16860

<h4>Fires event <code>localeChange</code></h4>

16861

16862

<p>

16863

Fires when the value for the configuration attribute <code>locale</code> is

16864

changed. You can listen for the event using the <code>on</code> method if you

16865

wish to be notified before the attribute's value has changed, or

16866

using the <code>after</code> method if you wish to be notified after the

16867

attribute's value has changed.

16868

</p>

16869

16870

16871

<h4>Parameters:</h4>

16872

16873

16874

16875

16876

<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>

16877

16878

16879

An Event Facade object with the following

16880

attribute-specific properties added:

16881

</div>

16882

16883

16884

16885

<code class="param-name">prevVal</code>

16886

16887

<div class="param-description">The value of the attribute, prior to it being set.</div>

16888

</li>

16889

16890

<code class="param-name">newVal</code>

16891

16892

<div class="param-description">The value the attribute is to be set to.</div>

16893

</li>

16894

16895

<code class="param-name">attrName</code>

16896

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

16897

<div class="param-description">The name of the attribute being set.</div>

16898

</li>

16899

16900

<code class="param-name">subAttrName</code>

16901

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

16902

<div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div>

16903

</li>

16904

</ul>

16905

</li>

16906

</ul>

16907

</div>

16908

</div>

16909

16910

16911

16912

</div>

16913

16914

16915

16916

16917

<h3 class="name"><code>panelNode</code></h3>

16918

16919

16920

16921

16922

16923

16924

16925

16926

16927

16928

16929

16930

16931

16932

<p>

16933

16934

Defined in

16935

16936

16937

16938

16939

<a href="../files/tabview_js_tab.js.html#l182"><code>tabview/js/tab.js:182</code></a>

16940

16941

</p>

16942

16943

16944

16945

16946

</div>

16947

16948

16949

16950

</div>

16951

16952

16953

16954

16955

16956

<h4>Fires event <code>panelNodeChange</code></h4>

16957

16958

<p>

16959

Fires when the value for the configuration attribute <code>panelNode</code> is

16960

changed. You can listen for the event using the <code>on</code> method if you

16961

wish to be notified before the attribute's value has changed, or

16962

using the <code>after</code> method if you wish to be notified after the

16963

attribute's value has changed.

16964

</p>

16965

16966

16967

<h4>Parameters:</h4>

16968

16969

16970

16971

16972

<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>

16973

16974

16975

An Event Facade object with the following

16976

attribute-specific properties added:

16977

</div>

16978

16979

16980

16981

<code class="param-name">prevVal</code>

16982

16983

<div class="param-description">The value of the attribute, prior to it being set.</div>

16984

</li>

16985

16986

<code class="param-name">newVal</code>

16987

16988

<div class="param-description">The value the attribute is to be set to.</div>

16989

</li>

16990

16991

<code class="param-name">attrName</code>

16992

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

16993

<div class="param-description">The name of the attribute being set.</div>

16994

</li>

16995

16996

<code class="param-name">subAttrName</code>

16997

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

16998

<div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div>

16999

</li>

17000

</ul>

17001

</li>

17002

</ul>

17003

</div>

17004

</div>

17005

17006

17007

17008

</div>

17009

17010

17011

17012

17013

<h3 class="name"><code>parent</code></h3>

17014

<span class="type"><a href="../classes/Widget.html" class="crosslink">Widget</a></span>

17015

17016

17017

17018

17019

17020

17021

17022

17023

17024

17025

17026

17027

<p>Inherited from

17028

<a href="../classes/WidgetChild.html#attr_parent">WidgetChild</a>:

17029

17030

17031

17032

<a href="../files/widget-child_js_Widget-Child.js.html#l70"><code>widget-child/js/Widget-Child.js:70</code></a>

17033

17034

</p>

17035

17036

17037

17038

17039

</div>

17040

17041

17042

<p>Retrieves the parent of the Widget in the object hierarchy.</p>

17043

</div>

17044

17045

17046

17047

17048

17049

<h4>Fires event <code>parentChange</code></h4>

17050

17051

<p>

17052

Fires when the value for the configuration attribute <code>parent</code> is

17053

changed. You can listen for the event using the <code>on</code> method if you

17054

wish to be notified before the attribute's value has changed, or

17055

using the <code>after</code> method if you wish to be notified after the

17056

attribute's value has changed.

17057

</p>

17058

17059

17060

<h4>Parameters:</h4>

17061

17062

17063

17064

17065

<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>

17066

17067

17068

An Event Facade object with the following

17069

attribute-specific properties added:

17070

</div>

17071

17072

17073

17074

<code class="param-name">prevVal</code>

17075

17076

<div class="param-description">The value of the attribute, prior to it being set.</div>

17077

</li>

17078

17079

<code class="param-name">newVal</code>

17080

17081

<div class="param-description">The value the attribute is to be set to.</div>

17082

</li>

17083

17084

<code class="param-name">attrName</code>

17085

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

17086

<div class="param-description">The name of the attribute being set.</div>

17087

</li>

17088

17089

<code class="param-name">subAttrName</code>

17090

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

17091

<div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div>

17092

</li>

17093

</ul>

17094

</li>

17095

</ul>

17096

</div>

17097

</div>

17098

17099

17100

17101

</div>

17102

17103

17104

17105

17106

<h3 class="name"><code>render</code></h3>

17107

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a> | <a href="../classes/Node.html" class="crosslink">Node</a></span>

17108

17109

17110

17111

17112

17113

17114

17115

17116

17117

17118

17119

17120

<p>Inherited from

17121

<a href="../classes/Widget.html#attr_render">Widget</a>:

17122

17123

17124

17125

<a href="../files/widget_js_Widget.js.html#l286"><code>widget/js/Widget.js:286</code></a>

17126

17127

</p>

17128

17129

17130

17131

17132

</div>

17133

17134

17135

<p>Whether or not to render the widget automatically after init, and optionally, to which parent node.</p>

17136

</div>

17137

17138

17139

17140

17141

17142

<h4>Fires event <code>renderChange</code></h4>

17143

17144

<p>

17145

Fires when the value for the configuration attribute <code>render</code> is

17146

changed. You can listen for the event using the <code>on</code> method if you

17147

wish to be notified before the attribute's value has changed, or

17148

using the <code>after</code> method if you wish to be notified after the

17149

attribute's value has changed.

17150

</p>

17151

17152

17153

<h4>Parameters:</h4>

17154

17155

17156

17157

17158

<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>

17159

17160

17161

An Event Facade object with the following

17162

attribute-specific properties added:

17163

</div>

17164

17165

17166

17167

<code class="param-name">prevVal</code>

17168

17169

<div class="param-description">The value of the attribute, prior to it being set.</div>

17170

</li>

17171

17172

<code class="param-name">newVal</code>

17173

17174

<div class="param-description">The value the attribute is to be set to.</div>

17175

</li>

17176

17177

<code class="param-name">attrName</code>

17178

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

17179

<div class="param-description">The name of the attribute being set.</div>

17180

</li>

17181

17182

<code class="param-name">subAttrName</code>

17183

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

17184

<div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div>

17185

</li>

17186

</ul>

17187

</li>

17188

</ul>

17189

</div>

17190

</div>

17191

17192

17193

17194

</div>

17195

17196

17197

17198

17199

<h3 class="name"><code>rendered</code></h3>

17200

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>

17201

17202

17203

17204

17205

17206

17207

17208

17209

17210

17211

17212

17213

<p>Inherited from

17214

<a href="../classes/Widget.html#attr_rendered">Widget</a>:

17215

17216

17217

17218

<a href="../files/widget_js_Widget.js.html#l161"><code>widget/js/Widget.js:161</code></a>

17219

17220

</p>

17221

17222

17223

17224

17225

</div>

17226

17227

17228

<p>Flag indicating whether or not this Widget

17229

has been through the render lifecycle phase.</p>

17230

</div>

17231

17232

17233

<p><strong>Default:</strong> false</p>

17234

17235

17236

17237

17238

<h4>Fires event <code>renderedChange</code></h4>

17239

17240

<p>

17241

Fires when the value for the configuration attribute <code>rendered</code> is

17242

changed. You can listen for the event using the <code>on</code> method if you

17243

wish to be notified before the attribute's value has changed, or

17244

using the <code>after</code> method if you wish to be notified after the

17245

attribute's value has changed.

17246

</p>

17247

17248

17249

<h4>Parameters:</h4>

17250

17251

17252

17253

17254

<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>

17255

17256

17257

An Event Facade object with the following

17258

attribute-specific properties added:

17259

</div>

17260

17261

17262

17263

<code class="param-name">prevVal</code>

17264

17265

<div class="param-description">The value of the attribute, prior to it being set.</div>

17266

</li>

17267

17268

<code class="param-name">newVal</code>

17269

17270

<div class="param-description">The value the attribute is to be set to.</div>

17271

</li>

17272

17273

<code class="param-name">attrName</code>

17274

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

17275

<div class="param-description">The name of the attribute being set.</div>

17276

</li>

17277

17278

<code class="param-name">subAttrName</code>

17279

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

17280

<div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div>

17281

</li>

17282

</ul>

17283

</li>

17284

</ul>

17285

</div>

17286

</div>

17287

17288

17289

17290

</div>

17291

17292

17293

17294

17295

17296

<span class="type"><a href="../classes/Widget.html" class="crosslink">Widget</a></span>

17297

17298

17299

17300

17301

17302

17303

17304

17305

17306

17307

17308

17309

<p>Inherited from

17310

<a href="../classes/WidgetChild.html#attr_root">WidgetChild</a>:

17311

17312

17313

17314

<a href="../files/widget-child_js_Widget-Child.js.html#l116"><code>widget-child/js/Widget-Child.js:116</code></a>

17315

17316

</p>

17317

17318

17319

17320

17321

</div>

17322

17323

17324

<p>Returns the root Widget in the object hierarchy. If the

17325

ROOT_TYPE property is set, the search for the root Widget will be

17326

constrained to parent Widgets of the specified type.</p>

17327

</div>

17328

17329

17330

17331

17332

17333

<h4>Fires event <code>rootChange</code></h4>

17334

17335

<p>

17336

Fires when the value for the configuration attribute <code>root</code> is

17337

changed. You can listen for the event using the <code>on</code> method if you

17338

wish to be notified before the attribute's value has changed, or

17339

using the <code>after</code> method if you wish to be notified after the

17340

attribute's value has changed.

17341

</p>

17342

17343

17344

<h4>Parameters:</h4>

17345

17346

17347

17348

17349

<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>

17350

17351

17352

An Event Facade object with the following

17353

attribute-specific properties added:

17354

</div>

17355

17356

17357

17358

<code class="param-name">prevVal</code>

17359

17360

<div class="param-description">The value of the attribute, prior to it being set.</div>

17361

</li>

17362

17363

<code class="param-name">newVal</code>

17364

17365

<div class="param-description">The value the attribute is to be set to.</div>

17366

</li>

17367

17368

<code class="param-name">attrName</code>

17369

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

17370

<div class="param-description">The name of the attribute being set.</div>

17371

</li>

17372

17373

<code class="param-name">subAttrName</code>

17374

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

17375

<div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div>

17376

</li>

17377

</ul>

17378

</li>

17379

</ul>

17380

</div>

17381

</div>

17382

17383

17384

17385

</div>

17386

17387

17388

17389

17390

<h3 class="name"><code>selected</code></h3>

17391

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Number" class="crosslink external" target="_blank">Number</a></span>

17392

17393

17394

17395

17396

17397

17398

17399

17400

17401

17402

17403

17404

<p>Inherited from

17405

<a href="../classes/WidgetChild.html#attr_selected">WidgetChild</a>:

17406

17407

17408

17409

<a href="../files/widget-child_js_Widget-Child.js.html#l26"><code>widget-child/js/Widget-Child.js:26</code></a>

17410

17411

</p>

17412

17413

17414

17415

17416

</div>

17417

17418

17419

<p>Number indicating if the Widget is selected. Possible

17420

values are:</p>

17421

17422

<dl>

17423

<dt>0</dt> <dd>(Default) Not selected</dd>

17424

<dt>1</dt> <dd>Fully selected</dd>

17425

<dt>2</dt> <dd>Partially selected</dd>

17426

</dl>

17427

</div>

17428

17429

17430

<p><strong>Default:</strong> 0</p>

17431

17432

17433

17434

17435

<h4>Fires event <code>selectedChange</code></h4>

17436

17437

<p>

17438

Fires when the value for the configuration attribute <code>selected</code> is

17439

changed. You can listen for the event using the <code>on</code> method if you

17440

wish to be notified before the attribute's value has changed, or

17441

using the <code>after</code> method if you wish to be notified after the

17442

attribute's value has changed.

17443

</p>

17444

17445

17446

<h4>Parameters:</h4>

17447

17448

17449

17450

17451

<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>

17452

17453

17454

An Event Facade object with the following

17455

attribute-specific properties added:

17456

</div>

17457

17458

17459

17460

<code class="param-name">prevVal</code>

17461

17462

<div class="param-description">The value of the attribute, prior to it being set.</div>

17463

</li>

17464

17465

<code class="param-name">newVal</code>

17466

17467

<div class="param-description">The value the attribute is to be set to.</div>

17468

</li>

17469

17470

<code class="param-name">attrName</code>

17471

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

17472

<div class="param-description">The name of the attribute being set.</div>

17473

</li>

17474

17475

<code class="param-name">subAttrName</code>

17476

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

17477

<div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div>

17478

</li>

17479

</ul>

17480

</li>

17481

</ul>

17482

</div>

17483

</div>

17484

17485

17486

17487

</div>

17488

17489

17490

17491

17492

<h3 class="name"><code>srcNode</code></h3>

17493

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a> | <a href="../classes/Node.html" class="crosslink">Node</a></span>

17494

17495

17496

17497

17498

17499

17500

17501

17502

17503

17504

17505

17506

<p>Inherited from

17507

<a href="../classes/Widget.html#attr_srcNode">Widget</a>:

17508

17509

17510

17511

<a href="../files/widget_js_WidgetHTMLParser.js.html#l59"><code>widget/js/WidgetHTMLParser.js:59</code></a>

17512

17513

</p>

17514

17515

17516

17517

17518

</div>

17519

17520

17521

<p>The DOM node to parse for configuration values, passed to the Widget's HTML_PARSER definition</p>

17522

</div>

17523

17524

17525

17526

17527

17528

<h4>Fires event <code>srcNodeChange</code></h4>

17529

17530

<p>

17531

Fires when the value for the configuration attribute <code>srcNode</code> is

17532

changed. You can listen for the event using the <code>on</code> method if you

17533

wish to be notified before the attribute's value has changed, or

17534

using the <code>after</code> method if you wish to be notified after the

17535

attribute's value has changed.

17536

</p>

17537

17538

17539

<h4>Parameters:</h4>

17540

17541

17542

17543

17544

<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>

17545

17546

17547

An Event Facade object with the following

17548

attribute-specific properties added:

17549

</div>

17550

17551

17552

17553

<code class="param-name">prevVal</code>

17554

17555

<div class="param-description">The value of the attribute, prior to it being set.</div>

17556

</li>

17557

17558

<code class="param-name">newVal</code>

17559

17560

<div class="param-description">The value the attribute is to be set to.</div>

17561

</li>

17562

17563

<code class="param-name">attrName</code>

17564

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

17565

<div class="param-description">The name of the attribute being set.</div>

17566

</li>

17567

17568

<code class="param-name">subAttrName</code>

17569

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

17570

<div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div>

17571

</li>

17572

</ul>

17573

</li>

17574

</ul>

17575

</div>

17576

</div>

17577

17578

17579

17580

</div>

17581

17582

17583

17584

17585

<h3 class="name"><code>strings</code></h3>

17586

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>

17587

17588

17589

17590

17591

17592

17593

17594

17595

17596

17597

17598

17599

<p>Inherited from

17600

<a href="../classes/Widget.html#attr_strings">Widget</a>:

17601

17602

17603

17604

<a href="../files/widget_js_Widget.js.html#l274"><code>widget/js/Widget.js:274</code></a>

17605

17606

</p>

17607

17608

17609

17610

17611

</div>

17612

17613

17614

<p>Collection of strings used to label elements of the Widget's UI.</p>

17615

</div>

17616

17617

17618

<p><strong>Default:</strong> null</p>

17619

17620

17621

17622

17623

<h4>Fires event <code>stringsChange</code></h4>

17624

17625

<p>

17626

Fires when the value for the configuration attribute <code>strings</code> is

17627

changed. You can listen for the event using the <code>on</code> method if you

17628

wish to be notified before the attribute's value has changed, or

17629

using the <code>after</code> method if you wish to be notified after the

17630

attribute's value has changed.

17631

</p>

17632

17633

17634

<h4>Parameters:</h4>

17635

17636

17637

17638

17639

<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>

17640

17641

17642

An Event Facade object with the following

17643

attribute-specific properties added:

17644

</div>

17645

17646

17647

17648

<code class="param-name">prevVal</code>

17649

17650

<div class="param-description">The value of the attribute, prior to it being set.</div>

17651

</li>

17652

17653

<code class="param-name">newVal</code>

17654

17655

<div class="param-description">The value the attribute is to be set to.</div>

17656

</li>

17657

17658

<code class="param-name">attrName</code>

17659

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

17660

<div class="param-description">The name of the attribute being set.</div>

17661

</li>

17662

17663

<code class="param-name">subAttrName</code>

17664

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

17665

<div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div>

17666

</li>

17667

</ul>

17668

</li>

17669

</ul>

17670

</div>

17671

</div>

17672

17673

17674

17675

</div>

17676

17677

17678

17679

17680

<h3 class="name"><code>tabIndex</code></h3>

17681

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Number" class="crosslink external" target="_blank">Number</a></span>

17682

17683

17684

17685

17686

17687

17688

17689

17690

17691

17692

17693

17694

<p>Inherited from

17695

<a href="../classes/Widget.html#attr_tabIndex">Widget</a>:

17696

17697

17698

17699

<a href="../files/widget_js_Widget.js.html#l202"><code>widget/js/Widget.js:202</code></a>

17700

17701

</p>

17702

17703

17704

17705

17706

</div>

17707

17708

17709

<p>Number (between -32767 to 32767) indicating the widget's

17710

position in the default tab flow. The value is used to set the

17711

"tabIndex" attribute on the widget's bounding box. Negative values allow

17712

the widget to receive DOM focus programmatically (by calling the focus

17713

method), while being removed from the default tab flow. A value of

17714

null removes the "tabIndex" attribute from the widget's bounding box.</p>

17715

</div>

17716

17717

17718

<p><strong>Default:</strong> null</p>

17719

17720

17721

17722

17723

<h4>Fires event <code>tabIndexChange</code></h4>

17724

17725

<p>

17726

Fires when the value for the configuration attribute <code>tabIndex</code> is

17727

changed. You can listen for the event using the <code>on</code> method if you

17728

wish to be notified before the attribute's value has changed, or

17729

using the <code>after</code> method if you wish to be notified after the

17730

attribute's value has changed.

17731

</p>

17732

17733

17734

<h4>Parameters:</h4>

17735

17736

17737

17738

17739

<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>

17740

17741

17742

An Event Facade object with the following

17743

attribute-specific properties added:

17744

</div>

17745

17746

17747

17748

<code class="param-name">prevVal</code>

17749

17750

<div class="param-description">The value of the attribute, prior to it being set.</div>

17751

</li>

17752

17753

<code class="param-name">newVal</code>

17754

17755

<div class="param-description">The value the attribute is to be set to.</div>

17756

</li>

17757

17758

<code class="param-name">attrName</code>

17759

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

17760

<div class="param-description">The name of the attribute being set.</div>

17761

</li>

17762

17763

<code class="param-name">subAttrName</code>

17764

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

17765

<div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div>

17766

</li>

17767

</ul>

17768

</li>

17769

</ul>

17770

</div>

17771

</div>

17772

17773

17774

17775

</div>

17776

17777

17778

17779

17780

<h3 class="name"><code>triggerEvent</code></h3>

17781

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

17782

17783

17784

17785

17786

17787

17788

17789

17790

17791

17792

17793

17794

17795

<p>

17796

17797

Defined in

17798

17799

17800

17801

17802

<a href="../files/tabview_js_tab.js.html#l155"><code>tabview/js/tab.js:155</code></a>

17803

17804

</p>

17805

17806

17807

17808

17809

</div>

17810

17811

17812

17813

</div>

17814

17815

17816

<p><strong>Default:</strong> "click"</p>

17817

17818

17819

17820

17821

<h4>Fires event <code>triggerEventChange</code></h4>

17822

17823

<p>

17824

Fires when the value for the configuration attribute <code>triggerEvent</code> is

17825

changed. You can listen for the event using the <code>on</code> method if you

17826

wish to be notified before the attribute's value has changed, or

17827

using the <code>after</code> method if you wish to be notified after the

17828

attribute's value has changed.

17829

</p>

17830

17831

17832

<h4>Parameters:</h4>

17833

17834

17835

17836

17837

<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>

17838

17839

17840

An Event Facade object with the following

17841

attribute-specific properties added:

17842

</div>

17843

17844

17845

17846

<code class="param-name">prevVal</code>

17847

17848

<div class="param-description">The value of the attribute, prior to it being set.</div>

17849

</li>

17850

17851

<code class="param-name">newVal</code>

17852

17853

<div class="param-description">The value the attribute is to be set to.</div>

17854

</li>

17855

17856

<code class="param-name">attrName</code>

17857

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

17858

<div class="param-description">The name of the attribute being set.</div>

17859

</li>

17860

17861

<code class="param-name">subAttrName</code>

17862

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

17863

<div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div>

17864

</li>

17865

</ul>

17866

</li>

17867

</ul>

17868

</div>

17869

</div>

17870

17871

17872

17873

</div>

17874

17875

17876

17877

17878

<h3 class="name"><code>visible</code></h3>

17879

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>

17880

17881

17882

17883

17884

17885

17886

17887

17888

17889

17890

17891

17892

<p>Inherited from

17893

<a href="../classes/Widget.html#attr_visible">Widget</a>:

17894

17895

17896

17897

<a href="../files/widget_js_Widget.js.html#l242"><code>widget/js/Widget.js:242</code></a>

17898

17899

</p>

17900

17901

17902

17903

17904

</div>

17905

17906

17907

<p>Boolean indicating weather or not the Widget is visible.</p>

17908

</div>

17909

17910

17911

<p><strong>Default:</strong> TRUE</p>

17912

17913

17914

17915

17916

<h4>Fires event <code>visibleChange</code></h4>

17917

17918

<p>

17919

Fires when the value for the configuration attribute <code>visible</code> is

17920

changed. You can listen for the event using the <code>on</code> method if you

17921

wish to be notified before the attribute's value has changed, or

17922

using the <code>after</code> method if you wish to be notified after the

17923

attribute's value has changed.

17924

</p>

17925

17926

17927

<h4>Parameters:</h4>

17928

17929

17930

17931

17932

<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>

17933

17934

17935

An Event Facade object with the following

17936

attribute-specific properties added:

17937

</div>

17938

17939

17940

17941

<code class="param-name">prevVal</code>

17942

17943

<div class="param-description">The value of the attribute, prior to it being set.</div>

17944

</li>

17945

17946

<code class="param-name">newVal</code>

17947

17948

<div class="param-description">The value the attribute is to be set to.</div>

17949

</li>

17950

17951

<code class="param-name">attrName</code>

17952

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

17953

<div class="param-description">The name of the attribute being set.</div>

17954

</li>

17955

17956

<code class="param-name">subAttrName</code>

17957

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

17958

<div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div>

17959

</li>

17960

</ul>

17961

</li>

17962

</ul>

17963

</div>

17964

</div>

17965

17966

17967

17968

</div>

17969

17970

17971

17972

17973

<h3 class="name"><code>width</code></h3>

17974

17975

17976

17977

17978

17979

17980

17981

17982

17983

17984

17985

17986

17987

<p>Inherited from

17988

<a href="../classes/Widget.html#attr_width">Widget</a>:

17989

17990

17991

17992

<a href="../files/widget_js_Widget.js.html#l263"><code>widget/js/Widget.js:263</code></a>

17993

17994

</p>

17995

17996

17997

17998

17999

</div>

18000

18001

18002

<p>String with units, or number, representing the width of the Widget. If a number is provided,

18003

the default unit, defined by the Widgets DEF_UNIT, property is used.</p>

18004

</div>

18005

18006

18007

<p><strong>Default:</strong> EMPTY_STR</p>

18008

18009

18010

18011

18012

<h4>Fires event <code>widthChange</code></h4>

18013

18014

<p>

18015

Fires when the value for the configuration attribute <code>width</code> is

18016

changed. You can listen for the event using the <code>on</code> method if you

18017

wish to be notified before the attribute's value has changed, or

18018

using the <code>after</code> method if you wish to be notified after the

18019

attribute's value has changed.

18020

</p>

18021

18022

18023

<h4>Parameters:</h4>

18024

18025

18026

18027

18028

<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>

18029

18030

18031

An Event Facade object with the following

18032

attribute-specific properties added:

18033

</div>

18034

18035

18036

18037

<code class="param-name">prevVal</code>

18038

18039

<div class="param-description">The value of the attribute, prior to it being set.</div>

18040

</li>

18041

18042

<code class="param-name">newVal</code>

18043

18044

<div class="param-description">The value the attribute is to be set to.</div>

18045

</li>

18046

18047

<code class="param-name">attrName</code>

18048

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

18049

<div class="param-description">The name of the attribute being set.</div>

18050

</li>

18051

18052

<code class="param-name">subAttrName</code>

18053

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

18054

<div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div>

18055

</li>

18056

</ul>

18057

</li>

18058

</ul>

18059

</div>

18060

</div>

18061

18062

18063

18064

</div>

18065

18066

18067

</div>

18068

18069

18070

18071

18072

<h2 class="off-left">Events</h2>

18073

18074

18075

18076

<h3 class="name"><code>destroy</code></h3>

18077

18078

18079

18080

18081

18082

18083

18084

18085

18086

18087

18088

18089

18090

<p>Inherited from

18091

<a href="../classes/Base.html#event_destroy">Base</a>:

18092

18093

18094

18095

18096

18097

</p>

18098

18099

18100

18101

18102

</div>

18103

18104

18105

<p>

18106

Lifecycle event for the destroy phase,

18107

fired prior to destruction. Invoking the preventDefault

18108

method on the event object provided to subscribers will

18109

prevent destruction from proceeding.

18110

</p>

18111

18112

<p>

18113

Subscribers to the "after" moment of this event, will be notified

18114

after destruction is complete (and as a result cannot prevent

18115

destruction).

18116

</p>

18117

</div>

18118

18119

18120

18121

<h4>Event Payload:</h4>

18122

18123

18124

18125

18126

18127

18128

<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>

18129

18130

18131

18132

18133

18134

<p>Event object</p>

18135

</div>

18136

18137

18138

</li>

18139

18140

</ul>

18141

</div>

18142

18143

18144

18145

18146

</div>

18147

18148

18149

18150

18151

18152

18153

18154

18155

18156

18157

18158

18159

18160

18161

18162

18163

18164

<p>Inherited from

18165

<a href="../classes/Base.html#event_init">Base</a>:

18166

18167

18168

18169

18170

18171

</p>

18172

18173

18174

18175

18176

</div>

18177

18178

18179

<p>

18180

Lifecycle event for the init phase, fired prior to initialization.

18181

Invoking the preventDefault() method on the event object provided

18182

to subscribers will prevent initialization from occuring.

18183

</p>

18184

18185

<p>

18186

Subscribers to the "after" momemt of this event, will be notified

18187

after initialization of the object is complete (and therefore

18188

cannot prevent initialization).

18189

</p>

18190

</div>

18191

18192

18193

18194

<h4>Event Payload:</h4>

18195

18196

18197

18198

18199

18200

18201

<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>

18202

18203

18204

18205

18206

18207

<p>Event object, with a cfg property which

18208

refers to the configuration object passed to the constructor.</p>

18209

</div>

18210

18211

18212

</li>

18213

18214

</ul>

18215

</div>

18216

18217

18218

18219

18220

</div>

18221

18222

18223

18224

<h3 class="name"><code>widget:contentUpdate</code></h3>

18225

18226

18227

18228

18229

18230

18231

18232

18233

18234

18235

18236

18237

18238

<p>Inherited from

18239

<a href="../classes/Widget.html#event_widget:contentUpdate">Widget</a>:

18240

18241

18242

18243

<a href="../files/widget_js_Widget.js.html#l398"><code>widget/js/Widget.js:398</code></a>

18244

18245

</p>

18246

18247

18248

18249

18250

</div>

18251

18252

18253

<p>Notification event, which widget implementations can fire, when

18254

they change the content of the widget. This event has no default

18255

behavior and cannot be prevented, so the "on" or "after"

18256

moments are effectively equivalent (with on listeners being invoked before

18257

after listeners).</p>

18258

</div>

18259

18260

18261

18262

<h4>Event Payload:</h4>

18263

18264

18265

18266

18267

18268

18269

<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>

18270

18271

18272

18273

18274

18275

<p>The Event Facade</p>

18276

</div>

18277

18278

18279

</li>

18280

18281

</ul>

18282

</div>

18283

18284

18285

18286

18287

</div>

18288

18289

18290

18291

<h3 class="name"><code>widget:render</code></h3>

18292

18293

18294

18295

18296

18297

18298

18299

18300

18301

18302

18303

18304

18305

<p>Inherited from

18306

<a href="../classes/Widget.html#event_widget:render">Widget</a>:

18307

18308

18309

18310

<a href="../files/widget_js_Widget.js.html#l544"><code>widget/js/Widget.js:544</code></a>

18311

18312

</p>

18313

18314

18315

18316

18317

</div>

18318

18319

18320

<p>Lifecycle event for the render phase, fired prior to rendering the UI

18321

for the widget (prior to invoking the widget's renderer method).</p>

18322

18323

<p>

18324

Subscribers to the "on" moment of this event, will be notified

18325

before the widget is rendered.

18326

</p>

18327

18328

<p>

18329

Subscribers to the "after" moment of this event, will be notified

18330

after rendering is complete.

18331

</p>

18332

</div>

18333

18334

18335

18336

<h4>Event Payload:</h4>

18337

18338

18339

18340

18341

18342

18343

<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>

18344

18345

18346

18347

18348

18349

<p>The Event Facade</p>

18350

</div>

18351

18352

18353

</li>

18354

18355

</ul>

18356

</div>

18357

18358

18359

18360

18361

</div>

18362

18363

18364

</div>

18365

18366

</div>

18367

</div>

18368

18369

</div>

18370

</div>

18371

</div>

18372

</div>

18373

</div>

18374

</div>

18375

18376

18377

18378

18379

18380

18381

18382

18383

</body>

18384

</html>

Older »