~bac/juju-gui/trunkcopy

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

1407

1408

1409

1410

1411

1412

<p>Configuration object</p>

1413

</div>

1414

1415

1416

</li>

1417

1418

</ul>

1419

</div>

1420

1421

1422

1423

1424

1425

</div>

1426

1427

</div>

1428

1429

1430

1431

1432

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

1433

1434

1435

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

1436

1437

1438

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

1439

1440

1441

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

1442

1443

1444

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

1445

1446

</ul>

1447

1448

<div>

1449

1450

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

1451

1452

1453

1454

<h3>Methods</h3>

1455

1456

1457

1458

1459

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

1460

1461

1462

</li>

1463

1464

1465

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

1466

1467

1468

</li>

1469

1470

1471

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

1472

1473

1474

</li>

1475

1476

1477

<a href="#method__afterDisabledChange">_afterDisabledChange</a>

1478

1479

1480

</li>

1481

1482

1483

<a href="#method__afterLabelChange">_afterLabelChange</a>

1484

1485

1486

</li>

1487

1488

1489

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

1490

1491

1492

</li>

1493

1494

1495

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

1496

1497

1498

</li>

1499

1500

1501

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

1502

1503

1504

</li>

1505

1506

1507

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

1508

1509

1510

</li>

1511

1512

1513

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

1514

1515

1516

</li>

1517

1518

1519

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

1520

1521

1522

</li>

1523

1524

1525

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

1526

1527

1528

</li>

1529

1530

1531

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

1532

1533

1534

</li>

1535

1536

1537

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

1538

1539

1540

</li>

1541

1542

1543

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

1544

1545

1546

</li>

1547

1548

1549

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

1550

1551

1552

</li>

1553

1554

1555

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

1556

1557

1558

</li>

1559

1560

1561

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

1562

1563

1564

</li>

1565

1566

1567

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

1568

1569

1570

</li>

1571

1572

1573

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

1574

1575

1576

</li>

1577

1578

1579

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

1580

1581

1582

</li>

1583

1584

1585

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

1586

1587

1588

</li>

1589

1590

1591

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

1592

1593

1594

</li>

1595

1596

1597

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

1598

1599

1600

</li>

1601

1602

1603

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

1604

1605

1606

</li>

1607

1608

1609

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

1610

1611

1612

</li>

1613

1614

1615

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

1616

1617

1618

</li>

1619

1620

1621

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

1622

1623

1624

</li>

1625

1626

1627

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

1628

1629

1630

</li>

1631

1632

1633

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

1634

1635

1636

</li>

1637

1638

1639

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

1640

1641

1642

</li>

1643

1644

1645

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

1646

1647

1648

</li>

1649

1650

1651

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

1652

1653

1654

</li>

1655

1656

1657

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

1658

1659

1660

</li>

1661

1662

1663

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

1664

1665

1666

</li>

1667

1668

1669

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

1670

1671

1672

</li>

1673

1674

1675

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

1676

1677

1678

</li>

1679

1680

1681

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

1682

1683

1684

</li>

1685

1686

1687

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

1688

1689

1690

</li>

1691

1692

1693

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

1694

1695

1696

</li>

1697

1698

1699

1700

1701

1702

</li>

1703

1704

1705

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

1706

1707

1708

</li>

1709

1710

1711

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

1712

1713

1714

</li>

1715

1716

1717

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

1718

1719

1720

</li>

1721

1722

1723

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

1724

1725

1726

</li>

1727

1728

1729

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

1730

1731

1732

</li>

1733

1734

1735

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

1736

1737

1738

</li>

1739

1740

1741

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

1742

1743

1744

</li>

1745

1746

1747

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

1748

1749

1750

</li>

1751

1752

1753

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

1754

1755

1756

</li>

1757

1758

1759

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

1760

1761

1762

</li>

1763

1764

1765

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

1766

1767

1768

</li>

1769

1770

1771

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

1772

1773

1774

</li>

1775

1776

1777

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

1778

1779

1780

</li>

1781

1782

1783

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

1784

1785

1786

</li>

1787

1788

1789

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

1790

1791

1792

</li>

1793

1794

1795

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

1796

1797

1798

</li>

1799

1800

1801

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

1802

1803

1804

</li>

1805

1806

1807

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

1808

1809

1810

</li>

1811

1812

1813

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

1814

1815

1816

</li>

1817

1818

1819

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

1820

1821

1822

</li>

1823

1824

1825

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

1826

1827

1828

</li>

1829

1830

1831

1832

1833

1834

</li>

1835

1836

1837

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

1838

1839

1840

</li>

1841

1842

1843

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

1844

1845

1846

</li>

1847

1848

1849

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

1850

1851

1852

</li>

1853

1854

1855

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

1856

1857

1858

</li>

1859

1860

1861

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

1862

1863

1864

</li>

1865

1866

1867

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

1868

1869

1870

</li>

1871

1872

1873

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

1874

1875

1876

</li>

1877

1878

1879

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

1880

1881

1882

</li>

1883

1884

1885

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

1886

1887

1888

</li>

1889

1890

1891

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

1892

1893

1894

</li>

1895

1896

1897

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

1898

1899

1900

</li>

1901

1902

1903

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

1904

1905

1906

</li>

1907

1908

1909

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

1910

1911

1912

</li>

1913

1914

1915

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

1916

1917

1918

</li>

1919

1920

1921

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

1922

1923

1924

</li>

1925

1926

1927

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

1928

1929

1930

</li>

1931

1932

1933

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

1934

1935

1936

</li>

1937

1938

1939

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

1940

1941

1942

</li>

1943

1944

1945

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

1946

1947

1948

</li>

1949

1950

1951

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

1952

1953

1954

</li>

1955

1956

1957

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

1958

1959

1960

</li>

1961

1962

1963

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

1964

1965

1966

</li>

1967

1968

1969

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

1970

1971

1972

</li>

1973

1974

1975

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

1976

1977

1978

</li>

1979

1980

1981

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

1982

1983

1984

</li>

1985

1986

1987

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

1988

1989

1990

</li>

1991

1992

1993

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

1994

1995

1996

</li>

1997

1998

1999

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

2000

2001

2002

</li>

2003

2004

2005

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

2006

2007

2008

</li>

2009

2010

2011

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

2012

2013

2014

</li>

2015

2016

2017

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

2018

2019

2020

</li>

2021

2022

2023

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

2024

2025

2026

</li>

2027

2028

2029

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

2030

2031

2032

</li>

2033

2034

2035

2036

2037

2038

</li>

2039

2040

2041

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

2042

2043

2044

</li>

2045

2046

2047

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

2048

2049

2050

</li>

2051

2052

2053

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

2054

2055

2056

</li>

2057

2058

2059

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

2060

2061

2062

</li>

2063

2064

2065

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

2066

2067

2068

</li>

2069

2070

2071

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

2072

2073

2074

</li>

2075

2076

2077

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

2078

2079

2080

</li>

2081

2082

2083

2084

2085

2086

</li>

2087

2088

2089

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

2090

2091

2092

</li>

2093

2094

2095

2096

2097

2098

</li>

2099

2100

2101

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

2102

2103

2104

</li>

2105

2106

2107

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

2108

2109

2110

</li>

2111

2112

2113

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

2114

2115

2116

</li>

2117

2118

2119

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

2120

2121

2122

</li>

2123

2124

2125

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

2126

2127

2128

</li>

2129

2130

2131

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

2132

2133

2134

</li>

2135

2136

2137

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

2138

2139

2140

</li>

2141

2142

2143

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

2144

2145

2146

</li>

2147

2148

2149

2150

2151

2152

</li>

2153

2154

2155

2156

2157

2158

</li>

2159

2160

2161

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

2162

2163

2164

</li>

2165

2166

2167

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

2168

2169

2170

</li>

2171

2172

2173

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

2174

2175

2176

</li>

2177

2178

2179

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

2180

2181

2182

</li>

2183

2184

2185

2186

2187

2188

</li>

2189

2190

2191

2192

2193

2194

</li>

2195

2196

2197

2198

2199

2200

</li>

2201

2202

2203

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

2204

2205

2206

</li>

2207

2208

2209

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

2210

2211

2212

</li>

2213

2214

2215

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

2216

2217

2218

</li>

2219

2220

2221

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

2222

2223

2224

</li>

2225

2226

2227

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

2228

2229

2230

</li>

2231

2232

2233

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

2234

2235

2236

</li>

2237

2238

2239

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

2240

2241

2242

</li>

2243

2244

2245

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

2246

2247

2248

</li>

2249

2250

2251

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

2252

2253

2254

</li>

2255

2256

2257

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

2258

2259

2260

</li>

2261

2262

2263

2264

2265

2266

</li>

2267

2268

2269

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

2270

2271

2272

</li>

2273

2274

2275

2276

2277

2278

</li>

2279

2280

2281

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

2282

2283

2284

</li>

2285

2286

2287

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

2288

2289

2290

</li>

2291

2292

2293

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

2294

2295

2296

</li>

2297

2298

2299

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

2300

2301

2302

</li>

2303

2304

2305

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

2306

2307

2308

</li>

2309

2310

</ul>

2311

</div>

2312

2313

2314

2315

2316

<h3>Properties</h3>

2317

2318

2319

2320

2321

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

2322

2323

2324

</li>

2325

2326

2327

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

2328

2329

2330

</li>

2331

2332

2333

<a href="#property_ATTRS">ATTRS</a>

2334

2335

2336

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

2337

2338

</li>

2339

2340

2341

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

2342

2343

2344

</li>

2345

2346

2347

<a href="#property_CLASS_NAMES">CLASS_NAMES</a>

2348

2349

2350

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

2351

2352

</li>

2353

2354

2355

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

2356

2357

2358

</li>

2359

2360

2361

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

2362

2363

2364

</li>

2365

2366

2367

2368

2369

2370

</li>

2371

2372

2373

<a href="#property_HTML_PARSER">HTML_PARSER</a>

2374

2375

2376

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

2377

2378

</li>

2379

2380

2381

2382

2383

2384

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

2385

2386

</li>

2387

2388

2389

2390

2391

2392

</li>

2393

2394

2395

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

2396

2397

2398

</li>

2399

2400

</ul>

2401

</div>

2402

2403

2404

2405

2406

<h3>Attributes</h3>

2407

2408

2409

2410

2411

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

2412

</li>

2413

2414

2415

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

2416

</li>

2417

2418

2419

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

2420

</li>

2421

2422

2423

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

2424

</li>

2425

2426

2427

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

2428

</li>

2429

2430

2431

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

2432

</li>

2433

2434

2435

2436

</li>

2437

2438

2439

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

2440

</li>

2441

2442

2443

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

2444

</li>

2445

2446

2447

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

2448

</li>

2449

2450

2451

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

2452

</li>

2453

2454

2455

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

2456

</li>

2457

2458

2459

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

2460

</li>

2461

2462

2463

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

2464

</li>

2465

2466

2467

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

2468

</li>

2469

2470

2471

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

2472

</li>

2473

2474

</ul>

2475

</div>

2476

2477

2478

2479

2480

<h3>Events</h3>

2481

2482

2483

2484

2485

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

2486

2487

2488

</li>

2489

2490

2491

2492

2493

2494

</li>

2495

2496

2497

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

2498

2499

2500

</li>

2501

2502

2503

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

2504

2505

2506

</li>

2507

2508

</ul>

2509

</div>

2510

2511

</div>

2512

2513

2514

2515

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

2516

2517

2518

2519

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

2520

2521

2522

2523

2524

2525

2526

2527

2528

2529

</li>

2530

2531

2532

2533

<code>values</code>

2534

2535

</li>

2536

2537

2538

2539

2540

2541

</li>

2542

2543

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

2544

</div>

2545

2546

2547

2548

2549

2550

2551

2552

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

2553

2554

2555

2556

2557

2558

2559

2560

2561

2562

2563

2564

<p>Inherited from

2565

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

2566

2567

2568

2569

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

2570

2571

</p>

2572

2573

2574

2575

2576

2577

</div>

2578

2579

2580

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

2581

2582

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

2583

in which an attribute's valueFn attempts to obtain the

2584

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

2585

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

2586

</div>

2587

2588

2589

2590

<h4>Parameters:</h4>

2591

2592

2593

2594

2595

2596

2597

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

2598

2599

2600

2601

2602

2603

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

2604

</div>

2605

2606

2607

</li>

2608

2609

2610

2611

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

2612

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

2613

2614

2615

2616

2617

2618

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

2619

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

2620

</div>

2621

2622

2623

</li>

2624

2625

2626

2627

2628

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

2629

2630

2631

2632

2633

2634

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

2635

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

2636

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

2637

</div>

2638

2639

2640

</li>

2641

2642

</ul>

2643

</div>

2644

2645

2646

2647

2648

2649

</div>

2650

2651

2652

2653

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

2654

2655

2656

2657

2658

2659

2660

2661

2662

2663

</li>

2664

2665

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

2666

</div>

2667

2668

2669

2670

2671

2672

2673

2674

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

2675

2676

2677

2678

2679

2680

2681

2682

2683

2684

2685

2686

<p>Inherited from

2687

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

2688

2689

2690

2691

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

2692

2693

</p>

2694

2695

2696

2697

2698

2699

</div>

2700

2701

2702

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

2703

</div>

2704

2705

2706

2707

<h4>Parameters:</h4>

2708

2709

2710

2711

2712

2713

2714

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

2715

2716

2717

2718

2719

2720

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

2721

</div>

2722

2723

2724

</li>

2725

2726

</ul>

2727

</div>

2728

2729

2730

2731

2732

2733

</div>

2734

2735

2736

2737

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

2738

2739

2740

2741

2742

2743

2744

2745

<code>event</code>

2746

2747

</li>

2748

2749

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

2750

</div>

2751

2752

2753

2754

2755

2756

2757

2758

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

2759

2760

2761

2762

2763

2764

2765

2766

2767

2768

2769

2770

<p>Inherited from

2771

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

2772

2773

2774

2775

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

2776

2777

</p>

2778

2779

2780

2781

2782

2783

</div>

2784

2785

2786

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

2787

attribute, responsible for updating the UI, in response to

2788

attribute changes.</p>

2789

</div>

2790

2791

2792

2793

<h4>Parameters:</h4>

2794

2795

2796

2797

2798

2799

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

2800

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

2801

2802

2803

2804

2805

2806

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

2807

</div>

2808

2809

2810

</li>

2811

2812

</ul>

2813

</div>

2814

2815

2816

2817

2818

2819

</div>

2820

2821

2822

2823

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

2824

2825

2826

2827

2828

2829

2830

2831

2832

2833

2834

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

2835

2836

2837

2838

2839

2840

2841

2842

2843

2844

2845

2846

2847

<p>

2848

2849

Defined in

2850

2851

2852

2853

2854

<a href="../files/button_js_button.js.html#l71"><code>button/js/button.js:71</code></a>

2855

2856

</p>

2857

2858

2859

2860

2861

2862

</div>

2863

2864

2865

2866

</div>

2867

2868

2869

2870

2871

2872

2873

</div>

2874

2875

2876

2877

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

2878

2879

2880

2881

2882

2883

2884

2885

2886

2887

2888

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

2889

2890

2891

2892

2893

2894

2895

2896

2897

2898

2899

2900

2901

<p>

2902

2903

Defined in

2904

2905

2906

2907

2908

<a href="../files/button_js_button.js.html#l63"><code>button/js/button.js:63</code></a>

2909

2910

</p>

2911

2912

2913

2914

2915

2916

</div>

2917

2918

2919

2920

</div>

2921

2922

2923

2924

2925

2926

2927

</div>

2928

2929

2930

2931

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

2932

2933

2934

2935

2936

2937

2938

2939

<code>allAttrs</code>

2940

2941

</li>

2942

2943

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

2944

</div>

2945

2946

2947

2948

2949

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

2950

</span>

2951

2952

2953

2954

2955

2956

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

2957

2958

2959

2960

2961

2962

2963

2964

2965

2966

2967

2968

<p>Inherited from

2969

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

2970

2971

2972

2973

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

2974

2975

</p>

2976

2977

2978

2979

2980

2981

</div>

2982

2983

2984

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

2985

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

2986

2987

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

2988

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

2989

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

2990

</div>

2991

2992

2993

2994

<h4>Parameters:</h4>

2995

2996

2997

2998

2999

3000

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

3001

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

3002

3003

3004

3005

3006

3007

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

3008

(subclass first, Base last)</p>

3009

</div>

3010

3011

3012

</li>

3013

3014

</ul>

3015

</div>

3016

3017

3018

3019

3020

<h4>Returns:</h4>

3021

3022

3023

3024

3025

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

3026

3027

The aggregate set of ATTRS definitions for the instance

3028

3029

</div>

3030

</div>

3031

3032

3033

3034

</div>

3035

3036

3037

3038

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

3039

3040

3041

3042

3043

3044

3045

3046

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

3047

</span>

3048

3049

3050

3051

3052

3053

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

3054

3055

3056

3057

3058

3059

3060

3061

3062

3063

3064

3065

<p>Inherited from

3066

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

3067

3068

3069

3070

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

3071

3072

</p>

3073

3074

3075

3076

3077

3078

</div>

3079

3080

3081

3082

</div>

3083

3084

3085

3086

3087

3088

<h4>Returns:</h4>

3089

3090

3091

3092

3093

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

3094

3095

The merged configuration literal

3096

3097

</div>

3098

</div>

3099

3100

3101

3102

</div>

3103

3104

3105

3106

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

3107

3108

3109

3110

3111

3112

3113

3114

<code>config</code>

3115

3116

</li>

3117

3118

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

3119

</div>

3120

3121

3122

3123

3124

3125

3126

3127

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

3128

3129

3130

3131

3132

3133

3134

3135

3136

3137

3138

3139

<p>Inherited from

3140

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

3141

3142

3143

3144

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

3145

3146

</p>

3147

3148

3149

3150

3151

3152

</div>

3153

3154

3155

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

3156

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

3157

</div>

3158

3159

3160

3161

<h4>Parameters:</h4>

3162

3163

3164

3165

3166

3167

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

3168

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

3169

3170

3171

3172

3173

3174

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

3175

</div>

3176

3177

3178

</li>

3179

3180

</ul>

3181

</div>

3182

3183

3184

3185

3186

3187

</div>

3188

3189

3190

3191

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

3192

3193

3194

3195

3196

3197

3198

3199

3200

3201

3202

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

3203

3204

3205

3206

3207

3208

3209

3210

3211

3212

3213

<p>Inherited from

3214

3215

BaseCore

3216

</a>

3217

3218

but overwritten in

3219

3220

3221

3222

3223

3224

</p>

3225

3226

3227

3228

3229

3230

</div>

3231

3232

3233

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

3234

this class.</p>

3235

</div>

3236

3237

3238

3239

3240

3241

3242

</div>

3243

3244

3245

3246

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

3247

3248

3249

3250

3251

3252

3253

3254

3255

3256

3257

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

3258

3259

3260

3261

3262

3263

3264

3265

3266

3267

3268

3269

<p>Inherited from

3270

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

3271

3272

3273

3274

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

3275

3276

</p>

3277

3278

3279

3280

3281

3282

</div>

3283

3284

3285

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

3286

</div>

3287

3288

3289

3290

3291

3292

3293

</div>

3294

3295

3296

3297

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

3298

3299

3300

3301

3302

3303

3304

3305

3306

3307

3308

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

3309

3310

3311

3312

3313

3314

3315

3316

3317

3318

3319

3320

<p>Inherited from

3321

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

3322

3323

3324

3325

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

3326

3327

</p>

3328

3329

3330

3331

3332

3333

</div>

3334

3335

3336

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

3337

</div>

3338

3339

3340

3341

3342

3343

3344

</div>

3345

3346

3347

3348

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

3349

3350

3351

3352

3353

3354

3355

3356

<code>attrs</code>

3357

3358

</li>

3359

3360

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

3361

</div>

3362

3363

3364

3365

3366

3367

3368

3369

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

3370

3371

3372

3373

3374

3375

3376

3377

3378

3379

3380

3381

<p>Inherited from

3382

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

3383

3384

3385

3386

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

3387

3388

</p>

3389

3390

3391

3392

3393

3394

</div>

3395

3396

3397

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

3398

</div>

3399

3400

3401

3402

<h4>Parameters:</h4>

3403

3404

3405

3406

3407

3408

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

3409

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

3410

3411

3412

3413

3414

3415

3416

</div>

3417

3418

3419

</li>

3420

3421

</ul>

3422

</div>

3423

3424

3425

3426

3427

3428

</div>

3429

3430

3431

3432

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

3433

3434

3435

3436

3437

3438

3439

3440

3441

3442

3443

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

3444

3445

3446

3447

3448

3449

3450

3451

3452

3453

3454

3455

<p>Inherited from

3456

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

3457

3458

3459

3460

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

3461

3462

</p>

3463

3464

3465

3466

3467

3468

</div>

3469

3470

3471

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

3472

</div>

3473

3474

3475

3476

3477

3478

3479

</div>

3480

3481

3482

3483

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

3484

3485

3486

3487

3488

3489

3490

3491

3492

3493

3494

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

3495

3496

3497

3498

3499

3500

3501

3502

3503

3504

3505

3506

<p>Inherited from

3507

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

3508

3509

3510

3511

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

3512

3513

</p>

3514

3515

3516

3517

3518

3519

</div>

3520

3521

3522

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

3523

</div>

3524

3525

3526

3527

3528

3529

3530

</div>

3531

3532

3533

3534

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

3535

3536

3537

3538

3539

3540

3541

3542

3543

3544

3545

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

3546

3547

3548

3549

3550

3551

3552

3553

3554

3555

3556

3557

<p>Inherited from

3558

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

3559

3560

3561

3562

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

3563

3564

</p>

3565

3566

3567

3568

3569

3570

</div>

3571

3572

3573

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

3574

to WidgetChild related state changes.</p>

3575

3576

<p>

3577

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

3578

using YUI's aop infrastructure.

3579

</p>

3580

</div>

3581

3582

3583

3584

3585

3586

3587

</div>

3588

3589

3590

3591

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

3592

3593

3594

3595

3596

3597

3598

3599

3600

3601

</li>

3602

3603

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

3604

</div>

3605

3606

3607

3608

3609

3610

3611

3612

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

3613

3614

3615

3616

3617

3618

3619

3620

3621

3622

3623

3624

<p>Inherited from

3625

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

3626

3627

3628

3629

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

3630

3631

</p>

3632

3633

3634

3635

3636

3637

</div>

3638

3639

3640

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

3641

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

3642

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

3643

</div>

3644

3645

3646

3647

<h4>Parameters:</h4>

3648

3649

3650

3651

3652

3653

3654

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

3655

3656

3657

3658

3659

3660

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

3661

</div>

3662

3663

3664

</li>

3665

3666

</ul>

3667

</div>

3668

3669

3670

3671

3672

3673

</div>

3674

3675

3676

3677

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

3678

3679

3680

3681

3682

3683

3684

3685

3686

3687

</li>

3688

3689

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

3690

</div>

3691

3692

3693

3694

3695

3696

3697

3698

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

3699

3700

3701

3702

3703

3704

3705

3706

3707

3708

3709

3710

<p>Inherited from

3711

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

3712

3713

3714

3715

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

3716

3717

</p>

3718

3719

3720

3721

3722

3723

</div>

3724

3725

3726

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

3727

</div>

3728

3729

3730

3731

<h4>Parameters:</h4>

3732

3733

3734

3735

3736

3737

3738

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

3739

3740

3741

3742

3743

3744

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

3745

</div>

3746

3747

3748

</li>

3749

3750

</ul>

3751

</div>

3752

3753

3754

3755

3756

3757

</div>

3758

3759

3760

3761

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

3762

3763

3764

3765

3766

3767

3768

3769

3770

3771

3772

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

3773

3774

3775

3776

3777

3778

3779

3780

3781

3782

3783

3784

<p>Inherited from

3785

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

3786

3787

3788

3789

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

3790

3791

</p>

3792

3793

3794

3795

3796

3797

</div>

3798

3799

3800

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

3801

3802

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

3803

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

3804

</div>

3805

3806

3807

3808

3809

3810

3811

</div>

3812

3813

3814

3815

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

3816

3817

3818

3819

3820

3821

3822

3823

3824

3825

</li>

3826

3827

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

3828

</div>

3829

3830

3831

3832

3833

3834

3835

3836

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

3837

3838

3839

3840

3841

3842

3843

3844

3845

3846

3847

3848

<p>Inherited from

3849

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

3850

3851

3852

3853

3854

3855

</p>

3856

3857

3858

3859

3860

3861

</div>

3862

3863

3864

<p>Default destroy event handler</p>

3865

</div>

3866

3867

3868

3869

<h4>Parameters:</h4>

3870

3871

3872

3873

3874

3875

3876

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

3877

3878

3879

3880

3881

3882

<p>Event object</p>

3883

</div>

3884

3885

3886

</li>

3887

3888

</ul>

3889

</div>

3890

3891

3892

3893

3894

3895

</div>

3896

3897

3898

3899

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

3900

3901

3902

3903

3904

3905

3906

3907

3908

3909

</li>

3910

3911

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

3912

</div>

3913

3914

3915

3916

3917

3918

3919

3920

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

3921

3922

3923

3924

3925

3926

3927

3928

3929

3930

3931

3932

<p>Inherited from

3933

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

3934

3935

3936

3937

3938

3939

</p>

3940

3941

3942

3943

3944

3945

</div>

3946

3947

3948

<p>Default init event handler</p>

3949

</div>

3950

3951

3952

3953

<h4>Parameters:</h4>

3954

3955

3956

3957

3958

3959

3960

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

3961

3962

3963

3964

3965

3966

<p>Event object, with a cfg property which

3967

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

3968

</div>

3969

3970

3971

</li>

3972

3973

</ul>

3974

</div>

3975

3976

3977

3978

3979

3980

</div>

3981

3982

3983

3984

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

3985

3986

3987

3988

3989

3990

3991

3992

3993

3994

</li>

3995

3996

3997

3998

<code>parentNode</code>

3999

4000

</li>

4001

4002

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

4003

</div>

4004

4005

4006

4007

4008

4009

4010

4011

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

4012

4013

4014

4015

4016

4017

4018

4019

4020

4021

4022

4023

<p>Inherited from

4024

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

4025

4026

4027

4028

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

4029

4030

</p>

4031

4032

4033

4034

4035

4036

</div>

4037

4038

4039

<p>Default render handler</p>

4040

</div>

4041

4042

4043

4044

<h4>Parameters:</h4>

4045

4046

4047

4048

4049

4050

4051

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

4052

4053

4054

4055

4056

4057

<p>The Event object</p>

4058

</div>

4059

4060

4061

</li>

4062

4063

4064

4065

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

4066

4067

4068

4069

4070

4071

4072

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

4073

</div>

4074

4075

4076

</li>

4077

4078

</ul>

4079

</div>

4080

4081

4082

4083

4084

4085

</div>

4086

4087

4088

4089

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

4090

4091

4092

4093

4094

4095

4096

4097

4098

4099

4100

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

4101

4102

4103

4104

4105

4106

4107

4108

4109

4110

4111

4112

<p>Inherited from

4113

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

4114

4115

4116

4117

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

4118

4119

</p>

4120

4121

4122

4123

4124

4125

</div>

4126

4127

4128

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

4129

and detaches bound UI events.</p>

4130

</div>

4131

4132

4133

4134

4135

4136

4137

</div>

4138

4139

4140

4141

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

4142

4143

4144

4145

4146

4147

4148

4149

4150

4151

4152

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

4153

4154

4155

4156

4157

4158

4159

4160

4161

4162

4163

4164

<p>Inherited from

4165

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

4166

4167

4168

4169

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

4170

4171

</p>

4172

4173

4174

4175

4176

4177

</div>

4178

4179

4180

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

4181

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

4182

</div>

4183

4184

4185

4186

4187

4188

4189

</div>

4190

4191

4192

4193

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

4194

4195

4196

4197

4198

4199

4200

4201

4202

4203

4204

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

4205

4206

4207

4208

4209

4210

4211

4212

4213

4214

4215

4216

<p>Inherited from

4217

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

4218

4219

4220

4221

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

4222

4223

</p>

4224

4225

4226

4227

4228

4229

</div>

4230

4231

4232

