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

2025

2026

2027

2028

2029

2030

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

2031

</div>

2032

2033

2034

</li>

2035

2036

2037

2038

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

2039

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

2040

2041

2042

2043

2044

2045

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

2046

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

2047

</div>

2048

2049

2050

</li>

2051

2052

2053

2054

2055

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

2056

2057

2058

2059

2060

2061

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

2062

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

2063

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

2064

</div>

2065

2066

2067

</li>

2068

2069

</ul>

2070

</div>

2071

2072

2073

2074

2075

2076

</div>

2077

2078

2079

2080

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

2081

2082

2083

2084

2085

2086

2087

2088

2089

2090

</li>

2091

2092

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

2093

</div>

2094

2095

2096

2097

2098

2099

2100

2101

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

2102

2103

2104

2105

2106

2107

2108

2109

2110

2111

2112

2113

<p>Inherited from

2114

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

2115

2116

2117

2118

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

2119

2120

</p>

2121

2122

2123

2124

2125

2126

</div>

2127

2128

2129

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

2130

</div>

2131

2132

2133

2134

<h4>Parameters:</h4>

2135

2136

2137

2138

2139

2140

2141

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

2142

2143

2144

2145

2146

2147

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

2148

</div>

2149

2150

2151

</li>

2152

2153

</ul>

2154

</div>

2155

2156

2157

2158

2159

2160

</div>

2161

2162

2163

2164

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

2165

2166

2167

2168

2169

2170

2171

2172

<code>allAttrs</code>

2173

2174

</li>

2175

2176

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

2177

</div>

2178

2179

2180

2181

2182

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

2183

</span>

2184

2185

2186

2187

2188

2189

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

2190

2191

2192

2193

2194

2195

2196

2197

2198

2199

2200

2201

<p>Inherited from

2202

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

2203

2204

2205

2206

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

2207

2208

</p>

2209

2210

2211

2212

2213

2214

</div>

2215

2216

2217

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

2218

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

2219

2220

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

2221

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

2222

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

2223

</div>

2224

2225

2226

2227

<h4>Parameters:</h4>

2228

2229

2230

2231

2232

2233

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

2234

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

2235

2236

2237

2238

2239

2240

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

2241

(subclass first, Base last)</p>

2242

</div>

2243

2244

2245

</li>

2246

2247

</ul>

2248

</div>

2249

2250

2251

2252

2253

<h4>Returns:</h4>

2254

2255

2256

2257

2258

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

2259

2260

The aggregate set of ATTRS definitions for the instance

2261

2262

</div>

2263

</div>

2264

2265

2266

2267

</div>

2268

2269

2270

2271

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

2272

2273

2274

2275

2276

2277

2278

2279

2280

2281

2282

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

2283

2284

2285

2286

2287

2288

2289

2290

2291

2292

2293

<p>Inherited from

2294

2295

BaseCore

2296

</a>

2297

2298

but overwritten in

2299

2300

2301

2302

2303

2304

</p>

2305

2306

2307

2308

2309

2310

</div>

2311

2312

2313

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

2314

this class.</p>

2315

</div>

2316

2317

2318

2319

2320

2321

2322

</div>

2323

2324

2325

2326

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

2327

2328

2329

2330

2331

2332

2333

2334

2335

2336

2337

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

2338

2339

2340

2341

2342

2343

2344

2345

2346

2347

2348

2349

<p>Inherited from

2350

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

2351

2352

2353

2354

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

2355

2356

</p>

2357

2358

2359

2360

2361

2362

</div>

2363

2364

2365

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

2366

</div>

2367

2368

2369

2370

2371

2372

2373

</div>

2374

2375

2376

2377

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

2378

2379

2380

2381

2382

2383

2384

2385

2386

2387

2388

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

2389

2390

2391

2392

2393

2394

2395

2396

2397

2398

2399

2400

<p>Inherited from

2401

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

2402

2403

2404

2405

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

2406

2407

</p>

2408

2409

2410

2411

2412

2413

</div>

2414

2415

2416

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

2417

</div>

2418

2419

2420

2421

2422

2423

2424

</div>

2425

2426

2427

2428

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

2429

2430

2431

2432

2433

2434

2435

2436

2437

2438

</li>

2439

2440

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

2441

</div>

2442

2443

2444

2445

2446

2447

2448

2449

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

2450

2451

2452

2453

2454

2455

2456

2457

2458

2459

2460

2461

<p>Inherited from

2462

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

2463

2464

2465

2466

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

2467

2468

</p>

2469

2470

2471

2472

2473

2474

</div>

2475

2476

2477

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

2478

</div>

2479

2480

2481

2482

<h4>Parameters:</h4>

2483

2484

2485

2486

2487

2488

2489

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

2490

2491

2492

2493

2494

2495

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

2496

</div>

2497

2498

2499

</li>

2500

2501

</ul>

2502

</div>

2503

2504

2505

2506

2507

2508

</div>

2509

2510

2511

2512

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

2513

2514

2515

2516

2517

2518

2519

2520

2521

2522

</li>

2523

2524

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

2525

</div>

2526

2527

2528

2529

2530

2531

2532

2533

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

2534

2535

2536

2537

2538

2539

2540

2541

2542

2543

2544

2545

<p>Inherited from

2546

<a href="../classes/DataSource.Local.html#method__defDataFn">DataSource.Local</a>:

2547

2548

2549

2550

<a href="../files/datasource_js_datasource-local.js.html#l279"><code>datasource/js/datasource-local.js:279</code></a>

2551

2552

</p>

2553

2554

2555

2556

2557

2558

</div>

2559

2560

2561

<p>Normalizes raw data into a response that includes results and meta properties.</p>

2562

</div>

2563

2564

2565

2566

<h4>Parameters:</h4>

2567

2568

2569

2570

2571

2572

2573

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

2574

2575

2576

2577

2578

2579

<p>Event Facade with the following properties:</p>

2580

2581

<dl>

2582

<dt>tId (Number)</dt> <dd>Unique transaction ID.</dd>

2583

<dt>request (Object)</dt> <dd>The request.</dd>

2584

<dt>callback (Object)</dt> <dd>Deprecated alias for the

2585

<strong>on</strong> property</dd>

2586

<dt>on (Object)</dt> <dd>The map of configured transaction

2587

callbacks. An object with the following properties:

2588

<dl>

2589

<dt>success (Function)</dt> <dd>Success handler.</dd>

2590

<dt>failure (Function)</dt> <dd>Failure handler.</dd>

2591

</dl>

2592

</dd>

2593

<dt>cfg (Object)</dt> <dd>Configuration object.</dd>

2594

<dt>data (Object)</dt> <dd>Raw data.</dd>

2595

</dl>

2596

</div>

2597

2598

2599

</li>

2600

2601

</ul>

2602

</div>

2603

2604

2605

2606

2607

2608

</div>

2609

2610

2611

2612

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

2613

2614

2615

2616

2617

2618

2619

2620

2621

2622

</li>

2623

2624

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

2625

</div>

2626

2627

2628

2629

2630

2631

2632

2633

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

2634

2635

2636

2637

2638

2639

2640

2641

2642

2643

2644

2645

<p>Inherited from

2646

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

2647

2648

2649

2650

2651

2652

</p>

2653

2654

2655

2656

2657

2658

</div>

2659

2660

2661

<p>Default destroy event handler</p>

2662

</div>

2663

2664

2665

2666

<h4>Parameters:</h4>

2667

2668

2669

2670

2671

2672

2673

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

2674

2675

2676

2677

2678

2679

<p>Event object</p>

2680

</div>

2681

2682

2683

</li>

2684

2685

</ul>

2686

</div>

2687

2688

2689

2690

2691

2692

</div>

2693

2694

2695

2696

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

2697

2698

2699

2700

2701

2702

2703

2704

2705

2706

</li>

2707

2708

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

2709

</div>

2710

2711

2712

2713

2714

2715

2716

2717

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

2718

2719

2720

2721

2722

2723

2724

2725

2726

2727

2728

2729

<p>Inherited from

2730

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

2731

2732

2733

2734

2735

2736

</p>

2737

2738

2739

2740

2741

2742

</div>

2743

2744

2745

<p>Default init event handler</p>

2746

</div>

2747

2748

2749

2750

<h4>Parameters:</h4>

2751

2752

2753

2754

2755

2756

2757

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

2758

2759

2760

2761

2762

2763

<p>Event object, with a cfg property which

2764

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

2765

</div>

2766

2767

2768

</li>

2769

2770

</ul>

2771

</div>

2772

2773

2774

2775

2776

2777

</div>

2778

2779

2780

2781

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

2782

2783

2784

2785

2786

2787

2788

2789

2790

2791

</li>

2792

2793

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

2794

</div>

2795

2796

2797

2798

2799

2800

2801

2802

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

2803

2804

2805

2806

2807

2808

2809

2810

2811

2812

2813

2814

<p>Inherited from

2815

<a href="../classes/DataSource.Local.html#method__defRequestFn">DataSource.Local</a>:

2816

2817

2818

2819

<a href="../files/datasource_js_datasource-local.js.html#l240"><code>datasource/js/datasource-local.js:240</code></a>

2820

2821

</p>

2822

2823

2824

2825

2826

2827

</div>

2828

2829

2830

<p>Manages request/response transaction. Must fire <code>response</code>

2831

event when response is received. This method should be implemented by

2832

subclasses to achieve more complex behavior such as accessing remote data.</p>

2833

</div>

2834

2835

2836

2837

<h4>Parameters:</h4>

2838

2839

2840

2841

2842

2843

2844

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

2845

2846

2847

2848

2849

2850

<p>Event Facadewith the following properties:</p>

2851

2852

<dl>

2853

<dt>tId (Number)</dt> <dd>Unique transaction ID.</dd>

2854

<dt>request (Object)</dt> <dd>The request.</dd>

2855

<dt>callback (Object)</dt> <dd>Deprecated alias for the

2856

<strong>on</strong> property</dd>

2857

<dt>on (Object)</dt> <dd>The map of configured transaction

2858

callbacks. An object with the following properties:

2859

<dl>

2860

<dt>success (Function)</dt> <dd>Success handler.</dd>

2861

<dt>failure (Function)</dt> <dd>Failure handler.</dd>

2862

</dl>

2863

</dd>

2864

<dt>cfg (Object)</dt> <dd>Configuration object.</dd>

2865

</dl>

2866

</div>

2867

2868

2869

</li>

2870

2871

</ul>

2872

</div>

2873

2874

2875

2876

2877

2878

</div>

2879

2880

2881

2882

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

2883

2884

2885

2886

2887

2888

2889

2890

2891

2892

</li>

2893

2894

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

2895

</div>

2896

2897

2898

2899

2900

2901

2902

2903

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

2904

2905

2906

2907

2908

2909

2910

2911

2912

2913

2914

2915

<p>Inherited from

2916

<a href="../classes/DataSource.Local.html#method__defResponseFn">DataSource.Local</a>:

2917

2918

2919

2920

<a href="../files/datasource_js_datasource-local.js.html#l314"><code>datasource/js/datasource-local.js:314</code></a>

2921

2922

</p>

2923

2924

2925

2926

2927

2928

</div>

2929

2930

2931

<p>Sends data as a normalized response to callback.</p>

2932

</div>

2933

2934

2935

2936

<h4>Parameters:</h4>

2937

2938

2939

2940

2941

2942

2943

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

2944

2945

2946

2947

2948

2949

<p>Event Facade with the following properties:</p>

2950

2951

<dl>

2952

<dt>tId (Number)</dt> <dd>Unique transaction ID.</dd>

2953

<dt>request (Object)</dt> <dd>The request.</dd>

2954

<dt>callback (Object)</dt> <dd>Deprecated alias for the

2955

<strong>on</strong> property</dd>

2956

<dt>on (Object)</dt> <dd>The map of configured transaction

2957

callbacks. An object with the following properties:

2958

<dl>

2959

<dt>success (Function)</dt> <dd>Success handler.</dd>

2960

<dt>failure (Function)</dt> <dd>Failure handler.</dd>

2961

</dl>

2962

</dd>

2963

<dt>cfg (Object)</dt> <dd>Configuration object.</dd>

2964

<dt>data (Object)</dt> <dd>Raw data.</dd>

2965

<dt>response (Object)</dt> <dd>Normalized response object with the following properties:

2966

<dl>

2967

<dt>results (Object)</dt> <dd>Parsed results.</dd>

2968

<dt>meta (Object)</dt> <dd>Parsed meta data.</dd>

2969

<dt>error (Boolean)</dt> <dd>Error flag.</dd>

2970

</dl>

2971

</dd>

2972

</dl>

2973

</div>

2974

2975

2976

</li>

2977

2978

</ul>

2979

</div>

2980

2981

2982

2983

2984

2985

</div>

2986

2987

2988

2989

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

2990

2991

2992

2993

2994

2995

2996

2997

2998

2999

3000

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

3001

3002

3003

3004

3005

3006

3007

3008

3009

3010

3011

3012

<p>Inherited from

3013

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

3014

3015

3016

3017

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

3018

3019

</p>

3020

3021

3022

3023

3024

3025

</div>

3026

3027

3028

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

3029

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

3030

</div>

3031

3032

3033

3034

3035

3036

3037

</div>

3038

3039

3040

3041

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

3042

3043

3044

3045

3046

3047

3048

3049

<code>allAttrs</code>

3050

3051

</li>

3052

3053

3054

3055

<code>userVals</code>

3056

3057

</li>

3058

3059

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

3060

</div>

3061

3062

3063

3064

3065

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

3066

</span>

3067

3068

3069

3070

3071

3072

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

3073

3074

3075

3076

3077

3078

3079

3080

3081

3082

3083

3084

<p>Inherited from

3085

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

3086

3087

3088

3089

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

3090

3091

</p>

3092

3093

3094

3095

3096

3097

</div>

3098

3099

3100

3101

</div>

3102

3103

3104

3105

<h4>Parameters:</h4>

3106

3107

3108

3109

