~bcsaller/juju-gui/update-reductions

<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__aggregateAttrs">_aggregateAttrs</a>

1472

1473

1474

</li>

1475

1476

1477

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

1478

1479

1480

</li>

1481

1482

1483

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

1484

1485

1486

</li>

1487

1488

1489

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

1490

1491

1492

</li>

1493

1494

1495

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

1496

1497

1498

</li>

1499

1500

1501

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

1502

1503

1504

</li>

1505

1506

1507

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

1508

1509

1510

</li>

1511

1512

1513

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

1514

1515

1516

</li>

1517

1518

1519

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

1520

1521

1522

</li>

1523

1524

1525

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

1526

1527

1528

</li>

1529

1530

1531

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

1532

1533

1534

</li>

1535

1536

1537

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

1538

1539

1540

</li>

1541

1542

1543

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

1544

1545

1546

</li>

1547

1548

1549

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

1550

1551

1552

</li>

1553

1554

1555

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

1556

1557

1558

</li>

1559

1560

1561

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

1562

1563

1564

</li>

1565

1566

1567

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

1568

1569

1570

</li>

1571

1572

1573

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

1574

1575

1576

</li>

1577

1578

1579

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

1580

1581

1582

</li>

1583

1584

1585

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

1586

1587

1588

</li>

1589

1590

1591

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

1592

1593

1594

</li>

1595

1596

1597

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

1598

1599

1600

</li>

1601

1602

1603

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

1604

1605

1606

</li>

1607

1608

1609

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

1610

1611

1612

</li>

1613

1614

1615

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

1616

1617

1618

</li>

1619

1620

1621

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

1622

1623

1624

</li>

1625

1626

1627

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

1628

1629

1630

</li>

1631

1632

1633

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

1634

1635

1636

</li>

1637

1638

1639

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

1640

1641

1642

</li>

1643

1644

1645

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

1646

1647

1648

</li>

1649

1650

1651

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

1652

1653

1654

</li>

1655

1656

1657

1658

1659

1660

</li>

1661

1662

1663

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

1664

1665

1666

</li>

1667

1668

1669

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

1670

1671

1672

</li>

1673

1674

1675

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

1676

1677

1678

</li>

1679

1680

1681

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

1682

1683

1684

</li>

1685

1686

1687

<a href="#method__uplodEventHandler">_uplodEventHandler</a>

1688

1689

1690

</li>

1691

1692

1693

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

1694

1695

1696

</li>

1697

1698

1699

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

1700

1701

1702

</li>

1703

1704

1705

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

1706

1707

1708

</li>

1709

1710

1711

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

1712

1713

1714

</li>

1715

1716

1717

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

1718

1719

1720

</li>

1721

1722

1723

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

1724

1725

1726

</li>

1727

1728

1729

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

1730

1731

1732

</li>

1733

1734

1735

<a href="#method_cancelUpload">cancelUpload</a>

1736

1737

1738

</li>

1739

1740

1741

<a href="#method_canUpload">canUpload</a>

1742

1743

1744

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

1745

1746

</li>

1747

1748

1749

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

1750

1751

1752

</li>

1753

1754

1755

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

1756

1757

1758

</li>

1759

1760

1761

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

1762

1763

1764

</li>

1765

1766

1767

1768

1769

1770

</li>

1771

1772

1773

1774

1775

1776

</li>

1777

1778

1779

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

1780

1781

1782

</li>

1783

1784

1785

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

1786

1787

1788

</li>

1789

1790

1791

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

1792

1793

1794

</li>

1795

1796

1797

1798

1799

1800

</li>

1801

1802

1803

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

1804

1805

1806

</li>

1807

1808

1809

<a href="#method_isValidFile">isValidFile</a>

1810

1811

1812

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

1813

1814

</li>

1815

1816

1817

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

1818

1819

1820

</li>

1821

1822

1823

1824

1825

1826

</li>

1827

1828

1829

1830

1831

1832

</li>

1833

1834

1835

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

1836

1837

1838

</li>

1839

1840

1841

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

1842

1843

1844

</li>

1845

1846

1847

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

1848

1849

1850

</li>

1851

1852

1853

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

1854

1855

1856

</li>

1857

1858

1859

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

1860

1861

1862

</li>

1863

1864

1865

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

1866

1867

1868

</li>

1869

1870

1871

1872

1873

1874

</li>

1875

1876

1877

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

1878

1879

1880

</li>

1881

1882

1883

<a href="#method_startUpload">startUpload</a>

1884

1885

1886

</li>

1887

1888

1889

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

1890

1891

1892

</li>

1893

1894

1895

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

1896

1897

1898

</li>

1899

1900

1901

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

1902

1903

1904

</li>

1905

1906

1907

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

1908

1909

1910

</li>

1911

1912

</ul>

1913

</div>

1914

1915

1916

1917

1918

<h3>Properties</h3>

1919

1920

1921

1922

1923

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

1924

1925

1926

</li>

1927

1928

1929

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

1930

1931

1932

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

1933

1934

</li>

1935

1936

1937

1938

1939

1940

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

1941

1942

</li>

1943

1944

1945

1946

1947

1948

</li>

1949

1950

1951

1952

1953

1954

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

1955

1956

</li>

1957

1958

</ul>

1959

</div>

1960

1961

1962

1963

1964

<h3>Attributes</h3>

1965

1966

1967

1968

1969

<a href="#attr_boundEventHandler">boundEventHandler</a>

1970

</li>

1971

1972

1973

<a href="#attr_bytesUploaded">bytesUploaded</a>

1974

</li>

1975

1976

1977

<a href="#attr_dateCreated">dateCreated</a>

1978

</li>

1979

1980

1981

<a href="#attr_dateModified">dateModified</a>

1982

</li>

1983

1984

1985

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

1986

</li>

1987

1988

1989

1990

</li>

1991

1992

1993

1994

</li>

1995

1996

1997

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

1998

</li>

1999

2000

2001

2002

</li>

2003

2004

2005

2006

</li>

2007

2008

2009

2010

</li>

2011

2012

2013

2014

</li>

2015

2016

</ul>

2017

</div>

2018

2019

2020

2021

2022

<h3>Events</h3>

2023

2024

2025

2026

2027

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

2028

2029

2030

</li>

2031

2032

2033

2034

2035

2036

</li>

2037

2038

2039

<a href="#event_readystatechange">readystatechange</a>

2040

2041

2042

</li>

2043

2044

2045

<a href="#event_uploadcancel">uploadcancel</a>

2046

2047

2048

</li>

2049

2050

2051

<a href="#event_uploadcomplete">uploadcomplete</a>

2052

2053

2054

</li>

2055

2056

2057

<a href="#event_uploaderror">uploaderror</a>

2058

2059

2060

</li>

2061

2062

2063

<a href="#event_uploadprogress">uploadprogress</a>

2064

2065

2066

</li>

2067

2068

2069

<a href="#event_uploadstart">uploadstart</a>

2070

2071

2072

</li>

2073

2074

</ul>

2075

</div>

2076

2077

</div>

2078

2079

2080

2081

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

2082

2083

2084

2085

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

2086

2087

2088

2089

2090

2091

2092

2093

2094

2095

</li>

2096

2097

2098

2099

<code>values</code>

2100

2101

</li>

2102

2103

2104

2105

2106

2107

</li>

2108

2109

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

2110

</div>

2111

2112

2113

2114

2115

2116

2117

2118

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

2119

2120

2121

2122

2123

2124

2125

2126

2127

2128

2129

2130

<p>Inherited from

2131

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

2132

2133

2134

2135

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

2136

2137

</p>

2138

2139

2140

2141

2142

2143

</div>

2144

2145

2146

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

2147

2148

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

2149

in which an attribute's valueFn attempts to obtain the

2150

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

2151

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

2152

</div>

2153

2154

2155

2156

<h4>Parameters:</h4>

2157

2158

2159

2160

2161

2162

2163

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

2164

2165

2166

2167

2168

2169

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

2170

</div>

2171

2172

2173

</li>

2174

2175

2176

2177

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

2178

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

2179

2180

2181

2182

2183

2184

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

2185

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

2186

</div>

2187

2188

2189

</li>

2190

2191

2192

2193

2194

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

2195

2196

2197

2198

2199

2200

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

2201

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

2202

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

2203

</div>

2204

2205

2206

</li>

2207

2208

</ul>

2209

</div>

2210

2211

2212

2213

2214

2215

</div>

2216

2217

2218

2219

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

2220

2221

2222

2223

2224

2225

2226

2227

2228

2229

</li>

2230

2231

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

2232

</div>

2233

2234

2235

2236

2237

2238

2239

2240

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

2241

2242

2243

2244

2245

2246

2247

2248

2249

2250

2251

2252

<p>Inherited from

2253

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

2254

2255

2256

2257

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

2258

2259

</p>

2260

2261

2262

2263

2264

2265

</div>

2266

2267

2268

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

2269

</div>

2270

2271

2272

2273

<h4>Parameters:</h4>

2274

2275

2276

2277

2278

2279

2280

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

2281

2282

2283

2284

2285

2286

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

2287

</div>

2288

2289

2290

</li>

2291

2292

</ul>

2293

</div>

2294

2295

2296

2297

2298

2299

</div>

2300

2301

2302

2303

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

2304

2305

2306

2307

2308

2309

2310

2311

<code>allAttrs</code>

2312

2313

</li>

2314

2315

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

2316

</div>

2317

2318

2319

2320

2321

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

2322

</span>

2323

2324

2325

2326

2327

2328

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

2329

2330

2331

2332

2333

2334

2335

2336

2337

2338

2339

2340

<p>Inherited from

2341

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

2342

2343

2344

2345

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

2346

2347

</p>

2348

2349

2350

2351

2352

2353

</div>

2354

2355

2356

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

2357

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

2358

2359

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

2360

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

2361

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

2362

</div>

2363

2364

2365

2366

<h4>Parameters:</h4>

2367

2368

2369

2370

2371

2372

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

2373

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

2374

2375

2376

2377

2378

2379

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

2380

(subclass first, Base last)</p>

2381

</div>

2382

2383

2384

</li>

2385

2386

</ul>

2387

</div>

2388

2389

2390

2391

2392

<h4>Returns:</h4>

2393

2394

2395

2396

2397

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

2398

2399

The aggregate set of ATTRS definitions for the instance

2400

2401

</div>

2402

</div>

2403

2404

2405

2406

</div>

2407

2408

2409

2410

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

2411

2412

2413

2414

2415

2416

2417

2418

2419

2420

2421

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

2422

2423

2424

2425

2426

2427

2428

2429

2430

2431

2432

<p>Inherited from

2433

2434

BaseCore

2435

</a>

2436

2437

but overwritten in

2438

2439

2440

2441

2442

2443

</p>

2444

2445

2446

2447

2448

2449

</div>

2450

2451

2452

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

2453

this class.</p>

2454

</div>

2455

2456

2457

2458

2459

2460

2461

</div>

2462

2463

2464

2465

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

2466

2467

2468

2469

2470

2471

2472

2473

2474

2475

2476

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

2477

2478

2479

2480

2481

2482

2483

2484

2485

2486

2487

2488

<p>Inherited from

2489

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

2490

2491

2492

2493

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

2494

2495

</p>

2496

2497

2498

2499

2500

2501

</div>

2502

2503

2504

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

2505

</div>

2506

2507

2508

2509

2510

2511

2512

</div>

2513

2514

2515

2516

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

2517

2518

2519

2520

2521

2522

2523

2524

2525

2526

2527

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

2528

2529

2530

2531

2532

2533

2534

2535

2536

2537

2538

2539

<p>Inherited from

2540

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

2541

2542

2543

2544

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

2545

2546

</p>

2547

2548

2549

2550

2551

2552

</div>

2553

2554

2555

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

2556

</div>

2557

2558

2559

2560

2561

2562

2563

</div>

2564

2565

2566

2567

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

2568

2569

2570

2571

2572

2573

2574

2575

2576

2577

</li>

2578

2579

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

2580

</div>

2581

2582

2583

2584

2585

2586

2587

2588

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

2589

2590

2591

2592

2593

2594

2595

2596

2597

2598

2599

2600

<p>Inherited from

2601

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

2602

2603

2604

2605

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

2606

2607

</p>

2608

2609

2610

2611

2612

2613

</div>

2614

2615

2616

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

2617

</div>

2618

2619

2620

2621

<h4>Parameters:</h4>

2622

2623

2624

2625

2626

2627

2628

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

2629

2630

2631

2632

2633

2634

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

2635

</div>

2636

2637

2638

</li>

2639

2640

</ul>

2641

</div>

2642

2643

2644

2645

2646

2647

</div>

2648

2649

2650

2651

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

2652

2653

2654

2655

2656

2657

2658

2659

2660

2661

</li>

2662

2663

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

2664

</div>

2665

2666

2667

2668

2669

2670

2671

2672

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

2673

2674

2675

2676

2677

2678

2679

2680

2681

2682

2683

2684

<p>Inherited from

2685

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

2686

2687

2688

2689

2690

2691

</p>

2692

2693

2694

2695

2696

2697

</div>

2698

2699

2700

<p>Default destroy event handler</p>

2701

</div>

2702

2703

2704

2705

<h4>Parameters:</h4>

2706

2707

2708

2709

2710

2711

2712

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

2713

2714

2715

2716

2717

2718

<p>Event object</p>

2719

</div>

2720

2721

2722

</li>

2723

2724

</ul>

2725

</div>

2726

2727

2728

2729

2730

2731

</div>

2732

2733

2734

2735

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

2736

2737

2738

2739

2740

2741

2742

2743

2744

2745

</li>

2746

2747

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

2748

</div>

2749

2750

2751

2752

2753

2754

2755

2756

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

2757

2758

2759

2760

2761

2762

2763

2764

2765

2766

2767

2768

<p>Inherited from

2769

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

2770

2771

2772

2773

2774

2775

</p>

2776

2777

2778

2779

2780

2781

</div>

2782

2783

2784

<p>Default init event handler</p>

2785

</div>

2786

2787

2788

2789

<h4>Parameters:</h4>

2790

2791

2792

2793

2794

2795

2796

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

2797

2798

2799

2800

2801

2802

<p>Event object, with a cfg property which

2803

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

2804

</div>

2805

2806

2807

</li>

2808

2809

</ul>

2810

</div>

2811

2812

2813

2814

2815

2816

</div>

2817

2818

2819

2820

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

2821

2822

2823

2824

2825

2826

2827

2828

2829

2830

2831

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

2832

2833

2834

2835

2836

2837

2838

2839

2840

2841

2842

2843

<p>Inherited from

2844

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

2845

2846

2847

2848

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

2849

2850

</p>

2851

2852

2853

2854

2855

2856

</div>

2857

2858

2859

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

2860

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

2861

</div>

2862

2863

2864

2865

2866

2867

2868

</div>

2869

2870

2871

2872

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

2873

2874

2875

2876

2877

2878

2879

2880

<code>allAttrs</code>

2881

2882

</li>

2883

2884

2885

2886

<code>userVals</code>

2887

2888

</li>

2889

2890

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

2891

</div>

2892

2893

2894

2895

2896

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

2897

</span>

2898

2899

2900

2901

2902

2903

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

2904

2905

2906

2907

2908

2909

2910

2911

2912

2913

2914

2915

<p>Inherited from

2916

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

2917

2918

2919

2920

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

2921

2922

</p>

2923

2924

2925

2926

2927

2928

</div>

2929

2930

2931

2932

</div>

2933

2934

2935

2936

<h4>Parameters:</h4>

2937

2938

2939

2940

2941

2942

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

2943

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

2944

2945

2946

2947

2948

2949

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

2950

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

2951

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

2952

</div>

2953

2954

2955

</li>

2956

2957

2958

2959

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

2960

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

2961

2962

2963

2964

2965

2966

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

2967

</div>

2968

2969

2970

</li>

2971

2972

</ul>

2973

</div>

2974

2975

2976

2977

2978

<h4>Returns:</h4>

2979

2980

2981

2982

2983

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

2984

2985

The set of adhoc attributes passed in, in the form

2986

of an object with attribute name/configuration pairs.

2987

2988

</div>

2989

</div>

2990

2991

2992

2993

</div>

2994

2995

2996

2997

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

2998

2999

3000

3001

3002

3003

3004

3005

<code>clazz</code>

3006

3007

</li>

3008

3009

3010

3011

<code>allCfgs</code>

3012

3013

</li>