<p>Destructor logic for UI event infrastructure,

4233

invoked during Widget destruction.</p>

4234

</div>

4235

4236

4237

4238

4239

4240

4241

</div>

4242

4243

4244

4245

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

4246

4247

4248

4249

4250

4251

4252

4253

<code>allAttrs</code>

4254

4255

</li>

4256

4257

4258

4259

<code>userVals</code>

4260

4261

</li>

4262

4263

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

4264

</div>

4265

4266

4267

4268

4269

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

4270

</span>

4271

4272

4273

4274

4275

4276

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

4277

4278

4279

4280

4281

4282

4283

4284

4285

4286

4287

4288

<p>Inherited from

4289

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

4290

4291

4292

4293

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

4294

4295

</p>

4296

4297

4298

4299

4300

4301

</div>

4302

4303

4304

4305

</div>

4306

4307

4308

4309

<h4>Parameters:</h4>

4310

4311

4312

4313

4314

4315

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

4316

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

4317

4318

4319

4320

4321

4322

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

4323

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

4324

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

4325

</div>

4326

4327

4328

</li>

4329

4330

4331

4332

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

4333

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

4334

4335

4336

4337

4338

4339

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

4340

</div>

4341

4342

4343

</li>

4344

4345

</ul>

4346

</div>

4347

4348

4349

4350

4351

<h4>Returns:</h4>

4352

4353

4354

4355

4356

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

4357

4358

The set of adhoc attributes passed in, in the form

4359

of an object with attribute name/configuration pairs.

4360

4361

</div>

4362

</div>

4363

4364

4365

4366

</div>

4367

4368

4369

4370

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

4371

4372

4373

4374

4375

4376

4377

4378

<code>clazz</code>

4379

4380

</li>

4381

4382

4383

4384

<code>allCfgs</code>

4385

4386

</li>

4387

4388

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

4389

</div>

4390

4391

4392

4393

4394

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

4395

</span>

4396

4397

4398

4399

4400

4401

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

4402

4403

4404

4405

4406

4407

4408

4409

4410

4411

4412

4413

<p>Inherited from

4414

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

4415

4416

4417

4418

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

4419

4420

</p>

4421

4422

4423

4424

4425

4426

</div>

4427

4428

4429

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

4430

initialization. Returns a disposable object with the attributes defined for

4431

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

4432

</div>

4433

4434

4435

4436

<h4>Parameters:</h4>

4437

4438

4439

4440

4441

4442

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

4443

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

4444

4445

4446

4447

4448

4449

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

4450

</div>

4451

4452

4453

</li>

4454

4455

4456

4457

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

4458

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

4459

4460

4461

4462

4463

4464

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

4465

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

4466

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

4467

</div>

4468

4469

4470

</li>

4471

4472

</ul>

4473

</div>

4474

4475

4476

4477

4478

<h4>Returns:</h4>

4479

4480

4481

4482

4483

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

4484

4485

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

4486

of an object with attribute name/configuration pairs.

4487

4488

</div>

4489

</div>

4490

4491

4492

4493

</div>

4494

4495

4496

4497

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

4498

4499

4500

4501

4502

4503

4504

4505

4506

4507

</li>

4508

4509

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

4510

</div>

4511

4512

4513

4514

4515

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

4516

</span>

4517

4518

4519

4520

4521

4522

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

4523

4524

4525

4526

4527

4528

4529

4530

4531

4532

4533

4534

<p>Inherited from

4535

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

4536

4537

4538

4539

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

4540

4541

</p>

4542

4543

4544

4545

4546

4547

</div>

4548

4549

4550

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

4551

the UI Event or not. The default implementation makes sure

4552

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

4553

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

4554

4555

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

4556

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

4557

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

4558

filter will match once, but the outer will match twice

4559

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

4560

and once for the outer.</p>

4561

</div>

4562

4563

4564

4565

<h4>Parameters:</h4>

4566

4567

4568

4569

4570

4571

4572

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

4573

4574

4575

4576

4577

4578

4579

</div>

4580

4581

4582

</li>

4583

4584

</ul>

4585

</div>

4586

4587

4588

4589

4590

<h4>Returns:</h4>

4591

4592

4593

4594

4595

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

4596

4597

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

4598

4599

</div>

4600

</div>

4601

4602

4603

4604

</div>

4605

4606

4607

4608

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

4609

4610

4611

4612

4613

4614

4615

4616

<code>attrName</code>

4617

4618

</li>

4619

4620

4621

4622

<code>subAttrName</code>

4623

4624

</li>

4625

4626

4627

4628

<code>currVal</code>

4629

4630

</li>

4631

4632

4633

4634

<code>newVal</code>

4635

4636

</li>

4637

4638

4639

4640

4641

4642

</li>

4643

4644

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

4645

</div>

4646

4647

4648

4649

4650

4651

4652

4653

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

4654

4655

4656

4657

4658

4659

4660

4661

4662

4663

4664

4665

<p>Inherited from

4666

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

4667

4668

4669

4670

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

4671

4672

</p>

4673

4674

4675

4676

4677

4678

</div>

4679

4680

4681

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

4682

</div>

4683

4684

4685

4686

<h4>Parameters:</h4>

4687

4688

4689

4690

4691

4692

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

4693

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

4694

4695

4696

4697

4698

4699

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

4700

</div>

4701

4702

4703

</li>

4704

4705

4706

4707

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

4708

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

4709

4710

4711

4712

4713

4714

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

4715

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

4716

</div>

4717

4718

4719

</li>

4720

4721

4722

4723

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

4724

4725

4726

4727

4728

4729

4730

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

4731

</div>

4732

4733

4734

</li>

4735

4736

4737

4738

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

4739

4740

4741

4742

4743

4744

4745

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

4746

</div>

4747

4748

4749

</li>

4750

4751

4752

4753

4754

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

4755

4756

4757

4758

4759

4760

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

4761

</div>

4762

4763

4764

</li>

4765

4766

</ul>

4767

</div>

4768

4769

4770

4771

4772

4773

</div>

4774

4775

4776

4777

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

4778

4779

4780

4781

4782

4783

4784

4785

4786

4787

</li>

4788

4789

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

4790

</div>

4791

4792

4793

4794

4795

4796

</span>

4797

4798

4799

4800

4801

4802

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

4803

4804

4805

4806

4807

4808

4809

4810

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

4811

4812

4813

4814

4815

4816

<p>Inherited from

4817

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

4818

4819

4820

4821

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

4822

4823

</p>

4824

4825

4826

4827

4828

4829

</div>

4830

4831

4832

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

4833

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

4834

4835

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

4836

</div>

4837

4838

4839

4840

<h4>Parameters:</h4>

4841

4842

4843

4844

4845

4846

4847

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

4848

4849

4850

4851

4852

4853

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

4854

</div>

4855

4856

4857

</li>

4858

4859

</ul>

4860

</div>

4861

4862

4863

4864

4865

<h4>Returns:</h4>

4866

4867

4868

4869

4870

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

4871

4872

The value of the attribute.

4873

4874

</div>

4875

</div>

4876

4877

4878

4879

</div>

4880

4881

4882

4883

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

4884

4885

4886

4887

4888

4889

4890

4891

4892

4893

</li>

4894

4895

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

4896

</div>

4897

4898

4899

4900

4901

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

4902

</span>

4903

4904

4905

4906

4907

4908

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

4909

4910

4911

4912

4913

4914

4915

4916

4917

4918

4919

4920

<p>Inherited from

4921

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

4922

4923

4924

4925

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

4926

4927

</p>

4928

4929

4930

4931

4932

4933

</div>

4934

4935

4936

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

4937

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

4938

configuration properties for all attributes.</p>

4939

</div>

4940

4941

4942

4943

<h4>Parameters:</h4>

4944

4945

4946

4947

4948

4949

4950

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

4951

4952

4953

4954

4955

4956

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

4957

</div>

4958

4959

4960

</li>

4961

4962

</ul>

4963

</div>

4964

4965

4966

4967

4968

<h4>Returns:</h4>

4969

4970

4971

4972

4973

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

4974

4975

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

4976

4977

</div>

4978

</div>

4979

4980

4981

4982

</div>

4983

4984

4985

4986

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

4987

4988

4989

4990

4991

4992

4993

4994

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

4995

</span>

4996

4997

4998

4999

5000

5001

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

5002

5003

5004

5005

5006

5007

5008

5009

5010

5011

5012

5013

<p>Inherited from

5014

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

5015

5016

5017

5018

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

5019

5020

</p>

5021

5022

5023

5024

5025

5026

</div>

5027

5028

5029

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

5030

the class hierarchy.</p>

5031

</div>

5032

5033

5034

5035

5036

5037

<h4>Returns:</h4>

5038

5039

5040

5041

5042

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

5043

5044

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

5045

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

5046

the cached value.

5047

5048

</div>

5049

</div>

5050

5051

5052

5053

</div>

5054

5055

5056

5057

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

5058

5059

5060

5061

5062

5063

5064

5065

5066

5067

</li>

5068

5069

5070

5071

5072

5073

</li>

5074

5075

5076

5077

<code>initValues</code>

5078

5079

</li>

5080

5081

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

5082

</div>

5083

5084

5085

5086

5087

5088

</span>

5089

5090

5091

5092

5093

5094

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

5095

5096

5097

5098

5099

5100

5101

5102

5103

5104

5105

<p>Inherited from

5106

5107

Attribute

5108

</a>

5109

5110

but overwritten in

5111

5112

5113

5114

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

5115

5116

</p>

5117

5118

5119

5120

5121

5122

</div>

5123

5124

5125

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

5126

either the default configuration provided, or the

5127

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

5128

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

5129

</div>

5130

5131

5132

5133

<h4>Parameters:</h4>

5134

5135

5136

5137

5138

5139

5140

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

5141

5142

5143

5144

5145

5146

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

5147

</div>

5148

5149

5150

</li>

5151

5152

5153

5154

5155

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

5156

5157

5158

5159

5160

5161

<p>The attribute configuration object</p>

5162

</div>

5163

5164

5165

</li>

5166

5167

5168

5169

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

5170

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

5171

5172

5173

5174

5175

5176

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

5177

</div>

5178

5179

5180

</li>

5181

5182

</ul>

5183

</div>

5184

5185

5186

5187

5188

<h4>Returns:</h4>

5189

5190

5191

5192

5193

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

5194

5195

The initial value of the attribute.

5196

5197

</div>

5198

</div>

5199

5200

5201

5202

</div>

5203

5204

5205

5206

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

5207

5208

5209

5210

5211

5212

5213

5214

<code>attrs</code>

5215

5216

</li>

5217

5218

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

5219

</div>

5220

5221

5222

5223

5224

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

5225

</span>

5226

5227

5228

5229

5230

5231

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

5232

5233

5234

5235

5236

5237

5238

5239

5240

5241

5242

5243

<p>Inherited from

5244

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

5245

5246

5247

5248

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

5249

5250

</p>

5251

5252

5253

5254

5255

5256

</div>

5257

5258

5259

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

5260

</div>

5261

5262

5263

5264

<h4>Parameters:</h4>

5265

5266

5267

5268

5269

5270

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

5271

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

5272

5273

5274

5275

5276

5277

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

5278

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

5279

</div>

5280

5281

5282

</li>

5283

5284

</ul>

5285

</div>

5286

5287

5288

5289

5290

<h4>Returns:</h4>

5291

5292

5293

5294

5295

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

5296

5297

An object with attribute name/value pairs.

5298

5299

</div>

5300

</div>

5301

5302

5303

5304

</div>

5305

5306

5307

5308

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

5309

5310

5311

5312

5313

5314

5315

5316

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

5317

</span>

5318

5319

5320

5321

5322

5323

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

5324

5325

5326

5327

5328

5329

5330

5331

5332

5333

5334

5335

<p>Inherited from

5336

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

5337

5338

5339

5340

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

5341

5342

</p>

5343

5344

5345

5346

5347

5348

</div>

5349

5350

5351

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

5352

</div>

5353

5354

5355

5356

5357

5358

<h4>Returns:</h4>

5359

5360

5361

5362

5363

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

5364

5365

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

5366

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

5367

cached value.

5368

5369

</div>

5370

</div>

5371

5372

5373

5374

</div>

5375

5376

5377

5378

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

5379

5380

5381

5382

5383

5384

5385

5386

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

5387

</span>

5388

5389

5390

5391

5392

5393

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

5394

5395

5396

5397

5398

5399

5400

5401

5402

5403

5404

5405

<p>Inherited from

5406

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

5407

5408

5409

5410

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

5411

5412

</p>

5413

5414

5415

5416

5417

5418

</div>

5419

5420

5421

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

5422

definitions across the class hierarchy.</p>

5423

</div>

5424

5425

5426

5427

5428

5429

<h4>Returns:</h4>

5430

5431

5432

5433

5434

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

5435

5436

HTML_PARSER definition for this instance

5437

5438

</div>

5439

</div>

5440

5441

5442

5443

</div>

5444

5445

5446

5447

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

5448

5449

5450

5451

5452

5453

5454

5455

5456

</span>

5457

5458

5459

5460

5461

5462

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

5463

5464

5465

5466

5467

5468

5469

5470

5471

5472

5473

5474

<p>Inherited from

5475

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

5476

5477

5478

5479

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

5480

5481

</p>

5482

5483

5484

5485

5486

5487

</div>

5488

5489

5490

5491

</div>

5492

5493

5494

5495

5496

5497

<h4>Returns:</h4>

5498

5499

5500

5501

5502

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

5503

5504

The Node to apply HTML_PARSER to

5505

5506

</div>

5507

</div>

5508

5509

5510

5511

</div>

5512

5513

5514

5515

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

5516

5517

5518

5519

5520

5521

5522

5523

5524

5525

</li>

5526

5527

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

5528

</div>

5529

5530

5531

5532

5533

5534

</span>

5535

5536

5537

5538

5539

5540

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

5541

5542

5543

5544

5545

5546

5547

5548

5549

5550

5551

5552

<p>Inherited from

5553

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

5554

5555

5556

5557

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

5558

5559

</p>

5560

5561

5562

5563

5564

5565

</div>

5566

5567

5568

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

5569

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

5570

</div>

5571

5572

5573

5574

<h4>Parameters:</h4>

5575

5576

5577

5578

5579

5580

5581

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

5582

5583

5584

5585

5586

5587

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

5588

</div>

5589

5590

5591

</li>

5592

5593

</ul>

5594

</div>

5595

5596

5597

5598

5599

<h4>Returns:</h4>

5600

5601

5602

5603

5604

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

5605

5606

The stored value of the attribute

5607

5608

</div>

5609

</div>

5610

5611

5612

5613

</div>

5614

5615

5616

5617

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

5618

5619

5620

5621

5622

5623

5624

5625

<code>locale</code>

5626

5627

</li>

5628

5629

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

5630

</div>

5631

5632

5633

5634

5635

5636

5637

5638

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

5639

5640

5641

5642

5643

5644

5645

5646

5647

5648

5649

5650

<p>Inherited from

5651

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

5652

5653

5654

5655

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

5656

5657

</p>

5658

5659

5660

5661

5662

5663

</div>

5664

5665

5666

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

5667

</div>

5668

5669

5670

5671

<h4>Parameters:</h4>

5672

5673

5674

5675

5676

5677

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

5678

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

5679

5680

5681

5682

5683

5684

5685

</div>

5686

5687

5688

</li>

5689

5690

</ul>

5691

</div>

5692

5693

5694

5695

5696

5697

</div>

5698

5699

5700

5701

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

5702

5703

5704

5705

5706

5707

5708

5709

5710

5711

5712

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

5713

5714

5715

5716

5717

5718

5719

5720

5721

5722

5723

5724

<p>Inherited from

5725

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

5726

5727

5728

5729

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

5730

5731

</p>

5732

5733

5734

5735

5736

5737

</div>

5738

5739

5740

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

5741

event type is not prefixed, the instance prefix is

5742

applied to the supplied type.</p>

5743

</div>

5744

5745

5746

5747

5748

5749

5750

</div>

5751

5752

5753

5754

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

5755

5756

5757

5758

5759

5760

5761

5762

5763

5764

5765

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

5766

5767

5768

5769

5770

5771

5772

5773

5774

5775

5776

<p>Inherited from

5777

5778

Widget

5779

</a>

5780

5781

but overwritten in

5782

5783

5784

5785

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

5786

5787

</p>

5788

5789

5790

5791

5792

5793

</div>

5794

5795

5796

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

5797

5798

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

5799

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

5800

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

5801

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

5802

event listener.</p>

5803

</div>

5804

5805

5806

5807

5808

5809

5810

</div>

5811

5812

5813

5814

5815

5816

5817

5818

5819

5820

5821

5822

5823

5824

5825

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

5826

5827

5828

5829

5830

5831

5832

5833

5834

5835

5836

5837

<p>Inherited from

5838

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

5839

5840

5841

5842

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

5843

5844

</p>

5845

5846

5847

5848

5849

5850

</div>

5851

5852

5853

5854

</div>

5855

5856

5857

5858

5859

5860

5861

</div>

5862

5863

5864

5865

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

5866

5867

5868

5869

5870

5871

5872

5873

<code>attrs</code>

5874

5875

</li>

5876

5877

5878

5879

<code>values</code>

5880

5881

</li>

5882

5883

5884

5885

5886

5887

</li>

5888

5889

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

5890

</div>

5891

5892

5893

5894

5895

5896

5897

5898

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

5899

5900

5901

5902

5903

5904

5905

5906

5907

5908

5909

5910

<p>Inherited from

5911

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

5912

5913

5914

5915

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

5916

5917

</p>

5918

5919

5920

5921

5922

5923

</div>

5924

5925

5926

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

5927

constructor.</p>

5928

</div>

5929

5930

5931

5932

<h4>Parameters:</h4>

5933

5934

5935

5936

5937

5938

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

5939

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

5940

5941

5942

5943

5944

5945

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

5946

</div>

5947

5948

5949

</li>

5950

5951

5952

5953

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

5954

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

5955

5956

5957

5958

5959

5960

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

5961

</div>

5962

5963

5964

</li>

5965

5966

5967

5968

5969

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

5970

5971

5972

5973

5974

5975

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

5976

</div>

5977

5978

5979

</li>

5980

5981

</ul>

5982

</div>

5983

5984

5985

5986

5987

5988

</div>

5989

5990

5991

5992

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

5993

5994

5995

5996

5997

5998

5999

6000

6001

6002

6003

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

6004

6005

6006

6007

6008

6009

6010

6011

6012

6013

6014

<p>Inherited from

6015

6016

BaseCore

6017

</a>

6018

6019

but overwritten in

6020

6021

6022

6023

6024

6025

</p>

6026

6027

6028

6029

6030

6031

</div>

6032

6033

6034

<p>Initializes Attribute</p>

6035

</div>

6036

6037

6038

6039

6040

6041

6042

</div>

6043

6044

6045

6046

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

6047

6048

6049

6050

6051

6052

6053

6054

<code>attrs</code>

6055

6056

</li>

6057

6058

6059

6060

<code>values</code>

6061

6062

</li>

6063

6064

6065

6066

6067

6068

</li>

6069

6070

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

6071

</div>

6072

6073

6074

6075

6076

6077

6078

6079

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

6080

6081

6082

6083

6084

6085

6086

6087

6088

6089

6090

6091

<p>Inherited from

6092

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

6093

6094

6095

6096

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

6097

6098

</p>

6099

6100

6101

6102

6103

6104

</div>

6105

6106

6107

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

6108

</div>

6109

6110

6111

6112

<h4>Parameters:</h4>

6113

6114

6115

6116

6117

6118

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

6119

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

6120

6121

6122

6123

6124

6125

6126

</div>

6127

6128

6129

</li>

6130

6131

6132

6133

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

6134

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

6135

6136

6137

6138

6139

6140

6141

</div>

6142

6143

6144

</li>

6145

6146

6147

6148

6149

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

6150

6151

6152

6153

6154

6155

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

6156

</div>

6157

6158

6159

</li>

6160

6161

</ul>

6162

</div>

6163

6164

6165

6166

6167

6168

</div>

6169

6170

6171

6172

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

6173

6174

6175

6176

6177

6178

6179

6180

<code>config</code>

6181

6182

</li>

6183

6184

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

6185

</div>

6186

6187

6188

6189

6190

6191

6192

6193

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

6194

6195

6196

6197

6198

6199

6200

6201

6202

6203

6204

<p>Inherited from

6205

6206

BaseCore

6207

</a>

6208

6209

but overwritten in

6210

6211

6212

6213

6214

6215

</p>

6216

6217

6218

6219

6220

6221

</div>

6222

6223

6224

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

6225

</div>

6226

6227

6228

6229

<h4>Parameters:</h4>

6230

6231

6232

6233

6234

6235

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

6236

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

6237

6238

6239

6240

6241

6242

<p>The constructor configuration object</p>

6243

</div>

6244

6245

6246

</li>

6247

6248

</ul>

6249

</div>

6250

6251

6252

6253

6254

6255

</div>

6256

6257

6258

6259

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

6260

6261

6262

6263

6264

6265

6266

6267

<code>userVals</code>

6268

6269

</li>

6270

6271

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

6272

</div>

6273

6274

6275

6276

6277

6278

6279

6280

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

6281

6282

6283

6284

6285

6286

6287

6288

6289

6290

6291

6292

<p>Inherited from

6293

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

6294

6295

6296

6297

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

6298

6299

</p>

6300

6301

6302

6303

6304

6305

</div>

6306

6307

6308

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

6309

initializing attributes for each class defined in the class's

6310

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

6311

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

6312

</div>

6313

6314

6315

6316

<h4>Parameters:</h4>

6317

6318

6319

6320

6321

6322

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

6323

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

6324

6325

6326

6327

6328

6329

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

6330

</div>

6331

6332

6333

</li>

6334

6335

</ul>

6336

</div>

6337

6338

6339

6340

6341

6342

</div>

6343

6344

6345

6346

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

6347

6348

6349

6350

6351

6352

6353

6354

6355

6356

6357

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

6358

6359

6360

6361

6362

6363

6364

6365

6366

6367

6368

6369

<p>Inherited from

6370

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

6371

6372

6373

6374

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

6375

6376

</p>

6377

6378

6379

6380

6381

6382

</div>

6383

6384

6385

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

6386

the array of classes and aggregate set of attribute configurations

6387

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

6388

</div>

6389

6390

6391

6392

6393

6394

6395

</div>

6396

6397

6398

6399

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

6400

6401

6402

6403

6404

6405

6406

6407

6408

6409

</li>

6410

6411

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

6412

</div>

6413

6414

6415

6416

6417

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

6418

</span>

6419

6420

6421

6422

6423

6424

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

6425

6426

6427

6428

6429

6430

6431

6432

6433

6434

6435

6436

<p>Inherited from

6437

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

6438

6439

6440

6441

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

6442

6443

</p>

6444

6445

6446

6447

6448

6449

</div>

6450

6451

6452

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

6453

</div>

6454

6455

6456

6457

<h4>Parameters:</h4>

6458

6459

6460

6461

6462

6463

6464

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

6465

6466

6467

6468

6469

6470

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

6471

</div>

6472

6473

6474

</li>

6475

6476

</ul>

6477

</div>

6478

6479

6480

6481

6482

<h4>Returns:</h4>

6483

6484

6485

6486

6487

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

6488

6489

6490

</div>

6491

</div>

6492

6493

6494

6495

</div>

6496

6497

6498

6499

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

6500

6501

6502

6503

6504

6505

6506

6507

6508

6509

</li>

6510

6511

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

6512

</div>

6513

6514

6515

6516

6517

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

6518

</span>

6519

6520

6521

6522

6523

6524

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

6525

6526

6527

6528

6529

6530

6531

6532

6533

6534

6535

6536

<p>Inherited from

6537

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

6538

6539

6540

6541

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

6542

6543

</p>

6544

6545

6546

6547

6548

6549

</div>

6550

6551

6552

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

6553

added lazily and still requires initialization.</p>

6554

</div>

6555

6556

6557

6558

<h4>Parameters:</h4>

6559

6560

6561

6562

6563

6564

6565

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

6566

6567

6568

6569

6570

6571

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

6572

</div>

6573

6574

6575

</li>

6576

6577

</ul>

6578

</div>

6579

6580

6581

6582

6583

<h4>Returns:</h4>

6584

6585

6586

6587

6588

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

6589

6590

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

6591

6592

</div>

6593

</div>

6594

6595

6596

6597

</div>

6598

6599

6600

6601

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

6602

6603

6604

6605

6606

6607

6608

6609

6610

6611

</li>

6612

6613

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

6614

</div>

6615

6616

6617

6618

6619

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

6620

</span>

6621

6622

6623

6624

6625

6626

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

6627

6628

6629

6630

6631

6632

6633

6634

6635

6636

6637

6638

<p>Inherited from

6639

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

6640

6641

6642

6643

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

6644

6645

</p>

6646

6647

6648

6649

6650

6651

</div>

6652

6653

6654

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

6655

</div>

6656

6657

6658

6659

<h4>Parameters:</h4>

6660

6661

6662

6663

6664

6665

6666

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

6667

6668

6669

6670

6671

6672

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

6673

</div>

6674

6675

6676

</li>

6677

6678

</ul>

6679

</div>

6680

6681

6682

6683

6684

<h4>Returns:</h4>

6685

6686

6687

6688

6689

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

6690

6691

Event Returns the name of the UI Event, otherwise

6692

undefined.

6693

6694

</div>

6695

</div>

6696

6697

6698

6699

</div>

6700

6701

6702

6703

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

6704

6705

6706

6707

6708

6709

6710

6711

6712

6713

</li>

6714

6715

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

6716

</div>

6717

6718

6719

6720

6721

6722

6723

6724

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

6725

6726

6727

6728

6729

6730

6731

6732

6733

6734

6735

6736

<p>Inherited from

6737

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

6738

6739

6740

6741

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

6742

6743

</p>

6744

6745

6746

6747

6748

6749

</div>

6750

6751

6752

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

6753

6754

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

6755

</div>

6756

6757

6758

6759

<h4>Parameters:</h4>

6760

6761

6762

6763

6764

6765

6766

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

6767

6768

6769

6770

6771

6772

<p>boundingBox id</p>

6773

</div>

6774

6775

6776

</li>

6777

6778

</ul>

6779

</div>

6780

6781

6782

6783

6784

6785

</div>

6786

6787

6788

6789

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

6790

6791

6792

6793

6794

6795

6796

6797

6798

6799

</li>

6800

6801

6802

6803

6804

6805

</li>

6806

6807

6808

6809

6810

6811

</li>

6812

6813

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

6814

</div>

6815

6816

6817

6818

6819

6820

6821

6822

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

6823

6824

6825

6826

6827

6828

6829

6830

6831

6832

6833

6834

<p>Inherited from

6835

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

6836

6837

6838

6839

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

6840

6841

</p>

6842

6843

6844

6845

6846

6847

</div>

6848

6849

6850

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

6851

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

6852

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

6853

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

6854

be subscribed to like other events to monitor the event

6855

system. Inividual published events can have monitoring

6856

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

6857

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

6858

</div>

6859

6860

6861

6862

<h4>Parameters:</h4>

6863

6864

6865

6866

6867

6868

6869

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

6870

6871

6872

6873

6874

6875

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

6876

</div>

6877

6878

6879

</li>

6880

6881

6882

6883

6884

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

6885

6886

6887

6888

6889

6890

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

6891

</div>

6892

6893

6894

</li>

6895

6896

6897

6898

6899

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

6900

6901

6902

6903

6904

6905

<p>Information about the event interaction, such as

6906

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

6907

</div>

6908

6909

6910

</li>

6911

6912

</ul>

6913

</div>

6914

6915

6916

6917

6918

6919

</div>

6920

6921

6922

6923

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

6924

6925

6926

6927

6928

6929

6930

6931

<code>valueHash</code>

6932

6933

</li>

6934

6935

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

6936

</div>

6937

6938

6939

6940

6941

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

6942

</span>

6943

6944

6945

6946

6947

6948

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

6949

6950

6951

6952

6953

6954

6955

6956

6957

6958

6959

<p>Inherited from

6960

6961

Attribute

6962

</a>

6963

6964

but overwritten in

6965

6966

6967

6968

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

6969

6970

</p>

6971

6972

6973

6974

6975

6976

</div>

6977