3110

3111

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

3112

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

3113

3114

3115

3116

3117

3118

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

3119

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

3120

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

3121

</div>

3122

3123

3124

</li>

3125

3126

3127

3128

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

3129

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

3130

3131

3132

3133

3134

3135

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

3136

</div>

3137

3138

3139

</li>

3140

3141

</ul>

3142

</div>

3143

3144

3145

3146

3147

<h4>Returns:</h4>

3148

3149

3150

3151

3152

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

3153

3154

The set of adhoc attributes passed in, in the form

3155

of an object with attribute name/configuration pairs.

3156

3157

</div>

3158

</div>

3159

3160

3161

3162

</div>

3163

3164

3165

3166

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

3167

3168

3169

3170

3171

3172

3173

3174

<code>clazz</code>

3175

3176

</li>

3177

3178

3179

3180

<code>allCfgs</code>

3181

3182

</li>

3183

3184

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

3185

</div>

3186

3187

3188

3189

3190

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

3191

</span>

3192

3193

3194

3195

3196

3197

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

3198

3199

3200

3201

3202

3203

3204

3205

3206

3207

3208

3209

<p>Inherited from

3210

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

3211

3212

3213

3214

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

3215

3216

</p>

3217

3218

3219

3220

3221

3222

</div>

3223

3224

3225

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

3226

initialization. Returns a disposable object with the attributes defined for

3227

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

3228

</div>

3229

3230

3231

3232

<h4>Parameters:</h4>

3233

3234

3235

3236

3237

3238

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

3239

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

3240

3241

3242

3243

3244

3245

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

3246

</div>

3247

3248

3249

</li>

3250

3251

3252

3253

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

3254

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

3255

3256

3257

3258

3259

3260

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

3261

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

3262

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

3263

</div>

3264

3265

3266

</li>

3267

3268

</ul>

3269

</div>

3270

3271

3272

3273

3274

<h4>Returns:</h4>

3275

3276

3277

3278

3279

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

3280

3281

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

3282

of an object with attribute name/configuration pairs.

3283

3284

</div>

3285

</div>

3286

3287

3288

3289

</div>

3290

3291

3292

3293

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

3294

3295

3296

3297

3298

3299

3300

3301

<code>attrName</code>

3302

3303

</li>

3304

3305

3306

3307

<code>subAttrName</code>

3308

3309

</li>

3310

3311

3312

3313

<code>currVal</code>

3314

3315

</li>

3316

3317

3318

3319

<code>newVal</code>

3320

3321

</li>

3322

3323

3324

3325

3326

3327

</li>

3328

3329

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

3330

</div>

3331

3332

3333

3334

3335

3336

3337

3338

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

3339

3340

3341

3342

3343

3344

3345

3346

3347

3348

3349

3350

<p>Inherited from

3351

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

3352

3353

3354

3355

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

3356

3357

</p>

3358

3359

3360

3361

3362

3363

</div>

3364

3365

3366

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

3367

</div>

3368

3369

3370

3371

<h4>Parameters:</h4>

3372

3373

3374

3375

3376

3377

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

3378

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

3379

3380

3381

3382

3383

3384

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

3385

</div>

3386

3387

3388

</li>

3389

3390

3391

3392

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

3393

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

3394

3395

3396

3397

3398

3399

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

3400

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

3401

</div>

3402

3403

3404

</li>

3405

3406

3407

3408

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

3409

3410

3411

3412

3413

3414

3415

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

3416

</div>

3417

3418

3419

</li>

3420

3421

3422

3423

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

3424

3425

3426

3427

3428

3429

3430

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

3431

</div>

3432

3433

3434

</li>

3435

3436

3437

3438

3439

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

3440

3441

3442

3443

3444

3445

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

3446

</div>

3447

3448

3449

</li>

3450

3451

</ul>

3452

</div>

3453

3454

3455

3456

3457

3458

</div>

3459

3460

3461

3462

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

3463

3464

3465

3466

3467

3468

3469

3470

3471

3472

</li>

3473

3474

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

3475

</div>

3476

3477

3478

3479

3480

3481

</span>

3482

3483

3484

3485

3486

3487

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

3488

3489

3490

3491

3492

3493

3494

3495

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

3496

3497

3498

3499

3500

3501

<p>Inherited from

3502

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

3503

3504

3505

3506

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

3507

3508

</p>

3509

3510

3511

3512

3513

3514

</div>

3515

3516

3517

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

3518

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

3519

3520

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

3521

</div>

3522

3523

3524

3525

<h4>Parameters:</h4>

3526

3527

3528

3529

3530

3531

3532

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

3533

3534

3535

3536

3537

3538

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

3539

</div>

3540

3541

3542

</li>

3543

3544

</ul>

3545

</div>

3546

3547

3548

3549

3550

<h4>Returns:</h4>

3551

3552

3553

3554

3555

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

3556

3557

The value of the attribute.

3558

3559

</div>

3560

</div>

3561

3562

3563

3564

</div>

3565

3566

3567

3568

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

3569

3570

3571

3572

3573

3574

3575

3576

3577

3578

</li>

3579

3580

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

3581

</div>

3582

3583

3584

3585

3586

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

3587

</span>

3588

3589

3590

3591

3592

3593

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

3594

3595

3596

3597

3598

3599

3600

3601

3602

3603

3604

3605

<p>Inherited from

3606

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

3607

3608

3609

3610

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

3611

3612

</p>

3613

3614

3615

3616

3617

3618

</div>

3619

3620

3621

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

3622

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

3623

configuration properties for all attributes.</p>

3624

</div>

3625

3626

3627

3628

<h4>Parameters:</h4>

3629

3630

3631

3632

3633

3634

3635

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

3636

3637

3638

3639

3640

3641

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

3642

</div>

3643

3644

3645

</li>

3646

3647

</ul>

3648

</div>

3649

3650

3651

3652

3653

<h4>Returns:</h4>

3654

3655

3656

3657

3658

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

3659

3660

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

3661

3662

</div>

3663

</div>

3664

3665

3666

3667

</div>

3668

3669

3670

3671

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

3672

3673

3674

3675

3676

3677

3678

3679

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

3680

</span>

3681

3682

3683

3684

3685

3686

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

3687

3688

3689

3690

3691

3692

3693

3694

3695

3696

3697

3698

<p>Inherited from

3699

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

3700

3701

3702

3703

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

3704

3705

</p>

3706

3707

3708

3709

3710

3711

</div>

3712

3713

3714

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

3715

the class hierarchy.</p>

3716

</div>

3717

3718

3719

3720

3721

3722

<h4>Returns:</h4>

3723

3724

3725

3726

3727

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

3728

3729

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

3730

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

3731

the cached value.

3732

3733

</div>

3734

</div>

3735

3736

3737

3738

</div>

3739

3740

3741

3742

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

3743

3744

3745

3746

3747

3748

3749

3750

3751

3752

</li>

3753

3754

3755

3756

3757

3758

</li>

3759

3760

3761

3762

<code>initValues</code>

3763

3764

</li>

3765

3766

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

3767

</div>

3768

3769

3770

3771

3772

3773

</span>

3774

3775

3776

3777

3778

3779

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

3780

3781

3782

3783

3784

3785

3786

3787

3788

3789

3790

<p>Inherited from

3791

3792

Attribute

3793

</a>

3794

3795

but overwritten in

3796

3797

3798

3799

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

3800

3801

</p>

3802

3803

3804

3805

3806

3807

</div>

3808

3809

3810

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

3811

either the default configuration provided, or the

3812

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

3813

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

3814

</div>

3815

3816

3817

3818

<h4>Parameters:</h4>

3819

3820

3821

3822

3823

3824

3825

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

3826

3827

3828

3829

3830

3831

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

3832

</div>

3833

3834

3835

</li>

3836

3837

3838

3839

3840

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

3841

3842

3843

3844

3845

3846

<p>The attribute configuration object</p>

3847

</div>

3848

3849

3850

</li>

3851

3852

3853

3854

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

3855

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

3856

3857

3858

3859

3860

3861

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

3862

</div>

3863

3864

3865

</li>

3866

3867

</ul>

3868

</div>

3869

3870

3871

3872

3873

<h4>Returns:</h4>

3874

3875

3876

3877

3878

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

3879

3880

The initial value of the attribute.

3881

3882

</div>

3883

</div>

3884

3885

3886

3887

</div>

3888

3889

3890

3891

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

3892

3893

3894

3895

3896

3897

3898

3899

<code>attrs</code>

3900

3901

</li>

3902

3903

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

3904

</div>

3905

3906

3907

3908

3909

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

3910

</span>

3911

3912

3913

3914

3915

3916

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

3917

3918

3919

3920

3921

3922

3923

3924

3925

3926

3927

3928

<p>Inherited from

3929

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

3930

3931

3932

3933

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

3934

3935

</p>

3936

3937

3938

3939

3940

3941

</div>

3942

3943

3944

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

3945

</div>

3946

3947

3948

3949

<h4>Parameters:</h4>

3950

3951

3952

3953

3954

3955

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

3956

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

3957

3958

3959

3960

3961

3962

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

3963

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

3964

</div>

3965

3966

3967

</li>

3968

3969

</ul>

3970

</div>

3971

3972

3973

3974

3975

<h4>Returns:</h4>

3976

3977

3978

3979

3980

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

3981

3982

An object with attribute name/value pairs.

3983

3984

</div>

3985

</div>

3986

3987

3988

3989

</div>

3990

3991

3992

3993

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

3994

3995

3996

3997

3998

3999

4000

4001

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

4002

</span>

4003

4004

4005

4006

4007

4008

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

4009

4010

4011

4012

4013

4014

4015

4016

4017

4018

4019

4020

<p>Inherited from

4021

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

4022

4023

4024

4025

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

4026

4027

</p>

4028

4029

4030

4031

4032

4033

</div>

4034

4035

4036

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

4037

</div>

4038

4039

4040

4041

4042

4043

<h4>Returns:</h4>

4044

4045

4046

4047

4048

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

4049

4050

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

4051

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

4052

cached value.

4053

4054

</div>

4055

</div>

4056

4057

4058

4059

</div>

4060

4061

4062

4063

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

4064

4065

4066

4067

4068

4069

4070

4071

4072

4073

</li>

4074

4075

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

4076

</div>

4077

4078

4079

4080

4081

4082

</span>

4083

4084

4085

4086

4087

4088

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

4089

4090

4091

4092

4093

4094

4095

4096

4097

4098

4099

4100

<p>Inherited from

4101

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

4102

4103

4104

4105

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

4106

4107

</p>

4108

4109

4110

4111

4112

4113

</div>

4114

4115

4116

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

4117

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

4118

</div>

4119

4120

4121

4122

<h4>Parameters:</h4>

4123

4124

4125

4126

4127

4128

4129

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

4130

4131

4132

4133

4134

4135

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

4136

</div>

4137

4138

4139

</li>

4140

4141

</ul>

4142

</div>

4143

4144

4145

4146

4147

<h4>Returns:</h4>

4148

4149

4150

4151

4152

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

4153

4154

The stored value of the attribute

4155

4156

</div>

4157

</div>

4158

4159

4160

4161

</div>

4162

4163

4164

4165

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

4166

4167

4168

4169

4170

4171

4172

4173

4174

4175

4176

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

4177

4178

4179

4180

4181

4182

4183

4184

4185

4186

4187

4188

<p>Inherited from

4189

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

4190

4191

4192

4193

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

4194

4195

</p>

4196

4197

4198

4199

4200

4201

</div>

4202

4203

4204

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

4205

event type is not prefixed, the instance prefix is

4206

applied to the supplied type.</p>

4207

</div>

4208

4209

4210

4211

4212

4213

4214

</div>

4215

4216

4217

4218

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

4219

4220

4221

4222

4223

4224

4225

4226

<code>attrs</code>

4227

4228

</li>

4229

4230

4231

4232

<code>values</code>

4233

4234

</li>

4235

4236

4237

4238

4239

4240

</li>

4241

4242

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

4243

</div>

4244

4245

4246

4247

4248

4249

4250

4251

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

4252

4253

4254

4255

4256

4257

4258

4259

4260

4261

4262

4263

<p>Inherited from

4264

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

4265

4266

4267

4268

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

4269

4270

</p>

4271

4272

4273

4274

4275

4276

</div>

4277

4278

4279

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

4280

constructor.</p>

4281

</div>

4282

4283

4284

4285

<h4>Parameters:</h4>

4286

4287

4288

4289

4290

4291

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

4292

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

4293

4294

4295

4296

4297

4298

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

4299

</div>

4300

4301

4302

</li>

4303

4304

4305

4306

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

4307

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

4308

4309

4310

4311

4312

4313

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

4314

</div>

4315

4316

4317

</li>

4318

4319

4320

4321

4322

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

4323

4324

4325

4326

4327

4328

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

4329

</div>

4330

4331

4332

</li>

4333

4334

</ul>

4335

</div>

4336

4337

4338

4339

4340

4341

</div>

4342

4343

4344

4345

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

4346

4347

4348

4349

4350

4351

4352

4353

4354

4355

4356

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

4357

4358

4359

4360

4361

4362

4363

4364

4365

4366

4367

<p>Inherited from

4368

4369

BaseCore

4370

</a>

4371

4372

but overwritten in

4373

4374

4375

4376

4377

4378

</p>

4379

4380

4381

4382

4383

4384

</div>

4385

4386

4387

<p>Initializes Attribute</p>

4388

</div>

4389

4390

4391

4392

4393

4394

4395

</div>

4396

4397

4398

4399

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

4400

4401

4402

4403

4404

4405

4406

4407

<code>attrs</code>

4408

4409

</li>

4410

4411

4412

4413

<code>values</code>

4414

4415

</li>

4416

4417

4418

4419

4420

4421

</li>

4422

4423

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

4424

</div>

4425

4426

4427

4428

4429

4430

4431

4432

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

4433

4434

4435

4436

4437

4438

4439

4440

4441

4442

4443

4444