3014

3015

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

3016

</div>

3017

3018

3019

3020

3021

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

3022

</span>

3023

3024

3025

3026

3027

3028

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

3029

3030

3031

3032

3033

3034

3035

3036

3037

3038

3039

3040

<p>Inherited from

3041

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

3042

3043

3044

3045

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

3046

3047

</p>

3048

3049

3050

3051

3052

3053

</div>

3054

3055

3056

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

3057

initialization. Returns a disposable object with the attributes defined for

3058

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

3059

</div>

3060

3061

3062

3063

<h4>Parameters:</h4>

3064

3065

3066

3067

3068

3069

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

3070

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

3071

3072

3073

3074

3075

3076

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

3077

</div>

3078

3079

3080

</li>

3081

3082

3083

3084

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

3085

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

3086

3087

3088

3089

3090

3091

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

3092

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

3093

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

3094

</div>

3095

3096

3097

</li>

3098

3099

</ul>

3100

</div>

3101

3102

3103

3104

3105

<h4>Returns:</h4>

3106

3107

3108

3109

3110

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

3111

3112

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

3113

of an object with attribute name/configuration pairs.

3114

3115

</div>

3116

</div>

3117

3118

3119

3120

</div>

3121

3122

3123

3124

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

3125

3126

3127

3128

3129

3130

3131

3132

<code>attrName</code>

3133

3134

</li>

3135

3136

3137

3138

<code>subAttrName</code>

3139

3140

</li>

3141

3142

3143

3144

<code>currVal</code>

3145

3146

</li>

3147

3148

3149

3150

<code>newVal</code>

3151

3152

</li>

3153

3154

3155

3156

3157

3158

</li>

3159

3160

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

3161

</div>

3162

3163

3164

3165

3166

3167

3168

3169

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

3170

3171

3172

3173

3174

3175

3176

3177

3178

3179

3180

3181

<p>Inherited from

3182

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

3183

3184

3185

3186

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

3187

3188

</p>

3189

3190

3191

3192

3193

3194

</div>

3195

3196

3197

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

3198

</div>

3199

3200

3201

3202

<h4>Parameters:</h4>

3203

3204

3205

3206

3207

3208

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

3209

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

3210

3211

3212

3213

3214

3215

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

3216

</div>

3217

3218

3219

</li>

3220

3221

3222

3223

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

3224

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

3225

3226

3227

3228

3229

3230

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

3231

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

3232

</div>

3233

3234

3235

</li>

3236

3237

3238

3239

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

3240

3241

3242

3243

3244

3245

3246

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

3247

</div>

3248

3249

3250

</li>

3251

3252

3253

3254

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

3255

3256

3257

3258

3259

3260

3261

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

3262

</div>

3263

3264

3265

</li>

3266

3267

3268

3269

3270

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

3271

3272

3273

3274

3275

3276

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

3277

</div>

3278

3279

3280

</li>

3281

3282

</ul>

3283

</div>

3284

3285

3286

3287

3288

3289

</div>

3290

3291

3292

3293

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

3294

3295

3296

3297

3298

3299

3300

3301

3302

3303

</li>

3304

3305

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

3306

</div>

3307

3308

3309

3310

3311

3312

</span>

3313

3314

3315

3316

3317

3318

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

3319

3320

3321

3322

3323

3324

3325

3326

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

3327

3328

3329

3330

3331

3332

<p>Inherited from

3333

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

3334

3335

3336

3337

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

3338

3339

</p>

3340

3341

3342

3343

3344

3345

</div>

3346

3347

3348

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

3349

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

3350

3351

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

3352

</div>

3353

3354

3355

3356

<h4>Parameters:</h4>

3357

3358

3359

3360

3361

3362

3363

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

3364

3365

3366

3367

3368

3369

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

3370

</div>

3371

3372

3373

</li>

3374

3375

</ul>

3376

</div>

3377

3378

3379

3380

3381

<h4>Returns:</h4>

3382

3383

3384

3385

3386

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

3387

3388

The value of the attribute.

3389

3390

</div>

3391

</div>

3392

3393

3394

3395

</div>

3396

3397

3398

3399

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

3400

3401

3402

3403

3404

3405

3406

3407

3408

3409

</li>

3410

3411

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

3412

</div>

3413

3414

3415

3416

3417

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

3418

</span>

3419

3420

3421

3422

3423

3424

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

3425

3426

3427

3428

3429

3430

3431

3432

3433

3434

3435

3436

<p>Inherited from

3437

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

3438

3439

3440

3441

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

3442

3443

</p>

3444

3445

3446

3447

3448

3449

</div>

3450

3451

3452

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

3453

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

3454

configuration properties for all attributes.</p>

3455

</div>

3456

3457

3458

3459

<h4>Parameters:</h4>

3460

3461

3462

3463

3464

3465

3466

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

3467

3468

3469

3470

3471

3472

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

3473

</div>

3474

3475

3476

</li>

3477

3478

</ul>

3479

</div>

3480

3481

3482

3483

3484

<h4>Returns:</h4>

3485

3486

3487

3488

3489

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

3490

3491

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

3492

3493

</div>

3494

</div>

3495

3496

3497

3498

</div>

3499

3500

3501

3502

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

3503

3504

3505

3506

3507

3508

3509

3510

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

3511

</span>

3512

3513

3514

3515

3516

3517

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

3518

3519

3520

3521

3522

3523

3524

3525

3526

3527

3528

3529

<p>Inherited from

3530

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

3531

3532

3533

3534

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

3535

3536

</p>

3537

3538

3539

3540

3541

3542

</div>

3543

3544

3545

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

3546

the class hierarchy.</p>

3547

</div>

3548

3549

3550

3551

3552

3553

<h4>Returns:</h4>

3554

3555

3556

3557

3558

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

3559

3560

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

3561

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

3562

the cached value.

3563

3564

</div>

3565

</div>

3566

3567

3568

3569

</div>

3570

3571

3572

3573

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

3574

3575

3576

3577

3578

3579

3580

3581

3582

3583

</li>

3584

3585

3586

3587

3588

3589

</li>

3590

3591

3592

3593

<code>initValues</code>

3594

3595

</li>

3596

3597

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

3598

</div>

3599

3600

3601

3602

3603

3604

</span>

3605

3606

3607

3608

3609

3610

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

3611

3612

3613

3614

3615

3616

3617

3618

3619

3620

3621

<p>Inherited from

3622

3623

Attribute

3624

</a>

3625

3626

but overwritten in

3627

3628

3629

3630

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

3631

3632

</p>

3633

3634

3635

3636

3637

3638

</div>

3639

3640

3641

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

3642

either the default configuration provided, or the

3643

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

3644

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

3645

</div>

3646

3647

3648

3649

<h4>Parameters:</h4>

3650

3651

3652

3653

3654

3655

3656

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

3657

3658

3659

3660

3661

3662

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

3663

</div>

3664

3665

3666

</li>

3667

3668

3669

3670

3671

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

3672

3673

3674

3675

3676

3677

<p>The attribute configuration object</p>

3678

</div>

3679

3680

3681

</li>

3682

3683

3684

3685

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

3686

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

3687

3688

3689

3690

3691

3692

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

3693

</div>

3694

3695

3696

</li>

3697

3698

</ul>

3699

</div>

3700

3701

3702

3703

3704

<h4>Returns:</h4>

3705

3706

3707

3708

3709

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

3710

3711

The initial value of the attribute.

3712

3713

</div>

3714

</div>

3715

3716

3717

3718

</div>

3719

3720

3721

3722

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

3723

3724

3725

3726

3727

3728

3729

3730

<code>attrs</code>

3731

3732

</li>

3733

3734

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

3735

</div>

3736

3737

3738

3739

3740

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

3741

</span>

3742

3743

3744

3745

3746

3747

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

3748

3749

3750

3751

3752

3753

3754

3755

3756

3757

3758

3759

<p>Inherited from

3760

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

3761

3762

3763

3764

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

3765

3766

</p>

3767

3768

3769

3770

3771

3772

</div>

3773

3774

3775

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

3776

</div>

3777

3778

3779

3780

<h4>Parameters:</h4>

3781

3782

3783

3784

3785

3786

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

3787

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

3788

3789

3790

3791

3792

3793

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

3794

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

3795

</div>

3796

3797

3798

</li>

3799

3800

</ul>

3801

</div>

3802

3803

3804

3805

3806

<h4>Returns:</h4>

3807

3808

3809

3810

3811

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

3812

3813

An object with attribute name/value pairs.

3814

3815

</div>

3816

</div>

3817

3818

3819

3820

</div>

3821

3822

3823

3824

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

3825

3826

3827

3828

3829

3830

3831

3832

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

3833

</span>

3834

3835

3836

3837

3838

3839

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

3840

3841

3842

3843

3844

3845

3846

3847

3848

3849

3850

3851

<p>Inherited from

3852

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

3853

3854

3855

3856

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

3857

3858

</p>

3859

3860

3861

3862

3863

3864

</div>

3865

3866

3867

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

3868

</div>

3869

3870

3871

3872

3873

3874

<h4>Returns:</h4>

3875

3876

3877

3878

3879

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

3880

3881

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

3882

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

3883

cached value.

3884

3885

</div>

3886

</div>

3887

3888

3889

3890

</div>

3891

3892

3893

3894

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

3895

3896

3897

3898

3899

3900

3901

3902

3903

3904

</li>

3905

3906

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

3907

</div>

3908

3909

3910

3911

3912

3913

</span>

3914

3915

3916

3917

3918

3919

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

3920

3921

3922

3923

3924

3925

3926

3927

3928

3929

3930

3931

<p>Inherited from

3932

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

3933

3934

3935

3936

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

3937

3938

</p>

3939

3940

3941

3942

3943

3944

</div>

3945

3946

3947

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

3948

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

3949

</div>

3950

3951

3952

3953

<h4>Parameters:</h4>

3954

3955

3956

3957

3958

3959

3960

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

3961

3962

3963

3964

3965

3966

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

3967

</div>

3968

3969

3970

</li>

3971

3972

</ul>

3973

</div>

3974

3975

3976

3977

3978

<h4>Returns:</h4>

3979

3980

3981

3982

3983

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

3984

3985

The stored value of the attribute

3986

3987

</div>

3988

</div>

3989

3990

3991

3992

</div>

3993

3994

3995

3996

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

3997

3998

3999

4000

4001

4002

4003

4004

4005

4006

4007

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

4008

4009

4010

4011

4012

4013

4014

4015

4016

4017

4018

4019

<p>Inherited from

4020

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

4021

4022

4023

4024

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

4025

4026

</p>

4027

4028

4029

4030

4031

4032

</div>

4033

4034

4035

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

4036

event type is not prefixed, the instance prefix is

4037

applied to the supplied type.</p>

4038

</div>

4039

4040

4041

4042

4043

4044

4045

</div>

4046

4047

4048

4049

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

4050

4051

4052

4053

4054

4055

4056

4057

<code>attrs</code>

4058

4059

</li>

4060

4061

4062

4063

<code>values</code>

4064

4065

</li>

4066

4067

4068

4069

4070

4071

</li>

4072

4073

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

4074

</div>

4075

4076

4077

4078

4079

4080

4081

4082

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

4083

4084

4085

4086

4087

4088

4089

4090

4091

4092

4093

4094

<p>Inherited from

4095

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

4096

4097

4098

4099

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

4100

4101

</p>

4102

4103

4104

4105

4106

4107

</div>

4108

4109

4110

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

4111

constructor.</p>

4112

</div>

4113

4114

4115

4116

<h4>Parameters:</h4>

4117

4118

4119

4120

4121

4122

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

4123

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

4124

4125

4126

4127

4128

4129

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

4130

</div>

4131

4132

4133

</li>

4134

4135

4136

4137

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

4138

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

4139

4140

4141

4142

4143

4144

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

4145

</div>

4146

4147

4148

</li>

4149

4150

4151

4152

4153

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

4154

4155

4156

4157

4158

4159

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

4160

</div>

4161

4162

4163

</li>

4164

4165

</ul>

4166

</div>

4167

4168

4169

4170

4171

4172

</div>

4173

4174

4175

4176

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

4177

4178

4179

4180

4181

4182

4183

4184

4185

4186

4187

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

4188

4189

4190

4191

4192

4193

4194

4195

4196

4197

4198

<p>Inherited from

4199

4200

BaseCore

4201

</a>

4202

4203

but overwritten in

4204

4205

4206

4207

4208

4209

</p>

4210

4211

4212

4213

4214

4215

</div>

4216

4217

4218

<p>Initializes Attribute</p>

4219

</div>

4220

4221

4222

4223

4224

4225

4226

</div>

4227

4228

4229

4230

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

4231

4232

4233

4234

4235

4236

4237

4238

<code>attrs</code>

4239

4240

</li>

4241

4242

4243

4244

<code>values</code>

4245

4246

</li>

4247

4248

4249

4250

4251

4252

</li>

4253

4254

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

4255

</div>

4256

4257

4258

4259

4260

4261

4262

4263

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

4264

4265

4266

4267

4268

4269

4270

4271

4272

4273

4274

4275

<p>Inherited from

4276

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

4277

4278

4279

4280

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

4281

4282

</p>

4283

4284

4285

4286

4287

4288

</div>

4289

4290

4291

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

4292

</div>

4293

4294

4295

4296

<h4>Parameters:</h4>

4297

4298

4299

4300

4301

4302

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

4303

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

4304

4305

4306

4307

4308

4309

4310

</div>

4311

4312

4313

</li>

4314

4315

4316

4317

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

4318

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

4319

4320

4321

4322

4323

4324

4325

</div>

4326

4327

4328

</li>

4329

4330

4331

4332

4333

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

4334

4335

4336

4337

4338

4339

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

4340

</div>

4341

4342

4343

</li>

4344

4345

</ul>

4346

</div>

4347

4348

4349

4350

4351

4352

</div>

4353

4354

4355

4356

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

4357

4358

4359

4360

4361

4362

4363

4364

<code>config</code>

4365

4366

</li>

4367

4368

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

4369

</div>

4370

4371

4372

4373

4374

4375

4376

4377

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

4378

4379

4380

4381

4382

4383

4384

4385

4386

4387

4388

<p>Inherited from

4389

4390

BaseCore

4391

</a>

4392

4393

but overwritten in

4394

4395

4396

4397

4398

4399

</p>

4400

4401

4402

4403

4404

4405

</div>

4406

4407

4408

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

4409

</div>

4410

4411

4412

4413

<h4>Parameters:</h4>

4414

4415

4416

4417

4418

4419

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

4420

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

4421

4422

4423

4424

4425

4426

<p>The constructor configuration object</p>

4427

</div>

4428

4429

4430

</li>

4431

4432

</ul>

4433

</div>

4434

4435

4436

4437

4438

4439

</div>

4440

4441

4442

4443

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

4444

4445

4446

4447

4448

4449

4450

4451

<code>userVals</code>

4452

4453

</li>

4454

4455

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

4456

</div>

4457

4458

4459

4460

4461

4462

4463

4464

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

4465

4466

4467

4468

4469

4470

4471

4472

4473

4474

4475

4476

<p>Inherited from

4477

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

4478

4479

4480

4481

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

4482

4483

</p>

4484

4485

4486

4487

4488

4489

</div>

4490

4491

4492

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

4493

initializing attributes for each class defined in the class's

4494

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

4495

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

4496

</div>

4497

4498

4499

4500

<h4>Parameters:</h4>

4501

4502

4503

4504

4505

4506

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

4507

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

4508

4509

4510

4511

4512

4513

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

4514

</div>

4515

4516

4517

</li>

4518

4519

</ul>

4520

</div>

4521

4522

4523

4524

4525

4526

</div>

4527

4528

4529

4530

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

4531

4532

4533

4534

4535

4536

4537

4538

4539

4540

4541

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

4542

4543

4544

4545

4546

4547

4548

4549

4550

4551

4552

4553

<p>Inherited from

4554

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

4555

4556

4557

4558

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

4559

4560

</p>

4561

4562

4563

4564

4565

4566

</div>

4567

4568

4569

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

4570

the array of classes and aggregate set of attribute configurations

4571

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

4572

</div>

4573

4574

4575

4576

4577

4578

4579

</div>

4580

4581

4582

4583

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

4584

4585

4586

4587

4588

4589

4590

4591

4592

4593

</li>

4594

4595

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

4596

</div>

4597

4598

4599

4600

4601

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

4602

</span>

