~smagoun/whoopsie/whoopsie-lp1017637

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

2064

2065

2066

2067

2068

2069

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

2070

</div>

2071

2072

2073

</li>

2074

2075

2076

2077

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

2078

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

2079

2080

2081

2082

2083

2084

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

2085

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

2086

</div>

2087

2088

2089

</li>

2090

2091

2092

2093

2094

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

2095

2096

2097

2098

2099

2100

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

2101

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

2102

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

2103

</div>

2104

2105

2106

</li>

2107

2108

</ul>

2109

</div>

2110

2111

2112

2113

2114

2115

</div>

2116

2117

2118

2119

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

2120

2121

2122

2123

2124

2125

2126

2127

2128

2129

</li>

2130

2131

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

2132

</div>

2133

2134

2135

2136

2137

2138

2139

2140

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

2141

2142

2143

2144

2145

2146

2147

2148

2149

2150

2151

2152

<p>Inherited from

2153

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

2154

2155

2156

2157

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

2158

2159

</p>

2160

2161

2162

2163

2164

2165

</div>

2166

2167

2168

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

2169

</div>

2170

2171

2172

2173

<h4>Parameters:</h4>

2174

2175

2176

2177

2178

2179

2180

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

2181

2182

2183

2184

2185

2186

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

2187

</div>

2188

2189

2190

</li>

2191

2192

</ul>

2193

</div>

2194

2195

2196

2197

2198

2199

</div>

2200

2201

2202

2203

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

2204

2205

2206

2207

2208

2209

2210

2211

<code>allAttrs</code>

2212

2213

</li>

2214

2215

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

2216

</div>

2217

2218

2219

2220

2221

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

2222

</span>

2223

2224

2225

2226

2227

2228

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

2229

2230

2231

2232

2233

2234

2235

2236

2237

2238

2239

2240

<p>Inherited from

2241

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

2242

2243

2244

2245

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

2246

2247

</p>

2248

2249

2250

2251

2252

2253

</div>

2254

2255

2256

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

2257

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

2258

2259

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

2260

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

2261

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

2262

</div>

2263

2264

2265

2266

<h4>Parameters:</h4>

2267

2268

2269

2270

2271

2272

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

2273

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

2274

2275

2276

2277

2278

2279

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

2280

(subclass first, Base last)</p>

2281

</div>

2282

2283

2284

</li>

2285

2286

</ul>

2287

</div>

2288

2289

2290

2291

2292

<h4>Returns:</h4>

2293

2294

2295

2296

2297

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

2298

2299

The aggregate set of ATTRS definitions for the instance

2300

2301

</div>

2302

</div>

2303

2304

2305

2306

</div>

2307

2308

2309

2310

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

2311

2312

2313

2314

2315

2316

2317

2318

2319

2320

2321

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

2322

2323

2324

2325

2326

2327

2328

2329

2330

2331

2332

<p>Inherited from

2333

2334

BaseCore

2335

</a>

2336

2337

but overwritten in

2338

2339

2340

2341

2342

2343

</p>

2344

2345

2346

2347

2348

2349

</div>

2350

2351

2352

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

2353

this class.</p>

2354

</div>

2355

2356

2357

2358

2359

2360

2361

</div>

2362

2363

2364

2365

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

2366

2367

2368

2369

2370

2371

2372

2373

2374

2375

2376

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

2377

2378

2379

2380

2381

2382

2383

2384

2385

2386

2387

2388

<p>Inherited from

2389

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

2390

2391

2392

2393

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

2394

2395

</p>

2396

2397

2398

2399

2400

2401

</div>

2402

2403

2404

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

2405

</div>

2406

2407

2408

2409

2410

2411

2412

</div>

2413

2414

2415

2416

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

2417

2418

2419

2420

2421

2422

2423

2424

2425

2426

2427

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

2428

2429

2430

2431

2432

2433

2434

2435

2436

2437

2438

2439

<p>Inherited from

2440

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

2441

2442

2443

2444

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

2445

2446

</p>

2447

2448

2449

2450

2451

2452

</div>

2453

2454

2455

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

2456

</div>

2457

2458

2459

2460

2461

2462

2463

</div>

2464

2465

2466

2467

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

2468

2469

2470

2471

2472

2473

2474

2475

2476

2477

</li>

2478

2479

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

2480

</div>

2481

2482

2483

2484

2485

2486

2487

2488

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

2489

2490

2491

2492

2493

2494

2495

2496

2497

2498

2499

2500

<p>Inherited from

2501

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

2502

2503

2504

2505

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

2506

2507

</p>

2508

2509

2510

2511

2512

2513

</div>

2514

2515

2516

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

2517

</div>

2518

2519

2520

2521

<h4>Parameters:</h4>

2522

2523

2524

2525

2526

2527

2528

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

2529

2530

2531

2532

2533

2534

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

2535

</div>

2536

2537

2538

</li>

2539

2540

</ul>

2541

</div>

2542

2543

2544

2545

2546

2547

</div>

2548

2549

2550

2551

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

2552

2553

2554

2555

2556

2557

2558

2559

2560

2561

</li>

2562

2563

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

2564

</div>

2565

2566

2567

2568

2569

2570

2571

2572

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

2573

2574

2575

2576

2577

2578

2579

2580

2581

2582

2583

2584

<p>Inherited from

2585

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

2586

2587

2588

2589

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

2590

2591

</p>

2592

2593

2594

2595

2596

2597

</div>

2598

2599

2600

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

2601

</div>

2602

2603

2604

2605

<h4>Parameters:</h4>

2606

2607

2608

2609

2610

2611

2612

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

2613

2614

2615

2616

2617

2618

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

2619

2620

<dl>

2621

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

2622

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

2623

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

2624

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

2625

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

2626

callbacks. An object with the following properties:

2627

<dl>

2628

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

2629

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

2630

</dl>

2631

</dd>

2632

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

2633

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

2634

</dl>

2635

</div>

2636

2637

2638

</li>

2639

2640

</ul>

2641

</div>

2642

2643

2644

2645

2646

2647

</div>

2648

2649

2650

2651

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

2652

2653

2654

2655

2656

2657

2658

2659

2660

2661

</li>

2662

2663

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

2664

</div>

2665

2666

2667

2668

2669

2670

2671

2672

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

2673

2674

2675

2676

2677

2678

2679

2680

2681

2682

2683

2684

<p>Inherited from

2685

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

2686

2687

2688

2689

2690

2691

</p>

2692

2693

2694

2695

2696

2697

</div>

2698

2699

2700

<p>Default destroy event handler</p>

2701

</div>

2702

2703

2704

2705

<h4>Parameters:</h4>

2706

2707

2708

2709

2710

2711

2712

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

2713

2714

2715

2716

2717

2718

<p>Event object</p>

2719

</div>

2720

2721

2722

</li>

2723

2724

</ul>

2725

</div>

2726

2727

2728

2729

2730

2731

</div>

2732

2733

2734

2735

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

2736

2737

2738

2739

2740

2741

2742

2743

2744

2745

</li>

2746

2747

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

2748

</div>

2749

2750

2751

2752

2753

2754

2755

2756

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

2757

2758

2759

2760

2761

2762

2763

2764

2765

2766

2767

2768

<p>Inherited from

2769

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

2770

2771

2772

2773

2774

2775

</p>

2776

2777

2778

2779

2780

2781

</div>

2782

2783

2784

<p>Default init event handler</p>

2785

</div>

2786

2787

2788

2789

<h4>Parameters:</h4>

2790

2791

2792

2793

2794

2795

2796

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

2797

2798

2799

2800

2801

2802

<p>Event object, with a cfg property which

2803

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

2804

</div>

2805

2806

2807

</li>

2808

2809

</ul>

2810

</div>

2811

2812

2813

2814

2815

2816

</div>

2817

2818

2819

2820

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

2821

2822

2823

2824

2825

2826

2827

2828

2829

2830

</li>

2831

2832

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

2833

</div>

2834

2835

2836

2837

2838

2839

2840

2841

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

2842

2843

2844

2845

2846

2847

2848

2849

2850

2851

2852

<p>Inherited from

2853

2854

DataSource.Local

2855

</a>

2856

2857

but overwritten in

2858

2859

2860

2861

<a href="../files/datasource_js_datasource-function.js.html#l59"><code>datasource/js/datasource-function.js:59</code></a>

2862

2863

</p>

2864

2865

2866

2867

2868

2869

</div>

2870

2871

2872

<p>Passes query string to IO. Fires <code>response</code> event when

2873

response is received asynchronously.</p>

2874

</div>

2875

2876

2877

2878

<h4>Parameters:</h4>

2879

2880

2881

2882

2883

2884

2885

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

2886

2887

2888

2889

2890

2891

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

2892

2893

<dl>

2894

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

2895

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

2896

<dt>callback (Object)</dt> <dd>The callback object with the following properties:

2897

<dl>

2898

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

2899

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

2900

</dl>

2901

</dd>

2902

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

2903

</dl>

2904

</div>

2905

2906

2907

</li>

2908

2909

</ul>

2910

</div>

2911

2912

2913

2914

2915

2916

</div>

2917

2918

2919

2920

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

2921

2922

2923

2924

2925

2926

2927

2928

2929

2930

</li>

2931

2932

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

2933

</div>

2934

2935

2936

2937

2938

2939

2940

2941

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

2942

2943

2944

2945

2946

2947

2948

2949

2950

2951

2952

2953

<p>Inherited from

2954

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

2955

2956

2957

2958

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

2959

2960

</p>

2961

2962

2963

2964

2965

2966

</div>

2967

2968

2969

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

2970

</div>

2971

2972

2973

2974

<h4>Parameters:</h4>

2975

2976

2977

2978

2979

2980

2981

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

2982

2983

2984

2985

2986

2987

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

2988

2989

<dl>

2990

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

2991

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

2992

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

2993

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

2994

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

2995

callbacks. An object with the following properties:

2996

<dl>

2997

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

2998

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

2999

</dl>

3000

</dd>

3001

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

3002

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

3003

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

3004

<dl>

3005

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

3006

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

3007

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

3008

</dl>

3009

</dd>

3010

</dl>

3011

</div>

3012

3013

3014

</li>

3015

3016

</ul>

3017

</div>

3018

3019

3020

3021

3022

3023

</div>

3024

3025

3026

3027

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

3028

3029

3030

3031

3032

3033

3034

3035

3036

3037

3038

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

3039

3040

3041

3042

3043

3044

3045

3046

3047

3048

3049

3050

<p>Inherited from

3051

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

3052

3053

3054

3055

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

3056

3057

</p>

3058

3059

3060

3061

3062

3063

</div>

3064

3065

3066

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

3067

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

3068

</div>

3069

3070

3071

3072

3073

3074

3075

</div>

3076

3077

3078

3079

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

3080

3081

3082

3083

3084

3085

3086

3087

<code>allAttrs</code>

3088

3089

</li>

3090

3091

3092

3093

<code>userVals</code>

3094

3095

</li>

3096

3097

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

3098

</div>

3099

3100

3101

3102

3103

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

3104

</span>

3105

3106

3107

3108

3109

3110

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

3111

3112

3113

3114

3115

3116

3117

3118

3119

3120

3121

3122

<p>Inherited from

3123

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

3124

3125

3126

3127

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

3128

3129

</p>

3130

3131

3132

3133

3134

3135

</div>

3136

3137

3138

3139

</div>

3140

3141

3142

3143

<h4>Parameters:</h4>

3144

3145

3146

3147

3148

3149

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

3150

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

3151

3152

3153

3154

3155

3156

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

3157

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

3158

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

3159

</div>

3160

3161

3162

</li>

3163

3164

3165

3166

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

3167

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

3168

3169

3170

3171

3172

3173

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

3174

</div>

3175

3176

3177

</li>

3178

3179

</ul>

3180

</div>

3181

3182

3183

3184

3185

<h4>Returns:</h4>

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

3192

The set of adhoc attributes passed in, in the form

3193

of an object with attribute name/configuration pairs.

3194

3195

</div>

3196

</div>

3197

3198

3199

3200

</div>

3201

3202

3203

3204

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

3205

3206

3207

3208

3209

3210

3211

3212

<code>clazz</code>

3213

3214

</li>

3215

3216

3217

3218

<code>allCfgs</code>

3219

3220

</li>

3221

3222

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

3223

</div>

3224

3225

3226

3227

3228

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

3229

</span>

3230

3231

3232

3233

3234

3235

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

3236

3237

3238

3239

3240

3241

3242

3243

3244

3245

3246

3247

<p>Inherited from

3248

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

3249

3250

3251

3252

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

3253

3254

</p>

3255

3256

3257

3258

3259

3260

</div>

3261

3262

3263

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

3264

initialization. Returns a disposable object with the attributes defined for

3265

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

3266

</div>

3267

3268

3269

3270

<h4>Parameters:</h4>

3271

3272

3273

3274

3275

3276

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

3277

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

3278

3279

3280

3281

3282

3283

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

3284

</div>

3285

3286

3287

</li>

3288

3289

3290

3291

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

3292

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

3293

3294

3295

3296

3297

3298

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

3299

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

3300

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

3301

</div>

3302

3303

3304

</li>

3305

3306

</ul>

3307

</div>

3308

3309

3310

3311

3312

<h4>Returns:</h4>

3313

3314

3315

3316

3317

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

3318

3319

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

3320

of an object with attribute name/configuration pairs.

3321

3322

</div>