<p>Inherited from

4445

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

4446

4447

4448

4449

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

4450

4451

</p>

4452

4453

4454

4455

4456

4457

</div>

4458

4459

4460

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

4461

</div>

4462

4463

4464

4465

<h4>Parameters:</h4>

4466

4467

4468

4469

4470

4471

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

4472

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

4473

4474

4475

4476

4477

4478

4479

</div>

4480

4481

4482

</li>

4483

4484

4485

4486

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

4487

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

4488

4489

4490

4491

4492

4493

4494

</div>

4495

4496

4497

</li>

4498

4499

4500

4501

4502

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

4503

4504

4505

4506

4507

4508

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

4509

</div>

4510

4511

4512

</li>

4513

4514

</ul>

4515

</div>

4516

4517

4518

4519

4520

4521

</div>

4522

4523

4524

4525

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

4526

4527

4528

4529

4530

4531

4532

4533

<code>config</code>

4534

4535

</li>

4536

4537

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

4538

</div>

4539

4540

4541

4542

4543

4544

4545

4546

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

4547

4548

4549

4550

4551

4552

4553

4554

4555

4556

4557

<p>Inherited from

4558

4559

BaseCore

4560

</a>

4561

4562

but overwritten in

4563

4564

4565

4566

4567

4568

</p>

4569

4570

4571

4572

4573

4574

</div>

4575

4576

4577

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

4578

</div>

4579

4580

4581

4582

<h4>Parameters:</h4>

4583

4584

4585

4586

4587

4588

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

4589

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

4590

4591

4592

4593

4594

4595

<p>The constructor configuration object</p>

4596

</div>

4597

4598

4599

</li>

4600

4601

</ul>

4602

</div>

4603

4604

4605

4606

4607

4608

</div>

4609

4610

4611

4612

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

4613

4614

4615

4616

4617

4618

4619

4620

4621

4622

4623

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

4624

4625

4626

4627

4628

4629

4630

4631

4632

4633

4634

4635

<p>Inherited from

4636

<a href="../classes/DataSource.Local.html#method__initEvents">DataSource.Local</a>:

4637

4638

4639

4640

<a href="../files/datasource_js_datasource-local.js.html#l124"><code>datasource/js/datasource-local.js:124</code></a>

4641

4642

</p>

4643

4644

4645

4646

4647

4648

</div>

4649

4650

4651

<p>This method creates all the events for this module.</p>

4652

</div>

4653

4654

4655

4656

4657

4658

4659

</div>

4660

4661

4662

4663

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

4664

4665

4666

4667

4668

4669

4670

4671

<code>userVals</code>

4672

4673

</li>

4674

4675

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

4676

</div>

4677

4678

4679

4680

4681

4682

4683

4684

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

4685

4686

4687

4688

4689

4690

4691

4692

4693

4694

4695

4696

<p>Inherited from

4697

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

4698

4699

4700

4701

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

4702

4703

</p>

4704

4705

4706

4707

4708

4709

</div>

4710

4711

4712

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

4713

initializing attributes for each class defined in the class's

4714

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

4715

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

4716

</div>

4717

4718

4719

4720

<h4>Parameters:</h4>

4721

4722

4723

4724

4725

4726

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

4727

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

4728

4729

4730

4731

4732

4733

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

4734

</div>

4735

4736

4737

</li>

4738

4739

</ul>

4740

</div>

4741

4742

4743

4744

4745

4746

</div>

4747

4748

4749

4750

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

4751

4752

4753

4754

4755

4756

4757

4758

4759

4760

4761

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

4762

4763

4764

4765

4766

4767

4768

4769

4770

4771

4772

4773

<p>Inherited from

4774

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

4775

4776

4777

4778

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

4779

4780

</p>

4781

4782

4783

4784

4785

4786

</div>

4787

4788

4789

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

4790

the array of classes and aggregate set of attribute configurations

4791

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

4792

</div>

4793

4794

4795

4796

4797

4798

4799

</div>

4800

4801

4802

4803

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

4804

4805

4806

4807

4808

4809

4810

4811

4812

4813

</li>

4814

4815

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

4816

</div>

4817

4818

4819

4820

4821

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

4822

</span>

4823

4824

4825

4826

4827

4828

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

4829

4830

4831

4832

4833

4834

4835

4836

4837

4838

4839

4840

<p>Inherited from

4841

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

4842

4843

4844

4845

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

4846

4847

</p>

4848

4849

4850

4851

4852

4853

</div>

4854

4855

4856

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

4857

added lazily and still requires initialization.</p>

4858

</div>

4859

4860

4861

4862

<h4>Parameters:</h4>

4863

4864

4865

4866

4867

4868

4869

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

4870

4871

4872

4873

4874

4875

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

4876

</div>

4877

4878

4879

</li>

4880

4881

</ul>

4882

</div>

4883

4884

4885

4886

4887

<h4>Returns:</h4>

4888

4889

4890

4891

4892

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

4893

4894

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

4895

4896

</div>

4897

</div>

4898

4899

4900

4901

</div>

4902

4903

4904

4905

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

4906

4907

4908

4909

4910

4911

4912

4913

4914

4915

</li>

4916

4917

4918

4919

4920

4921

</li>

4922

4923

4924

4925

4926

4927

</li>

4928

4929

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

4930

</div>

4931

4932

4933

4934

4935

4936

4937

4938

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

4939

4940

4941

4942

4943

4944

4945

4946

4947

4948

4949

4950

<p>Inherited from

4951

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

4952

4953

4954

4955

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

4956

4957

</p>

4958

4959

4960

4961

4962

4963

</div>

4964

4965

4966

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

4967

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

4968

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

4969

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

4970

be subscribed to like other events to monitor the event

4971

system. Inividual published events can have monitoring

4972

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

4973

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

4974

</div>

4975

4976

4977

4978

<h4>Parameters:</h4>

4979

4980

4981

4982

4983

4984

4985

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

4986

4987

4988

4989

4990

4991

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

4992

</div>

4993

4994

4995

</li>

4996

4997

4998

4999

5000

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

5001

5002

5003

5004

5005

5006

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

5007

</div>

5008

5009

5010

</li>

5011

5012

5013

5014

5015

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

5016

5017

5018

5019

5020

5021

<p>Information about the event interaction, such as

5022

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

5023

</div>

5024

5025

5026

</li>

5027

5028

</ul>

5029

</div>

5030

5031

5032

5033

5034

5035

</div>

5036

5037

5038

5039

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

5040

5041

5042

5043

5044

5045

5046

5047

<code>valueHash</code>

5048

5049

</li>

5050

5051

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

5052

</div>

5053

5054

5055

5056

5057

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

5058

</span>

5059

5060

5061

5062

5063

5064

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

5065

5066

5067

5068

5069

5070

5071

5072

5073

5074

5075

<p>Inherited from

5076

5077

Attribute

5078

</a>

5079

5080

but overwritten in

5081

5082

5083

5084

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

5085

5086

</p>

5087

5088

5089

5090

5091

5092

</div>

5093

5094

5095

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

5096

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

5097

</div>

5098

5099

5100

5101

<h4>Parameters:</h4>

5102

5103

5104

5105

5106

5107

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

5108

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

5109

5110

5111

5112

5113

5114

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

5115

</div>

5116

5117

5118

</li>

5119

5120

</ul>

5121

</div>

5122

5123

5124

5125

5126

<h4>Returns:</h4>

5127

5128

5129

5130

5131

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

5132

5133

5134

</div>

5135

</div>

5136

5137

5138

5139

</div>

5140

5141

5142

5143

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

5144

5145

5146

5147

5148

5149

5150

5151

5152

5153

5154

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

5155

5156

5157

5158

5159

5160

5161

5162

5163

5164

5165

5166

<p>Inherited from

5167

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

5168

5169

5170

5171

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

5172

5173

</p>

5174

5175

5176

5177

5178

5179

</div>

5180

5181

5182

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

5183

and the prefixed event name from _getType

5184

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

5185

</div>

5186

5187

5188

5189

5190

5191

5192

</div>

5193

5194

5195

5196

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

5197

5198

5199

5200

5201

5202

5203

5204

<code>config</code>

5205

5206

</li>

5207

5208

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

5209

</div>

5210

5211

5212

5213

5214

5215

5216

5217

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

5218

5219

5220

5221

5222

5223

5224

5225

5226

5227

5228

5229

<p>Inherited from

5230

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

5231

5232

5233

5234

5235

5236

</p>

5237

5238

5239

5240

5241

5242

</div>

5243

5244

5245

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

5246

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

5247

construction, prior to init.</p>

5248

</div>

5249

5250

5251

5252

<h4>Parameters:</h4>

5253

5254

5255

5256

5257

5258

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

5259

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

5260

5261

5262

5263

5264

5265

<p>The user configuration object</p>

5266

</div>

5267

5268

5269

</li>

5270

5271

</ul>

5272

</div>

5273

5274

5275

5276

5277

5278

</div>

5279

5280

5281

5282

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

5283

5284

5285

5286

5287

5288

5289

5290

<code>attrs</code>

5291

5292

</li>

5293

5294

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

5295

</div>

5296

5297

5298

5299

5300

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

5301

</span>

5302

5303

5304

5305

5306

5307

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

5308

5309

5310

5311

5312

5313

5314

5315

5316

5317

5318

5319

<p>Inherited from

5320

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

5321

5322

5323

5324

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

5325

5326

</p>

5327

5328

5329

5330

5331

5332

</div>

5333

5334

5335

<p>Utility method to protect an attribute configuration

5336

hash, by merging the entire object and the individual

5337

attr config objects.</p>

5338

</div>

5339

5340

5341

5342

<h4>Parameters:</h4>

5343

5344

5345

5346

5347

5348

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

5349

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

5350

5351

5352

5353

5354

5355

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

5356

</div>

5357

5358

5359

</li>

5360

5361

</ul>

5362

</div>

5363

5364

5365

5366

5367

<h4>Returns:</h4>

5368

5369

5370

5371

5372

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

5373

5374

A protected version of the attrs argument.

5375

5376

</div>

5377

</div>

5378

5379

5380

5381

</div>

5382

5383

5384

5385

5386

5387

5388

5389

5390

5391

5392

5393

5394

5395

</li>

5396

5397

5398

5399

5400

5401

</li>

5402

5403

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

5404

</div>

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

</span>

5411

5412

5413

5414

5415

5416

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

5417

5418

5419

5420

5421

5422

5423

5424

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

5425

5426

5427

5428

5429

<p>Inherited from

5430

5431

AttributeEvents

5432

</a>

5433

5434

but overwritten in

5435

5436

5437

5438

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

5439

5440

</p>

5441

5442

5443

5444

5445

5446

</div>

5447

5448

5449

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

5450

</div>

5451

5452

5453

5454

<h4>Parameters:</h4>

5455

5456

5457

5458

5459

5460

5461

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

5462

5463

5464

5465

5466

5467

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

5468

</div>

5469

5470

5471

</li>

5472

5473

5474

5475

5476

5477

5478

5479

5480

5481

5482

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

5483

</div>

5484

5485

5486

</li>

5487

5488

</ul>

5489

</div>

5490

5491

5492

5493

5494

<h4>Returns:</h4>

5495

5496

5497

5498

5499

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

5500

5501

A reference to the host object.

5502

5503

</div>

5504

</div>

5505

5506

5507

5508

</div>

5509

5510

5511

5512

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

5513

5514

5515

5516

5517

5518

5519

5520

5521

5522

</li>

5523

5524

5525

5526

<code>value</code>

5527

5528

</li>

5529

5530

5531

5532

5533

5534

</li>

5535

5536

5537

5538

<code>force</code>

5539

5540

</li>

5541

5542

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

5543

</div>

5544

5545

5546

5547

5548

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

5549

</span>

5550

5551

5552

5553

5554

5555

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

5556

5557

5558

5559

5560

5561

5562

5563

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

5564

5565

5566

5567

5568

5569

<p>Inherited from

5570

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

5571

5572

5573

5574

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

5575

5576

</p>

5577

5578

5579

5580

5581

5582

</div>

5583

5584

5585

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

5586

5587

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

5588

</div>

5589

5590

5591

5592

<h4>Parameters:</h4>

5593

5594

5595

5596

5597

5598

5599

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

5600

5601

5602

5603

5604

5605

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

5606

</div>

5607

5608

5609

</li>

5610

5611

5612

5613

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

5614

5615

5616

5617

5618

5619

5620

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

5621

</div>

5622

5623

5624

</li>

5625

5626

5627

5628

5629

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

5630

5631

5632

5633

5634

5635

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

5636

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

5637

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

5638

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

5639

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

5640

</div>

5641

5642

5643

</li>

5644

5645

5646

5647

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

5648

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

5649

5650

5651

5652

5653

5654

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

5655

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

5656

</div>

5657

5658

5659

</li>

5660

5661

</ul>

5662

</div>

5663

5664

5665

5666

5667

<h4>Returns:</h4>

5668

5669

5670

5671

5672

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

5673

5674

A reference to the host object.

5675

5676

</div>

5677

</div>

5678

5679

5680

5681

</div>

5682

5683

5684

5685

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

5686

5687

5688

5689

5690

5691

5692

5693

<code>attrs</code>

5694

5695

</li>

5696

5697

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

5698

</div>

5699

5700

5701

5702

5703

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

5704

</span>

5705

5706

5707

5708

5709

5710

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

5711

5712

5713

5714

5715

5716

5717

5718

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

5719

5720

5721

5722

5723

5724

<p>Inherited from

5725

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

5726

5727

5728

5729

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

5730

5731

</p>

5732

5733

5734

5735

5736

5737

</div>

5738

5739

5740

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

5741

</div>

5742

5743

5744

5745

<h4>Parameters:</h4>

5746

5747

5748

5749

5750

5751

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

5752

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

5753

5754

5755

5756

5757

5758

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

5759

</div>

5760

5761

5762

</li>

5763

5764

</ul>

5765

</div>

5766

5767

5768

5769

5770