4603

4604

4605

4606

4607

4608

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

4609

4610

4611

4612

4613

4614

4615

4616

4617

4618

4619

4620

<p>Inherited from

4621

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

4622

4623

4624

4625

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

4626

4627

</p>

4628

4629

4630

4631

4632

4633

</div>

4634

4635

4636

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

4637

added lazily and still requires initialization.</p>

4638

</div>

4639

4640

4641

4642

<h4>Parameters:</h4>

4643

4644

4645

4646

4647

4648

4649

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

4650

4651

4652

4653

4654

4655

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

4656

</div>

4657

4658

4659

</li>

4660

4661

</ul>

4662

</div>

4663

4664

4665

4666

4667

<h4>Returns:</h4>

4668

4669

4670

4671

4672

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

4673

4674

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

4675

4676

</div>

4677

</div>

4678

4679

4680

4681

</div>

4682

4683

4684

4685

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

4686

4687

4688

4689

4690

4691

4692

4693

4694

4695

</li>

4696

4697

4698

4699

4700

4701

</li>

4702

4703

4704

4705

4706

4707

</li>

4708

4709

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

4710

</div>

4711

4712

4713

4714

4715

4716

4717

4718

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

4719

4720

4721

4722

4723

4724

4725

4726

4727

4728

4729

4730

<p>Inherited from

4731

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

4732

4733

4734

4735

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

4736

4737

</p>

4738

4739

4740

4741

4742

4743

</div>

4744

4745

4746

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

4747

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

4748

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

4749

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

4750

be subscribed to like other events to monitor the event

4751

system. Inividual published events can have monitoring

4752

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

4753

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

4754

</div>

4755

4756

4757

4758

<h4>Parameters:</h4>

4759

4760

4761

4762

4763

4764

4765

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

4766

4767

4768

4769

4770

4771

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

4772

</div>

4773

4774

4775

</li>

4776

4777

4778

4779

4780

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

4781

4782

4783

4784

4785

4786

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

4787

</div>

4788

4789

4790

</li>

4791

4792

4793

4794

4795

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

4796

4797

4798

4799

4800

4801

<p>Information about the event interaction, such as

4802

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

4803

</div>

4804

4805

4806

</li>

4807

4808

</ul>

4809

</div>

4810

4811

4812

4813

4814

4815

</div>

4816

4817

4818

4819

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

4820

4821

4822

4823

4824

4825

4826

4827

<code>valueHash</code>

4828

4829

</li>

4830

4831

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

4832

</div>

4833

4834

4835

4836

4837

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

4838

</span>

4839

4840

4841

4842

4843

4844

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

4845

4846

4847

4848

4849

4850

4851

4852

4853

4854

4855

<p>Inherited from

4856

4857

Attribute

4858

</a>

4859

4860

but overwritten in

4861

4862

4863

4864

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

4865

4866

</p>

4867

4868

4869

4870

4871

4872

</div>

4873

4874

4875

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

4876

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

4877

</div>

4878

4879

4880

4881

<h4>Parameters:</h4>

4882

4883

4884

4885

4886

4887

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

4888

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

4889

4890

4891

4892

4893

4894

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

4895

</div>

4896

4897

4898

</li>

4899

4900

</ul>

4901

</div>

4902

4903

4904

4905

4906

<h4>Returns:</h4>

4907

4908

4909

4910

4911

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

4912

4913

4914

</div>

4915

</div>

4916

4917

4918

4919

</div>

4920

4921

4922

4923

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

4924

4925

4926

4927

4928

4929

4930

4931

4932

4933

4934

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

4935

4936

4937

4938

4939

4940

4941

4942

4943

4944

4945

4946

<p>Inherited from

4947

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

4948

4949

4950

4951

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

4952

4953

</p>

4954

4955

4956

4957

4958

4959

</div>

4960

4961

4962

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

4963

and the prefixed event name from _getType

4964

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

4965

</div>

4966

4967

4968

4969

4970

4971

4972

</div>

4973

4974

4975

4976

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

4977

4978

4979

4980

4981

4982

4983

4984

<code>config</code>

4985

4986

</li>

4987

4988

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

4989

</div>

4990

4991

4992

4993

4994

4995

4996

4997

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

4998

4999

5000

5001

5002

5003

5004

5005

5006

5007

5008

5009

<p>Inherited from

5010

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

5011

5012

5013

5014

5015

5016

</p>

5017

5018

5019

5020

5021

5022

</div>

5023

5024

5025

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

5026

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

5027

construction, prior to init.</p>

5028

</div>

5029

5030

5031

5032

<h4>Parameters:</h4>

5033

5034

5035

5036

5037

5038

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

5039

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

5040

5041

5042

5043

5044

5045

<p>The user configuration object</p>

5046

</div>

5047

5048

5049

</li>

5050

5051

</ul>

5052

</div>

5053

5054

5055

5056

5057

5058

</div>

5059

5060

5061

5062

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

5063

5064

5065

5066

5067

5068

5069

5070

<code>attrs</code>

5071

5072

</li>

5073

5074

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

5075

</div>

5076

5077

5078

5079

5080

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

5081

</span>

5082

5083

5084

5085

5086

5087

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

5088

5089

5090

5091

5092

5093

5094

5095

5096

5097

5098

5099

<p>Inherited from

5100

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

5101

5102

5103

5104

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

5105

5106

</p>

5107

5108

5109

5110

5111

5112

</div>

5113

5114

5115

<p>Utility method to protect an attribute configuration

5116

hash, by merging the entire object and the individual

5117

attr config objects.</p>

5118

</div>

5119

5120

5121

5122

<h4>Parameters:</h4>

5123

5124

5125

5126

5127

5128

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

5129

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

5130

5131

5132

5133

5134

5135

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

5136

</div>

5137

5138

5139

</li>

5140

5141

</ul>

5142

</div>

5143

5144

5145

5146

5147

<h4>Returns:</h4>

5148

5149

5150

5151

5152

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

5153

5154

A protected version of the attrs argument.

5155

5156

</div>

5157

</div>

5158

5159

5160

5161

</div>

5162

5163

5164

5165

5166

5167

5168

5169

5170

5171

5172

5173

5174

5175

</li>

5176

5177

5178

5179

5180

5181

</li>

5182

5183

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

5184

</div>

5185

5186

5187

5188

5189

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

5190

</span>

5191

5192

5193

5194

5195

5196

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

5197

5198

5199

5200

5201

5202

5203

5204

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

5205

5206

5207

5208

5209

<p>Inherited from

5210

5211

AttributeEvents

5212

</a>

5213

5214

but overwritten in

5215

5216

5217

5218

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

5219

5220

</p>

5221

5222

5223

5224

5225

5226

</div>

5227

5228

5229

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

5230

</div>

5231

5232

5233

5234

<h4>Parameters:</h4>

5235

5236

5237

5238

5239

5240

5241

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

5242

5243

5244

5245

5246

5247

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

5248

</div>

5249

5250

5251

</li>

5252

5253

5254

5255

5256

5257

5258

5259

5260

5261

5262

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

5263

</div>

5264

5265

5266

</li>

5267

5268

</ul>

5269

</div>

5270

5271

5272

5273

5274

<h4>Returns:</h4>

5275

5276

5277

5278

5279

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

5280

5281

A reference to the host object.

5282

5283

</div>

5284

</div>

5285

5286

5287

5288

</div>

5289

5290

5291

5292

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

5293

5294

5295

5296

5297

5298

5299

5300

5301

5302

</li>

5303

5304

5305

5306

<code>value</code>

5307

5308

</li>

5309

5310

5311

5312

5313

5314

</li>

5315

5316

5317

5318

<code>force</code>

5319

5320

</li>

5321

5322

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

5323

</div>

5324

5325

5326

5327

5328

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

5329

</span>

5330

5331

5332

5333

5334

5335

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

5336

5337

5338

5339

5340

5341

5342

5343

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

5344

5345

5346

5347

5348

5349

<p>Inherited from

5350

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

5351

5352

5353

5354

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

5355

5356

</p>

5357

5358

5359

5360

5361

5362

</div>

5363

5364

5365

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

5366

5367

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

5368

</div>

5369

5370

5371

5372

<h4>Parameters:</h4>

5373

5374

5375

5376

5377

5378

5379

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

5380

5381

5382

5383

5384

5385

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

5386

</div>

5387

5388

5389

</li>

5390

5391

5392

5393

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

5394

5395

5396

5397

5398

5399

5400

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

5401

</div>

5402

5403

5404

</li>

5405

5406

5407

5408

5409

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

5410

5411

5412

5413

5414

5415

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

5416

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

5417

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

5418

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

5419

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

5420

</div>

5421

5422

5423

</li>

5424

5425

5426

5427

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

5428

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

5429

5430

5431

5432

5433

5434

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

5435

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

5436

</div>

5437

5438

5439

</li>

5440

5441

</ul>

5442

</div>

5443

5444

5445

5446

5447

<h4>Returns:</h4>

5448

5449

5450

5451

5452

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

5453

5454

A reference to the host object.

5455

5456

</div>

5457

</div>

5458

5459

5460

5461

</div>

5462

5463

5464

5465

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

5466

5467

5468

5469

5470

5471

5472

5473

<code>attrs</code>

5474

5475

</li>

5476

5477

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

5478

</div>

5479

5480

5481

5482

5483

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

5484

</span>

5485

5486

5487

5488

5489

5490

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

5491

5492

5493

5494

5495

5496

5497

5498

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

5499

5500

5501

5502

5503

5504

<p>Inherited from

5505

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

5506

5507

5508

5509

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

5510

5511

</p>

5512

5513

5514

5515

5516

5517

</div>

5518

5519

5520

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

5521

</div>

5522

5523

5524

5525

<h4>Parameters:</h4>

5526

5527

5528

5529

5530

5531

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

5532

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

5533

5534

5535

5536

5537

5538

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

5539

</div>

5540

5541

5542

</li>

5543

5544

</ul>

5545

</div>

5546

5547

5548

5549

5550

<h4>Returns:</h4>

5551

5552

5553

5554

5555

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

5556

5557

A reference to the host object.

5558

5559

</div>

5560

</div>

5561

5562

5563

5564

</div>

5565

5566

5567

5568

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

5569

5570

5571

5572

5573

5574

5575

5576

<code>attrName</code>

5577

5578

</li>

5579

5580

5581

5582

<code>subAttrName</code>

5583

5584

</li>

5585

5586

5587

5588

<code>prevVal</code>

5589

5590

</li>

5591

5592

5593

5594

<code>newVal</code>

5595

5596

</li>

5597

5598

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

5599

</div>

5600

5601

5602

5603

5604

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

5605

</span>

5606

5607

5608

5609

5610

5611

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

5612

5613

5614

5615

5616

5617

5618

5619

5620

5621

5622

5623

<p>Inherited from

5624

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

5625

5626

5627

5628

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

5629

5630

</p>

5631

5632

5633

5634

5635

5636

</div>

5637

5638

5639

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

5640

if validation and setter passes.</p>

5641

</div>

5642

5643

5644

5645

<h4>Parameters:</h4>

5646

5647

5648

5649

5650

5651

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

5652

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

5653

5654

5655

5656

5657

5658

<p>The attribute name.</p>

5659

</div>

5660

5661

5662

</li>

5663

5664

5665

5666

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

5667

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

5668

5669

5670

5671

5672

5673

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

5674

</div>

5675

5676

5677

</li>

5678

5679

5680

5681

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

5682

5683

5684

5685

5686

5687

5688

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

5689

</div>

5690

5691

5692

</li>

5693

5694

5695

5696

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

5697

5698

5699

5700

5701

5702

5703

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

5704

</div>

5705

5706

5707

</li>

5708

5709

</ul>

5710

</div>

5711

5712

5713

5714

5715

<h4>Returns:</h4>

5716

5717

5718

5719

5720

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

5721

5722

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

5723

5724

</div>

5725

</div>

5726

5727

5728

5729

</div>

5730

5731

5732

5733

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

5734

5735

5736

5737

5738

5739

5740

5741

5742

5743

</li>

5744

5745

5746

5747

<code>value</code>

5748

5749

</li>

5750

5751

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

5752

</div>

5753

5754

5755

5756

5757

5758

5759

5760

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

5761

5762

5763

5764

5765

5766

5767

5768

5769

5770

5771

5772

<p>Inherited from

5773

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

5774

5775

5776

5777

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

5778

5779

</p>

5780

5781

5782

5783

5784

5785

</div>

5786

5787

5788

<p>Sets the stored value for the attribute, in either the

5789

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

5790

</div>

5791

5792

5793

5794

<h4>Parameters:</h4>

5795

5796

5797

5798

5799

5800

5801

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

5802

5803

5804

5805

5806

5807

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

5808

</div>

5809

5810

5811

</li>

5812

5813

5814

5815

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

5816

5817

5818

5819

5820

5821

5822

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

5823

</div>

5824

5825

5826

</li>

5827

5828

</ul>

5829

</div>

5830

5831

5832

5833

5834

5835

</div>

5836

5837

5838

5839

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

5840

5841

5842

5843

5844

5845

5846

5847

<code>event</code>

5848

5849

</li>

5850

5851

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

5852

</div>

5853

5854

5855

5856

5857

5858

5859

5860

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

5861

5862

5863

5864

5865

5866

5867

5868

5869

5870

5871

5872

5873

<p>

5874

5875

Defined in

5876

5877

5878

5879

5880

5881

5882

</p>

5883

5884

5885

5886

5887

5888

</div>

5889

5890

5891

<p>Handler of events dispatched by the XMLHTTPRequest.</p>

5892

</div>

5893

5894

5895

5896

<h4>Parameters:</h4>

5897

5898

5899

5900

5901

5902

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

5903

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

5904

5905

5906

5907

5908

5909

<p>The event object received from the XMLHTTPRequest.</p>

5910

</div>

5911

5912

5913

</li>

5914

5915

</ul>

5916

</div>

5917

5918

5919

5920

5921

5922

</div>

5923

5924

5925

5926

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

5927

5928

5929

5930

5931

5932

5933

5934

5935

5936

</li>

5937

5938

5939

5940

<code>config</code>

5941

5942

</li>

5943

5944

5945

5946

5947

5948

</li>

5949

5950

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

5951

</div>

5952

5953

5954

5955

5956

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

5957

</span>

5958

5959

5960

5961

5962

5963

5964

5965

5966

5967

5968

5969

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

5970

5971

5972

5973

5974

5975

<p>Inherited from

5976

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

5977

5978

5979

5980

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

5981

5982

</p>

5983

5984

5985

5986

5987

5988

</div>

5989

5990

5991

<p>

5992

Adds an attribute with the provided configuration to the host object.

5993

</p>

5994

5995

<p>

5996

The config argument object supports the following properties:

5997

</p>

5998

5999

<dl>

6000

<dt>value <Any></dt>

6001

<dd>The initial value to set on the attribute</dd>

6002

6003

<dt>valueFn <Function | String></dt>

6004

<dd>

6005

<p>A function, which will return the initial value to set on the attribute. This is useful

6006

for cases where the attribute configuration is defined statically, but needs to

6007

reference the host instance ("this") to obtain an initial value. If both the value and valueFn properties are defined,

6008

the value returned by the valueFn has precedence over the value property, unless it returns undefined, in which

6009

case the value property is used.</p>

6010

6011

<p>valueFn can also be set to a string, representing the name of the instance method to be used to retrieve the value.</p>

6012

</dd>

6013

6014

<dt>readOnly <boolean></dt>

6015

<dd>Whether or not the attribute is read only. Attributes having readOnly set to true

6016

cannot be modified by invoking the set method.</dd>

6017

6018

<dt>writeOnce <boolean> or <string></dt>

6019

<dd>

6020

Whether or not the attribute is "write once". Attributes having writeOnce set to true,

6021

can only have their values set once, be it through the default configuration,

6022

constructor configuration arguments, or by invoking set.

6023

<p>The writeOnce attribute can also be set to the string "initOnly", in which case the attribute can only be set during initialization

6024

(when used with Base, this means it can only be set during construction)</p>

6025

</dd>

6026

6027

<dt>setter <Function | String></dt>

6028

<dd>

6029

<p>The setter function used to massage or normalize the value passed to the set method for the attribute.

6030

The value returned by the setter will be the final stored value. Returning

6031

<a href="#property_Attribute.INVALID_VALUE">Attribute.INVALID_VALUE</a>, from the setter will prevent

6032