6978

6979

<p>Utility method to normalize attribute values. The base implementation

6980

simply merges the hash to protect the original.</p>

6981

</div>

6982

6983

6984

6985

<h4>Parameters:</h4>

6986

6987

6988

6989

6990

6991

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

6992

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

6993

6994

6995

6996

6997

6998

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

6999

</div>

7000

7001

7002

</li>

7003

7004

</ul>

7005

</div>

7006

7007

7008

7009

7010

<h4>Returns:</h4>

7011

7012

7013

7014

7015

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

7016

7017

7018

</div>

7019

</div>

7020

7021

7022

7023

</div>

7024

7025

7026

7027

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

7028

7029

7030

7031

7032

7033

7034

7035

7036

7037

</li>

7038

7039

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

7040

</div>

7041

7042

7043

7044

7045

7046

7047

7048

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

7049

7050

7051

7052

7053

7054

7055

7056

7057

7058

7059

7060

<p>Inherited from

7061

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

7062

7063

7064

7065

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

7066

7067

</p>

7068

7069

7070

7071

7072

7073

</div>

7074

7075

7076

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

7077

</div>

7078

7079

7080

7081

<h4>Parameters:</h4>

7082

7083

7084

7085

7086

7087

7088

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

7089

7090

7091

7092

7093

7094

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

7095

</div>

7096

7097

7098

</li>

7099

7100

</ul>

7101

</div>

7102

7103

7104

7105

7106

7107

</div>

7108

7109

7110

7111

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

7112

7113

7114

7115

7116

7117

7118

7119

7120

7121

</li>

7122

7123

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

7124

</div>

7125

7126

7127

7128

7129

7130

7131

7132

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

7133

7134

7135

7136

7137

7138

7139

7140

7141

7142

7143

7144

<p>Inherited from

7145

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

7146

7147

7148

7149

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

7150

7151

</p>

7152

7153

7154

7155

7156

7157

</div>

7158

7159

7160

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

7161

widget's bounding box.</p>

7162

</div>

7163

7164

7165

7166

<h4>Parameters:</h4>

7167

7168

7169

7170

7171

7172

7173

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

7174

7175

7176

7177

7178

7179

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

7180

</div>

7181

7182

7183

</li>

7184

7185

</ul>

7186

</div>

7187

7188

7189

7190

7191

7192

</div>

7193

7194

7195

7196

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

7197

7198

7199

7200

7201

7202

7203

7204

7205

7206

7207

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

7208

7209

7210

7211

7212

7213

7214

7215

7216

7217

7218

7219

<p>Inherited from

7220

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

7221

7222

7223

7224

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

7225

7226

</p>

7227

7228

7229

7230

7231

7232

</div>

7233

7234

7235

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

7236

and the prefixed event name from _getType

7237

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

7238

</div>

7239

7240

7241

7242

7243

7244

7245

</div>

7246

7247

7248

7249

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

7250

7251

7252

7253

7254

7255

7256

7257

<code>config</code>

7258

7259

</li>

7260

7261

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

7262

</div>

7263

7264

7265

7266

7267

7268

7269

7270

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

7271

7272

7273

7274

7275

7276

7277

7278

7279

7280

7281

7282

<p>Inherited from

7283

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

7284

7285

7286

7287

7288

7289

</p>

7290

7291

7292

7293

7294

7295

</div>

7296

7297

7298

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

7299

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

7300

construction, prior to init.</p>

7301

</div>

7302

7303

7304

7305

<h4>Parameters:</h4>

7306

7307

7308

7309

7310

7311

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

7312

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

7313

7314

7315

7316

7317

7318

<p>The user configuration object</p>

7319

</div>

7320

7321

7322

</li>

7323

7324

</ul>

7325

</div>

7326

7327

7328

7329

7330

7331

</div>

7332

7333

7334

7335

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

7336

7337

7338

7339

7340

7341

7342

7343

<code>attrs</code>

7344

7345

</li>

7346

7347

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

7348

</div>

7349

7350

7351

7352

7353

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

7354

</span>

7355

7356

7357

7358

7359

7360

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

7361

7362

7363

7364

7365

7366

7367

7368

7369

7370

7371

7372

<p>Inherited from

7373

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

7374

7375

7376

7377

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

7378

7379

</p>

7380

7381

7382

7383

7384

7385

</div>

7386

7387

7388

<p>Utility method to protect an attribute configuration

7389

hash, by merging the entire object and the individual

7390

attr config objects.</p>

7391

</div>

7392

7393

7394

7395

<h4>Parameters:</h4>

7396

7397

7398

7399

7400

7401

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

7402

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

7403

7404

7405

7406

7407

7408

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

7409

</div>

7410

7411

7412

</li>

7413

7414

</ul>

7415

</div>

7416

7417

7418

7419

7420

<h4>Returns:</h4>

7421

7422

7423

7424

7425

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

7426

7427

A protected version of the attrs argument.

7428

7429

</div>

7430

</div>

7431

7432

7433

7434

</div>

7435

7436

7437

7438

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

7439

7440

7441

7442

7443

7444

7445

7446

7447

7448

7449

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

7450

7451

7452

7453

7454

7455

7456

7457

7458

7459

7460

7461

<p>Inherited from

7462

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

7463

7464

7465

7466

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

7467

7468

</p>

7469

7470

7471

7472

7473

7474

</div>

7475

7476

7477

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

7478

the boundingBox.</p>

7479

</div>

7480

7481

7482

7483

7484

7485

7486

</div>

7487

7488

7489

7490

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

7491

7492

7493

7494

7495

7496

7497

7498

<code>parentNode</code>

7499

7500

</li>

7501

7502

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

7503

</div>

7504

7505

7506

7507

7508

7509

7510

7511

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

7512

7513

7514

7515

7516

7517

7518

7519

7520

7521

7522

7523

<p>Inherited from

7524

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

7525

7526

7527

7528

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

7529

7530

</p>

7531

7532

7533

7534

7535

7536

</div>

7537

7538

7539

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

7540

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

7541

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

7542

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

7543

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

7544

</div>

7545

7546

7547

7548

<h4>Parameters:</h4>

7549

7550

7551

7552

7553

7554

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

7555

7556

7557

7558

7559

7560

7561

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

7562

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

7563

</div>

7564

7565

7566

</li>

7567

7568

</ul>

7569

</div>

7570

7571

7572

7573

7574

7575

</div>

7576

7577

7578

7579

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

7580

7581

7582

7583

7584

7585

7586

7587

7588

7589

7590

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

7591

7592

7593

7594

7595

7596

7597

7598

7599

7600

7601

7602

<p>Inherited from

7603

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

7604

7605

7606

7607

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

7608

7609

</p>

7610

7611

7612

7613

7614

7615

</div>

7616

7617

7618

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

7619

</div>

7620

7621

7622

7623

7624

7625

7626

</div>

7627

7628

7629

7630

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

7631

7632

7633

7634

7635

7636

7637

7638

7639

7640

7641

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

7642

7643

7644

7645

7646

7647

7648

7649

7650

7651

7652

7653

<p>Inherited from

7654

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

7655

7656

7657

7658

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

7659

7660

</p>

7661

7662

7663

7664

7665

7666

</div>

7667

7668

7669

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

7670

</div>

7671

7672

7673

7674

7675

7676

7677

</div>

7678

7679

7680

7681

7682

7683

7684

7685

7686

7687

7688

7689

7690

7691

</li>

7692

7693

7694

7695

7696

7697

</li>

7698

7699

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

7700

</div>

7701

7702

7703

7704

7705

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

7706

</span>

7707

7708

7709

7710

7711

7712

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

7713

7714

7715

7716

7717

7718

7719

7720

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

7721

7722

7723

7724

7725

<p>Inherited from

7726

7727

AttributeEvents

7728

</a>

7729

7730

but overwritten in

7731

7732

7733

7734

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

7735

7736

</p>

7737

7738

7739

7740

7741

7742

</div>

7743

7744

7745

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

7746

</div>

7747

7748

7749

7750

<h4>Parameters:</h4>

7751

7752

7753

7754

7755

7756

7757

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

7758

7759

7760

7761

7762

7763

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

7764

</div>

7765

7766

7767

</li>

7768

7769

7770

7771

7772

7773

7774

7775

7776

7777

7778

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

7779

</div>

7780

7781

7782

</li>

7783

7784

</ul>

7785

</div>

7786

7787

7788

7789

7790

<h4>Returns:</h4>

7791

7792

7793

7794

7795

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

7796

7797

A reference to the host object.

7798

7799

</div>

7800

</div>

7801

7802

7803

7804

</div>

7805

7806

7807

7808

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

7809

7810

7811

7812

7813

7814

7815

7816

7817

7818

</li>

7819

7820

7821

7822

<code>value</code>

7823

7824

</li>

7825

7826

7827

7828

7829

7830

</li>

7831

7832

7833

7834

<code>force</code>

7835

7836

</li>

7837

7838

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

7839

</div>

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

</span>

7846

7847

7848

7849

7850

7851

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

7852

7853

7854

7855

7856

7857

7858

7859

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

7860

7861

7862

7863

7864

7865

<p>Inherited from

7866

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

7867

7868

7869

7870

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

7871

7872

</p>

7873

7874

7875

7876

7877

7878

</div>

7879

7880

7881

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

7882

7883

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

7884

</div>

7885

7886

7887

7888

<h4>Parameters:</h4>

7889

7890

7891

7892

7893

7894

7895

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

7896

7897

7898

7899

7900

7901

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

7902

</div>

7903

7904

7905

</li>

7906

7907

7908

7909

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

7910

7911

7912

7913

7914

7915

7916

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

7917

</div>

7918

7919

7920

</li>

7921

7922

7923

7924

7925

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

7926

7927

7928

7929

7930

7931

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

7932

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

7933

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

7934

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

7935

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

7936

</div>

7937

7938

7939

</li>

7940

7941

7942

7943

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

7944

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

7945

7946

7947

7948

7949

7950

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

7951

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

7952

</div>

7953

7954

7955

</li>

7956

7957

</ul>

7958

</div>

7959

7960

7961

7962

7963

<h4>Returns:</h4>

7964

7965

7966

7967

7968

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

7969

7970

A reference to the host object.

7971

7972

</div>

7973

</div>

7974

7975

7976

7977

</div>

7978

7979

7980

7981

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

7982

7983

7984

7985

7986

7987

7988

7989

<code>attrs</code>

7990

7991

</li>

7992

7993

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

7994

</div>

7995

7996

7997

7998

7999

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

8000

</span>

8001

8002

8003

8004

8005

8006

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

8007

8008

8009

8010

8011

8012

8013

8014

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

8015

8016

8017

8018

8019

8020

<p>Inherited from

8021

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

8022

8023

8024

8025

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

8026

8027

</p>

8028

8029

8030

8031

8032

8033

</div>

8034

8035

8036

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

8037

</div>

8038

8039

8040

8041

<h4>Parameters:</h4>

8042

8043

8044

8045

8046

8047

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

8048

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

8049

8050

8051

8052

8053

8054

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

8055

</div>

8056

8057

8058

</li>

8059

8060

</ul>

8061

</div>

8062

8063

8064

8065

8066

<h4>Returns:</h4>

8067

8068

8069

8070

8071

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

8072

8073

A reference to the host object.

8074

8075

</div>

8076

</div>

8077

8078

8079

8080

</div>

8081

8082

8083

8084

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

8085

8086

8087

8088

8089

8090

8091

8092

8093

8094

</li>

8095

8096

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

8097

</div>

8098

8099

8100

8101

8102

8103

8104

8105

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

8106

8107

8108

8109

8110

8111

8112

8113

8114

8115

8116

8117

<p>Inherited from

8118

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

8119

8120

8121

8122

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

8123

8124

</p>

8125

8126

8127

8128

8129

8130

</div>

8131

8132

8133

8134

</div>

8135

8136

8137

8138

<h4>Parameters:</h4>

8139

8140

8141

8142

8143

8144

8145

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

8146

8147

8148

8149

8150

8151

8152

</div>

8153

8154

8155

</li>

8156

8157

</ul>

8158

</div>

8159

8160

8161

8162

8163

8164

</div>

8165

8166

8167

8168

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

8169

8170

8171

8172

8173

8174

8175

8176

<code>attrName</code>

8177

8178

</li>

8179

8180

8181

8182

<code>subAttrName</code>

8183

8184

</li>

8185

8186

8187

8188

<code>prevVal</code>

8189

8190

</li>

8191

8192

8193

8194

<code>newVal</code>

8195

8196

</li>

8197

8198

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

8199

</div>

8200

8201

8202

8203

8204

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

8205

</span>

8206

8207

8208

8209

8210

8211

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

8212

8213

8214

8215

8216

8217

8218

8219

8220

8221

8222

8223

<p>Inherited from

8224

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

8225

8226

8227

8228

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

8229

8230

</p>

8231

8232

8233

8234

8235

8236

</div>

8237

8238

8239

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

8240

if validation and setter passes.</p>

8241

</div>

8242

8243

8244

8245

<h4>Parameters:</h4>

8246

8247

8248

8249

8250

8251

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

8252

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

8253

8254

8255

8256

8257

8258

<p>The attribute name.</p>

8259

</div>

8260

8261

8262

</li>

8263

8264

8265

8266

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

8267

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

8268

8269

8270

8271

8272

8273

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

8274

</div>

8275

8276

8277

</li>

8278

8279

8280

8281

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

8282

8283

8284

8285

8286

8287

8288

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

8289

</div>

8290

8291

8292

</li>

8293

8294

8295

8296

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

8297

8298

8299

8300

8301

8302

8303

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

8304

</div>

8305

8306

8307

</li>

8308

8309

</ul>

8310

</div>

8311

8312

8313

8314

8315

<h4>Returns:</h4>

8316

8317

8318

8319

8320

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

8321

8322

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

8323

8324

</div>

8325

</div>

8326

8327

8328

8329

</div>

8330

8331

8332

8333

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

8334

8335

8336

8337

8338

8339

8340

8341

<code>Node/String</code>

8342

8343

</li>

8344

8345

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

8346

</div>

8347

8348

8349

8350

8351

8352

</span>

8353

8354

8355

8356

8357

8358

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

8359

8360

8361

8362

8363

8364

8365

8366

8367

8368

8369

8370

<p>Inherited from

8371

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

8372

8373

8374

8375

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

8376

8377

</p>

8378

8379

8380

8381

8382

8383

</div>

8384

8385

8386

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

8387

</div>

8388

8389

8390

8391

<h4>Parameters:</h4>

8392

8393

8394

8395

8396

8397

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

8398

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

8399

8400

8401

8402

8403

8404

8405

</div>

8406

8407

8408

</li>

8409

8410

</ul>

8411

</div>

8412

8413

8414

8415

8416

<h4>Returns:</h4>

8417

8418

8419

8420

8421

Node

8422

8423

</div>

8424

</div>

8425

8426

8427

8428

</div>

8429

8430

8431

8432

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

8433

8434

8435

8436

8437

8438

8439

8440

8441

8442

</li>

8443

8444

8445

8446

8447

8448

</li>

8449

8450

8451

8452

<code>template</code>

8453

8454

</li>

8455

8456

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

8457

</div>

8458

8459

8460

8461

8462

8463

</span>

8464

8465

8466

8467

8468

8469

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

8470

8471

8472

8473

8474

8475

8476

8477

8478

8479

8480

8481

<p>Inherited from

8482

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

8483

8484

8485

8486

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

8487

8488

</p>

8489

8490

8491

8492

8493

8494

</div>

8495

8496

8497

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

8498

the provided template if not found.</p>

8499

</div>

8500

8501

8502

8503

<h4>Parameters:</h4>

8504

8505

8506

8507

8508

8509

8510

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

8511

8512

8513

8514

8515

8516

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

8517

</div>

8518

8519

8520

</li>

8521

8522

8523

8524

8525

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

8526

8527

8528

8529

8530

8531

<p>The node reference</p>

8532

</div>

8533

8534

8535

</li>

8536

8537

8538

8539

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

8540

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

8541

8542

8543

8544

8545

8546

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

8547

</div>

8548

8549

8550

</li>

8551

8552

</ul>

8553

</div>

8554

8555

8556

8557

8558

<h4>Returns:</h4>

8559

8560

8561

8562

8563

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

8564

8565

The node

8566

8567

</div>

8568

</div>

8569

8570

8571

8572

</div>

8573

8574

8575

8576

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

8577

8578

8579

8580

8581

8582

8583

8584

8585

8586

</li>

8587

8588

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

8589

</div>

8590

8591

8592

8593

8594

8595

</span>

8596

8597

8598

8599

8600

8601

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

8602

8603

8604

8605

8606

8607

8608

8609

8610

8611

8612

8613

<p>Inherited from

8614

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

8615

8616

8617

8618

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

8619

8620

</p>

8621

8622

8623

8624

8625

8626

</div>

8627

8628

8629

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

8630

</div>

8631

8632

8633

8634

<h4>Parameters:</h4>

8635

8636

8637

8638

8639

8640

8641

8642

8643

8644

8645

8646

8647

8648

</div>

8649

8650

8651

</li>

8652

8653

</ul>

8654

</div>

8655

8656

8657

8658

8659

<h4>Returns:</h4>

8660

8661

8662

8663

8664

Node

8665

8666

</div>

8667

</div>

8668

8669

8670

8671

</div>

8672

8673

8674

8675

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

8676

8677

8678

8679

8680

8681

8682

8683

8684

8685

</li>

8686

8687

8688

8689

<code>value</code>

8690

8691

</li>

8692

8693

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

8694

</div>

8695

8696

8697

8698

8699

8700

8701

8702

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

8703

8704

8705

8706

8707

8708

8709

8710

8711

8712

8713

8714

<p>Inherited from

8715

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

8716

8717

8718

8719

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

8720

8721

</p>

8722

8723

8724

8725

8726

8727

</div>

8728

8729

8730

<p>Sets the stored value for the attribute, in either the

8731

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

8732

</div>

8733

8734

8735

8736

<h4>Parameters:</h4>

8737

8738

8739

8740

8741

8742

8743

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

8744

8745

8746

8747

8748

8749

<p>The name of the attribute</p>

8750

</div>

8751

8752

8753

</li>

8754

8755

8756

8757

<code class="param-name">value</code>

8758

8759

8760

8761

8762

8763

8764

<p>The value of the attribute</p>

8765

</div>

8766

8767

8768

</li>

8769

8770

</ul>

8771

</div>

8772

8773

8774

8775

8776

8777

</div>

8778

8779

8780

8781

<h3 class="name"><code>_setStrings</code></h3>

8782

8783

8784

8785

8786

8787

8788

8789

<code>strings</code>

8790

8791

</li>

8792

8793

8794

8795

<code>locale</code>

8796

8797

</li>

8798

8799

</ul><span class="paren">)</span>

8800

</div>

8801

8802

8803

8804

8805

8806

8807

8808

<span class="flag protected">protected</span>

8809

8810

8811

8812

8813

8814

8815

8816

8817

8818

8819

8820

<p>Inherited from

8821

<a href="../classes/Widget.html#method__setStrings">Widget</a>:

8822

8823

8824

8825

<a href="../files/widget_js_WidgetLocale.js.html#l32"><code>widget/js/WidgetLocale.js:32</code></a>

8826

8827

</p>

8828

8829

8830

8831

8832

8833

</div>

8834

8835

8836

<p>Sets strings for a particular locale, merging with any existing

8837

strings which may already be defined for the locale.</p>

8838

</div>

8839

8840

8841

8842

<h4>Parameters:</h4>

8843

8844

8845

8846

8847

8848

<code class="param-name">strings</code>

8849

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>

8850

8851

8852

8853

8854

8855

<p>The hash of string key/values to set</p>

8856

</div>

8857

8858

8859

</li>

8860

8861

8862

8863

<code class="param-name">locale</code>

8864

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>

8865

8866

8867

8868

8869

8870

<p>The locale for the string values being set</p>

8871

</div>

8872

8873

8874

</li>

8875

8876

</ul>

8877

</div>

8878

8879

8880

8881

8882

8883

</div>

8884

8885

8886

8887

<h3 class="name"><code>_strSetter</code></h3>

8888

8889

8890

8891

8892

8893

8894

8895

<code>strings</code>

8896

8897

</li>

8898

8899

</ul><span class="paren">)</span>

8900

</div>

8901

8902

8903

8904

8905

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

8906

</span>

8907

8908

8909

8910

8911

8912

<span class="flag protected">protected</span>

8913

8914

8915

8916

8917

8918

8919

8920

8921

8922

8923

8924

<p>Inherited from

8925

<a href="../classes/Widget.html#method__strSetter">Widget</a>:

8926

8927

8928

8929

<a href="../files/widget_js_Widget.js.html#l1199"><code>widget/js/Widget.js:1199</code></a>

8930

8931

</p>

8932

8933

8934

8935

8936

8937

</div>

8938

8939

8940

<p>The default setter for the strings attribute. Merges partial sets

8941

into the full string set, to allow users to partial sets of strings</p>

8942

</div>

8943

8944

8945

8946

<h4>Parameters:</h4>

8947

8948

8949

8950

8951

8952

<code class="param-name">strings</code>

8953

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>

8954

8955

8956

8957

8958

8959

8960

</div>

8961

8962

8963

</li>

8964

8965

</ul>

8966

</div>

8967

8968

8969

8970

8971

<h4>Returns:</h4>

8972

8973

8974

8975

8976

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>:

8977

8978

The full set of strings to set

8979

8980

</div>

8981

</div>

8982

8983

8984

8985

</div>

8986

8987

8988

8989

<h3 class="name"><code>_syncAttrUI</code></h3>

8990

8991

8992

8993

8994

8995

8996

8997

<code>attrs</code>

8998

8999

</li>

9000

9001

</ul><span class="paren">)</span>

9002

</div>

9003

9004

9005

9006

9007

9008

9009

9010

<span class="flag private">private</span>

9011

9012

9013

9014

9015

9016

9017

9018

9019

9020

9021

9022

<p>Inherited from

9023

<a href="../classes/Widget.html#method__syncAttrUI">Widget</a>:

9024

9025

9026

9027

<a href="../files/widget_js_Widget.js.html#l1173"><code>widget/js/Widget.js:1173</code></a>

9028

9029

</p>

9030

9031

9032

9033

9034

9035

</div>

9036

9037

9038

<p>Invokes the _uiSet=ATTR NAME> method for the list of attributes provided</p>

9039

</div>

9040

9041

9042

9043

<h4>Parameters:</h4>

9044

9045

9046

9047

9048

9049

<code class="param-name">attrs</code>

9050

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Array" class="crosslink external" target="_blank">Array</a></span>

9051

9052

9053

9054

9055

9056

9057

</div>

9058

9059

9060

</li>

9061

9062

</ul>

9063

</div>

9064

9065

9066

9067

9068

9069

</div>

9070

9071

9072

9073

<h3 class="name"><code>_syncUI</code></h3>

9074

9075

9076

9077

9078

9079

9080

9081

9082

9083

9084

<span class="flag protected">protected</span>

9085

9086

9087

9088

9089

9090

9091

9092

9093

9094

9095

9096

<p>Inherited from

9097

<a href="../classes/Widget.html#method__syncUI">Widget</a>:

9098

9099

9100

9101

<a href="../files/widget_js_Widget.js.html#l951"><code>widget/js/Widget.js:951</code></a>

9102

9103

</p>

9104

9105

9106

9107

9108

9109

</div>

9110

9111

9112

<p>Updates the widget UI to reflect the attribute state.</p>

9113

</div>

9114

9115

9116

9117

9118

9119

9120

</div>

9121

9122

9123

9124

<h3 class="name"><code>_syncUIChild</code></h3>

9125

9126

9127

9128

9129

9130

9131

9132

9133

9134

9135

<span class="flag protected">protected</span>

9136

9137

9138

9139

9140

9141

9142

9143

9144

9145

9146

9147

<p>Inherited from

9148

<a href="../classes/Widget.html#method__syncUIChild">Widget</a>:

9149

9150

9151

9152

<a href="../files/widget-child_js_Widget-Child.js.html#l341"><code>widget-child/js/Widget-Child.js:341</code></a>

9153

9154

</p>

9155

9156

9157

9158

9159

9160

</div>

9161

9162

9163

<p>Synchronizes the UI to match the WidgetChild state.</p>

9164

9165

<p>

9166

This method is invoked after bindUI is invoked for the Widget class

9167

using YUI's aop infrastructure.

9168

</p>

9169

</div>

9170

9171

9172

9173

9174

9175

9176

</div>

9177

9178

9179

9180

<h3 class="name"><code>_uiSetChildSelected</code></h3>

9181

9182

9183

9184

9185

9186

9187

9188

<code>selected</code>

9189

9190

</li>

9191

9192

</ul><span class="paren">)</span>

9193

</div>

9194

9195

9196

9197

9198

9199

9200

9201

<span class="flag protected">protected</span>

9202

9203

9204

9205

9206

9207

9208

9209

9210

9211

9212

9213

<p>Inherited from

9214

<a href="../classes/Widget.html#method__uiSetChildSelected">Widget</a>:

9215

9216

9217

9218

<a href="../files/widget-child_js_Widget-Child.js.html#l305"><code>widget-child/js/Widget-Child.js:305</code></a>

9219

9220

</p>

9221

9222

9223

9224

9225

9226

</div>

9227

9228

9229

<p>Updates the UI to reflect the <code>selected</code> attribute value.</p>

9230

</div>

9231

9232

9233

9234

<h4>Parameters:</h4>

9235

9236

9237

9238

9239

9240

<code class="param-name">selected</code>

9241

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Number" class="crosslink external" target="_blank">Number</a></span>

9242

9243

9244

9245

9246

9247

<p>The selected value to be reflected in the UI.</p>

9248

</div>

9249

9250

9251

</li>

9252

9253

</ul>

9254

</div>

9255

9256

9257

9258

9259

9260

</div>

9261

9262

9263

9264

<h3 class="name"><code>_uiSetDim</code></h3>

9265

9266

9267

9268

9269

9270

9271

9272

9273

9274

</li>

9275

9276

9277

9278

9279

9280

</li>

9281

9282

</ul><span class="paren">)</span>

9283

</div>

9284

9285

9286

9287

9288

9289

9290

9291

<span class="flag private">private</span>

9292

9293

9294

9295

9296

9297

9298

9299

9300

9301

9302

9303

<p>Inherited from

9304

<a href="../classes/Widget.html#method__uiSetDim">Widget</a>:

9305

9306

9307

9308

<a href="../files/widget_js_Widget.js.html#l984"><code>widget/js/Widget.js:984</code></a>

9309

9310

</p>

9311

9312

9313

9314

9315

9316

</div>

9317

9318

9319

9320

</div>

9321

9322

9323

9324

<h4>Parameters:</h4>

9325

9326

9327

9328

9329

9330

9331

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

9332

9333

9334

9335

9336

9337

<p>The dimension - "width" or "height"</p>

9338

</div>

9339

9340

9341

</li>

9342

9343

9344

9345

9346

<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>

9347

9348

9349

9350

9351

9352

<p>The value to set</p>

9353

</div>

9354

9355

9356

</li>

9357

9358

</ul>

9359

</div>

9360

9361

9362

9363

9364

9365

</div>

9366

9367

9368

9369

<h3 class="name"><code>_uiSetDisabled</code></h3>

9370

9371

9372

9373

9374

9375

9376

9377

9378

9379

</li>

9380

9381

</ul><span class="paren">)</span>

9382

</div>

9383

9384

9385

9386

9387

9388

9389

9390

<span class="flag protected">protected</span>

9391

9392

9393

9394

9395

9396

9397

9398

9399

9400

9401

9402

<p>Inherited from

9403

<a href="../classes/Widget.html#method__uiSetDisabled">Widget</a>:

9404

9405

9406

9407

<a href="../files/widget_js_Widget.js.html#l1005"><code>widget/js/Widget.js:1005</code></a>

9408

9409

</p>

9410

9411

9412

9413

9414

9415

</div>

9416

9417

9418

<p>Sets the disabled state for the UI</p>

9419

</div>

9420

9421

9422

9423

<h4>Parameters:</h4>

9424

9425

9426

9427

9428

9429

9430

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>

9431

9432

9433

9434

9435

9436

9437

</div>

9438

9439

9440

</li>

9441

9442