3323

</div>

3324

3325

3326

3327

</div>

3328

3329

3330

3331

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

3332

3333

3334

3335

3336

3337

3338

3339

<code>attrName</code>

3340

3341

</li>

3342

3343

3344

3345

<code>subAttrName</code>

3346

3347

</li>

3348

3349

3350

3351

<code>currVal</code>

3352

3353

</li>

3354

3355

3356

3357

<code>newVal</code>

3358

3359

</li>

3360

3361

3362

3363

3364

3365

</li>

3366

3367

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

3368

</div>

3369

3370

3371

3372

3373

3374

3375

3376

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

3377

3378

3379

3380

3381

3382

3383

3384

3385

3386

3387

3388

<p>Inherited from

3389

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

3390

3391

3392

3393

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

3394

3395

</p>

3396

3397

3398

3399

3400

3401

</div>

3402

3403

3404

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

3405

</div>

3406

3407

3408

3409

<h4>Parameters:</h4>

3410

3411

3412

3413

3414

3415

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

3416

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

3417

3418

3419

3420

3421

3422

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

3423

</div>

3424

3425

3426

</li>

3427

3428

3429

3430

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

3431

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

3432

3433

3434

3435

3436

3437

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

3438

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

3439

</div>

3440

3441

3442

</li>

3443

3444

3445

3446

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

3447

3448

3449

3450

3451

3452

3453

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

3454

</div>

3455

3456

3457

</li>

3458

3459

3460

3461

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

3462

3463

3464

3465

3466

3467

3468

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

3469

</div>

3470

3471

3472

</li>

3473

3474

3475

3476

3477

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

3478

3479

3480

3481

3482

3483

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

3484

</div>

3485

3486

3487

</li>

3488

3489

</ul>

3490

</div>

3491

3492

3493

3494

3495

3496

</div>

3497

3498

3499

3500

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

3501

3502

3503

3504

3505

3506

3507

3508

3509

3510

</li>

3511

3512

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

3513

</div>

3514

3515

3516

3517

3518

3519

</span>

3520

3521

3522

3523

3524

3525

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

3526

3527

3528

3529

3530

3531

3532

3533

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

3534

3535

3536

3537

3538

3539

<p>Inherited from

3540

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

3541

3542

3543

3544

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

3545

3546

</p>

3547

3548

3549

3550

3551

3552

</div>

3553

3554

3555

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

3556

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

3557

3558

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

3559

</div>

3560

3561

3562

3563

<h4>Parameters:</h4>

3564

3565

3566

3567

3568

3569

3570

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

3571

3572

3573

3574

3575

3576

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

3577

</div>

3578

3579

3580

</li>

3581

3582

</ul>

3583

</div>

3584

3585

3586

3587

3588

<h4>Returns:</h4>

3589

3590

3591

3592

3593

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

3594

3595

The value of the attribute.

3596

3597

</div>

3598

</div>

3599

3600

3601

3602

</div>

3603

3604

3605

3606

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

3607

3608

3609

3610

3611

3612

3613

3614

3615

3616

</li>

3617

3618

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

3619

</div>

3620

3621

3622

3623

3624

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

3625

</span>

3626

3627

3628

3629

3630

3631

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

3632

3633

3634

3635

3636

3637

3638

3639

3640

3641

3642

3643

<p>Inherited from

3644

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

3645

3646

3647

3648

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

3649

3650

</p>

3651

3652

3653

3654

3655

3656

</div>

3657

3658

3659

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

3660

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

3661

configuration properties for all attributes.</p>

3662

</div>

3663

3664

3665

3666

<h4>Parameters:</h4>

3667

3668

3669

3670

3671

3672

3673

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

3674

3675

3676

3677

3678

3679

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

3680

</div>

3681

3682

3683

</li>

3684

3685

</ul>

3686

</div>

3687

3688

3689

3690

3691

<h4>Returns:</h4>

3692

3693

3694

3695

3696

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

3697

3698

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

3699

3700

</div>

3701

</div>

3702

3703

3704

3705

</div>

3706

3707

3708

3709

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

3710

3711

3712

3713

3714

3715

3716

3717

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

3718

</span>

3719

3720

3721

3722

3723

3724

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

3725

3726

3727

3728

3729

3730

3731

3732

3733

3734

3735

3736

<p>Inherited from

3737

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

3738

3739

3740

3741

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

3742

3743

</p>

3744

3745

3746

3747

3748

3749

</div>

3750

3751

3752

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

3753

the class hierarchy.</p>

3754

</div>

3755

3756

3757

3758

3759

3760

<h4>Returns:</h4>

3761

3762

3763

3764

3765

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

3766

3767

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

3768

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

3769

the cached value.

3770

3771

</div>

3772

</div>

3773

3774

3775

3776

</div>

3777

3778

3779

3780

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

3781

3782

3783

3784

3785

3786

3787

3788

3789

3790

</li>

3791

3792

3793

3794

3795

3796

</li>

3797

3798

3799

3800

<code>initValues</code>

3801

3802

</li>

3803

3804

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

3805

</div>

3806

3807

3808

3809

3810

3811

</span>

3812

3813

3814

3815

3816

3817

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

3818

3819

3820

3821

3822

3823

3824

3825

3826

3827

3828

<p>Inherited from

3829

3830

AttributeCore

3831

</a>

3832

3833

but overwritten in

3834

3835

3836

3837

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

3838

3839

</p>

3840

3841

3842

3843

3844

3845

</div>

3846

3847

3848

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

3849

either the default configuration provided, or the

3850

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

3851

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

3852

</div>

3853

3854

3855

3856

<h4>Parameters:</h4>

3857

3858

3859

3860

3861

3862

3863

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

3864

3865

3866

3867

3868

3869

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

3870

</div>

3871

3872

3873

</li>

3874

3875

3876

3877

3878

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

3879

3880

3881

3882

3883

3884

<p>The attribute configuration object</p>

3885

</div>

3886

3887

3888

</li>

3889

3890

3891

3892

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

3893

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

3894

3895

3896

3897

3898

3899

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

3900

</div>

3901

3902

3903

</li>

3904

3905

</ul>

3906

</div>

3907

3908

3909

3910

3911

<h4>Returns:</h4>

3912

3913

3914

3915

3916

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

3917

3918

The initial value of the attribute.

3919

3920

</div>

3921

</div>

3922

3923

3924

3925

</div>

3926

3927

3928

3929

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

3930

3931

3932

3933

3934

3935

3936

3937

<code>attrs</code>

3938

3939

</li>

3940

3941

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

3942

</div>

3943

3944

3945

3946

3947

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

3948

</span>

3949

3950

3951

3952

3953

3954

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

3955

3956

3957

3958

3959

3960

3961

3962

3963

3964

3965

3966

<p>Inherited from

3967

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

3968

3969

3970

3971

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

3972

3973

</p>

3974

3975

3976

3977

3978

3979

</div>

3980

3981

3982

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

3983

</div>

3984

3985

3986

3987

<h4>Parameters:</h4>

3988

3989

3990

3991

3992

3993

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

3994

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

3995

3996

3997

3998

3999

4000

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

4001

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

4002

</div>

4003

4004

4005

</li>

4006

4007

</ul>

4008

</div>

4009

4010

4011

4012

4013

<h4>Returns:</h4>

4014

4015

4016

4017

4018

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

4019

4020

An object with attribute name/value pairs.

4021

4022

</div>

4023

</div>

4024

4025

4026

4027

</div>

4028

4029

4030

4031

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

4032

4033

4034

4035

4036

4037

4038

4039

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

4040

</span>

4041

4042

4043

4044

4045

4046

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

4047

4048

4049

4050

4051

4052

4053

4054

4055

4056

4057

4058

<p>Inherited from

4059

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

4060

4061

4062

4063

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

4064

4065

</p>

4066

4067

4068

4069

4070

4071

</div>

4072

4073

4074

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

4075

</div>

4076

4077

4078

4079

4080

4081

<h4>Returns:</h4>

4082

4083

4084

4085

4086

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

4087

4088

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

4089

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

4090

cached value.

4091

4092

</div>

4093

</div>

4094

4095

4096

4097

</div>

4098

4099

4100

4101

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

4102

4103

4104

4105

4106

4107

4108

4109

4110

4111

</li>

4112

4113

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

4114

</div>

4115

4116

4117

4118

4119

4120

</span>

4121

4122

4123

4124

4125

4126

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

4127

4128

4129

4130

4131

4132

4133

4134

4135

4136

4137

4138

<p>Inherited from

4139

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

4140

4141

4142

4143

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

4144

4145

</p>

4146

4147

4148

4149

4150

4151

</div>

4152

4153

4154

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

4155

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

4156

</div>

4157

4158

4159

4160

<h4>Parameters:</h4>

4161

4162

4163

4164

4165

4166

4167

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

4168

4169

4170

4171

4172

4173

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

4174

</div>

4175

4176

4177

</li>

4178

4179

</ul>

4180

</div>

4181

4182

4183

4184

4185

<h4>Returns:</h4>

4186

4187

4188

4189

4190

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

4191

4192

The stored value of the attribute

4193

4194

</div>

4195

</div>

4196

4197

4198

4199

</div>

4200

4201

4202

4203

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

4204

4205

4206

4207

4208

4209

4210

4211

4212

4213

4214

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

4215

4216

4217

4218

4219

4220

4221

4222

4223

4224

4225

4226

<p>Inherited from

4227

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

4228

4229

4230

4231

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

4232

4233

</p>

4234

4235

4236

4237

4238

4239

</div>

4240

4241

4242

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

4243

event type is not prefixed, the instance prefix is

4244

applied to the supplied type.</p>

4245

</div>

4246

4247

4248

4249

4250

4251

4252

</div>

4253

4254

4255

4256

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

4257

4258

4259

4260

4261

4262

4263

4264

<code>attrs</code>

4265

4266

</li>

4267

4268

4269

4270

<code>values</code>

4271

4272

</li>

4273

4274

4275

4276

4277

4278

</li>

4279

4280

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

4281

</div>

4282

4283

4284

4285

4286

4287

4288

4289

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

4290

4291

4292

4293

4294

4295

4296

4297

4298

4299

4300

4301

<p>Inherited from

4302

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

4303

4304

4305

4306

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

4307

4308

</p>

4309

4310

4311

4312

4313

4314

</div>

4315

4316

4317

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

4318

constructor.</p>

4319

</div>

4320

4321

4322

4323

<h4>Parameters:</h4>

4324

4325

4326

4327

4328

4329

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

4330

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

4331

4332

4333

4334

4335

4336

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

4337

</div>

4338

4339

4340

</li>

4341

4342

4343

4344

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

4345

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

4346

4347

4348

4349

4350

4351

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

4352

</div>

4353

4354

4355

</li>

4356

4357

4358

4359

4360

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

4361

4362

4363

4364

4365

4366

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

4367

</div>

4368

4369

4370

</li>

4371

4372

</ul>

4373

</div>

4374

4375

4376

4377

4378

4379

</div>

4380

4381

4382

4383

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

4384

4385

4386

4387

4388

4389

4390

4391

4392

4393

4394

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

4395

4396

4397

4398

4399

4400

4401

4402

4403

4404

4405

<p>Inherited from

4406

4407

BaseCore

4408

</a>

4409

4410

but overwritten in

4411

4412

4413

4414

4415

4416

</p>

4417

4418

4419

4420

4421

4422

</div>

4423

4424

4425

<p>Initializes Attribute</p>

4426

</div>

4427

4428

4429

4430

4431

4432

4433

</div>

4434

4435

4436

4437

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

4438

4439

4440

4441

4442

4443

4444

4445

<code>attrs</code>

4446

4447

</li>

4448

4449

4450

4451

<code>values</code>

4452

4453

</li>

4454

4455

4456

4457

4458

4459

</li>

4460

4461

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

4462

</div>

4463

4464

4465

4466

4467

4468

4469

4470

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

4471

4472

4473

4474

4475

4476

4477

4478

4479

4480

4481

4482

<p>Inherited from

4483

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

4484

4485

4486

4487

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

4488

4489

</p>

4490

4491

4492

4493

4494

4495

</div>

4496

4497

4498

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

4499

</div>

4500

4501

4502

4503

<h4>Parameters:</h4>

4504

4505

4506

4507

4508

4509

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

4510

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

4511

4512

4513

4514

4515

4516

4517

</div>

4518

4519

4520

</li>

4521

4522

4523

4524

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

4525

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

4526

4527

4528

4529

4530

4531

4532

</div>

4533

4534

4535

</li>

4536

4537

4538

4539

4540

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

4541

4542

4543

4544

4545

4546

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

4547

</div>

4548

4549

4550

</li>

4551

4552

</ul>

4553

</div>

4554

4555

4556

4557

4558

4559

</div>

4560

4561

4562

4563

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

4564

4565

4566

4567

4568

4569

4570

4571

<code>config</code>

4572

4573

</li>

4574

4575

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

4576

</div>

4577

4578

4579

4580

4581

4582

4583

4584

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

4585

4586

4587

4588

4589

4590

4591

4592

4593

4594

4595

<p>Inherited from

4596

4597

BaseCore

4598

</a>

4599

4600

but overwritten in

4601

4602

4603

4604

4605

4606

</p>

4607

4608

4609

4610

4611

4612

</div>

4613

4614

4615

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

4616

</div>

4617

4618

4619

4620

<h4>Parameters:</h4>

4621

4622