<h4>Returns:</h4>

5771

5772

5773

5774

5775

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

5776

5777

A reference to the host object.

5778

5779

</div>

5780

</div>

5781

5782

5783

5784

</div>

5785

5786

5787

5788

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

5789

5790

5791

5792

5793

5794

5795

5796

<code>attrName</code>

5797

5798

</li>

5799

5800

5801

5802

<code>subAttrName</code>

5803

5804

</li>

5805

5806

5807

5808

<code>prevVal</code>

5809

5810

</li>

5811

5812

5813

5814

<code>newVal</code>

5815

5816

</li>

5817

5818

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

5819

</div>

5820

5821

5822

5823

5824

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

5825

</span>

5826

5827

5828

5829

5830

5831

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

5832

5833

5834

5835

5836

5837

5838

5839

5840

5841

5842

5843

<p>Inherited from

5844

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

5845

5846

5847

5848

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

5849

5850

</p>

5851

5852

5853

5854

5855

5856

</div>

5857

5858

5859

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

5860

if validation and setter passes.</p>

5861

</div>

5862

5863

5864

5865

<h4>Parameters:</h4>

5866

5867

5868

5869

5870

5871

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

5872

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

5873

5874

5875

5876

5877

5878

<p>The attribute name.</p>

5879

</div>

5880

5881

5882

</li>

5883

5884

5885

5886

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

5887

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

5888

5889

5890

5891

5892

5893

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

5894

</div>

5895

5896

5897

</li>

5898

5899

5900

5901

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

5902

5903

5904

5905

5906

5907

5908

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

5909

</div>

5910

5911

5912

</li>

5913

5914

5915

5916

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

5917

5918

5919

5920

5921

5922

5923

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

5924

</div>

5925

5926

5927

</li>

5928

5929

</ul>

5930

</div>

5931

5932

5933

5934

5935

<h4>Returns:</h4>

5936

5937

5938

5939

5940

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

5941

5942

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

5943

5944

</div>

5945

</div>

5946

5947

5948

5949

</div>

5950

5951

5952

5953

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

5954

5955

5956

5957

5958

5959

5960

5961

5962

5963

</li>

5964

5965

5966

5967

<code>value</code>

5968

5969

</li>

5970

5971

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

5972

</div>

5973

5974

5975

5976

5977

5978

5979

5980

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

5981

5982

5983

5984

5985

5986

5987

5988

5989

5990

5991

5992

<p>Inherited from

5993

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

5994

5995

5996

5997

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

5998

5999

</p>

6000

6001

6002

6003

6004

6005

</div>

6006

6007

6008

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

6009

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

6010

</div>

6011

6012

6013

6014

<h4>Parameters:</h4>

6015

6016

6017

6018

6019

6020

6021

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

6022

6023

6024

6025

6026

6027

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

6028

</div>

6029

6030

6031

</li>

6032

6033

6034

6035

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

6036

6037

6038

6039

6040

6041

6042

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

6043

</div>

6044

6045

6046

</li>

6047

6048

</ul>

6049

</div>

6050

6051

6052

6053

6054

6055

</div>

6056

6057

6058

6059

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

6060

6061

6062

6063

6064

6065

6066

6067

6068

6069

</li>

6070

6071

6072

6073

<code>config</code>

6074

6075

</li>

6076

6077

6078

6079

6080

6081

</li>

6082

6083

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

6084

</div>

6085

6086

6087

6088

6089

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

6090

</span>

6091

6092

6093

6094

6095

6096

6097

6098

6099

6100

6101

6102

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

6103

6104

6105

6106

6107

6108

<p>Inherited from

6109

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

6110

6111

6112

6113

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

6114

6115

</p>

6116

6117

6118

6119

6120

6121

</div>

6122

6123

6124

<p>

6125

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

6126

</p>

6127

6128

<p>

6129

The config argument object supports the following properties:

6130

</p>

6131

6132

<dl>

6133

<dt>value <Any></dt>

6134

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

6135

6136

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

6137

<dd>

6138

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

6139

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

6140

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

6141

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

6142

case the value property is used.</p>

6143

6144

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

6145

</dd>

6146

6147

<dt>readOnly <boolean></dt>

6148

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

6149

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

6150

6151

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

6152

<dd>

6153

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

6154

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

6155

constructor configuration arguments, or by invoking set.

6156

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

6157

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

6158

</dd>

6159

6160

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

6161

<dd>

6162

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

6163

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

6164

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

6165

the value from being stored.

6166

</p>

6167

6168

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

6169

</dd>

6170

6171

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

6172

<dd>

6173

<p>

6174

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

6175

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

6176

invoke get.

6177

</p>

6178

6179

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

6180

</dd>

6181

6182

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

6183

<dd>

6184

<p>

6185

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

6186

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

6187

</p>

6188

6189

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

6190

</dd>

6191

6192

<dt>lazyAdd <boolean></dt>

6193

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

6194

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

6195

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

6196

6197

</dl>

6198

6199

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

6200

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

6201

6202

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

6203

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

6204

</div>

6205

6206

6207

6208

<h4>Parameters:</h4>

6209

6210

6211

6212

6213

6214

6215

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

6216

6217

6218

6219

6220

6221

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

6222

</div>

6223

6224

6225

</li>

6226

6227

6228

6229

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

6230

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

6231

6232

6233

6234

6235

6236

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

6237

6238

<p>

6239

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

6240

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

6241

</p>

6242

</div>

6243

6244

6245

</li>

6246

6247

6248

6249

6250

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

6251

6252

6253

6254

6255

6256

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

6257

</div>

6258

6259

6260

</li>

6261

6262

</ul>

6263

</div>

6264

6265

6266

6267

6268

<h4>Returns:</h4>

6269

6270

6271

6272

6273

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

6274

6275

A reference to the host object.

6276

6277

</div>

6278

</div>

6279

6280

6281

6282

</div>

6283

6284

6285

6286

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

6287

6288

6289

6290

6291

6292

6293

6294

6295

6296

</li>

6297

6298

6299

6300

<code>values</code>

6301

6302

</li>

6303

6304

6305

6306

6307

6308

</li>

6309

6310

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

6311

</div>

6312

6313

6314

6315

6316

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

6317

</span>

6318

6319

6320

6321

6322

6323

6324

6325

6326

6327

6328

6329

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

6330

6331

6332

6333

6334

6335

<p>Inherited from

6336

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

6337

6338

6339

6340

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

6341

6342

</p>

6343

6344

6345

6346

6347

6348

</div>

6349

6350

6351

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

6352

6353

<p>

6354

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

6355

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

6356

</p>

6357

</div>

6358

6359

6360

6361

<h4>Parameters:</h4>

6362

6363

6364

6365

6366

6367

6368

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

6369

6370

6371

6372

6373

6374

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

6375

</div>

6376

6377

6378

</li>

6379

6380

6381

6382

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

6383

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

6384

6385

6386

6387

6388

6389

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

6390

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

6391

</div>

6392

6393

6394

</li>

6395

6396

6397

6398

6399

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

6400

6401

6402

6403

6404

6405

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

6406

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

6407

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

6408

</div>

6409

6410

6411

</li>

6412

6413

</ul>

6414

</div>

6415

6416

6417

6418

6419

<h4>Returns:</h4>

6420

6421

6422

6423

6424

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

6425

6426

A reference to the host object.

6427

6428

</div>

6429

</div>

6430

6431

6432

6433

</div>

6434

6435

6436

6437

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

6438

6439

6440

6441

6442

6443

6444

6445

6446

6447

</li>

6448

6449

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

6450

</div>

6451

6452

6453

6454

6455

6456

6457

6458

6459

6460

6461

6462

6463

6464

6465

6466

6467

6468

<p>Inherited from

6469

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

6470

6471

6472

6473

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

6474

6475

</p>

6476

6477

6478

6479

6480

6481

</div>

6482

6483

6484

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

6485

is determined by the order registered. Multiple targets can

6486

be specified.</p>

6487

6488

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

6489

6490

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

6491

</div>

6492

6493

6494

6495

<h4>Parameters:</h4>

6496

6497

6498

6499

6500

6501

6502

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

6503

6504

6505

6506

6507

6508

<p>the target to add</p>

6509

</div>

6510

6511

6512

</li>

6513

6514

</ul>

6515

</div>

6516

6517

6518

6519

6520

6521

</div>

6522

6523

6524

6525

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

6526

6527

6528

6529

6530

6531

6532

6533

6534

6535

</li>

6536

6537

6538

6539

6540

6541

</li>

6542

6543

6544

6545

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

6546

6547

</li>

6548

6549

6550

6551

6552

6553

</li>

6554

6555

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

6556

</div>

6557

6558

6559

6560

6561

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

6562

</span>

6563

6564

6565

6566

6567

6568

6569

6570

6571

6572

6573

6574

6575

6576

6577

6578

<p>Inherited from

6579

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

6580

6581

6582

6583

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

6584

6585

</p>

6586

6587

6588

6589

6590

6591

</div>

6592

6593

6594

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

6595

supplied callback will execute after any listeners add

6596

via the subscribe method, and after the default function,

6597

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

6598

</div>

6599

6600

6601

6602

<h4>Parameters:</h4>

6603

6604

6605

6606

6607

6608

6609

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

6610

6611

6612

6613

6614

6615

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

6616

</div>

6617

6618

6619

</li>

6620

6621

6622

6623

6624

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

6625

6626

6627

6628

6629

6630

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

6631

</div>

6632

6633

6634

</li>

6635

6636

6637

6638

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

6639

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

6640

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

6641

6642

6643

6644

6645

6646

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

6647

</div>

6648

6649

6650

</li>

6651

6652

6653

6654

6655

6656

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

6657

6658

6659

6660

6661

6662

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

6663

</div>

6664

6665

6666

</li>

6667

6668

</ul>

6669

</div>

6670

6671

6672

6673

6674

<h4>Returns:</h4>

6675

6676

6677

6678

6679

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

6680

6681

A subscription handle capable of detaching the

6682

subscription

6683

6684

</div>

6685

</div>

6686

6687

6688

6689

</div>

6690

6691

6692

6693

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

6694

6695

6696

6697

6698

6699

6700

6701

6702

6703

</li>

6704

6705

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

6706

</div>

6707

6708

6709

6710

6711

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

6712

</span>

6713

6714

6715

6716

6717

6718

6719

6720

6721

6722

6723

6724

6725

6726

6727

6728

<p>Inherited from

6729

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

6730

6731

6732

6733

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

6734

6735

</p>

6736

6737

6738

6739

6740

6741

</div>

6742

6743

6744

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

6745

</div>

6746

6747

6748

6749

<h4>Parameters:</h4>

6750

6751

6752

6753

6754

6755

6756

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

6757

6758

6759

6760

6761

6762

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

6763

</div>

6764

6765

6766

</li>

6767

6768

</ul>

6769

</div>

6770

6771

6772

6773

6774

<h4>Returns:</h4>

6775

6776

6777

6778

6779

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

6780

6781

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.

6782

6783

</div>

6784

</div>

6785

6786

6787

6788

</div>

6789

6790

6791

6792

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

6793

6794

6795

6796

6797

6798

6799

6800

6801

</span>

6802

6803

6804

6805

6806

6807

6808

6809

6810

6811

6812

6813

6814

6815

6816

6817

<p>Inherited from

6818

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

6819

6820

6821

6822

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

6823

6824

</p>

6825

6826

6827

6828

6829

6830

</div>

6831

6832

6833

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

6834

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

6835

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

6836

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

6837

6838

<p>For DOM and custom events:

6839

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

6840

6841

<p>For methods:

6842

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

6843

</div>

6844

6845

6846

6847

6848

6849

<h4>Returns:</h4>

6850

6851

6852

6853

6854

detach handle

6855

6856

</div>

6857

</div>

6858

6859

6860

6861

</div>

6862

6863

6864

6865

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

6866

6867

6868

6869

6870

6871

6872

6873

6874

6875

</li>

6876

6877

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

6878

</div>

6879

6880

6881

6882

6883

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

6884

</span>

6885

6886

6887

6888

6889

6890

6891

6892

6893

6894

6895

6896

6897

6898

6899

6900

<p>Inherited from

6901

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

6902

6903

6904

6905

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

6906

6907

</p>

6908

6909

6910

6911

6912

6913

</div>

6914

6915

6916

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

6917

</div>

6918

6919

6920

6921

<h4>Parameters:</h4>

6922

6923

6924

6925

6926

6927

6928

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

6929

6930

6931

6932

6933

6934

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

6935

</div>

6936

6937

6938

</li>

6939

6940

</ul>

6941

</div>

6942

6943

6944

6945

6946

<h4>Returns:</h4>

6947

6948

6949

6950

6951

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

6952

6953

the aggregated return value from Event.Custom.fire

6954

6955

</div>

6956

</div>

6957

6958

6959

6960

</div>

6961

6962

6963

6964

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

6965

6966

6967

6968

6969

6970

6971

6972

6973

6974

6975

6976

6977

6978

6979

6980

6981

6982

6983

6984

6985

6986

<p>

6987

6988

Defined in

6989

6990

6991

6992

6993

<a href="../files/datasource_js_datasource-polling.js.html#l78"><code>datasource/js/datasource-polling.js:78</code></a>

6994

6995

</p>

6996

6997

6998

6999

7000

7001

</div>

7002

7003

7004

<p>Clears all intervals.</p>

7005

</div>

7006

7007

7008

7009

7010

7011

7012

</div>

7013

7014

7015

7016

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

7017

7018

7019

7020

7021

7022

7023

7024

7025

7026

</li>

7027

7028

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

7029

</div>

7030

7031

7032

7033

7034

7035

7036

7037

7038

7039

7040

7041

7042

7043

7044

7045

7046

7047

7048

<p>

7049

7050

Defined in

7051

7052

7053

7054

7055

<a href="../files/datasource_js_datasource-polling.js.html#l61"><code>datasource/js/datasource-polling.js:61</code></a>

7056

7057

</p>

7058