</ul>

9443

</div>

9444

9445

9446

9447

9448

9449

</div>

9450

9451

9452

9453

<h3 class="name"><code>_uiSetFocused</code></h3>

9454

9455

9456

9457

9458

9459

9460

9461

9462

9463

</li>

9464

9465

9466

9467

9468

9469

</li>

9470

9471

</ul><span class="paren">)</span>

9472

</div>

9473

9474

9475

9476

9477

9478

9479

9480

<span class="flag protected">protected</span>

9481

9482

9483

9484

9485

9486

9487

9488

9489

9490

9491

9492

<p>Inherited from

9493

<a href="../classes/Widget.html#method__uiSetFocused">Widget</a>:

9494

9495

9496

9497

<a href="../files/widget_js_Widget.js.html#l1016"><code>widget/js/Widget.js:1016</code></a>

9498

9499

</p>

9500

9501

9502

9503

9504

9505

</div>

9506

9507

9508

<p>Sets the focused state for the UI</p>

9509

</div>

9510

9511

9512

9513

<h4>Parameters:</h4>

9514

9515

9516

9517

9518

9519

9520

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>

9521

9522

9523

9524

9525

9526

9527

</div>

9528

9529

9530

</li>

9531

9532

9533

9534

9535

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

9536

9537

9538

9539

9540

9541

<p>String representing the source that triggered an update to

9542

the UI.</p>

9543

</div>

9544

9545

9546

</li>

9547

9548

</ul>

9549

</div>

9550

9551

9552

9553

9554

9555

</div>

9556

9557

9558

9559

<h3 class="name"><code>_uiSetHeight</code></h3>

9560

9561

9562

9563

9564

9565

9566

9567

9568

9569

</li>

9570

9571

</ul><span class="paren">)</span>

9572

</div>

9573

9574

9575

9576

9577

9578

9579

9580

<span class="flag protected">protected</span>

9581

9582

9583

9584

9585

9586

9587

9588

9589

9590

9591

9592

<p>Inherited from

9593

<a href="../classes/Widget.html#method__uiSetHeight">Widget</a>:

9594

9595

9596

9597

<a href="../files/widget_js_Widget.js.html#l961"><code>widget/js/Widget.js:961</code></a>

9598

9599

</p>

9600

9601

9602

9603

9604

9605

</div>

9606

9607

9608

<p>Sets the height on the widget's bounding box element</p>

9609

</div>

9610

9611

9612

9613

<h4>Parameters:</h4>

9614

9615

9616

9617

9618

9619

9620

<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>

9621

9622

9623

9624

9625

9626

9627

</div>

9628

9629

9630

</li>

9631

9632

</ul>

9633

</div>

9634

9635

9636

9637

9638

9639

</div>

9640

9641

9642

9643

<h3 class="name"><code>_uiSetTabIndex</code></h3>

9644

9645

9646

9647

9648

9649

9650

9651

<code>Number</code>

9652

9653

</li>

9654

9655

</ul><span class="paren">)</span>

9656

</div>

9657

9658

9659

9660

9661

9662

9663

9664

<span class="flag protected">protected</span>

9665

9666

9667

9668

9669

9670

9671

9672

9673

9674

9675

9676

<p>Inherited from

9677

<a href="../classes/Widget.html#method__uiSetTabIndex">Widget</a>:

9678

9679

9680

9681

<a href="../files/widget_js_Widget.js.html#l1038"><code>widget/js/Widget.js:1038</code></a>

9682

9683

</p>

9684

9685

9686

9687

9688

9689

</div>

9690

9691

9692

<p>Set the tabIndex on the widget's rendered UI</p>

9693

</div>

9694

9695

9696

9697

<h4>Parameters:</h4>

9698

9699

9700

9701

9702

9703

<code class="param-name">Number</code>

9704

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>

9705

9706

9707

9708

9709

9710

9711

</div>

9712

9713

9714

</li>

9715

9716

</ul>

9717

</div>

9718

9719

9720

9721

9722

9723

</div>

9724

9725

9726

9727

<h3 class="name"><code>_uiSetVisible</code></h3>

9728

9729

9730

9731

9732

9733

9734

9735

9736

9737

</li>

9738

9739

</ul><span class="paren">)</span>

9740

</div>

9741

9742

9743

9744

9745

9746

9747

9748

<span class="flag protected">protected</span>

9749

9750

9751

9752

9753

9754

9755

9756

9757

9758

9759

9760

<p>Inherited from

9761

<a href="../classes/Widget.html#method__uiSetVisible">Widget</a>:

9762

9763

9764

9765

<a href="../files/widget_js_Widget.js.html#l994"><code>widget/js/Widget.js:994</code></a>

9766

9767

</p>

9768

9769

9770

9771

9772

9773

</div>

9774

9775

9776

<p>Sets the visible state for the UI</p>

9777

</div>

9778

9779

9780

9781

<h4>Parameters:</h4>

9782

9783

9784

9785

9786

9787

9788

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>

9789

9790

9791

9792

9793

9794

9795

</div>

9796

9797

9798

</li>

9799

9800

</ul>

9801

</div>

9802

9803

9804

9805

9806

9807

</div>

9808

9809

9810

9811

<h3 class="name"><code>_uiSetWidth</code></h3>

9812

9813

9814

9815

9816

9817

9818

9819

9820

9821

</li>

9822

9823

</ul><span class="paren">)</span>

9824

</div>

9825

9826

9827

9828

9829

9830

9831

9832

<span class="flag protected">protected</span>

9833

9834

9835

9836

9837

9838

9839

9840

9841

9842

9843

9844

<p>Inherited from

9845

<a href="../classes/Widget.html#method__uiSetWidth">Widget</a>:

9846

9847

9848

9849

<a href="../files/widget_js_Widget.js.html#l973"><code>widget/js/Widget.js:973</code></a>

9850

9851

</p>

9852

9853

9854

9855

9856

9857

</div>

9858

9859

9860

<p>Sets the width on the widget's bounding box element</p>

9861

</div>

9862

9863

9864

9865

<h4>Parameters:</h4>

9866

9867

9868

9869

9870

9871

9872

9873

9874

9875

9876

9877

9878

9879

</div>

9880

9881

9882

</li>

9883

9884

</ul>

9885

</div>

9886

9887

9888

9889

9890

9891

</div>

9892

9893

9894

9895

<h3 class="name"><code>_uiSizeCB</code></h3>

9896

9897

9898

9899

9900

9901

9902

9903

<code>expand</code>

9904

9905

</li>

9906

9907

</ul><span class="paren">)</span>

9908

</div>

9909

9910

9911

9912

9913

9914

9915

9916

<span class="flag protected">protected</span>

9917

9918

9919

9920

9921

9922

9923

9924

9925

9926

9927

9928

<p>Inherited from

9929

<a href="../classes/Widget.html#method__uiSizeCB">Widget</a>:

9930

9931

9932

9933

<a href="../files/widget_js_Widget.js.html#l702"><code>widget/js/Widget.js:702</code></a>

9934

9935

</p>

9936

9937

9938

9939

9940

9941

</div>

9942

9943

9944

9945

</div>

9946

9947

9948

9949

<h4>Parameters:</h4>

9950

9951

9952

9953

9954

9955

<code class="param-name">expand</code>

9956

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>

9957

9958

9959

9960

9961

9962

9963

</div>

9964

9965

9966

</li>

9967

9968

</ul>

9969

</div>

9970

9971

9972

9973

9974

9975

</div>

9976

9977

9978

9979

<h3 class="name"><code>_unbindDOM</code></h3>

9980

9981

9982

9983

9984

9985

9986

9987

9988

9989

9990

<span class="flag protected">protected</span>

9991

9992

9993

9994

9995

9996

9997

9998

9999

10000

10001

10002

<p>Inherited from

10003

<a href="../classes/Widget.html#method__unbindDOM">Widget</a>:

10004

10005

10006

10007

<a href="../files/widget_js_Widget.js.html#l920"><code>widget/js/Widget.js:920</code></a>

10008

10009

</p>

10010

10011

10012

10013

10014

10015

</div>

10016

10017

10018

10019

</div>

10020

10021

10022

10023

10024

10025

10026

</div>

10027

10028

10029

10030

<h3 class="name"><code>_unbindUI</code></h3>

10031

10032

10033

10034

10035

10036

10037

10038

10039

10040

10041

<span class="flag protected">protected</span>

10042

10043

10044

10045

10046

10047

10048

10049

10050

10051

10052

10053

<p>Inherited from

10054

<a href="../classes/Widget.html#method__unbindUI">Widget</a>:

10055

10056

10057

10058

<a href="../files/widget_js_Widget.js.html#l881"><code>widget/js/Widget.js:881</code></a>

10059

10060

</p>

10061

10062

10063

10064

10065

10066

</div>

10067

10068

10069

10070

</div>

10071

10072

10073

10074

10075

10076

10077

</div>

10078

10079

10080

10081

<h3 class="name"><code>_validTabIndex</code></h3>

10082

10083

10084

10085

10086

10087

10088

10089

<code>tabIndex</code>

10090

10091

</li>

10092

10093

</ul><span class="paren">)</span>

10094

</div>

10095

10096

10097

10098

10099

10100

10101

10102

<span class="flag protected">protected</span>

10103

10104

10105

10106

10107

10108

10109

10110

10111

10112

10113

10114

<p>Inherited from

10115

<a href="../classes/Widget.html#method__validTabIndex">Widget</a>:

10116

10117

10118

10119

<a href="../files/widget_js_Widget.js.html#l1148"><code>widget/js/Widget.js:1148</code></a>

10120

10121

</p>

10122

10123

10124

10125

10126

10127

</div>

10128

10129

10130

10131

</div>

10132

10133

10134

10135

<h4>Parameters:</h4>

10136

10137

10138

10139

10140

10141

<code class="param-name">tabIndex</code>

10142

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Number" class="crosslink external" target="_blank">Number</a></span>

10143

10144

10145

10146

10147

10148

10149

</div>

10150

10151

10152

</li>

10153

10154

</ul>

10155

</div>

10156

10157

10158

10159

10160

10161

</div>

10162

10163

10164

10165

<h3 class="name"><code>addAttr</code></h3>

10166

10167

10168

10169

10170

10171

10172

10173

10174

10175

</li>

10176

10177

10178

10179

<code>config</code>

10180

10181

</li>

10182

10183

10184

10185

10186

10187

</li>

10188

10189

</ul><span class="paren">)</span>

10190

</div>

10191

10192

10193

10194

10195

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>

10196

</span>

10197

10198

10199

10200

10201

10202

10203

10204

10205

10206

10207

10208

<span class="flag chainable">chainable</span>

10209

10210

10211

10212

10213

10214

<p>Inherited from

10215

<a href="../classes/AttributeCore.html#method_addAttr">AttributeCore</a>:

10216

10217

10218

10219

<a href="../files/attribute_js_AttributeCore.js.html#l124"><code>attribute/js/AttributeCore.js:124</code></a>

10220

10221

</p>

10222

10223

10224

10225

10226

10227

</div>

10228

10229

10230

<p>

10231

Adds an attribute with the provided configuration to the host object.

10232

</p>

10233

10234

<p>

10235

The config argument object supports the following properties:

10236

</p>

10237

10238

<dl>

10239

<dt>value <Any></dt>

10240

<dd>The initial value to set on the attribute</dd>

10241

10242

<dt>valueFn <Function | String></dt>

10243

<dd>

10244

<p>A function, which will return the initial value to set on the attribute. This is useful

10245

for cases where the attribute configuration is defined statically, but needs to

10246

reference the host instance ("this") to obtain an initial value. If both the value and valueFn properties are defined,

10247

the value returned by the valueFn has precedence over the value property, unless it returns undefined, in which

10248

case the value property is used.</p>

10249

10250

<p>valueFn can also be set to a string, representing the name of the instance method to be used to retrieve the value.</p>

10251

</dd>

10252

10253

<dt>readOnly <boolean></dt>

10254

<dd>Whether or not the attribute is read only. Attributes having readOnly set to true

10255

cannot be modified by invoking the set method.</dd>

10256

10257

<dt>writeOnce <boolean> or <string></dt>

10258

<dd>

10259

Whether or not the attribute is "write once". Attributes having writeOnce set to true,

10260

can only have their values set once, be it through the default configuration,

10261

constructor configuration arguments, or by invoking set.

10262

<p>The writeOnce attribute can also be set to the string "initOnly", in which case the attribute can only be set during initialization

10263

(when used with Base, this means it can only be set during construction)</p>

10264

</dd>

10265

10266

<dt>setter <Function | String></dt>

10267

<dd>

10268

<p>The setter function used to massage or normalize the value passed to the set method for the attribute.

10269

The value returned by the setter will be the final stored value. Returning

10270

<a href="#property_Attribute.INVALID_VALUE">Attribute.INVALID_VALUE</a>, from the setter will prevent

10271

the value from being stored.

10272

</p>

10273

10274

<p>setter can also be set to a string, representing the name of the instance method to be used as the setter function.</p>

10275

</dd>

10276

10277

<dt>getter <Function | String></dt>

10278

<dd>

10279

<p>

10280

The getter function used to massage or normalize the value returned by the get method for the attribute.

10281

The value returned by the getter function is the value which will be returned to the user when they

10282

invoke get.

10283

</p>

10284

10285

<p>getter can also be set to a string, representing the name of the instance method to be used as the getter function.</p>

10286

</dd>

10287

10288

<dt>validator <Function | String></dt>

10289

<dd>

10290

<p>

10291

The validator function invoked prior to setting the stored value. Returning

10292

false from the validator function will prevent the value from being stored.

10293

</p>

10294

10295

<p>validator can also be set to a string, representing the name of the instance method to be used as the validator function.</p>

10296

</dd>

10297

10298

<dt>lazyAdd <boolean></dt>

10299

<dd>Whether or not to delay initialization of the attribute until the first call to get/set it.

10300

This flag can be used to over-ride lazy initialization on a per attribute basis, when adding multiple attributes through

10301

the <a href="#method_addAttrs">addAttrs</a> method.</dd>

10302

10303

</dl>

10304

10305

<p>The setter, getter and validator are invoked with the value and name passed in as the first and second arguments, and with

10306

the context ("this") set to the host object.</p>

10307

10308

<p>Configuration properties outside of the list mentioned above are considered private properties used internally by attribute,

10309

and are not intended for public use.</p>

10310

</div>

10311

10312

10313

10314

<h4>Parameters:</h4>

10315

10316

10317

10318

10319

10320

10321

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

10322

10323

10324

10325

10326

10327

<p>The name of the attribute.</p>

10328

</div>

10329

10330

10331

</li>

10332

10333

10334

10335

<code class="param-name">config</code>

10336

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>

10337

10338

10339

10340

10341

10342

<p>An object with attribute configuration property/value pairs, specifying the configuration for the attribute.</p>

10343

10344

<p>

10345

<strong>NOTE:</strong> The configuration object is modified when adding an attribute, so if you need

10346

to protect the original values, you will need to merge the object.

10347

</p>

10348

</div>

10349

10350

10351

</li>

10352

10353

10354

10355

10356

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>

10357

10358

10359

10360

10361

10362

<p>(optional) Whether or not to add this attribute lazily (on the first call to get/set).</p>

10363

</div>

10364

10365

10366

</li>

10367

10368

</ul>

10369

</div>

10370

10371

10372

10373

10374

<h4>Returns:</h4>

10375

10376

10377

10378

10379

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>:

10380

10381

A reference to the host object.

10382

10383

</div>

10384

</div>

10385

10386

10387

10388

</div>

10389

10390

10391

10392

<h3 class="name"><code>addAttrs</code></h3>

10393

10394

10395

10396

10397

10398

10399

10400

10401

10402

</li>

10403

10404

10405

10406

<code>values</code>

10407

10408

</li>

10409

10410

10411

10412

10413

10414

</li>

10415

10416

</ul><span class="paren">)</span>

10417

</div>

10418

10419

10420

10421

10422

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>

10423

</span>

10424

10425

10426

10427

10428

10429

10430

10431

10432

10433

10434

10435

<span class="flag chainable">chainable</span>

10436

10437

10438

10439

10440

10441

<p>Inherited from

10442

<a href="../classes/AttributeCore.html#method_addAttrs">AttributeCore</a>:

10443

10444

10445

10446

<a href="../files/attribute_js_AttributeCore.js.html#l708"><code>attribute/js/AttributeCore.js:708</code></a>

10447

10448

</p>

10449

10450

10451

10452

10453

10454

</div>

10455

10456

10457

<p>Configures a group of attributes, and sets initial values.</p>

10458

10459

<p>

10460

<strong>NOTE:</strong> This method does not isolate the configuration object by merging/cloning.

10461

The caller is responsible for merging/cloning the configuration object if required.

10462

</p>

10463

</div>

10464

10465

10466

10467

<h4>Parameters:</h4>

10468

10469

10470

10471

10472

10473

10474

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>

10475

10476

10477

10478

10479

10480

<p>An object with attribute name/configuration pairs.</p>

10481

</div>

10482

10483

10484

</li>

10485

10486

10487

10488

<code class="param-name">values</code>

10489

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>

10490

10491

10492

10493

10494

10495

<p>An object with attribute name/value pairs, defining the initial values to apply.

10496

Values defined in the cfgs argument will be over-written by values in this argument unless defined as read only.</p>

10497

</div>

10498

10499

10500

</li>

10501

10502

10503

10504

10505

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>

10506

10507

10508

10509

10510

10511

<p>Whether or not to delay the intialization of these attributes until the first call to get/set.

10512

Individual attributes can over-ride this behavior by defining a lazyAdd configuration property in their configuration.

10513

See <a href="#method_addAttr">addAttr</a>.</p>

10514

</div>

10515

10516

10517

</li>

10518

10519

</ul>

10520

</div>

10521

10522

10523

10524

10525

<h4>Returns:</h4>

10526

10527

10528

10529

10530

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>:

10531

10532

A reference to the host object.

10533

10534

</div>

10535

</div>

10536

10537

10538

10539

</div>

10540

10541

10542

10543

<h3 class="name"><code>addTarget</code></h3>

10544

10545

10546

10547

10548

10549

10550

10551

10552

10553

</li>

10554

10555

</ul><span class="paren">)</span>

10556

</div>

10557

10558

10559

10560

10561

10562

10563

10564

10565

10566

10567

10568

10569

10570

10571

10572

10573

10574

<p>Inherited from

10575

<a href="../classes/EventTarget.html#method_addTarget">EventTarget</a>:

10576

10577

10578

10579

<a href="../files/event-custom_js_event-facade.js.html#l382"><code>event-custom/js/event-facade.js:382</code></a>

10580

10581

</p>

10582

10583

10584

10585

10586

10587

</div>

10588

10589

10590

<p>Registers another EventTarget as a bubble target. Bubble order

10591

is determined by the order registered. Multiple targets can

10592

be specified.</p>

10593

10594

<p>Events can only bubble if emitFacade is true.</p>

10595

10596

<p>Included in the event-custom-complex submodule.</p>

10597

</div>

10598

10599

10600

10601

<h4>Parameters:</h4>

10602

10603

10604

10605

10606

10607

10608

<span class="type"><a href="../classes/EventTarget.html" class="crosslink">EventTarget</a></span>

10609

10610

10611

10612

10613

10614

<p>the target to add</p>

10615

</div>

10616

10617

10618

</li>

10619

10620

</ul>

10621

</div>

10622

10623

10624

10625

10626

10627

</div>

10628

10629

10630

10631

<h3 class="name"><code>after</code></h3>

10632

10633

10634

10635

10636

10637

10638

10639

10640

10641

</li>

10642

10643

10644

10645

10646

10647

</li>

10648

10649

10650

10651

<code class="optional">[context]</code>

10652

10653

</li>

10654

10655

10656

10657

10658

10659

</li>

10660

10661

</ul><span class="paren">)</span>

10662

</div>

10663

10664

10665

10666

10667

<span class="type"><a href="../classes/EventHandle.html" class="crosslink">EventHandle</a></span>

10668

</span>

10669

10670

10671

10672

10673

10674

10675

10676

10677

10678

10679

10680

10681

10682

10683

10684

<p>Inherited from

10685

<a href="../classes/EventTarget.html#method_after">EventTarget</a>:

10686

10687

10688

10689

<a href="../files/event-custom_js_event-target.js.html#l730"><code>event-custom/js/event-target.js:730</code></a>

10690

10691

</p>

10692

10693

10694

10695

10696

10697

</div>

10698

10699

10700

<p>Subscribe to a custom event hosted by this object. The

10701

supplied callback will execute after any listeners add

10702

via the subscribe method, and after the default function,

10703

if configured for the event, has executed.</p>

10704

</div>

10705

10706

10707

10708

<h4>Parameters:</h4>

10709

10710

10711

10712

10713

10714

10715

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

10716

10717

10718

10719

10720

10721

<p>The name of the event</p>

10722

</div>

10723

10724

10725

</li>

10726

10727

10728

10729

10730

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function</a></span>

10731

10732

10733

10734

10735

10736

<p>The callback to execute in response to the event</p>

10737

</div>

10738

10739

10740

</li>

10741

10742

10743

10744

<code class="param-name optional">[context]</code>

10745

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>

10746

<span class="flag optional" title="This parameter is optional.">optional</span>

10747

10748

10749

10750

10751

10752

<p>Override <code>this</code> object in callback</p>

10753

</div>

10754

10755

10756

</li>

10757

10758

10759

10760

10761

10762

<span class="flag optional" title="This parameter is optional.">optional</span>

10763

10764

10765

10766

10767

10768

<p>0..n additional arguments to supply to the subscriber</p>

10769

</div>

10770

10771

10772

</li>

10773

10774

</ul>

10775

</div>

10776

10777

10778

10779

10780

<h4>Returns:</h4>

10781

10782

10783

10784

10785

<span class="type"><a href="../classes/EventHandle.html" class="crosslink">EventHandle</a></span>:

10786

10787

A subscription handle capable of detaching the

10788

subscription

10789

10790

</div>

10791

</div>

10792

10793

10794

10795

</div>

10796

10797

10798

10799

<h3 class="name"><code>ancestor</code></h3>

10800

10801

10802

10803

10804

10805

10806

10807

<code>depth</code>

10808

10809

</li>

10810

10811

</ul><span class="paren">)</span>

10812

</div>

10813

10814

10815

10816

10817

<span class="type"><a href="../classes/Widget.html" class="crosslink">Widget</a></span>

10818

</span>

10819

10820

10821

10822

10823

10824

10825

10826

10827

10828

10829

10830

10831

10832

10833

10834

<p>Inherited from

10835

<a href="../classes/Widget.html#method_ancestor">Widget</a>:

10836

10837

10838

10839

<a href="../files/widget-child_js_Widget-Child.js.html#l279"><code>widget-child/js/Widget-Child.js:279</code></a>

10840

10841

</p>

10842

10843

10844

10845

10846

10847

</div>

10848

10849

10850

<p>Returns the Widget instance at the specified depth.</p>

10851

</div>

10852

10853

10854

10855

<h4>Parameters:</h4>

10856

10857

10858

10859

10860

10861

<code class="param-name">depth</code>

10862

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Number" class="crosslink external" target="_blank">Number</a></span>

10863

10864

10865

10866

10867

10868

<p>Number representing the depth of the ancestor.</p>

10869

</div>

10870

10871

10872

</li>

10873

10874

</ul>

10875

</div>

10876

10877

10878

10879

10880

<h4>Returns:</h4>

10881

10882

10883

10884

10885

<span class="type"><a href="../classes/Widget.html" class="crosslink">Widget</a></span>:

10886

10887

Widget instance.

10888

10889

</div>

10890

</div>

10891

10892

10893

10894

</div>

10895

10896

10897

10898

<h3 class="name"><code>attrAdded</code></h3>

10899

10900

10901

10902

10903

10904

10905

10906

10907

10908

</li>

10909

10910

</ul><span class="paren">)</span>

10911

</div>

10912

10913

10914

10915

10916

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>

10917

</span>

10918

10919

10920

10921

10922

10923

10924

10925

10926

10927

10928

10929

10930

10931

10932

10933

<p>Inherited from

10934

<a href="../classes/AttributeCore.html#method_attrAdded">AttributeCore</a>:

10935

10936

10937

10938

<a href="../files/attribute_js_AttributeCore.js.html#l272"><code>attribute/js/AttributeCore.js:272</code></a>

10939

10940

</p>

10941

10942

10943

10944

10945

10946

</div>

10947

10948

10949

<p>Checks if the given attribute has been added to the host</p>

10950

</div>

10951

10952

10953

10954

<h4>Parameters:</h4>

10955

10956

10957

10958

10959

10960

10961

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

10962

10963

10964

10965

10966

10967

<p>The name of the attribute to check.</p>

10968

</div>

10969

10970

10971

</li>

10972

10973

</ul>

10974

</div>

10975

10976

10977

10978

10979

<h4>Returns:</h4>

10980

10981

10982

10983

10984

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>:

10985

10986

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.

10987

10988

</div>

10989

</div>

10990

10991

10992

10993

</div>

10994

10995

10996

10997

<h3 class="name"><code>before</code></h3>

10998

10999

11000

11001

11002

11003

11004

11005

11006

</span>

11007

11008

11009

11010

11011

11012

11013

11014

11015

11016

11017

11018

11019

11020

11021

11022

<p>Inherited from

11023

<a href="../classes/EventTarget.html#method_before">EventTarget</a>:

11024

11025

11026

11027

<a href="../files/event-custom_js_event-target.js.html#l767"><code>event-custom/js/event-target.js:767</code></a>

11028

11029

</p>

11030

11031

11032

11033

11034

11035

</div>

11036

11037

11038

<p>Executes the callback before a DOM event, custom event

11039

or method. If the first argument is a function, it

11040

is assumed the target is a method. For DOM and custom

11041

events, this is an alias for Y.on.</p>

11042

11043

<p>For DOM and custom events:

11044

type, callback, context, 0-n arguments</p>

11045

11046

<p>For methods:

11047

callback, object (method host), methodName, context, 0-n arguments</p>

11048

</div>

11049

11050

11051

11052

11053

11054

<h4>Returns:</h4>

11055

11056

11057

11058

11059

detach handle

11060

11061

</div>

11062

</div>

11063

11064

11065

11066

</div>

11067

11068

11069

11070

<h3 class="name"><code>bindUI</code></h3>

11071

11072

11073

11074

11075

11076

11077

11078

11079

11080

11081

11082

11083

11084

11085

11086

11087

11088

11089

11090

<p>Inherited from

11091

11092

Widget

11093

</a>

11094

11095

but overwritten in

11096

11097

11098

11099

<a href="../files/button_js_button.js.html#l41"><code>button/js/button.js:41</code></a>

11100

11101

</p>

11102

11103

11104

11105

11106

11107

</div>

11108

11109

11110

<p>Hooks up events for the widget</p>

11111

</div>

11112

11113

11114

11115

11116

11117

11118

</div>

11119

11120

11121

11122

11123

11124

11125

11126

11127

11128

11129

11130

11131

11132

11133

11134

11135

11136

11137

11138

11139

<span class="flag chainable">chainable</span>

11140

11141

11142

11143

11144

11145

<p>Inherited from

11146

<a href="../classes/Widget.html#method_blur">Widget</a>:

11147

11148

11149

11150

<a href="../files/widget_js_Widget.js.html#l674"><code>widget/js/Widget.js:674</code></a>

11151

11152

</p>

11153

11154

11155

11156

11157

11158

</div>

11159

11160

11161

<p>Causes the Widget to lose focus by setting the "focused" attribute

11162

to "false"</p>

11163

</div>

11164

11165

11166

11167

11168

11169

11170

</div>

11171

11172

11173

11174

<h3 class="name"><code>bubble</code></h3>

11175

11176

11177

11178

11179

11180

11181

11182

11183

11184

</li>

11185

11186

</ul><span class="paren">)</span>

11187

</div>

11188

11189

11190

11191

11192

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>

11193

</span>

11194

11195

11196

11197

11198

11199

11200

11201

11202

11203

11204

11205

11206

11207

11208

11209

<p>Inherited from

11210

<a href="../classes/EventTarget.html#method_bubble">EventTarget</a>:

11211

11212

11213

11214

<a href="../files/event-custom_js_event-facade.js.html#l419"><code>event-custom/js/event-facade.js:419</code></a>