4623

4624

4625

4626

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

4627

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

4628

4629

4630

4631

4632

4633

<p>The constructor configuration object</p>

4634

</div>

4635

4636

4637

</li>

4638

4639

</ul>

4640

</div>

4641

4642

4643

4644

4645

4646

</div>

4647

4648

4649

4650

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

4651

4652

4653

4654

4655

4656

4657

4658

4659

4660

4661

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

4662

4663

4664

4665

4666

4667

4668

4669

4670

4671

4672

4673

<p>Inherited from

4674

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

4675

4676

4677

4678

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

4679

4680

</p>

4681

4682

4683

4684

4685

4686

</div>

4687

4688

4689

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

4690

</div>

4691

4692

4693

4694

4695

4696

4697

</div>

4698

4699

4700

4701

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

4702

4703

4704

4705

4706

4707

4708

4709

<code>userVals</code>

4710

4711

</li>

4712

4713

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

4714

</div>

4715

4716

4717

4718

4719

4720

4721

4722

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

4723

4724

4725

4726

4727

4728

4729

4730

4731

4732

4733

4734

<p>Inherited from

4735

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

4736

4737

4738

4739

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

4740

4741

</p>

4742

4743

4744

4745

4746

4747

</div>

4748

4749

4750

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

4751

initializing attributes for each class defined in the class's

4752

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

4753

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

4754

</div>

4755

4756

4757

4758

<h4>Parameters:</h4>

4759

4760

4761

4762

4763

4764

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

4765

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

4766

4767

4768

4769

4770

4771

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

4772

</div>

4773

4774

4775

</li>

4776

4777

</ul>

4778

</div>

4779

4780

4781

4782

4783

4784

</div>

4785

4786

4787

4788

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

4789

4790

4791

4792

4793

4794

4795

4796

4797

4798

4799

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

4800

4801

4802

4803

4804

4805

4806

4807

4808

4809

4810

4811

<p>Inherited from

4812

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

4813

4814

4815

4816

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

4817

4818

</p>

4819

4820

4821

4822

4823

4824

</div>

4825

4826

4827

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

4828

the array of classes and aggregate set of attribute configurations

4829

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

4830

</div>

4831

4832

4833

4834

4835

4836

4837

</div>

4838

4839

4840

4841

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

4842

4843

4844

4845

4846

4847

4848

4849

4850

4851

</li>

4852

4853

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

4854

</div>

4855

4856

4857

4858

4859

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

4860

</span>

4861

4862

4863

4864

4865

4866

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

4867

4868

4869

4870

4871

4872

4873

4874

4875

4876

4877

4878

<p>Inherited from

4879

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

4880

4881

4882

4883

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

4884

4885

</p>

4886

4887

4888

4889

4890

4891

</div>

4892

4893

4894

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

4895

added lazily and still requires initialization.</p>

4896

</div>

4897

4898

4899

4900

<h4>Parameters:</h4>

4901

4902

4903

4904

4905

4906

4907

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

4908

4909

4910

4911

4912

4913

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

4914

</div>

4915

4916

4917

</li>

4918

4919

</ul>

4920

</div>

4921

4922

4923

4924

4925

<h4>Returns:</h4>

4926

4927

4928

4929

4930

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

4931

4932

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

4933

4934

</div>

4935

</div>

4936

4937

4938

4939

</div>

4940

4941

4942

4943

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

4944

4945

4946

4947

4948

4949

4950

4951

4952

4953

</li>

4954

4955

4956

4957

4958

4959

</li>

4960

4961

4962

4963

4964

4965

</li>

4966

4967

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

4968

</div>

4969

4970

4971

4972

4973

4974

4975

4976

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

4977

4978

4979

4980

4981

4982

4983

4984

4985

4986

4987

4988

<p>Inherited from

4989

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

4990

4991

4992

4993

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

4994

4995

</p>

4996

4997

4998

4999

5000

5001

</div>

5002

5003

5004

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

5005

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

5006

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

5007

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

5008

be subscribed to like other events to monitor the event

5009

system. Inividual published events can have monitoring

5010

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

5011

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

5012

</div>

5013

5014

5015

5016

<h4>Parameters:</h4>

5017

5018

5019

5020

5021

5022

5023

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

5024

5025

5026

5027

5028

5029

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

5030

</div>

5031

5032

5033

</li>

5034

5035

5036

5037

5038

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

5039

5040

5041

5042

5043

5044

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

5045

</div>

5046

5047

5048

</li>

5049

5050

5051

5052

5053

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

5054

5055

5056

5057

5058

5059

<p>Information about the event interaction, such as

5060

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

5061

</div>

5062

5063

5064

</li>

5065

5066

</ul>

5067

</div>

5068

5069

5070

5071

5072

5073

</div>

5074

5075

5076

5077

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

5078

5079

5080

5081

5082

5083

5084

5085

<code>valueHash</code>

5086

5087

</li>

5088

5089

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

5090

</div>

5091

5092

5093

5094

5095

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

5096

</span>

5097

5098

5099

5100

5101

5102

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

5103

5104

5105

5106

5107

5108

5109

5110

5111

5112

5113

<p>Inherited from

5114

5115

AttributeCore

5116

</a>

5117

5118

but overwritten in

5119

5120

5121

5122

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

5123

5124

</p>

5125

5126

5127

5128

5129

5130

</div>

5131

5132

5133

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

5134

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

5135

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

5136

</div>

5137

5138

5139

5140

<h4>Parameters:</h4>

5141

5142

5143

5144

5145

5146

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

5147

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

5148

5149

5150

5151

5152

5153

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

5154

</div>

5155

5156

5157

</li>

5158

5159

</ul>

5160

</div>

5161

5162

5163

5164

5165

<h4>Returns:</h4>

5166

5167

5168

5169

5170

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

5171

5172

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

5173

containing simple and complex attribute values respectively keyed

5174

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

5175

5176

</div>

5177

</div>

5178

5179

5180

5181

</div>

5182

5183

5184

5185

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

5186

5187

5188

5189

5190

5191

5192

5193

5194

5195

5196

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

5197

5198

5199

5200

5201

5202

5203

5204

5205

5206

5207

5208

<p>Inherited from

5209

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

5210

5211

5212

5213

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

5214

5215

</p>

5216

5217

5218

5219

5220

5221

</div>

5222

5223

5224

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

5225

and the prefixed event name from _getType

5226

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

5227

</div>

5228

5229

5230

5231

5232

5233

5234

</div>

5235

5236

5237

5238

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

5239

5240

5241

5242

5243

5244

5245

5246

<code>config</code>

5247

5248

</li>

5249

5250

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

5251

</div>

5252

5253

5254

5255

5256

5257

5258

5259

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

5260

5261

5262

5263

5264

5265

5266

5267

5268

5269

5270

5271

<p>Inherited from

5272

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

5273

5274

5275

5276

5277

5278

</p>

5279

5280

5281

5282

5283

5284

</div>

5285

5286

5287

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

5288

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

5289

construction, prior to init.</p>

5290

</div>

5291

5292

5293

5294

<h4>Parameters:</h4>

5295

5296

5297

5298

5299

5300

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

5301

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

5302

5303

5304

5305

5306

5307

<p>The user configuration object</p>

5308

</div>

5309

5310

5311

</li>

5312

5313

</ul>

5314

</div>

5315

5316

5317

5318

5319

5320

</div>

5321

5322

5323

5324

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

5325

5326

5327

5328

5329

5330

5331

5332

<code>attrs</code>

5333

5334

</li>

5335

5336

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

5337

</div>

5338

5339

5340

5341

5342

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

5343

</span>

5344

5345

5346

5347

5348

5349

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

5350

5351

5352

5353

5354

5355

5356

5357

5358

5359

5360

5361

<p>Inherited from

5362

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

5363

5364

5365

5366

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

5367

5368

</p>

5369

5370

5371

5372

5373

5374

</div>

5375

5376

5377

<p>Utility method to protect an attribute configuration

5378

hash, by merging the entire object and the individual

5379

attr config objects.</p>

5380

</div>

5381

5382

5383

5384

<h4>Parameters:</h4>

5385

5386

5387

5388

5389

5390

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

5391

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

5392

5393

5394

5395

5396

5397

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

5398

</div>

5399

5400

5401

</li>

5402

5403

</ul>

5404

</div>

5405

5406

5407

5408

5409

<h4>Returns:</h4>

5410

5411

5412

5413

5414

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

5415

5416

A protected version of the attrs argument.

5417

5418

</div>

5419

</div>

5420

5421

5422

5423

</div>

5424

5425

5426

5427

5428

5429

5430

5431

5432

5433

5434

5435

5436

5437

</li>

5438

5439

5440

5441

5442

5443

</li>

5444

5445

5446

5447

5448

5449

</li>

5450

5451

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

5452

</div>

5453

5454

5455

5456

5457

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

5458

</span>

5459

5460

5461

5462

5463

5464

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

5465

5466

5467

5468

5469

5470

5471

5472

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

5473

5474

5475

5476

5477

<p>Inherited from

5478

5479

AttributeCore

5480

</a>

5481

5482

but overwritten in

5483

5484

5485

5486

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

5487

5488

</p>

5489

5490

5491

5492

5493

5494

</div>

5495

5496

5497

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

5498

</div>

5499

5500

5501

5502

<h4>Parameters:</h4>

5503

5504

5505

5506

5507

5508

5509

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

5510

5511

5512

5513

5514

5515

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

5516

</div>

5517

5518

5519

</li>

5520

5521

5522

5523

5524

5525

5526

5527

5528

5529

5530

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

5531

</div>

5532

5533

5534

</li>

5535

5536

5537

5538

5539

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

5540

5541

5542

5543

5544

5545

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

5546

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

5547

</div>

5548

5549

5550

</li>

5551

5552

</ul>

5553

</div>

5554

5555

5556

5557

5558

<h4>Returns:</h4>

5559

5560

5561

5562

5563

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

5564

5565

A reference to the host object.

5566

5567

</div>

5568

</div>

5569

5570

5571

5572

</div>

5573

5574

5575

5576

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

5577

5578

5579

5580

5581

5582

5583

5584

5585

5586

</li>

5587

5588

5589

5590

<code>value</code>

5591

5592

</li>

5593

5594

5595

5596

5597

5598

</li>

5599

5600

5601

5602

<code>force</code>

5603

5604

</li>

5605

5606

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

5607

</div>

5608

5609

5610

5611

5612

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

5613

</span>

5614

5615

5616

5617

5618

5619

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

5620

5621

5622

5623

5624

5625

5626

5627

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

5628

5629

5630

5631

5632

5633

<p>Inherited from

5634

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

5635

5636

5637

5638

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

5639

5640

</p>

5641

5642

5643

5644

5645

5646

</div>

5647

5648

5649

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

5650

5651

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

5652

</div>

5653

5654

5655

5656

<h4>Parameters:</h4>

5657

5658

5659

5660

5661

5662

5663

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

5664

5665

5666

5667

5668

5669

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

5670

</div>

5671

5672

5673

</li>

5674

5675

5676

5677

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

5678

5679

5680

5681

5682

5683

5684

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

5685

</div>

5686

5687

5688

</li>

5689

5690

5691

5692

5693

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

5694

5695

5696

5697

5698

5699

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

5700

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

5701

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

5702

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

5703

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

5704

</div>

5705

5706

5707

</li>

5708

5709

5710

5711

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

5712

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

5713

5714

5715

5716

5717

5718

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

5719

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

5720

</div>

5721

5722

5723

</li>

5724

5725

</ul>

5726

</div>

5727

5728

5729

5730

5731

<h4>Returns:</h4>

5732

5733

5734

5735

5736

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

5737

5738

A reference to the host object.

5739

5740

</div>

5741

</div>

5742

5743

5744

5745

</div>

5746

5747

5748

5749

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

5750

5751

5752

5753

5754

5755

5756

5757

<code>attrs</code>

5758

5759

</li>

5760

5761

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

5762

</div>

5763

5764

5765

5766

5767

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

5768

</span>

5769

5770

5771

5772

5773

5774

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

5775

5776

5777

5778

5779

5780

5781

5782

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

5783

5784

5785

5786

5787

5788

<p>Inherited from

5789

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

5790

5791

5792

5793

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

5794

5795

</p>

5796

5797

5798

5799

5800

5801

</div>

5802

5803

5804

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

5805

</div>

5806

5807

5808

5809

<h4>Parameters:</h4>

5810

5811

5812

5813

5814

5815

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

5816

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

5817

5818

5819

5820

5821

5822

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

5823

</div>

5824

5825

5826

</li>

5827

5828

</ul>

5829

</div>

5830

5831

5832

5833

5834

<h4>Returns:</h4>

5835

5836

5837

5838

5839

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

5840

5841

A reference to the host object.

5842

5843

</div>

5844

</div>

5845

5846

5847

5848

</div>

5849

5850

5851

5852

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

5853

5854

5855

5856

5857

5858

5859

5860

<code>attrName</code>

5861

5862

</li>

5863

5864

5865

5866

<code>subAttrName</code>

5867

5868

</li>

5869

5870

5871

5872

<code>prevVal</code>

5873

5874

</li>

5875

5876

5877

5878

<code>newVal</code>

5879

5880

</li>

5881

5882

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

5883

</div>

5884

5885

5886

5887

5888

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

5889

</span>

5890

5891

5892

5893

5894

5895

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

5896

5897

5898

5899

5900

5901