7059

7060

7061

7062

7063

</div>

7064

7065

7066

<p>Disables polling mechanism associated with the given interval ID.</p>

7067

</div>

7068

7069

7070

7071

<h4>Parameters:</h4>

7072

7073

7074

7075

7076

7077

7078

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

7079

7080

7081

7082

7083

7084

<p>Interval ID.</p>

7085

</div>

7086

7087

7088

</li>

7089

7090

</ul>

7091

</div>

7092

7093

7094

7095

7096

7097

</div>

7098

7099

7100

7101

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

7102

7103

7104

7105

7106

7107

7108

7109

7110

</span>

7111

7112

7113

7114

7115

7116

7117

7118

7119

7120

7121

7122

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

7123

7124

7125

7126

7127

<p>Inherited from

7128

7129

BaseCore

7130

</a>

7131

7132

but overwritten in

7133

7134

7135

7136

7137

7138

</p>

7139

7140

7141

7142

7143

7144

</div>

7145

7146

7147

<p>

7148

Destroy lifecycle method. Fires the destroy

7149

event, prior to invoking destructors for the

7150

class hierarchy.

7151

</p>

7152

7153

<p>

7154

Subscribers to the destroy

7155

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

7156

from proceeding.

7157

</p>

7158

</div>

7159

7160

7161

7162

7163

7164

<h4>Returns:</h4>

7165

7166

7167

7168

7169

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

7170

7171

A reference to this object

7172

7173

</div>

7174

</div>

7175

7176

7177

7178

</div>

7179

7180

7181

7182

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

7183

7184

7185

7186

7187

7188

7189

7190

7191

7192

</li>

7193

7194

7195

7196

7197

7198

</li>

7199

7200

7201

7202

<code>context</code>

7203

7204

</li>

7205

7206

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

7207

</div>

7208

7209

7210

7211

7212

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

7213

</span>

7214

7215

7216

7217

7218

7219

7220

7221

7222

7223

7224

7225

7226

7227

7228

7229

<p>Inherited from

7230

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

7231

7232

7233

7234

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

7235

7236

</p>

7237

7238

7239

7240

7241

7242

</div>

7243

7244

7245

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

7246

</div>

7247

7248

7249

7250

<h4>Parameters:</h4>

7251

7252

7253

7254

7255

7256

7257

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

7258

7259

7260

7261

7262

7263

<p>Either the handle to the subscriber or the

7264

type of event. If the type

7265

is not specified, it will attempt to remove

7266

the listener from all hosted events.</p>

7267

</div>

7268

7269

7270

</li>

7271

7272

7273

7274

7275

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

7276

7277

7278

7279

7280

7281

<p>The subscribed function to unsubscribe, if not

7282

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

7283

</div>

7284

7285

7286

</li>

7287

7288

7289

7290

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

7291

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

7292

7293

7294

7295

7296

7297

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

7298

optional, but if supplied will be used to

7299

disambiguate multiple listeners that are the same

7300

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

7301

that lives on the prototype)</p>

7302

</div>

7303

7304

7305

</li>

7306

7307

</ul>

7308

</div>

7309

7310

7311

7312

7313

<h4>Returns:</h4>

7314

7315

7316

7317

7318

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

7319

7320

the host

7321

7322

</div>

7323

</div>

7324

7325

7326

7327

</div>

7328

7329

7330

7331

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

7332

7333

7334

7335

7336

7337

7338

7339

7340

7341

</li>

7342

7343

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

7344

</div>

7345

7346

7347

7348

7349

7350

7351

7352

7353

7354

7355

7356

7357

7358

7359

7360

7361

7362

<p>Inherited from

7363

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

7364

7365

7366

7367

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

7368

7369

</p>

7370

7371

7372

7373

7374

7375

</div>

7376

7377

7378

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

7379

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

7380

be removed.</p>

7381

</div>

7382

7383

7384

7385

<h4>Parameters:</h4>

7386

7387

7388

7389

7390

7391

7392

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

7393

7394

7395

7396

7397

7398

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

7399

</div>

7400

7401

7402

</li>

7403

7404

</ul>

7405

</div>

7406

7407

7408

7409

7410

7411

</div>

7412

7413

7414

7415

7416

7417

7418

7419

7420

7421

7422

7423

7424

7425

</li>

7426

7427

7428

7429

<code>arguments</code>

7430

7431

</li>

7432

7433

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

7434

</div>

7435

7436

7437

7438

7439

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

7440

</span>

7441

7442

7443

7444

7445

7446

7447

7448

7449

7450

7451

7452

7453

7454

7455

7456

<p>Inherited from

7457

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

7458

7459

7460

7461

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

7462

7463

</p>

7464

7465

7466

7467

7468

7469

</div>

7470

7471

7472

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

7473

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

7474

following parameters.</p>

7475

7476

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

7477

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

7478

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

7479

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

7480

be published on this object first.</p>

7481

7482

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

7483

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

7484

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

7485

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

7486

in place of the original object.</p>

7487

</div>

7488

7489

7490

7491

<h4>Parameters:</h4>

7492

7493

7494

7495

7496

7497

7498

7499

7500

7501

7502

7503

7504

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

7505

a 'type' property.</p>

7506

</div>

7507

7508

7509

</li>

7510

7511

7512

7513

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

7514

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

7515

7516

7517

7518

7519

7520

<p>an arbitrary set of parameters to pass to

7521

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

7522

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

7523

parameter after the properties the object literal contains are copied to

7524

the event facade.</p>

7525

</div>

7526

7527

7528

</li>

7529

7530

</ul>

7531

</div>

7532

7533

7534

7535

7536

<h4>Returns:</h4>

7537

7538

7539

7540

7541

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

7542

7543

the event host

7544

7545

</div>

7546

</div>

7547

7548

7549

7550

</div>

7551

7552

7553

7554

7555

7556

7557

7558

7559

7560

7561

7562

7563

7564

</li>

7565

7566

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

7567

</div>

7568

7569

7570

7571

7572

7573

</span>

7574

7575

7576

7577

7578

7579

7580

7581

7582

7583

7584

7585

7586

7587

7588

7589

<p>Inherited from

7590

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

7591

7592

7593

7594

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

7595

7596

</p>

7597

7598

7599

7600

7601

7602

</div>

7603

7604

7605

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

7606

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

7607

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

7608

</div>

7609

7610

7611

7612

<h4>Parameters:</h4>

7613

7614

7615

7616

7617

7618

7619

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

7620

7621

7622

7623

7624

7625

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

7626

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

7627

</div>

7628

7629

7630

</li>

7631

7632

</ul>

7633

</div>

7634

7635

7636

7637

7638

<h4>Returns:</h4>

7639

7640

7641

7642

7643

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

7644

7645

The value of the attribute

7646

7647

</div>

7648

</div>

7649

7650

7651

7652

</div>

7653

7654

7655

7656

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

7657

7658

7659

7660

7661

7662

7663

7664

<code>attrs</code>

7665

7666

</li>

7667

7668

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

7669

</div>

7670

7671

7672

7673

7674

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

7675

</span>

7676

7677

7678

7679

7680

7681

7682

7683

7684

7685

7686

7687

7688

7689

7690

7691

<p>Inherited from

7692

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

7693

7694

7695

7696

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

7697

7698

</p>

7699

7700

7701

7702

7703

7704

</div>

7705

7706

7707

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

7708

</div>

7709

7710

7711

7712

<h4>Parameters:</h4>

7713

7714

7715

7716

7717

7718

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

7719

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

7720

7721

7722

7723

7724

7725

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

7726

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

7727

</div>

7728

7729

7730

</li>

7731

7732

</ul>

7733

</div>

7734

7735

7736

7737

7738

<h4>Returns:</h4>

7739

7740

7741

7742

7743

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

7744

7745

An object with attribute name/value pairs.

7746

7747

</div>

7748

</div>

7749

7750

7751

7752

</div>

7753

7754

7755

7756

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

7757

7758

7759

7760

7761

7762

7763

7764

7765

7766

</li>

7767

7768

7769

7770

<code>prefixed</code>

7771

7772

</li>

7773

7774

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

7775

</div>

7776

7777

7778

7779

7780

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

7781

</span>

7782

7783

7784

7785

7786

7787

7788

7789

7790

7791

7792

7793

7794

7795

7796

7797

<p>Inherited from

7798

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

7799

7800

7801

7802

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

7803

7804

</p>

7805

7806

7807

7808

7809

7810

</div>

7811

7812

7813

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

7814

falsy value otherwise</p>

7815

</div>

7816

7817

7818

7819

<h4>Parameters:</h4>

7820

7821

7822

7823

7824

7825

7826

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

7827

7828

7829

7830

7831

7832

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

7833

</div>

7834

7835

7836

</li>

7837

7838

7839

7840

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

7841

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

7842

7843

7844

7845

7846

7847

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

7848

</div>

7849

7850

7851

</li>

7852

7853

</ul>

7854

</div>

7855

7856

7857

7858

7859

<h4>Returns:</h4>

7860

7861

7862

7863

7864

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

7865

7866

the custom event or null

7867

7868

</div>

7869

</div>

7870

7871

7872

7873

</div>

7874

7875

7876

7877

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

7878

7879

7880

7881

7882

7883

7884

7885

7886

</span>

7887

7888

7889

7890

7891

7892

7893

7894

7895

7896

7897

7898

7899

7900

7901

7902

<p>Inherited from

7903

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

7904

7905

7906

7907

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

7908

7909

</p>

7910

7911

7912

7913

7914

7915

</div>

7916

7917

7918

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

7919

</div>

7920

7921

7922

7923

7924

7925

<h4>Returns:</h4>

7926

7927

7928

7929

7930

EventTarget[]

7931

7932

</div>

7933

</div>

7934

7935

7936

7937

</div>

7938

7939

7940

7941

7942

7943

7944

7945

7946

7947

7948

7949

<code>config</code>

7950

7951

</li>

7952

7953

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

7954

</div>

7955

7956

7957

7958

7959

7960

</span>

7961

7962

7963

7964

7965

7966

7967

7968

7969

7970

7971

7972

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

7973

7974

7975

7976

7977

<p>Inherited from

7978

7979

BaseCore

7980

</a>

7981

7982

but overwritten in

7983

7984

7985

7986

7987

7988

</p>

7989

7990

7991

7992

7993

7994

</div>

7995

7996

7997

<p>Init lifecycle method, invoked during construction.

7998

Fires the init event prior to setting up attributes and

7999

invoking initializers for the class hierarchy.</p>

8000

</div>

8001

8002

8003

8004

<h4>Parameters:</h4>

8005

8006

8007

8008

8009

8010

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

8011

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

8012

8013

8014

8015

8016

8017

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

8018

</div>

8019

8020

8021

</li>

8022

8023

</ul>

8024

</div>

8025

8026

8027

8028

8029

<h4>Returns:</h4>

8030

8031

8032

8033

8034

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

8035

8036

A reference to this object

8037

8038

</div>

8039

</div>

8040

8041

8042

8043

</div>

8044

8045

8046

8047

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

8048

8049

8050

8051

8052

8053

8054

8055

<code>config</code>

8056

8057

</li>

8058

8059

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

8060

</div>

8061

8062

8063

8064

8065

8066

8067

8068

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

8069

8070

8071

8072

8073

8074

8075

8076

8077

8078

8079

8080

<p>Inherited from

8081

<a href="../classes/DataSource.Local.html#method_initializer">DataSource.Local</a>:

8082

8083

8084

8085

<a href="../files/datasource_js_datasource-local.js.html#l113"><code>datasource/js/datasource-local.js:113</code></a>

8086

8087

</p>

8088

8089

8090

8091

8092

8093

</div>

8094

8095

8096

<p>Internal init() handler.</p>

8097

</div>

8098

8099

8100

8101

<h4>Parameters:</h4>

8102

8103

8104

8105

8106

8107

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

8108

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

8109

8110

8111

8112

8113

8114

<p>Config object.</p>

8115

</div>

8116

8117

8118

</li>

8119

8120

</ul>

8121

</div>

8122

8123

8124

8125

8126

8127

</div>

8128

8129

8130

8131

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

8132

8133

8134

8135

8136

8137

8138

8139

8140

8141

</li>

8142

8143

8144

8145

<code>config</code>

8146

8147

</li>

8148

8149

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

8150

</div>

8151

8152

8153

8154

8155

8156

8157

8158

8159

8160

8161

8162

8163

8164

8165

8166

8167

8168

<p>Inherited from

8169

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

8170

8171

8172

8173

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

8174

8175

</p>

8176

8177

8178

8179

8180

8181

</div>

8182

8183

8184

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

8185

8186

<p>

8187

The properties which can be modified through this interface are limited

8188

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

8189

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

8190

broadcast and getter.

8191

</p>

8192

</div>

8193

8194

8195

8196

<h4>Parameters:</h4>

8197

8198

8199

8200

8201

8202

8203

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

8204

8205

8206

8207

8208

8209

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

8210

</div>

8211

8212

8213

</li>

8214

8215

8216

8217

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

8218

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

8219

8220

8221

8222

8223

8224

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

8225

</div>

8226

8227

8228

</li>

8229

8230

</ul>

8231

</div>

8232

8233

8234

8235

8236

8237

</div>

8238

8239

8240

8241

8242

8243

8244

8245

8246

8247

8248

8249

8250

8251

</li>

8252

8253

8254

8255

8256

8257

</li>

8258

8259

8260

8261

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

8262

8263

</li>

8264

8265

8266

8267

8268

8269

</li>

8270

8271

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

8272

</div>

8273

8274

8275

8276

8277

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

8278

</span>

8279

8280

8281

8282

8283

8284

8285

8286

8287

8288

8289

8290

8291

8292

8293

8294

<p>Inherited from

8295

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

8296

8297

8298

8299

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

8300

8301

</p>

8302

8303

8304

8305

8306

8307

</div>

8308

8309

8310

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

8311

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

8312

8313

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

8314

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

8315

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

8316

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

8317