11215

11216

</p>

11217

11218

11219

11220

11221

11222

</div>

11223

11224

11225

<p>Propagate an event. Requires the event-custom-complex module.</p>

11226

</div>

11227

11228

11229

11230

<h4>Parameters:</h4>

11231

11232

11233

11234

11235

11236

11237

<span class="type"><a href="../classes/CustomEvent.html" class="crosslink">CustomEvent</a></span>

11238

11239

11240

11241

11242

11243

<p>the custom event to propagate</p>

11244

</div>

11245

11246

11247

</li>

11248

11249

</ul>

11250

</div>

11251

11252

11253

11254

11255

<h4>Returns:</h4>

11256

11257

11258

11259

11260

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>:

11261

11262

the aggregated return value from Event.Custom.fire

11263

11264

</div>

11265

</div>

11266

11267

11268

11269

</div>

11270

11271

11272

11273

<h3 class="name"><code>destroy</code></h3>

11274

11275

11276

11277

11278

11279

11280

11281

<code>destroyAllNodes</code>

11282

11283

</li>

11284

11285

</ul><span class="paren">)</span>

11286

</div>

11287

11288

11289

11290

11291

<span class="type"><a href="../classes/Widget.html" class="crosslink">Widget</a></span>

11292

</span>

11293

11294

11295

11296

11297

11298

11299

11300

11301

11302

11303

11304

<span class="flag chainable">chainable</span>

11305

11306

11307

11308

11309

<p>Inherited from

11310

11311

BaseCore

11312

</a>

11313

11314

but overwritten in

11315

11316

11317

11318

<a href="../files/widget_js_Widget.js.html#l455"><code>widget/js/Widget.js:455</code></a>

11319

11320

</p>

11321

11322

11323

11324

11325

11326

</div>

11327

11328

11329

<p>

11330

Destroy lifecycle method. Fires the destroy

11331

event, prior to invoking destructors for the

11332

class hierarchy.

11333

11334

Overrides Base's implementation, to support arguments to destroy

11335

</p>

11336

11337

<p>

11338

Subscribers to the destroy

11339

event can invoke preventDefault on the event object, to prevent destruction

11340

from proceeding.

11341

</p>

11342

</div>

11343

11344

11345

11346

<h4>Parameters:</h4>

11347

11348

11349

11350

11351

11352

<code class="param-name">destroyAllNodes</code>

11353

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>

11354

11355

11356

11357

11358

11359

<p>If true, all nodes contained within the Widget are removed and destroyed. Defaults to false due to potentially high run-time cost.</p>

11360

</div>

11361

11362

11363

</li>

11364

11365

</ul>

11366

</div>

11367

11368

11369

11370

11371

<h4>Returns:</h4>

11372

11373

11374

11375

11376

<span class="type"><a href="../classes/Widget.html" class="crosslink">Widget</a></span>:

11377

11378

A reference to this object

11379

11380

</div>

11381

</div>

11382

11383

11384

11385

</div>

11386

11387

11388

11389

<h3 class="name"><code>destructor</code></h3>

11390

11391

11392

11393

11394

11395

11396

11397

11398

11399

11400

<span class="flag protected">protected</span>

11401

11402

11403

11404

11405

11406

11407

11408

11409

11410

11411

11412

<p>Inherited from

11413

<a href="../classes/Widget.html#method_destructor">Widget</a>:

11414

11415

11416

11417

<a href="../files/widget_js_Widget.js.html#l430"><code>widget/js/Widget.js:430</code></a>

11418

11419

</p>

11420

11421

11422

11423

11424

11425

</div>

11426

11427

11428

<p>Destructor lifecycle implementation for the Widget class. Purges events attached

11429

to the bounding box and content box, removes them from the DOM and removes

11430

the Widget from the list of registered widgets.</p>

11431

</div>

11432

11433

11434

11435

11436

11437

11438

</div>

11439

11440

11441

11442

<h3 class="name"><code>detach</code></h3>

11443

11444

11445

11446

11447

11448

11449

11450

11451

11452

</li>

11453

11454

11455

11456

11457

11458

</li>

11459

11460

11461

11462

<code>context</code>

11463

11464

</li>

11465

11466

</ul><span class="paren">)</span>

11467

</div>

11468

11469

11470

11471

11472

<span class="type"><a href="../classes/EventTarget.html" class="crosslink">EventTarget</a></span>

11473

</span>

11474

11475

11476

11477

11478

11479

11480

11481

11482

11483

11484

11485

11486

11487

11488

11489

<p>Inherited from

11490

<a href="../classes/EventTarget.html#method_detach">EventTarget</a>:

11491

11492

11493

11494

<a href="../files/event-custom_js_event-target.js.html#l345"><code>event-custom/js/event-target.js:345</code></a>

11495

11496

</p>

11497

11498

11499

11500

11501

11502

</div>

11503

11504

11505

<p>Detach one or more listeners the from the specified event</p>

11506

</div>

11507

11508

11509

11510

<h4>Parameters:</h4>

11511

11512

11513

11514

11515

11516

11517

<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>

11518

11519

11520

11521

11522

11523

<p>Either the handle to the subscriber or the

11524

type of event. If the type

11525

is not specified, it will attempt to remove

11526

the listener from all hosted events.</p>

11527

</div>

11528

11529

11530

</li>

11531

11532

11533

11534

11535

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function</a></span>

11536

11537

11538

11539

11540

11541

<p>The subscribed function to unsubscribe, if not

11542

supplied, all subscribers will be removed.</p>

11543

</div>

11544

11545

11546

</li>

11547

11548

11549

11550

<code class="param-name">context</code>

11551

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>

11552

11553

11554

11555

11556

11557

<p>The custom object passed to subscribe. This is

11558

optional, but if supplied will be used to

11559

disambiguate multiple listeners that are the same

11560

(e.g., you subscribe many object using a function

11561

that lives on the prototype)</p>

11562

</div>

11563

11564

11565

</li>

11566

11567

</ul>

11568

</div>

11569

11570

11571

11572

11573

<h4>Returns:</h4>

11574

11575

11576

11577

11578

<span class="type"><a href="../classes/EventTarget.html" class="crosslink">EventTarget</a></span>:

11579

11580

the host

11581

11582

</div>

11583

</div>

11584

11585

11586

11587

</div>

11588

11589

11590

11591

<h3 class="name"><code>detachAll</code></h3>

11592

11593

11594

11595

11596

11597

11598

11599

11600

11601

</li>

11602

11603

</ul><span class="paren">)</span>

11604

</div>

11605

11606

11607

11608

11609

11610

11611

11612

11613

11614

11615

11616

11617

11618

11619

11620

11621

11622

<p>Inherited from

11623

<a href="../classes/EventTarget.html#method_detachAll">EventTarget</a>:

11624

11625

11626

11627

<a href="../files/event-custom_js_event-target.js.html#l465"><code>event-custom/js/event-target.js:465</code></a>

11628

11629

</p>

11630

11631

11632

11633

11634

11635

</div>

11636

11637

11638

<p>Removes all listeners from the specified event. If the event type

11639

is not specified, all listeners from all hosted custom events will

11640

be removed.</p>

11641

</div>

11642

11643

11644

11645

<h4>Parameters:</h4>

11646

11647

11648

11649

11650

11651

11652

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

11653

11654

11655

11656

11657

11658

<p>The type, or name of the event</p>

11659

</div>

11660

11661

11662

</li>

11663

11664

</ul>

11665

</div>

11666

11667

11668

11669

11670

11671

</div>

11672

11673

11674

11675

<h3 class="name"><code>disable</code></h3>

11676

11677

11678

11679

11680

11681

11682

11683

11684

11685

11686

11687

11688

11689

11690

11691

11692

<span class="flag chainable">chainable</span>

11693

11694

11695

11696

11697

11698

<p>Inherited from

11699

<a href="../classes/Widget.html#method_disable">Widget</a>:

11700

11701

11702

11703

<a href="../files/widget_js_Widget.js.html#l693"><code>widget/js/Widget.js:693</code></a>

11704

11705

</p>

11706

11707

11708

11709

11710

11711

</div>

11712

11713

11714

<p>Set the Widget's "disabled" attribute to "true".</p>

11715

</div>

11716

11717

11718

11719

11720

11721

11722

</div>

11723

11724

11725

11726

<h3 class="name"><code>enable</code></h3>

11727

11728

11729

11730

11731

11732

11733

11734

11735

11736

11737

11738

11739

11740

11741

11742

11743

<span class="flag chainable">chainable</span>

11744

11745

11746

11747

11748

11749

<p>Inherited from

11750

<a href="../classes/Widget.html#method_enable">Widget</a>:

11751

11752

11753

11754

<a href="../files/widget_js_Widget.js.html#l684"><code>widget/js/Widget.js:684</code></a>

11755

11756

</p>

11757

11758

11759

11760

11761

11762

</div>

11763

11764

11765

<p>Set the Widget's "disabled" attribute to "false".</p>

11766

</div>

11767

11768

11769

11770

11771

11772

11773

</div>

11774

11775

11776

11777

11778

11779

11780

11781

11782

11783

11784

11785

11786

11787

</li>

11788

11789

11790

11791

<code>arguments</code>

11792

11793

</li>

11794

11795

</ul><span class="paren">)</span>

11796

</div>

11797

11798

11799

11800

11801

<span class="type"><a href="../classes/EventTarget.html" class="crosslink">EventTarget</a></span>

11802

</span>

11803

11804

11805

11806

11807

11808

11809

11810

11811

11812

11813

11814

11815

11816

11817

11818

<p>Inherited from

11819

<a href="../classes/EventTarget.html#method_fire">EventTarget</a>:

11820

11821

11822

11823

<a href="../files/event-custom_js_event-target.js.html#l629"><code>event-custom/js/event-target.js:629</code></a>

11824

11825

</p>

11826

11827

11828

11829

11830

11831

</div>

11832

11833

11834

<p>Fire a custom event by name. The callback functions will be executed

11835

from the context specified when the event was created, and with the

11836

following parameters.</p>

11837

11838

<p>If the custom event object hasn't been created, then the event hasn't

11839

been published and it has no subscribers. For performance sake, we

11840

immediate exit in this case. This means the event won't bubble, so

11841

if the intention is that a bubble target be notified, the event must

11842

be published on this object first.</p>

11843

11844

<p>The first argument is the event type, and any additional arguments are

11845

passed to the listeners as parameters. If the first of these is an

11846

object literal, and the event is configured to emit an event facade,

11847

that object is mixed into the event facade and the facade is provided

11848

in place of the original object.</p>

11849

</div>

11850

11851

11852

11853

<h4>Parameters:</h4>

11854

11855

11856

11857

11858

11859

11860

<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>

11861

11862

11863

11864

11865

11866

<p>The type of the event, or an object that contains

11867

a 'type' property.</p>

11868

</div>

11869

11870

11871

</li>

11872

11873

11874

11875

<code class="param-name">arguments</code>

11876

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object*</a></span>

11877

11878

11879

11880

11881

11882

<p>an arbitrary set of parameters to pass to

11883

the handler. If the first of these is an object literal and the event is

11884

configured to emit an event facade, the event facade will replace that

11885

parameter after the properties the object literal contains are copied to

11886

the event facade.</p>

11887

</div>

11888

11889

11890

</li>

11891

11892

</ul>

11893

</div>

11894

11895

11896

11897

11898

<h4>Returns:</h4>

11899

11900

11901

11902

11903

<span class="type"><a href="../classes/EventTarget.html" class="crosslink">EventTarget</a></span>:

11904

11905

the event host

11906

11907

</div>

11908

</div>

11909

11910

11911

11912

</div>

11913

11914

11915

11916

<h3 class="name"><code>focus</code></h3>

11917

11918

11919

11920

11921

11922

11923

11924

11925

11926

11927

11928

11929

11930

11931

11932

11933

<span class="flag chainable">chainable</span>

11934

11935

11936

11937

11938

11939

<p>Inherited from

11940

<a href="../classes/Widget.html#method_focus">Widget</a>:

11941

11942

11943

11944

<a href="../files/widget_js_Widget.js.html#l664"><code>widget/js/Widget.js:664</code></a>

11945

11946

</p>

11947

11948

11949

11950

11951

11952

</div>

11953

11954

11955

<p>Causes the Widget to receive the focus by setting the "focused"

11956

attribute to "true".</p>

11957

</div>

11958

11959

11960

11961

11962

11963

11964

</div>

11965

11966

11967

11968

11969

11970

11971

11972

11973

11974

11975

11976

11977

11978

</li>

11979

11980

</ul><span class="paren">)</span>

11981

</div>

11982

11983

11984

11985

11986

11987

</span>

11988

11989

11990

11991

11992

11993

11994

11995

11996

11997

11998

11999

12000

12001

12002

12003

<p>Inherited from

12004

<a href="../classes/AttributeCore.html#method_get">AttributeCore</a>:

12005

12006

12007

12008

<a href="../files/attribute_js_AttributeCore.js.html#l283"><code>attribute/js/AttributeCore.js:283</code></a>

12009

12010

</p>

12011

12012

12013

12014

12015

12016

</div>

12017

12018

12019

<p>Returns the current value of the attribute. If the attribute

12020

has been configured with a 'getter' function, this method will delegate

12021

to the 'getter' to obtain the value of the attribute.</p>

12022

</div>

12023

12024

12025

12026

<h4>Parameters:</h4>

12027

12028

12029

12030

12031

12032

12033

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

12034

12035

12036

12037

12038

12039

<p>The name of the attribute. If the value of the attribute is an Object,

12040

dot notation can be used to obtain the value of a property of the object (e.g. <code>get("x.y.z")</code>)</p>

12041

</div>

12042

12043

12044

</li>

12045

12046

</ul>

12047

</div>

12048

12049

12050

12051

12052

<h4>Returns:</h4>

12053

12054

12055

12056

12057

<span class="type">Any</span>:

12058

12059

The value of the attribute

12060

12061

</div>

12062

</div>

12063

12064

12065

12066

</div>

12067

12068

12069

12070

<h3 class="name"><code>getAttrs</code></h3>

12071

12072

12073

12074

12075

12076

12077

12078

<code>attrs</code>

12079

12080

</li>

12081

12082

</ul><span class="paren">)</span>

12083

</div>

12084

12085

12086

12087

12088

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>

12089

</span>

12090

12091

12092

12093

12094

12095

12096

12097

12098

12099

12100

12101

12102

12103

12104

12105

<p>Inherited from

12106

<a href="../classes/AttributeCore.html#method_getAttrs">AttributeCore</a>:

12107

12108

12109

12110

<a href="../files/attribute_js_AttributeCore.js.html#l665"><code>attribute/js/AttributeCore.js:665</code></a>

12111

12112

</p>

12113

12114

12115

12116

12117

12118

</div>

12119

12120

12121

<p>Gets multiple attribute values.</p>

12122

</div>

12123

12124

12125

12126

<h4>Parameters:</h4>

12127

12128

12129

12130

12131

12132

<code class="param-name">attrs</code>

12133

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Array" class="crosslink external" target="_blank">Array</a> | boolean</span>

12134

12135

12136

12137

12138

12139

<p>Optional. An array of attribute names. If omitted, all attribute values are

12140

returned. If set to true, all attributes modified from their initial values are returned.</p>

12141

</div>

12142

12143

12144

</li>

12145

12146

</ul>

12147

</div>

12148

12149

12150

12151

12152

<h4>Returns:</h4>

12153

12154

12155

12156

12157

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>:

12158

12159

An object with attribute name/value pairs.

12160

12161

</div>

12162

</div>

12163

12164

12165

12166

</div>

12167

12168

12169

12170

<h3 class="name"><code>getClassName</code></h3>

12171

12172

12173

12174

12175

12176

12177

12178

12179

12180

</li>

12181

12182

</ul><span class="paren">)</span>

12183

</div>

12184

12185

12186

12187

12188

12189

12190

12191

12192

12193

12194

12195

12196

12197

12198

12199

12200

<p>Inherited from

12201

12202

Widget

12203

</a>

12204

12205

but overwritten in

12206

12207

12208

12209

<a href="../files/widget_js_Widget.js.html#l309"><code>widget/js/Widget.js:309</code></a>

12210

12211

</p>

12212

12213

12214

12215

12216

12217

</div>

12218

12219

12220

<p>Generate a standard prefixed classname for the Widget, prefixed by the default prefix defined

12221

by the <code>Y.config.classNamePrefix</code> attribute used by <code>ClassNameManager</code> and

12222

<code>Widget.NAME.toLowerCase()</code> (e.g. "yui-widget-xxxxx-yyyyy", based on default values for

12223

the prefix and widget class name).</p>

12224

12225

<p>

12226

The instance based version of this method can be used to generate standard prefixed classnames,

12227

based on the instances NAME, as opposed to Widget.NAME. This method should be used when you

12228

need to use a constant class name across different types instances.

12229

</p>

12230

</div>

12231

12232

12233

12234

<h4>Parameters:</h4>

12235

12236

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

12244

12245

<span class="flag multiple" title="This argument may occur one or more times.">multiple</span>

12246

12247

12248

12249

<p>0..n strings which should be concatenated, using the default separator defined by ClassNameManager, to create the class name</p>

12250

</div>

12251

12252

12253

</li>

12254

12255

</ul>

12256

</div>

12257

12258

12259

12260

12261

12262

</div>

12263

12264

12265

12266

<h3 class="name"><code>getDefaultLocale</code></h3>

12267

12268

12269

12270

12271

12272

12273

12274

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

12275

</span>

12276

12277

12278

12279

12280

12281

12282

12283

12284

12285

12286

12287

12288

12289

12290

12291

<p>Inherited from

12292

<a href="../classes/Widget.html#method_getDefaultLocale">Widget</a>:

12293

12294

12295

12296

<a href="../files/widget_js_WidgetLocale.js.html#l150"><code>widget/js/WidgetLocale.js:150</code></a>

12297

12298

</p>

12299

12300

12301

12302

12303

12304

</div>

12305

12306

12307

<p>Returns the default locale for the widget (the locale value defined by the

12308

widget class, or provided by the user during construction).</p>

12309

</div>

12310

12311

12312

12313

12314

12315

<h4>Returns:</h4>

12316

12317

12318

12319

12320

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>:

12321

12322

The default locale for the widget

12323

12324

</div>

12325

</div>

12326

12327

12328

12329

</div>

12330

12331

12332

12333

<h3 class="name"><code>getEvent</code></h3>

12334

12335

12336

12337

12338

12339

12340

12341

12342

12343

</li>

12344

12345

12346

12347

<code>prefixed</code>

12348

12349

</li>

12350

12351

</ul><span class="paren">)</span>

12352

</div>

12353

12354

12355

12356

12357

<span class="type"><a href="../classes/CustomEvent.html" class="crosslink">CustomEvent</a></span>

12358

</span>

12359

12360

12361

12362

12363

12364

12365

12366

12367

12368

12369

12370

12371

12372

12373

12374

<p>Inherited from

12375

<a href="../classes/EventTarget.html#method_getEvent">EventTarget</a>:

12376

12377

12378

12379

<a href="../files/event-custom_js_event-target.js.html#l712"><code>event-custom/js/event-target.js:712</code></a>

12380

12381

</p>

12382

12383

12384

12385

12386

12387

</div>

12388

12389

12390

<p>Returns the custom event of the provided type has been created, a

12391

falsy value otherwise</p>

12392

</div>

12393

12394

12395

12396

<h4>Parameters:</h4>

12397

12398

12399

12400

12401

12402

12403

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

12404

12405

12406

12407

12408

12409

<p>the type, or name of the event</p>

12410

</div>

12411

12412

12413

</li>

12414

12415

12416

12417

<code class="param-name">prefixed</code>

12418

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

12419

12420

12421

12422

12423

12424

<p>if true, the type is prefixed already</p>

12425

</div>

12426

12427

12428

</li>

12429

12430

</ul>

12431

</div>

12432

12433

12434

12435

12436

<h4>Returns:</h4>

12437

12438

12439

12440

12441

<span class="type"><a href="../classes/CustomEvent.html" class="crosslink">CustomEvent</a></span>:

12442

12443

the custom event or null

12444

12445

</div>

12446

</div>

12447

12448

12449

12450

</div>

12451

12452

12453

12454

<h3 class="name"><code>getSkinName</code></h3>

12455

12456

12457

12458

12459

12460

12461

12462

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

12463

</span>

12464

12465

12466

12467

12468

12469

12470

12471

12472

12473

12474

12475

12476

12477

12478

12479

<p>Inherited from

12480

<a href="../classes/Widget.html#method_getSkinName">Widget</a>:

12481

12482

12483

12484

<a href="../files/widget_js_WidgetSkin.js.html#l13"><code>widget/js/WidgetSkin.js:13</code></a>

12485

12486

</p>

12487

12488

12489

12490

12491

12492

</div>

12493

12494

12495

<p>Returns the name of the skin that's currently applied to the widget.

12496

This is only really useful after the widget's DOM structure is in the

12497

document, either by render or by progressive enhancement. Searches up

12498

the Widget's ancestor axis for a class yui3-skin-(name), and returns the

12499

(name) portion. Otherwise, returns null.</p>

12500

</div>

12501

12502

12503

12504

12505

12506

<h4>Returns:</h4>

12507

12508

12509

12510

12511

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>:

12512

12513

the name of the skin, or null (yui3-skin-sam => sam)

12514

12515

</div>

12516

</div>

12517

12518

12519

12520

</div>

12521

12522

12523

12524

<h3 class="name"><code>getString</code></h3>

12525

12526

12527

12528

12529

12530

12531

12532

12533

12534

</li>

12535

12536

</ul><span class="paren">)</span>

12537

</div>

12538

12539

12540

12541

12542

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

12543

</span>

12544

12545

12546

12547

<span class="flag deprecated" title="Used by deprecated WidgetLocale implementations.">deprecated</span>

12548

12549

12550

12551

12552

12553

12554

12555

12556

12557

12558

12559

12560

<p>Inherited from

12561

12562

Widget

12563

</a>

12564

12565

but overwritten in

12566

12567

12568

12569

<a href="../files/widget_js_Widget.js.html#l1212"><code>widget/js/Widget.js:1212</code></a>

12570

12571

</p>

12572

12573

12574

12575

<p>Deprecated: Used by deprecated WidgetLocale implementations.</p>

12576

12577

12578

12579

</div>

12580

12581

12582

<p>Helper method to get a specific string value</p>

12583

</div>

12584

12585

12586

12587

<h4>Parameters:</h4>

12588

12589

12590

12591

12592

12593

12594

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

12595

12596

12597

12598

12599

12600

12601

</div>

12602

12603

12604

</li>

12605

12606

</ul>

12607

</div>

12608

12609

12610

12611

12612

<h4>Returns:</h4>

12613

12614

12615

12616

12617

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>:

12618

12619

The string

12620

12621

</div>

12622

</div>

12623

12624

12625

12626

</div>

12627

12628

12629

12630

<h3 class="name"><code>getStrings</code></h3>

12631

12632

12633

12634

12635

12636

12637

12638

12639

12640

</li>

12641

12642

</ul><span class="paren">)</span>

12643

</div>

12644

12645

12646

12647

12648

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

12649

</span>

12650

12651

12652

12653

<span class="flag deprecated" title="Used by deprecated WidgetLocale implementations.">deprecated</span>

12654

12655

12656

12657

12658

12659

12660

12661

12662

12663

12664

12665

12666

<p>Inherited from

12667

12668

Widget

12669

</a>

12670

12671

but overwritten in

12672

12673

12674

12675

<a href="../files/widget_js_Widget.js.html#l1224"><code>widget/js/Widget.js:1224</code></a>

12676

12677

</p>

12678

12679

12680

12681

<p>Deprecated: Used by deprecated WidgetLocale implementations.</p>

12682

12683

12684

12685

</div>

12686

12687

12688

<p>Helper method to get the complete set of strings for the widget</p>

12689

</div>

12690

12691

12692

12693

<h4>Parameters:</h4>

12694

12695

12696

12697

12698

12699

12700

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

12701

12702

12703

12704

12705

12706

12707

</div>

12708

12709

12710

</li>

12711

12712

</ul>

12713

</div>

12714

12715

12716

12717

12718

<h4>Returns:</h4>

12719

12720

12721

12722

12723

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>:

12724

12725

The strings

12726

12727

</div>

12728

</div>

12729

12730

12731

12732

</div>

12733

12734

12735

12736

<h3 class="name"><code>getTargets</code></h3>

12737

12738

12739

12740

12741

12742

12743

12744

12745

</span>

12746

12747

12748

12749

12750

12751

12752

12753

12754

12755

12756

12757

12758

12759

12760

12761

<p>Inherited from

12762

<a href="../classes/EventTarget.html#method_getTargets">EventTarget</a>:

12763

12764

12765

12766

<a href="../files/event-custom_js_event-facade.js.html#l400"><code>event-custom/js/event-facade.js:400</code></a>

12767

12768

</p>

12769

12770

12771

12772

12773

12774

</div>

12775

12776

12777

<p>Returns an array of bubble targets for this object.</p>

12778

</div>

12779

12780

12781

12782

12783

12784

<h4>Returns:</h4>

12785

12786

12787

12788

12789

EventTarget[]

12790

12791

</div>

12792

</div>

12793

12794

12795

12796

</div>

12797

12798

12799

12800

12801

12802

12803

12804

12805

12806

12807

12808

12809

12810

12811

12812

12813

12814

12815

12816

12817

<span class="flag chainable">chainable</span>

12818

12819

12820

12821

12822

12823

<p>Inherited from

12824

<a href="../classes/Widget.html#method_hide">Widget</a>:

12825

12826

12827

12828

<a href="../files/widget_js_Widget.js.html#l646"><code>widget/js/Widget.js:646</code></a>

12829

12830

</p>

12831

12832

12833

12834

12835

12836

</div>

12837

12838

12839

<p>Hides the Widget by setting the "visible" attribute to "false".</p>

12840

</div>

12841

12842

12843

12844

12845

12846

12847

</div>

12848

12849

12850

12851

12852

12853

12854

12855

12856

12857

12858

12859

<code>config</code>

12860

12861

</li>

12862

12863

</ul><span class="paren">)</span>

12864

</div>

12865

12866

12867

12868

12869

12870

</span>

12871

12872

12873

12874

12875

12876

12877

12878

12879

12880

12881

12882

<span class="flag chainable">chainable</span>

12883

12884

12885

12886

12887

<p>Inherited from

12888

12889

BaseCore

12890

</a>

12891

12892

but overwritten in

12893

12894

12895

12896

12897

12898

</p>

12899

12900

12901

12902

12903

12904

</div>

12905

12906

12907

<p>Init lifecycle method, invoked during construction.

12908

Fires the init event prior to setting up attributes and

12909

invoking initializers for the class hierarchy.</p>

12910

</div>

12911

12912

12913

12914

<h4>Parameters:</h4>

12915

12916

12917

12918

12919

12920

<code class="param-name">config</code>

12921

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>

12922

12923

12924

12925

12926

12927

<p>Object with configuration property name/value pairs</p>

12928

</div>

12929

12930

12931

</li>

12932

12933

</ul>

12934

</div>

12935

12936

12937

12938

12939

<h4>Returns:</h4>

12940

12941

12942

12943

12944

<span class="type"><a href="../classes/Base.html" class="crosslink">Base</a></span>:

12945

12946

A reference to this object

12947

12948

</div>

12949

</div>

12950

12951

12952

12953

</div>

12954

12955

12956

12957

<h3 class="name"><code>initializer</code></h3>

12958

12959

12960

12961

12962

12963

12964

12965

<code>config</code>

12966

12967

</li>

12968

12969

</ul><span class="paren">)</span>

12970

</div>

12971

12972

12973

12974

12975

12976

12977

12978

<span class="flag protected">protected</span>

12979

12980

12981

12982

12983

12984

12985

12986

12987

12988

12989

12990

<p>Inherited from

12991

<a href="../classes/Widget.html#method_initializer">Widget</a>:

12992

12993

12994

12995

<a href="../files/widget_js_Widget.js.html#l382"><code>widget/js/Widget.js:382</code></a>

12996

12997

</p>

12998

12999

13000

13001

13002

13003

</div>

13004

13005

13006

<p>Initializer lifecycle implementation for the Widget class. Registers the