5902

5903

5904

5905

5906

5907

<p>Inherited from

5908

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

5909

5910

5911

5912

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

5913

5914

</p>

5915

5916

5917

5918

5919

5920

</div>

5921

5922

5923

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

5924

if validation and setter passes.</p>

5925

</div>

5926

5927

5928

5929

<h4>Parameters:</h4>

5930

5931

5932

5933

5934

5935

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

5936

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

5937

5938

5939

5940

5941

5942

<p>The attribute name.</p>

5943

</div>

5944

5945

5946

</li>

5947

5948

5949

5950

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

5951

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

5952

5953

5954

5955

5956

5957

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

5958

</div>

5959

5960

5961

</li>

5962

5963

5964

5965

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

5966

5967

5968

5969

5970

5971

5972

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

5973

</div>

5974

5975

5976

</li>

5977

5978

5979

5980

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

5981

5982

5983

5984

5985

5986

5987

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

5988

</div>

5989

5990

5991

</li>

5992

5993

</ul>

5994

</div>

5995

5996

5997

5998

5999

<h4>Returns:</h4>

6000

6001

6002

6003

6004

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

6005

6006

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

6007

6008

</div>

6009

</div>

6010

6011

6012

6013

</div>

6014

6015

6016

6017

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

6018

6019

6020

6021

6022

6023

6024

6025

6026

6027

</li>

6028

6029

6030

6031

<code>value</code>

6032

6033

</li>

6034

6035

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

6036

</div>

6037

6038

6039

6040

6041

6042

6043

6044

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

6045

6046

6047

6048

6049

6050

6051

6052

6053

6054

6055

6056

<p>Inherited from

6057

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

6058

6059

6060

6061

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

6062

6063

</p>

6064

6065

6066

6067

6068

6069

</div>

6070

6071

6072

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

6073

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

6074

</div>

6075

6076

6077

6078

<h4>Parameters:</h4>

6079

6080

6081

6082

6083

6084

6085

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

6086

6087

6088

6089

6090

6091

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

6092

</div>

6093

6094

6095

</li>

6096

6097

6098

6099

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

6100

6101

6102

6103

6104

6105

6106

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

6107

</div>

6108

6109

6110

</li>

6111

6112

</ul>

6113

</div>

6114

6115

6116

6117

6118

6119

</div>

6120

6121

6122

6123

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

6124

6125

6126

6127

6128

6129

6130

6131

6132

6133

</li>

6134

6135

6136

6137

<code>config</code>

6138

6139

</li>

6140

6141

6142

6143

6144

6145

</li>

6146

6147

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

6148

</div>

6149

6150

6151

6152

6153

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

6154

</span>

6155

6156

6157

6158

6159

6160

6161

6162

6163

6164

6165

6166

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

6167

6168

6169

6170

6171

6172

<p>Inherited from

6173

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

6174

6175

6176

6177

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

6178

6179

</p>

6180

6181

6182

6183

6184

6185

</div>

6186

6187

6188

<p>

6189

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

6190

</p>

6191

6192

<p>

6193

The config argument object supports the following properties:

6194

</p>

6195

6196

<dl>

6197

<dt>value <Any></dt>

6198

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

6199

6200

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

6201

<dd>

6202

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

6203

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

6204

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

6205

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

6206

case the value property is used.</p>

6207

6208

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

6209

</dd>

6210

6211

<dt>readOnly <boolean></dt>

6212

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

6213

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

6214

6215

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

6216

<dd>

6217

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

6218

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

6219

constructor configuration arguments, or by invoking set.

6220

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

6221

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

6222

</dd>

6223

6224

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

6225

<dd>

6226

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

6227

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

6228

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

6229

the value from being stored.

6230

</p>

6231

6232

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

6233

</dd>

6234

6235

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

6236

<dd>

6237

<p>

6238

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

6239

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

6240

invoke get.

6241

</p>

6242

6243

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

6244

</dd>

6245

6246

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

6247

<dd>

6248

<p>

6249

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

6250

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

6251

</p>

6252

6253

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

6254

</dd>

6255

6256

<dt>lazyAdd <boolean></dt>

6257

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

6258

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

6259

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

6260

6261

</dl>

6262

6263

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

6264

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

6265

6266

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

6267

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

6268

</div>

6269

6270

6271

6272

<h4>Parameters:</h4>

6273

6274

6275

6276

6277

6278

6279

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

6280

6281

6282

6283

6284

6285

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

6286

</div>

6287

6288

6289

</li>

6290

6291

6292

6293

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

6294

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

6295

6296

6297

6298

6299

6300

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

6301

6302

<p>

6303

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

6304

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

6305

</p>

6306

</div>

6307

6308

6309

</li>

6310

6311

6312

6313

6314

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

6315

6316

6317

6318

6319

6320

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

6321

</div>

6322

6323

6324

</li>

6325

6326

</ul>

6327

</div>

6328

6329

6330

6331

6332

<h4>Returns:</h4>

6333

6334

6335

6336

6337

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

6338

6339

A reference to the host object.

6340

6341

</div>

6342

</div>

6343

6344

6345

6346

</div>

6347

6348

6349

6350

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

6351

6352

6353

6354

6355

6356

6357

6358

6359

6360

</li>

6361

6362

6363

6364

<code>values</code>

6365

6366

</li>

6367

6368

6369

6370

6371

6372

</li>

6373

6374

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

6375

</div>

6376

6377

6378

6379

6380

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

6381

</span>

6382

6383

6384

6385

6386

6387

6388

6389

6390

6391

6392

6393

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

6394

6395

6396

6397

6398

6399

<p>Inherited from

6400

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

6401

6402

6403

6404

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

6405

6406

</p>

6407

6408

6409

6410

6411

6412

</div>

6413

6414

6415

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

6416

6417

<p>

6418

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

6419

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

6420

</p>

6421

</div>

6422

6423

6424

6425

<h4>Parameters:</h4>

6426

6427

6428

6429

6430

6431

6432

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

6433

6434

6435

6436

6437

6438

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

6439

</div>

6440

6441

6442

</li>

6443

6444

6445

6446

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

6447

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

6448

6449

6450

6451

6452

6453

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

6454

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

6455

</div>

6456

6457

6458

</li>

6459

6460

6461

6462

6463

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

6464

6465

6466

6467

6468

6469

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

6470

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

6471

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

6472

</div>

6473

6474

6475

</li>

6476

6477

</ul>

6478

</div>

6479

6480

6481

6482

6483

<h4>Returns:</h4>

6484

6485

6486

6487

6488

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

6489

6490

A reference to the host object.

6491

6492

</div>

6493

</div>

6494

6495

6496

6497

</div>

6498

6499

6500

6501

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

6502

6503

6504

6505

6506

6507

6508

6509

6510

6511

</li>

6512

6513

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

6514

</div>

6515

6516

6517

6518

6519

6520

6521

6522

6523

6524

6525

6526

6527

6528

6529

6530

6531

6532

<p>Inherited from

6533

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

6534

6535

6536

6537

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

6538

6539

</p>

6540

6541

6542

6543

6544

6545

</div>

6546

6547

6548

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

6549

is determined by the order registered. Multiple targets can

6550

be specified.</p>

6551

6552

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

6553

6554

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

6555

</div>

6556

6557

6558

6559

<h4>Parameters:</h4>

6560

6561

6562

6563

6564

6565

6566

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

6567

6568

6569

6570

6571

6572

<p>the target to add</p>

6573

</div>

6574

6575

6576

</li>

6577

6578

</ul>

6579

</div>

6580

6581

6582

6583

6584

6585

</div>

6586

6587

6588

6589

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

6590

6591

6592

6593

6594

6595

6596

6597

6598

6599

</li>

6600

6601

6602

6603

6604

6605

</li>

6606

6607

6608

6609

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

6610

6611

</li>

6612

6613

6614

6615

6616

6617

</li>

6618

6619

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

6620

</div>

6621

6622

6623

6624

6625

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

6626

</span>

6627

6628

6629

6630

6631

6632

6633

6634

6635

6636

6637

6638

6639

6640

6641

6642

<p>Inherited from

6643

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

6644

6645

6646

6647

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

6648

6649

</p>

6650

6651

6652

6653

6654

6655

</div>

6656

6657

6658

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

6659

supplied callback will execute after any listeners add

6660

via the subscribe method, and after the default function,

6661

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

6662

</div>

6663

6664

6665

6666

<h4>Parameters:</h4>

6667

6668

6669

6670

6671

6672

6673

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

6674

6675

6676

6677

6678

6679

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

6680

</div>

6681

6682

6683

</li>

6684

6685

6686

6687

6688

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

6689

6690

6691

6692

6693

6694

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

6695

</div>

6696

6697

6698

</li>

6699

6700

6701

6702

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

6703

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

6704

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

6705

6706

6707

6708

6709

6710

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

6711

</div>

6712

6713

6714

</li>

6715

6716

6717

6718

6719

6720

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

6721

6722

6723

6724

6725

6726

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

6727

</div>

6728

6729

6730

</li>

6731

6732

</ul>

6733

</div>

6734

6735

6736

6737

6738

<h4>Returns:</h4>

6739

6740

6741

6742

6743

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

6744

6745

A subscription handle capable of detaching the

6746

subscription

6747

6748

</div>

6749

</div>

6750

6751

6752

6753

</div>

6754

6755

6756

6757

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

6758

6759

6760

6761

6762

6763

6764

6765

6766

6767

</li>

6768

6769

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

6770

</div>

6771

6772

6773

6774

6775

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

6776

</span>

6777

6778

6779

6780

6781

6782

6783

6784

6785

6786

6787

6788

6789

6790

6791

6792

<p>Inherited from

6793

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

6794

6795

6796

6797

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

6798

6799

</p>

6800

6801

6802

6803

6804

6805

</div>

6806

6807

6808

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

6809

</div>

6810

6811

6812

6813

<h4>Parameters:</h4>

6814

6815

6816

6817

6818

6819

6820

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

6821

6822

6823

6824

6825

6826

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

6827

</div>

6828

6829

6830

</li>

6831

6832

</ul>

6833

</div>

6834

6835

6836

6837

6838

<h4>Returns:</h4>

6839

6840

6841

6842

6843

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

6844

6845

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.

6846

6847

</div>

6848

</div>

6849

6850

6851

6852

</div>

6853

6854

6855

6856

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

6857

6858

6859

6860

6861

6862

6863

6864

6865

</span>

6866

6867

6868

6869

6870

6871

6872

6873

6874

6875

6876

6877

6878

6879

6880

6881

<p>Inherited from

6882

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

6883

6884

6885

6886

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

6887

6888

</p>

6889

6890

6891

6892

6893

6894

</div>

6895

6896

6897

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

6898

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

6899

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

6900

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

6901

6902

<p>For DOM and custom events:

6903

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

6904

6905

<p>For methods:

6906

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

6907

</div>

6908

6909

6910

6911

6912

6913

<h4>Returns:</h4>

6914

6915

6916

6917

6918

detach handle

6919

6920

</div>

6921

</div>

6922

6923

6924

6925

</div>

6926

6927

6928

6929

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

6930

6931

6932

6933

6934

6935

6936

6937

6938

6939

</li>

6940

6941

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

6942

</div>

6943

6944

6945

6946

6947

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

6948

</span>

6949

6950

6951

6952

6953

6954

6955

6956

6957

6958

6959

6960

6961

6962

6963

6964

<p>Inherited from

6965

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

6966

6967

6968

6969

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

6970

6971

</p>

6972

6973

6974

6975

6976

6977

</div>

6978

6979

6980

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

6981

</div>

6982

6983

6984

6985

<h4>Parameters:</h4>

6986

6987

6988

6989

6990

6991

6992

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

6993

6994

6995

6996

6997

6998

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

6999

</div>

7000

7001

7002

</li>

7003

7004

</ul>

7005

</div>

7006

7007

7008

7009

7010

<h4>Returns:</h4>

7011

7012

7013

7014

7015

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

7016

7017

the aggregated return value from Event.Custom.fire

7018

7019

</div>

7020

</div>

7021

7022

7023

7024

</div>

7025

7026

7027

7028

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

7029

7030

7031

7032

7033

7034

7035

7036

7037

</span>

7038

7039

7040

7041

7042

7043

7044

7045

7046

7047

7048

7049

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

7050

7051

7052

7053

7054

<p>Inherited from

7055

7056

BaseCore

7057

</a>

7058

7059

but overwritten in

7060

7061

7062

7063

7064

7065

</p>

7066

7067

7068

7069

7070

7071

</div>

7072

7073

7074

<p>

7075

Destroy lifecycle method. Fires the destroy

7076

event, prior to invoking destructors for the

7077

class hierarchy.

7078

</p>

7079

7080

<p>

7081

Subscribers to the destroy

7082

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

7083

from proceeding.

7084

</p>

7085

</div>

7086

7087

7088

7089

7090

7091

<h4>Returns:</h4>

7092

7093

7094

7095

7096

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

7097

7098

A reference to this object

7099

7100

</div>

7101

</div>

7102

7103

7104

7105

</div>

7106

7107

7108

7109

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

7110

7111

7112

7113

7114

7115

7116

7117

7118

7119

</li>

7120

7121

7122

7123

7124

7125

</li>

7126

7127

7128

7129

<code>context</code>

7130

7131

</li>

7132

7133

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

7134

</div>

7135

7136

7137

7138

7139

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

7140

</span>

7141

7142