the value from being stored.

6033

</p>

6034

6035

<p>setter can also be set to a string, representing the name of the instance method to be used as the setter function.</p>

6036

</dd>

6037

6038

<dt>getter <Function | String></dt>

6039

<dd>

6040

<p>

6041

The getter function used to massage or normalize the value returned by the get method for the attribute.

6042

The value returned by the getter function is the value which will be returned to the user when they

6043

invoke get.

6044

</p>

6045

6046

<p>getter can also be set to a string, representing the name of the instance method to be used as the getter function.</p>

6047

</dd>

6048

6049

<dt>validator <Function | String></dt>

6050

<dd>

6051

<p>

6052

The validator function invoked prior to setting the stored value. Returning

6053

false from the validator function will prevent the value from being stored.

6054

</p>

6055

6056

<p>validator can also be set to a string, representing the name of the instance method to be used as the validator function.</p>

6057

</dd>

6058

6059

<dt>lazyAdd <boolean></dt>

6060

<dd>Whether or not to delay initialization of the attribute until the first call to get/set it.

6061

This flag can be used to over-ride lazy initialization on a per attribute basis, when adding multiple attributes through

6062

the <a href="#method_addAttrs">addAttrs</a> method.</dd>

6063

6064

</dl>

6065

6066

<p>The setter, getter and validator are invoked with the value and name passed in as the first and second arguments, and with

6067

the context ("this") set to the host object.</p>

6068

6069

<p>Configuration properties outside of the list mentioned above are considered private properties used internally by attribute,

6070

and are not intended for public use.</p>

6071

</div>

6072

6073

6074

6075

<h4>Parameters:</h4>

6076

6077

6078

6079

6080

6081

6082

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

6083

6084

6085

6086

6087

6088

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

6089

</div>

6090

6091

6092

</li>

6093

6094

6095

6096

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

6097

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

6098

6099

6100

6101

6102

6103

<p>An object with attribute configuration property/value pairs, specifying the configuration for the attribute.</p>

6104

6105

<p>

6106

<strong>NOTE:</strong> The configuration object is modified when adding an attribute, so if you need

6107

to protect the original values, you will need to merge the object.

6108

</p>

6109

</div>

6110

6111

6112

</li>

6113

6114

6115

6116

6117

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

6118

6119

6120

6121

6122

6123

<p>(optional) Whether or not to add this attribute lazily (on the first call to get/set).</p>

6124

</div>

6125

6126

6127

</li>

6128

6129

</ul>

6130

</div>

6131

6132

6133

6134

6135

<h4>Returns:</h4>

6136

6137

6138

6139

6140

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

6141

6142

A reference to the host object.

6143

6144

</div>

6145

</div>

6146

6147

6148

6149

</div>

6150

6151

6152

6153

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

6154

6155

6156

6157

6158

6159

6160

6161

6162

6163

</li>

6164

6165

6166

6167

<code>values</code>

6168

6169

</li>

6170

6171

6172

6173

6174

6175

</li>

6176

6177

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

6178

</div>

6179

6180

6181

6182

6183

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

6184

</span>

6185

6186

6187

6188

6189

6190

6191

6192

6193

6194

6195

6196

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

6197

6198

6199

6200

6201

6202

<p>Inherited from

6203

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

6204

6205

6206

6207

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

6208

6209

</p>

6210

6211

6212

6213

6214

6215

</div>

6216

6217

6218

<p>Configures a group of attributes, and sets initial values.</p>

6219

6220

<p>

6221

<strong>NOTE:</strong> This method does not isolate the configuration object by merging/cloning.

6222

The caller is responsible for merging/cloning the configuration object if required.

6223

</p>

6224

</div>

6225

6226

6227

6228

<h4>Parameters:</h4>

6229

6230

6231

6232

6233

6234

6235

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

6236

6237

6238

6239

6240

6241

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

6242

</div>

6243

6244

6245

</li>

6246

6247

6248

6249

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

6250

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

6251

6252

6253

6254

6255

6256

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

6257

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

6258

</div>

6259

6260

6261

</li>

6262

6263

6264

6265

6266

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

6267

6268

6269

6270

6271

6272

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

6273

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

6274

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

6275

</div>

6276

6277

6278

</li>

6279

6280

</ul>

6281

</div>

6282

6283

6284

6285

6286

<h4>Returns:</h4>

6287

6288

6289

6290

6291

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

6292

6293

A reference to the host object.

6294

6295

</div>

6296

</div>

6297

6298

6299

6300

</div>

6301

6302

6303

6304

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

6305

6306

6307

6308

6309

6310

6311

6312

6313

6314

</li>

6315

6316

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

6317

</div>

6318

6319

6320

6321

6322

6323

6324

6325

6326

6327

6328

6329

6330

6331

6332

6333

6334

6335

<p>Inherited from

6336

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

6337

6338

6339

6340

<a href="../files/event-custom_js_event-facade.js.html#l382"><code>event-custom/js/event-facade.js:382</code></a>

6341

6342

</p>

6343

6344

6345

6346

6347

6348

</div>

6349

6350

6351

<p>Registers another EventTarget as a bubble target. Bubble order

6352

is determined by the order registered. Multiple targets can

6353

be specified.</p>

6354

6355

<p>Events can only bubble if emitFacade is true.</p>

6356

6357

<p>Included in the event-custom-complex submodule.</p>

6358

</div>

6359

6360

6361

6362

<h4>Parameters:</h4>

6363

6364

6365

6366

6367

6368

6369

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

6370

6371

6372

6373

6374

6375

<p>the target to add</p>

6376

</div>

6377

6378

6379

</li>

6380

6381

</ul>

6382

</div>

6383

6384

6385

6386

6387

6388

</div>

6389

6390

6391

6392

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

6393

6394

6395

6396

6397

6398

6399

6400

6401

6402

</li>

6403

6404

6405

6406

6407

6408

</li>

6409

6410

6411

6412

<code class="optional">[context]</code>

6413

6414

</li>

6415

6416

6417

6418

6419

6420

</li>

6421

6422

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

6423

</div>

6424

6425

6426

6427

6428

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

6429

</span>

6430

6431

6432

6433

6434

6435

6436

6437

6438

6439

6440

6441

6442

6443

6444

6445

<p>Inherited from

6446

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

6447

6448

6449

6450

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

6451

6452

</p>

6453

6454

6455

6456

6457

6458

</div>

6459

6460

6461

<p>Subscribe to a custom event hosted by this object. The

6462

supplied callback will execute after any listeners add

6463

via the subscribe method, and after the default function,

6464

if configured for the event, has executed.</p>

6465

</div>

6466

6467

6468

6469

<h4>Parameters:</h4>

6470

6471

6472

6473

6474

6475

6476

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

6477

6478

6479

6480

6481

6482

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

6483

</div>

6484

6485

6486

</li>

6487

6488

6489

6490

6491

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

6492

6493

6494

6495

6496

6497

<p>The callback to execute in response to the event</p>

6498

</div>

6499

6500

6501

</li>

6502

6503

6504

6505

<code class="param-name optional">[context]</code>

6506

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

6507

<span class="flag optional" title="This parameter is optional.">optional</span>

6508

6509

6510

6511

6512

6513

<p>Override <code>this</code> object in callback</p>

6514

</div>

6515

6516

6517

</li>

6518

6519

6520

6521

6522

6523

<span class="flag optional" title="This parameter is optional.">optional</span>

6524

6525

6526

6527

6528

6529

<p>0..n additional arguments to supply to the subscriber</p>

6530

</div>

6531

6532

6533

</li>

6534

6535

</ul>

6536

</div>

6537

6538

6539

6540

6541

<h4>Returns:</h4>

6542

6543

6544

6545

6546

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

6547

6548

A subscription handle capable of detaching the

6549

subscription

6550

6551

</div>

6552

</div>

6553

6554

6555

6556

</div>

6557

6558

6559

6560

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

6561

6562

6563

6564

6565

6566

6567

6568

6569

6570

</li>

6571

6572

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

6573

</div>

6574

6575

6576

6577

6578

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

6579

</span>

6580

6581

6582

6583

6584

6585

6586

6587

6588

6589

6590

6591

6592

6593

6594

6595

<p>Inherited from

6596

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

6597

6598

6599

6600

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

6601

6602

</p>

6603

6604

6605

6606

6607

6608

</div>

6609

6610

6611

<p>Checks if the given attribute has been added to the host</p>

6612

</div>

6613

6614

6615

6616

<h4>Parameters:</h4>

6617

6618

6619

6620

6621

6622

6623

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

6624

6625

6626

6627

6628

6629

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

6630

</div>

6631

6632

6633

</li>

6634

6635

</ul>

6636

</div>

6637

6638

6639

6640

6641

<h4>Returns:</h4>

6642

6643

6644

6645

6646

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

6647

6648

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.

6649

6650

</div>

6651

</div>

6652

6653

6654

6655

</div>

6656

6657

6658

6659

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

6660

6661

6662

6663

6664

6665

6666

6667

6668

</span>

6669

6670

6671

6672

6673

6674

6675

6676

6677

6678

6679

6680

6681

6682

6683

6684

<p>Inherited from

6685

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

6686

6687

6688

6689

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

6690

6691

</p>

6692

6693

6694

6695

6696

6697

</div>

6698

6699

6700

<p>Executes the callback before a DOM event, custom event

6701

or method. If the first argument is a function, it

6702

is assumed the target is a method. For DOM and custom

6703

events, this is an alias for Y.on.</p>

6704

6705

<p>For DOM and custom events:

6706

type, callback, context, 0-n arguments</p>

6707

6708

<p>For methods:

6709

callback, object (method host), methodName, context, 0-n arguments</p>

6710

</div>

6711

6712

6713

6714

6715

6716

<h4>Returns:</h4>

6717

6718

6719

6720

6721

detach handle

6722

6723

</div>

6724

</div>

6725

6726

6727

6728

</div>

6729

6730

6731

6732

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

6733

6734

6735

6736

6737

6738

6739

6740

6741

6742

</li>

6743

6744

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

6745

</div>

6746

6747

6748

6749

6750

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

6751

</span>

6752

6753

6754

6755

6756

6757

6758

6759

6760

6761

6762

6763

6764

6765

6766

6767

<p>Inherited from

6768

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

6769

6770

6771

6772

<a href="../files/event-custom_js_event-facade.js.html#l419"><code>event-custom/js/event-facade.js:419</code></a>

6773

6774

</p>

6775

6776

6777

6778

6779

6780

</div>

6781

6782

6783

<p>Propagate an event. Requires the event-custom-complex module.</p>

6784

</div>

6785

6786

6787

6788

<h4>Parameters:</h4>

6789

6790

6791

6792

6793

6794

6795

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

6796

6797

6798

6799

6800

6801

<p>the custom event to propagate</p>

6802

</div>

6803

6804

6805

</li>

6806

6807

</ul>

6808

</div>

6809

6810

6811

6812

6813

<h4>Returns:</h4>

6814

6815

6816

6817

6818

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

6819

6820

the aggregated return value from Event.Custom.fire

6821

6822

</div>

6823

</div>

6824

6825

6826

6827

</div>

6828

6829

6830

6831

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

6832

6833

6834

6835

6836

6837

6838

6839

6840

6841

6842

6843

6844

6845

6846

6847

6848

6849

6850

6851

6852

6853

<p>

6854

6855

Defined in

6856

6857

6858

6859

6860

6861

6862

</p>

6863

6864

6865

6866

6867

6868

</div>

6869

6870

6871

<p>Cancels the upload of a specific file, if currently in progress.</p>

6872

</div>

6873

6874

6875

6876

6877

6878

6879

</div>

6880

6881

6882

6883

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

6884

6885

6886

6887

6888

6889

6890

6891

6892

6893

6894

6895

6896

6897

6898

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

6899

6900

6901

6902

6903

6904

6905

6906

6907

<p>

6908

6909

Defined in

6910

6911

6912

6913

6914

6915

6916

</p>

6917

6918

6919

6920

6921

6922

</div>

6923

6924

6925

<p>Checks whether the browser has a native upload capability

6926

via XMLHttpRequest Level 2.</p>

6927

</div>

6928

6929

6930

6931

6932

6933

6934

</div>

6935

6936

6937

6938

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

6939

6940

6941

6942

6943

6944

6945

6946

6947

</span>

6948

6949

6950

6951

6952

6953

6954

6955

6956

6957

6958

6959

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

6960

6961

6962

6963

6964

<p>Inherited from

6965

6966

BaseCore

6967

</a>

6968

6969

but overwritten in

6970

6971

6972

6973

6974

6975

</p>

6976

6977

6978

6979

6980

6981

</div>

6982

6983

6984

<p>

6985

Destroy lifecycle method. Fires the destroy

6986

event, prior to invoking destructors for the

6987

class hierarchy.

6988

</p>

6989

6990

<p>

6991

Subscribers to the destroy

6992

event can invoke preventDefault on the event object, to prevent destruction

6993

from proceeding.

6994

</p>

6995

</div>

6996

6997

6998

6999

7000

7001

<h4>Returns:</h4>

7002

7003

7004

7005

7006

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

7007

7008

A reference to this object

7009

7010

</div>

7011

</div>

7012

7013

7014

7015

</div>

7016

7017

7018

7019

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

7020

7021

7022

7023

7024

7025

7026

7027

7028

7029

</li>

7030

7031

7032

7033

7034

7035

</li>

7036

7037

7038

7039

<code>context</code>

7040

7041

</li>

7042

7043

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

7044

</div>

7045

7046

7047

7048

7049

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

7050

</span>

7051

7052

7053

7054

7055

7056

7057

7058

7059

7060

7061

7062

7063

7064

7065

7066

<p>Inherited from

7067

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

7068

7069

7070

7071

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

7072

7073

</p>

7074

7075

7076

7077

7078

7079

</div>

7080

7081

7082

<p>Detach one or more listeners the from the specified event</p>

7083

</div>

7084

7085

7086

7087

<h4>Parameters:</h4>

7088

7089

7090

7091

7092

7093

7094

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

7095

7096

7097

7098

7099

7100

<p>Either the handle to the subscriber or the

7101

type of event. If the type

7102

is not specified, it will attempt to remove

7103

the listener from all hosted events.</p>

7104

</div>

7105

7106

7107

</li>

7108

7109

7110

7111

7112

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

7113

7114

7115

7116

7117

7118

<p>The subscribed function to unsubscribe, if not

7119

supplied, all subscribers will be removed.</p>

7120

</div>

7121

7122

7123

</li>

7124

7125

7126

7127

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

7128

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

7129

7130

7131

7132

7133

7134

<p>The custom object passed to subscribe. This is

7135

optional, but if supplied will be used to

7136

disambiguate multiple listeners that are the same

7137

(e.g., you subscribe many object using a function

7138

that lives on the prototype)</p>

7139

</div>

7140

7141

7142

</li>

7143

7144

</ul>

7145

</div>

7146

7147

7148

7149

7150

<h4>Returns:</h4>

7151

7152

7153

7154

7155

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

7156

7157

the host

7158

7159

</div>

7160

</div>

7161

7162

7163

7164

</div>

7165

7166

7167

7168

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

7169

7170

7171

7172

7173

7174

7175

7176

7177

7178

</li>

7179

7180

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

7181

</div>

7182

7183

7184

7185

7186

7187

7188

7189

7190

7191

7192

7193

7194

7195

7196

7197

7198

7199

<p>Inherited from

7200

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

7201

7202

7203

7204

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

7205

7206

</p>

7207

7208

7209

7210

7211

7212

</div>

7213

7214

7215

<p>Removes all listeners from the specified event. If the event type

7216

is not specified, all listeners from all hosted custom events will

7217

be removed.</p>

7218

</div>

7219

7220

7221

7222

<h4>Parameters:</h4>

7223

7224

7225

7226

7227

7228

7229

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

7230

7231

7232

7233

7234

7235

<p>The type, or name of the event</p>

7236

</div>

7237

7238

7239

</li>

7240

7241

</ul>

7242

</div>

7243

7244

7245

7246

7247

7248

</div>

7249

7250

7251

7252

7253

7254

7255

7256

7257

7258

7259

7260

7261

7262

</li>

7263

7264

7265

7266

<code>arguments</code>

7267

7268

</li>

7269

7270

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

7271

</div>

7272

7273

7274

7275

7276

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

7277

</span>

7278

7279

7280

7281

7282

7283

7284

7285

7286

7287

7288

7289

7290