13007

widget instance, and runs through the Widget's HTML_PARSER definition.</p>

13008

</div>

13009

13010

13011

13012

<h4>Parameters:</h4>

13013

13014

13015

13016

13017

13018

<code class="param-name">config</code>

13019

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>

13020

13021

13022

13023

13024

13025

<p>Configuration object literal for the widget</p>

13026

</div>

13027

13028

13029

</li>

13030

13031

</ul>

13032

</div>

13033

13034

13035

13036

13037

13038

</div>

13039

13040

13041

13042

<h3 class="name"><code>initializer</code></h3>

13043

13044

13045

13046

13047

13048

13049

13050

<code>config</code>

13051

13052

</li>

13053

13054

</ul><span class="paren">)</span>

13055

</div>

13056

13057

13058

13059

13060

13061

13062

13063

<span class="flag private">private</span>

13064

13065

13066

13067

13068

13069

13070

13071

13072

13073

13074

13075

13076

<p>

13077

13078

Defined in

13079

13080

13081

13082

13083

<a href="../files/button_js_button.js.html#l31"><code>button/js/button.js:31</code></a>

13084

13085

</p>

13086

13087

13088

13089

13090

13091

</div>

13092

13093

13094

<p>Internal init() handler.</p>

13095

</div>

13096

13097

13098

13099

<h4>Parameters:</h4>

13100

13101

13102

13103

13104

13105

<code class="param-name">config</code>

13106

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>

13107

13108

13109

13110

13111

13112

<p>Config object.</p>

13113

</div>

13114

13115

13116

</li>

13117

13118

</ul>

13119

</div>

13120

13121

13122

13123

13124

13125

</div>

13126

13127

13128

13129

<h3 class="name"><code>isRoot</code></h3>

13130

13131

13132

13133

13134

13135

13136

13137

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>

13138

</span>

13139

13140

13141

13142

13143

13144

13145

13146

13147

13148

13149

13150

13151

13152

13153

13154

<p>Inherited from

13155

<a href="../classes/Widget.html#method_isRoot">Widget</a>:

13156

13157

13158

13159

<a href="../files/widget-child_js_Widget-Child.js.html#l267"><code>widget-child/js/Widget-Child.js:267</code></a>

13160

13161

</p>

13162

13163

13164

13165

13166

13167

</div>

13168

13169

13170

<p>Determines if the Widget is the root Widget in the

13171

object hierarchy.</p>

13172

</div>

13173

13174

13175

13176

13177

13178

<h4>Returns:</h4>

13179

13180

13181

13182

13183

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>:

13184

13185

Boolean indicating if Widget is the root Widget in the

13186

object hierarchy.

13187

13188

</div>

13189

</div>

13190

13191

13192

13193

</div>

13194

13195

13196

13197

<h3 class="name"><code>modifyAttr</code></h3>

13198

13199

13200

13201

13202

13203

13204

13205

13206

13207

</li>

13208

13209

13210

13211

<code>config</code>

13212

13213

</li>

13214

13215

</ul><span class="paren">)</span>

13216

</div>

13217

13218

13219

13220

13221

13222

13223

13224

13225

13226

13227

13228

13229

13230

13231

13232

13233

13234

<p>Inherited from

13235

<a href="../classes/AttributeExtras.html#method_modifyAttr">AttributeExtras</a>:

13236

13237

13238

13239

<a href="../files/attribute_js_AttributeExtras.js.html#l39"><code>attribute/js/AttributeExtras.js:39</code></a>

13240

13241

</p>

13242

13243

13244

13245

13246

13247

</div>

13248

13249

13250

<p>Updates the configuration of an attribute which has already been added.</p>

13251

13252

<p>

13253

The properties which can be modified through this interface are limited

13254

to the following subset of attributes, which can be safely modified

13255

after a value has already been set on the attribute: readOnly, writeOnce,

13256

broadcast and getter.

13257

</p>

13258

</div>

13259

13260

13261

13262

<h4>Parameters:</h4>

13263

13264

13265

13266

13267

13268

13269

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

13270

13271

13272

13273

13274

13275

<p>The name of the attribute whose configuration is to be updated.</p>

13276

</div>

13277

13278

13279

</li>

13280

13281

13282

13283

<code class="param-name">config</code>

13284

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>

13285

13286

13287

13288

13289

13290

<p>An object with configuration property/value pairs, specifying the configuration properties to modify.</p>

13291

</div>

13292

13293

13294

</li>

13295

13296

</ul>

13297

</div>

13298

13299

13300

13301

13302

13303

</div>

13304

13305

13306

13307

13308

13309

13310

13311

13312

13313

13314

13315

<code>circular</code>

13316

13317

</li>

13318

13319

</ul><span class="paren">)</span>

13320

</div>

13321

13322

13323

13324

13325

<span class="type"><a href="../classes/Widget.html" class="crosslink">Widget</a></span>

13326

</span>

13327

13328

13329

13330

13331

13332

13333

13334

13335

13336

13337

13338

13339

13340

13341

13342

<p>Inherited from

13343

<a href="../classes/Widget.html#method_next">Widget</a>:

13344

13345

13346

13347

<a href="../files/widget-child_js_Widget-Child.js.html#l191"><code>widget-child/js/Widget-Child.js:191</code></a>

13348

13349

</p>

13350

13351

13352

13353

13354

13355

</div>

13356

13357

13358

<p>Returns the Widget's next sibling.</p>

13359

</div>

13360

13361

13362

13363

<h4>Parameters:</h4>

13364

13365

13366

13367

13368

13369

<code class="param-name">circular</code>

13370

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>

13371

13372

13373

13374

13375

13376

<p>Boolean indicating if the parent's first child

13377

should be returned if the child has no next sibling.</p>

13378

</div>

13379

13380

13381

</li>

13382

13383

</ul>

13384

</div>

13385

13386

13387

13388

13389

<h4>Returns:</h4>

13390

13391

13392

13393

13394

<span class="type"><a href="../classes/Widget.html" class="crosslink">Widget</a></span>:

13395

13396

Widget instance.

13397

13398

</div>

13399

</div>

13400

13401

13402

13403

</div>

13404

13405

13406

13407

13408

13409

13410

13411

13412

13413

13414

13415

13416

13417

</li>

13418

13419

13420

13421

13422

13423

</li>

13424

13425

13426

13427

<code class="optional">[context]</code>

13428

13429

</li>

13430

13431

13432

13433

13434

13435

</li>

13436

13437

</ul><span class="paren">)</span>

13438

</div>

13439

13440

13441

13442

13443

<span class="type"><a href="../classes/EventHandle.html" class="crosslink">EventHandle</a></span>

13444

</span>

13445

13446

13447

13448

13449

13450

13451

13452

13453

13454

13455

13456

13457

13458

13459

13460

<p>Inherited from

13461

<a href="../classes/EventTarget.html#method_on">EventTarget</a>:

13462

13463

13464

13465

<a href="../files/event-custom_js_event-target.js.html#l192"><code>event-custom/js/event-target.js:192</code></a>

13466

13467

</p>

13468

13469

13470

13471

13472

13473

</div>

13474

13475

13476

<p>Subscribe a callback function to a custom event fired by this object or

13477

from an object that bubbles its events to this object.</p>

13478

13479

<p>Callback functions for events published with <code>emitFacade = true</code> will

13480

receive an <code>EventFacade</code> as the first argument (typically named "e").

13481

These callbacks can then call <code>e.preventDefault()</code> to disable the

13482

behavior published to that event's <code>defaultFn</code>. See the <code>EventFacade</code>

13483

API for all available properties and methods. Subscribers to

13484

non-<code>emitFacade</code> events will receive the arguments passed to <code>fire()</code>

13485

after the event name.</p>

13486

13487

<p>To subscribe to multiple events at once, pass an object as the first

13488

argument, where the key:value pairs correspond to the eventName:callback,

13489

or pass an array of event names as the first argument to subscribe to

13490

all listed events with the same callback.</p>

13491

13492

<p>Returning <code>false</code> from a callback is supported as an alternative to

13493

calling <code>e.preventDefault(); e.stopPropagation();</code>. However, it is

13494

recommended to use the event methods whenever possible.</p>

13495

</div>

13496

13497

13498

13499

<h4>Parameters:</h4>

13500

13501

13502

13503

13504

13505

13506

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

13507

13508

13509

13510

13511

13512

<p>The name of the event</p>

13513

</div>

13514

13515

13516

</li>

13517

13518

13519

13520

13521

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function</a></span>

13522

13523

13524

13525

13526

13527

<p>The callback to execute in response to the event</p>

13528

</div>

13529

13530

13531

</li>

13532

13533

13534

13535

<code class="param-name optional">[context]</code>

13536

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>

13537

<span class="flag optional" title="This parameter is optional.">optional</span>

13538

13539

13540

13541

13542

13543

<p>Override <code>this</code> object in callback</p>

13544

</div>

13545

13546

13547

</li>

13548

13549

13550

13551

13552

13553

<span class="flag optional" title="This parameter is optional.">optional</span>

13554

13555

13556

13557

13558

13559

<p>0..n additional arguments to supply to the subscriber</p>

13560

</div>

13561

13562

13563

</li>

13564

13565

</ul>

13566

</div>

13567

13568

13569

13570

13571

<h4>Returns:</h4>

13572

13573

13574

13575

13576

<span class="type"><a href="../classes/EventHandle.html" class="crosslink">EventHandle</a></span>:

13577

13578

A subscription handle capable of detaching that

13579

subscription

13580

13581

</div>

13582

</div>

13583

13584

13585

13586

</div>

13587

13588

13589

13590

13591

13592

13593

13594

13595

13596

13597

13598

13599

13600

</li>

13601

13602

13603

13604

13605

13606

</li>

13607

13608

13609

13610

<code class="optional">[context]</code>

13611

13612

</li>

13613

13614

13615

13616

13617

13618

</li>

13619

13620

</ul><span class="paren">)</span>

13621

</div>

13622

13623

13624

13625

13626

<span class="type"><a href="../classes/EventHandle.html" class="crosslink">EventHandle</a></span>

13627

</span>

13628

13629

13630

13631

13632

13633

13634

13635

13636

13637

13638

13639

13640

13641

13642

13643

<p>Inherited from

13644

<a href="../classes/EventTarget.html#method_once">EventTarget</a>:

13645

13646

13647

13648

<a href="../files/event-custom_js_event-target.js.html#l128"><code>event-custom/js/event-target.js:128</code></a>

13649

13650

</p>

13651

13652

13653

13654

13655

13656

</div>

13657

13658

13659

<p>Listen to a custom event hosted by this object one time.

13660

This is the equivalent to <code>on</code> except the

13661

listener is immediatelly detached when it is executed.</p>

13662

</div>

13663

13664

13665

13666

<h4>Parameters:</h4>

13667

13668

13669

13670

13671

13672

13673

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

13674

13675

13676

13677

13678

13679

<p>The name of the event</p>

13680

</div>

13681

13682

13683

</li>

13684

13685

13686

13687

13688

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function</a></span>

13689

13690

13691

13692

13693

13694

<p>The callback to execute in response to the event</p>

13695

</div>

13696

13697

13698

</li>

13699

13700

13701

13702

<code class="param-name optional">[context]</code>

13703

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>

13704

<span class="flag optional" title="This parameter is optional.">optional</span>

13705

13706

13707

13708

13709

13710

<p>Override <code>this</code> object in callback</p>

13711

</div>

13712

13713

13714

</li>

13715

13716

13717

13718

13719

13720

<span class="flag optional" title="This parameter is optional.">optional</span>

13721

13722

13723

13724

13725

13726

<p>0..n additional arguments to supply to the subscriber</p>

13727

</div>

13728

13729

13730

</li>

13731

13732

</ul>

13733

</div>

13734

13735

13736

13737

13738

<h4>Returns:</h4>

13739

13740

13741

13742

13743

<span class="type"><a href="../classes/EventHandle.html" class="crosslink">EventHandle</a></span>:

13744

13745

A subscription handle capable of detaching the

13746

subscription

13747

13748

</div>

13749

</div>

13750

13751

13752

13753

</div>

13754

13755

13756

13757

<h3 class="name"><code>onceAfter</code></h3>

13758

13759

13760

13761

13762

13763

13764

13765

13766

13767

</li>

13768

13769

13770

13771

13772

13773

</li>

13774

13775

13776

13777

<code class="optional">[context]</code>

13778

13779

</li>

13780

13781

13782

13783

13784

13785

</li>

13786

13787

</ul><span class="paren">)</span>

13788

</div>

13789

13790

13791

13792

13793

<span class="type"><a href="../classes/EventHandle.html" class="crosslink">EventHandle</a></span>

13794

</span>

13795

13796

13797

13798

13799

13800

13801

13802

13803

13804

13805

13806

13807

13808

13809

13810

<p>Inherited from

13811

<a href="../classes/EventTarget.html#method_onceAfter">EventTarget</a>:

13812

13813

13814

13815

<a href="../files/event-custom_js_event-target.js.html#l150"><code>event-custom/js/event-target.js:150</code></a>

13816

13817

</p>

13818

13819

13820

13821

13822

13823

</div>

13824

13825

13826

<p>Listen to a custom event hosted by this object one time.

13827

This is the equivalent to <code>after</code> except the

13828

listener is immediatelly detached when it is executed.</p>

13829

</div>

13830

13831

13832

13833

<h4>Parameters:</h4>

13834

13835

13836

13837

13838

13839

13840

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

13841

13842

13843

13844

13845

13846

<p>The name of the event</p>

13847

</div>

13848

13849

13850

</li>

13851

13852

13853

13854

13855

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function</a></span>

13856

13857

13858

13859

13860

13861

<p>The callback to execute in response to the event</p>

13862

</div>

13863

13864

13865

</li>

13866

13867

13868

13869

<code class="param-name optional">[context]</code>

13870

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>

13871

<span class="flag optional" title="This parameter is optional.">optional</span>

13872

13873

13874

13875

13876

13877

<p>Override <code>this</code> object in callback</p>

13878

</div>

13879

13880

13881

</li>

13882

13883

13884

13885

13886

13887

<span class="flag optional" title="This parameter is optional.">optional</span>

13888

13889

13890

13891

13892

13893

<p>0..n additional arguments to supply to the subscriber</p>

13894

</div>

13895

13896

13897

</li>

13898

13899

</ul>

13900

</div>

13901

13902

13903

13904

13905

<h4>Returns:</h4>

13906

13907

13908

13909

13910

<span class="type"><a href="../classes/EventHandle.html" class="crosslink">EventHandle</a></span>:

13911

13912

A subscription handle capable of detaching that

13913

subscription

13914

13915

</div>

13916

</div>

13917

13918

13919

13920

</div>

13921

13922

13923

13924

<h3 class="name"><code>parseType</code></h3>

13925

13926

13927

13928

13929

13930

13931

13932

13933

13934

</li>

13935

13936

13937

13938

<code class="optional">[pre=this._yuievt.config.prefix]</code>

13939

13940

</li>

13941

13942

</ul><span class="paren">)</span>

13943

</div>

13944

13945

13946

13947

13948

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Array" class="crosslink external" target="_blank">Array</a></span>

13949

</span>

13950

13951

13952

13953

13954

13955

13956

13957

13958

13959

13960

13961

13962

13963

13964

13965

<p>Inherited from

13966

<a href="../classes/EventTarget.html#method_parseType">EventTarget</a>:

13967

13968

13969

13970

<a href="../files/event-custom_js_event-target.js.html#l172"><code>event-custom/js/event-target.js:172</code></a>

13971

13972

</p>

13973

13974

13975

13976

13977

13978

<p>Available since 3.3.0</p>

13979

13980

</div>

13981

13982

13983

<p>Takes the type parameter passed to 'on' and parses out the

13984

various pieces that could be included in the type. If the

13985

event type is passed without a prefix, it will be expanded

13986

to include the prefix one is supplied or the event target

13987

is configured with a default prefix.</p>

13988

</div>

13989

13990

13991

13992

<h4>Parameters:</h4>

13993

13994

13995

13996

13997

13998

13999

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

14000

14001

14002

14003

14004

14005

14006

</div>

14007

14008

14009

</li>

14010

14011

14012

14013

<code class="param-name optional">[pre=this._yuievt.config.prefix]</code>

14014

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

14015

<span class="flag optional" title="This parameter is optional.">optional</span>

14016

14017

14018

14019

14020

14021

<p>the prefix</p>

14022

</div>

14023

14024

14025

</li>

14026

14027

</ul>

14028

</div>

14029

14030

14031

14032

14033

<h4>Returns:</h4>

14034

14035

14036

14037

14038

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Array" class="crosslink external" target="_blank">Array</a></span>:

14039

14040

an array containing:

14041

* the detach category, if supplied,

14042

* the prefixed event type,

14043

* whether or not this is an after listener,

14044

* the supplied event type

14045

14046

</div>

14047

</div>

14048

14049

14050

14051

</div>

14052

14053

14054

14055

<h3 class="name"><code>previous</code></h3>

14056

14057

14058

14059

14060

14061

14062

14063

<code>circular</code>

14064

14065

</li>

14066

14067

</ul><span class="paren">)</span>

14068

</div>

14069

14070

14071

14072

14073

<span class="type"><a href="../classes/Widget.html" class="crosslink">Widget</a></span>

14074

</span>

14075

14076

14077

14078

14079

14080

14081

14082

14083

14084

14085

14086

14087

14088

14089

14090

<p>Inherited from

14091

<a href="../classes/Widget.html#method_previous">Widget</a>:

14092

14093

14094

14095

<a href="../files/widget-child_js_Widget-Child.js.html#l216"><code>widget-child/js/Widget-Child.js:216</code></a>

14096

14097

</p>

14098

14099

14100

14101

14102

14103

</div>

14104

14105

14106

<p>Returns the Widget's previous sibling.</p>

14107

</div>

14108

14109

14110

14111

<h4>Parameters:</h4>

14112

14113

14114

14115

14116

14117

<code class="param-name">circular</code>

14118

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>

14119

14120

14121

14122

14123

14124

<p>Boolean indicating if the parent's last child

14125

should be returned if the child has no previous sibling.</p>

14126

</div>

14127

14128

14129

</li>

14130

14131

</ul>

14132

</div>

14133

14134

14135

14136

14137

<h4>Returns:</h4>

14138

14139

14140

14141

14142

<span class="type"><a href="../classes/Widget.html" class="crosslink">Widget</a></span>:

14143

14144

Widget instance.

14145

14146

</div>

14147

</div>

14148

14149

14150

14151

</div>

14152

14153

14154

14155

<h3 class="name"><code>publish</code></h3>

14156

14157

14158

14159

14160

14161

14162

14163

14164

14165

</li>

14166

14167

14168

14169

14170

14171

</li>

14172

14173

</ul><span class="paren">)</span>

14174

</div>

14175

14176

14177

14178

14179

<span class="type"><a href="../classes/CustomEvent.html" class="crosslink">CustomEvent</a></span>

14180

</span>

14181

14182

14183

14184

14185

14186

14187

14188

14189

14190

14191

14192

14193

14194

14195

14196

<p>Inherited from

14197

<a href="../classes/EventTarget.html#method_publish">EventTarget</a>:

14198

14199

14200

14201

<a href="../files/event-custom_js_event-target.js.html#l489"><code>event-custom/js/event-target.js:489</code></a>

14202

14203

</p>

14204

14205

14206

14207

14208

14209

</div>

14210

14211

14212

<p>Creates a new custom event of the specified type. If a custom event

14213

by that name already exists, it will not be re-created. In either

14214

case the custom event is returned.</p>

14215

</div>

14216

14217

14218

14219

<h4>Parameters:</h4>

14220

14221

14222

14223

14224

14225

14226

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

14227

14228

14229

14230

14231

14232

<p>the type, or name of the event</p>

14233

</div>

14234

14235

14236

</li>

14237

14238

14239

14240

14241

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>

14242

14243

14244

14245

14246

14247

<p>optional config params. Valid properties are:</p>

14248

14249

<p><ul>

14250

<li>

14251

'broadcast': whether or not the YUI instance and YUI global are notified when the event is fired (false)

14252

</li>

14253

<li>

14254

'bubbles': whether or not this event bubbles (true)

14255

Events can only bubble if emitFacade is true.

14256

</li>

14257

<li>

14258

'context': the default execution context for the listeners (this)

14259

</li>

14260

<li>

14261

'defaultFn': the default function to execute when this event fires if preventDefault was not called

14262

</li>

14263

<li>

14264

'emitFacade': whether or not this event emits a facade (false)

14265

</li>

14266

<li>

14267

'prefix': the prefix for this targets events, e.g., 'menu' in 'menu:click'

14268

</li>

14269

<li>

14270

'fireOnce': if an event is configured to fire once, new subscribers after

14271

the fire will be notified immediately.

14272

</li>

14273

<li>

14274

'async': fireOnce event listeners will fire synchronously if the event has already

14275

fired unless async is true.

14276

</li>

14277

<li>

14278

'preventable': whether or not preventDefault() has an effect (true)

14279

</li>

14280

<li>

14281

'preventedFn': a function that is executed when preventDefault is called

14282

</li>

14283

<li>

14284

'queuable': whether or not this event can be queued during bubbling (false)

14285

</li>

14286

<li>

14287

'silent': if silent is true, debug messages are not provided for this event.

14288

</li>

14289

<li>

14290

'stoppedFn': a function that is executed when stopPropagation is called

14291

</li></p>

14292

14293

<p><li>

14294

'monitored': specifies whether or not this event should send notifications about

14295

when the event has been attached, detached, or published.

14296

</li>

14297

<li>

14298

'type': the event type (valid option if not provided as the first parameter to publish)

14299

</li>

14300

</ul></p>

14301

</div>

14302

14303

14304

</li>

14305

14306

</ul>

14307

</div>

14308

14309

14310

14311

14312

<h4>Returns:</h4>

14313

14314

14315

14316

14317

<span class="type"><a href="../classes/CustomEvent.html" class="crosslink">CustomEvent</a></span>:

14318

14319

the custom event

14320

14321

</div>

14322

</div>

14323

14324

14325

14326

</div>

14327

14328

14329

14330

<h3 class="name"><code>removeAttr</code></h3>

14331

14332

14333

14334

14335

14336

14337

14338

14339

14340

</li>

14341

14342

</ul><span class="paren">)</span>

14343

</div>

14344

14345

14346

14347

14348

14349

14350

14351

14352

14353

14354

14355

14356

14357

14358

14359

14360

14361

<p>Inherited from

14362

<a href="../classes/AttributeExtras.html#method_removeAttr">AttributeExtras</a>:

14363

14364

14365

14366

<a href="../files/attribute_js_AttributeExtras.js.html#l77"><code>attribute/js/AttributeExtras.js:77</code></a>

14367

14368

</p>

14369

14370

14371

14372

14373

14374

</div>

14375

14376

14377

<p>Removes an attribute from the host object</p>

14378

</div>

14379

14380

14381

14382

<h4>Parameters:</h4>

14383

14384

14385

14386

14387

14388

14389

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

14390

14391

14392

14393

14394

14395

<p>The name of the attribute to be removed.</p>

14396

</div>

14397

14398

14399

</li>

14400

14401

</ul>

14402

</div>

14403

14404

14405

14406

14407

14408

</div>

14409

14410

14411

14412

<h3 class="name"><code>removeTarget</code></h3>

14413

14414

14415

14416

14417

14418

14419

14420

14421

14422

</li>

14423

14424

</ul><span class="paren">)</span>

14425

</div>

14426

14427

14428

14429

14430

14431

14432

14433

14434

14435

14436

14437

14438

14439

14440

14441

14442

14443

<p>Inherited from

14444

<a href="../classes/EventTarget.html#method_removeTarget">EventTarget</a>:

14445

14446

14447

14448

<a href="../files/event-custom_js_event-facade.js.html#l409"><code>event-custom/js/event-facade.js:409</code></a>

14449

14450

</p>

14451

14452

14453

14454

14455

14456

</div>

14457

14458

14459

<p>Removes a bubble target</p>

14460

</div>

14461

14462

14463

14464

<h4>Parameters:</h4>

14465

14466

14467

14468

14469

14470

14471

<span class="type"><a href="../classes/EventTarget.html" class="crosslink">EventTarget</a></span>

14472

14473

14474

14475

14476

14477

<p>the target to remove</p>

14478

</div>

14479

14480

14481

</li>

14482

14483

</ul>

14484

</div>

14485

14486

14487

14488

14489

14490

</div>

14491

14492

14493

14494

<h3 class="name"><code>render</code></h3>

14495

14496

14497

14498

14499

14500

14501

14502

<code>parentNode</code>

14503

14504

</li>

14505

14506

</ul><span class="paren">)</span>

14507

</div>

14508

14509

14510

14511

14512

14513

14514

14515

14516

14517

<span class="flag final">final</span>

14518

14519

14520

14521

14522

14523

<span class="flag chainable">chainable</span>

14524

14525

14526

14527

14528

14529

<p>Inherited from

14530

<a href="../classes/Widget.html#method_render">Widget</a>:

14531

14532

14533

14534

<a href="../files/widget_js_Widget.js.html#l514"><code>widget/js/Widget.js:514</code></a>

14535

14536

</p>

14537

14538

14539

14540

14541

14542

</div>

14543

14544

14545

<p>Establishes the initial DOM for the widget. Invoking this

14546

method will lead to the creating of all DOM elements for

14547

the widget (or the manipulation of existing DOM elements

14548

for the progressive enhancement use case).</p>

14549

14550

<p>

14551

This method should only be invoked once for an initialized

14552

widget.

14553

</p>

14554

14555

<p>

14556

It delegates to the widget specific renderer method to do

14557

the actual work.

14558

</p>

14559

</div>

14560

14561

14562

14563

<h4>Parameters:</h4>

14564

14565

14566

14567

14568

14569

<code class="param-name">parentNode</code>

14570

<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>

14571

14572

14573

14574

14575

14576

<p>Optional. The Node under which the

14577

Widget is to be rendered. This can be a Node instance or a CSS selector string. </p>

14578

14579

<p>

14580

If the selector string returns more than one Node, the first node will be used

14581

as the parentNode. NOTE: This argument is required if both the boundingBox and contentBox

14582

are not currently in the document. If it's not provided, the Widget will be rendered

14583

to the body of the current document in this case.

14584

</p>

14585

</div>

14586

14587

14588

</li>

14589

14590

</ul>

14591

</div>

14592

14593

14594

14595

14596

14597

</div>

14598

14599

14600

14601

<h3 class="name"><code>renderer</code></h3>

14602

14603

14604

14605

14606

14607

14608

14609

14610

14611

14612

<span class="flag protected">protected</span>

14613

14614

14615

14616

14617

14618

14619

14620

14621

14622

14623

14624

<p>Inherited from

14625

<a href="../classes/Widget.html#method_renderer">Widget</a>:

14626

14627

14628

14629

<a href="../files/widget_js_Widget.js.html#l589"><code>widget/js/Widget.js:589</code></a>

14630

14631

</p>

14632

14633

14634

14635

14636

14637

</div>

14638

14639

14640

<p>Creates DOM (or manipulates DOM for progressive enhancement)

14641

This method is invoked by render() and is not chained

14642

automatically for the class hierarchy (unlike initializer, destructor)

14643

so it should be chained manually for subclasses if required.</p>

14644

</div>

14645

14646

14647

14648

14649

14650

14651

</div>

14652

14653

14654

14655

<h3 class="name"><code>renderUI</code></h3>

14656

14657

14658

14659

14660

14661

14662

14663

14664

14665

14666

<span class="flag protected">protected</span>

14667

14668

14669

14670

14671

14672

14673

14674

14675

14676

14677

14678

<p>Inherited from

14679

<a href="../classes/Widget.html#method_renderUI">Widget</a>:

14680

14681

14682

14683

<a href="../files/widget_js_Widget.js.html#l623"><code>widget/js/Widget.js:623</code></a>

14684

14685

</p>

14686

14687

14688

14689

14690

14691

</div>

14692

14693

14694

<p>Adds nodes to the DOM </p>

14695

14696

<p>This method is not called by framework and is not chained

14697

automatically for the class hierarchy.</p>

14698

</div>

14699

14700

14701

14702

14703

14704

14705

</div>

14706

14707

14708

14709

<h3 class="name"><code>reset</code></h3>