7143

7144

7145

7146

7147

7148

7149

7150

7151

7152

7153

7154

7155

7156

<p>Inherited from

7157

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

7158

7159

7160

7161

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

7162

7163

</p>

7164

7165

7166

7167

7168

7169

</div>

7170

7171

7172

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

7173

</div>

7174

7175

7176

7177

<h4>Parameters:</h4>

7178

7179

7180

7181

7182

7183

7184

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

7185

7186

7187

7188

7189

7190

<p>Either the handle to the subscriber or the

7191

type of event. If the type

7192

is not specified, it will attempt to remove

7193

the listener from all hosted events.</p>

7194

</div>

7195

7196

7197

</li>

7198

7199

7200

7201

7202

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

7203

7204

7205

7206

7207

7208

<p>The subscribed function to unsubscribe, if not

7209

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

7210

</div>

7211

7212

7213

</li>

7214

7215

7216

7217

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

7218

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

7219

7220

7221

7222

7223

7224

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

7225

optional, but if supplied will be used to

7226

disambiguate multiple listeners that are the same

7227

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

7228

that lives on the prototype)</p>

7229

</div>

7230

7231

7232

</li>

7233

7234

</ul>

7235

</div>

7236

7237

7238

7239

7240

<h4>Returns:</h4>

7241

7242

7243

7244

7245

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

7246

7247

the host

7248

7249

</div>

7250

</div>

7251

7252

7253

7254

</div>

7255

7256

7257

7258

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

7259

7260

7261

7262

7263

7264

7265

7266

7267

7268

</li>

7269

7270

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

7271

</div>

7272

7273

7274

7275

7276

7277

7278

7279

7280

7281

7282

7283

7284

7285

7286

7287

7288

7289

<p>Inherited from

7290

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

7291

7292

7293

7294

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

7295

7296

</p>

7297

7298

7299

7300

7301

7302

</div>

7303

7304

7305

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

7306

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

7307

be removed.</p>

7308

</div>

7309

7310

7311

7312

<h4>Parameters:</h4>

7313

7314

7315

7316

7317

7318

7319

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

7320

7321

7322

7323

7324

7325

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

7326

</div>

7327

7328

7329

</li>

7330

7331

</ul>

7332

</div>

7333

7334

7335

7336

7337

7338

</div>

7339

7340

7341

7342

7343

7344

7345

7346

7347

7348

7349

7350

7351

7352

</li>

7353

7354

7355

7356

<code>arguments</code>

7357

7358

</li>

7359

7360

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

7361

</div>

7362

7363

7364

7365

7366

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

7367

</span>

7368

7369

7370

7371

7372

7373

7374

7375

7376

7377

7378

7379

7380

7381

7382

7383

<p>Inherited from

7384

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

7385

7386

7387

7388

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

7389

7390

</p>

7391

7392

7393

7394

7395

7396

</div>

7397

7398

7399

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

7400

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

7401

following parameters.</p>

7402

7403

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

7404

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

7405

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

7406

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

7407

be published on this object first.</p>

7408

7409

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

7410

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

7411

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

7412

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

7413

in place of the original object.</p>

7414

</div>

7415

7416

7417

7418

<h4>Parameters:</h4>

7419

7420

7421

7422

7423

7424

7425

7426

7427

7428

7429

7430

7431

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

7432

a 'type' property.</p>

7433

</div>

7434

7435

7436

</li>

7437

7438

7439

7440

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

7441

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

7442

7443

7444

7445

7446

7447

<p>an arbitrary set of parameters to pass to

7448

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

7449

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

7450

parameter after the properties the object literal contains are copied to

7451

the event facade.</p>

7452

</div>

7453

7454

7455

</li>

7456

7457

</ul>

7458

</div>

7459

7460

7461

7462

7463

<h4>Returns:</h4>

7464

7465

7466

7467

7468

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

7469

7470

the event host

7471

7472

</div>

7473

</div>

7474

7475

7476

7477

</div>

7478

7479

7480

7481

7482

7483

7484

7485

7486

7487

7488

7489

7490

7491

</li>

7492

7493

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

7494

</div>

7495

7496

7497

7498

7499

7500

</span>

7501

7502

7503

7504

7505

7506

7507

7508

7509

7510

7511

7512

7513

7514

7515

7516

<p>Inherited from

7517

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

7518

7519

7520

7521

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

7522

7523

</p>

7524

7525

7526

7527

7528

7529

</div>

7530

7531

7532

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

7533

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

7534

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

7535

</div>

7536

7537

7538

7539

<h4>Parameters:</h4>

7540

7541

7542

7543

7544

7545

7546

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

7547

7548

7549

7550

7551

7552

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

7553

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

7554

</div>

7555

7556

7557

</li>

7558

7559

</ul>

7560

</div>

7561

7562

7563

7564

7565

<h4>Returns:</h4>

7566

7567

7568

7569

7570

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

7571

7572

The value of the attribute

7573

7574

</div>

7575

</div>

7576

7577

7578

7579

</div>

7580

7581

7582

7583

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

7584

7585

7586

7587

7588

7589

7590

7591

<code>attrs</code>

7592

7593

</li>

7594

7595

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

7596

</div>

7597

7598

7599

7600

7601

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

7602

</span>

7603

7604

7605

7606

7607

7608

7609

7610

7611

7612

7613

7614

7615

7616

7617

7618

<p>Inherited from

7619

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

7620

7621

7622

7623

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

7624

7625

</p>

7626

7627

7628

7629

7630

7631

</div>

7632

7633

7634

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

7635

</div>

7636

7637

7638

7639

<h4>Parameters:</h4>

7640

7641

7642

7643

7644

7645

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

7646

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

7647

7648

7649

7650

7651

7652

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

7653

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

7654

</div>

7655

7656

7657

</li>

7658

7659

</ul>

7660

</div>

7661

7662

7663

7664

7665

<h4>Returns:</h4>

7666

7667

7668

7669

7670

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

7671

7672

An object with attribute name/value pairs.

7673

7674

</div>

7675

</div>

7676

7677

7678

7679

</div>

7680

7681

7682

7683

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

7684

7685

7686

7687

7688

7689

7690

7691

7692

7693

</li>

7694

7695

7696

7697

<code>prefixed</code>

7698

7699

</li>

7700

7701

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

7702

</div>

7703

7704

7705

7706

7707

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

7708

</span>

7709

7710

7711

7712

7713

7714

7715

7716

7717

7718

7719

7720

7721

7722

7723

7724

<p>Inherited from

7725

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

7726

7727

7728

7729

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

7730

7731

</p>

7732

7733

7734

7735

7736

7737

</div>

7738

7739

7740

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

7741

falsy value otherwise</p>

7742

</div>

7743

7744

7745

7746

<h4>Parameters:</h4>

7747

7748

7749

7750

7751

7752

7753

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

7754

7755

7756

7757

7758

7759

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

7760

</div>

7761

7762

7763

</li>

7764

7765

7766

7767

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

7768

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

7769

7770

7771

7772

7773

7774

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

7775

</div>

7776

7777

7778

</li>

7779

7780

</ul>

7781

</div>

7782

7783

7784

7785

7786

<h4>Returns:</h4>

7787

7788

7789

7790

7791

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

7792

7793

the custom event or null

7794

7795

</div>

7796

</div>

7797

7798

7799

7800

</div>

7801

7802

7803

7804

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

7805

7806

7807

7808

7809

7810

7811

7812

7813

</span>

7814

7815

7816

7817

7818

7819

7820

7821

7822

7823

7824

7825

7826

7827

7828

7829

<p>Inherited from

7830

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

7831

7832

7833

7834

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

7835

7836

</p>

7837

7838

7839

7840

7841

7842

</div>

7843

7844

7845

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

7846

</div>

7847

7848

7849

7850

7851

7852

<h4>Returns:</h4>

7853

7854

7855

7856

7857

EventTarget[]

7858

7859

</div>

7860

</div>

7861

7862

7863

7864

</div>

7865

7866

7867

7868

7869

7870

7871

7872

7873

7874

7875

7876

<code>config</code>

7877

7878

</li>

7879

7880

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

7881

</div>

7882

7883

7884

7885

7886

7887

</span>

7888

7889

7890

7891

7892

7893

7894

7895

7896

7897

7898

7899

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

7900

7901

7902

7903

7904

<p>Inherited from

7905

7906

BaseCore

7907

</a>

7908

7909

but overwritten in

7910

7911

7912

7913

7914

7915

</p>

7916

7917

7918

7919

7920

7921

</div>

7922

7923

7924

<p>Init lifecycle method, invoked during construction.

7925

Fires the init event prior to setting up attributes and

7926

invoking initializers for the class hierarchy.</p>

7927

</div>

7928

7929

7930

7931

<h4>Parameters:</h4>

7932

7933

7934

7935

7936

7937

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

7938

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

7939

7940

7941

7942

7943

7944

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

7945

</div>

7946

7947

7948

</li>

7949

7950

</ul>

7951

</div>

7952

7953

7954

7955

7956

<h4>Returns:</h4>

7957

7958

7959

7960

7961

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

7962

7963

A reference to this object

7964

7965

</div>

7966

</div>

7967

7968

7969

7970

</div>

7971

7972

7973

7974

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

7975

7976

7977

7978

7979

7980

7981

7982

<code>config</code>

7983

7984

</li>

7985

7986

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

7987

</div>

7988

7989

7990

7991

7992

7993

7994

7995

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

7996

7997

7998

7999

8000

8001

8002

8003

8004

8005

8006

8007

<p>Inherited from

8008

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

8009

8010

8011

8012

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

8013

8014

</p>

8015

8016

8017

8018

8019

8020

</div>

8021

8022

8023

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

8024

</div>

8025

8026

8027

8028

<h4>Parameters:</h4>

8029

8030

8031

8032

8033

8034

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

8035

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

8036

8037

8038

8039

8040

8041

<p>Config object.</p>

8042

</div>

8043

8044

8045

</li>

8046

8047

</ul>

8048

</div>

8049

8050

8051

8052

8053

8054

</div>

8055

8056

8057

8058

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

8059

8060

8061

8062

8063

8064

8065

8066

8067

8068

</li>

8069

8070

8071

8072

<code>config</code>

8073

8074

</li>

8075

8076

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

8077

</div>

8078

8079

8080

8081

8082

8083

8084

8085

8086

8087

8088

8089

8090

8091

8092

8093

8094

8095

<p>Inherited from

8096

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

8097

8098

8099

8100

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

8101

8102

</p>

8103

8104

8105

8106

8107

8108

</div>

8109

8110

8111

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

8112

8113

<p>

8114

The properties which can be modified through this interface are limited

8115

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

8116

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

8117

broadcast and getter.

8118

</p>

8119

</div>

8120

8121

8122

8123

<h4>Parameters:</h4>

8124

8125

8126

8127

8128

8129

8130

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

8131

8132

8133

8134

8135

8136

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

8137

</div>

8138

8139

8140

</li>

8141

8142

8143

8144

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

8145

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

8146

8147

8148

8149

8150

8151

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

8152

</div>

8153

8154

8155

</li>

8156

8157

</ul>

8158

</div>

8159

8160

8161

8162

8163

8164

</div>

8165

8166

8167

8168

8169

8170

8171

8172

8173

8174

8175

8176

8177

8178

</li>

8179

8180

8181

8182

8183

8184

</li>

8185

8186

8187

8188

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

8189

8190

</li>

8191

8192

8193

8194

8195

8196

</li>

8197

8198

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

8199

</div>

8200

8201

8202

8203

8204

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

8205

</span>

8206

8207

8208

8209

8210

8211

8212

8213

8214

8215

8216

8217

8218

8219

8220

8221

<p>Inherited from

8222

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

8223

8224

8225

8226

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

8227

8228

</p>

8229

8230

8231

8232

8233

8234

</div>

8235

8236

8237

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

8238

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

8239

8240

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

8241

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

8242

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

8243

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

8244

API for all available properties and methods. Subscribers to

8245

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

8246

after the event name.</p>

8247

8248

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

8249

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

8250

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

8251

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

8252

8253

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

8254

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

8255

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

8256

</div>

8257

8258

8259

8260

<h4>Parameters:</h4>

8261

8262

8263

8264

8265

8266

8267

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

8268

8269

8270

8271

8272

8273

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

8274

</div>

8275

8276

8277

</li>

8278

8279

8280

8281

8282

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

8283

8284

8285

8286

8287

8288

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

8289

</div>

8290

8291

8292

</li>

8293

8294

8295

8296

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

8297

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

8298

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

8299

8300

8301

8302

8303

8304

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

8305

</div>

8306

8307

8308

</li>

8309

8310

8311

8312

8313

8314

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

8315

8316

8317

8318

8319

8320

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

8321

</div>

8322

8323

8324

</li>

8325

8326

</ul>

8327

</div>

8328

8329

8330

8331

8332

<h4>Returns:</h4>

8333

8334

8335

8336

8337

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

8338

8339

A subscription handle capable of detaching that

8340

subscription

8341

8342

</div>

8343

</div>

8344

8345

8346

8347

</div>

8348

8349

8350

8351

8352

8353

8354

8355

8356

8357

8358

8359

8360

8361

</li>

8362

8363

8364

8365

8366

8367

</li>

8368

8369

8370

8371

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

8372

8373

</li>

8374

8375

8376

8377

8378

8379

</li>

8380

8381

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

8382

</div>

8383

8384

8385