7291

7292

7293

<p>Inherited from

7294

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

7295

7296

7297

7298

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

7299

7300

</p>

7301

7302

7303

7304

7305

7306

</div>

7307

7308

7309

<p>Fire a custom event by name. The callback functions will be executed

7310

from the context specified when the event was created, and with the

7311

following parameters.</p>

7312

7313

<p>If the custom event object hasn't been created, then the event hasn't

7314

been published and it has no subscribers. For performance sake, we

7315

immediate exit in this case. This means the event won't bubble, so

7316

if the intention is that a bubble target be notified, the event must

7317

be published on this object first.</p>

7318

7319

<p>The first argument is the event type, and any additional arguments are

7320

passed to the listeners as parameters. If the first of these is an

7321

object literal, and the event is configured to emit an event facade,

7322

that object is mixed into the event facade and the facade is provided

7323

in place of the original object.</p>

7324

</div>

7325

7326

7327

7328

<h4>Parameters:</h4>

7329

7330

7331

7332

7333

7334

7335

7336

7337

7338

7339

7340

7341

<p>The type of the event, or an object that contains

7342

a 'type' property.</p>

7343

</div>

7344

7345

7346

</li>

7347

7348

7349

7350

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

7351

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

7352

7353

7354

7355

7356

7357

<p>an arbitrary set of parameters to pass to

7358

the handler. If the first of these is an object literal and the event is

7359

configured to emit an event facade, the event facade will replace that

7360

parameter after the properties the object literal contains are copied to

7361

the event facade.</p>

7362

</div>

7363

7364

7365

</li>

7366

7367

</ul>

7368

</div>

7369

7370

7371

7372

7373

<h4>Returns:</h4>

7374

7375

7376

7377

7378

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

7379

7380

the event host

7381

7382

</div>

7383

</div>

7384

7385

7386

7387

</div>

7388

7389

7390

7391

7392

7393

7394

7395

7396

7397

7398

7399

7400

7401

</li>

7402

7403

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

7404

</div>

7405

7406

7407

7408

7409

7410

</span>

7411

7412

7413

7414

7415

7416

7417

7418

7419

7420

7421

7422

7423

7424

7425

7426

<p>Inherited from

7427

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

7428

7429

7430

7431

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

7432

7433

</p>

7434

7435

7436

7437

7438

7439

</div>

7440

7441

7442

<p>Returns the current value of the attribute. If the attribute

7443

has been configured with a 'getter' function, this method will delegate

7444

to the 'getter' to obtain the value of the attribute.</p>

7445

</div>

7446

7447

7448

7449

<h4>Parameters:</h4>

7450

7451

7452

7453

7454

7455

7456

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

7457

7458

7459

7460

7461

7462

<p>The name of the attribute. If the value of the attribute is an Object,

7463

dot notation can be used to obtain the value of a property of the object (e.g. <code>get("x.y.z")</code>)</p>

7464

</div>

7465

7466

7467

</li>

7468

7469

</ul>

7470

</div>

7471

7472

7473

7474

7475

<h4>Returns:</h4>

7476

7477

7478

7479

7480

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

7481

7482

The value of the attribute

7483

7484

</div>

7485

</div>

7486

7487

7488

7489

</div>

7490

7491

7492

7493

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

7494

7495

7496

7497

7498

7499

7500

7501

<code>attrs</code>

7502

7503

</li>

7504

7505

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

7506

</div>

7507

7508

7509

7510

7511

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

7512

</span>

7513

7514

7515

7516

7517

7518

7519

7520

7521

7522

7523

7524

7525

7526

7527

7528

<p>Inherited from

7529

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

7530

7531

7532

7533

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

7534

7535

</p>

7536

7537

7538

7539

7540

7541

</div>

7542

7543

7544

<p>Gets multiple attribute values.</p>

7545

</div>

7546

7547

7548

7549

<h4>Parameters:</h4>

7550

7551

7552

7553

7554

7555

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

7556

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

7557

7558

7559

7560

7561

7562

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

7563

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

7564

</div>

7565

7566

7567

</li>

7568

7569

</ul>

7570

</div>

7571

7572

7573

7574

7575

<h4>Returns:</h4>

7576

7577

7578

7579

7580

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

7581

7582

An object with attribute name/value pairs.

7583

7584

</div>

7585

</div>

7586

7587

7588

7589

</div>

7590

7591

7592

7593

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

7594

7595

7596

7597

7598

7599

7600

7601

7602

7603

</li>

7604

7605

7606

7607

<code>prefixed</code>

7608

7609

</li>

7610

7611

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

7612

</div>

7613

7614

7615

7616

7617

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

7618

</span>

7619

7620

7621

7622

7623

7624

7625

7626

7627

7628

7629

7630

7631

7632

7633

7634

<p>Inherited from

7635

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

7636

7637

7638

7639

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

7640

7641

</p>

7642

7643

7644

7645

7646

7647

</div>

7648

7649

7650

<p>Returns the custom event of the provided type has been created, a

7651

falsy value otherwise</p>

7652

</div>

7653

7654

7655

7656

<h4>Parameters:</h4>

7657

7658

7659

7660

7661

7662

7663

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

7664

7665

7666

7667

7668

7669

<p>the type, or name of the event</p>

7670

</div>

7671

7672

7673

</li>

7674

7675

7676

7677

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

7678

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

7679

7680

7681

7682

7683

7684

<p>if true, the type is prefixed already</p>

7685

</div>

7686

7687

7688

</li>

7689

7690

</ul>

7691

</div>

7692

7693

7694

7695

7696

<h4>Returns:</h4>

7697

7698

7699

7700

7701

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

7702

7703

the custom event or null

7704

7705

</div>

7706

</div>

7707

7708

7709

7710

</div>

7711

7712

7713

7714

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

7715

7716

7717

7718

7719

7720

7721

7722

7723

</span>

7724

7725

7726

7727

7728

7729

7730

7731

7732

7733

7734

7735

7736

7737

7738

7739

<p>Inherited from

7740

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

7741

7742

7743

7744

<a href="../files/event-custom_js_event-facade.js.html#l400"><code>event-custom/js/event-facade.js:400</code></a>

7745

7746

</p>

7747

7748

7749

7750

7751

7752

</div>

7753

7754

7755

<p>Returns an array of bubble targets for this object.</p>

7756

</div>

7757

7758

7759

7760

7761

7762

<h4>Returns:</h4>

7763

7764

7765

7766

7767

EventTarget[]

7768

7769

</div>

7770

</div>

7771

7772

7773

7774

</div>

7775

7776

7777

7778

7779

7780

7781

7782

7783

7784

7785

7786

<code>config</code>

7787

7788

</li>

7789

7790

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

7791

</div>

7792

7793

7794

7795

7796

7797

</span>

7798

7799

7800

7801

7802

7803

7804

7805

7806

7807

7808

7809

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

7810

7811

7812

7813

7814

<p>Inherited from

7815

7816

BaseCore

7817

</a>

7818

7819

but overwritten in

7820

7821

7822

7823

7824

7825

</p>

7826

7827

7828

7829

7830

7831

</div>

7832

7833

7834

<p>Init lifecycle method, invoked during construction.

7835

Fires the init event prior to setting up attributes and

7836

invoking initializers for the class hierarchy.</p>

7837

</div>

7838

7839

7840

7841

<h4>Parameters:</h4>

7842

7843

7844

7845

7846

7847

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

7848

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

7849

7850

7851

7852

7853

7854

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

7855

</div>

7856

7857

7858

</li>

7859

7860

</ul>

7861

</div>

7862

7863

7864

7865

7866

<h4>Returns:</h4>

7867

7868

7869

7870

7871

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

7872

7873

A reference to this object

7874

7875

</div>

7876

</div>

7877

7878

7879

7880

</div>

7881

7882

7883

7884

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

7885

7886

7887

7888

7889

7890

7891

7892

7893

7894

7895

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

7896

7897

7898

7899

7900

7901

7902

7903

7904

7905

7906

7907

7908

<p>

7909

7910

Defined in

7911

7912

7913

7914

7915

7916

7917

</p>

7918

7919

7920

7921

7922

7923

</div>

7924

7925

7926

<p>Construction logic executed during FileHTML5 instantiation.</p>

7927

</div>

7928

7929

7930

7931

7932

7933

7934

</div>

7935

7936

7937

7938

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

7939

7940

7941

7942

7943

7944

7945

7946

7947

7948

</li>

7949

7950

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

7951

</div>

7952

7953

7954

7955

7956

7957

7958

7959

7960

7961

7962

7963

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

7964

7965

7966

7967

7968

7969

7970

7971

7972

<p>

7973

7974

Defined in

7975

7976

7977

7978

7979

7980

7981

</p>

7982

7983

7984

7985

7986

7987

</div>

7988

7989

7990

<p>Checks whether a specific native file instance is valid</p>

7991

</div>

7992

7993

7994

7995

<h4>Parameters:</h4>

7996

7997

7998

7999

8000

8001

8002

8003

8004

8005

8006

8007

8008

<p>A native File() instance.</p>

8009

</div>

8010

8011

8012

</li>

8013

8014

</ul>

8015

</div>

8016

8017

8018

8019

8020

8021

</div>

8022

8023

8024

8025

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

8026

8027

8028

8029

8030

8031

8032

8033

8034

8035

</li>

8036

8037

8038

8039

<code>config</code>

8040

8041

</li>

8042

8043

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

8044

</div>

8045

8046

8047

8048

8049

8050

8051

8052

8053

8054

8055

8056

8057

8058

8059

8060

8061

8062

<p>Inherited from

8063

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

8064

8065

8066

8067

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

8068

8069

</p>

8070

8071

8072

8073

8074

8075

</div>

8076

8077

8078

<p>Updates the configuration of an attribute which has already been added.</p>

8079

8080

<p>

8081

The properties which can be modified through this interface are limited

8082

to the following subset of attributes, which can be safely modified

8083

after a value has already been set on the attribute: readOnly, writeOnce,

8084

broadcast and getter.

8085

</p>

8086

</div>

8087

8088

8089

8090

<h4>Parameters:</h4>

8091

8092

8093

8094

8095

8096

8097

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

8098

8099

8100

8101

8102

8103

<p>The name of the attribute whose configuration is to be updated.</p>

8104

</div>

8105

8106

8107

</li>

8108

8109

8110

8111

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

8112

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

8113

8114

8115

8116

8117

8118

<p>An object with configuration property/value pairs, specifying the configuration properties to modify.</p>

8119

</div>

8120

8121

8122

</li>

8123

8124

</ul>

8125

</div>

8126

8127

8128

8129

8130

8131

</div>

8132

8133

8134

8135

8136

8137

8138

8139

8140

8141

8142

8143

8144

8145

</li>

8146

8147

8148

8149

8150

8151

</li>

8152

8153

8154

8155

<code class="optional">[context]</code>

8156

8157

</li>

8158

8159

8160

8161

8162

8163

</li>

8164

8165

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

8166

</div>

8167

8168

8169

8170

8171

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

8172

</span>

8173

8174

8175

8176

8177

8178

8179

8180

8181

8182

8183

8184

8185

8186

8187

8188

<p>Inherited from

8189

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

8190

8191

8192

8193

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

8194

8195

</p>

8196

8197

8198

8199

8200

8201

</div>

8202

8203

8204

<p>Subscribe a callback function to a custom event fired by this object or

8205

from an object that bubbles its events to this object.</p>

8206

8207

<p>Callback functions for events published with <code>emitFacade = true</code> will

8208

receive an <code>EventFacade</code> as the first argument (typically named "e").

8209

These callbacks can then call <code>e.preventDefault()</code> to disable the

8210

behavior published to that event's <code>defaultFn</code>. See the <code>EventFacade</code>

8211

API for all available properties and methods. Subscribers to

8212

non-<code>emitFacade</code> events will receive the arguments passed to <code>fire()</code>

8213

after the event name.</p>

8214

8215

<p>To subscribe to multiple events at once, pass an object as the first

8216

argument, where the key:value pairs correspond to the eventName:callback,

8217

or pass an array of event names as the first argument to subscribe to

8218

all listed events with the same callback.</p>

8219

8220

<p>Returning <code>false</code> from a callback is supported as an alternative to

8221

calling <code>e.preventDefault(); e.stopPropagation();</code>. However, it is

8222

recommended to use the event methods whenever possible.</p>

8223

</div>

8224

8225

8226

8227

<h4>Parameters:</h4>

8228

8229

8230

8231

8232

8233

8234

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

8235

8236

8237

8238

8239

8240

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

8241

</div>

8242

8243

8244

</li>

8245

8246

8247

8248

8249

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

8250

8251

8252

8253

8254

8255

<p>The callback to execute in response to the event</p>

8256

</div>

8257

8258

8259

</li>

8260

8261

8262

8263

<code class="param-name optional">[context]</code>

8264

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

8265

<span class="flag optional" title="This parameter is optional.">optional</span>

8266

8267

8268

8269

8270

8271

<p>Override <code>this</code> object in callback</p>

8272

</div>

8273

8274

8275

</li>

8276

8277

8278

8279

8280

8281

<span class="flag optional" title="This parameter is optional.">optional</span>

8282

8283

8284

8285

8286

8287

<p>0..n additional arguments to supply to the subscriber</p>

8288

</div>

8289

8290

8291

</li>

8292

8293

</ul>

8294

</div>

8295

8296

8297

8298

8299

<h4>Returns:</h4>

8300

8301

8302

8303

8304

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

8305

8306

A subscription handle capable of detaching that

8307

subscription

8308

8309

</div>

8310

</div>

8311

8312

8313

8314

</div>

8315

8316

8317

8318

8319

8320

8321

8322

8323

8324

8325

8326

8327

8328

</li>

8329

8330

8331

8332

8333

8334

</li>

8335

8336

8337

8338

<code class="optional">[context]</code>

8339

8340

</li>

8341

8342

8343

8344

8345

8346

</li>

8347

8348

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

8349

</div>

8350

8351

8352

8353

8354

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

8355

</span>

8356

8357

8358

8359

8360

8361

8362

8363

8364

8365

8366

8367

8368

8369

8370

8371

<p>Inherited from

8372

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

8373

8374

8375

8376

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

8377

8378

</p>

8379

8380

8381

8382

8383

8384

</div>

8385

8386

8387

<p>Listen to a custom event hosted by this object one time.

8388

This is the equivalent to <code>on</code> except the

8389

listener is immediatelly detached when it is executed.</p>

8390

</div>

8391

8392

8393

8394

<h4>Parameters:</h4>

8395

8396

8397

8398

8399

8400

8401

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

8402

8403

8404

8405

8406

8407

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

8408

</div>

8409

8410

8411

</li>

8412

8413

8414

8415

8416

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

8417

8418

8419

8420

8421

8422

<p>The callback to execute in response to the event</p>

8423

</div>

8424

8425

8426

</li>

8427

8428

8429

8430

<code class="param-name optional">[context]</code>

8431

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

8432

<span class="flag optional" title="This parameter is optional.">optional</span>

8433

8434

8435

8436

8437

8438

<p>Override <code>this</code> object in callback</p>

8439

</div>

8440

8441

8442

</li>

8443

8444

8445

8446

8447

8448

<span class="flag optional" title="This parameter is optional.">optional</span>

8449

8450

8451

8452

8453

8454

<p>0..n additional arguments to supply to the subscriber</p>

8455

</div>

8456

8457

8458

</li>

8459

8460

</ul>

8461

</div>

8462

8463

8464

8465

8466

<h4>Returns:</h4>

8467

8468

8469

8470

8471

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

8472

8473

A subscription handle capable of detaching the

8474

subscription

8475

8476

</div>

8477

</div>

8478

8479

8480

8481

</div>

8482

8483

8484

8485

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

8486

8487

8488

8489

8490

8491

8492

8493

8494

8495

</li>

8496

8497

8498

8499

8500

8501

</li>

8502

8503

8504

8505

<code class="optional">[context]</code>

8506

8507

</li>

8508

8509

8510

8511

8512

8513

</li>

8514

8515

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

8516

</div>

8517

8518

8519

8520

8521

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

8522

</span>

8523

8524

8525

8526

8527

8528

8529

8530

8531

8532

8533

8534

8535

8536

8537

8538

<p>Inherited from

8539

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

8540

8541

8542

8543

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

8544

8545

</p>

8546

8547

8548

8549

8550

8551

</div>

8552

8553

8554

<p>Listen to a custom event hosted by this object one time.