API for all available properties and methods. Subscribers to

8318

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

8319

after the event name.</p>

8320

8321

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

8322

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

8323

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

8324

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

8325

8326

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

8327

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

8328

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

8329

</div>

8330

8331

8332

8333

<h4>Parameters:</h4>

8334

8335

8336

8337

8338

8339

8340

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

8341

8342

8343

8344

8345

8346

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

8347

</div>

8348

8349

8350

</li>

8351

8352

8353

8354

8355

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

8356

8357

8358

8359

8360

8361

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

8362

</div>

8363

8364

8365

</li>

8366

8367

8368

8369

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

8370

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

8371

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

8372

8373

8374

8375

8376

8377

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

8378

</div>

8379

8380

8381

</li>

8382

8383

8384

8385

8386

8387

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

8388

8389

8390

8391

8392

8393

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

8394

</div>

8395

8396

8397

</li>

8398

8399

</ul>

8400

</div>

8401

8402

8403

8404

8405

<h4>Returns:</h4>

8406

8407

8408

8409

8410

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

8411

8412

A subscription handle capable of detaching that

8413

subscription

8414

8415

</div>

8416

</div>

8417

8418

8419

8420

</div>

8421

8422

8423

8424

8425

8426

8427

8428

8429

8430

8431

8432

8433

8434

</li>

8435

8436

8437

8438

8439

8440

</li>

8441

8442

8443

8444

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

8445

8446

</li>

8447

8448

8449

8450

8451

8452

</li>

8453

8454

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

8455

</div>

8456

8457

8458

8459

8460

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

8461

</span>

8462

8463

8464

8465

8466

8467

8468

8469

8470

8471

8472

8473

8474

8475

8476

8477

<p>Inherited from

8478

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

8479

8480

8481

8482

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

8483

8484

</p>

8485

8486

8487

8488

8489

8490

</div>

8491

8492

8493

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

8494

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

8495

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

8496

</div>

8497

8498

8499

8500

<h4>Parameters:</h4>

8501

8502

8503

8504

8505

8506

8507

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

8508

8509

8510

8511

8512

8513

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

8514

</div>

8515

8516

8517

</li>

8518

8519

8520

8521

8522

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

8523

8524

8525

8526

8527

8528

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

8529

</div>

8530

8531

8532

</li>

8533

8534

8535

8536

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

8537

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

8538

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

8539

8540

8541

8542

8543

8544

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

8545

</div>

8546

8547

8548

</li>

8549

8550

8551

8552

8553

8554

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

8555

8556

8557

8558

8559

8560

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

8561

</div>

8562

8563

8564

</li>

8565

8566

</ul>

8567

</div>

8568

8569

8570

8571

8572

<h4>Returns:</h4>

8573

8574

8575

8576

8577

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

8578

8579

A subscription handle capable of detaching the

8580

subscription

8581

8582

</div>

8583

</div>

8584

8585

8586

8587

</div>

8588

8589

8590

8591

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

8592

8593

8594

8595

8596

8597

8598

8599

8600

8601

</li>

8602

8603

8604

8605

8606

8607

</li>

8608

8609

8610

8611

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

8612

8613

</li>

8614

8615

8616

8617

8618

8619

</li>

8620

8621

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

8622

</div>

8623

8624

8625

8626

8627

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

8628

</span>

8629

8630

8631

8632

8633

8634

8635

8636

8637

8638

8639

8640

8641

8642

8643

8644

<p>Inherited from

8645

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

8646

8647

8648

8649

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

8650

8651

</p>

8652

8653

8654

8655

8656

8657

</div>

8658

8659

8660

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

8661

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

8662

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

8663

</div>

8664

8665

8666

8667

<h4>Parameters:</h4>

8668

8669

8670

8671

8672

8673

8674

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

8675

8676

8677

8678

8679

8680

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

8681

</div>

8682

8683

8684

</li>

8685

8686

8687

8688

8689

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

8690

8691

8692

8693

8694

8695

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

8696

</div>

8697

8698

8699

</li>

8700

8701

8702

8703

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

8704

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

8705

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

8706

8707

8708

8709

8710

8711

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

8712

</div>

8713

8714

8715

</li>

8716

8717

8718

8719

8720

8721

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

8722

8723

8724

8725

8726

8727

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

8728

</div>

8729

8730

8731

</li>

8732

8733

</ul>

8734

</div>

8735

8736

8737

8738

8739

<h4>Returns:</h4>

8740

8741

8742

8743

8744

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

8745

8746

A subscription handle capable of detaching that

8747

subscription

8748

8749

</div>

8750

</div>

8751

8752

8753

8754

</div>

8755

8756

8757

8758

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

8759

8760

8761

8762

8763

8764

8765

8766

8767

8768

</li>

8769

8770

8771

8772

<code class="optional">[pre=this._yuievt.config.prefix]</code>

8773

8774

</li>

8775

8776

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

8777

</div>

8778

8779

8780

8781

8782

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

8783

</span>

8784

8785

8786

8787

8788

8789

8790

8791

8792

8793

8794

8795

8796

8797

8798

8799

<p>Inherited from

8800

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

8801

8802

8803

8804

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

8805

8806

</p>

8807

8808

8809

8810

8811

8812

<p>Available since 3.3.0</p>

8813

8814

</div>

8815

8816

8817

<p>Takes the type parameter passed to 'on' and parses out the

8818

various pieces that could be included in the type. If the

8819

event type is passed without a prefix, it will be expanded

8820

to include the prefix one is supplied or the event target

8821

is configured with a default prefix.</p>

8822

</div>

8823

8824

8825

8826

<h4>Parameters:</h4>

8827

8828

8829

8830

8831

8832

8833

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

8834

8835

8836

8837

8838

8839

8840

</div>

8841

8842

8843

</li>

8844

8845

8846

8847

<code class="param-name optional">[pre=this._yuievt.config.prefix]</code>

8848

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

8849

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

8850

8851

8852

8853

8854

8855

<p>the prefix</p>

8856

</div>

8857

8858

8859

</li>

8860

8861

</ul>

8862

</div>

8863

8864

8865

8866

8867

<h4>Returns:</h4>

8868

8869

8870

8871

8872

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

8873

8874

an array containing:

8875

* the detach category, if supplied,

8876

* the prefixed event type,

8877

* whether or not this is an after listener,

8878

* the supplied event type

8879

8880

</div>

8881

</div>

8882

8883

8884

8885

</div>

8886

8887

8888

8889

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

8890

8891

8892

8893

8894

8895

8896

8897

8898

8899

</li>

8900

8901

8902

8903

8904

8905

</li>

8906

8907

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

8908

</div>

8909

8910

8911

8912

8913

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

8914

</span>

8915

8916

8917

8918

8919

8920

8921

8922

8923

8924

8925

8926

8927

8928

8929

8930

<p>Inherited from

8931

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

8932

8933

8934

8935

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

8936

8937

</p>

8938

8939

8940

8941

8942

8943

</div>

8944

8945

8946

<p>Creates a new custom event of the specified type. If a custom event

8947

by that name already exists, it will not be re-created. In either

8948

case the custom event is returned.</p>

8949

</div>

8950

8951

8952

8953

<h4>Parameters:</h4>

8954

8955

8956

8957

8958

8959

8960

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

8961

8962

8963

8964

8965

8966

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

8967

</div>

8968

8969

8970

</li>

8971

8972

8973

8974

8975

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

8976

8977

8978

8979

8980

8981

<p>optional config params. Valid properties are:</p>

8982

8983

<p><ul>

8984

<li>

8985

'broadcast': whether or not the YUI instance and YUI global are notified when the event is fired (false)

8986

</li>

8987

<li>

8988

'bubbles': whether or not this event bubbles (true)

8989

Events can only bubble if emitFacade is true.

8990

</li>

8991

<li>

8992

'context': the default execution context for the listeners (this)

8993

</li>

8994

<li>

8995

'defaultFn': the default function to execute when this event fires if preventDefault was not called

8996

</li>

8997

<li>

8998

'emitFacade': whether or not this event emits a facade (false)

8999

</li>

9000

<li>

9001

'prefix': the prefix for this targets events, e.g., 'menu' in 'menu:click'

9002

</li>

9003

<li>

9004

'fireOnce': if an event is configured to fire once, new subscribers after

9005

the fire will be notified immediately.

9006

</li>

9007

<li>

9008

'async': fireOnce event listeners will fire synchronously if the event has already

9009

fired unless async is true.

9010

</li>

9011

<li>

9012

'preventable': whether or not preventDefault() has an effect (true)

9013

</li>

9014

<li>

9015

'preventedFn': a function that is executed when preventDefault is called

9016

</li>

9017

<li>

9018

'queuable': whether or not this event can be queued during bubbling (false)

9019

</li>

9020

<li>

9021

'silent': if silent is true, debug messages are not provided for this event.

9022

</li>

9023

<li>

9024

'stoppedFn': a function that is executed when stopPropagation is called

9025

</li></p>

9026

9027

<p><li>

9028

'monitored': specifies whether or not this event should send notifications about

9029

when the event has been attached, detached, or published.

9030

</li>

9031

<li>

9032

'type': the event type (valid option if not provided as the first parameter to publish)

9033

</li>

9034

</ul></p>

9035

</div>

9036

9037

9038

</li>

9039

9040

</ul>

9041

</div>

9042

9043

9044

9045

9046

<h4>Returns:</h4>

9047

9048

9049

9050

9051

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

9052

9053

the custom event

9054

9055

</div>

9056

</div>

9057

9058

9059

9060

</div>

9061

9062

9063

9064

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

9065

9066

9067

9068

9069

9070

9071

9072

9073

9074

</li>

9075

9076

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

9077

</div>

9078

9079

9080

9081

9082

9083

9084

9085

9086

9087

9088

9089

9090

9091

9092

9093

9094

9095

<p>Inherited from

9096

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

9097

9098

9099

9100

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

9101

9102

</p>

9103

9104

9105

9106

9107

9108

</div>

9109

9110

9111

<p>Removes an attribute from the host object</p>

9112

</div>

9113

9114

9115

9116

<h4>Parameters:</h4>

9117

9118

9119

9120

9121

9122

9123

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

9124

9125

9126

9127

9128

9129

<p>The name of the attribute to be removed.</p>

9130

</div>

9131

9132

9133

</li>

9134

9135

</ul>

9136

</div>

9137

9138

9139

9140

9141

9142

</div>

9143

9144

9145

9146

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

9147

9148

9149

9150

9151

9152

9153

9154

9155

9156

</li>

9157

9158

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

9159

</div>

9160

9161

9162

9163

9164

9165

9166

9167

9168

9169

9170

9171

9172

9173

9174

9175

9176

9177

<p>Inherited from

9178

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

9179

9180

9181

9182

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

9183

9184

</p>

9185

9186

9187

9188

9189

9190

</div>

9191

9192

9193

<p>Removes a bubble target</p>

9194

</div>

9195

9196

9197

9198

<h4>Parameters:</h4>

9199

9200

9201

9202

9203

9204

9205

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

9206

9207

9208

9209

9210

9211

<p>the target to remove</p>

9212

</div>

9213

9214

9215

</li>

9216

9217

</ul>

9218

</div>

9219

9220

9221

9222

9223

9224

</div>

9225

9226

9227

9228

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

9229

9230

9231

9232

9233

9234

9235

9236

9237

9238

</li>

9239

9240

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

9241

</div>

9242

9243

9244

9245

9246

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

9247

</span>

9248

9249

9250

9251

9252

9253

9254

9255

9256

9257

9258

9259

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

9260

9261

9262

9263

9264

9265

<p>Inherited from

9266

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

9267

9268

9269

9270

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

9271

9272

</p>

9273

9274

9275

9276

9277

9278

</div>

9279

9280

9281

<p>Resets the attribute (or all attributes) to its initial value, as long as

9282

the attribute is not readOnly, or writeOnce.</p>

9283

</div>

9284

9285

9286

9287

<h4>Parameters:</h4>

9288

9289

9290

9291

9292

9293

9294

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

9295

9296

9297

9298

9299

9300

<p>Optional. The name of the attribute to reset. If omitted, all attributes are reset.</p>

9301

</div>

9302

9303

9304

</li>

9305

9306

</ul>

9307

</div>

9308

9309

9310

9311

9312

<h4>Returns:</h4>

9313

9314

9315

9316

9317

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

9318

9319

A reference to the host object.

9320

9321

</div>

9322

</div>

9323

9324

9325

9326

</div>

9327

9328

9329

9330

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

9331

9332

9333

9334

9335

9336

9337

9338

<code>request</code>

9339

9340

</li>

9341

9342

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

9343

</div>

9344

9345

9346

9347

9348

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

9349

</span>

9350

9351

9352

9353

9354

9355

9356

9357

9358

9359

9360

9361

9362

9363

9364

9365

<p>Inherited from

9366

<a href="../classes/DataSource.Local.html#method_sendRequest">DataSource.Local</a>:

9367

9368

9369

9370

<a href="../files/datasource_js_datasource-local.js.html#l348"><code>datasource/js/datasource-local.js:348</code></a>

9371

9372

</p>

9373

9374

9375

9376

9377

9378

</div>

9379

9380

9381

<p>Generates a unique transaction ID and fires <code>request</code> event.

9382

<strong>Note</strong>: the property <code>callback</code> is a

9383

deprecated alias for the <code>on</code> transaction configuration

9384

property described below.</p>

9385

</div>

9386

9387

9388

9389

<h4>Parameters:</h4>

9390

9391

9392

9393

9394

9395

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

9396

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

9397

9398

9399

9400

9401

9402

<p>An object literal with the following properties:

9403

<dl>

9404

<dt><code>request</code></dt>

9405

<dd>The request to send to the live data source, if any.</dd>

9406

9407

<dd>An object literal with the following properties:

9408

<dl>

9409

<dt><code>success</code></dt>

9410

<dd>The function to call when the data is ready.</dd>

9411

<dt><code>failure</code></dt>

9412