8386

8387

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

8388

</span>

8389

8390

8391

8392

8393

8394

8395

8396

8397

8398

8399

8400

8401

8402

8403

8404

<p>Inherited from

8405

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

8406

8407

8408

8409

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

8410

8411

</p>

8412

8413

8414

8415

8416

8417

</div>

8418

8419

8420

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

8421

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

8422

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

8423

</div>

8424

8425

8426

8427

<h4>Parameters:</h4>

8428

8429

8430

8431

8432

8433

8434

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

8435

8436

8437

8438

8439

8440

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

8441

</div>

8442

8443

8444

</li>

8445

8446

8447

8448

8449

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

8450

8451

8452

8453

8454

8455

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

8456

</div>

8457

8458

8459

</li>

8460

8461

8462

8463

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

8464

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

8465

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

8466

8467

8468

8469

8470

8471

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

8472

</div>

8473

8474

8475

</li>

8476

8477

8478

8479

8480

8481

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

8482

8483

8484

8485

8486

8487

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

8488

</div>

8489

8490

8491

</li>

8492

8493

</ul>

8494

</div>

8495

8496

8497

8498

8499

<h4>Returns:</h4>

8500

8501

8502

8503

8504

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

8505

8506

A subscription handle capable of detaching the

8507

subscription

8508

8509

</div>

8510

</div>

8511

8512

8513

8514

</div>

8515

8516

8517

8518

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

8519

8520

8521

8522

8523

8524

8525

8526

8527

8528

</li>

8529

8530

8531

8532

8533

8534

</li>

8535

8536

8537

8538

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

8539

8540

</li>

8541

8542

8543

8544

8545

8546

</li>

8547

8548

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

8549

</div>

8550

8551

8552

8553

8554

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

8555

</span>

8556

8557

8558

8559

8560

8561

8562

8563

8564

8565

8566

8567

8568

8569

8570

8571

<p>Inherited from

8572

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

8573

8574

8575

8576

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

8577

8578

</p>

8579

8580

8581

8582

8583

8584

</div>

8585

8586

8587

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

8588

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

8589

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

8590

</div>

8591

8592

8593

8594

<h4>Parameters:</h4>

8595

8596

8597

8598

8599

8600

8601

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

8602

8603

8604

8605

8606

8607

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

8608

</div>

8609

8610

8611

</li>

8612

8613

8614

8615

8616

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

8617

8618

8619

8620

8621

8622

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

8623

</div>

8624

8625

8626

</li>

8627

8628

8629

8630

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

8631

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

8632

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

8633

8634

8635

8636

8637

8638

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

8639

</div>

8640

8641

8642

</li>

8643

8644

8645

8646

8647

8648

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

8649

8650

8651

8652

8653

8654

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

8655

</div>

8656

8657

8658

</li>

8659

8660

</ul>

8661

</div>

8662

8663

8664

8665

8666

<h4>Returns:</h4>

8667

8668

8669

8670

8671

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

8672

8673

A subscription handle capable of detaching that

8674

subscription

8675

8676

</div>

8677

</div>

8678

8679

8680

8681

</div>

8682

8683

8684

8685

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

8686

8687

8688

8689

8690

8691

8692

8693

8694

8695

</li>

8696

8697

8698

8699

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

8700

8701

</li>

8702

8703

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

8704

</div>

8705

8706

8707

8708

8709

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

8710

</span>

8711

8712

8713

8714

8715

8716

8717

8718

8719

8720

8721

8722

8723

8724

8725

8726

<p>Inherited from

8727

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

8728

8729

8730

8731

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

8732

8733

</p>

8734

8735

8736

8737

8738

8739

<p>Available since 3.3.0</p>

8740

8741

</div>

8742

8743

8744

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

8745

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

8746

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

8747

to include the prefix one is supplied or the event target

8748

is configured with a default prefix.</p>

8749

</div>

8750

8751

8752

8753

<h4>Parameters:</h4>

8754

8755

8756

8757

8758

8759

8760

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

8761

8762

8763

8764

8765

8766

8767

</div>

8768

8769

8770

</li>

8771

8772

8773

8774

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

8775

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

8776

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

8777

8778

8779

8780

8781

8782

<p>the prefix</p>

8783

</div>

8784

8785

8786

</li>

8787

8788

</ul>

8789

</div>

8790

8791

8792

8793

8794

<h4>Returns:</h4>

8795

8796

8797

8798

8799

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

8800

8801

an array containing:

8802

* the detach category, if supplied,

8803

* the prefixed event type,

8804

* whether or not this is an after listener,

8805

* the supplied event type

8806

8807

</div>

8808

</div>

8809

8810

8811

8812

</div>

8813

8814

8815

8816

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

8817

8818

8819

8820

8821

8822

8823

8824

8825

8826

</li>

8827

8828

8829

8830

8831

8832

</li>

8833

8834

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

8835

</div>

8836

8837

8838

8839

8840

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

8841

</span>

8842

8843

8844

8845

8846

8847

8848

8849

8850

8851

8852

8853

8854

8855

8856

8857

<p>Inherited from

8858

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

8859

8860

8861

8862

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

8863

8864

</p>

8865

8866

8867

8868

8869

8870

</div>

8871

8872

8873

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

8874

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

8875

case the custom event is returned.</p>

8876

</div>

8877

8878

8879

8880

<h4>Parameters:</h4>

8881

8882

8883

8884

8885

8886

8887

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

8888

8889

8890

8891

8892

8893

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

8894

</div>

8895

8896

8897

</li>

8898

8899

8900

8901

8902

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

8903

8904

8905

8906

8907

8908

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

8909

8910

<p><ul>

8911

<li>

8912

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

8913

</li>

8914

<li>

8915

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

8916

Events can only bubble if emitFacade is true.

8917

</li>

8918

<li>

8919

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

8920

</li>

8921

<li>

8922

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

8923

</li>

8924

<li>

8925

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

8926

</li>

8927

<li>

8928

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

8929

</li>

8930

<li>

8931

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

8932

the fire will be notified immediately.

8933

</li>

8934

<li>

8935

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

8936

fired unless async is true.

8937

</li>

8938

<li>

8939

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

8940

</li>

8941

<li>

8942

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

8943

</li>

8944

<li>

8945

'queuable': whether or not this event can be queued during bubbling (false)

8946

</li>

8947

<li>

8948

'silent': if silent is true, debug messages are not provided for this event.

8949

</li>

8950

<li>

8951

'stoppedFn': a function that is executed when stopPropagation is called

8952

</li></p>

8953

8954

<p><li>

8955

'monitored': specifies whether or not this event should send notifications about

8956

when the event has been attached, detached, or published.

8957

</li>

8958

<li>

8959

'type': the event type (valid option if not provided as the first parameter to publish)

8960

</li>

8961

</ul></p>

8962

</div>

8963

8964

8965

</li>

8966

8967

</ul>

8968

</div>

8969

8970

8971

8972

8973

<h4>Returns:</h4>

8974

8975

8976

8977

8978

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

8979

8980

the custom event

8981

8982

</div>

8983

</div>

8984

8985

8986

8987

</div>

8988

8989

8990

8991

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

8992

8993

8994

8995

8996

8997

8998

8999

9000

9001

</li>

9002

9003

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

9004

</div>

9005

9006

9007

9008

9009

9010

9011

9012

9013

9014

9015

9016

9017

9018

9019

9020

9021

9022

<p>Inherited from

9023

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

9024

9025

9026

9027

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

9028

9029

</p>

9030

9031

9032

9033

9034

9035

</div>

9036

9037

9038

<p>Removes an attribute from the host object</p>

9039

</div>

9040

9041

9042

9043

<h4>Parameters:</h4>

9044

9045

9046

9047

9048

9049

9050

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

9051

9052

9053

9054

9055

9056

<p>The name of the attribute to be removed.</p>

9057

</div>

9058

9059

9060

</li>

9061

9062

</ul>

9063

</div>

9064

9065

9066

9067

9068

9069

</div>

9070

9071

9072

9073

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

9074

9075

9076

9077

9078

9079

9080

9081

9082

9083

</li>

9084

9085

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

9086

</div>

9087

9088

9089

9090

9091

9092

9093

9094

9095

9096

9097

9098

9099

9100

9101

9102

9103

9104

<p>Inherited from

9105

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

9106

9107

9108

9109

<a href="../files/event-custom_js_event-facade.js.html#l409"><code>event-custom/js/event-facade.js:409</code></a>

9110

9111

</p>

9112

9113

9114

9115

9116

9117

</div>

9118

9119

9120

<p>Removes a bubble target</p>

9121

</div>

9122

9123

9124

9125

<h4>Parameters:</h4>

9126

9127

9128

9129

9130

9131

9132

<span class="type"><a href="../classes/EventTarget.html" class="crosslink">EventTarget</a></span>

9133

9134

9135

9136

9137

9138

<p>the target to remove</p>

9139

</div>

9140

9141

9142

</li>

9143

9144

</ul>

9145

</div>

9146

9147

9148

9149

9150

9151

</div>

9152

9153

9154

9155

<h3 class="name"><code>reset</code></h3>

9156

9157

9158

9159

9160

9161

9162

9163

9164

9165

</li>

9166

9167

</ul><span class="paren">)</span>

9168

</div>

9169

9170

9171

9172

9173

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>

9174

</span>

9175

9176

9177

9178

9179

9180

9181

9182

9183

9184

9185

9186

<span class="flag chainable">chainable</span>

9187

9188

9189

9190

9191

9192

<p>Inherited from

9193

<a href="../classes/AttributeExtras.html#method_reset">AttributeExtras</a>:

9194

9195

9196

9197

<a href="../files/attribute_js_AttributeExtras.js.html#l87"><code>attribute/js/AttributeExtras.js:87</code></a>

9198

9199

</p>

9200

9201

9202

9203

9204

9205

</div>

9206

9207

9208

<p>Resets the attribute (or all attributes) to its initial value, as long as

9209

the attribute is not readOnly, or writeOnce.</p>

9210

</div>

9211

9212

9213

9214

<h4>Parameters:</h4>

9215

9216

9217

9218

9219

9220

9221

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

9222

9223

9224

9225

9226

9227

<p>Optional. The name of the attribute to reset. If omitted, all attributes are reset.</p>

9228

</div>

9229

9230

9231

</li>

9232

9233

</ul>

9234

</div>

9235

9236

9237

9238

9239

<h4>Returns:</h4>

9240

9241

9242

9243

9244

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>:

9245

9246

A reference to the host object.

9247

9248

</div>

9249

</div>

9250

9251

9252

9253

</div>

9254

9255

9256

9257

<h3 class="name"><code>sendRequest</code></h3>

9258

9259

9260

9261

9262

9263

9264

9265

<code>request</code>

9266

9267

</li>

9268

9269

</ul><span class="paren">)</span>

9270

</div>

9271

9272

9273

9274

9275

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Number" class="crosslink external" target="_blank">Number</a></span>

9276

</span>

9277

9278

9279

9280

9281

9282

9283

9284

9285

9286

9287

9288

9289

9290

9291

9292

<p>Inherited from

9293

<a href="../classes/DataSource.Local.html#method_sendRequest">DataSource.Local</a>:

9294

9295

9296

9297

<a href="../files/datasource_js_datasource-local.js.html#l348"><code>datasource/js/datasource-local.js:348</code></a>

9298

9299

</p>

9300

9301

9302

9303

9304

9305

</div>

9306

9307

9308

<p>Generates a unique transaction ID and fires <code>request</code> event.

9309

<strong>Note</strong>: the property <code>callback</code> is a

9310

deprecated alias for the <code>on</code> transaction configuration

9311

property described below.</p>

9312

</div>

9313

9314

9315

9316

<h4>Parameters:</h4>

9317

9318

9319

9320

9321

9322

<code class="param-name">request</code>

9323

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>

9324

9325

9326

9327

9328

9329

<p>An object literal with the following properties:

9330

<dl>

9331

<dt><code>request</code></dt>

9332

<dd>The request to send to the live data source, if any.</dd>

9333

9334

<dd>An object literal with the following properties:

9335

<dl>

9336

<dt><code>success</code></dt>

9337

<dd>The function to call when the data is ready.</dd>

9338

<dt><code>failure</code></dt>

9339

<dd>The function to call upon a response failure condition.</dd>

9340

<dt><code>argument</code></dt>

9341

<dd>Arbitrary data payload that will be passed back to the success and failure handlers.</dd>

9342

</dl>

9343

</dd>

9344

9345

<dd>Configuration object, if any.</dd>

9346

</dl></p>

9347

</div>

9348

9349

9350

</li>

9351

9352

</ul>

9353

</div>

9354

9355

9356

9357

9358

<h4>Returns:</h4>

9359

9360

9361

9362

9363

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Number" class="crosslink external" target="_blank">Number</a></span>:

9364

9365

Transaction ID.

9366

9367

</div>

9368

</div>

9369

9370

9371

9372

</div>

9373

9374

9375

9376

9377

9378

9379

9380

9381

9382

9383

9384

9385

9386

</li>

9387

9388

9389

9390

<code>value</code>

9391

9392

</li>

9393

9394

9395

9396

9397

9398

</li>

9399

9400

</ul><span class="paren">)</span>

9401

</div>

9402

9403

9404

9405

9406

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>

9407

</span>

9408

9409

9410

9411

9412

9413

9414

9415

9416

9417

9418

9419

<span class="flag chainable">chainable</span>