8555

This is the equivalent to <code>after</code> except the

8556

listener is immediatelly detached when it is executed.</p>

8557

</div>

8558

8559

8560

8561

<h4>Parameters:</h4>

8562

8563

8564

8565

8566

8567

8568

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

8569

8570

8571

8572

8573

8574

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

8575

</div>

8576

8577

8578

</li>

8579

8580

8581

8582

8583

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

8584

8585

8586

8587

8588

8589

<p>The callback to execute in response to the event</p>

8590

</div>

8591

8592

8593

</li>

8594

8595

8596

8597

<code class="param-name optional">[context]</code>

8598

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

8599

<span class="flag optional" title="This parameter is optional.">optional</span>

8600

8601

8602

8603

8604

8605

<p>Override <code>this</code> object in callback</p>

8606

</div>

8607

8608

8609

</li>

8610

8611

8612

8613

8614

8615

<span class="flag optional" title="This parameter is optional.">optional</span>

8616

8617

8618

8619

8620

8621

<p>0..n additional arguments to supply to the subscriber</p>

8622

</div>

8623

8624

8625

</li>

8626

8627

</ul>

8628

</div>

8629

8630

8631

8632

8633

<h4>Returns:</h4>

8634

8635

8636

8637

8638

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

8639

8640

A subscription handle capable of detaching that

8641

subscription

8642

8643

</div>

8644

</div>

8645

8646

8647

8648

</div>

8649

8650

8651

8652

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

8653

8654

8655

8656

8657

8658

8659

8660

8661

8662

</li>

8663

8664

8665

8666

<code class="optional">[pre=this._yuievt.config.prefix]</code>

8667

8668

</li>

8669

8670

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

8671

</div>

8672

8673

8674

8675

8676

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

8677

</span>

8678

8679

8680

8681

8682

8683

8684

8685

8686

8687

8688

8689

8690

8691

8692

8693

<p>Inherited from

8694

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

8695

8696

8697

8698

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

8699

8700

</p>

8701

8702

8703

8704

8705

8706

<p>Available since 3.3.0</p>

8707

8708

</div>

8709

8710

8711

<p>Takes the type parameter passed to 'on' and parses out the

8712

various pieces that could be included in the type. If the

8713

event type is passed without a prefix, it will be expanded

8714

to include the prefix one is supplied or the event target

8715

is configured with a default prefix.</p>

8716

</div>

8717

8718

8719

8720

<h4>Parameters:</h4>

8721

8722

8723

8724

8725

8726

8727

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

8728

8729

8730

8731

8732

8733

8734

</div>

8735

8736

8737

</li>

8738

8739

8740

8741

<code class="param-name optional">[pre=this._yuievt.config.prefix]</code>

8742

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

8743

<span class="flag optional" title="This parameter is optional.">optional</span>

8744

8745

8746

8747

8748

8749

<p>the prefix</p>

8750

</div>

8751

8752

8753

</li>

8754

8755

</ul>

8756

</div>

8757

8758

8759

8760

8761

<h4>Returns:</h4>

8762

8763

8764

8765

8766

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

8767

8768

an array containing:

8769

* the detach category, if supplied,

8770

* the prefixed event type,

8771

* whether or not this is an after listener,

8772

* the supplied event type

8773

8774

</div>

8775

</div>

8776

8777

8778

8779

</div>

8780

8781

8782

8783

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

8784

8785

8786

8787

8788

8789

8790

8791

8792

8793

</li>

8794

8795

8796

8797

8798

8799

</li>

8800

8801

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

8802

</div>

8803

8804

8805

8806

8807

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

8808

</span>

8809

8810

8811

8812

8813

8814

8815

8816

8817

8818

8819

8820

8821

8822

8823

8824

<p>Inherited from

8825

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

8826

8827

8828

8829

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

8830

8831

</p>

8832

8833

8834

8835

8836

8837

</div>

8838

8839

8840

<p>Creates a new custom event of the specified type. If a custom event

8841

by that name already exists, it will not be re-created. In either

8842

case the custom event is returned.</p>

8843

</div>

8844

8845

8846

8847

<h4>Parameters:</h4>

8848

8849

8850

8851

8852

8853

8854

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

8855

8856

8857

8858

8859

8860

<p>the type, or name of the event</p>

8861

</div>

8862

8863

8864

</li>

8865

8866

8867

8868

8869

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

8870

8871

8872

8873

8874

8875

<p>optional config params. Valid properties are:</p>

8876

8877

<p><ul>

8878

<li>

8879

'broadcast': whether or not the YUI instance and YUI global are notified when the event is fired (false)

8880

</li>

8881

<li>

8882

'bubbles': whether or not this event bubbles (true)

8883

Events can only bubble if emitFacade is true.

8884

</li>

8885

<li>

8886

'context': the default execution context for the listeners (this)

8887

</li>

8888

<li>

8889

'defaultFn': the default function to execute when this event fires if preventDefault was not called

8890

</li>

8891

<li>

8892

'emitFacade': whether or not this event emits a facade (false)

8893

</li>

8894

<li>

8895

'prefix': the prefix for this targets events, e.g., 'menu' in 'menu:click'

8896

</li>

8897

<li>

8898

'fireOnce': if an event is configured to fire once, new subscribers after

8899

the fire will be notified immediately.

8900

</li>

8901

<li>

8902

'async': fireOnce event listeners will fire synchronously if the event has already

8903

fired unless async is true.

8904

</li>

8905

<li>

8906

'preventable': whether or not preventDefault() has an effect (true)

8907

</li>

8908

<li>

8909

'preventedFn': a function that is executed when preventDefault is called

8910

</li>

8911

<li>

8912

'queuable': whether or not this event can be queued during bubbling (false)

8913

</li>

8914

<li>

8915

'silent': if silent is true, debug messages are not provided for this event.

8916

</li>

8917

<li>

8918

'stoppedFn': a function that is executed when stopPropagation is called

8919

</li></p>

8920

8921

<p><li>

8922

'monitored': specifies whether or not this event should send notifications about

8923

when the event has been attached, detached, or published.

8924

</li>

8925

<li>

8926

'type': the event type (valid option if not provided as the first parameter to publish)

8927

</li>

8928

</ul></p>

8929

</div>

8930

8931

8932

</li>

8933

8934

</ul>

8935

</div>

8936

8937

8938

8939

8940

<h4>Returns:</h4>

8941

8942

8943

8944

8945

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

8946

8947

the custom event

8948

8949

</div>

8950

</div>

8951

8952

8953

8954

</div>

8955

8956

8957

8958

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

8959

8960

8961

8962

8963

8964

8965

8966

8967

8968

</li>

8969

8970

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

8971

</div>

8972

8973

8974

8975

8976

8977

8978

8979

8980

8981

8982

8983

8984

8985

8986

8987

8988

8989

<p>Inherited from

8990

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

8991

8992

8993

8994

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

8995

8996

</p>

8997

8998

8999

9000

9001

9002

</div>

9003

9004

9005

<p>Removes an attribute from the host object</p>

9006

</div>

9007

9008

9009

9010

<h4>Parameters:</h4>

9011

9012

9013

9014

9015

9016

9017

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

9018

9019

9020

9021

9022

9023

<p>The name of the attribute to be removed.</p>

9024

</div>

9025

9026

9027

</li>

9028

9029

</ul>

9030

</div>

9031

9032

9033

9034

9035

9036

</div>

9037

9038

9039

9040

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

9041

9042

9043

9044

9045

9046

9047

9048

9049

9050

</li>

9051

9052

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

9053

</div>

9054

9055

9056

9057

9058

9059

9060

9061

9062

9063

9064

9065

9066

9067

9068

9069

9070

9071

<p>Inherited from

9072

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

9073

9074

9075

9076

<a href="../files/event-custom_js_event-facade.js.html#l409"><code>event-custom/js/event-facade.js:409</code></a>

9077

9078

</p>

9079

9080

9081

9082

9083

9084

</div>

9085

9086

9087

<p>Removes a bubble target</p>

9088

</div>

9089

9090

9091

9092

<h4>Parameters:</h4>

9093

9094

9095

9096

9097

9098

9099

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

9100

9101

9102

9103

9104

9105

<p>the target to remove</p>

9106

</div>

9107

9108

9109

</li>

9110

9111

</ul>

9112

</div>

9113

9114

9115

9116

9117

9118

</div>

9119

9120

9121

9122

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

9123

9124

9125

9126

9127

9128

9129

9130

9131

9132

</li>

9133

9134

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

9135

</div>

9136

9137

9138

9139

9140

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

9141

</span>

9142

9143

9144

9145

9146

9147

9148

9149

9150

9151

9152

9153

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

9154

9155

9156

9157

9158

9159

<p>Inherited from

9160

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

9161

9162

9163

9164

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

9165

9166

</p>

9167

9168

9169

9170

9171

9172

</div>

9173

9174

9175

<p>Resets the attribute (or all attributes) to its initial value, as long as

9176

the attribute is not readOnly, or writeOnce.</p>

9177

</div>

9178

9179

9180

9181

<h4>Parameters:</h4>

9182

9183

9184

9185

9186

9187

9188

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

9189

9190

9191

9192

9193

9194

<p>Optional. The name of the attribute to reset. If omitted, all attributes are reset.</p>

9195

</div>

9196

9197

9198

</li>

9199

9200

</ul>

9201

</div>

9202

9203

9204

9205

9206

<h4>Returns:</h4>

9207

9208

9209

9210

9211

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

9212

9213

A reference to the host object.

9214

9215

</div>

9216

</div>

9217

9218

9219

9220

</div>

9221

9222

9223

9224

9225

9226

9227

9228

9229

9230

9231

9232

9233

9234

</li>

9235

9236

9237

9238

<code>value</code>

9239

9240

</li>

9241

9242

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

9243

</div>

9244

9245

9246

9247

9248

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

9249

</span>

9250

9251

9252

9253

9254

9255

9256

9257

9258

9259

9260

9261

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

9262

9263

9264

9265

9266

<p>Inherited from

9267

9268

AttributeEvents

9269

</a>

9270

9271

but overwritten in

9272

9273

9274

9275

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

9276

9277

</p>

9278

9279

9280

9281

9282

9283

</div>

9284

9285

9286

<p>Sets the value of an attribute.</p>

9287

</div>

9288

9289

9290

9291

<h4>Parameters:</h4>

9292

9293

9294

9295

9296

9297

9298

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

9299

9300

9301

9302

9303

9304

<p>The name of the attribute. If the

9305

current value of the attribute is an Object, dot notation can be used

9306

to set the value of a property within the object (e.g. <code>set("x.y.z", 5)</code>).</p>

9307

</div>

9308

9309

9310

</li>

9311

9312

9313

9314

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

9315

9316

9317

9318

9319

9320

9321

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

9322

</div>

9323

9324

9325

</li>

9326

9327

</ul>

9328

</div>

9329

9330

9331

9332

9333

<h4>Returns:</h4>

9334

9335

9336

9337

9338

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

9339

9340

A reference to the host object.

9341

9342

</div>

9343

</div>

9344

9345

9346

9347

</div>

9348

9349

9350

9351

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

9352

9353

9354

9355

9356

9357

9358

9359

<code>attrs</code>

9360

9361

</li>

9362

9363

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

9364

</div>

9365

9366

9367

9368

9369

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

9370

</span>

9371

9372

9373

9374

9375

9376

9377

9378

9379

9380

9381

9382

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

9383

9384

9385

9386

9387

<p>Inherited from

9388

9389

AttributeEvents

9390

</a>

9391

9392

but overwritten in

9393

9394

9395

9396

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

9397

9398

</p>

9399

9400

9401

9402

9403

9404

</div>

9405

9406

9407

<p>Sets multiple attribute values.</p>

9408

</div>

9409

9410

9411

9412

<h4>Parameters:</h4>

9413

9414

9415

9416

9417

9418

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

9419

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

9420

9421

9422

9423

9424

9425

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

9426

</div>

9427

9428

9429

</li>

9430

9431

</ul>

9432

</div>

9433

9434

9435

9436

9437

<h4>Returns:</h4>

9438

9439

9440

9441

9442

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

9443

9444

A reference to the host object.

9445

9446

</div>

9447

</div>

9448

9449

9450

9451

</div>

9452

9453

9454

9455

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

9456

9457

9458

9459

9460

9461

9462

9463

9464

9465

</li>

9466

9467

9468

9469

<code>parameters</code>

9470

9471

</li>

9472

9473

9474

9475

<code>fileFieldName</code>

9476

9477

</li>

9478

9479

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

9480

</div>

9481

9482

9483

9484

9485

9486

9487

9488

9489

9490

9491

9492

9493

9494

9495

9496

9497

9498

9499

<p>

9500

9501

Defined in

9502

9503

9504

9505

9506

9507

9508

</p>

9509

9510

9511

9512

9513

9514

</div>

9515

9516

9517

<p>Starts the upload of a specific file.</p>

9518

</div>

9519

9520

9521

9522

<h4>Parameters:</h4>

9523

9524

9525

9526

9527

9528

9529

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

9530

9531

9532

9533

9534

9535

<p>The URL to upload the file to.</p>

9536

</div>

9537

9538

9539

</li>

9540

9541

9542

9543

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

9544

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

9545

9546

9547

9548

9549

9550

<p>(optional) A set of key-value pairs to send as variables along with the file upload HTTP request.</p>

9551

</div>

9552

9553

9554

</li>

9555

9556

9557

9558

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

9559

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

9560

9561

9562

9563

9564

9565

<p>(optional) The name of the POST variable that should contain the uploaded file ('Filedata' by default)</p>

9566

</div>

9567

9568

9569

</li>

9570

9571

</ul>

9572

</div>

9573

9574

9575

9576

9577

9578

</div>

9579

9580

9581

9582

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

9583

9584

9585

9586

9587

9588

9589

9590

9591

<span class="flag deprecated" title="use on">deprecated</span>

9592

9593

9594

9595

9596

9597

9598

9599

9600

9601

9602

9603

9604

9605

<p>Inherited from

9606

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

9607

9608

9609

9610

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

9611

9612

</p>

9613

9614

9615

9616

<p>Deprecated: use on</p>

9617

9618

9619

9620

</div>

9621

9622

9623

<p>subscribe to an event</p>

9624

</div>

9625

9626

9627

9628

9629

9630

9631

</div>

9632

9633

9634

9635

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

9636

9637

9638

9639

9640

9641

9642

9643

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

9644

</span>

9645

9646

9647

9648

9649

9650

9651

9652

9653

9654

9655

9656

9657

9658

9659

9660

<p>Inherited from

9661

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

9662

9663

9664

9665

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

9666

9667

</p>

9668

9669

9670

9671

9672

9673

</div>

9674

9675

9676

<p>Default toString implementation. Provides the constructor NAME

9677

and the instance guid, if set.</p>

9678

</div>

9679

9680

9681

9682

9683

9684

<h4>Returns:</h4>

9685

9686

9687

9688

9689

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

9690

9691

String representation for this object

9692

9693

</div>

9694

</div>

9695

9696

9697

9698

</div>

9699

9700

9701

9702

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

9703

9704

9705

9706

9707

9708

9709

9710

9711

<span class="flag deprecated" title="use detach">deprecated</span>

9712

9713

9714

9715

9716

9717

9718

9719

9720

9721

9722

9723

9724

9725

<p>Inherited from

9726

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

9727

9728

9729

9730

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

9731

9732

</p>

9733

9734

9735

9736

<p>Deprecated: use detach</p>

9737

9738

9739

9740

</div>

9741

9742

9743

<p>detach a listener</p>

9744

</div>

9745

9746

9747

9748

9749

9750

9751

</div>

9752

9753

9754

9755

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

9756

9757

9758

9759

9760

9761

9762

9763

9764

9765

</li>

9766

9767

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

9768

</div>

9769

9770

9771

9772

9773

9774

<span class="flag deprecated" title="use detachAll">deprecated</span>

9775

9776

9777

9778

9779

9780

9781

9782

9783

9784

9785

9786

9787

9788

<p>Inherited from

9789

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

9790

9791

9792

9793

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

9794

9795

</p>

9796

9797

9798

9799

<p>Deprecated: use detachAll</p>

9800

9801

9802

9803

</div>

9804

9805

9806

<p>Removes all listeners from the specified event. If the event type

9807

is not specified, all listeners from all hosted custom events will

9808

be removed.</p>

9809

</div>

9810

9811

9812