<dd>The function to call upon a response failure condition.</dd>

9413

<dt><code>argument</code></dt>

9414

<dd>Arbitrary data payload that will be passed back to the success and failure handlers.</dd>

9415

</dl>

9416

</dd>

9417

9418

<dd>Configuration object, if any.</dd>

9419

</dl></p>

9420

</div>

9421

9422

9423

</li>

9424

9425

</ul>

9426

</div>

9427

9428

9429

9430

9431

<h4>Returns:</h4>

9432

9433

9434

9435

9436

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

9437

9438

Transaction ID.

9439

9440

</div>

9441

</div>

9442

9443

9444

9445

</div>

9446

9447

9448

9449

9450

9451

9452

9453

9454

9455

9456

9457

9458

9459

</li>

9460

9461

9462

9463

<code>value</code>

9464

9465

</li>

9466

9467

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

9468

</div>

9469

9470

9471

9472

9473

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

9474

</span>

9475

9476

9477

9478

9479

9480

9481

9482

9483

9484

9485

9486

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

9487

9488

9489

9490

9491

<p>Inherited from

9492

9493

AttributeEvents

9494

</a>

9495

9496

but overwritten in

9497

9498

9499

9500

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

9501

9502

</p>

9503

9504

9505

9506

9507

9508

</div>

9509

9510

9511

<p>Sets the value of an attribute.</p>

9512

</div>

9513

9514

9515

9516

<h4>Parameters:</h4>

9517

9518

9519

9520

9521

9522

9523

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

9524

9525

9526

9527

9528

9529

<p>The name of the attribute. If the

9530

current value of the attribute is an Object, dot notation can be used

9531

to set the value of a property within the object (e.g. <code>set("x.y.z", 5)</code>).</p>

9532

</div>

9533

9534

9535

</li>

9536

9537

9538

9539

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

9540

9541

9542

9543

9544

9545

9546

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

9547

</div>

9548

9549

9550

</li>

9551

9552

</ul>

9553

</div>

9554

9555

9556

9557

9558

<h4>Returns:</h4>

9559

9560

9561

9562

9563

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

9564

9565

A reference to the host object.

9566

9567

</div>

9568

</div>

9569

9570

9571

9572

</div>

9573

9574

9575

9576

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

9577

9578

9579

9580

9581

9582

9583

9584

<code>attrs</code>

9585

9586

</li>

9587

9588

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

9589

</div>

9590

9591

9592

9593

9594

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

9595

</span>

9596

9597

9598

9599

9600

9601

9602

9603

9604

9605

9606

9607

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

9608

9609

9610

9611

9612

<p>Inherited from

9613

9614

AttributeEvents

9615

</a>

9616

9617

but overwritten in

9618

9619

9620

9621

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

9622

9623

</p>

9624

9625

9626

9627

9628

9629

</div>

9630

9631

9632

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

9633

</div>

9634

9635

9636

9637

<h4>Parameters:</h4>

9638

9639

9640

9641

9642

9643

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

9644

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

9645

9646

9647

9648

9649

9650

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

9651

</div>

9652

9653

9654

</li>

9655

9656

</ul>

9657

</div>

9658

9659

9660

9661

9662

<h4>Returns:</h4>

9663

9664

9665

9666

9667

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

9668

9669

A reference to the host object.

9670

9671

</div>

9672

</div>

9673

9674

9675

9676

</div>

9677

9678

9679

9680

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

9681

9682

9683

9684

9685

9686

9687

9688

9689

9690

</li>

9691

9692

9693

9694

<code>request</code>

9695

9696

</li>

9697

9698

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

9699

</div>

9700

9701

9702

9703

9704

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

9705

</span>

9706

9707

9708

9709

9710

9711

9712

9713

9714

9715

9716

9717

9718

9719

9720

9721

9722

<p>

9723

9724

Defined in

9725

9726

9727

9728

9729

<a href="../files/datasource_js_datasource-polling.js.html#l27"><code>datasource/js/datasource-polling.js:27</code></a>

9730

9731

</p>

9732

9733

9734

9735

9736

9737

</div>

9738

9739

9740

<p>Sets up a polling mechanism to send requests at set intervals and

9741

forward responses to given callback.</p>

9742

</div>

9743

9744

9745

9746

<h4>Parameters:</h4>

9747

9748

9749

9750

9751

9752

9753

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

9754

9755

9756

9757

9758

9759

<p>Length of interval in milliseconds.</p>

9760

</div>

9761

9762

9763

</li>

9764

9765

9766

9767

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

9768

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

9769

9770

9771

9772

9773

9774

<p>An object literal with the following properties:

9775

<dl>

9776

<dt><code>request</code></dt>

9777

<dd>The request to send to the live data source, if any.</dd>

9778

<dt><code>callback</code></dt>

9779

<dd>An object literal with the following properties:

9780

<dl>

9781

<dt><code>success</code></dt>

9782

<dd>The function to call when the data is ready.</dd>

9783

<dt><code>failure</code></dt>

9784

<dd>The function to call upon a response failure condition.</dd>

9785

<dt><code>argument</code></dt>

9786

<dd>Arbitrary data payload that will be passed back to the success and failure handlers.</dd>

9787

</dl>

9788

</dd>

9789

9790

<dd>Configuration object, if any.</dd>

9791

</dl></p>

9792

</div>

9793

9794

9795

</li>

9796

9797

</ul>

9798

</div>

9799

9800

9801

9802

9803

<h4>Returns:</h4>

9804

9805

9806

9807

9808

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

9809

9810

Interval ID.

9811

9812

</div>

9813

</div>

9814

9815

9816

9817

</div>

9818

9819

9820

9821

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

9822

9823

9824

9825

9826

9827

9828

9829

9830

<span class="flag deprecated" title="use on">deprecated</span>

9831

9832

9833

9834

9835

9836

9837

9838

9839

9840

9841

9842

9843

9844

<p>Inherited from

9845

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

9846

9847

9848

9849

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

9850

9851

</p>

9852

9853

9854

9855

<p>Deprecated: use on</p>

9856

9857

9858

9859

</div>

9860

9861

9862

<p>subscribe to an event</p>

9863

</div>

9864

9865

9866

9867

9868

9869

9870

</div>

9871

9872

9873

9874

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

9875

9876

9877

9878

9879

9880

9881

9882

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

9883

</span>

9884

9885

9886

9887

9888

9889

9890

9891

9892

9893

9894

9895

9896

9897

9898

9899

<p>Inherited from

9900

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

9901

9902

9903

9904

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

9905

9906

</p>

9907

9908

9909

9910

9911

9912

</div>

9913

9914

9915

<p>Default toString implementation. Provides the constructor NAME

9916

and the instance guid, if set.</p>

9917

</div>

9918

9919

9920

9921

9922

9923

<h4>Returns:</h4>

9924

9925

9926

9927

9928

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

9929

9930

String representation for this object

9931

9932

</div>

9933

</div>

9934

9935

9936

9937

</div>

9938

9939

9940

9941

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

9942

9943

9944

9945

9946

9947

9948

9949

9950

<span class="flag deprecated" title="use detach">deprecated</span>

9951

9952

9953

9954

9955

9956

9957

9958

9959

9960

9961

9962

9963

9964

<p>Inherited from

9965

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

9966

9967

9968

9969

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

9970

9971

</p>

9972

9973

9974

9975

<p>Deprecated: use detach</p>

9976

9977

9978

9979

</div>

9980

9981

9982

<p>detach a listener</p>

9983

</div>

9984

9985

9986

9987

9988

9989

9990

</div>

9991

9992

9993

9994

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

9995

9996

9997

9998

9999

10000

10001

10002

10003

10004

</li>

10005

10006

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

10007

</div>

10008

10009

10010

10011

10012

10013

<span class="flag deprecated" title="use detachAll">deprecated</span>

10014

10015

10016

10017

10018

10019

10020

10021

10022

10023

10024

10025

10026

10027

<p>Inherited from

10028

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

10029

10030

10031

10032

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

10033

10034

</p>

10035

10036

10037

10038

<p>Deprecated: use detachAll</p>

10039

10040

10041

10042

</div>

10043

10044

10045

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

10046

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

10047

be removed.</p>

10048

</div>

10049

10050

10051

10052

<h4>Parameters:</h4>

10053

10054

10055

10056

10057

10058

10059

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

10060

10061

10062

10063

10064

10065

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

10066

</div>

10067

10068

10069

</li>

10070

10071

</ul>

10072

</div>

10073

10074

10075

10076

10077

10078

</div>

10079

10080

10081

</div>

10082

10083

10084

10085

10086

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

10087

10088

10089

10090

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

10091

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>

10092

10093

10094

10095

10096

<span class="flag protected">protected</span>

10097

10098

10099

10100

10101

10102

10103

10104

10105

10106

<p>Inherited from

10107

<a href="../classes/BaseCore.html#property__allowAdHocAttrs">BaseCore</a>:

10108

10109

10110

10111

<a href="../files/base_js_BaseCore.js.html#l100"><code>base/js/BaseCore.js:100</code></a>

10112

10113

</p>

10114

10115

10116

10117

10118

</div>

10119

10120

10121

<p>This property controls whether or not instances of this class should

10122

allow users to add ad-hoc attributes through the constructor configuration

10123

hash.</p>

10124

10125

<p>AdHoc attributes are attributes which are not defined by the class, and are

10126

not handled by the MyClass.<em>NON</em>ATTRS_CFG</p>

10127

</div>

10128

10129

10130

<p><strong>Default:</strong> undefined (false)</p>

10131

10132

10133

10134

10135

10136

</div>

10137

10138

10139

10140

<h3 class="name"><code>_intervals</code></h3>

10141

<span class="type">Unknown</span>

10142

10143

10144

10145

10146

<span class="flag private">private</span>

10147

10148

10149

10150

10151

10152

10153

10154

10155

10156

10157

<p>

10158

10159

Defined in

10160

10161

10162

10163

10164

<a href="../files/datasource_js_datasource-polling.js.html#l19"><code>datasource/js/datasource-polling.js:19</code></a>

10165

10166

</p>

10167

10168

10169

10170

10171

</div>

10172

10173

10174

<p>Hash of polling interval IDs that have been enabled,

10175

stored here to be able to clear all intervals.</p>

10176

</div>

10177

10178

10179

10180

10181

10182

10183

</div>

10184

10185

10186

10187

10188

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

10189

10190

10191

<span class="flag deprecated" title="Use this.constructor.NAME">deprecated</span>

10192

10193

10194

10195

10196

10197

10198

10199

10200

10201

10202

10203

<p>Inherited from

10204

<a href="../classes/BaseCore.html#property_name">BaseCore</a>:

10205

10206

10207

10208

<a href="../files/base_js_BaseCore.js.html#l196"><code>base/js/BaseCore.js:196</code></a>

10209

10210

</p>

10211

10212

10213

<p>Deprecated: Use this.constructor.NAME</p>

10214

10215

10216

10217

</div>

10218

10219

10220

<p>The string used to identify the class of this object.</p>

10221

</div>

10222

10223

10224

10225

10226

10227

10228

</div>

10229

10230

10231

</div>

10232

10233

10234

10235

10236

<h2 class="off-left">Attributes</h2>

10237

10238

10239

10240

10241

<h3 class="name"><code>destroyed</code></h3>

10242

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>

10243

10244

10245

10246

10247

10248

10249

10250

10251

10252

10253

10254

10255

<p>Inherited from

10256

<a href="../classes/BaseCore.html#attr_destroyed">BaseCore</a>:

10257

10258

10259

10260

<a href="../files/base_js_BaseCore.js.html#l157"><code>base/js/BaseCore.js:157</code></a>

10261

10262

</p>

10263

10264

10265

10266

10267

</div>

10268

10269

10270

<p>Flag indicating whether or not this object

10271

has been through the destroy lifecycle phase.</p>

10272

</div>

10273

10274

10275

<p><strong>Default:</strong> false</p>

10276

10277

10278

10279

10280

<h4>Fires event <code>destroyedChange</code></h4>

10281

10282

<p>

10283

Fires when the value for the configuration attribute <code>destroyed</code> is

10284

changed. You can listen for the event using the <code>on</code> method if you

10285

wish to be notified before the attribute's value has changed, or

10286

using the <code>after</code> method if you wish to be notified after the

10287

attribute's value has changed.

10288

</p>

10289

10290

10291

<h4>Parameters:</h4>

10292

10293

10294

10295

10296

<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>

10297

10298

10299

An Event Facade object with the following

10300

attribute-specific properties added:

10301

</div>

10302

10303

10304

10305

<code class="param-name">prevVal</code>

10306

10307

<div class="param-description">The value of the attribute, prior to it being set.</div>

10308

</li>

10309

10310

<code class="param-name">newVal</code>

10311

10312

<div class="param-description">The value the attribute is to be set to.</div>

10313

</li>

10314

10315

<code class="param-name">attrName</code>

10316

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

10317

<div class="param-description">The name of the attribute being set.</div>

10318

</li>

10319

10320

<code class="param-name">subAttrName</code>

10321

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

10322

<div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div>

10323

</li>

10324

</ul>

10325

</li>

10326

</ul>

10327

</div>

10328

</div>

10329

10330

10331

10332

</div>

10333

10334

10335

10336

10337

<h3 class="name"><code>initialized</code></h3>

10338

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>

10339

10340

10341

10342

10343

10344

10345

10346

10347

10348

10349

10350

10351

<p>Inherited from

10352

<a href="../classes/BaseCore.html#attr_initialized">BaseCore</a>:

10353

10354

10355

10356

<a href="../files/base_js_BaseCore.js.html#l143"><code>base/js/BaseCore.js:143</code></a>

10357

10358

</p>

10359

10360

10361

10362

10363

</div>

10364

10365

10366

<p>Flag indicating whether or not this object

10367

has been through the init lifecycle phase.</p>

10368

</div>

10369

10370

10371

<p><strong>Default:</strong> false</p>

10372

10373

10374

10375

10376