9420

9421

9422

9423

9424

<p>Inherited from

9425

9426

AttributeCore

9427

</a>

9428

9429

but overwritten in

9430

9431

9432

9433

<a href="../files/attribute_js_AttributeEvents.js.html#l41"><code>attribute/js/AttributeEvents.js:41</code></a>

9434

9435

</p>

9436

9437

9438

9439

9440

9441

</div>

9442

9443

9444

<p>Sets the value of an attribute.</p>

9445

</div>

9446

9447

9448

9449

<h4>Parameters:</h4>

9450

9451

9452

9453

9454

9455

9456

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

9457

9458

9459

9460

9461

9462

<p>The name of the attribute. If the

9463

current value of the attribute is an Object, dot notation can be used

9464

to set the value of a property within the object (e.g. <code>set("x.y.z", 5)</code>).</p>

9465

</div>

9466

9467

9468

</li>

9469

9470

9471

9472

<code class="param-name">value</code>

9473

9474

9475

9476

9477

9478

9479

<p>The value to set the attribute to.</p>

9480

</div>

9481

9482

9483

</li>

9484

9485

9486

9487

9488

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>

9489

9490

9491

9492

9493

9494

<p>(Optional) Optional event data to be mixed into

9495

the event facade passed to subscribers of the attribute's change event. This

9496

can be used as a flexible way to identify the source of a call to set, allowing

9497

the developer to distinguish between set called internally by the host, vs.

9498

set called externally by the application developer.</p>

9499

</div>

9500

9501

9502

</li>

9503

9504

</ul>

9505

</div>

9506

9507

9508

9509

9510

<h4>Returns:</h4>

9511

9512

9513

9514

9515

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>:

9516

9517

A reference to the host object.

9518

9519

</div>

9520

</div>

9521

9522

9523

9524

</div>

9525

9526

9527

9528

<h3 class="name"><code>setAttrs</code></h3>

9529

9530

9531

9532

9533

9534

9535

9536

<code>attrs</code>

9537

9538

</li>

9539

9540

</ul><span class="paren">)</span>

9541

</div>

9542

9543

9544

9545

9546

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>

9547

</span>

9548

9549

9550

9551

9552

9553

9554

9555

9556

9557

9558

9559

<span class="flag chainable">chainable</span>

9560

9561

9562

9563

9564

<p>Inherited from

9565

9566

AttributeCore

9567

</a>

9568

9569

but overwritten in

9570

9571

9572

9573

<a href="../files/attribute_js_AttributeEvents.js.html#l82"><code>attribute/js/AttributeEvents.js:82</code></a>

9574

9575

</p>

9576

9577

9578

9579

9580

9581

</div>

9582

9583

9584

<p>Sets multiple attribute values.</p>

9585

</div>

9586

9587

9588

9589

<h4>Parameters:</h4>

9590

9591

9592

9593

9594

9595

<code class="param-name">attrs</code>

9596

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>

9597

9598

9599

9600

9601

9602

<p>An object with attributes name/value pairs.</p>

9603

</div>

9604

9605

9606

</li>

9607

9608

</ul>

9609

</div>

9610

9611

9612

9613

9614

<h4>Returns:</h4>

9615

9616

9617

9618

9619

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>:

9620

9621

A reference to the host object.

9622

9623

</div>

9624

</div>

9625

9626

9627

9628

</div>

9629

9630

9631

9632

<h3 class="name"><code>subscribe</code></h3>

9633

9634

9635

9636

9637

9638

9639

9640

9641

<span class="flag deprecated" title="use on">deprecated</span>

9642

9643

9644

9645

9646

9647

9648

9649

9650

9651

9652

9653

9654

9655

<p>Inherited from

9656

<a href="../classes/EventTarget.html#method_subscribe">EventTarget</a>:

9657

9658

9659

9660

<a href="../files/event-custom_js_event-target.js.html#l335"><code>event-custom/js/event-target.js:335</code></a>

9661

9662

</p>

9663

9664

9665

9666

<p>Deprecated: use on</p>

9667

9668

9669

9670

</div>

9671

9672

9673

<p>subscribe to an event</p>

9674

</div>

9675

9676

9677

9678

9679

9680

9681

</div>

9682

9683

9684

9685

<h3 class="name"><code>toString</code></h3>

9686

9687

9688

9689

9690

9691

9692

9693

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

9694

</span>

9695

9696

9697

9698

9699

9700

9701

9702

9703

9704

9705

9706

9707

9708

9709

9710

<p>Inherited from

9711

<a href="../classes/BaseCore.html#method_toString">BaseCore</a>:

9712

9713

9714

9715

<a href="../files/base_js_BaseCore.js.html#l592"><code>base/js/BaseCore.js:592</code></a>

9716

9717

</p>

9718

9719

9720

9721

9722

9723

</div>

9724

9725

9726

<p>Default toString implementation. Provides the constructor NAME

9727

and the instance guid, if set.</p>

9728

</div>

9729

9730

9731

9732

9733

9734

<h4>Returns:</h4>

9735

9736

9737

9738

9739

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>:

9740

9741

String representation for this object

9742

9743

</div>

9744

</div>

9745

9746

9747

9748

</div>

9749

9750

9751

9752

<h3 class="name"><code>unsubscribe</code></h3>

9753

9754

9755

9756

9757

9758

9759

9760

9761

<span class="flag deprecated" title="use detach">deprecated</span>

9762

9763

9764

9765

9766

9767

9768

9769

9770

9771

9772

9773

9774

9775

<p>Inherited from

9776

<a href="../classes/EventTarget.html#method_unsubscribe">EventTarget</a>:

9777

9778

9779

9780

<a href="../files/event-custom_js_event-target.js.html#l455"><code>event-custom/js/event-target.js:455</code></a>

9781

9782

</p>

9783

9784

9785

9786

<p>Deprecated: use detach</p>

9787

9788

9789

9790

</div>

9791

9792

9793

<p>detach a listener</p>

9794

</div>

9795

9796

9797

9798

9799

9800

9801

</div>

9802

9803

9804

9805

<h3 class="name"><code>unsubscribeAll</code></h3>

9806

9807

9808

9809

9810

9811

9812

9813

9814

9815

</li>

9816

9817

</ul><span class="paren">)</span>

9818

</div>

9819

9820

9821

9822

9823

9824

<span class="flag deprecated" title="use detachAll">deprecated</span>

9825

9826

9827

9828

9829

9830

9831

9832

9833

9834

9835

9836

9837

9838

<p>Inherited from

9839

<a href="../classes/EventTarget.html#method_unsubscribeAll">EventTarget</a>:

9840

9841

9842

9843

<a href="../files/event-custom_js_event-target.js.html#l476"><code>event-custom/js/event-target.js:476</code></a>

9844

9845

</p>

9846

9847

9848

9849

<p>Deprecated: use detachAll</p>

9850

9851

9852

9853

</div>

9854

9855

9856

<p>Removes all listeners from the specified event. If the event type

9857

is not specified, all listeners from all hosted custom events will

9858

be removed.</p>

9859

</div>

9860

9861

9862

9863

<h4>Parameters:</h4>

9864

9865

9866

9867

9868

9869

9870

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

9871

9872

9873

9874

9875

9876

<p>The type, or name of the event</p>

9877

</div>

9878

9879

9880

</li>

9881

9882

</ul>

9883

</div>

9884

9885

9886

9887

9888

9889

</div>

9890

9891

9892

</div>

9893

9894

9895

9896

9897

<h2 class="off-left">Properties</h2>

9898

9899

9900

9901

<h3 class="name"><code>_allowAdHocAttrs</code></h3>

9902

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>

9903

9904

9905

9906

9907

<span class="flag protected">protected</span>

9908

9909

9910

9911

9912

9913

9914

9915

9916

9917

<p>Inherited from

9918

<a href="../classes/BaseCore.html#property__allowAdHocAttrs">BaseCore</a>:

9919

9920

9921

9922

<a href="../files/base_js_BaseCore.js.html#l100"><code>base/js/BaseCore.js:100</code></a>

9923

9924

</p>

9925

9926

9927

9928

9929

</div>

9930

9931

9932

<p>This property controls whether or not instances of this class should

9933

allow users to add ad-hoc attributes through the constructor configuration

9934

hash.</p>

9935

9936

<p>AdHoc attributes are attributes which are not defined by the class, and are

9937

not handled by the MyClass.<em>NON</em>ATTRS_CFG</p>

9938

</div>

9939

9940

9941

<p><strong>Default:</strong> undefined (false)</p>

9942

9943

9944

9945

9946

9947

</div>

9948

9949

9950

9951

9952

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

9953

9954

9955

9956

9957

9958

9959

<span class="flag final">final</span>

9960

9961

9962

9963

<span class="flag static">static</span>

9964

9965

9966

9967

9968

9969

9970

<p>

9971

9972

Defined in

9973

9974

9975

9976

9977

<a href="../files/datasource_js_datasource-function.js.html#l27"><code>datasource/js/datasource-function.js:27</code></a>

9978

9979

</p>

9980

9981

9982

9983

9984

</div>

9985

9986

9987

<p>Class name.</p>

9988

</div>

9989

9990

9991

9992

9993

9994

9995

</div>

9996

9997

9998

9999

10000

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

10001

10002

10003

<span class="flag deprecated" title="Use this.constructor.NAME">deprecated</span>

10004

10005

10006

10007

10008

10009

10010

10011

10012

10013

10014

10015

<p>Inherited from

10016

<a href="../classes/BaseCore.html#property_name">BaseCore</a>:

10017

10018

10019

10020

<a href="../files/base_js_BaseCore.js.html#l196"><code>base/js/BaseCore.js:196</code></a>

10021

10022

</p>

10023

10024

10025

<p>Deprecated: Use this.constructor.NAME</p>

10026

10027

10028

10029

</div>

10030

10031

10032

<p>The string used to identify the class of this object.</p>

10033

</div>

10034

10035

10036

10037

10038

10039

10040

</div>

10041

10042

10043

</div>

10044

10045

10046

10047

10048

<h2 class="off-left">Attributes</h2>

10049

10050

10051

10052

10053

<h3 class="name"><code>destroyed</code></h3>

10054

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>

10055

10056

10057

10058

10059

10060

10061

10062

10063

10064

10065

10066

10067

<p>Inherited from

10068

<a href="../classes/BaseCore.html#attr_destroyed">BaseCore</a>:

10069

10070

10071

10072

<a href="../files/base_js_BaseCore.js.html#l157"><code>base/js/BaseCore.js:157</code></a>

10073

10074

</p>

10075

10076

10077

10078

10079

</div>

10080

10081

10082

<p>Flag indicating whether or not this object

10083

has been through the destroy lifecycle phase.</p>

10084

</div>

10085

10086

10087

<p><strong>Default:</strong> false</p>

10088

10089

10090

10091

10092

<h4>Fires event <code>destroyedChange</code></h4>

10093

10094

<p>

10095

Fires when the value for the configuration attribute <code>destroyed</code> is

10096

changed. You can listen for the event using the <code>on</code> method if you

10097

wish to be notified before the attribute's value has changed, or

10098

using the <code>after</code> method if you wish to be notified after the

10099

attribute's value has changed.

10100

</p>

10101

10102

10103

<h4>Parameters:</h4>

10104

10105

10106

10107

10108

<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>

10109

10110

10111

An Event Facade object with the following

10112

attribute-specific properties added:

10113

</div>

10114

10115

10116

10117

<code class="param-name">prevVal</code>

10118

10119

<div class="param-description">The value of the attribute, prior to it being set.</div>

10120

</li>

10121

10122

<code class="param-name">newVal</code>

10123

10124

<div class="param-description">The value the attribute is to be set to.</div>

10125

</li>

10126

10127

<code class="param-name">attrName</code>

10128

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

10129

<div class="param-description">The name of the attribute being set.</div>

10130

</li>

10131

10132

<code class="param-name">subAttrName</code>

10133

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

10134

<div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div>

10135

</li>

10136

</ul>

10137

</li>

10138

</ul>

10139

</div>

10140

</div>

10141

10142

10143

10144

</div>

10145

10146

10147

10148

10149

<h3 class="name"><code>initialized</code></h3>

10150

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>

10151

10152

10153

10154

10155

10156

10157

10158

10159

10160

10161

10162

10163

<p>Inherited from

10164

<a href="../classes/BaseCore.html#attr_initialized">BaseCore</a>:

10165

10166

10167

10168

<a href="../files/base_js_BaseCore.js.html#l143"><code>base/js/BaseCore.js:143</code></a>

10169

10170

</p>

10171

10172

10173

10174

10175

</div>

10176

10177

10178

<p>Flag indicating whether or not this object

10179

has been through the init lifecycle phase.</p>

10180

</div>

10181

10182

10183

<p><strong>Default:</strong> false</p>

10184

10185

10186

10187

10188

<h4>Fires event <code>initializedChange</code></h4>

10189

10190

<p>

10191

Fires when the value for the configuration attribute <code>initialized</code> is

10192

changed. You can listen for the event using the <code>on</code> method if you

10193

wish to be notified before the attribute's value has changed, or

10194

using the <code>after</code> method if you wish to be notified after the

10195

attribute's value has changed.

10196

</p>

10197

10198

10199

<h4>Parameters:</h4>

10200

10201

10202

10203

10204

<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>

10205

10206

10207

An Event Facade object with the following

10208

attribute-specific properties added:

10209