9813

<h4>Parameters:</h4>

9814

9815

9816

9817

9818

9819

9820

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

9821

9822

9823

9824

9825

9826

<p>The type, or name of the event</p>

9827

</div>

9828

9829

9830

</li>

9831

9832

</ul>

9833

</div>

9834

9835

9836

9837

9838

9839

</div>

9840

9841

9842

</div>

9843

9844

9845

9846

9847

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

9848

9849

9850

9851

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

9852

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

9853

9854

9855

9856

9857

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

9858

9859

9860

9861

9862

9863

9864

9865

9866

9867

<p>Inherited from

9868

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

9869

9870

9871

9872

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

9873

9874

</p>

9875

9876

9877

9878

9879

</div>

9880

9881

9882

<p>This property controls whether or not instances of this class should

9883

allow users to add ad-hoc attributes through the constructor configuration

9884

hash.</p>

9885

9886

<p>AdHoc attributes are attributes which are not defined by the class, and are

9887

not handled by the MyClass.<em>NON</em>ATTRS_CFG</p>

9888

</div>

9889

9890

9891

<p><strong>Default:</strong> undefined (false)</p>

9892

9893

9894

9895

9896

9897

</div>

9898

9899

9900

9901

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

9902

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

9903

9904

9905

9906

9907

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

9908

9909

9910

9911

9912

9913

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

9914

9915

9916

9917

9918

9919

9920

<p>

9921

9922

Defined in

9923

9924

9925

9926

9927

9928

9929

</p>

9930

9931

9932

9933

9934

</div>

9935

9936

9937

<p>Static property used to define the default attribute configuration of

9938

the File.</p>

9939

</div>

9940

9941

9942

9943

9944

9945

9946

</div>

9947

9948

9949

9950

9951

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

9952

9953

9954

9955

9956

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

9957

9958

9959

9960

9961

9962

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

9963

9964

9965

9966

9967

9968

9969

<p>

9970

9971

Defined in

9972

9973

9974

9975

9976

9977

9978

</p>

9979

9980

9981

9982

9983

</div>

9984

9985

9986

<p>The identity of the class.</p>

9987

</div>

9988

9989

9990

<p><strong>Default:</strong> 'file'</p>

9991

9992

9993

9994

9995

9996

</div>

9997

9998

9999

10000

10001

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

10002

10003

10004

<span class="flag deprecated" title="Use this.constructor.NAME">deprecated</span>

10005

10006

10007

10008

10009

10010

10011

10012

10013

10014

10015

10016

<p>Inherited from

10017

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

10018

10019

10020

10021

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

10022

10023

</p>

10024

10025

10026

<p>Deprecated: Use this.constructor.NAME</p>

10027

10028

10029

10030

</div>

10031

10032

10033

<p>The string used to identify the class of this object.</p>

10034

</div>

10035

10036

10037

10038

10039

10040

10041

</div>

10042

10043

10044

10045

10046

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

10047

10048

10049

10050

10051

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

10052

10053

10054

10055

10056

10057

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

10058

10059

10060

10061

10062

10063

10064

<p>

10065

10066

Defined in

10067

10068

10069

10070

10071

10072

10073

</p>

10074

10075

10076

10077

10078

</div>

10079

10080

10081

<p>The type of transport.</p>

10082

</div>

10083

10084

10085

<p><strong>Default:</strong> 'html5'</p>

10086

10087

10088

10089

10090

10091

</div>

10092

10093

10094

</div>

10095

10096

10097

10098

10099

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

10100

10101

10102

10103

10104

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

10105

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

10106

10107

10108

10109

10110

10111

10112

10113

10114

10115

10116

10117

10118

10119

<p>

10120

10121

Defined in

10122

10123

10124

10125

10126

10127

10128

</p>

10129

10130

10131

10132

10133

</div>

10134

10135

10136

<p>The bound event handler used to handle events from XMLHttpRequest.</p>

10137

</div>

10138

10139

10140

10141

10142

10143

<h4>Fires event <code>boundEventHandlerChange</code></h4>

10144

10145

<p>

10146

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

10147

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

10148

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

10149

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

10150

attribute's value has changed.

10151

</p>

10152

10153

10154

<h4>Parameters:</h4>

10155

10156

10157

10158

10159

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

10160

10161

10162

An Event Facade object with the following

10163

attribute-specific properties added:

10164

</div>

10165

10166

10167

10168

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

10169

10170

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

10171

</li>

10172

10173

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

10174

10175

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

10176

</li>

10177

10178

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

10179

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

10180

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

10181

</li>

10182

10183

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

10184

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

10185

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

10186

</li>

10187

</ul>

10188

</li>

10189

</ul>

10190

</div>

10191

</div>

10192

10193

10194

10195

</div>

10196

10197

10198

10199

10200

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

10201

10202

10203

10204

10205

10206

10207

10208

10209

10210

10211

10212

10213

10214

10215

<p>

10216

10217

Defined in

10218

10219

10220

10221

10222

10223

10224

</p>

10225

10226

10227

10228

10229

</div>

10230

10231

10232

<p>The number of bytes of the file that has been uploaded to the server. This value is

10233

non-zero only while a file is being uploaded.</p>

10234

</div>

10235

10236

10237

10238

10239

10240

<h4>Fires event <code>bytesUploadedChange</code></h4>

10241

10242

<p>

10243

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

10244

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

10245

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

10246

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

10247

attribute's value has changed.

10248

</p>

10249

10250

10251

<h4>Parameters:</h4>

10252

10253

10254

10255

10256

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

10257

10258

10259

An Event Facade object with the following

10260

attribute-specific properties added:

10261

</div>

10262

10263

10264

10265

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

10266

10267

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

10268

</li>

10269

10270

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

10271

10272

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

10273

</li>

10274

10275

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

10276

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

10277

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

10278

</li>

10279

10280

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

10281

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

10282

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

10283

</li>

10284

</ul>

10285

</li>

10286

</ul>

10287

</div>

10288

</div>

10289

10290

10291

10292

</div>

10293

10294

10295

10296

10297

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

10298

10299

10300

10301

10302

10303

10304

10305

10306

10307

10308

10309

10310

10311

10312

<p>

10313

10314

Defined in

10315

10316

10317

10318

10319

10320

10321

</p>

10322

10323

10324

10325

10326

</div>

10327

10328

10329

<p>The date that the file wrapped by FileHTML5 was created on. This value is supplied by the instance of File().</p>

10330

</div>

10331

10332

10333

<p><strong>Default:</strong> null</p>

10334

10335

10336

10337

10338

<h4>Fires event <code>dateCreatedChange</code></h4>

10339

10340

<p>

10341

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

10342

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

10343

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

10344

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

10345

attribute's value has changed.

10346

</p>

10347

10348

10349

<h4>Parameters:</h4>

10350

10351

10352

10353

10354

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

10355

10356

10357

An Event Facade object with the following

10358

attribute-specific properties added:

10359

</div>

10360

10361

10362

10363

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

10364

10365

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

10366

</li>

10367

10368

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

10369

10370

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

10371

</li>

10372

10373

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

10374

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

10375

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

10376

</li>

10377

10378

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

10379

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

10380

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

10381

</li>

10382

</ul>

10383

</li>

10384

</ul>

10385

</div>

10386

</div>

10387

10388

10389

10390

</div>

10391

10392

10393

10394

10395

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

10396

10397

10398

10399

10400

10401

10402

10403

10404

10405

10406

10407

10408

10409

10410

<p>

10411

10412

Defined in

10413

10414

10415

10416

10417

10418

10419

</p>

10420

10421

10422

10423

10424

</div>

10425

10426

10427

<p>The date that the file wrapped by FileHTML5 was last modified on. This value is supplied by the instance of File().</p>

10428

</div>

10429

10430

10431

10432

10433

10434

<h4>Fires event <code>dateModifiedChange</code></h4>

10435

10436

<p>

10437

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

10438

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

10439

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

10440

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

10441

attribute's value has changed.

10442

</p>

10443

10444

10445

<h4>Parameters:</h4>

10446

10447

10448

10449

10450

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

10451

10452

10453

An Event Facade object with the following

10454

attribute-specific properties added:

10455

</div>

10456

10457

10458

10459

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

10460

10461

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

10462

</li>

10463

10464

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

10465

10466

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

10467

</li>

10468

10469

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

10470

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

10471

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

10472

</li>

10473

10474

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

10475

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

10476

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

10477

</li>

10478

</ul>

10479

</li>

10480

</ul>

10481

</div>

10482

</div>

10483

10484

10485

10486

</div>

10487

10488

10489

10490

10491

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

10492

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

10493

10494

10495

10496

10497

10498

10499

10500

10501

10502

10503

10504

10505

<p>Inherited from

10506

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

10507

10508

10509

10510

<a href="../files/base_js_BaseCore.js.html#l157"><code>base/js/BaseCore.js:157</code></a>

10511

10512

</p>

10513

10514

10515

10516

10517

</div>

10518

10519

10520

<p>Flag indicating whether or not this object

10521

has been through the destroy lifecycle phase.</p>

10522

</div>

10523

10524

10525

<p><strong>Default:</strong> false</p>

10526

10527

10528

10529

10530

<h4>Fires event <code>destroyedChange</code></h4>

10531

10532

<p>

10533

Fires when the value for the configuration attribute <code>destroyed</code> is

10534

changed. You can listen for the event using the <code>on</code> method if you

10535

wish to be notified before the attribute's value has changed, or

10536

using the <code>after</code> method if you wish to be notified after the

10537

attribute's value has changed.

10538

</p>

10539

10540

10541

<h4>Parameters:</h4>

10542

10543

10544

10545

10546

<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>

10547

10548

10549

An Event Facade object with the following

10550

attribute-specific properties added:

10551

</div>

10552

10553

10554

10555

<code class="param-name">prevVal</code>

10556

10557

<div class="param-description">The value of the attribute, prior to it being set.</div>

10558

</li>

10559

10560

<code class="param-name">newVal</code>

10561

10562

<div class="param-description">The value the attribute is to be set to.</div>

10563

</li>

10564

10565

<code class="param-name">attrName</code>

10566

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

10567

<div class="param-description">The name of the attribute being set.</div>

10568

</li>

10569

10570

<code class="param-name">subAttrName</code>

10571

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

10572

<div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div>

10573

</li>

10574

</ul>

10575

</li>

10576

</ul>

10577

</div>

10578

</div>

10579

10580

10581

10582

</div>

10583

10584

10585

10586

10587

10588

10589

10590

10591

10592

10593

10594

10595

10596

10597

10598

10599

10600

10601

10602

<p>

10603

10604

Defined in

10605

10606

10607

10608

10609

10610

10611

</p>

10612

10613

10614

10615

10616

</div>

10617

10618

10619

<p>The pointer to the instance of File() wrapped by FileHTML5.</p>

10620

</div>

10621

10622

10623

10624

10625

10626

<h4>Fires event <code>fileChange</code></h4>

10627

10628

<p>

10629

Fires when the value for the configuration attribute <code>file</code> is

10630

changed. You can listen for the event using the <code>on</code> method if you

10631

wish to be notified before the attribute's value has changed, or

10632

using the <code>after</code> method if you wish to be notified after the

10633

attribute's value has changed.

10634

</p>

10635

10636

10637

<h4>Parameters:</h4>

10638

10639

10640

10641

10642

<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>

10643

10644

10645

An Event Facade object with the following

10646

attribute-specific properties added:

10647

</div>

10648

10649

10650

10651

<code class="param-name">prevVal</code>

10652

10653

<div class="param-description">The value of the attribute, prior to it being set.</div>

10654

</li>

10655

10656

<code class="param-name">newVal</code>

10657

10658

<div class="param-description">The value the attribute is to be set to.</div>

10659

</li>

10660

10661

<code class="param-name">attrName</code>

10662

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

10663

<div class="param-description">The name of the attribute being set.</div>

10664

</li>

10665

10666

<code class="param-name">subAttrName</code>

10667

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

10668

<div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div>

10669

</li>

10670

</ul>

10671

</li>

10672

</ul>

10673

</div>

10674

</div>

10675

10676

10677

10678

</div>

10679

10680

10681

10682

10683

10684

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

10685

10686

10687

10688

10689

10690

10691

10692

10693

10694

10695

10696

10697

10698

<p>

10699

10700

Defined in

10701

10702

10703

10704

10705

10706

10707

</p>

10708

10709

10710

10711

10712

</div>

10713

10714

10715

<p>A String containing the unique id of the file wrapped by the FileFlash instance.

10716

The id is supplied by the Flash player uploader.</p>

10717

</div>

10718

10719

10720

10721

10722

10723

<h4>Fires event <code>idChange</code></h4>

10724

10725

<p>

10726

Fires when the value for the configuration attribute <code>id</code> is

10727

changed. You can listen for the event using the <code>on</code> method if you

10728

wish to be notified before the attribute's value has changed, or

10729

using the <code>after</code> method if you wish to be notified after the

10730

attribute's value has changed.

10731

</p>

10732

10733

10734

<h4>Parameters:</h4>

10735

10736

10737

10738

10739

<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>

10740

10741

10742

An Event Facade object with the following

10743

attribute-specific properties added:

10744

</div>

10745

10746

10747

10748

<code class="param-name">prevVal</code>

10749

10750

<div class="param-description">The value of the attribute, prior to it being set.</div>

10751

</li>

10752

10753

<code class="param-name">newVal</code>

10754

10755

<div class="param-description">The value the attribute is to be set to.</div>

10756

</li>

10757

10758

<code class="param-name">attrName</code>

10759

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

10760

<div class="param-description">The name of the attribute being set.</div>

10761

</li>

10762

10763

<code class="param-name">subAttrName</code>

10764

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

10765

<div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div>

10766

</li>

10767

</ul>

10768

</li>

10769

</ul>

10770

</div>

10771

</div>

10772

10773

10774

10775

</div>

10776

10777

10778

10779

10780

<h3 class="name"><code>initialized</code></h3>

10781

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>

10782

10783

10784

10785

10786

10787

10788

10789

10790

10791

10792

10793

10794

<p>Inherited from

10795

<a href="../classes/BaseCore.html#attr_initialized">BaseCore</a>:

10796

10797

10798

10799

<a href="../files/base_js_BaseCore.js.html#l143"><code>base/js/BaseCore.js:143</code></a>

10800

10801

</p>

10802

10803

10804

10805

10806

</div>

10807

10808

10809

<p>Flag indicating whether or not this object

10810

has been through the init lifecycle phase.</p>

10811

</div>

10812

10813

10814

<p><strong>Default:</strong> false</p>

10815

10816

10817

10818

10819

<h4>Fires event <code>initializedChange</code></h4>

10820

10821

<p>

10822

Fires when the value for the configuration attribute <code>initialized</code> is

10823

changed. You can listen for the event using the <code>on</code> method if you

10824

wish to be notified before the attribute's value has changed, or

10825

using the <code>after</code> method if you wish to be notified after the

10826

attribute's value has changed.

10827

</p>

10828

10829

10830

<h4>Parameters:</h4>

10831

10832

10833

10834

10835

<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>

10836

10837

10838

An Event Facade object with the following

10839

attribute-specific properties added:

10840

</div>

10841

10842

10843

10844

<code class="param-name">prevVal</code>

10845

10846

<div class="param-description">The value of the attribute, prior to it being set.</div>

10847

</li>

10848

10849

<code class="param-name">newVal</code>

10850

10851

<div class="param-description">The value the attribute is to be set to.</div>

10852

</li>

10853

10854

<code class="param-name">attrName</code>

10855

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

10856

<div class="param-description">The name of the attribute being set.</div>

10857

</li>

10858

10859

<code class="param-name">subAttrName</code>

10860

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

10861

<div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div>

10862

</li>

10863

</ul>

10864

</li>

10865

</ul>

10866

</div>

10867

</div>

10868

10869

10870

10871

</div>

10872

10873

10874

10875

10876

10877

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

10878

10879

10880

10881

10882

10883

10884

10885

10886

10887

10888

10889

10890

10891

<p>

10892

10893

Defined in

10894

10895

10896

10897

10898

10899

10900

</p>

10901

10902

10903

10904

10905

</div>

10906

10907

10908

<p>The name of the file wrapped by FileHTML5. This value is supplied by the instance of File().</p>

10909

</div>

10910

10911

10912

10913

10914

10915

<h4>Fires event <code>nameChange</code></h4>

10916

10917

<p>

10918