<h4>Fires event <code>initializedChange</code></h4>

10377

10378

<p>

10379

Fires when the value for the configuration attribute <code>initialized</code> is

10380

changed. You can listen for the event using the <code>on</code> method if you

10381

wish to be notified before the attribute's value has changed, or

10382

using the <code>after</code> method if you wish to be notified after the

10383

attribute's value has changed.

10384

</p>

10385

10386

10387

<h4>Parameters:</h4>

10388

10389

10390

10391

10392

<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>

10393

10394

10395

An Event Facade object with the following

10396

attribute-specific properties added:

10397

</div>

10398

10399

10400

10401

<code class="param-name">prevVal</code>

10402

10403

<div class="param-description">The value of the attribute, prior to it being set.</div>

10404

</li>

10405

10406

<code class="param-name">newVal</code>

10407

10408

<div class="param-description">The value the attribute is to be set to.</div>

10409

</li>

10410

10411

<code class="param-name">attrName</code>

10412

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

10413

<div class="param-description">The name of the attribute being set.</div>

10414

</li>

10415

10416

<code class="param-name">subAttrName</code>

10417

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

10418

<div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div>

10419

</li>

10420

</ul>

10421

</li>

10422

</ul>

10423

</div>

10424

</div>

10425

10426

10427

10428

</div>

10429

10430

10431

10432

10433

<h3 class="name"><code>source</code></h3>

10434

<span class="type">MIXED</span>

10435

10436

10437

10438

10439

10440

10441

10442

10443

10444

10445

10446

10447

<p>Inherited from

10448

<a href="../classes/DataSource.Local.html#attr_source">DataSource.Local</a>:

10449

10450

10451

10452

<a href="../files/datasource_js_datasource-local.js.html#l54"><code>datasource/js/datasource-local.js:54</code></a>

10453

10454

</p>

10455

10456

10457

10458

10459

</div>

10460

10461

10462

<p>Pointer to live data.</p>

10463

</div>

10464

10465

10466

<p><strong>Default:</strong> null</p>

10467

10468

10469

10470

10471

<h4>Fires event <code>sourceChange</code></h4>

10472

10473

<p>

10474

Fires when the value for the configuration attribute <code>source</code> is

10475

changed. You can listen for the event using the <code>on</code> method if you

10476

wish to be notified before the attribute's value has changed, or

10477

using the <code>after</code> method if you wish to be notified after the

10478

attribute's value has changed.

10479

</p>

10480

10481

10482

<h4>Parameters:</h4>

10483

10484

10485

10486

10487

<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>

10488

10489

10490

An Event Facade object with the following

10491

attribute-specific properties added:

10492

</div>

10493

10494

10495

10496

<code class="param-name">prevVal</code>

10497

10498

<div class="param-description">The value of the attribute, prior to it being set.</div>

10499

</li>

10500

10501

<code class="param-name">newVal</code>

10502

10503

<div class="param-description">The value the attribute is to be set to.</div>

10504

</li>

10505

10506

<code class="param-name">attrName</code>

10507

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

10508

<div class="param-description">The name of the attribute being set.</div>

10509

</li>

10510

10511

<code class="param-name">subAttrName</code>

10512

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

10513

<div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div>

10514

</li>

10515

</ul>

10516

</li>

10517

</ul>

10518

</div>

10519

</div>

10520

10521

10522

10523

</div>

10524

10525

10526

</div>

10527

10528

10529

10530

10531

<h2 class="off-left">Events</h2>

10532

10533

10534

10535

10536

10537

10538

10539

10540

10541

10542

10543

10544

10545

10546

10547

10548

10549

<p>Inherited from

10550

<a href="../classes/DataSource.Local.html#event_data">DataSource.Local</a>:

10551

10552

10553

10554

<a href="../files/datasource_js_datasource-local.js.html#l148"><code>datasource/js/datasource-local.js:148</code></a>

10555

10556

</p>

10557

10558

10559

10560

10561

</div>

10562

10563

10564

<p>Fired when raw data is received.</p>

10565

</div>

10566

10567

10568

10569

<h4>Event Payload:</h4>

10570

10571

10572

10573

10574

10575

10576

<span class="type"><a href="../classes/EventFacade.html" class="crosslink">Event.Facade</a></span>

10577

10578

10579

10580

10581

10582

<p>Event Facade with the following properties:</p>

10583

10584

<dl>

10585

<dt>tId (Number)</dt> <dd>Unique transaction ID.</dd>

10586

<dt>request (Object)</dt> <dd>The request.</dd>

10587

<dt>callback (Object)</dt> <dd>Deprecated alias for the

10588

<strong>on</strong> property</dd>

10589

<dt>on (Object)</dt> <dd>The map of configured transaction

10590

callbacks. An object with the following properties:

10591

<dl>

10592

<dt>success (Function)</dt> <dd>Success handler.</dd>

10593

<dt>failure (Function)</dt> <dd>Failure handler.</dd>

10594

</dl>

10595

</dd>

10596

<dt>cfg (Object)</dt> <dd>Configuration object.</dd>

10597

<dt>data (Object)</dt> <dd>Raw data.</dd>

10598

</dl>

10599

</div>

10600

10601

10602

</li>

10603

10604

</ul>

10605

</div>

10606

10607

10608

10609

10610

</div>

10611

10612

10613

10614

<h3 class="name"><code>destroy</code></h3>

10615

10616

10617

10618

10619

10620

10621

10622

10623

10624

10625

10626

10627

10628

<p>Inherited from

10629

<a href="../classes/Base.html#event_destroy">Base</a>:

10630

10631

10632

10633

10634

10635

</p>

10636

10637

10638

10639

10640

</div>

10641

10642

10643

<p>

10644

Lifecycle event for the destroy phase,

10645

fired prior to destruction. Invoking the preventDefault

10646

method on the event object provided to subscribers will

10647

prevent destruction from proceeding.

10648

</p>

10649

10650

<p>

10651

Subscribers to the "after" moment of this event, will be notified

10652

after destruction is complete (and as a result cannot prevent

10653

destruction).

10654

</p>

10655

</div>

10656

10657

10658

10659

<h4>Event Payload:</h4>

10660

10661

10662

10663

10664

10665

10666

<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>

10667

10668

10669

10670

10671

10672

<p>Event object</p>

10673

</div>

10674

10675

10676

</li>

10677

10678

</ul>

10679

</div>

10680

10681

10682

10683

10684

</div>

10685

10686

10687

10688

<h3 class="name"><code>error</code></h3>

10689

10690

10691

10692

10693

10694

10695

10696

10697

10698

10699

10700

10701

10702

<p>Inherited from

10703

<a href="../classes/DataSource.Local.html#event_error">DataSource.Local</a>:

10704

10705

10706

10707

<a href="../files/datasource_js_datasource-local.js.html#l206"><code>datasource/js/datasource-local.js:206</code></a>

10708

10709

</p>

10710

10711

10712

10713

10714

</div>

10715

10716

10717

<p>Fired when an error is encountered.</p>

10718

</div>

10719

10720

10721

10722

<h4>Event Payload:</h4>

10723

10724

10725

10726

10727

10728

10729

<span class="type"><a href="../classes/EventFacade.html" class="crosslink">Event.Facade</a></span>

10730

10731

10732

10733

10734

10735

<p>Event Facade with the following properties:</p>

10736

10737

<dl>

10738

<dt>tId (Number)</dt> <dd>Unique transaction ID.</dd>

10739

<dt>request (Object)</dt> <dd>The request.</dd>

10740

<dt>callback (Object)</dt> <dd>Deprecated alias for the

10741

<strong>on</strong> property</dd>

10742

<dt>on (Object)</dt> <dd>The map of configured transaction

10743

callbacks. An object with the following properties:

10744

<dl>

10745

<dt>success (Function)</dt> <dd>Success handler.</dd>

10746

<dt>failure (Function)</dt> <dd>Failure handler.</dd>

10747

</dl>

10748

</dd>

10749

<dt>cfg (Object)</dt> <dd>Configuration object.</dd>

10750

<dt>data (Object)</dt> <dd>Raw data.</dd>

10751

<dt>response (Object)</dt>

10752

<dd>Normalized response object with the following properties:

10753

<dl>

10754

<dt>results (Object)</dt> <dd>Parsed results.</dd>

10755

<dt>meta (Object)</dt> <dd>Parsed meta data.</dd>

10756

<dt>error (Object)</dt> <dd>Error object.</dd>

10757

</dl>

10758

</dd>

10759

<dt>error</dt>

10760

<dd>Any error that occurred along the transaction lifecycle.</dd>

10761

</dl>

10762

</div>

10763

10764

10765

</li>

10766

10767

</ul>

10768

</div>

10769

10770

10771

10772

10773

</div>

10774

10775

10776

10777

10778

10779

10780

10781

10782

10783

10784

10785

10786

10787

10788

10789

10790

10791

<p>Inherited from

10792

<a href="../classes/Base.html#event_init">Base</a>:

10793

10794

10795

10796

10797

10798

</p>

10799

10800

10801

10802

10803

</div>

10804

10805

10806

<p>

10807

Lifecycle event for the init phase, fired prior to initialization.

10808

Invoking the preventDefault() method on the event object provided

10809

to subscribers will prevent initialization from occuring.

10810

</p>

10811

10812

<p>

10813

Subscribers to the "after" momemt of this event, will be notified

10814

after initialization of the object is complete (and therefore

10815

cannot prevent initialization).

10816

</p>

10817

</div>

10818

10819

10820

10821

<h4>Event Payload:</h4>

10822

10823

10824

10825

10826

10827

10828

<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>

10829

10830

10831

10832

10833

10834

<p>Event object, with a cfg property which

10835

refers to the configuration object passed to the constructor.</p>

10836

</div>

10837

10838

10839

</li>

10840

10841

</ul>

10842

</div>

10843

10844

10845

10846

10847

</div>

10848

10849

10850

10851

<h3 class="name"><code>request</code></h3>

10852

10853

10854

10855

10856

10857

10858

10859

10860

10861

10862

10863

10864

10865

<p>Inherited from

10866

<a href="../classes/DataSource.Local.html#event_request">DataSource.Local</a>:

10867

10868

10869

10870

<a href="../files/datasource_js_datasource-local.js.html#l130"><code>datasource/js/datasource-local.js:130</code></a>

10871

10872

</p>

10873

10874

10875

10876

10877

</div>

10878

10879

10880

<p>Fired when a data request is received.</p>

10881

</div>

10882

10883

10884

10885

<h4>Event Payload:</h4>

10886

10887

10888

10889

10890

10891

10892

<span class="type"><a href="../classes/EventFacade.html" class="crosslink">Event.Facade</a></span>

10893

10894

10895

10896

10897

10898

<p>Event Facade with the following properties:</p>

10899

10900

<dl>

10901

<dt>tId (Number)</dt> <dd>Unique transaction ID.</dd>

10902

<dt>request (Object)</dt> <dd>The request.</dd>

10903

<dt>callback (Object)</dt> <dd>The callback object

10904

(deprecated, refer to <strong>on</strong></dd>

10905

<dt>on (Object)</dt> <dd>The map of configured callback

10906

functions.</dd>

10907

<dt>cfg (Object)</dt> <dd>Configuration object.</dd>

10908

</dl>

10909

</div>

10910

10911

10912

</li>

10913

10914

</ul>

10915

</div>

10916

10917

10918

10919

10920

</div>

10921

10922

10923

10924

<h3 class="name"><code>response</code></h3>

10925

10926

10927

10928

10929

10930

10931

10932

10933

10934

10935

10936

10937

10938

<p>Inherited from

10939

<a href="../classes/DataSource.Local.html#event_response">DataSource.Local</a>:

10940

10941

10942

10943

<a href="../files/datasource_js_datasource-local.js.html#l172"><code>datasource/js/datasource-local.js:172</code></a>

10944

10945

</p>

10946

10947

10948

10949

10950

</div>

10951

10952

10953

<p>Fired when response is returned.</p>

10954

</div>

10955

10956

10957

10958

<h4>Event Payload:</h4>

10959

10960

10961

10962

10963

10964

10965

<span class="type"><a href="../classes/EventFacade.html" class="crosslink">Event.Facade</a></span>

10966

10967

10968

10969

10970

10971

<p>Event Facade with the following properties:</p>

10972

10973

<dl>

10974

<dt>tId (Number)</dt> <dd>Unique transaction ID.</dd>

10975

<dt>request (Object)</dt> <dd>The request.</dd>

10976

<dt>callback (Object)</dt> <dd>Deprecated alias for the

10977

<strong>on</strong> property</dd>

10978

<dt>on (Object)</dt> <dd>The map of configured transaction

10979

callbacks. An object with the following properties:

10980

<dl>

10981

<dt>success (Function)</dt> <dd>Success handler.</dd>

10982

<dt>failure (Function)</dt> <dd>Failure handler.</dd>

10983

</dl>

10984

</dd>

10985

<dt>cfg (Object)</dt> <dd>Configuration object.</dd>

10986

<dt>data (Object)</dt> <dd>Raw data.</dd>

10987

<dt>response (Object)</dt>

10988

<dd>Normalized response object with the following properties:

10989

<dl>

10990

<dt>results (Object)</dt> <dd>Parsed results.</dd>

10991

<dt>meta (Object)</dt> <dd>Parsed meta data.</dd>

10992

<dt>error (Boolean)</dt> <dd>Error flag.</dd>

10993

</dl>

10994

</dd>

10995

<dt>error</dt>

10996

<dd>Any error that occurred along the transaction lifecycle.</dd>

10997

</dl>

10998

</div>

10999

11000

11001

</li>

11002

11003

</ul>

11004

</div>

11005

11006

11007

11008

11009

</div>

11010

11011

11012

</div>

11013

11014

</div>

11015

</div>

11016

11017

</div>

11018

</div>

11019

</div>

11020

</div>

11021

</div>

11022

</div>

11023

11024

11025

11026

11027

11028

11029

11030

11031

</body>

11032

</html>

Older »