14710

14711

14712

14713

14714

14715

14716

14717

14718

14719

</li>

14720

14721

</ul><span class="paren">)</span>

14722

</div>

14723

14724

14725

14726

14727

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>

14728

</span>

14729

14730

14731

14732

14733

14734

14735

14736

14737

14738

14739

14740

<span class="flag chainable">chainable</span>

14741

14742

14743

14744

14745

14746

<p>Inherited from

14747

<a href="../classes/AttributeExtras.html#method_reset">AttributeExtras</a>:

14748

14749

14750

14751

<a href="../files/attribute_js_AttributeExtras.js.html#l87"><code>attribute/js/AttributeExtras.js:87</code></a>

14752

14753

</p>

14754

14755

14756

14757

14758

14759

</div>

14760

14761

14762

<p>Resets the attribute (or all attributes) to its initial value, as long as

14763

the attribute is not readOnly, or writeOnce.</p>

14764

</div>

14765

14766

14767

14768

<h4>Parameters:</h4>

14769

14770

14771

14772

14773

14774

14775

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

14776

14777

14778

14779

14780

14781

<p>Optional. The name of the attribute to reset. If omitted, all attributes are reset.</p>

14782

</div>

14783

14784

14785

</li>

14786

14787

</ul>

14788

</div>

14789

14790

14791

14792

14793

<h4>Returns:</h4>

14794

14795

14796

14797

14798

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>:

14799

14800

A reference to the host object.

14801

14802

</div>

14803

</div>

14804

14805

14806

14807

</div>

14808

14809

14810

14811

14812

14813

14814

14815

14816

14817

14818

14819

14820

14821

</li>

14822

14823

14824

14825

<code>value</code>

14826

14827

</li>

14828

14829

</ul><span class="paren">)</span>

14830

</div>

14831

14832

14833

14834

14835

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>

14836

</span>

14837

14838

14839

14840

14841

14842

14843

14844

14845

14846

14847

14848

<span class="flag chainable">chainable</span>

14849

14850

14851

14852

14853

<p>Inherited from

14854

14855

AttributeEvents

14856

</a>

14857

14858

but overwritten in

14859

14860

14861

14862

<a href="../files/attribute_js_AttributeCore.js.html#l328"><code>attribute/js/AttributeCore.js:328</code></a>

14863

14864

</p>

14865

14866

14867

14868

14869

14870

</div>

14871

14872

14873

<p>Sets the value of an attribute.</p>

14874

</div>

14875

14876

14877

14878

<h4>Parameters:</h4>

14879

14880

14881

14882

14883

14884

14885

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

14886

14887

14888

14889

14890

14891

<p>The name of the attribute. If the

14892

current value of the attribute is an Object, dot notation can be used

14893

to set the value of a property within the object (e.g. <code>set("x.y.z", 5)</code>).</p>

14894

</div>

14895

14896

14897

</li>

14898

14899

14900

14901

<code class="param-name">value</code>

14902

14903

14904

14905

14906

14907

14908

<p>The value to set the attribute to.</p>

14909

</div>

14910

14911

14912

</li>

14913

14914

</ul>

14915

</div>

14916

14917

14918

14919

14920

<h4>Returns:</h4>

14921

14922

14923

14924

14925

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>:

14926

14927

A reference to the host object.

14928

14929

</div>

14930

</div>

14931

14932

14933

14934

</div>

14935

14936

14937

14938

<h3 class="name"><code>setAttrs</code></h3>

14939

14940

14941

14942

14943

14944

14945

14946

<code>attrs</code>

14947

14948

</li>

14949

14950

</ul><span class="paren">)</span>

14951

</div>

14952

14953

14954

14955

14956

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>

14957

</span>

14958

14959

14960

14961

14962

14963

14964

14965

14966

14967

14968

14969

<span class="flag chainable">chainable</span>

14970

14971

14972

14973

14974

<p>Inherited from

14975

14976

AttributeEvents

14977

</a>

14978

14979

but overwritten in

14980

14981

14982

14983

<a href="../files/attribute_js_AttributeCore.js.html#l635"><code>attribute/js/AttributeCore.js:635</code></a>

14984

14985

</p>

14986

14987

14988

14989

14990

14991

</div>

14992

14993

14994

<p>Sets multiple attribute values.</p>

14995

</div>

14996

14997

14998

14999

<h4>Parameters:</h4>

15000

15001

15002

15003

15004

15005

<code class="param-name">attrs</code>

15006

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>

15007

15008

15009

15010

15011

15012

<p>An object with attributes name/value pairs.</p>

15013

</div>

15014

15015

15016

</li>

15017

15018

</ul>

15019

</div>

15020

15021

15022

15023

15024

<h4>Returns:</h4>

15025

15026

15027

15028

15029

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>:

15030

15031

A reference to the host object.

15032

15033

</div>

15034

</div>

15035

15036

15037

15038

</div>

15039

15040

15041

15042

15043

15044

15045

15046

15047

15048

15049

15050

15051

15052

15053

15054

15055

15056

15057

15058

15059

<span class="flag chainable">chainable</span>

15060

15061

15062

15063

15064

15065

<p>Inherited from

15066

<a href="../classes/Widget.html#method_show">Widget</a>:

15067

15068

15069

15070

<a href="../files/widget_js_Widget.js.html#l655"><code>widget/js/Widget.js:655</code></a>

15071

15072

</p>

15073

15074

15075

15076

15077

15078

</div>

15079

15080

15081

<p>Shows the Widget by setting the "visible" attribute to "true".</p>

15082

</div>

15083

15084

15085

15086

15087

15088

15089

</div>

15090

15091

15092

15093

<h3 class="name"><code>subscribe</code></h3>

15094

15095

15096

15097

15098

15099

15100

15101

15102

<span class="flag deprecated" title="use on">deprecated</span>

15103

15104

15105

15106

15107

15108

15109

15110

15111

15112

15113

15114

15115

15116

<p>Inherited from

15117

<a href="../classes/EventTarget.html#method_subscribe">EventTarget</a>:

15118

15119

15120

15121

<a href="../files/event-custom_js_event-target.js.html#l335"><code>event-custom/js/event-target.js:335</code></a>

15122

15123

</p>

15124

15125

15126

15127

<p>Deprecated: use on</p>

15128

15129

15130

15131

</div>

15132

15133

15134

<p>subscribe to an event</p>

15135

</div>

15136

15137

15138

15139

15140

15141

15142

</div>

15143

15144

15145

15146

<h3 class="name"><code>syncUI</code></h3>

15147

15148

15149

15150

15151

15152

15153

15154

15155

15156

15157

15158

15159

15160

15161

15162

15163

15164

15165

15166

<p>Inherited from

15167

15168

Widget

15169

</a>

15170

15171

but overwritten in

15172

15173

15174

15175

<a href="../files/button_js_button.js.html#l53"><code>button/js/button.js:53</code></a>

15176

15177

</p>

15178

15179

15180

15181

15182

15183

</div>

15184

15185

15186

<p>Updates button attributes</p>

15187

</div>

15188

15189

15190

15191

15192

15193

15194

</div>

15195

15196

15197

15198

<h3 class="name"><code>toString</code></h3>

15199

15200

15201

15202

15203

15204

15205

15206

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

15207

</span>

15208

15209

15210

15211

15212

15213

15214

15215

15216

15217

15218

15219

15220

15221

15222

<p>Inherited from

15223

15224

BaseCore

15225

</a>

15226

15227

but overwritten in

15228

15229

15230

15231

<a href="../files/widget_js_Widget.js.html#l1094"><code>widget/js/Widget.js:1094</code></a>

15232

15233

</p>

15234

15235

15236

15237

15238

15239

</div>

15240

15241

15242

<p>Generic toString implementation for all widgets.</p>

15243

</div>

15244

15245

15246

15247

15248

15249

<h4>Returns:</h4>

15250

15251

15252

15253

15254

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>:

15255

15256

The default string value for the widget [ displays the NAME of the instance, and the unique id ]

15257

15258

</div>

15259

</div>

15260

15261

15262

15263

</div>

15264

15265

15266

15267

<h3 class="name"><code>unsubscribe</code></h3>

15268

15269

15270

15271

15272

15273

15274

15275

15276

<span class="flag deprecated" title="use detach">deprecated</span>

15277

15278

15279

15280

15281

15282

15283

15284

15285

15286

15287

15288

15289

15290

<p>Inherited from

15291

<a href="../classes/EventTarget.html#method_unsubscribe">EventTarget</a>:

15292

15293

15294

15295

<a href="../files/event-custom_js_event-target.js.html#l455"><code>event-custom/js/event-target.js:455</code></a>

15296

15297

</p>

15298

15299

15300

15301

<p>Deprecated: use detach</p>

15302

15303

15304

15305

</div>

15306

15307

15308

<p>detach a listener</p>

15309

</div>

15310

15311

15312

15313

15314

15315

15316

</div>

15317

15318

15319

15320

<h3 class="name"><code>unsubscribeAll</code></h3>

15321

15322

15323

15324

15325

15326

15327

15328

15329

15330

</li>

15331

15332

</ul><span class="paren">)</span>

15333

</div>

15334

15335

15336

15337

15338

15339

<span class="flag deprecated" title="use detachAll">deprecated</span>

15340

15341

15342

15343

15344

15345

15346

15347

15348

15349

15350

15351

15352

15353

<p>Inherited from

15354

<a href="../classes/EventTarget.html#method_unsubscribeAll">EventTarget</a>:

15355

15356

15357

15358

<a href="../files/event-custom_js_event-target.js.html#l476"><code>event-custom/js/event-target.js:476</code></a>

15359

15360

</p>

15361

15362

15363

15364

<p>Deprecated: use detachAll</p>

15365

15366

15367

15368

</div>

15369

15370

15371

<p>Removes all listeners from the specified event. If the event type

15372

is not specified, all listeners from all hosted custom events will

15373

be removed.</p>

15374

</div>

15375

15376

15377

15378

<h4>Parameters:</h4>

15379

15380

15381

15382

15383

15384

15385

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

15386

15387

15388

15389

15390

15391

<p>The type, or name of the event</p>

15392

</div>

15393

15394

15395

</li>

15396

15397

</ul>

15398

</div>

15399

15400

15401

15402

15403

15404

</div>

15405

15406

15407

</div>

15408

15409

15410

15411

15412

<h2 class="off-left">Properties</h2>

15413

15414

15415

15416

<h3 class="name"><code>_allowAdHocAttrs</code></h3>

15417

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>

15418

15419

15420

15421

15422

<span class="flag protected">protected</span>

15423

15424

15425

15426

15427

15428

15429

15430

15431

15432

<p>Inherited from

15433

<a href="../classes/BaseCore.html#property__allowAdHocAttrs">BaseCore</a>:

15434

15435

15436

15437

<a href="../files/base_js_BaseCore.js.html#l100"><code>base/js/BaseCore.js:100</code></a>

15438

15439

</p>

15440

15441

15442

15443

15444

</div>

15445

15446

15447

<p>This property controls whether or not instances of this class should

15448

allow users to add ad-hoc attributes through the constructor configuration

15449

hash.</p>

15450

15451

<p>AdHoc attributes are attributes which are not defined by the class, and are

15452

not handled by the MyClass.<em>NON</em>ATTRS_CFG</p>

15453

</div>

15454

15455

15456

<p><strong>Default:</strong> undefined (false)</p>

15457

15458

15459

15460

15461

15462

</div>

15463

15464

15465

15466

<h3 class="name"><code>_UI_ATTRS</code></h3>

15467

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>

15468

15469

15470

15471

15472

<span class="flag private">private</span>

15473

15474

15475

15476

15477

15478

15479

15480

15481

15482

<p>Inherited from

15483

<a href="../classes/Widget.html#property__UI_ATTRS">Widget</a>:

15484

15485

15486

15487

<a href="../files/widget_js_Widget.js.html#l1236"><code>widget/js/Widget.js:1236</code></a>

15488

15489

</p>

15490

15491

15492

15493

15494

</div>

15495

15496

15497

<p>The lists of UI attributes to bind and sync for widget's _bindUI and _syncUI implementations</p>

15498

</div>

15499

15500

15501

15502

15503

15504

15505

</div>

15506

15507

15508

15509

<h3 class="name"><code>ATTRS</code></h3>

15510

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>

15511

15512

15513

15514

15515

<span class="flag protected">protected</span>

15516

15517

15518

15519

15520

15521

<span class="flag static">static</span>

15522

15523

15524

15525

15526

15527

15528

<p>

15529

15530

Defined in

15531

15532

15533

15534

15535

<a href="../files/button_js_button.js.html#l94"><code>button/js/button.js:94</code></a>

15536

15537

</p>

15538

15539

15540

15541

15542

</div>

15543

15544

15545

<p>Static property used to define the default attribute configuration of

15546

the Widget.</p>

15547

</div>

15548

15549

15550

15551

15552

15553

15554

</div>

15555

15556

15557

15558

<h3 class="name"><code>BOUNDING_TEMPLATE</code></h3>

15559

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

15560

15561

15562

15563

15564

15565

15566

15567

15568

15569

15570

15571

15572

<p>Inherited from

15573

<a href="../classes/Widget.html#property_BOUNDING_TEMPLATE">Widget</a>:

15574

15575

15576

15577

<a href="../files/widget_js_Widget.js.html#l1132"><code>widget/js/Widget.js:1132</code></a>

15578

15579

</p>

15580

15581

15582

15583

15584

</div>

15585

15586

15587

<p>Property defining the markup template for bounding box.</p>

15588

</div>

15589

15590

15591

15592

15593

15594

15595

</div>

15596

15597

15598

15599

<h3 class="name"><code>CLASS_NAMES</code></h3>

15600

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>

15601

15602

15603

15604

15605

15606

15607

15608

15609

<span class="flag static">static</span>

15610

15611

15612

15613

15614

15615

15616

<p>

15617

15618

Defined in

15619

15620

15621

15622

15623

<a href="../files/button_js_button.js.html#l130"><code>button/js/button.js:130</code></a>

15624

15625

</p>

15626

15627

15628

15629

15630

</div>

15631

15632

15633

<p>List of class names used in the ButtonGroup's DOM</p>

15634

</div>

15635

15636

15637

15638

15639

15640

15641

</div>

15642

15643

15644

15645

<h3 class="name"><code>CONTENT_TEMPLATE</code></h3>

15646

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

15647

15648

15649

15650

15651

15652

15653

15654

15655

15656

15657

15658

15659

<p>Inherited from

15660

<a href="../classes/Widget.html#property_CONTENT_TEMPLATE">Widget</a>:

15661

15662

15663

15664

<a href="../files/widget_js_Widget.js.html#l1122"><code>widget/js/Widget.js:1122</code></a>

15665

15666

</p>

15667

15668

15669

15670

15671

</div>

15672

15673

15674

<p>Property defining the markup template for content box. If your Widget doesn't

15675

need the dual boundingBox/contentBox structure, set CONTENT_TEMPLATE to null,

15676

and contentBox and boundingBox will both point to the same Node.</p>

15677

</div>

15678

15679

15680

15681

15682

15683

15684

</div>

15685

15686

15687

15688

<h3 class="name"><code>DEF_PARENT_NODE</code></h3>

15689

<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>

15690

15691

15692

15693

15694

15695

15696

15697

15698

15699

15700

15701

15702

<p>Inherited from

15703

<a href="../classes/Widget.html#property_DEF_PARENT_NODE">Widget</a>:

15704

15705

15706

15707

<a href="../files/widget_js_Widget.js.html#l1113"><code>widget/js/Widget.js:1113</code></a>

15708

15709

</p>

15710

15711

15712

15713

15714

</div>

15715

15716

15717

<p>Default node to render the bounding box to. If not set,

15718

will default to the current document body.</p>

15719

</div>

15720

15721

15722

15723

15724

15725

15726

</div>

15727

15728

15729

15730

15731

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

15732

15733

15734

15735

15736

15737

15738

15739

15740

15741

15742

15743

15744

<p>Inherited from

15745

<a href="../classes/Widget.html#property_DEF_UNIT">Widget</a>:

15746

15747

15748

15749

<a href="../files/widget_js_Widget.js.html#l1105"><code>widget/js/Widget.js:1105</code></a>

15750

15751

</p>

15752

15753

15754

15755

15756

</div>

15757

15758

15759

<p>Default unit to use for dimension values</p>

15760

</div>

15761

15762

15763

15764

15765

15766

15767

</div>

15768

15769

15770

15771

<h3 class="name"><code>HTML_PARSER</code></h3>

15772

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>

15773

15774

15775

15776

15777

<span class="flag protected">protected</span>

15778

15779

15780

15781

15782

15783

<span class="flag static">static</span>

15784

15785

15786

15787

15788

15789

15790

<p>

15791

15792

Defined in

15793

15794

15795

15796

15797

<a href="../files/button_js_button.js.html#l113"><code>button/js/button.js:113</code></a>

15798

15799

</p>

15800

15801

15802

15803

15804

</div>

15805

15806

15807

15808

</div>

15809

15810

15811

15812

15813

15814

15815

</div>

15816

15817

15818

15819

15820

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

15821

15822

15823

15824

15825

<span class="flag protected">protected</span>

15826

15827

15828

15829

15830

15831

<span class="flag static">static</span>

15832

15833

15834

15835

15836

15837

15838

<p>

15839

15840

Defined in

15841

15842

15843

15844

15845

<a href="../files/button_js_button.js.html#l82"><code>button/js/button.js:82</code></a>

15846

15847

</p>

15848

15849

15850

15851

15852

</div>

15853

15854

15855

<p>The identity of the widget.</p>

15856

</div>

15857

15858

15859

<p><strong>Default:</strong> 'button'</p>

15860

15861

15862

15863

15864

15865

</div>

15866

15867

15868

15869

15870

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

15871

15872

15873

<span class="flag deprecated" title="Use this.constructor.NAME">deprecated</span>

15874

15875

15876

15877

15878

15879

15880

15881

15882

15883

15884

15885

<p>Inherited from

15886

<a href="../classes/BaseCore.html#property_name">BaseCore</a>:

15887

15888

15889

15890

<a href="../files/base_js_BaseCore.js.html#l196"><code>base/js/BaseCore.js:196</code></a>

15891

15892

</p>

15893

15894

15895

<p>Deprecated: Use this.constructor.NAME</p>

15896

15897

15898

15899

</div>

15900

15901

15902

<p>The string used to identify the class of this object.</p>

15903

</div>

15904

15905

15906

15907

15908

15909

15910

</div>

15911

15912

15913

15914

<h3 class="name"><code>UI_EVENTS</code></h3>

15915

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>

15916

15917

15918

15919

15920

15921

15922

15923

15924

15925

15926

15927

15928

<p>Inherited from

15929

<a href="../classes/Widget.html#property_UI_EVENTS">Widget</a>:

15930

15931

15932

15933

<a href="../files/widget_js_WidgetUIEvents.js.html#l52"><code>widget/js/WidgetUIEvents.js:52</code></a>

15934

15935

</p>

15936

15937

15938

15939

15940

</div>

15941

15942

15943

<p>Map of DOM events that should be fired as Custom Events by the

15944

Widget instance.</p>

15945

</div>

15946

15947

15948

15949

15950

15951

15952

</div>

15953

15954

15955

</div>

15956

15957

15958

15959

15960

<h2 class="off-left">Attributes</h2>

15961

15962

15963

15964

15965

<h3 class="name"><code>boundingBox</code></h3>

15966

<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>

15967

15968

15969

15970

15971

15972

15973

15974

15975

15976

15977

15978

15979

<p>Inherited from

15980

<a href="../classes/Widget.html#attr_boundingBox">Widget</a>:

15981

15982

15983

15984

<a href="../files/widget_js_Widget.js.html#l175"><code>widget/js/Widget.js:175</code></a>

15985

15986

</p>

15987

15988

15989

15990

15991

</div>

15992

15993

15994

<p>The outermost DOM node for the Widget, used for sizing and positioning

15995

of a Widget as well as a containing element for any decorator elements used

15996

for skinning.</p>

15997

</div>

15998

15999

16000

16001

16002

16003

<h4>Fires event <code>boundingBoxChange</code></h4>

16004

16005

<p>

16006

Fires when the value for the configuration attribute <code>boundingBox</code> is

16007

changed. You can listen for the event using the <code>on</code> method if you

16008

wish to be notified before the attribute's value has changed, or

16009

using the <code>after</code> method if you wish to be notified after the

16010

attribute's value has changed.

16011

</p>

16012

16013

16014

<h4>Parameters:</h4>

16015

16016

16017

16018

16019

<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>

16020

16021

16022

An Event Facade object with the following

16023

attribute-specific properties added:

16024

</div>

16025

16026

16027

16028

<code class="param-name">prevVal</code>

16029

16030

<div class="param-description">The value of the attribute, prior to it being set.</div>

16031

</li>

16032

16033

<code class="param-name">newVal</code>

16034

16035

<div class="param-description">The value the attribute is to be set to.</div>

16036

</li>

16037

16038

<code class="param-name">attrName</code>

16039

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

16040

<div class="param-description">The name of the attribute being set.</div>

16041

</li>

16042

16043

<code class="param-name">subAttrName</code>

16044

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

16045

<div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div>

16046

</li>

16047

</ul>

16048

</li>

16049

</ul>

16050

</div>

16051

</div>

16052

16053

16054

16055

</div>

16056

16057

16058

16059

16060

<h3 class="name"><code>contentBox</code></h3>

16061

<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>

16062

16063

16064

16065

16066

16067

16068

16069

16070

16071

16072

16073

16074

<p>Inherited from

16075

<a href="../classes/Widget.html#attr_contentBox">Widget</a>:

16076

16077

16078

16079

<a href="../files/widget_js_Widget.js.html#l189"><code>widget/js/Widget.js:189</code></a>

16080

16081

</p>

16082

16083

16084

16085

16086

</div>

16087

16088

16089

<p>A DOM node that is a direct descendant of a Widget's bounding box that

16090

houses its content.</p>

16091

</div>

16092

16093

16094

16095

16096

16097

<h4>Fires event <code>contentBoxChange</code></h4>

16098

16099

<p>

16100

Fires when the value for the configuration attribute <code>contentBox</code> is

16101

changed. You can listen for the event using the <code>on</code> method if you

16102

wish to be notified before the attribute's value has changed, or

16103

using the <code>after</code> method if you wish to be notified after the

16104

attribute's value has changed.

16105

</p>

16106

16107

16108

<h4>Parameters:</h4>

16109

16110

16111

16112

16113

<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>

16114

16115

16116

An Event Facade object with the following

16117

attribute-specific properties added:

16118

</div>

16119

16120

16121

16122

<code class="param-name">prevVal</code>

16123

16124

<div class="param-description">The value of the attribute, prior to it being set.</div>

16125

</li>

16126

16127

<code class="param-name">newVal</code>

16128

16129

<div class="param-description">The value the attribute is to be set to.</div>

16130

</li>

16131

16132

<code class="param-name">attrName</code>

16133

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

16134

<div class="param-description">The name of the attribute being set.</div>

16135

</li>

16136

16137

<code class="param-name">subAttrName</code>

16138

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

16139

<div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div>

16140

</li>

16141

</ul>

16142

</li>

16143

</ul>

16144

</div>

16145

</div>

16146

16147

16148

16149

</div>

16150

16151

16152

16153

16154

<h3 class="name"><code>destroyed</code></h3>

16155

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>

16156

16157

16158

16159

16160

16161

16162

16163

16164

16165

16166

16167

16168

<p>Inherited from

16169

<a href="../classes/BaseCore.html#attr_destroyed">BaseCore</a>:

16170

16171

16172

16173

<a href="../files/base_js_BaseCore.js.html#l157"><code>base/js/BaseCore.js:157</code></a>

16174

16175

</p>

16176

16177

16178

16179

16180

</div>

16181

16182

16183

<p>Flag indicating whether or not this object

16184

has been through the destroy lifecycle phase.</p>

16185

</div>

16186

16187

16188

<p><strong>Default:</strong> false</p>

16189

16190

16191

16192

16193

<h4>Fires event <code>destroyedChange</code></h4>

16194

16195

<p>

16196

Fires when the value for the configuration attribute <code>destroyed</code> is

16197

changed. You can listen for the event using the <code>on</code> method if you

16198

wish to be notified before the attribute's value has changed, or

16199

using the <code>after</code> method if you wish to be notified after the

16200

attribute's value has changed.

16201

</p>

16202

16203

16204

<h4>Parameters:</h4>

16205

16206

16207

16208

16209

<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>

16210

16211

16212

An Event Facade object with the following

16213

attribute-specific properties added:

16214

</div>

16215

16216

16217

16218

<code class="param-name">prevVal</code>

16219

16220

<div class="param-description">The value of the attribute, prior to it being set.</div>

16221

</li>

16222

16223

<code class="param-name">newVal</code>

16224

16225

<div class="param-description">The value the attribute is to be set to.</div>

16226

</li>

16227

16228

<code class="param-name">attrName</code>

16229

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

16230

<div class="param-description">The name of the attribute being set.</div>

16231

</li>

16232

16233

<code class="param-name">subAttrName</code>

16234

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

16235

<div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div>

16236

</li>

16237

</ul>

16238

</li>

16239

</ul>

16240

</div>

16241

</div>

16242

16243

16244

16245

</div>

16246

16247

16248

16249

16250

<h3 class="name"><code>disabled</code></h3>

16251

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>

16252

16253

16254

16255

16256

16257

16258

16259

16260

16261

16262

16263

16264

<p>Inherited from

16265

<a href="../classes/Widget.html#attr_disabled">Widget</a>:

16266

16267

16268

16269

<a href="../files/widget_js_Widget.js.html#l231"><code>widget/js/Widget.js:231</code></a>

16270

16271

</p>

16272

16273

16274

16275

16276

</div>

16277

16278

16279

<p>Boolean indicating if the Widget should be disabled. The disabled implementation

16280

is left to the specific classes extending widget.</p>

16281

</div>

16282

16283

16284

<p><strong>Default:</strong> false</p>

16285

16286

16287

16288

16289

<h4>Fires event <code>disabledChange</code></h4>

16290

16291

<p>

16292

Fires when the value for the configuration attribute <code>disabled</code> is

16293

changed. You can listen for the event using the <code>on</code> method if you

16294

wish to be notified before the attribute's value has changed, or

16295

using the <code>after</code> method if you wish to be notified after the

16296

attribute's value has changed.

16297

</p>

16298

16299

16300

<h4>Parameters:</h4>

16301

16302

16303

16304

16305

<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>

16306

16307

16308

An Event Facade object with the following

16309

attribute-specific properties added:

16310

</div>

16311

16312

16313

16314

<code class="param-name">prevVal</code>

16315

16316

<div class="param-description">The value of the attribute, prior to it being set.</div>

16317

</li>

16318

16319

<code class="param-name">newVal</code>

16320

16321

<div class="param-description">The value the attribute is to be set to.</div>

16322

</li>

16323

16324

<code class="param-name">attrName</code>

16325

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

16326

<div class="param-description">The name of the attribute being set.</div>

16327

</li>

16328

16329

<code class="param-name">subAttrName</code>

16330

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

16331

<div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div>

16332

</li>

16333

</ul>

16334

</li>

16335

</ul>

16336

</div>

16337

</div>

16338

16339

16340

16341

</div>

16342

16343

16344

16345

16346

<h3 class="name"><code>focused</code></h3>

16347

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>

16348

16349

16350

16351

16352

16353

16354

16355

16356

16357

16358

16359

16360

<p>Inherited from

16361

<a href="../classes/Widget.html#attr_focused">Widget</a>:

16362

16363

16364

16365

<a href="../files/widget_js_Widget.js.html#l218"><code>widget/js/Widget.js:218</code></a>

16366

16367

</p>

16368

16369

16370

16371

16372

</div>

16373

16374

16375

<p>Boolean indicating if the Widget, or one of its descendants,

16376

has focus.</p>

16377

</div>

16378

16379

16380

<p><strong>Default:</strong> false</p>

16381

16382

16383

16384

16385

<h4>Fires event <code>focusedChange</code></h4>

16386

16387

<p>

16388

Fires when the value for the configuration attribute <code>focused</code> is

16389

changed. You can listen for the event using the <code>on</code> method if you

16390

wish to be notified before the attribute's value has changed, or