Fires when the value for the configuration attribute <code>name</code> is

10919

changed. You can listen for the event using the <code>on</code> method if you

10920

wish to be notified before the attribute's value has changed, or

10921

using the <code>after</code> method if you wish to be notified after the

10922

attribute's value has changed.

10923

</p>

10924

10925

10926

<h4>Parameters:</h4>

10927

10928

10929

10930

10931

<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>

10932

10933

10934

An Event Facade object with the following

10935

attribute-specific properties added:

10936

</div>

10937

10938

10939

10940

<code class="param-name">prevVal</code>

10941

10942

<div class="param-description">The value of the attribute, prior to it being set.</div>

10943

</li>

10944

10945

<code class="param-name">newVal</code>

10946

10947

<div class="param-description">The value the attribute is to be set to.</div>

10948

</li>

10949

10950

<code class="param-name">attrName</code>

10951

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

10952

<div class="param-description">The name of the attribute being set.</div>

10953

</li>

10954

10955

<code class="param-name">subAttrName</code>

10956

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

10957

<div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div>

10958

</li>

10959

</ul>

10960

</li>

10961

</ul>

10962

</div>

10963

</div>

10964

10965

10966

10967

</div>

10968

10969

10970

10971

10972

10973

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Number" class="crosslink external" target="_blank">Number</a></span>

10974

10975

10976

10977

10978

10979

10980

10981

10982

10983

10984

10985

10986

10987

<p>

10988

10989

Defined in

10990

10991

10992

10993

10994

10995

10996

</p>

10997

10998

10999

11000

11001

</div>

11002

11003

11004

<p>The size of the file wrapped by FileHTML5. This value is supplied by the instance of File().</p>

11005

</div>

11006

11007

11008

11009

11010

11011

<h4>Fires event <code>sizeChange</code></h4>

11012

11013

<p>

11014

Fires when the value for the configuration attribute <code>size</code> is

11015

changed. You can listen for the event using the <code>on</code> method if you

11016

wish to be notified before the attribute's value has changed, or

11017

using the <code>after</code> method if you wish to be notified after the

11018

attribute's value has changed.

11019

</p>

11020

11021

11022

<h4>Parameters:</h4>

11023

11024

11025

11026

11027

<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>

11028

11029

11030

An Event Facade object with the following

11031

attribute-specific properties added:

11032

</div>

11033

11034

11035

11036

<code class="param-name">prevVal</code>

11037

11038

<div class="param-description">The value of the attribute, prior to it being set.</div>

11039

</li>

11040

11041

<code class="param-name">newVal</code>

11042

11043

<div class="param-description">The value the attribute is to be set to.</div>

11044

</li>

11045

11046

<code class="param-name">attrName</code>

11047

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

11048

<div class="param-description">The name of the attribute being set.</div>

11049

</li>

11050

11051

<code class="param-name">subAttrName</code>

11052

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

11053

<div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div>

11054

</li>

11055

</ul>

11056

</li>

11057

</ul>

11058

</div>

11059

</div>

11060

11061

11062

11063

</div>

11064

11065

11066

11067

11068

11069

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

11070

11071

11072

11073

11074

11075

11076

11077

11078

11079

11080

11081

11082

11083

<p>

11084

11085

Defined in

11086

11087

11088

11089

11090

11091

11092

</p>

11093

11094

11095

11096

11097

</div>

11098

11099

11100

<p>The type of the file wrapped by FileHTML. This value is provided by the instance of File()</p>

11101

</div>

11102

11103

11104

11105

11106

11107

<h4>Fires event <code>typeChange</code></h4>

11108

11109

<p>

11110

Fires when the value for the configuration attribute <code>type</code> is

11111

changed. You can listen for the event using the <code>on</code> method if you

11112

wish to be notified before the attribute's value has changed, or

11113

using the <code>after</code> method if you wish to be notified after the

11114

attribute's value has changed.

11115

</p>

11116

11117

11118

<h4>Parameters:</h4>

11119

11120

11121

11122

11123

<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>

11124

11125

11126

An Event Facade object with the following

11127

attribute-specific properties added:

11128

</div>

11129

11130

11131

11132

<code class="param-name">prevVal</code>

11133

11134

<div class="param-description">The value of the attribute, prior to it being set.</div>

11135

</li>

11136

11137

<code class="param-name">newVal</code>

11138

11139

<div class="param-description">The value the attribute is to be set to.</div>

11140

</li>

11141

11142

<code class="param-name">attrName</code>

11143

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

11144

<div class="param-description">The name of the attribute being set.</div>

11145

</li>

11146

11147

<code class="param-name">subAttrName</code>

11148

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

11149

<div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div>

11150

</li>

11151

</ul>

11152

</li>

11153

</ul>

11154

</div>

11155

</div>

11156

11157

11158

11159

</div>

11160

11161

11162

11163

11164

11165

<span class="type">XMLHttpRequest</span>

11166

11167

11168

11169

11170

11171

11172

11173

11174

11175

11176

11177

11178

11179

<p>

11180

11181

Defined in

11182

11183

11184

11185

11186

11187

11188

</p>

11189

11190

11191

11192

11193

</div>

11194

11195

11196

<p>The pointer to the instance of XMLHttpRequest used by FileHTML5 to upload the file.</p>

11197

</div>

11198

11199

11200

11201

11202

11203

<h4>Fires event <code>xhrChange</code></h4>

11204

11205

<p>

11206

Fires when the value for the configuration attribute <code>xhr</code> is

11207

changed. You can listen for the event using the <code>on</code> method if you

11208

wish to be notified before the attribute's value has changed, or

11209

using the <code>after</code> method if you wish to be notified after the

11210

attribute's value has changed.

11211

</p>

11212

11213

11214

<h4>Parameters:</h4>

11215

11216

11217

11218

11219

<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>

11220

11221

11222

An Event Facade object with the following

11223

attribute-specific properties added:

11224

</div>

11225

11226

11227

11228

<code class="param-name">prevVal</code>

11229

11230

<div class="param-description">The value of the attribute, prior to it being set.</div>

11231

</li>

11232

11233

<code class="param-name">newVal</code>

11234

11235

<div class="param-description">The value the attribute is to be set to.</div>

11236

</li>

11237

11238

<code class="param-name">attrName</code>

11239

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

11240

<div class="param-description">The name of the attribute being set.</div>

11241

</li>

11242

11243

<code class="param-name">subAttrName</code>

11244

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

11245

<div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div>

11246

</li>

11247

</ul>

11248

</li>

11249

</ul>

11250

</div>

11251

</div>

11252

11253

11254

11255

</div>

11256

11257

11258

</div>

11259

11260

11261

11262

11263

<h2 class="off-left">Events</h2>

11264

11265

11266

11267

<h3 class="name"><code>destroy</code></h3>

11268

11269

11270

11271

11272

11273

11274

11275

11276

11277

11278

11279

11280

11281

<p>Inherited from

11282

<a href="../classes/Base.html#event_destroy">Base</a>:

11283

11284

11285

11286

11287

11288

</p>

11289

11290

11291

11292

11293

</div>

11294

11295

11296

<p>

11297

Lifecycle event for the destroy phase,

11298

fired prior to destruction. Invoking the preventDefault

11299

method on the event object provided to subscribers will

11300

prevent destruction from proceeding.

11301

</p>

11302

11303

<p>

11304

Subscribers to the "after" moment of this event, will be notified

11305

after destruction is complete (and as a result cannot prevent

11306

destruction).

11307

</p>

11308

</div>

11309

11310

11311

11312

<h4>Event Payload:</h4>

11313

11314

11315

11316

11317

11318

11319

<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>

11320

11321

11322

11323

11324

11325

<p>Event object</p>

11326

</div>

11327

11328

11329

</li>

11330

11331

</ul>

11332

</div>

11333

11334

11335

11336

11337

</div>

11338

11339

11340

11341

11342

11343

11344

11345

11346

11347

11348

11349

11350

11351

11352

11353

11354

11355

<p>Inherited from

11356

<a href="../classes/Base.html#event_init">Base</a>:

11357

11358

11359

11360

11361

11362

</p>

11363

11364

11365

11366

11367

</div>

11368

11369

11370

<p>

11371

Lifecycle event for the init phase, fired prior to initialization.

11372

Invoking the preventDefault() method on the event object provided

11373

to subscribers will prevent initialization from occuring.

11374

</p>

11375

11376

<p>

11377

Subscribers to the "after" momemt of this event, will be notified

11378

after initialization of the object is complete (and therefore

11379

cannot prevent initialization).

11380

</p>

11381

</div>

11382

11383

11384

11385

<h4>Event Payload:</h4>

11386

11387

11388

11389

11390

11391

11392

<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>

11393

11394

11395

11396

11397

11398

<p>Event object, with a cfg property which

11399

refers to the configuration object passed to the constructor.</p>

11400

</div>

11401

11402

11403

</li>

11404

11405

</ul>

11406

</div>

11407

11408

11409

11410

11411

</div>

11412

11413

11414

11415

<h3 class="name"><code>readystatechange</code></h3>

11416

11417

11418

11419

11420

11421

11422

11423

11424

11425

11426

11427

11428

11429

11430

<p>

11431

11432

Defined in

11433

11434

11435

11436

11437

11438

11439

</p>

11440

11441

11442

11443

11444

</div>

11445

11446

11447

<p>Signals that XMLHttpRequest has fired a readystatechange event.</p>

11448

</div>

11449

11450

11451

11452

<h4>Event Payload:</h4>

11453

11454

11455

11456

11457

11458

<code class="param-name">event</code>

11459

<span class="type"><a href="../classes/Event.html" class="crosslink">Event</a></span>

11460

11461

11462

11463

11464

11465

<p>The event object for the <code>readystatechange</code> with the

11466

following payload:

11467

<dl>

11468

<dt>readyState</dt>

11469

<dd>The readyState code reported by the XMLHttpRequest instance.</dd>

11470

<dt>originEvent</dt>

11471

<dd>The original event fired by the XMLHttpRequest instance.</dd>

11472

</dl></p>

11473

</div>

11474

11475

11476

</li>

11477

11478

</ul>

11479

</div>

11480

11481

11482

11483

11484

</div>

11485

11486

11487

11488

<h3 class="name"><code>uploadcancel</code></h3>

11489

11490

11491

11492

11493

11494

11495

11496

11497

11498

11499

11500

11501

11502

11503

<p>

11504

11505

Defined in

11506

11507

11508

11509

11510

11511

11512

</p>

11513

11514

11515

11516

11517

</div>

11518

11519

11520

<p>Signals that this file's upload has been cancelled.</p>

11521

</div>

11522

11523

11524

11525

<h4>Event Payload:</h4>

11526

11527

11528

11529

11530

11531

<code class="param-name">event</code>

11532

<span class="type"><a href="../classes/Event.html" class="crosslink">Event</a></span>

11533

11534

11535

11536

11537

11538

<p>The event object for the <code>uploadcancel</code> with the

11539

following payload:

11540

<dl>

11541

<dt>originEvent</dt>

11542

<dd>The original event fired by the XMLHttpRequest instance.</dd>

11543

</dl></p>

11544

</div>

11545

11546

11547

</li>

11548

11549

</ul>

11550

</div>

11551

11552

11553

11554

11555

</div>

11556

11557

11558

11559

<h3 class="name"><code>uploadcomplete</code></h3>

11560

11561

11562

11563

11564

11565

11566

11567

11568

11569

11570

11571

11572

11573

11574

<p>

11575

11576

Defined in

11577

11578

11579

11580

11581

11582

11583

</p>

11584

11585

11586

11587

11588

</div>

11589

11590

11591

<p>Signals that this file's upload has completed and data has been received from the server.</p>

11592

</div>

11593

11594

11595

11596

<h4>Event Payload:</h4>

11597

11598

11599

11600

11601

11602

<code class="param-name">event</code>

11603

<span class="type"><a href="../classes/Event.html" class="crosslink">Event</a></span>

11604

11605

11606

11607

11608

11609

<p>The event object for the <code>uploadcomplete</code> with the

11610

following payload:

11611

<dl>

11612

<dt>originEvent</dt>

11613

<dd>The original event fired by the XMLHttpRequest instance.</dd>

11614

11615

<dd>The data returned by the server.</dd>

11616

</dl></p>

11617

</div>

11618

11619

11620

</li>

11621

11622

</ul>

11623

</div>

11624

11625

11626

11627

11628

</div>

11629

11630

11631

11632

<h3 class="name"><code>uploaderror</code></h3>

11633

11634

11635

11636

11637

11638

11639

11640

11641

11642

11643

11644

11645

11646

11647

<p>

11648

11649

Defined in

11650

11651

11652

11653

11654

11655

11656

</p>

11657

11658

11659

11660

11661

</div>

11662

11663

11664

<p>Signals that this file's upload has encountered an error.</p>

11665

</div>

11666

11667

11668

11669

<h4>Event Payload:</h4>

11670

11671

11672

11673

11674

11675

<code class="param-name">event</code>

11676

<span class="type"><a href="../classes/Event.html" class="crosslink">Event</a></span>

11677

11678

11679

11680

11681

11682

<p>The event object for the <code>uploaderror</code> with the

11683

following payload:

11684

<dl>

11685

<dt>originEvent</dt>

11686

<dd>The original event fired by the XMLHttpRequest instance.</dd>

11687

<dt>status</dt>

11688

<dd>The status code reported by the XMLHttpRequest</dd>

11689

<dt>statusText</dt>

11690

<dd>The text of the error event reported by the XMLHttpRequest instance</dd>

11691

</dl></p>

11692

</div>

11693

11694

11695

</li>

11696

11697

</ul>

11698

</div>

11699

11700

11701

11702

11703

</div>

11704

11705

11706

11707

<h3 class="name"><code>uploadprogress</code></h3>

11708

11709

11710

11711

11712

11713

11714

11715

11716

11717

11718

11719

11720

11721

11722

<p>

11723

11724

Defined in

11725

11726

11727

11728

11729

11730

11731

</p>

11732

11733

11734

11735

11736

</div>

11737

11738

11739

<p>Signals that progress has been made on the upload of this file.</p>

11740

</div>

11741

11742

11743

11744

<h4>Event Payload:</h4>

11745

11746

11747

11748

11749

11750

<code class="param-name">event</code>

11751

<span class="type"><a href="../classes/Event.html" class="crosslink">Event</a></span>

11752

11753

11754

11755

11756

11757

<p>The event object for the <code>uploadprogress</code> with the

11758

following payload:

11759

<dl>

11760

<dt>originEvent</dt>

11761

<dd>The original event fired by the XMLHttpRequest instance.</dd>

11762

<dt>bytesLoaded</dt>

11763

<dd>The number of bytes of the file that has been uploaded.</dd>

11764

<dt>bytesTotal</dt>

11765

<dd>The total number of bytes in the file (the file size)</dd>

11766

<dt>percentLoaded</dt>

11767

<dd>The fraction of the file that has been uploaded, out of 100.</dd>

11768

</dl></p>

11769

</div>

11770

11771

11772

</li>

11773

11774

</ul>

11775

</div>

11776

11777

11778

11779

11780

</div>

11781

11782

11783

11784

<h3 class="name"><code>uploadstart</code></h3>

11785

11786

11787

11788

11789

11790

11791

11792

11793

11794

11795

11796

11797

11798

11799

<p>

11800

11801

Defined in

11802

11803

11804

11805

11806

11807

11808

</p>

11809

11810

11811

11812

11813

</div>

11814

11815

11816

<p>Signals that this file's upload has started.</p>

11817

</div>

11818

11819

11820

11821

<h4>Event Payload:</h4>

11822

11823

11824

11825

11826

11827

<code class="param-name">event</code>

11828

<span class="type"><a href="../classes/Event.html" class="crosslink">Event</a></span>

11829

11830

11831

11832

11833

11834

<p>The event object for the <code>uploadstart</code> with the

11835

following payload:

11836

<dl>

11837

11838

<dd>The XMLHttpRequest instance handling the file upload.</dd>

11839

</dl></p>

11840

</div>

11841

11842

11843

</li>

11844

11845

</ul>

11846

</div>

11847

11848

11849

11850

11851

</div>

11852

11853

11854

</div>

11855

11856

</div>

11857

</div>

11858

11859

</div>

11860

</div>

11861

</div>

11862

</div>

11863

</div>

11864

</div>

11865

11866

11867

11868

11869

11870

11871

11872

11873

</body>

11874

</html>

Older »