</div>

10210

10211

10212

10213

<code class="param-name">prevVal</code>

10214

10215

<div class="param-description">The value of the attribute, prior to it being set.</div>

10216

</li>

10217

10218

<code class="param-name">newVal</code>

10219

10220

<div class="param-description">The value the attribute is to be set to.</div>

10221

</li>

10222

10223

<code class="param-name">attrName</code>

10224

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

10225

<div class="param-description">The name of the attribute being set.</div>

10226

</li>

10227

10228

<code class="param-name">subAttrName</code>

10229

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

10230

<div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div>

10231

</li>

10232

</ul>

10233

</li>

10234

</ul>

10235

</div>

10236

</div>

10237

10238

10239

10240

</div>

10241

10242

10243

10244

10245

<h3 class="name"><code>source</code></h3>

10246

<span class="type">MIXED</span>

10247

10248

10249

10250

10251

10252

10253

10254

10255

10256

10257

10258

<p>Inherited from

10259

10260

DataSource.Local

10261

</a>

10262

10263

but overwritten in

10264

10265

10266

10267

<a href="../files/datasource_js_datasource-function.js.html#l46"><code>datasource/js/datasource-function.js:46</code></a>

10268

10269

</p>

10270

10271

10272

10273

10274

</div>

10275

10276

10277

<p>Pointer to live data.</p>

10278

</div>

10279

10280

10281

<p><strong>Default:</strong> null</p>

10282

10283

10284

10285

10286

<h4>Fires event <code>sourceChange</code></h4>

10287

10288

<p>

10289

Fires when the value for the configuration attribute <code>source</code> is

10290

changed. You can listen for the event using the <code>on</code> method if you

10291

wish to be notified before the attribute's value has changed, or

10292

using the <code>after</code> method if you wish to be notified after the

10293

attribute's value has changed.

10294

</p>

10295

10296

10297

<h4>Parameters:</h4>

10298

10299

10300

10301

10302

<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>

10303

10304

10305

An Event Facade object with the following

10306

attribute-specific properties added:

10307

</div>

10308

10309

10310

10311

<code class="param-name">prevVal</code>

10312

10313

<div class="param-description">The value of the attribute, prior to it being set.</div>

10314

</li>

10315

10316

<code class="param-name">newVal</code>

10317

10318

<div class="param-description">The value the attribute is to be set to.</div>

10319

</li>

10320

10321

<code class="param-name">attrName</code>

10322

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

10323

<div class="param-description">The name of the attribute being set.</div>

10324

</li>

10325

10326

<code class="param-name">subAttrName</code>

10327

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

10328

<div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div>

10329

</li>

10330

</ul>

10331

</li>

10332

</ul>

10333

</div>

10334

</div>

10335

10336

10337

10338

</div>

10339

10340

10341

</div>

10342

10343

10344

10345

10346

<h2 class="off-left">Events</h2>

10347

10348

10349

10350

10351

10352

10353

10354

10355

10356

10357

10358

10359

10360

10361

10362

10363

10364

<p>Inherited from

10365

<a href="../classes/DataSource.Local.html#event_data">DataSource.Local</a>:

10366

10367

10368

10369

<a href="../files/datasource_js_datasource-local.js.html#l148"><code>datasource/js/datasource-local.js:148</code></a>

10370

10371

</p>

10372

10373

10374

10375

10376

</div>

10377

10378

10379

<p>Fired when raw data is received.</p>

10380

</div>

10381

10382

10383

10384

<h4>Event Payload:</h4>

10385

10386

10387

10388

10389

10390

10391

<span class="type"><a href="../classes/EventFacade.html" class="crosslink">Event.Facade</a></span>

10392

10393

10394

10395

10396

10397

<p>Event Facade with the following properties:</p>

10398

10399

<dl>

10400

<dt>tId (Number)</dt> <dd>Unique transaction ID.</dd>

10401

<dt>request (Object)</dt> <dd>The request.</dd>

10402

<dt>callback (Object)</dt> <dd>Deprecated alias for the

10403

<strong>on</strong> property</dd>

10404

<dt>on (Object)</dt> <dd>The map of configured transaction

10405

callbacks. An object with the following properties:

10406

<dl>

10407

<dt>success (Function)</dt> <dd>Success handler.</dd>

10408

<dt>failure (Function)</dt> <dd>Failure handler.</dd>

10409

</dl>

10410

</dd>

10411

<dt>cfg (Object)</dt> <dd>Configuration object.</dd>

10412

<dt>data (Object)</dt> <dd>Raw data.</dd>

10413

</dl>

10414

</div>

10415

10416

10417

</li>

10418

10419

</ul>

10420

</div>

10421

10422

10423

10424

10425

</div>

10426

10427

10428

10429

<h3 class="name"><code>destroy</code></h3>

10430

10431

10432

10433

10434

10435

10436

10437

10438

10439

10440

10441

10442

10443

<p>Inherited from

10444

<a href="../classes/Base.html#event_destroy">Base</a>:

10445

10446

10447

10448

10449

10450

</p>

10451

10452

10453

10454

10455

</div>

10456

10457

10458

<p>

10459

Lifecycle event for the destroy phase,

10460

fired prior to destruction. Invoking the preventDefault

10461

method on the event object provided to subscribers will

10462

prevent destruction from proceeding.

10463

</p>

10464

10465

<p>

10466

Subscribers to the "after" moment of this event, will be notified

10467

after destruction is complete (and as a result cannot prevent

10468

destruction).

10469

</p>

10470

</div>

10471

10472

10473

10474

<h4>Event Payload:</h4>

10475

10476

10477

10478

10479

10480

10481

<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>

10482

10483

10484

10485

10486

10487

<p>Event object</p>

10488

</div>

10489

10490

10491

</li>

10492

10493

</ul>

10494

</div>

10495

10496

10497

10498

10499

</div>

10500

10501

10502

10503

<h3 class="name"><code>error</code></h3>

10504

10505

10506

10507

10508

10509

10510

10511

10512

10513

10514

10515

10516

10517

<p>Inherited from

10518

<a href="../classes/DataSource.Local.html#event_error">DataSource.Local</a>:

10519

10520

10521

10522

<a href="../files/datasource_js_datasource-local.js.html#l206"><code>datasource/js/datasource-local.js:206</code></a>

10523

10524

</p>

10525

10526

10527

10528

10529

</div>

10530

10531

10532

<p>Fired when an error is encountered.</p>

10533

</div>

10534

10535

10536

10537

<h4>Event Payload:</h4>

10538

10539

10540

10541

10542

10543

10544

<span class="type"><a href="../classes/EventFacade.html" class="crosslink">Event.Facade</a></span>

10545

10546

10547

10548

10549

10550

<p>Event Facade with the following properties:</p>

10551

10552

<dl>

10553

<dt>tId (Number)</dt> <dd>Unique transaction ID.</dd>

10554

<dt>request (Object)</dt> <dd>The request.</dd>

10555

<dt>callback (Object)</dt> <dd>Deprecated alias for the

10556

<strong>on</strong> property</dd>

10557

<dt>on (Object)</dt> <dd>The map of configured transaction

10558

callbacks. An object with the following properties:

10559

<dl>

10560

<dt>success (Function)</dt> <dd>Success handler.</dd>

10561

<dt>failure (Function)</dt> <dd>Failure handler.</dd>

10562

</dl>

10563

</dd>

10564

<dt>cfg (Object)</dt> <dd>Configuration object.</dd>

10565

<dt>data (Object)</dt> <dd>Raw data.</dd>

10566

<dt>response (Object)</dt>

10567

<dd>Normalized response object with the following properties:

10568

<dl>

10569

<dt>results (Object)</dt> <dd>Parsed results.</dd>

10570

<dt>meta (Object)</dt> <dd>Parsed meta data.</dd>

10571

<dt>error (Object)</dt> <dd>Error object.</dd>

10572

</dl>

10573

</dd>

10574

<dt>error</dt>

10575

<dd>Any error that occurred along the transaction lifecycle.</dd>

10576

</dl>

10577

</div>

10578

10579

10580

</li>

10581

10582

</ul>

10583

</div>

10584

10585

10586

10587

10588

</div>

10589

10590

10591

10592

10593

10594

10595

10596

10597

10598

10599

10600

10601

10602

10603

10604

10605

10606

<p>Inherited from

10607

<a href="../classes/Base.html#event_init">Base</a>:

10608

10609

10610

10611

10612

10613

</p>

10614

10615

10616

10617

10618

</div>

10619

10620

10621

<p>

10622

Lifecycle event for the init phase, fired prior to initialization.

10623

Invoking the preventDefault() method on the event object provided

10624

to subscribers will prevent initialization from occuring.

10625

</p>

10626

10627

<p>

10628

Subscribers to the "after" momemt of this event, will be notified

10629

after initialization of the object is complete (and therefore

10630

cannot prevent initialization).

10631

</p>

10632

</div>

10633

10634

10635

10636

<h4>Event Payload:</h4>

10637

10638

10639

10640

10641

10642

10643

<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>

10644

10645

10646

10647

10648

10649

<p>Event object, with a cfg property which

10650

refers to the configuration object passed to the constructor.</p>

10651

</div>

10652

10653

10654

</li>

10655

10656

</ul>

10657

</div>

10658

10659

10660

10661

10662

</div>

10663

10664

10665

10666

<h3 class="name"><code>request</code></h3>

10667

10668

10669

10670

10671

10672

10673

10674

10675

10676

10677

10678

10679

10680

<p>Inherited from

10681

<a href="../classes/DataSource.Local.html#event_request">DataSource.Local</a>:

10682

10683

10684

10685

<a href="../files/datasource_js_datasource-local.js.html#l130"><code>datasource/js/datasource-local.js:130</code></a>

10686

10687

</p>

10688

10689

10690

10691

10692

</div>

10693

10694

10695

<p>Fired when a data request is received.</p>

10696

</div>

10697

10698

10699

10700

<h4>Event Payload:</h4>

10701

10702

10703

10704

10705

10706

10707

<span class="type"><a href="../classes/EventFacade.html" class="crosslink">Event.Facade</a></span>

10708

10709

10710

10711

10712

10713

<p>Event Facade with the following properties:</p>

10714

10715

<dl>

10716

<dt>tId (Number)</dt> <dd>Unique transaction ID.</dd>

10717

<dt>request (Object)</dt> <dd>The request.</dd>

10718

<dt>callback (Object)</dt> <dd>The callback object

10719

(deprecated, refer to <strong>on</strong></dd>

10720

<dt>on (Object)</dt> <dd>The map of configured callback

10721

functions.</dd>

10722

<dt>cfg (Object)</dt> <dd>Configuration object.</dd>

10723

</dl>

10724

</div>

10725

10726

10727

</li>

10728

10729

</ul>

10730

</div>

10731

10732

10733

10734

10735

</div>

10736

10737

10738

10739

<h3 class="name"><code>response</code></h3>

10740

10741

10742

10743

10744

10745

10746

10747

10748

10749

10750

10751

10752

10753

<p>Inherited from

10754

<a href="../classes/DataSource.Local.html#event_response">DataSource.Local</a>:

10755

10756

10757

10758

<a href="../files/datasource_js_datasource-local.js.html#l172"><code>datasource/js/datasource-local.js:172</code></a>

10759

10760

</p>

10761

10762

10763

10764

10765

</div>

10766

10767

10768

<p>Fired when response is returned.</p>

10769

</div>

10770

10771

10772

10773

<h4>Event Payload:</h4>

10774

10775

10776

10777

10778

10779

10780

<span class="type"><a href="../classes/EventFacade.html" class="crosslink">Event.Facade</a></span>

10781

10782

10783

10784

10785

10786

<p>Event Facade with the following properties:</p>

10787

10788

<dl>

10789

<dt>tId (Number)</dt> <dd>Unique transaction ID.</dd>

10790

<dt>request (Object)</dt> <dd>The request.</dd>

10791

<dt>callback (Object)</dt> <dd>Deprecated alias for the

10792

<strong>on</strong> property</dd>

10793

<dt>on (Object)</dt> <dd>The map of configured transaction

10794

callbacks. An object with the following properties:

10795

<dl>

10796

<dt>success (Function)</dt> <dd>Success handler.</dd>

10797

<dt>failure (Function)</dt> <dd>Failure handler.</dd>

10798

</dl>

10799

</dd>

10800

<dt>cfg (Object)</dt> <dd>Configuration object.</dd>

10801

<dt>data (Object)</dt> <dd>Raw data.</dd>

10802

<dt>response (Object)</dt>

10803

<dd>Normalized response object with the following properties:

10804

<dl>

10805

<dt>results (Object)</dt> <dd>Parsed results.</dd>

10806

<dt>meta (Object)</dt> <dd>Parsed meta data.</dd>

10807

<dt>error (Boolean)</dt> <dd>Error flag.</dd>

10808

</dl>

10809

</dd>

10810

<dt>error</dt>

10811

<dd>Any error that occurred along the transaction lifecycle.</dd>

10812

</dl>

10813

</div>

10814

10815

10816

</li>

10817

10818

</ul>

10819

</div>

10820

10821

10822

10823

10824

</div>

10825

10826

10827

</div>

10828

10829

</div>

10830

</div>

10831

10832

</div>

10833

</div>

10834

</div>

10835

</div>

10836

</div>

10837

</div>

10838

10839

10840

10841

10842

10843

10844

10845

10846

</body>

10847

</html>

Older »