16391

using the <code>after</code> method if you wish to be notified after the

16392

attribute's value has changed.

16393

</p>

16394

16395

16396

<h4>Parameters:</h4>

16397

16398

16399

16400

16401

<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>

16402

16403

16404

An Event Facade object with the following

16405

attribute-specific properties added:

16406

</div>

16407

16408

16409

16410

<code class="param-name">prevVal</code>

16411

16412

<div class="param-description">The value of the attribute, prior to it being set.</div>

16413

</li>

16414

16415

<code class="param-name">newVal</code>

16416

16417

<div class="param-description">The value the attribute is to be set to.</div>

16418

</li>

16419

16420

<code class="param-name">attrName</code>

16421

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

16422

<div class="param-description">The name of the attribute being set.</div>

16423

</li>

16424

16425

<code class="param-name">subAttrName</code>

16426

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

16427

<div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div>

16428

</li>

16429

</ul>

16430

</li>

16431

</ul>

16432

</div>

16433

</div>

16434

16435

16436

16437

</div>

16438

16439

16440

16441

16442

<h3 class="name"><code>height</code></h3>

16443

16444

16445

16446

16447

16448

16449

16450

16451

16452

16453

16454

16455

16456

<p>Inherited from

16457

<a href="../classes/Widget.html#attr_height">Widget</a>:

16458

16459

16460

16461

<a href="../files/widget_js_Widget.js.html#l252"><code>widget/js/Widget.js:252</code></a>

16462

16463

</p>

16464

16465

16466

16467

16468

</div>

16469

16470

16471

<p>String with units, or number, representing the height of the Widget. If a number is provided,

16472

the default unit, defined by the Widgets DEF_UNIT, property is used.</p>

16473

</div>

16474

16475

16476

<p><strong>Default:</strong> EMPTY_STR</p>

16477

16478

16479

16480

16481

<h4>Fires event <code>heightChange</code></h4>

16482

16483

<p>

16484

Fires when the value for the configuration attribute <code>height</code> is

16485

changed. You can listen for the event using the <code>on</code> method if you

16486

wish to be notified before the attribute's value has changed, or

16487

using the <code>after</code> method if you wish to be notified after the

16488

attribute's value has changed.

16489

</p>

16490

16491

16492

<h4>Parameters:</h4>

16493

16494

16495

16496

16497

<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>

16498

16499

16500

An Event Facade object with the following

16501

attribute-specific properties added:

16502

</div>

16503

16504

16505

16506

<code class="param-name">prevVal</code>

16507

16508

<div class="param-description">The value of the attribute, prior to it being set.</div>

16509

</li>

16510

16511

<code class="param-name">newVal</code>

16512

16513

<div class="param-description">The value the attribute is to be set to.</div>

16514

</li>

16515

16516

<code class="param-name">attrName</code>

16517

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

16518

<div class="param-description">The name of the attribute being set.</div>

16519

</li>

16520

16521

<code class="param-name">subAttrName</code>

16522

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

16523

<div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div>

16524

</li>

16525

</ul>

16526

</li>

16527

</ul>

16528

</div>

16529

</div>

16530

16531

16532

16533

</div>

16534

16535

16536

16537

16538

16539

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

16540

16541

16542

16543

16544

16545

16546

16547

16548

16549

16550

16551

16552

<p>Inherited from

16553

<a href="../classes/Widget.html#attr_id">Widget</a>:

16554

16555

16556

16557

<a href="../files/widget_js_Widget.js.html#l149"><code>widget/js/Widget.js:149</code></a>

16558

16559

</p>

16560

16561

16562

16563

16564

</div>

16565

16566

16567

16568

</div>

16569

16570

16571

<p><strong>Default:</strong> Generated using guid()</p>

16572

16573

16574

16575

16576

<h4>Fires event <code>idChange</code></h4>

16577

16578

<p>

16579

Fires when the value for the configuration attribute <code>id</code> is

16580

changed. You can listen for the event using the <code>on</code> method if you

16581

wish to be notified before the attribute's value has changed, or

16582

using the <code>after</code> method if you wish to be notified after the

16583

attribute's value has changed.

16584

</p>

16585

16586

16587

<h4>Parameters:</h4>

16588

16589

16590

16591

16592

<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>

16593

16594

16595

An Event Facade object with the following

16596

attribute-specific properties added:

16597

</div>

16598

16599

16600

16601

<code class="param-name">prevVal</code>

16602

16603

<div class="param-description">The value of the attribute, prior to it being set.</div>

16604

</li>

16605

16606

<code class="param-name">newVal</code>

16607

16608

<div class="param-description">The value the attribute is to be set to.</div>

16609

</li>

16610

16611

<code class="param-name">attrName</code>

16612

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

16613

<div class="param-description">The name of the attribute being set.</div>

16614

</li>

16615

16616

<code class="param-name">subAttrName</code>

16617

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

16618

<div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div>

16619

</li>

16620

</ul>

16621

</li>

16622

</ul>

16623

</div>

16624

</div>

16625

16626

16627

16628

</div>

16629

16630

16631

16632

16633

<h3 class="name"><code>initialized</code></h3>

16634

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>

16635

16636

16637

16638

16639

16640

16641

16642

16643

16644

16645

16646

16647

<p>Inherited from

16648

<a href="../classes/BaseCore.html#attr_initialized">BaseCore</a>:

16649

16650

16651

16652

<a href="../files/base_js_BaseCore.js.html#l143"><code>base/js/BaseCore.js:143</code></a>

16653

16654

</p>

16655

16656

16657

16658

16659

</div>

16660

16661

16662

<p>Flag indicating whether or not this object

16663

has been through the init lifecycle phase.</p>

16664

</div>

16665

16666

16667

<p><strong>Default:</strong> false</p>

16668

16669

16670

16671

16672

<h4>Fires event <code>initializedChange</code></h4>

16673

16674

<p>

16675

Fires when the value for the configuration attribute <code>initialized</code> is

16676

changed. You can listen for the event using the <code>on</code> method if you

16677

wish to be notified before the attribute's value has changed, or

16678

using the <code>after</code> method if you wish to be notified after the

16679

attribute's value has changed.

16680

</p>

16681

16682

16683

<h4>Parameters:</h4>

16684

16685

16686

16687

16688

<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>

16689

16690

16691

An Event Facade object with the following

16692

attribute-specific properties added:

16693

</div>

16694

16695

16696

16697

<code class="param-name">prevVal</code>

16698

16699

<div class="param-description">The value of the attribute, prior to it being set.</div>

16700

</li>

16701

16702

<code class="param-name">newVal</code>

16703

16704

<div class="param-description">The value the attribute is to be set to.</div>

16705

</li>

16706

16707

<code class="param-name">attrName</code>

16708

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

16709

<div class="param-description">The name of the attribute being set.</div>

16710

</li>

16711

16712

<code class="param-name">subAttrName</code>

16713

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

16714

<div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div>

16715

</li>

16716

</ul>

16717

</li>

16718

</ul>

16719

</div>

16720

</div>

16721

16722

16723

16724

</div>

16725

16726

16727

16728

16729

<h3 class="name"><code>locale</code></h3>

16730

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

16731

16732

16733

<span class="flag deprecated" title="Use Y.config.lang and Y.Intl externalization support">deprecated</span>

16734

16735

16736

16737

16738

16739

16740

16741

16742

16743

16744

16745

<p>Inherited from

16746

<a href="../classes/Widget.html#attr_locale">Widget</a>:

16747

16748

16749

16750

<a href="../files/widget_js_WidgetLocale.js.html#l14"><code>widget/js/WidgetLocale.js:14</code></a>

16751

16752

</p>

16753

16754

16755

<p>Deprecated: Use Y.config.lang and Y.Intl externalization support</p>

16756

16757

16758

16759

</div>

16760

16761

16762

<p>The default locale for the widget. NOTE: Using get/set on the "strings" attribute will

16763

return/set strings for this locale.</p>

16764

</div>

16765

16766

16767

<p><strong>Default:</strong> "en"</p>

16768

16769

16770

16771

16772

<h4>Fires event <code>localeChange</code></h4>

16773

16774

<p>

16775

Fires when the value for the configuration attribute <code>locale</code> is

16776

changed. You can listen for the event using the <code>on</code> method if you

16777

wish to be notified before the attribute's value has changed, or

16778

using the <code>after</code> method if you wish to be notified after the

16779

attribute's value has changed.

16780

</p>

16781

16782

16783

<h4>Parameters:</h4>

16784

16785

16786

16787

16788

<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>

16789

16790

16791

An Event Facade object with the following

16792

attribute-specific properties added:

16793

</div>

16794

16795

16796

16797

<code class="param-name">prevVal</code>

16798

16799

<div class="param-description">The value of the attribute, prior to it being set.</div>

16800

</li>

16801

16802

<code class="param-name">newVal</code>

16803

16804

<div class="param-description">The value the attribute is to be set to.</div>

16805

</li>

16806

16807

<code class="param-name">attrName</code>

16808

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

16809

<div class="param-description">The name of the attribute being set.</div>

16810

</li>

16811

16812

<code class="param-name">subAttrName</code>

16813

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

16814

<div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div>

16815

</li>

16816

</ul>

16817

</li>

16818

</ul>

16819

</div>

16820

</div>

16821

16822

16823

16824

</div>

16825

16826

16827

16828

16829

<h3 class="name"><code>render</code></h3>

16830

<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>

16831

16832

16833

16834

16835

16836

16837

16838

16839

16840

16841

16842

16843

<p>Inherited from

16844

<a href="../classes/Widget.html#attr_render">Widget</a>:

16845

16846

16847

16848

<a href="../files/widget_js_Widget.js.html#l286"><code>widget/js/Widget.js:286</code></a>

16849

16850

</p>

16851

16852

16853

16854

16855

</div>

16856

16857

16858

<p>Whether or not to render the widget automatically after init, and optionally, to which parent node.</p>

16859

</div>

16860

16861

16862

16863

16864

16865

<h4>Fires event <code>renderChange</code></h4>

16866

16867

<p>

16868

Fires when the value for the configuration attribute <code>render</code> is

16869

changed. You can listen for the event using the <code>on</code> method if you

16870

wish to be notified before the attribute's value has changed, or

16871

using the <code>after</code> method if you wish to be notified after the

16872

attribute's value has changed.

16873

</p>

16874

16875

16876

<h4>Parameters:</h4>

16877

16878

16879

16880

16881

<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>

16882

16883

16884

An Event Facade object with the following

16885

attribute-specific properties added:

16886

</div>

16887

16888

16889

16890

<code class="param-name">prevVal</code>

16891

16892

<div class="param-description">The value of the attribute, prior to it being set.</div>

16893

</li>

16894

16895

<code class="param-name">newVal</code>

16896

16897

<div class="param-description">The value the attribute is to be set to.</div>

16898

</li>

16899

16900

<code class="param-name">attrName</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">The name of the attribute being set.</div>

16903

</li>

16904

16905

<code class="param-name">subAttrName</code>

16906

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

16907

<div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div>

16908

</li>

16909

</ul>

16910

</li>

16911

</ul>

16912

</div>

16913

</div>

16914

16915

16916

16917

</div>

16918

16919

16920

16921

16922

<h3 class="name"><code>rendered</code></h3>

16923

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>

16924

16925

16926

16927

16928

16929

16930

16931

16932

16933

16934

16935

16936

<p>Inherited from

16937

<a href="../classes/Widget.html#attr_rendered">Widget</a>:

16938

16939

16940

16941

<a href="../files/widget_js_Widget.js.html#l161"><code>widget/js/Widget.js:161</code></a>

16942

16943

</p>

16944

16945

16946

16947

16948

</div>

16949

16950

16951

<p>Flag indicating whether or not this Widget

16952

has been through the render lifecycle phase.</p>

16953

</div>

16954

16955

16956

<p><strong>Default:</strong> false</p>

16957

16958

16959

16960

16961

<h4>Fires event <code>renderedChange</code></h4>

16962

16963

<p>

16964

Fires when the value for the configuration attribute <code>rendered</code> is

16965

changed. You can listen for the event using the <code>on</code> method if you

16966

wish to be notified before the attribute's value has changed, or

16967

using the <code>after</code> method if you wish to be notified after the

16968

attribute's value has changed.

16969

</p>

16970

16971

16972

<h4>Parameters:</h4>

16973

16974

16975

16976

16977

<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>

16978

16979

16980

An Event Facade object with the following

16981

attribute-specific properties added:

16982

</div>

16983

16984

16985

16986

<code class="param-name">prevVal</code>

16987

16988

<div class="param-description">The value of the attribute, prior to it being set.</div>

16989

</li>

16990

16991

<code class="param-name">newVal</code>

16992

16993

<div class="param-description">The value the attribute is to be set to.</div>

16994

</li>

16995

16996

<code class="param-name">attrName</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">The name of the attribute being set.</div>

16999

</li>

17000

17001

<code class="param-name">subAttrName</code>

17002

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

17003

<div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div>

17004

</li>

17005

</ul>

17006

</li>

17007

</ul>

17008

</div>

17009

</div>

17010

17011

17012

17013

</div>

17014

17015

17016

17017

17018

<h3 class="name"><code>srcNode</code></h3>

17019

<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>

17020

17021

17022

17023

17024

17025

17026

17027

17028

17029

17030

17031

17032

<p>Inherited from

17033

<a href="../classes/Widget.html#attr_srcNode">Widget</a>:

17034

17035

17036

17037

<a href="../files/widget_js_WidgetHTMLParser.js.html#l59"><code>widget/js/WidgetHTMLParser.js:59</code></a>

17038

17039

</p>

17040

17041

17042

17043

17044

</div>

17045

17046

17047

<p>The DOM node to parse for configuration values, passed to the Widget's HTML_PARSER definition</p>

17048

</div>

17049

17050

17051

17052

17053

17054

<h4>Fires event <code>srcNodeChange</code></h4>

17055

17056

<p>

17057

Fires when the value for the configuration attribute <code>srcNode</code> is

17058

changed. You can listen for the event using the <code>on</code> method if you

17059

wish to be notified before the attribute's value has changed, or

17060

using the <code>after</code> method if you wish to be notified after the

17061

attribute's value has changed.

17062

</p>

17063

17064

17065

<h4>Parameters:</h4>

17066

17067

17068

17069

17070

<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>

17071

17072

17073

An Event Facade object with the following

17074

attribute-specific properties added:

17075

</div>

17076

17077

17078

17079

<code class="param-name">prevVal</code>

17080

17081

<div class="param-description">The value of the attribute, prior to it being set.</div>

17082

</li>

17083

17084

<code class="param-name">newVal</code>

17085

17086

<div class="param-description">The value the attribute is to be set to.</div>

17087

</li>

17088

17089

<code class="param-name">attrName</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">The name of the attribute being set.</div>

17092

</li>

17093

17094

<code class="param-name">subAttrName</code>

17095

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

17096

<div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div>

17097

</li>

17098

</ul>

17099

</li>

17100

</ul>

17101

</div>

17102

</div>

17103

17104

17105

17106

</div>

17107

17108

17109

17110

17111

<h3 class="name"><code>strings</code></h3>

17112

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>

17113

17114

17115

17116

17117

17118

17119

17120

17121

17122

17123

17124

17125

<p>Inherited from

17126

<a href="../classes/Widget.html#attr_strings">Widget</a>:

17127

17128

17129

17130

<a href="../files/widget_js_Widget.js.html#l274"><code>widget/js/Widget.js:274</code></a>

17131

17132

</p>

17133

17134

17135

17136

17137

</div>

17138

17139

17140

<p>Collection of strings used to label elements of the Widget's UI.</p>

17141

</div>

17142

17143

17144

<p><strong>Default:</strong> null</p>

17145

17146

17147

17148

17149

<h4>Fires event <code>stringsChange</code></h4>

17150

17151

<p>

17152

Fires when the value for the configuration attribute <code>strings</code> is

17153

changed. You can listen for the event using the <code>on</code> method if you

17154

wish to be notified before the attribute's value has changed, or

17155

using the <code>after</code> method if you wish to be notified after the

17156

attribute's value has changed.

17157

</p>

17158

17159

17160

<h4>Parameters:</h4>

17161

17162

17163

17164

17165

<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>

17166

17167

17168

An Event Facade object with the following

17169

attribute-specific properties added:

17170

</div>

17171

17172

17173

17174

<code class="param-name">prevVal</code>

17175

17176

<div class="param-description">The value of the attribute, prior to it being set.</div>

17177

</li>

17178

17179

<code class="param-name">newVal</code>

17180

17181

<div class="param-description">The value the attribute is to be set to.</div>

17182

</li>

17183

17184

<code class="param-name">attrName</code>

17185

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

17186

<div class="param-description">The name of the attribute being set.</div>

17187

</li>

17188

17189

<code class="param-name">subAttrName</code>

17190

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

17191

<div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div>

17192

</li>

17193

</ul>

17194

</li>

17195

</ul>

17196

</div>

17197

</div>

17198

17199

17200

17201

</div>

17202

17203

17204

17205

17206

<h3 class="name"><code>tabIndex</code></h3>

17207

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Number" class="crosslink external" target="_blank">Number</a></span>

17208

17209

17210

17211

17212

17213

17214

17215

17216

17217

17218

17219

17220

<p>Inherited from

17221

<a href="../classes/Widget.html#attr_tabIndex">Widget</a>:

17222

17223

17224

17225

<a href="../files/widget_js_Widget.js.html#l202"><code>widget/js/Widget.js:202</code></a>

17226

17227

</p>

17228

17229

17230

17231

17232

</div>

17233

17234

17235

<p>Number (between -32767 to 32767) indicating the widget's

17236

position in the default tab flow. The value is used to set the

17237

"tabIndex" attribute on the widget's bounding box. Negative values allow

17238

the widget to receive DOM focus programmatically (by calling the focus

17239

method), while being removed from the default tab flow. A value of

17240

null removes the "tabIndex" attribute from the widget's bounding box.</p>

17241

</div>

17242

17243

17244

<p><strong>Default:</strong> null</p>

17245

17246

17247

17248

17249

<h4>Fires event <code>tabIndexChange</code></h4>

17250

17251

<p>

17252

Fires when the value for the configuration attribute <code>tabIndex</code> is

17253

changed. You can listen for the event using the <code>on</code> method if you

17254

wish to be notified before the attribute's value has changed, or

17255

using the <code>after</code> method if you wish to be notified after the

17256

attribute's value has changed.

17257

</p>

17258

17259

17260

<h4>Parameters:</h4>

17261

17262

17263

17264

17265

<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>

17266

17267

17268

An Event Facade object with the following

17269

attribute-specific properties added:

17270

</div>

17271

17272

17273

17274

<code class="param-name">prevVal</code>

17275

17276

<div class="param-description">The value of the attribute, prior to it being set.</div>

17277

</li>

17278

17279

<code class="param-name">newVal</code>

17280

17281

<div class="param-description">The value the attribute is to be set to.</div>

17282

</li>

17283

17284

<code class="param-name">attrName</code>

17285

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

17286

<div class="param-description">The name of the attribute being set.</div>

17287

</li>

17288

17289

<code class="param-name">subAttrName</code>

17290

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

17291

<div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div>

17292

</li>

17293

</ul>

17294

</li>

17295

</ul>

17296

</div>

17297

</div>

17298

17299

17300

17301

</div>

17302

17303

17304

17305

17306

<h3 class="name"><code>visible</code></h3>

17307

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>

17308

17309

17310

17311

17312

17313

17314

17315

17316

17317

17318

17319

17320

<p>Inherited from

17321

<a href="../classes/Widget.html#attr_visible">Widget</a>:

17322

17323

17324

17325

<a href="../files/widget_js_Widget.js.html#l242"><code>widget/js/Widget.js:242</code></a>

17326

17327

</p>

17328

17329

17330

17331

17332

</div>

17333

17334

17335

<p>Boolean indicating weather or not the Widget is visible.</p>

17336

</div>

17337

17338

17339

<p><strong>Default:</strong> TRUE</p>

17340

17341

17342

17343

17344

<h4>Fires event <code>visibleChange</code></h4>

17345

17346

<p>

17347

Fires when the value for the configuration attribute <code>visible</code> is

17348

changed. You can listen for the event using the <code>on</code> method if you

17349

wish to be notified before the attribute's value has changed, or

17350

using the <code>after</code> method if you wish to be notified after the

17351

attribute's value has changed.

17352

</p>

17353

17354

17355

<h4>Parameters:</h4>

17356

17357

17358

17359

17360

<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>

17361

17362

17363

An Event Facade object with the following

17364

attribute-specific properties added:

17365

</div>

17366

17367

17368

17369

<code class="param-name">prevVal</code>

17370

17371

<div class="param-description">The value of the attribute, prior to it being set.</div>

17372

</li>

17373

17374

<code class="param-name">newVal</code>

17375

17376

<div class="param-description">The value the attribute is to be set to.</div>

17377

</li>

17378

17379

<code class="param-name">attrName</code>

17380

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

17381

<div class="param-description">The name of the attribute being set.</div>

17382

</li>

17383

17384

<code class="param-name">subAttrName</code>

17385

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

17386

<div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div>

17387

</li>

17388

</ul>

17389

</li>

17390

</ul>

17391

</div>

17392

</div>

17393

17394

17395

17396

</div>

17397

17398

17399

17400

17401

<h3 class="name"><code>width</code></h3>

17402

17403

17404

17405

17406

17407

17408

17409

17410

17411

17412

17413

17414

17415

<p>Inherited from

17416

<a href="../classes/Widget.html#attr_width">Widget</a>:

17417

17418

17419

17420

<a href="../files/widget_js_Widget.js.html#l263"><code>widget/js/Widget.js:263</code></a>

17421

17422

</p>

17423

17424

17425

17426

17427

</div>

17428

17429

17430

<p>String with units, or number, representing the width of the Widget. If a number is provided,

17431

the default unit, defined by the Widgets DEF_UNIT, property is used.</p>

17432

</div>

17433

17434

17435

<p><strong>Default:</strong> EMPTY_STR</p>

17436

17437

17438

17439

17440

<h4>Fires event <code>widthChange</code></h4>

17441

17442

<p>

17443

Fires when the value for the configuration attribute <code>width</code> is

17444

changed. You can listen for the event using the <code>on</code> method if you

17445

wish to be notified before the attribute's value has changed, or

17446

using the <code>after</code> method if you wish to be notified after the

17447

attribute's value has changed.

17448

</p>

17449

17450

17451

<h4>Parameters:</h4>

17452

17453

17454

17455

17456

<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>

17457

17458

17459

An Event Facade object with the following

17460

attribute-specific properties added:

17461

</div>

17462

17463

17464

17465

<code class="param-name">prevVal</code>

17466

17467

<div class="param-description">The value of the attribute, prior to it being set.</div>

17468

</li>

17469

17470

<code class="param-name">newVal</code>

17471

17472

<div class="param-description">The value the attribute is to be set to.</div>

17473

</li>

17474

17475

<code class="param-name">attrName</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">The name of the attribute being set.</div>

17478

</li>

17479

17480

<code class="param-name">subAttrName</code>

17481

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

17482

<div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div>

17483

</li>

17484

</ul>

17485

</li>

17486

</ul>

17487

</div>

17488

</div>

17489

17490

17491

17492

</div>

17493

17494

17495

</div>

17496

17497

17498

17499

17500

<h2 class="off-left">Events</h2>

17501

17502

17503

17504

<h3 class="name"><code>destroy</code></h3>

17505

17506

17507

17508

17509

17510

17511

17512

17513

17514

17515

17516

17517

17518

<p>Inherited from

17519

<a href="../classes/Base.html#event_destroy">Base</a>:

17520

17521

17522

17523

17524

17525

</p>

17526

17527

17528

17529

17530

</div>

17531

17532

17533

<p>

17534

Lifecycle event for the destroy phase,

17535

fired prior to destruction. Invoking the preventDefault

17536

method on the event object provided to subscribers will

17537

prevent destruction from proceeding.

17538

</p>

17539

17540

<p>

17541

Subscribers to the "after" moment of this event, will be notified

17542

after destruction is complete (and as a result cannot prevent

17543

destruction).

17544

</p>

17545

</div>

17546

17547

17548

17549

<h4>Event Payload:</h4>

17550

17551

17552

17553

17554

17555

17556

<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>

17557

17558

17559

17560

17561

17562

<p>Event object</p>

17563

</div>

17564

17565

17566

</li>

17567

17568

</ul>

17569

</div>

17570

17571

17572

17573

17574

</div>

17575

17576

17577

17578

17579

17580

17581

17582

17583

17584

17585

17586

17587

17588

17589

17590

17591

17592

<p>Inherited from

17593

<a href="../classes/Base.html#event_init">Base</a>:

17594

17595

17596

17597

17598

17599

</p>

17600

17601

17602

17603

17604

</div>

17605

17606

17607

<p>

17608

Lifecycle event for the init phase, fired prior to initialization.

17609

Invoking the preventDefault() method on the event object provided

17610

to subscribers will prevent initialization from occuring.

17611

</p>

17612

17613

<p>

17614

Subscribers to the "after" momemt of this event, will be notified

17615

after initialization of the object is complete (and therefore

17616

cannot prevent initialization).

17617

</p>

17618

</div>

17619

17620

17621

17622

<h4>Event Payload:</h4>

17623

17624

17625

17626

17627

17628

17629

<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>

17630

17631

17632

17633

17634

17635

<p>Event object, with a cfg property which

17636

refers to the configuration object passed to the constructor.</p>

17637

</div>

17638

17639

17640

</li>

17641

17642

</ul>

17643

</div>

17644

17645

17646

17647

17648

</div>

17649

17650

17651

17652

<h3 class="name"><code>widget:contentUpdate</code></h3>

17653

17654

17655

17656

17657

17658

17659

17660

17661

17662

17663

17664

17665

17666

<p>Inherited from

17667

<a href="../classes/Widget.html#event_widget:contentUpdate">Widget</a>:

17668

17669

17670

17671

<a href="../files/widget_js_Widget.js.html#l398"><code>widget/js/Widget.js:398</code></a>

17672

17673

</p>

17674

17675

17676

17677

17678

</div>

17679

17680

17681

<p>Notification event, which widget implementations can fire, when

17682

they change the content of the widget. This event has no default

17683

behavior and cannot be prevented, so the "on" or "after"

17684

moments are effectively equivalent (with on listeners being invoked before

17685

after listeners).</p>

17686

</div>

17687

17688

17689

17690

<h4>Event Payload:</h4>

17691

17692

17693

17694

17695

17696

17697

<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>

17698

17699

17700

17701

17702

17703

<p>The Event Facade</p>

17704

</div>

17705

17706

17707

</li>

17708

17709

</ul>

17710

</div>

17711

17712

17713

17714

17715

</div>

17716

17717

17718

17719

<h3 class="name"><code>widget:render</code></h3>

17720

17721

17722

17723

17724

17725

17726

17727

17728

17729

17730

17731

17732

17733

<p>Inherited from

17734

<a href="../classes/Widget.html#event_widget:render">Widget</a>:

17735

17736

17737

17738

<a href="../files/widget_js_Widget.js.html#l544"><code>widget/js/Widget.js:544</code></a>

17739

17740

</p>

17741

17742

17743

17744

17745

</div>

17746

17747

17748

<p>Lifecycle event for the render phase, fired prior to rendering the UI

17749

for the widget (prior to invoking the widget's renderer method).</p>

17750

17751

<p>

17752

Subscribers to the "on" moment of this event, will be notified

17753

before the widget is rendered.

17754

</p>

17755

17756

<p>

17757

Subscribers to the "after" moment of this event, will be notified

17758

after rendering is complete.

17759

</p>

17760

</div>

17761

17762

17763

17764

<h4>Event Payload:</h4>

17765

17766

17767

17768

17769

17770

17771

<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>

17772

17773

17774

17775

17776

17777

<p>The Event Facade</p>

17778

</div>

17779

17780

17781

</li>

17782

17783

</ul>

17784

</div>

17785

17786

17787

17788

17789

</div>

17790

17791

17792

</div>

17793

17794

</div>

17795

</div>

17796

17797

</div>

17798

</div>

17799

</div>

17800

</div>

17801

</div>

17802

</div>

17803

17804

17805

17806

17807

17808

17809

17810

17811

</body>

17812

</html>

Older »