~bcsaller/juju-gui/charmFind

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

2098

2099

2100

2101

2102

2103

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

2104

</div>

2105

2106

2107

</li>

2108

2109

2110

2111

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

2112

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

2113

2114

2115

2116

2117

2118

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

2119

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

2120

</div>

2121

2122

2123

</li>

2124

2125

2126

2127

2128

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

2129

2130

2131

2132

2133

2134

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

2135

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

2136

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

2137

</div>

2138

2139

2140

</li>

2141

2142

</ul>

2143

</div>

2144

2145

2146

2147

2148

2149

</div>

2150

2151

2152

2153

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

2154

2155

2156

2157

2158

2159

2160

2161

2162

2163

</li>

2164

2165

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

2166

</div>

2167

2168

2169

2170

2171

2172

2173

2174

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

2175

2176

2177

2178

2179

2180

2181

2182

2183

2184

2185

2186

<p>Inherited from

2187

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

2188

2189

2190

2191

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

2192

2193

</p>

2194

2195

2196

2197

2198

2199

</div>

2200

2201

2202

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

2203

</div>

2204

2205

2206

2207

<h4>Parameters:</h4>

2208

2209

2210

2211

2212

2213

2214

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

2215

2216

2217

2218

2219

2220

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

2221

</div>

2222

2223

2224

</li>

2225

2226

</ul>

2227

</div>

2228

2229

2230

2231

2232

2233

</div>

2234

2235

2236

2237

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

2238

2239

2240

2241

2242

2243

2244

2245

<code>allAttrs</code>

2246

2247

</li>

2248

2249

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

2250

</div>

2251

2252

2253

2254

2255

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

2256

</span>

2257

2258

2259

2260

2261

2262

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

2263

2264

2265

2266

2267

2268

2269

2270

2271

2272

2273

2274

<p>Inherited from

2275

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

2276

2277

2278

2279

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

2280

2281

</p>

2282

2283

2284

2285

2286

2287

</div>

2288

2289

2290

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

2291

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

2292

2293

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

2294

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

2295

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

2296

</div>

2297

2298

2299

2300

<h4>Parameters:</h4>

2301

2302

2303

2304

2305

2306

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

2307

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

2308

2309

2310

2311

2312

2313

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

2314

(subclass first, Base last)</p>

2315

</div>

2316

2317

2318

</li>

2319

2320

</ul>

2321

</div>

2322

2323

2324

2325

2326

<h4>Returns:</h4>

2327

2328

2329

2330

2331

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

2332

2333

The aggregate set of ATTRS definitions for the instance

2334

2335

</div>

2336

</div>

2337

2338

2339

2340

</div>

2341

2342

2343

2344

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

2345

2346

2347

2348

2349

2350

2351

2352

2353

2354

2355

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

2356

2357

2358

2359

2360

2361

2362

2363

2364

2365

2366

<p>Inherited from

2367

2368

BaseCore

2369

</a>

2370

2371

but overwritten in

2372

2373

2374

2375

2376

2377

</p>

2378

2379

2380

2381

2382

2383

</div>

2384

2385

2386

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

2387

this class.</p>

2388

</div>

2389

2390

2391

2392

2393

2394

2395

</div>

2396

2397

2398

2399

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

2400

2401

2402

2403

2404

2405

2406

2407

2408

2409

2410

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

2411

2412

2413

2414

2415

2416

2417

2418

2419

2420

2421

2422

<p>Inherited from

2423

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

2424

2425

2426

2427

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

2428

2429

</p>

2430

2431

2432

2433

2434

2435

</div>

2436

2437

2438

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

2439

</div>

2440

2441

2442

2443

2444

2445

2446

</div>

2447

2448

2449

2450

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

2451

2452

2453

2454

2455

2456

2457

2458

2459

2460

2461

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

2462

2463

2464

2465

2466

2467

2468

2469

2470

2471

2472

2473

<p>Inherited from

2474

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

2475

2476

2477

2478

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

2479

2480

</p>

2481

2482

2483

2484

2485

2486

</div>

2487

2488

2489

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

2490

</div>

2491

2492

2493

2494

2495

2496

2497

</div>

2498

2499

2500

2501

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

2502

2503

2504

2505

2506

2507

2508

2509

2510

2511

</li>

2512

2513

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

2514

</div>

2515

2516

2517

2518

2519

2520

2521

2522

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

2523

2524

2525

2526

2527

2528

2529

2530

2531

2532

2533

2534

<p>Inherited from

2535

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

2536

2537

2538

2539

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

2540

2541

</p>

2542

2543

2544

2545

2546

2547

</div>

2548

2549

2550

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

2551

</div>

2552

2553

2554

2555

<h4>Parameters:</h4>

2556

2557

2558

2559

2560

2561

2562

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

2563

2564

2565

2566

2567

2568

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

2569

</div>

2570

2571

2572

</li>

2573

2574

</ul>

2575

</div>

2576

2577

2578

2579

2580

2581

</div>

2582

2583

2584

2585

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

2586

2587

2588

2589

2590

2591

2592

2593

2594

2595

</li>

2596

2597

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

2598

</div>

2599

2600

2601

2602

2603

2604

2605

2606

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

2607

2608

2609

2610

2611

2612

2613

2614

2615

2616

2617

2618

<p>Inherited from

2619

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

2620

2621

2622

2623

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

2624

2625

</p>

2626

2627

2628

2629

2630

2631

</div>

2632

2633

2634

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

2635

</div>

2636

2637

2638

2639

<h4>Parameters:</h4>

2640

2641

2642

2643

2644

2645

2646

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

2647

2648

2649

2650

2651

2652

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

2653

2654

<dl>

2655

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

2656

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

2657

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

2658

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

2659

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

2660

callbacks. An object with the following properties:

2661

<dl>

2662

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

2663

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

2664

</dl>

2665

</dd>

2666

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

2667

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

2668

</dl>

2669

</div>

2670

2671

2672

</li>

2673

2674

</ul>

2675

</div>

2676

2677

2678

2679

2680

2681

</div>

2682

2683

2684

2685

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

2686

2687

2688

2689

2690

2691

2692

2693

2694

2695

</li>

2696

2697

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

2698

</div>

2699

2700

2701

2702

2703

2704

2705

2706

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

2707

2708

2709

2710

2711

2712

2713

2714

2715

2716

2717

2718

<p>Inherited from

2719

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

2720

2721

2722

2723

2724

2725

</p>

2726

2727

2728

2729

2730

2731

</div>

2732

2733

2734

<p>Default destroy event handler</p>

2735

</div>

2736

2737

2738

2739

<h4>Parameters:</h4>

2740

2741

2742

2743

2744

2745

2746

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

2747

2748

2749

2750

2751

2752

<p>Event object</p>

2753

</div>

2754

2755

2756

</li>

2757

2758

</ul>

2759

</div>

2760

2761

2762

2763

2764

2765

</div>

2766

2767

2768

2769

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

2770

2771

2772

2773

2774

2775

2776

2777

2778

2779

</li>

2780

2781

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

2782

</div>

2783

2784

2785

2786

2787

2788

2789

2790

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

2791

2792

2793

2794

2795

2796

2797

2798

2799

2800

2801

2802

<p>Inherited from

2803

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

2804

2805

2806

2807

2808

2809

</p>

2810

2811

2812

2813

2814

2815

</div>

2816

2817

2818

<p>Default init event handler</p>

2819

</div>

2820

2821

2822

2823

<h4>Parameters:</h4>

2824

2825

2826

2827

2828

2829

2830

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

2831

2832

2833

2834

2835

2836

<p>Event object, with a cfg property which

2837

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

2838

</div>

2839

2840

2841

</li>

2842

2843

</ul>

2844

</div>

2845

2846

2847

2848

2849

2850

</div>

2851

2852

2853

2854

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

2855

2856

2857

2858

2859

2860

2861

2862

2863

2864

</li>

2865

2866

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

2867

</div>

2868

2869

2870

2871

2872

2873

2874

2875

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

2876

2877

2878

2879

2880

2881

2882

2883

2884

2885

2886

2887

2888

<p>

2889

2890

Defined in

2891

2892

2893

2894

2895

<a href="../files/datasource_js_datasource-get.js.html#l20"><code>datasource/js/datasource-get.js:20</code></a>

2896

2897

</p>

2898

2899

2900

2901

2902

2903

</div>

2904

2905

2906

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

2907

response is received asynchronously.</p>

2908

</div>

2909

2910

2911

2912

<h4>Parameters:</h4>

2913

2914

2915

2916

2917

2918

2919

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

2920

2921

2922

2923

2924

2925

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

2926

2927

<dl>

2928

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

2929

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

2930

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

2931

<dl>

2932

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

2933

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

2934

</dl>

2935

</dd>

2936

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

2937

</dl>

2938

</div>

2939

2940

2941

</li>

2942

2943

</ul>

2944

</div>

2945

2946

2947

2948

2949

2950

</div>

2951

2952

2953

2954

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

2955

2956

2957

2958

2959

2960

2961

2962

2963

2964

</li>

2965

2966

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

2967

</div>

2968

2969

2970

2971

2972

2973

2974

2975

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

2976

2977

2978

2979

2980

2981

2982

2983

2984

2985

2986

2987

<p>Inherited from

2988

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

2989

2990

2991

2992

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

2993

2994

</p>

2995

2996

2997

2998

2999

3000

</div>

3001

3002

3003

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

3004

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

3005

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

3006

</div>

3007

3008

3009

3010

<h4>Parameters:</h4>

3011

3012

3013

3014

3015

3016

3017

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

3018

3019

3020

3021

3022

3023

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

3024

3025

<dl>

3026

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

3027

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

3028

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

3029

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

3030

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

3031

callbacks. An object with the following properties:

3032

<dl>

3033

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

3034

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

3035

</dl>

3036

</dd>

3037

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

3038

</dl>

3039

</div>

3040

3041

3042

</li>

3043

3044

</ul>

3045

</div>

3046

3047

3048

3049

3050

3051

</div>

3052

3053

3054

3055

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

3056

3057

3058

3059

3060

3061

3062

3063

3064

3065

</li>

3066

3067

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

3068

</div>

3069

3070

3071

3072

3073

3074

3075

3076

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

3077

3078

3079

3080

3081

3082

3083

3084

3085

3086

3087

3088

<p>Inherited from

3089

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

3090

3091

3092

3093

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

3094

3095

</p>

3096

3097

3098

3099

3100

3101

</div>

3102

3103

3104

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

3105

</div>

3106

3107

3108

3109

<h4>Parameters:</h4>

3110

3111

3112

3113

3114

3115

3116

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

3117

3118

3119

3120

3121

3122

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

3123

3124

<dl>

3125

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

3126

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

3127

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

3128

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

3129

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

3130

callbacks. An object with the following properties:

3131

<dl>

3132

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

3133

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

3134

</dl>

3135

</dd>

3136

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

3137

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

3138

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

3139

<dl>

3140

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

3141

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

3142

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

3143

</dl>

3144

</dd>

3145

</dl>

3146

</div>

3147

3148

3149

</li>

3150

3151

</ul>

3152

</div>

3153

3154

3155

3156

3157

3158

</div>

3159

3160

3161

3162

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

3163

3164

3165

3166

3167

3168

3169

3170

3171

3172

3173

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

3174

3175

3176

3177

3178

3179

3180

3181

3182

3183

3184

3185

<p>Inherited from

3186

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

3187

3188

3189

3190

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

3191

3192

</p>

3193

3194

3195

3196

3197

3198

</div>

3199

3200

3201

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

3202

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

3203

</div>

3204

3205

3206

3207

3208

3209

3210

</div>

3211

3212

3213

3214

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

3215

3216

3217

3218

3219

3220

3221

3222

<code>allAttrs</code>

3223

3224

</li>

3225

3226

3227

3228

<code>userVals</code>

3229

3230

</li>

3231

3232

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

3233

</div>

3234

3235

3236

3237

3238

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

3239

</span>

3240

3241

3242

3243

3244

3245

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

3246

3247

3248

3249

3250

3251

3252

3253

3254

3255

3256

3257

<p>Inherited from

3258

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

3259

3260

3261

3262

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

3263

3264

</p>

3265

3266

3267

3268

3269

3270

</div>

3271

3272

3273

3274

</div>

3275

3276

3277

3278

<h4>Parameters:</h4>

3279

3280

3281

3282

3283

3284

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

3285

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

3286

3287

3288

3289

3290

3291

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

3292

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

3293

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

3294

</div>

3295

3296

3297

</li>

3298

3299

3300

3301

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

3302

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

3303

3304

3305

3306

3307

3308

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

3309

</div>

3310

3311

3312

</li>

3313

3314

</ul>

3315

</div>

3316

3317

3318

3319

3320

<h4>Returns:</h4>

3321

3322

3323

3324

3325

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

3326

3327

The set of adhoc attributes passed in, in the form

3328

of an object with attribute name/configuration pairs.

3329

3330

</div>

3331

</div>

3332

3333

3334

3335

</div>

3336

3337

3338

3339

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

3340

3341

3342

3343

3344

3345

3346

3347

<code>clazz</code>

3348

3349

</li>

3350

3351

3352

3353

<code>allCfgs</code>

3354

3355

</li>

3356

3357

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

3358

</div>

3359

3360

3361

3362

3363

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

3364

</span>

3365

3366

3367

3368

3369

3370

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

3371

3372

3373

3374

3375

3376

3377

3378

3379

3380

3381

3382

<p>Inherited from

3383

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

3384

3385

3386

3387

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

3388

3389

</p>

3390

3391

3392

3393

3394

3395

</div>

3396

3397

3398

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

3399

initialization. Returns a disposable object with the attributes defined for

3400

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

3401

</div>

3402

3403

3404

3405

<h4>Parameters:</h4>

3406

3407

3408

3409

3410

3411

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

3412

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

3413

3414

3415

3416

3417

3418

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

3419

</div>

3420

3421

3422

</li>

3423

3424

3425

3426

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

3427

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

3428

3429

3430

3431

3432

3433

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

3434

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

3435

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

3436

</div>

3437

3438

3439

</li>

3440

3441

</ul>

3442

</div>

3443

3444

3445

3446

3447

<h4>Returns:</h4>

3448

3449

3450

3451

3452

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

3453

3454

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

3455

of an object with attribute name/configuration pairs.

3456

3457

</div>

3458

</div>

3459

3460

3461

3462

</div>

3463

3464

3465

3466

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

3467

3468

3469

3470

3471

3472

3473

3474

<code>attrName</code>

3475

3476

</li>

3477

3478

3479

3480

<code>subAttrName</code>

3481

3482

</li>

3483

3484

3485

3486

<code>currVal</code>

3487

3488

</li>

3489

3490

3491

3492

<code>newVal</code>

3493

3494

</li>

3495

3496

3497

3498

3499

3500

</li>

3501

3502

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

3503

</div>

3504

3505

3506

3507

3508

3509

3510

3511

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

3512

3513

3514

3515

3516

3517

3518

3519

3520

3521

3522

3523

<p>Inherited from

3524

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

3525

3526

3527

3528

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

3529

3530

</p>

3531

3532

3533

3534

3535

3536

</div>

3537

3538

3539

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

3540

</div>

3541

3542

3543

3544

<h4>Parameters:</h4>

3545

3546

3547

3548

3549

3550

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

3551

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

3552

3553

3554

3555

3556

3557

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

3558

</div>

3559

3560

3561

</li>

3562

3563

3564

3565

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

3566

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

3567

3568

3569

3570

3571

3572

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

3573

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

3574

</div>

3575

3576

3577

</li>

3578

3579

3580

3581

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

3582

3583

3584

3585

3586

3587

3588

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

3589

</div>

3590

3591

3592

</li>

3593

3594

3595

3596

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

3597

3598

3599

3600

3601

3602

3603

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

3604

</div>

3605

3606

3607

</li>

3608

3609

3610

3611

3612

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

3613

3614

3615

3616

3617

3618

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

3619

</div>

3620

3621

3622

</li>

3623

3624

</ul>

3625

</div>

3626

3627

3628

3629

3630

3631

</div>

3632

3633

3634

3635

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

3636

3637

3638

3639

3640

3641

3642

3643

3644

3645

</li>

3646

3647

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

3648

</div>

3649

3650

3651

3652

3653

3654

3655

3656

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

3657

3658

3659

3660

3661

3662

3663

3664

3665

3666

3667

3668

3669

<p>

3670

3671

Defined in

3672

3673

3674

3675

3676

<a href="../files/datasource_js_datasource-get.js.html#l110"><code>datasource/js/datasource-get.js:110</code></a>

3677

3678

</p>

3679

3680

3681

3682

3683

3684

</div>

3685

3686

3687

<p>Default method for adding callback param to url. See

3688

generateRequestCallback attribute.</p>

3689

</div>

3690

3691

3692

3693

<h4>Parameters:</h4>

3694

3695

3696

3697

3698

3699

3700

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

3701

3702

3703

3704

3705

3706

<p>unique identifier for callback function wrapper</p>

3707

</div>

3708

3709

3710

</li>

3711

3712

</ul>

3713

</div>

3714

3715

3716

3717

3718

3719

</div>

3720

3721

3722

3723

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

3724

3725

3726

3727

3728

3729

3730

3731

3732

3733

</li>

3734

3735

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

3736

</div>

3737

3738

3739

3740

3741

3742

</span>

3743

3744

3745

3746

3747

3748

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

3749

3750

3751

3752

3753

3754

3755

3756

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

3757

3758

3759

3760

3761

3762

<p>Inherited from

3763

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

3764

3765

3766

3767

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

3768

3769

</p>

3770

3771

3772

3773

3774

3775

</div>

3776

3777

3778

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

3779

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

3780

3781

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

3782

</div>

3783

3784

3785

3786

<h4>Parameters:</h4>

3787

3788

3789

3790

3791

3792

3793

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

3794

3795

3796

3797

3798

3799

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

3800

</div>

3801

3802

3803

</li>

3804

3805

</ul>

3806

</div>

3807

3808

3809

3810

3811

<h4>Returns:</h4>

3812

3813

3814

3815

3816

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

3817

3818

The value of the attribute.

3819

3820

</div>

3821

</div>

3822

3823

3824

3825

</div>

3826

3827

3828

3829

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

3830

3831

3832

3833

3834

3835

3836

3837

3838

3839

</li>

3840

3841

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

3842

</div>

3843

3844

3845

3846

3847

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

3848

</span>

3849

3850

3851

3852

3853

3854

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

3855

3856

3857

3858

3859

3860

3861

3862

3863

3864

3865

3866

<p>Inherited from

3867

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

3868

3869

3870

3871

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

3872

3873

</p>

3874

3875

3876

3877

3878

3879

</div>

3880

3881

3882

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

3883

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

3884

configuration properties for all attributes.</p>

3885

</div>

3886

3887

3888

3889

<h4>Parameters:</h4>

3890

3891

3892

3893

3894

3895

3896

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

3897

3898

3899

3900

3901

3902

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

3903

</div>

3904

3905

3906

</li>

3907

3908

</ul>

3909

</div>

3910

3911

3912

3913

3914

<h4>Returns:</h4>

3915

3916

3917

3918

3919

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

3920

3921

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

3922

3923

</div>

3924

</div>

3925

3926

3927

3928

</div>

3929

3930

3931

3932

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

3933

3934

3935

3936

3937

3938

3939

3940

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

3941

</span>

3942

3943

3944

3945

3946

3947

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

3948

3949

3950

3951

3952

3953

3954

3955

3956

3957

3958

3959

<p>Inherited from

3960

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

3961

3962

3963

3964

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

3965

3966

</p>

3967

3968

3969

3970

3971

3972

</div>

3973

3974

3975

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

3976

the class hierarchy.</p>

3977

</div>

3978

3979

3980

3981

3982

3983

<h4>Returns:</h4>

3984

3985

3986

3987

3988

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

3989

3990

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

3991

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

3992

the cached value.

3993

3994

</div>

3995

</div>

3996

3997

3998

3999

</div>

4000

4001

4002

4003

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

4004

4005

4006

4007

4008

4009

4010

4011

4012

4013

</li>

4014

4015

4016

4017

4018

4019

</li>

4020

4021

4022

4023

<code>initValues</code>

4024

4025

</li>

4026

4027

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

4028

</div>

4029

4030

4031

4032

4033

4034

</span>

4035

4036

4037

4038

4039

4040

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

4041

4042

4043

4044

4045

4046

4047

4048

4049

4050

4051

<p>Inherited from

4052

4053

Attribute

4054

</a>

4055

4056

but overwritten in

4057

4058

4059

4060

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

4061

4062

</p>

4063

4064

4065

4066

4067

4068

</div>

4069

4070

4071

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

4072

either the default configuration provided, or the

4073

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

4074

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

4075

</div>

4076

4077

4078

4079

<h4>Parameters:</h4>

4080

4081

4082

4083

4084

4085

4086

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

4087

4088

4089

4090

4091

4092

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

4093

</div>

4094

4095

4096

</li>

4097

4098

4099

4100

4101

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

4102

4103

4104

4105

4106

4107

<p>The attribute configuration object</p>

4108

</div>

4109

4110

4111

</li>

4112

4113

4114

4115

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

4116

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

4117

4118

4119

4120

4121

4122

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

4123

</div>

4124

4125

4126

</li>

4127

4128

</ul>

4129

</div>

4130

4131

4132

4133

4134

<h4>Returns:</h4>

4135

4136

4137

4138

4139

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

4140

4141

The initial value of the attribute.

4142

4143

</div>

4144

</div>

4145

4146

4147

4148

</div>

4149

4150

4151

4152

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

4153

4154

4155

4156

4157

4158

4159

4160

<code>attrs</code>

4161

4162

</li>

4163

4164

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

4165

</div>

4166

4167

4168

4169

4170

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

4171

</span>

4172

4173

4174

4175

4176

4177

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

4178

4179

4180

4181

4182

4183

4184

4185

4186

4187

4188

4189

<p>Inherited from

4190

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

4191

4192

4193

4194

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

4195

4196

</p>

4197

4198

4199

4200

4201

4202

</div>

4203

4204

4205

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

4206

</div>

4207

4208

4209

4210

<h4>Parameters:</h4>

4211

4212

4213

4214

4215

4216

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

4217

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

4218

4219

4220

4221

4222

4223

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

4224

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

4225

</div>

4226

4227

4228

</li>

4229

4230

</ul>

4231

</div>

4232

4233

4234

4235

4236

<h4>Returns:</h4>

4237

4238

4239

4240

4241

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

4242

4243

An object with attribute name/value pairs.

4244

4245

</div>

4246

</div>

4247

4248

4249

4250

</div>

4251

4252

4253

4254

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

4255

4256

4257

4258

4259

4260

4261

4262

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

4263

</span>

4264

4265

4266

4267

4268

4269

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

4270

4271

4272

4273

4274

4275

4276

4277

4278

4279

4280

4281

<p>Inherited from

4282

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

4283

4284

4285

4286

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

4287

4288

</p>

4289

4290

4291

4292

4293

4294

</div>

4295

4296

4297

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

4298

</div>

4299

4300

4301

4302

4303

4304

<h4>Returns:</h4>

4305

4306

4307

4308

4309

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

4310

4311

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

4312

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

4313

cached value.

4314

4315

</div>

4316

</div>

4317

4318

4319

4320

</div>

4321

4322

4323

4324

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

4325

4326

4327

4328

4329

4330

4331

4332

4333

4334

</li>

4335

4336

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

4337

</div>

4338

4339

4340

4341

4342

4343

</span>

4344

4345

4346

4347

4348

4349

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

4350

4351

4352

4353

4354

4355

4356

4357

4358

4359

4360

4361

<p>Inherited from

4362

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

4363

4364

4365

4366

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

4367

4368

</p>

4369

4370

4371

4372

4373

4374

</div>

4375

4376

4377

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

4378

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

4379

</div>

4380

4381

4382

4383

<h4>Parameters:</h4>

4384

4385

4386

4387

4388

4389

4390

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

4391

4392

4393

4394

4395

4396

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

4397

</div>

4398

4399

4400

</li>

4401

4402

</ul>

4403

</div>

4404

4405

4406

4407

4408

<h4>Returns:</h4>

4409

4410

4411

4412

4413

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

4414

4415

The stored value of the attribute

4416

4417

</div>

4418

</div>

4419

4420

4421

4422

</div>

4423

4424

4425

4426

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

4427

4428

4429

4430

4431

4432

4433

4434

4435

4436

4437

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

4438

4439

4440

4441

4442

4443

4444

4445

4446

4447

4448

4449

<p>Inherited from

4450

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

4451

4452

4453

4454

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

4455

4456

</p>

4457

4458

4459

4460

4461

4462

</div>

4463

4464

4465

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

4466

event type is not prefixed, the instance prefix is

4467

applied to the supplied type.</p>

4468

</div>

4469

4470

4471

4472

4473

4474

4475

</div>

4476

4477

4478

4479

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

4480

4481

4482

4483

4484

4485

4486

4487

<code>attrs</code>

4488

4489

</li>

4490

4491

4492

4493

<code>values</code>

4494

4495

</li>

4496

4497

4498

4499

4500

4501

</li>

4502

4503

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

4504

</div>

4505

4506

4507

4508

4509

4510

4511

4512

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

4513

4514

4515

4516

4517

4518

4519

4520

4521

4522

4523

4524

<p>Inherited from

4525

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

4526

4527

4528

4529

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

4530

4531

</p>

4532

4533

4534

4535

4536

4537

</div>

4538

4539

4540

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

4541

constructor.</p>

4542

</div>

4543

4544

4545

4546

<h4>Parameters:</h4>

4547

4548

4549

4550

4551

4552

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

4553

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

4554

4555

4556

4557

4558

4559

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

4560

</div>

4561

4562

4563

</li>

4564

4565

4566

4567

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

4568

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

4569

4570

4571

4572

4573

4574

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

4575

</div>

4576

4577

4578

</li>

4579

4580

4581

4582

4583

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

4584

4585

4586

4587

4588

4589

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

4590

</div>

4591

4592

4593

</li>

4594

4595

</ul>

4596

</div>

4597

4598

4599

4600

4601

4602

</div>

4603

4604

4605

4606

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

4607

4608

4609

4610

4611

4612

4613

4614

4615

4616

4617

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

4618

4619

4620

4621

4622

4623

4624

4625

4626

4627

4628

<p>Inherited from

4629

4630

BaseCore

4631

</a>

4632

4633

but overwritten in

4634

4635

4636

4637

4638

4639

</p>

4640

4641

4642

4643

4644

4645

</div>

4646

4647

4648

<p>Initializes Attribute</p>

4649

</div>

4650

4651

4652

4653

4654

4655

4656

</div>

4657

4658

4659

4660

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

4661

4662

4663

4664

4665

4666

4667

4668

<code>attrs</code>

4669

4670

</li>

4671

4672

4673

4674

<code>values</code>

4675

4676

</li>

4677

4678

4679

4680

4681

4682

</li>

4683

4684

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

4685

</div>

4686

4687

4688

4689

4690

4691

4692

4693

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

4694

4695

4696

4697

4698

4699

4700

4701

4702

4703

4704

4705

<p>Inherited from

4706

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

4707

4708

4709

4710

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

4711

4712

</p>

4713

4714

4715

4716

4717

4718

</div>

4719

4720

4721

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

4722

</div>

4723

4724

4725

4726

<h4>Parameters:</h4>

4727

4728

4729

4730

4731

4732

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

4733

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

4734

4735

4736

4737

4738

4739

4740

</div>

4741

4742

4743

</li>

4744

4745

4746

4747

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

4748

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

4749

4750

4751

4752

4753

4754

4755

</div>

4756

4757

4758

</li>

4759

4760

4761

4762

4763

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

4764

4765

4766

4767

4768

4769

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

4770

</div>

4771

4772

4773

</li>

4774

4775

</ul>

4776

</div>

4777

4778

4779

4780

4781

4782

</div>

4783

4784

4785

4786

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

4787

4788

4789

4790

4791

4792

4793

4794

<code>config</code>

4795

4796

</li>

4797

4798

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

4799

</div>

4800

4801

4802

4803

4804

4805

4806

4807

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

4808

4809

4810

4811

4812

4813

4814

4815

4816

4817

4818

<p>Inherited from

4819

4820

BaseCore

4821

</a>

4822

4823

but overwritten in

4824

4825

4826

4827

4828

4829

</p>

4830

4831

4832

4833

4834

4835

</div>

4836

4837

4838

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

4839

</div>

4840

4841

4842

4843

<h4>Parameters:</h4>

4844

4845

4846

4847

4848

4849

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

4850

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

4851

4852

4853

4854

4855

4856

<p>The constructor configuration object</p>

4857

</div>

4858

4859

4860

</li>

4861

4862

</ul>

4863

</div>

4864

4865

4866

4867

4868

4869

</div>

4870

4871

4872

4873

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

4874

4875

4876

4877

4878

4879

4880

4881

4882

4883

4884

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

4885

4886

4887

4888

4889

4890

4891

4892

4893

4894

4895

4896

<p>Inherited from

4897

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

4898

4899

4900

4901

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

4902

4903

</p>

4904

4905

4906

4907

4908

4909

</div>

4910

4911

4912

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

4913

</div>

4914

4915

4916

4917

4918

4919

4920

</div>

4921

4922

4923

4924

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

4925

4926

4927

4928

4929

4930

4931

4932

<code>userVals</code>

4933

4934

</li>

4935

4936

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

4937

</div>

4938

4939

4940

4941

4942

4943

4944

4945

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

4946

4947

4948

4949

4950

4951

4952

4953

4954

4955

4956

4957

<p>Inherited from

4958

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

4959

4960

4961

4962

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

4963

4964

</p>

4965

4966

4967

4968

4969

4970

</div>

4971

4972

4973

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

4974

initializing attributes for each class defined in the class's

4975

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

4976

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

4977

</div>

4978

4979

4980

4981

<h4>Parameters:</h4>

4982

4983

4984

4985

4986

4987

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

4988

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

4989

4990

4991

4992

4993

4994

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

4995

</div>

4996

4997

4998

</li>

4999

5000

</ul>

5001

</div>

5002

5003

5004

5005

5006

5007

</div>

5008

5009

5010

5011

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

5012

5013

5014

5015

5016

5017

5018

5019

5020

5021

5022

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

5023

5024

5025

5026

5027

5028

5029

5030

5031

5032

5033

5034

<p>Inherited from

5035

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

5036

5037

5038

5039

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

5040

5041

</p>

5042

5043

5044

5045

5046

5047

</div>

5048

5049

5050

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

5051

the array of classes and aggregate set of attribute configurations

5052

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

5053

</div>

5054

5055

5056

5057

5058

5059

5060

</div>

5061

5062

5063

5064

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

5065

5066

5067

5068

5069

5070

5071

5072

5073

5074

</li>

5075

5076

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

5077

</div>

5078

5079

5080

5081

5082

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

5083

</span>

5084

5085

5086

5087

5088

5089

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

5090

5091

5092

5093

5094

5095

5096

5097

5098

5099

5100

5101

<p>Inherited from

5102

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

5103

5104

5105

5106

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

5107

5108

</p>

5109

5110

5111

5112

5113

5114

</div>

5115

5116

5117

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

5118

added lazily and still requires initialization.</p>

5119

</div>

5120

5121

5122

5123

<h4>Parameters:</h4>

5124

5125

5126

5127

5128

5129

5130

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

5131

5132

5133

5134

5135

5136

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

5137

</div>

5138

5139

5140

</li>

5141

5142

</ul>

5143

</div>

5144

5145

5146

5147

5148

<h4>Returns:</h4>

5149

5150

5151

5152

5153

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

5154

5155

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

5156

5157

</div>

5158

</div>

5159

5160

5161

5162

</div>

5163

5164

5165

5166

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

5167

5168

5169

5170

5171

5172

5173

5174

5175

5176

</li>

5177

5178

5179

5180

5181

5182

</li>

5183

5184

5185

5186

5187

5188

</li>

5189

5190

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

5191

</div>

5192

5193

5194

5195

5196

5197

5198

5199

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

5200

5201

5202

5203

5204

5205

5206

5207

5208

5209

5210

5211

<p>Inherited from

5212

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

5213

5214

5215

5216

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

5217

5218

</p>

5219

5220

5221

5222

5223

5224

</div>

5225

5226

5227

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

5228

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

5229

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

5230

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

5231

be subscribed to like other events to monitor the event

5232

system. Inividual published events can have monitoring

5233

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

5234

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

5235

</div>

5236

5237

5238

5239

<h4>Parameters:</h4>

5240

5241

5242

5243

5244

5245

5246

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

5247

5248

5249

5250

5251

5252

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

5253

</div>

5254

5255

5256

</li>

5257

5258

5259

5260

5261

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

5262

5263

5264

5265

5266

5267

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

5268

</div>

5269

5270

5271

</li>

5272

5273

5274

5275

5276

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

5277

5278

5279

5280

5281

5282

<p>Information about the event interaction, such as

5283

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

5284

</div>

5285

5286

5287

</li>

5288

5289

</ul>

5290

</div>

5291

5292

5293

5294

5295

5296

</div>

5297

5298

5299

5300

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

5301

5302

5303

5304

5305

5306

5307

5308

<code>valueHash</code>

5309

5310

</li>

5311

5312

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

5313

</div>

5314

5315

5316

5317

5318

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

5319

</span>

5320

5321

5322

5323

5324

5325

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

5326

5327

5328

5329

5330

5331

5332

5333

5334

5335

5336

<p>Inherited from

5337

5338

Attribute

5339

</a>

5340

5341

but overwritten in

5342

5343

5344

5345

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

5346

5347

</p>

5348

5349

5350

5351

5352

5353

</div>

5354

5355

5356

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

5357

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

5358

</div>

5359

5360

5361

5362

<h4>Parameters:</h4>

5363

5364

5365

5366

5367

5368

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

5369

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

5370

5371

5372

5373

5374

5375

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

5376

</div>

5377

5378

5379

</li>

5380

5381

</ul>

5382

</div>

5383

5384

5385

5386

5387

<h4>Returns:</h4>

5388

5389

5390

5391

5392

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

5393

5394

5395

</div>

5396

</div>

5397

5398

5399

5400

</div>

5401

5402

5403

5404

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

5405

5406

5407

5408

5409

5410

5411

5412

5413

5414

5415

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

5416

5417

5418

5419

5420

5421

5422

5423

5424

5425

5426

5427

<p>Inherited from

5428

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

5429

5430

5431

5432

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

5433

5434

</p>

5435

5436

5437

5438

5439

5440

</div>

5441

5442

5443

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

5444

and the prefixed event name from _getType

5445

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

5446

</div>

5447

5448

5449

5450

5451

5452

5453

</div>

5454

5455

5456

5457

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

5458

5459

5460

5461

5462

5463

5464

5465

<code>config</code>

5466

5467

</li>

5468

5469

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

5470

</div>

5471

5472

5473

5474

5475

5476

5477

5478

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

5479

5480

5481

5482

5483

5484

5485

5486

5487

5488

5489

5490

<p>Inherited from

5491

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

5492

5493

5494

5495

5496

5497

</p>

5498

5499

5500

5501

5502

5503

</div>

5504

5505

5506

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

5507

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

5508

construction, prior to init.</p>

5509

</div>

5510

5511

5512

5513

<h4>Parameters:</h4>

5514

5515

5516

5517

5518

5519

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

5520

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

5521

5522

5523

5524

5525

5526

<p>The user configuration object</p>

5527

</div>

5528

5529

5530

</li>

5531

5532

</ul>

5533

</div>

5534

5535

5536

5537

5538

5539

</div>

5540

5541

5542

5543

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

5544

5545

5546

5547

5548

5549

5550

5551

<code>attrs</code>

5552

5553

</li>

5554

5555

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

5556

</div>

5557

5558

5559

5560

5561

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

5562

</span>

5563

5564

5565

5566

5567

5568

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

5569

5570

5571

5572

5573

5574

5575

5576

5577

5578

5579

5580

<p>Inherited from

5581

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

5582

5583

5584

5585

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

5586

5587

</p>

5588

5589

5590

5591

5592

5593

</div>

5594

5595

5596

<p>Utility method to protect an attribute configuration

5597

hash, by merging the entire object and the individual

5598

attr config objects.</p>

5599

</div>

5600

5601

5602

5603

<h4>Parameters:</h4>

5604

5605

5606

5607

5608

5609

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

5610

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

5611

5612

5613

5614

5615

5616

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

5617

</div>

5618

5619

5620

</li>

5621

5622

</ul>

5623

</div>

5624

5625

5626

5627

5628

<h4>Returns:</h4>

5629

5630

5631

5632

5633

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

5634

5635

A protected version of the attrs argument.

5636

5637

</div>

5638

</div>

5639

5640

5641

5642

</div>

5643

5644

5645

5646

5647

5648

5649

5650

5651

5652

5653

5654

5655

5656

</li>

5657

5658

5659

5660

5661

5662

</li>

5663

5664

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

5665

</div>

5666

5667

5668

5669

5670

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

5671

</span>

5672

5673

5674

5675

5676

5677

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

5678

5679

5680

5681

5682

5683

5684

5685

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

5686

5687

5688

5689

5690

<p>Inherited from

5691

5692

AttributeEvents

5693

</a>

5694

5695

but overwritten in

5696

5697

5698

5699

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

5700

5701

</p>

5702

5703

5704

5705

5706

5707

</div>

5708

5709

5710

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

5711

</div>

5712

5713

5714

5715

<h4>Parameters:</h4>

5716

5717

5718

5719

5720

5721

5722

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

5723

5724

5725

5726

5727

5728

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

5729

</div>

5730

5731

5732

</li>

5733

5734

5735

5736

5737

5738

5739

5740

5741

5742

5743

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

5744

</div>

5745

5746

5747

</li>

5748

5749

</ul>

5750

</div>

5751

5752

5753

5754

5755

<h4>Returns:</h4>

5756

5757

5758

5759

5760

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

5761

5762

A reference to the host object.

5763

5764

</div>

5765

</div>

5766

5767

5768

5769

</div>

5770

5771

5772

5773

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

5774

5775

5776

5777

5778

5779

5780

5781

5782

5783

</li>

5784

5785

5786

5787

<code>value</code>

5788

5789

</li>

5790

5791

5792

5793

5794

5795

</li>

5796

5797

5798

5799

<code>force</code>

5800

5801

</li>

5802

5803

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

5804

</div>

5805

5806

5807

5808

5809

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

5810

</span>

5811

5812

5813

5814

5815

5816

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

5817

5818

5819

5820

5821

5822

5823

5824

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

5825

5826

5827

5828

5829

5830

<p>Inherited from

5831

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

5832

5833

5834

5835

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

5836

5837

</p>

5838

5839

5840

5841

5842

5843

</div>

5844

5845

5846

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

5847

5848

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

5849

</div>

5850

5851

5852

5853

<h4>Parameters:</h4>

5854

5855

5856

5857

5858

5859

5860

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

5861

5862

5863

5864

5865

5866

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

5867

</div>

5868

5869

5870

</li>

5871

5872

5873

5874

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

5875

5876

5877

5878

5879

5880

5881

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

5882

</div>

5883

5884

5885

</li>

5886

5887

5888

5889

5890

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

5891

5892

5893

5894

5895

5896

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

5897

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

5898

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

5899

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

5900

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

5901

</div>

5902

5903

5904

</li>

5905

5906

5907

5908

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

5909

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

5910

5911

5912

5913

5914

5915

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

5916

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

5917

</div>

5918

5919

5920

</li>

5921

5922

</ul>

5923

</div>

5924

5925

5926

5927

5928

<h4>Returns:</h4>

5929

5930

5931

5932

5933

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

5934

5935

A reference to the host object.

5936

5937

</div>

5938

</div>

5939

5940

5941

5942

</div>

5943

5944

5945

5946

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

5947

5948

5949

5950

5951

5952

5953

5954

<code>attrs</code>

5955

5956

</li>

5957

5958

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

5959

</div>

5960

5961

5962

5963

5964

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

5965

</span>

5966

5967

5968

5969

5970

5971

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

5972

5973

5974

5975

5976

5977

5978

5979

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

5980

5981

5982

5983

5984

5985

<p>Inherited from

5986

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

5987

5988

5989

5990

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

5991

5992

</p>

5993

5994

5995

5996

5997

5998

</div>

5999

6000

6001

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

6002

</div>

6003

6004

6005

6006

<h4>Parameters:</h4>

6007

6008

6009

6010

6011

6012

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

6013

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

6014

6015

6016

6017

6018

6019

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

6020

</div>

6021

6022

6023

</li>

6024

6025

</ul>

6026

</div>

6027

6028

6029

6030

6031

<h4>Returns:</h4>

6032

6033

6034

6035

6036

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

6037

6038

A reference to the host object.

6039

6040

</div>

6041

</div>

6042

6043

6044

6045

</div>

6046

6047

6048

6049

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

6050

6051

6052

6053

6054

6055

6056

6057

<code>attrName</code>

6058

6059

</li>

6060

6061

6062

6063

<code>subAttrName</code>

6064

6065

</li>

6066

6067

6068

6069

<code>prevVal</code>

6070

6071

</li>

6072

6073

6074

6075

<code>newVal</code>

6076

6077

</li>

6078

6079

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

6080

</div>

6081

6082

6083

6084

6085

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

6086

</span>

6087

6088

6089

6090

6091

6092

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

6093

6094

6095

6096

6097

6098

6099

6100

6101

6102

6103

6104

<p>Inherited from

6105

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

6106

6107

6108

6109

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

6110

6111

</p>

6112

6113

6114

6115

6116

6117

</div>

6118

6119

6120

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

6121

if validation and setter passes.</p>

6122

</div>

6123

6124

6125

6126

<h4>Parameters:</h4>

6127

6128

6129

6130

6131

6132

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

6133

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

6134

6135

6136

6137

6138

6139

<p>The attribute name.</p>

6140

</div>

6141

6142

6143

</li>

6144

6145

6146

6147

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

6148

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

6149

6150

6151

6152

6153

6154

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

6155

</div>

6156

6157

6158

</li>

6159

6160

6161

6162

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

6163

6164

6165

6166

6167

6168

6169

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

6170

</div>

6171

6172

6173

</li>

6174

6175

6176

6177

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

6178

6179

6180

6181

6182

6183

6184

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

6185

</div>

6186

6187

6188

</li>

6189

6190

</ul>

6191

</div>

6192

6193

6194

6195

6196

<h4>Returns:</h4>

6197

6198

6199

6200

6201

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

6202

6203

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

6204

6205

</div>

6206

</div>

6207

6208

6209

6210

</div>

6211

6212

6213

6214

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

6215

6216

6217

6218

6219

6220

6221

6222

6223

6224

</li>

6225

6226

6227

6228

<code>value</code>

6229

6230

</li>

6231

6232

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

6233

</div>

6234

6235

6236

6237

6238

6239

6240

6241

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

6242

6243

6244

6245

6246

6247

6248

6249

6250

6251

6252

6253

<p>Inherited from

6254

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

6255

6256

6257

6258

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

6259

6260

</p>

6261

6262

6263

6264

6265

6266

</div>

6267

6268

6269

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

6270

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

6271

</div>

6272

6273

6274

6275

<h4>Parameters:</h4>

6276

6277

6278

6279

6280

6281

6282

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

6283

6284

6285

6286

6287

6288

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

6289

</div>

6290

6291

6292

</li>

6293

6294

6295

6296

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

6297

6298

6299

6300

6301

6302

6303

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

6304

</div>

6305

6306

6307

</li>

6308

6309

</ul>

6310

</div>

6311

6312

6313

6314

6315

6316

</div>

6317

6318

6319

6320

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

6321

6322

6323

6324

6325

6326

6327

6328

6329

6330

</li>

6331

6332

6333

6334

<code>config</code>

6335

6336

</li>

6337

6338

6339

6340

6341

6342

</li>

6343

6344

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

6345

</div>

6346

6347

6348

6349

6350

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

6351

</span>

6352

6353

6354

6355

6356

6357

6358

6359

6360

6361

6362

6363

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

6364

6365

6366

6367

6368

6369

<p>Inherited from

6370

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

6371

6372

6373

6374

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

6375

6376

</p>

6377

6378

6379

6380

6381

6382

</div>

6383

6384

6385

<p>

6386

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

6387

</p>

6388

6389

<p>

6390

The config argument object supports the following properties:

6391

</p>

6392

6393

<dl>

6394

<dt>value <Any></dt>

6395

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

6396

6397

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

6398

<dd>

6399

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

6400

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

6401

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

6402

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

6403

case the value property is used.</p>

6404

6405

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

6406

</dd>

6407

6408

<dt>readOnly <boolean></dt>

6409

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

6410

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

6411

6412

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

6413

<dd>

6414

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

6415

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

6416

constructor configuration arguments, or by invoking set.

6417

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

6418

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

6419

</dd>

6420

6421

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

6422

<dd>

6423

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

6424

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

6425

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

6426

the value from being stored.

6427

</p>

6428

6429

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

6430

</dd>

6431

6432

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

6433

<dd>

6434

<p>

6435

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

6436

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

6437

invoke get.

6438

</p>

6439

6440

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

6441

</dd>

6442

6443

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

6444

<dd>

6445

<p>

6446

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

6447

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

6448

</p>

6449

6450

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

6451

</dd>

6452

6453

<dt>lazyAdd <boolean></dt>

6454

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

6455

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

6456

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

6457

6458

</dl>

6459

6460

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

6461

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

6462

6463

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

6464

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

6465

</div>

6466

6467

6468

6469

<h4>Parameters:</h4>

6470

6471

6472

6473

6474

6475

6476

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

6477

6478

6479

6480

6481

6482

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

6483

</div>

6484

6485

6486

</li>

6487

6488

6489

6490

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

6491

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

6492

6493

6494

6495

6496

6497

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

6498

6499

<p>

6500

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

6501

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

6502

</p>

6503

</div>

6504

6505

6506

</li>

6507

6508

6509

6510

6511

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

6512

6513

6514

6515

6516

6517

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

6518

</div>

6519

6520

6521

</li>

6522

6523

</ul>

6524

</div>

6525

6526

6527

6528

6529

<h4>Returns:</h4>

6530

6531

6532

6533

6534

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

6535

6536

A reference to the host object.

6537

6538

</div>

6539

</div>

6540

6541

6542

6543

</div>

6544

6545

6546

6547

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

6548

6549

6550

6551

6552

6553

6554

6555

6556

6557

</li>

6558

6559

6560

6561

<code>values</code>

6562

6563

</li>

6564

6565

6566

6567

6568

6569

</li>

6570

6571

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

6572

</div>

6573

6574

6575

6576

6577

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

6578

</span>

6579

6580

6581

6582

6583

6584

6585

6586

6587

6588

6589

6590

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

6591

6592

6593

6594

6595

6596

<p>Inherited from

6597

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

6598

6599

6600

6601

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

6602

6603

</p>

6604

6605

6606

6607

6608

6609

</div>

6610

6611

6612

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

6613

6614

<p>

6615

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

6616

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

6617

</p>

6618

</div>

6619

6620

6621

6622

<h4>Parameters:</h4>

6623

6624

6625

6626

6627

6628

6629

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

6630

6631

6632

6633

6634

6635

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

6636

</div>

6637

6638

6639

</li>

6640

6641

6642

6643

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

6644

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

6645

6646

6647

6648

6649

6650

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

6651

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

6652

</div>

6653

6654

6655

</li>

6656

6657

6658

6659

6660

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

6661

6662

6663

6664

6665

6666

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

6667

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

6668

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

6669

</div>

6670

6671

6672

</li>

6673

6674

</ul>

6675

</div>

6676

6677

6678

6679

6680

<h4>Returns:</h4>

6681

6682

6683

6684

6685

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

6686

6687

A reference to the host object.

6688

6689

</div>

6690

</div>

6691

6692

6693

6694

</div>

6695

6696

6697

6698

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

6699

6700

6701

6702

6703

6704

6705

6706

6707

6708

</li>

6709

6710

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

6711

</div>

6712

6713

6714

6715

6716

6717

6718

6719

6720

6721

6722

6723

6724

6725

6726

6727

6728

6729

<p>Inherited from

6730

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

6731

6732

6733

6734

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

6735

6736

</p>

6737

6738

6739

6740

6741

6742

</div>

6743

6744

6745

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

6746

is determined by the order registered. Multiple targets can

6747

be specified.</p>

6748

6749

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

6750

6751

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

6752

</div>

6753

6754

6755

6756

<h4>Parameters:</h4>

6757

6758

6759

6760

6761

6762

6763

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

6764

6765

6766

6767

6768

6769

<p>the target to add</p>

6770

</div>

6771

6772

6773

</li>

6774

6775

</ul>

6776

</div>

6777

6778

6779

6780

6781

6782

</div>

6783

6784

6785

6786

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

6787

6788

6789

6790

6791

6792

6793

6794

6795

6796

</li>

6797

6798

6799

6800

6801

6802

</li>

6803

6804

6805

6806

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

6807

6808

</li>

6809

6810

6811

6812

6813

6814

</li>

6815

6816

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

6817

</div>

6818

6819

6820

6821

6822

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

6823

</span>

6824

6825

6826

6827

6828

6829

6830

6831

6832

6833

6834

6835

6836

6837

6838

6839

<p>Inherited from

6840

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

6841

6842

6843

6844

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

6845

6846

</p>

6847

6848

6849

6850

6851

6852

</div>

6853

6854

6855

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

6856

supplied callback will execute after any listeners add

6857

via the subscribe method, and after the default function,

6858

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

6859

</div>

6860

6861

6862

6863

<h4>Parameters:</h4>

6864

6865

6866

6867

6868

6869

6870

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

6871

6872

6873

6874

6875

6876

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

6877

</div>

6878

6879

6880

</li>

6881

6882

6883

6884

6885

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

6886

6887

6888

6889

6890

6891

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

6892

</div>

6893

6894

6895

</li>

6896

6897

6898

6899

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

6900

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

6901

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

6902

6903

6904

6905

6906

6907

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

6908

</div>

6909

6910

6911

</li>

6912

6913

6914

6915

6916

6917

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

6918

6919

6920

6921

6922

6923

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

6924

</div>

6925

6926

6927

</li>

6928

6929

</ul>

6930

</div>

6931

6932

6933

6934

6935

<h4>Returns:</h4>

6936

6937

6938

6939

6940

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

6941

6942

A subscription handle capable of detaching the

6943

subscription

6944

6945

</div>

6946

</div>

6947

6948

6949

6950

</div>

6951

6952

6953

6954

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

6955

6956

6957

6958

6959

6960

6961

6962

6963

6964

</li>

6965

6966

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

6967

</div>

6968

6969

6970

6971

6972

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

6973

</span>

6974

6975

6976

6977

6978

6979

6980

6981

6982

6983

6984

6985

6986

6987

6988

6989

<p>Inherited from

6990

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

6991

6992

6993

6994

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

6995

6996

</p>

6997

6998

6999

7000

7001

7002

</div>

7003

7004

7005

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

7006

</div>

7007

7008

7009

7010

<h4>Parameters:</h4>

7011

7012

7013

7014

7015

7016

7017

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

7018

7019

7020

7021

7022

7023

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

7024

</div>

7025

7026

7027

</li>

7028

7029

</ul>

7030

</div>

7031

7032

7033

7034

7035

<h4>Returns:</h4>

7036

7037

7038

7039

7040

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

7041

7042

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.

7043

7044

</div>

7045

</div>

7046

7047

7048

7049

</div>

7050

7051

7052

7053

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

7054

7055

7056

7057

7058

7059

7060

7061

7062

</span>

7063

7064

7065

7066

7067

7068

7069

7070

7071

7072

7073

7074

7075

7076

7077

7078

<p>Inherited from

7079

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

7080

7081

7082

7083

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

7084

7085

</p>

7086

7087

7088

7089

7090

7091

</div>

7092

7093

7094

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

7095

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

7096

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

7097

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

7098

7099

<p>For DOM and custom events:

7100

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

7101

7102

<p>For methods:

7103

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

7104

</div>

7105

7106

7107

7108

7109

7110

<h4>Returns:</h4>

7111

7112

7113

7114

7115

detach handle

7116

7117

</div>

7118

</div>

7119

7120

7121

7122

</div>

7123

7124

7125

7126

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

7127

7128

7129

7130

7131

7132

7133

7134

7135

7136

</li>

7137

7138

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

7139

</div>

7140

7141

7142

7143

7144

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

7145

</span>

7146

7147

7148

7149

7150

7151

7152

7153

7154

7155

7156

7157

7158

7159

7160

7161

<p>Inherited from

7162

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

7163

7164

7165

7166

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

7167

7168

</p>

7169

7170

7171

7172

7173

7174

</div>

7175

7176

7177

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

7178

</div>

7179

7180

7181

7182

<h4>Parameters:</h4>

7183

7184

7185

7186

7187

7188

7189

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

7190

7191

7192

7193

7194

7195

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

7196

</div>

7197

7198

7199

</li>

7200

7201

</ul>

7202

</div>

7203

7204

7205

7206

7207

<h4>Returns:</h4>

7208

7209

7210

7211

7212

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

7213

7214

the aggregated return value from Event.Custom.fire

7215

7216

</div>

7217

</div>

7218

7219

7220

7221

</div>

7222

7223

7224

7225

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

7226

7227

7228

7229

7230

7231

7232

7233

7234

</span>

7235

7236

7237

7238

7239

7240

7241

7242

7243

7244

7245

7246

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

7247

7248

7249

7250

7251

<p>Inherited from

7252

7253

BaseCore

7254

</a>

7255

7256

but overwritten in

7257

7258

7259

7260

7261

7262

</p>

7263

7264

7265

7266

7267

7268

</div>

7269

7270

7271

<p>

7272

Destroy lifecycle method. Fires the destroy

7273

event, prior to invoking destructors for the

7274

class hierarchy.

7275

</p>

7276

7277

<p>

7278

Subscribers to the destroy

7279

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

7280

from proceeding.

7281

</p>

7282

</div>

7283

7284

7285

7286

7287

7288

<h4>Returns:</h4>

7289

7290

7291

7292

7293

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

7294

7295

A reference to this object

7296

7297

</div>

7298

</div>

7299

7300

7301

7302

</div>

7303

7304

7305

7306

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

7307

7308

7309

7310

7311

7312

7313

7314

7315

7316

</li>

7317

7318

7319

7320

7321

7322

</li>

7323

7324

7325

7326

<code>context</code>

7327

7328

</li>

7329

7330

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

7331

</div>

7332

7333

7334

7335

7336

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

7337

</span>

7338

7339

7340

7341

7342

7343

7344

7345

7346

7347

7348

7349

7350

7351

7352

7353

<p>Inherited from

7354

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

7355

7356

7357

7358

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

7359

7360

</p>

7361

7362

7363

7364

7365

7366

</div>

7367

7368

7369

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

7370

</div>

7371

7372

7373

7374

<h4>Parameters:</h4>

7375

7376

7377

7378

7379

7380

7381

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

7382

7383

7384

7385

7386

7387

<p>Either the handle to the subscriber or the

7388

type of event. If the type

7389

is not specified, it will attempt to remove

7390

the listener from all hosted events.</p>

7391

</div>

7392

7393

7394

</li>

7395

7396

7397

7398

7399

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

7400

7401

7402

7403

7404

7405

<p>The subscribed function to unsubscribe, if not

7406

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

7407

</div>

7408

7409

7410

</li>

7411

7412

7413

7414

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

7415

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

7416

7417

7418

7419

7420

7421

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

7422

optional, but if supplied will be used to

7423

disambiguate multiple listeners that are the same

7424

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

7425

that lives on the prototype)</p>

7426

</div>

7427

7428

7429

</li>

7430

7431

</ul>

7432

</div>

7433

7434

7435

7436

7437

<h4>Returns:</h4>

7438

7439

7440

7441

7442

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

7443

7444

the host

7445

7446

</div>

7447

</div>

7448

7449

7450

7451

</div>

7452

7453

7454

7455

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

7456

7457

7458

7459

7460

7461

7462

7463

7464

7465

</li>

7466

7467

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

7468

</div>

7469

7470

7471

7472

7473

7474

7475

7476

7477

7478

7479

7480

7481

7482

7483

7484

7485

7486

<p>Inherited from

7487

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

7488

7489

7490

7491

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

7492

7493

</p>

7494

7495

7496

7497

7498

7499

</div>

7500

7501

7502

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

7503

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

7504

be removed.</p>

7505

</div>

7506

7507

7508

7509

<h4>Parameters:</h4>

7510

7511

7512

7513

7514

7515

7516

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

7517

7518

7519

7520

7521

7522

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

7523

</div>

7524

7525

7526

</li>

7527

7528

</ul>

7529

</div>

7530

7531

7532

7533

7534

7535

</div>

7536

7537

7538

7539

7540

7541

7542

7543

7544

7545

7546

7547

7548

7549

</li>

7550

7551

7552

7553

<code>arguments</code>

7554

7555

</li>

7556

7557

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

7558

</div>

7559

7560

7561

7562

7563

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

7564

</span>

7565

7566

7567

7568

7569

7570

7571

7572

7573

7574

7575

7576

7577

7578

7579

7580

<p>Inherited from

7581

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

7582

7583

7584

7585

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

7586

7587

</p>

7588

7589

7590

7591

7592

7593

</div>

7594

7595

7596

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

7597

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

7598

following parameters.</p>

7599

7600

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

7601

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

7602

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

7603

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

7604

be published on this object first.</p>

7605

7606

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

7607

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

7608

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

7609

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

7610

in place of the original object.</p>

7611

</div>

7612

7613

7614

7615

<h4>Parameters:</h4>

7616

7617

7618

7619

7620

7621

7622

7623

7624

7625

7626

7627

7628

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

7629

a 'type' property.</p>

7630

</div>

7631

7632

7633

</li>

7634

7635

7636

7637

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

7638

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

7639

7640

7641

7642

7643

7644

<p>an arbitrary set of parameters to pass to

7645

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

7646

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

7647

parameter after the properties the object literal contains are copied to

7648

the event facade.</p>

7649

</div>

7650

7651

7652

</li>

7653

7654

</ul>

7655

</div>

7656

7657

7658

7659

7660

<h4>Returns:</h4>

7661

7662

7663

7664

7665

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

7666

7667

the event host

7668

7669

</div>

7670

</div>

7671

7672

7673

7674

</div>

7675

7676

7677

7678

7679

7680

7681

7682

7683

7684

7685

7686

7687

7688

</li>

7689

7690

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

7691

</div>

7692

7693

7694

7695

7696

7697

</span>

7698

7699

7700

7701

7702

7703

7704

7705

7706

7707

7708

7709

7710

7711

7712

7713

<p>Inherited from

7714

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

7715

7716

7717

7718

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

7719

7720

</p>

7721

7722

7723

7724

7725

7726

</div>

7727

7728

7729

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

7730

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

7731

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

7732

</div>

7733

7734

7735

7736

<h4>Parameters:</h4>

7737

7738

7739

7740

7741

7742

7743

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

7744

7745

7746

7747

7748

7749

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

7750

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

7751

</div>

7752

7753

7754

</li>

7755

7756

</ul>

7757

</div>

7758

7759

7760

7761

7762

<h4>Returns:</h4>

7763

7764

7765

7766

7767

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

7768

7769

The value of the attribute

7770

7771

</div>

7772

</div>

7773

7774

7775

7776

</div>

7777

7778

7779

7780

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

7781

7782

7783

7784

7785

7786

7787

7788

<code>attrs</code>

7789

7790

</li>

7791

7792

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

7793

</div>

7794

7795

7796

7797

7798

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

7799

</span>

7800

7801

7802

7803

7804

7805

7806

7807

7808

7809

7810

7811

7812

7813

7814

7815

<p>Inherited from

7816

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

7817

7818

7819

7820

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

7821

7822

</p>

7823

7824

7825

7826

7827

7828

</div>

7829

7830

7831

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

7832

</div>

7833

7834

7835

7836

<h4>Parameters:</h4>

7837

7838

7839

7840

7841

7842

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

7843

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

7844

7845

7846

7847

7848

7849

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

7850

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

7851

</div>

7852

7853

7854

</li>

7855

7856

</ul>

7857

</div>

7858

7859

7860

7861

7862

<h4>Returns:</h4>

7863

7864

7865

7866

7867

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

7868

7869

An object with attribute name/value pairs.

7870

7871

</div>

7872

</div>

7873

7874

7875

7876

</div>

7877

7878

7879

7880

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

7881

7882

7883

7884

7885

7886

7887

7888

7889

7890

</li>

7891

7892

7893

7894

<code>prefixed</code>

7895

7896

</li>

7897

7898

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

7899

</div>

7900

7901

7902

7903

7904

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

7905

</span>

7906

7907

7908

7909

7910

7911

7912

7913

7914

7915

7916

7917

7918

7919

7920

7921

<p>Inherited from

7922

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

7923

7924

7925

7926

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

7927

7928

</p>

7929

7930

7931

7932

7933

7934

</div>

7935

7936

7937

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

7938

falsy value otherwise</p>

7939

</div>

7940

7941

7942

7943

<h4>Parameters:</h4>

7944

7945

7946

7947

7948

7949

7950

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

7951

7952

7953

7954

7955

7956

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

7957

</div>

7958

7959

7960

</li>

7961

7962

7963

7964

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

7965

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

7966

7967

7968

7969

7970

7971

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

7972

</div>

7973

7974

7975

</li>

7976

7977

</ul>

7978

</div>

7979

7980

7981

7982

7983

<h4>Returns:</h4>

7984

7985

7986

7987

7988

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

7989

7990

the custom event or null

7991

7992

</div>

7993

</div>

7994

7995

7996

7997

</div>

7998

7999

8000

8001

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

8002

8003

8004

8005

8006

8007

8008

8009

8010

</span>

8011

8012

8013

8014

8015

8016

8017

8018

8019

8020

8021

8022

8023

8024

8025

8026

<p>Inherited from

8027

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

8028

8029

8030

8031

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

8032

8033

</p>

8034

8035

8036

8037

8038

8039

</div>

8040

8041

8042

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

8043

</div>

8044

8045

8046

8047

8048

8049

<h4>Returns:</h4>

8050

8051

8052

8053

8054

EventTarget[]

8055

8056

</div>

8057

</div>

8058

8059

8060

8061

</div>

8062

8063

8064

8065

8066

8067

8068

8069

8070

8071

8072

8073

<code>config</code>

8074

8075

</li>

8076

8077

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

8078

</div>

8079

8080

8081

8082

8083

8084

</span>

8085

8086

8087

8088

8089

8090

8091

8092

8093

8094

8095

8096

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

8097

8098

8099

8100

8101

<p>Inherited from

8102

8103

BaseCore

8104

</a>

8105

8106

but overwritten in

8107

8108

8109

8110

8111

8112

</p>

8113

8114

8115

8116

8117

8118

</div>

8119

8120

8121

<p>Init lifecycle method, invoked during construction.

8122

Fires the init event prior to setting up attributes and

8123

invoking initializers for the class hierarchy.</p>

8124

</div>

8125

8126

8127

8128

<h4>Parameters:</h4>

8129

8130

8131

8132

8133

8134

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

8135

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

8136

8137

8138

8139

8140

8141

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

8142

</div>

8143

8144

8145

</li>

8146

8147

</ul>

8148

</div>

8149

8150

8151

8152

8153

<h4>Returns:</h4>

8154

8155

8156

8157

8158

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

8159

8160

A reference to this object

8161

8162

</div>

8163

</div>

8164

8165

8166

8167

</div>

8168

8169

8170

8171

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

8172

8173

8174

8175

8176

8177

8178

8179

<code>config</code>

8180

8181

</li>

8182

8183

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

8184

</div>

8185

8186

8187

8188

8189

8190

8191

8192

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

8193

8194

8195

8196

8197

8198

8199

8200

8201

8202

8203

8204

<p>Inherited from

8205

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

8206

8207

8208

8209

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

8210

8211

</p>

8212

8213

8214

8215

8216

8217

</div>

8218

8219

8220

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

8221

</div>

8222

8223

8224

8225

<h4>Parameters:</h4>

8226

8227

8228

8229

8230

8231

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

8232

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

8233

8234

8235

8236

8237

8238

<p>Config object.</p>

8239

</div>

8240

8241

8242

</li>

8243

8244

</ul>

8245

</div>

8246

8247

8248

8249

8250

8251

</div>

8252

8253

8254

8255

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

8256

8257

8258

8259

8260

8261

8262

8263

8264

8265

</li>

8266

8267

8268

8269

<code>config</code>

8270

8271

</li>

8272

8273

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

8274

</div>

8275

8276

8277

8278

8279

8280

8281

8282

8283

8284

8285

8286

8287

8288

8289

8290

8291

8292

<p>Inherited from

8293

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

8294

8295

8296

8297

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

8298

8299

</p>

8300

8301

8302

8303

8304

8305

</div>

8306

8307

8308

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

8309

8310

<p>

8311

The properties which can be modified through this interface are limited

8312

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

8313

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

8314

broadcast and getter.

8315

</p>

8316

</div>

8317

8318

8319

8320

<h4>Parameters:</h4>

8321

8322

8323

8324

8325

8326

8327

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

8328

8329

8330

8331

8332

8333

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

8334

</div>

8335

8336

8337

</li>

8338

8339

8340

8341

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

8342

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

8343

8344

8345

8346

8347

8348

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

8349

</div>

8350

8351

8352

</li>

8353

8354

</ul>

8355

</div>

8356

8357

8358

8359

8360

8361

</div>

8362

8363

8364

8365

8366

8367

8368

8369

8370

8371

8372

8373

8374

8375

</li>

8376

8377

8378

8379

8380

8381

</li>

8382

8383

8384

8385

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

8386

8387

</li>

8388

8389

8390

8391

8392

8393

</li>

8394

8395

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

8396

</div>

8397

8398

8399

8400

8401

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

8402

</span>

8403

8404

8405

8406

8407

8408

8409

8410

8411

8412

8413

8414

8415

8416

8417

8418

<p>Inherited from

8419

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

8420

8421

8422

8423

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

8424

8425

</p>

8426

8427

8428

8429

8430

8431

</div>

8432

8433

8434

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

8435

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

8436

8437

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

8438

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

8439

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

8440

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

8441

API for all available properties and methods. Subscribers to

8442

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

8443

after the event name.</p>

8444

8445

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

8446

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

8447

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

8448

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

8449

8450

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

8451

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

8452

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

8453

</div>

8454

8455

8456

8457

<h4>Parameters:</h4>

8458

8459

8460

8461

8462

8463

8464

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

8465

8466

8467

8468

8469

8470

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

8471

</div>

8472

8473

8474

</li>

8475

8476

8477

8478

8479

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

8480

8481

8482

8483

8484

8485

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

8486

</div>

8487

8488

8489

</li>

8490

8491

8492

8493

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

8494

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

8495

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

8496

8497

8498

8499

8500

8501

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

8502

</div>

8503

8504

8505

</li>

8506

8507

8508

8509

8510

8511

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

8512

8513

8514

8515

8516

8517

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

8518

</div>

8519

8520

8521

</li>

8522

8523

</ul>

8524

</div>

8525

8526

8527

8528

8529

<h4>Returns:</h4>

8530

8531

8532

8533

8534

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

8535

8536

A subscription handle capable of detaching that

8537

subscription

8538

8539

</div>

8540

</div>

8541

8542

8543

8544

</div>

8545

8546

8547

8548

8549

8550

8551

8552

8553

8554

8555

8556

8557

8558

</li>

8559

8560

8561

8562

8563

8564

</li>

8565

8566

8567

8568

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

8569

8570

</li>

8571

8572

8573

8574

8575

8576

</li>

8577

8578

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

8579

</div>

8580

8581

8582

8583

8584

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

8585

</span>

8586

8587

8588

8589

8590

8591

8592

8593

8594

8595

8596

8597

8598

8599

8600

8601

<p>Inherited from

8602

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

8603

8604

8605

8606

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

8607

8608

</p>

8609

8610

8611

8612

8613

8614

</div>

8615

8616

8617

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

8618

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

8619

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

8620

</div>

8621

8622

8623

8624

<h4>Parameters:</h4>

8625

8626

8627

8628

8629

8630

8631

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

8632

8633

8634

8635

8636

8637

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

8638

</div>

8639

8640

8641

</li>

8642

8643

8644

8645

8646

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

8647

8648

8649

8650

8651

8652

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

8653

</div>

8654

8655

8656

</li>

8657

8658

8659

8660

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

8661

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

8662

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

8663

8664

8665

8666

8667

8668

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

8669

</div>

8670

8671

8672

</li>

8673

8674

8675

8676

8677

8678

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

8679

8680

8681

8682

8683

8684

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

8685

</div>

8686

8687

8688

</li>

8689

8690

</ul>

8691

</div>

8692

8693

8694

8695

8696

<h4>Returns:</h4>

8697

8698

8699

8700

8701

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

8702

8703

A subscription handle capable of detaching the

8704

subscription

8705

8706

</div>

8707

</div>

8708

8709

8710

8711

</div>

8712

8713

8714

8715

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

8716

8717

8718

8719

8720

8721

8722

8723

8724

8725

</li>

8726

8727

8728

8729

8730

8731

</li>

8732

8733

8734

8735

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

8736

8737

</li>

8738

8739

8740

8741

8742

8743

</li>

8744

8745

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

8746

</div>

8747

8748

8749

8750

8751

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

8752

</span>

8753

8754

8755

8756

8757

8758

8759

8760

8761

8762

8763

8764

8765

8766

8767

8768

<p>Inherited from

8769

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

8770

8771

8772

8773

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

8774

8775

</p>

8776

8777

8778

8779

8780

8781

</div>

8782

8783

8784

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

8785

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

8786

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

8787

</div>

8788

8789

8790

8791

<h4>Parameters:</h4>

8792

8793

8794

8795

8796

8797

8798

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

8799

8800

8801

8802

8803

8804

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

8805

</div>

8806

8807

8808

</li>

8809

8810

8811

8812

8813

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

8814

8815

8816

8817

8818

8819

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

8820

</div>

8821

8822

8823

</li>

8824

8825

8826

8827

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

8828

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

8829

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

8830

8831

8832

8833

8834

8835

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

8836

</div>

8837

8838

8839

</li>

8840

8841

8842

8843

8844

8845

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

8846

8847

8848

8849

8850

8851

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

8852

</div>

8853

8854

8855

</li>

8856

8857

</ul>

8858

</div>

8859

8860

8861

8862

8863

<h4>Returns:</h4>

8864

8865

8866

8867

8868

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

8869

8870

A subscription handle capable of detaching that

8871

subscription

8872

8873

</div>

8874

</div>

8875

8876

8877

8878

</div>

8879

8880

8881

8882

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

8883

8884

8885

8886

8887

8888

8889

8890

8891

8892

</li>

8893

8894

8895

8896

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

8897

8898

</li>

8899

8900

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

8901

</div>

8902

8903

8904

8905

8906

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

8907

</span>

8908

8909

8910

8911

8912

8913

8914

8915

8916

8917

8918

8919

8920

8921

8922

8923

<p>Inherited from

8924

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

8925

8926

8927

8928

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

8929

8930

</p>

8931

8932

8933

8934

8935

8936

<p>Available since 3.3.0</p>

8937

8938

</div>

8939

8940

8941

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

8942

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

8943

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

8944

to include the prefix one is supplied or the event target

8945

is configured with a default prefix.</p>

8946

</div>

8947

8948

8949

8950

<h4>Parameters:</h4>

8951

8952

8953

8954

8955

8956

8957

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

8958

8959

8960

8961

8962

8963

8964

</div>

8965

8966

8967

</li>

8968

8969

8970

8971

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

8972

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

8973

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

8974

8975

8976

8977

8978

8979

<p>the prefix</p>

8980

</div>

8981

8982

8983

</li>

8984

8985

</ul>

8986

</div>

8987

8988

8989

8990

8991

<h4>Returns:</h4>

8992

8993

8994

8995

8996

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

8997

8998

an array containing:

8999

* the detach category, if supplied,

9000

* the prefixed event type,

9001

* whether or not this is an after listener,

9002

* the supplied event type

9003

9004

</div>

9005

</div>

9006

9007

9008

9009

</div>

9010

9011

9012

9013

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

9014

9015

9016

9017

9018

9019

9020

9021

9022

9023

</li>

9024

9025

9026

9027

9028

9029

</li>

9030

9031

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

9032

</div>

9033

9034

9035

9036

9037

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

9038

</span>

9039

9040

9041

9042

9043

9044

9045

9046

9047

9048

9049

9050

9051

9052

9053

9054

<p>Inherited from

9055

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

9056

9057

9058

9059

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

9060

9061

</p>

9062

9063

9064

9065

9066

9067

</div>

9068

9069

9070

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

9071

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

9072

case the custom event is returned.</p>

9073

</div>

9074

9075

9076

9077

<h4>Parameters:</h4>

9078

9079

9080

9081

9082

9083

9084

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

9085

9086

9087

9088

9089

9090

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

9091

</div>

9092

9093

9094

</li>

9095

9096

9097

9098

9099

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

9100

9101

9102

9103

9104

9105

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

9106

9107

<p><ul>

9108

<li>

9109

'broadcast': whether or not the YUI instance and YUI global are notified when the event is fired (false)

9110

</li>

9111

<li>

9112

'bubbles': whether or not this event bubbles (true)

9113

Events can only bubble if emitFacade is true.

9114

</li>

9115

<li>

9116

'context': the default execution context for the listeners (this)

9117

</li>

9118

<li>

9119

'defaultFn': the default function to execute when this event fires if preventDefault was not called

9120

</li>

9121

<li>

9122

'emitFacade': whether or not this event emits a facade (false)

9123

</li>

9124

<li>

9125

'prefix': the prefix for this targets events, e.g., 'menu' in 'menu:click'

9126

</li>

9127

<li>

9128

'fireOnce': if an event is configured to fire once, new subscribers after

9129

the fire will be notified immediately.

9130

</li>

9131

<li>

9132

'async': fireOnce event listeners will fire synchronously if the event has already

9133

fired unless async is true.

9134

</li>

9135

<li>

9136

'preventable': whether or not preventDefault() has an effect (true)

9137

</li>

9138

<li>

9139

'preventedFn': a function that is executed when preventDefault is called

9140

</li>

9141

<li>

9142

'queuable': whether or not this event can be queued during bubbling (false)

9143

</li>

9144

<li>

9145

'silent': if silent is true, debug messages are not provided for this event.

9146

</li>

9147

<li>

9148

'stoppedFn': a function that is executed when stopPropagation is called

9149

</li></p>

9150

9151

<p><li>

9152

'monitored': specifies whether or not this event should send notifications about

9153

when the event has been attached, detached, or published.

9154

</li>

9155

<li>

9156

'type': the event type (valid option if not provided as the first parameter to publish)

9157

</li>

9158

</ul></p>

9159

</div>

9160

9161

9162

</li>

9163

9164

</ul>

9165

</div>

9166

9167

9168

9169

9170

<h4>Returns:</h4>

9171

9172

9173

9174

9175

<span class="type"><a href="../classes/CustomEvent.html" class="crosslink">CustomEvent</a></span>:

9176

9177

the custom event

9178

9179

</div>

9180

</div>

9181

9182

9183

9184

</div>

9185

9186

9187

9188

<h3 class="name"><code>removeAttr</code></h3>

9189

9190

9191

9192

9193

9194

9195

9196

9197

9198

</li>

9199

9200

</ul><span class="paren">)</span>

9201

</div>

9202

9203

9204

9205

9206

9207

9208

9209

9210

9211

9212

9213

9214

9215

9216

9217

9218

9219

<p>Inherited from

9220

<a href="../classes/AttributeExtras.html#method_removeAttr">AttributeExtras</a>:

9221

9222

9223

9224

<a href="../files/attribute_js_AttributeExtras.js.html#l77"><code>attribute/js/AttributeExtras.js:77</code></a>

9225

9226

</p>

9227

9228

9229

9230

9231

9232

</div>

9233

9234

9235

<p>Removes an attribute from the host object</p>

9236

</div>

9237

9238

9239

9240

<h4>Parameters:</h4>

9241

9242

9243

9244

9245

9246

9247

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

9248

9249

9250

9251

9252

9253

<p>The name of the attribute to be removed.</p>

9254

</div>

9255

9256

9257

</li>

9258

9259

</ul>

9260

</div>

9261

9262

9263

9264

9265

9266

</div>

9267

9268

9269

9270

<h3 class="name"><code>removeTarget</code></h3>

9271

9272

9273

9274

9275

9276

9277

9278

9279

9280

</li>

9281

9282

</ul><span class="paren">)</span>

9283

</div>

9284

9285

9286

9287

9288

9289

9290

9291

9292

9293

9294

9295

9296

9297

9298

9299

9300

9301

<p>Inherited from

9302

<a href="../classes/EventTarget.html#method_removeTarget">EventTarget</a>:

9303

9304

9305

9306

<a href="../files/event-custom_js_event-facade.js.html#l409"><code>event-custom/js/event-facade.js:409</code></a>

9307

9308

</p>

9309

9310

9311

9312

9313

9314

</div>

9315

9316

9317

<p>Removes a bubble target</p>

9318

</div>

9319

9320

9321

9322

<h4>Parameters:</h4>

9323

9324

9325

9326

9327

9328

9329

<span class="type"><a href="../classes/EventTarget.html" class="crosslink">EventTarget</a></span>

9330

9331

9332

9333

9334

9335

<p>the target to remove</p>

9336

</div>

9337

9338

9339

</li>

9340

9341

</ul>

9342

</div>

9343

9344

9345

9346

9347

9348

</div>

9349

9350

9351

9352

<h3 class="name"><code>reset</code></h3>

9353

9354

9355

9356

9357

9358

9359

9360

9361

9362

</li>

9363

9364

</ul><span class="paren">)</span>

9365

</div>

9366

9367

9368

9369

9370

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>

9371

</span>

9372

9373

9374

9375

9376

9377

9378

9379

9380

9381

9382

9383

<span class="flag chainable">chainable</span>

9384

9385

9386

9387

9388

9389

<p>Inherited from

9390

<a href="../classes/AttributeExtras.html#method_reset">AttributeExtras</a>:

9391

9392

9393

9394

<a href="../files/attribute_js_AttributeExtras.js.html#l87"><code>attribute/js/AttributeExtras.js:87</code></a>

9395

9396

</p>

9397

9398

9399

9400

9401

9402

</div>

9403

9404

9405

<p>Resets the attribute (or all attributes) to its initial value, as long as

9406

the attribute is not readOnly, or writeOnce.</p>

9407

</div>

9408

9409

9410

9411

<h4>Parameters:</h4>

9412

9413

9414

9415

9416

9417

9418

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

9419

9420

9421

9422

9423

9424

<p>Optional. The name of the attribute to reset. If omitted, all attributes are reset.</p>

9425

</div>

9426

9427

9428

</li>

9429

9430

</ul>

9431

</div>

9432

9433

9434

9435

9436

<h4>Returns:</h4>

9437

9438

9439

9440

9441

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>:

9442

9443

A reference to the host object.

9444

9445

</div>

9446

</div>

9447

9448

9449

9450

</div>

9451

9452

9453

9454

<h3 class="name"><code>sendRequest</code></h3>

9455

9456

9457

9458

9459

9460

9461

9462

<code>request</code>

9463

9464

</li>

9465

9466

</ul><span class="paren">)</span>

9467

</div>

9468

9469

9470

9471

9472

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Number" class="crosslink external" target="_blank">Number</a></span>

9473

</span>

9474

9475

9476

9477

9478

9479

9480

9481

9482

9483

9484

9485

9486

9487

9488

9489

<p>Inherited from

9490

<a href="../classes/DataSource.Local.html#method_sendRequest">DataSource.Local</a>:

9491

9492

9493

9494

<a href="../files/datasource_js_datasource-local.js.html#l348"><code>datasource/js/datasource-local.js:348</code></a>

9495

9496

</p>

9497

9498

9499

9500

9501

9502

</div>

9503

9504

9505

<p>Generates a unique transaction ID and fires <code>request</code> event.

9506

<strong>Note</strong>: the property <code>callback</code> is a

9507

deprecated alias for the <code>on</code> transaction configuration

9508

property described below.</p>

9509

</div>

9510

9511

9512

9513

<h4>Parameters:</h4>

9514

9515

9516

9517

9518

9519

<code class="param-name">request</code>

9520

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>

9521

9522

9523

9524

9525

9526

<p>An object literal with the following properties:

9527

<dl>

9528

<dt><code>request</code></dt>

9529

<dd>The request to send to the live data source, if any.</dd>

9530

9531

<dd>An object literal with the following properties:

9532

<dl>

9533

<dt><code>success</code></dt>

9534

<dd>The function to call when the data is ready.</dd>

9535

<dt><code>failure</code></dt>

9536

<dd>The function to call upon a response failure condition.</dd>

9537

<dt><code>argument</code></dt>

9538

<dd>Arbitrary data payload that will be passed back to the success and failure handlers.</dd>

9539

</dl>

9540

</dd>

9541

9542

<dd>Configuration object, if any.</dd>

9543

</dl></p>

9544

</div>

9545

9546

9547

</li>

9548

9549

</ul>

9550

</div>

9551

9552

9553

9554

9555

<h4>Returns:</h4>

9556

9557

9558

9559

9560

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Number" class="crosslink external" target="_blank">Number</a></span>:

9561

9562

Transaction ID.

9563

9564

</div>

9565

</div>

9566

9567

9568

9569

</div>

9570

9571

9572

9573

9574

9575

9576

9577

9578

9579

9580

9581

9582

9583

</li>

9584

9585

9586

9587

<code>value</code>

9588

9589

</li>

9590

9591

</ul><span class="paren">)</span>

9592

</div>

9593

9594

9595

9596

9597

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>

9598

</span>

9599

9600

9601

9602

9603

9604

9605

9606

9607

9608

9609

9610

<span class="flag chainable">chainable</span>

9611

9612

9613

9614

9615

<p>Inherited from

9616

9617

AttributeEvents

9618

</a>

9619

9620

but overwritten in

9621

9622

9623

9624

<a href="../files/attribute_js_AttributeCore.js.html#l328"><code>attribute/js/AttributeCore.js:328</code></a>

9625

9626

</p>

9627

9628

9629

9630

9631

9632

</div>

9633

9634

9635

<p>Sets the value of an attribute.</p>

9636

</div>

9637

9638

9639

9640

<h4>Parameters:</h4>

9641

9642

9643

9644

9645

9646

9647

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

9648

9649

9650

9651

9652

9653

<p>The name of the attribute. If the

9654

current value of the attribute is an Object, dot notation can be used

9655

to set the value of a property within the object (e.g. <code>set("x.y.z", 5)</code>).</p>

9656

</div>

9657

9658

9659

</li>

9660

9661

9662

9663

<code class="param-name">value</code>

9664

9665

9666

9667

9668

9669

9670

<p>The value to set the attribute to.</p>

9671

</div>

9672

9673

9674

</li>

9675

9676

</ul>

9677

</div>

9678

9679

9680

9681

9682

<h4>Returns:</h4>

9683

9684

9685

9686

9687

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>:

9688

9689

A reference to the host object.

9690

9691

</div>

9692

</div>

9693

9694

9695

9696

</div>

9697

9698

9699

9700

<h3 class="name"><code>setAttrs</code></h3>

9701

9702

9703

9704

9705

9706

9707

9708

<code>attrs</code>

9709

9710

</li>

9711

9712

</ul><span class="paren">)</span>

9713

</div>

9714

9715

9716

9717

9718

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>

9719

</span>

9720

9721

9722

9723

9724

9725

9726

9727

9728

9729

9730

9731

<span class="flag chainable">chainable</span>

9732

9733

9734

9735

9736

<p>Inherited from

9737

9738

AttributeEvents

9739

</a>

9740

9741

but overwritten in

9742

9743

9744

9745

<a href="../files/attribute_js_AttributeCore.js.html#l635"><code>attribute/js/AttributeCore.js:635</code></a>

9746

9747

</p>

9748

9749

9750

9751

9752

9753

</div>

9754

9755

9756

<p>Sets multiple attribute values.</p>

9757

</div>

9758

9759

9760

9761

<h4>Parameters:</h4>

9762

9763

9764

9765

9766

9767

<code class="param-name">attrs</code>

9768

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>

9769

9770

9771

9772

9773

9774

<p>An object with attributes name/value pairs.</p>

9775

</div>

9776

9777

9778

</li>

9779

9780

</ul>

9781

</div>

9782

9783

9784

9785

9786

<h4>Returns:</h4>

9787

9788

9789

9790

9791

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>:

9792

9793

A reference to the host object.

9794

9795

</div>

9796

</div>

9797

9798

9799

9800

</div>

9801

9802

9803

9804

<h3 class="name"><code>subscribe</code></h3>

9805

9806

9807

9808

9809

9810

9811

9812

9813

<span class="flag deprecated" title="use on">deprecated</span>

9814

9815

9816

9817

9818

9819

9820

9821

9822

9823

9824

9825

9826

9827

<p>Inherited from

9828

<a href="../classes/EventTarget.html#method_subscribe">EventTarget</a>:

9829

9830

9831

9832

<a href="../files/event-custom_js_event-target.js.html#l335"><code>event-custom/js/event-target.js:335</code></a>

9833

9834

</p>

9835

9836

9837

9838

<p>Deprecated: use on</p>

9839

9840

9841

9842

</div>

9843

9844

9845

<p>subscribe to an event</p>

9846

</div>

9847

9848

9849

9850

9851

9852

9853

</div>

9854

9855

9856

9857

<h3 class="name"><code>toString</code></h3>

9858

9859

9860

9861

9862

9863

9864

9865

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

9866

</span>

9867

9868

9869

9870

9871

9872

9873

9874

9875

9876

9877

9878

9879

9880

9881

9882

<p>Inherited from

9883

<a href="../classes/BaseCore.html#method_toString">BaseCore</a>:

9884

9885

9886

9887

<a href="../files/base_js_BaseCore.js.html#l592"><code>base/js/BaseCore.js:592</code></a>

9888

9889

</p>

9890

9891

9892

9893

9894

9895

</div>

9896

9897

9898

<p>Default toString implementation. Provides the constructor NAME

9899

and the instance guid, if set.</p>

9900

</div>

9901

9902

9903

9904

9905

9906

<h4>Returns:</h4>

9907

9908

9909

9910

9911

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>:

9912

9913

String representation for this object

9914

9915

</div>

9916

</div>

9917

9918

9919

9920

</div>

9921

9922

9923

9924

<h3 class="name"><code>unsubscribe</code></h3>

9925

9926

9927

9928

9929

9930

9931

9932

9933

<span class="flag deprecated" title="use detach">deprecated</span>

9934

9935

9936

9937

9938

9939

9940

9941

9942

9943

9944

9945

9946

9947

<p>Inherited from

9948

<a href="../classes/EventTarget.html#method_unsubscribe">EventTarget</a>:

9949

9950

9951

9952

<a href="../files/event-custom_js_event-target.js.html#l455"><code>event-custom/js/event-target.js:455</code></a>

9953

9954

</p>

9955

9956

9957

9958

<p>Deprecated: use detach</p>

9959

9960

9961

9962

</div>

9963

9964

9965

<p>detach a listener</p>

9966

</div>

9967

9968

9969

9970

9971

9972

9973

</div>

9974

9975

9976

9977

<h3 class="name"><code>unsubscribeAll</code></h3>

9978

9979

9980

9981

9982

9983

9984

9985

9986

9987

</li>

9988

9989

</ul><span class="paren">)</span>

9990

</div>

9991

9992

9993

9994

9995

9996

<span class="flag deprecated" title="use detachAll">deprecated</span>

9997

9998

9999

10000

10001

10002

10003

10004

10005

10006

10007

10008

10009

10010

<p>Inherited from

10011

<a href="../classes/EventTarget.html#method_unsubscribeAll">EventTarget</a>:

10012

10013

10014

10015

<a href="../files/event-custom_js_event-target.js.html#l476"><code>event-custom/js/event-target.js:476</code></a>

10016

10017

</p>

10018

10019

10020

10021

<p>Deprecated: use detachAll</p>

10022

10023

10024

10025

</div>

10026

10027

10028

<p>Removes all listeners from the specified event. If the event type

10029

is not specified, all listeners from all hosted custom events will

10030

be removed.</p>

10031

</div>

10032

10033

10034

10035

<h4>Parameters:</h4>

10036

10037

10038

10039

10040

10041

10042

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

10043

10044

10045

10046

10047

10048

<p>The type, or name of the event</p>

10049

</div>

10050

10051

10052

</li>

10053

10054

</ul>

10055

</div>

10056

10057

10058

10059

10060

10061

</div>

10062

10063

10064

</div>

10065

10066

10067

10068

10069

<h2 class="off-left">Properties</h2>

10070

10071

10072

10073

<h3 class="name"><code>_allowAdHocAttrs</code></h3>

10074

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>

10075

10076

10077

10078

10079

<span class="flag protected">protected</span>

10080

10081

10082

10083

10084

10085

10086

10087

10088

10089

<p>Inherited from

10090

<a href="../classes/BaseCore.html#property__allowAdHocAttrs">BaseCore</a>:

10091

10092

10093

10094

<a href="../files/base_js_BaseCore.js.html#l100"><code>base/js/BaseCore.js:100</code></a>

10095

10096

</p>

10097

10098

10099

10100

10101

</div>

10102

10103

10104

<p>This property controls whether or not instances of this class should

10105

allow users to add ad-hoc attributes through the constructor configuration

10106

hash.</p>

10107

10108

<p>AdHoc attributes are attributes which are not defined by the class, and are

10109

not handled by the MyClass.<em>NON</em>ATTRS_CFG</p>

10110

</div>

10111

10112

10113

<p><strong>Default:</strong> undefined (false)</p>

10114

10115

10116

10117

10118

10119

</div>

10120

10121

10122

10123

10124

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

10125

10126

10127

10128

10129

<span class="flag protected">protected</span>

10130

10131

10132

10133

10134

10135

10136

10137

10138

10139

10140

<p>

10141

10142

Defined in

10143

10144

10145

10146

10147

<a href="../files/datasource_js_datasource-get.js.html#l47"><code>datasource/js/datasource-get.js:47</code></a>

10148

10149

</p>

10150

10151

10152

10153

10154

</div>

10155

10156

10157

<p>Stores the most recent request id for validation against stale

10158

response handling.</p>

10159

</div>

10160

10161

10162

10163

10164

10165

10166

</div>

10167

10168

10169

10170

10171

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

10172

10173

10174

10175

10176

10177

10178

<span class="flag final">final</span>

10179

10180

10181

10182

<span class="flag static">static</span>

10183

10184

10185

10186

10187

10188

10189

<p>

10190

10191

Defined in

10192

10193

10194

10195

10196

<a href="../files/datasource_js_datasource-get.js.html#l125"><code>datasource/js/datasource-get.js:125</code></a>

10197

10198

</p>

10199

10200

10201

10202

10203

</div>

10204

10205

10206

<p>Class name.</p>

10207

</div>

10208

10209

10210

10211

10212

10213

10214

</div>

10215

10216

10217

10218

10219

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

10220

10221

10222

<span class="flag deprecated" title="Use this.constructor.NAME">deprecated</span>

10223

10224

10225

10226

10227

10228

10229

10230

10231

10232

10233

10234

<p>Inherited from

10235

<a href="../classes/BaseCore.html#property_name">BaseCore</a>:

10236

10237

10238

10239

<a href="../files/base_js_BaseCore.js.html#l196"><code>base/js/BaseCore.js:196</code></a>

10240

10241

</p>

10242

10243

10244

<p>Deprecated: Use this.constructor.NAME</p>

10245

10246

10247

10248

</div>

10249

10250

10251

<p>The string used to identify the class of this object.</p>

10252

</div>

10253

10254

10255

10256

10257

10258

10259

</div>

10260

10261

10262

</div>

10263

10264

10265

10266

10267

<h2 class="off-left">Attributes</h2>

10268

10269

10270

10271

10272

<h3 class="name"><code>asyncMode</code></h3>

10273

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

10274

10275

10276

10277

10278

10279

10280

10281

10282

10283

10284

10285

10286

10287

<p>

10288

10289

Defined in

10290

10291

10292

10293

10294

<a href="../files/datasource_js_datasource-get.js.html#l155"><code>datasource/js/datasource-get.js:155</code></a>

10295

10296

</p>

10297

10298

10299

10300

10301

</div>

10302

10303

10304

<p>Defines request/response management in the following manner:</p>

10305

10306

<dl>

10307

<!--<dt>queueRequests</dt>

10308

<dd>If a request is already in progress, wait until response is

10309

returned before sending the next request.</dd>

10310

<dt>cancelStaleRequests</dt>

10311

<dd>If a request is already in progress, cancel it before

10312

sending the next request.</dd>-->

10313

<dt>ignoreStaleResponses</dt>

10314

<dd>Send all requests, but handle only the response for the most

10315

recently sent request.</dd>

10316

<dt>allowAll</dt>

10317

<dd>Send all requests and handle all responses.</dd>

10318

</dl>

10319

</div>

10320

10321

10322

<p><strong>Default:</strong> "allowAll"</p>

10323

10324

10325

10326

10327

<h4>Fires event <code>asyncModeChange</code></h4>

10328

10329

<p>

10330

Fires when the value for the configuration attribute <code>asyncMode</code> is

10331

changed. You can listen for the event using the <code>on</code> method if you

10332

wish to be notified before the attribute's value has changed, or

10333

using the <code>after</code> method if you wish to be notified after the

10334

attribute's value has changed.

10335

</p>

10336

10337

10338

<h4>Parameters:</h4>

10339

10340

10341

10342

10343

<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>

10344

10345

10346

An Event Facade object with the following

10347

attribute-specific properties added:

10348

</div>

10349

10350

10351

10352

<code class="param-name">prevVal</code>

10353

10354

<div class="param-description">The value of the attribute, prior to it being set.</div>

10355

</li>

10356

10357

<code class="param-name">newVal</code>

10358

10359

<div class="param-description">The value the attribute is to be set to.</div>

10360

</li>

10361

10362

<code class="param-name">attrName</code>

10363

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

10364

<div class="param-description">The name of the attribute being set.</div>

10365

</li>

10366

10367

<code class="param-name">subAttrName</code>

10368

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

10369

<div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div>

10370

</li>

10371

</ul>

10372

</li>

10373

</ul>

10374

</div>

10375

</div>

10376

10377

10378

10379

</div>

10380

10381

10382

10383

10384

<h3 class="name"><code>destroyed</code></h3>

10385

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>

10386

10387

10388

10389

10390

10391

10392

10393

10394

10395

10396

10397

10398

<p>Inherited from

10399

<a href="../classes/BaseCore.html#attr_destroyed">BaseCore</a>:

10400

10401

10402

10403

<a href="../files/base_js_BaseCore.js.html#l157"><code>base/js/BaseCore.js:157</code></a>

10404

10405

</p>

10406

10407

10408

10409

10410

</div>

10411

10412

10413

<p>Flag indicating whether or not this object

10414

has been through the destroy lifecycle phase.</p>

10415

</div>

10416

10417

10418

<p><strong>Default:</strong> false</p>

10419

10420

10421

10422

10423

<h4>Fires event <code>destroyedChange</code></h4>

10424

10425

<p>

10426

Fires when the value for the configuration attribute <code>destroyed</code> is

10427

changed. You can listen for the event using the <code>on</code> method if you

10428

wish to be notified before the attribute's value has changed, or

10429

using the <code>after</code> method if you wish to be notified after the

10430

attribute's value has changed.

10431

</p>

10432

10433

10434

<h4>Parameters:</h4>

10435

10436

10437

10438

10439

<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>

10440

10441

10442

An Event Facade object with the following

10443

attribute-specific properties added:

10444

</div>

10445

10446

10447

10448

<code class="param-name">prevVal</code>

10449

10450

<div class="param-description">The value of the attribute, prior to it being set.</div>

10451

</li>

10452

10453

<code class="param-name">newVal</code>

10454

10455

<div class="param-description">The value the attribute is to be set to.</div>

10456

</li>

10457

10458

<code class="param-name">attrName</code>

10459

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

10460

<div class="param-description">The name of the attribute being set.</div>

10461

</li>

10462

10463

<code class="param-name">subAttrName</code>

10464

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

10465

<div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div>

10466

</li>

10467

</ul>

10468

</li>

10469

</ul>

10470

</div>

10471

</div>

10472

10473

10474

10475

</div>

10476

10477

10478

10479

10480

<h3 class="name"><code>generateRequestCallback</code></h3>

10481

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function</a></span>

10482

10483

10484

10485

10486

10487

10488

10489

10490

10491

10492

10493

10494

10495

<p>

10496

10497

Defined in

10498

10499

10500

10501

10502

<a href="../files/datasource_js_datasource-get.js.html#l192"><code>datasource/js/datasource-get.js:192</code></a>

10503

10504

</p>

10505

10506

10507

10508

10509

</div>

10510

10511

10512

<p>Accepts the DataSource instance and a callback ID, and returns a callback

10513

param/value string that gets appended to the script URI. Implementers

10514

can customize this string to match their server's query syntax.</p>

10515

</div>

10516

10517

10518

10519

10520

10521

<h4>Fires event <code>generateRequestCallbackChange</code></h4>

10522

10523

<p>

10524

Fires when the value for the configuration attribute <code>generateRequestCallback</code> is

10525

changed. You can listen for the event using the <code>on</code> method if you

10526

wish to be notified before the attribute's value has changed, or

10527

using the <code>after</code> method if you wish to be notified after the

10528

attribute's value has changed.

10529

</p>

10530

10531

10532

<h4>Parameters:</h4>

10533

10534

10535

10536

10537

<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>

10538

10539

10540

An Event Facade object with the following

10541

attribute-specific properties added:

10542

</div>

10543

10544

10545

10546

<code class="param-name">prevVal</code>

10547

10548

<div class="param-description">The value of the attribute, prior to it being set.</div>

10549

</li>

10550

10551

<code class="param-name">newVal</code>

10552

10553

<div class="param-description">The value the attribute is to be set to.</div>

10554

</li>

10555

10556

<code class="param-name">attrName</code>

10557

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

10558

<div class="param-description">The name of the attribute being set.</div>

10559

</li>

10560

10561

<code class="param-name">subAttrName</code>

10562

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

10563

<div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div>

10564

</li>

10565

</ul>

10566

</li>

10567

</ul>

10568

</div>

10569

</div>

10570

10571

10572

10573

</div>

10574

10575

10576

10577

10578

10579

10580

10581

10582

10583

10584

10585

10586

10587

10588

10589

10590

10591

10592

10593

<p>

10594

10595

Defined in

10596

10597

10598

10599

10600

<a href="../files/datasource_js_datasource-get.js.html#l143"><code>datasource/js/datasource-get.js:143</code></a>

10601

10602

</p>

10603

10604

10605

10606

10607

</div>

10608

10609

10610

<p>Pointer to Get Utility.</p>

10611

</div>

10612

10613

10614

<p><strong>Default:</strong> Y.Get</p>

10615

10616

10617

10618

10619

<h4>Fires event <code>getChange</code></h4>

10620

10621

<p>

10622

Fires when the value for the configuration attribute <code>get</code> is

10623

changed. You can listen for the event using the <code>on</code> method if you

10624

wish to be notified before the attribute's value has changed, or

10625

using the <code>after</code> method if you wish to be notified after the

10626

attribute's value has changed.

10627

</p>

10628

10629

10630

<h4>Parameters:</h4>

10631

10632

10633

10634

10635

<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>

10636

10637

10638

An Event Facade object with the following

10639

attribute-specific properties added:

10640

</div>

10641

10642

10643

10644

<code class="param-name">prevVal</code>

10645

10646

<div class="param-description">The value of the attribute, prior to it being set.</div>

10647

</li>

10648

10649

<code class="param-name">newVal</code>

10650

10651

<div class="param-description">The value the attribute is to be set to.</div>

10652

</li>

10653

10654

<code class="param-name">attrName</code>

10655

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

10656

<div class="param-description">The name of the attribute being set.</div>

10657

</li>

10658

10659

<code class="param-name">subAttrName</code>

10660

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

10661

<div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div>

10662

</li>

10663

</ul>

10664

</li>

10665

</ul>

10666

</div>

10667

</div>

10668

10669

10670

10671

</div>

10672

10673

10674

10675

10676

<h3 class="name"><code>initialized</code></h3>

10677

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>

10678

10679

10680

10681

10682

10683

10684

10685

10686

10687

10688

10689

10690

<p>Inherited from

10691

<a href="../classes/BaseCore.html#attr_initialized">BaseCore</a>:

10692

10693

10694

10695

<a href="../files/base_js_BaseCore.js.html#l143"><code>base/js/BaseCore.js:143</code></a>

10696

10697

</p>

10698

10699

10700

10701

10702

</div>

10703

10704

10705

<p>Flag indicating whether or not this object

10706

has been through the init lifecycle phase.</p>

10707

</div>

10708

10709

10710

<p><strong>Default:</strong> false</p>

10711

10712

10713

10714

10715

<h4>Fires event <code>initializedChange</code></h4>

10716

10717

<p>

10718

Fires when the value for the configuration attribute <code>initialized</code> is

10719

changed. You can listen for the event using the <code>on</code> method if you

10720

wish to be notified before the attribute's value has changed, or

10721

using the <code>after</code> method if you wish to be notified after the

10722

attribute's value has changed.

10723

</p>

10724

10725

10726

<h4>Parameters:</h4>

10727

10728

10729

10730

10731

<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>

10732

10733

10734

An Event Facade object with the following

10735

attribute-specific properties added:

10736

</div>

10737

10738

10739

10740

<code class="param-name">prevVal</code>

10741

10742

<div class="param-description">The value of the attribute, prior to it being set.</div>

10743

</li>

10744

10745

<code class="param-name">newVal</code>

10746

10747

<div class="param-description">The value the attribute is to be set to.</div>

10748

</li>

10749

10750

<code class="param-name">attrName</code>

10751

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

10752

<div class="param-description">The name of the attribute being set.</div>

10753

</li>

10754

10755

<code class="param-name">subAttrName</code>

10756

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

10757

<div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div>

10758

</li>

10759

</ul>

10760

</li>

10761

</ul>

10762

</div>

10763

</div>

10764

10765

10766

10767

</div>

10768

10769

10770

10771

10772

<h3 class="name"><code>scriptCallbackParam</code></h3>

10773

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

10774

10775

10776

10777

10778

10779

10780

10781

10782

10783

10784

10785

10786

10787

<p>

10788

10789

Defined in

10790

10791

10792

10793

10794

<a href="../files/datasource_js_datasource-get.js.html#l179"><code>datasource/js/datasource-get.js:179</code></a>

10795

10796

</p>

10797

10798

10799

10800

10801

</div>

10802

10803

10804

<p>Callback string parameter name sent to the remote script. By default,

10805

requests are sent to

10806

<URI>?<scriptCallbackParam>=callbackFunction</p>

10807

</div>

10808

10809

10810

<p><strong>Default:</strong> "callback"</p>

10811

10812

10813

10814

10815

<h4>Fires event <code>scriptCallbackParamChange</code></h4>

10816

10817

<p>

10818

Fires when the value for the configuration attribute <code>scriptCallbackParam</code> is

10819

changed. You can listen for the event using the <code>on</code> method if you

10820

wish to be notified before the attribute's value has changed, or

10821

using the <code>after</code> method if you wish to be notified after the

10822

attribute's value has changed.

10823

</p>

10824

10825

10826

<h4>Parameters:</h4>

10827

10828

10829

10830

10831

<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>

10832

10833

10834

An Event Facade object with the following

10835

attribute-specific properties added:

10836

</div>

10837

10838

10839

10840

<code class="param-name">prevVal</code>

10841

10842

<div class="param-description">The value of the attribute, prior to it being set.</div>

10843

</li>

10844

10845

<code class="param-name">newVal</code>

10846

10847

<div class="param-description">The value the attribute is to be set to.</div>

10848

</li>

10849

10850

<code class="param-name">attrName</code>

10851

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

10852

<div class="param-description">The name of the attribute being set.</div>

10853

</li>

10854

10855

<code class="param-name">subAttrName</code>

10856

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

10857

<div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div>

10858

</li>

10859

</ul>

10860

</li>

10861

</ul>

10862

</div>

10863

</div>

10864

10865

10866

10867

</div>

10868

10869

10870

10871

10872

<h3 class="name"><code>source</code></h3>

10873

<span class="type">MIXED</span>

10874

10875

10876

10877

10878

10879

10880

10881

10882

10883

10884

10885

10886

<p>Inherited from

10887

<a href="../classes/DataSource.Local.html#attr_source">DataSource.Local</a>:

10888

10889

10890

10891

<a href="../files/datasource_js_datasource-local.js.html#l54"><code>datasource/js/datasource-local.js:54</code></a>

10892

10893

</p>

10894

10895

10896

10897

10898

</div>

10899

10900

10901

<p>Pointer to live data.</p>

10902

</div>

10903

10904

10905

<p><strong>Default:</strong> null</p>

10906

10907

10908

10909

10910

<h4>Fires event <code>sourceChange</code></h4>

10911

10912

<p>

10913

Fires when the value for the configuration attribute <code>source</code> is

10914

changed. You can listen for the event using the <code>on</code> method if you

10915

wish to be notified before the attribute's value has changed, or

10916

using the <code>after</code> method if you wish to be notified after the

10917

attribute's value has changed.

10918

</p>

10919

10920

10921

<h4>Parameters:</h4>

10922

10923

10924

10925

10926

<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>

10927

10928

10929

An Event Facade object with the following

10930

attribute-specific properties added:

10931

</div>

10932

10933

10934

10935

<code class="param-name">prevVal</code>

10936

10937

<div class="param-description">The value of the attribute, prior to it being set.</div>

10938

</li>

10939

10940

<code class="param-name">newVal</code>

10941

10942

<div class="param-description">The value the attribute is to be set to.</div>

10943

</li>

10944

10945

<code class="param-name">attrName</code>

10946

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

10947

<div class="param-description">The name of the attribute being set.</div>

10948

</li>

10949

10950

<code class="param-name">subAttrName</code>

10951

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

10952

<div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div>

10953

</li>

10954

</ul>

10955

</li>

10956

</ul>

10957

</div>

10958

</div>

10959

10960

10961

10962

</div>

10963

10964

10965

</div>

10966

10967

10968

10969

10970

<h2 class="off-left">Events</h2>

10971

10972

10973

10974

10975

10976

10977

10978

10979

10980

10981

10982

10983

10984

10985

10986

10987

10988

<p>Inherited from

10989

<a href="../classes/DataSource.Local.html#event_data">DataSource.Local</a>:

10990

10991

10992

10993

<a href="../files/datasource_js_datasource-local.js.html#l148"><code>datasource/js/datasource-local.js:148</code></a>

10994

10995

</p>

10996

10997

10998

10999

11000

</div>

11001

11002

11003

<p>Fired when raw data is received.</p>

11004

</div>

11005

11006

11007

11008

<h4>Event Payload:</h4>

11009

11010

11011

11012

11013

11014

11015

<span class="type"><a href="../classes/EventFacade.html" class="crosslink">Event.Facade</a></span>

11016

11017

11018

11019

11020

11021

<p>Event Facade with the following properties:</p>

11022

11023

<dl>

11024

<dt>tId (Number)</dt> <dd>Unique transaction ID.</dd>

11025

<dt>request (Object)</dt> <dd>The request.</dd>

11026

<dt>callback (Object)</dt> <dd>Deprecated alias for the

11027

<strong>on</strong> property</dd>

11028

<dt>on (Object)</dt> <dd>The map of configured transaction

11029

callbacks. An object with the following properties:

11030

<dl>

11031

<dt>success (Function)</dt> <dd>Success handler.</dd>

11032

<dt>failure (Function)</dt> <dd>Failure handler.</dd>

11033

</dl>

11034

</dd>

11035

<dt>cfg (Object)</dt> <dd>Configuration object.</dd>

11036

<dt>data (Object)</dt> <dd>Raw data.</dd>

11037

</dl>

11038

</div>

11039

11040

11041

</li>

11042

11043

</ul>

11044

</div>

11045

11046

11047

11048

11049

</div>

11050

11051

11052

11053

<h3 class="name"><code>destroy</code></h3>

11054

11055

11056

11057

11058

11059

11060

11061

11062

11063

11064

11065

11066

11067

<p>Inherited from

11068

<a href="../classes/Base.html#event_destroy">Base</a>:

11069

11070

11071

11072

11073

11074

</p>

11075

11076

11077

11078

11079

</div>

11080

11081

11082

<p>

11083

Lifecycle event for the destroy phase,

11084

fired prior to destruction. Invoking the preventDefault

11085

method on the event object provided to subscribers will

11086

prevent destruction from proceeding.

11087

</p>

11088

11089

<p>

11090

Subscribers to the "after" moment of this event, will be notified

11091

after destruction is complete (and as a result cannot prevent

11092

destruction).

11093

</p>

11094

</div>

11095

11096

11097

11098

<h4>Event Payload:</h4>

11099

11100

11101

11102

11103

11104

11105

<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>

11106

11107

11108

11109

11110

11111

<p>Event object</p>

11112

</div>

11113

11114

11115

</li>

11116

11117

</ul>

11118

</div>

11119

11120

11121

11122

11123

</div>

11124

11125

11126

11127

<h3 class="name"><code>error</code></h3>

11128

11129

11130

11131

11132

11133

11134

11135

11136

11137

11138

11139

11140

11141

<p>Inherited from

11142

<a href="../classes/DataSource.Local.html#event_error">DataSource.Local</a>:

11143

11144

11145

11146

<a href="../files/datasource_js_datasource-local.js.html#l206"><code>datasource/js/datasource-local.js:206</code></a>

11147

11148

</p>

11149

11150

11151

11152

11153

</div>

11154

11155

11156

<p>Fired when an error is encountered.</p>

11157

</div>

11158

11159

11160

11161

<h4>Event Payload:</h4>

11162

11163

11164

11165

11166

11167

11168

<span class="type"><a href="../classes/EventFacade.html" class="crosslink">Event.Facade</a></span>

11169

11170

11171

11172

11173

11174

<p>Event Facade with the following properties:</p>

11175

11176

<dl>

11177

<dt>tId (Number)</dt> <dd>Unique transaction ID.</dd>

11178

<dt>request (Object)</dt> <dd>The request.</dd>

11179

<dt>callback (Object)</dt> <dd>Deprecated alias for the

11180

<strong>on</strong> property</dd>

11181

<dt>on (Object)</dt> <dd>The map of configured transaction

11182

callbacks. An object with the following properties:

11183

<dl>

11184

<dt>success (Function)</dt> <dd>Success handler.</dd>

11185

<dt>failure (Function)</dt> <dd>Failure handler.</dd>

11186

</dl>

11187

</dd>

11188

<dt>cfg (Object)</dt> <dd>Configuration object.</dd>

11189

<dt>data (Object)</dt> <dd>Raw data.</dd>

11190

<dt>response (Object)</dt>

11191

<dd>Normalized response object with the following properties:

11192

<dl>

11193

<dt>results (Object)</dt> <dd>Parsed results.</dd>

11194

<dt>meta (Object)</dt> <dd>Parsed meta data.</dd>

11195

<dt>error (Object)</dt> <dd>Error object.</dd>

11196

</dl>

11197

</dd>

11198

<dt>error</dt>

11199

<dd>Any error that occurred along the transaction lifecycle.</dd>

11200

</dl>

11201

</div>

11202

11203

11204

</li>

11205

11206

</ul>

11207

</div>

11208

11209

11210

11211

11212

</div>

11213

11214

11215

11216

11217

11218

11219

11220

11221

11222

11223

11224

11225

11226

11227

11228

11229

11230

<p>Inherited from

11231

<a href="../classes/Base.html#event_init">Base</a>:

11232

11233

11234

11235

11236

11237

</p>

11238

11239

11240

11241

11242

</div>

11243

11244

11245

<p>

11246

Lifecycle event for the init phase, fired prior to initialization.

11247

Invoking the preventDefault() method on the event object provided

11248

to subscribers will prevent initialization from occuring.

11249

</p>

11250

11251

<p>

11252

Subscribers to the "after" momemt of this event, will be notified

11253

after initialization of the object is complete (and therefore

11254

cannot prevent initialization).

11255

</p>

11256

</div>

11257

11258

11259

11260

<h4>Event Payload:</h4>

11261

11262

11263

11264

11265

11266

11267

<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>

11268

11269

11270

11271

11272

11273

<p>Event object, with a cfg property which

11274

refers to the configuration object passed to the constructor.</p>

11275

</div>

11276

11277

11278

</li>

11279

11280

</ul>

11281

</div>

11282

11283

11284

11285

11286

</div>

11287

11288

11289

11290

<h3 class="name"><code>request</code></h3>

11291

11292

11293

11294

11295

11296

11297

11298

11299

11300

11301

11302

11303

11304

<p>Inherited from

11305

<a href="../classes/DataSource.Local.html#event_request">DataSource.Local</a>:

11306

11307

11308

11309

<a href="../files/datasource_js_datasource-local.js.html#l130"><code>datasource/js/datasource-local.js:130</code></a>

11310

11311

</p>

11312

11313

11314

11315

11316

</div>

11317

11318

11319

<p>Fired when a data request is received.</p>

11320

</div>

11321

11322

11323

11324

<h4>Event Payload:</h4>

11325

11326

11327

11328

11329

11330

11331

<span class="type"><a href="../classes/EventFacade.html" class="crosslink">Event.Facade</a></span>

11332

11333

11334

11335

11336

11337

<p>Event Facade with the following properties:</p>

11338

11339

<dl>

11340

<dt>tId (Number)</dt> <dd>Unique transaction ID.</dd>

11341

<dt>request (Object)</dt> <dd>The request.</dd>

11342

<dt>callback (Object)</dt> <dd>The callback object

11343

(deprecated, refer to <strong>on</strong></dd>

11344

<dt>on (Object)</dt> <dd>The map of configured callback

11345

functions.</dd>

11346

<dt>cfg (Object)</dt> <dd>Configuration object.</dd>

11347

</dl>

11348

</div>

11349

11350

11351

</li>

11352

11353

</ul>

11354

</div>

11355

11356

11357

11358

11359

</div>

11360

11361

11362

11363

<h3 class="name"><code>response</code></h3>

11364

11365

11366

11367

11368

11369

11370

11371

11372

11373

11374

11375

11376

11377

<p>Inherited from

11378

<a href="../classes/DataSource.Local.html#event_response">DataSource.Local</a>:

11379

11380

11381

11382

<a href="../files/datasource_js_datasource-local.js.html#l172"><code>datasource/js/datasource-local.js:172</code></a>

11383

11384

</p>

11385

11386

11387

11388

11389

</div>

11390

11391

11392

<p>Fired when response is returned.</p>

11393

</div>

11394

11395

11396

11397

<h4>Event Payload:</h4>

11398

11399

11400

11401

11402

11403

11404

<span class="type"><a href="../classes/EventFacade.html" class="crosslink">Event.Facade</a></span>

11405

11406

11407

11408

11409

11410

<p>Event Facade with the following properties:</p>

11411

11412

<dl>

11413

<dt>tId (Number)</dt> <dd>Unique transaction ID.</dd>

11414

<dt>request (Object)</dt> <dd>The request.</dd>

11415

<dt>callback (Object)</dt> <dd>Deprecated alias for the

11416

<strong>on</strong> property</dd>

11417

<dt>on (Object)</dt> <dd>The map of configured transaction

11418

callbacks. An object with the following properties:

11419

<dl>

11420

<dt>success (Function)</dt> <dd>Success handler.</dd>

11421

<dt>failure (Function)</dt> <dd>Failure handler.</dd>

11422

</dl>

11423

</dd>

11424

<dt>cfg (Object)</dt> <dd>Configuration object.</dd>

11425

<dt>data (Object)</dt> <dd>Raw data.</dd>

11426

<dt>response (Object)</dt>

11427

<dd>Normalized response object with the following properties:

11428

<dl>

11429

<dt>results (Object)</dt> <dd>Parsed results.</dd>

11430

<dt>meta (Object)</dt> <dd>Parsed meta data.</dd>

11431

<dt>error (Boolean)</dt> <dd>Error flag.</dd>

11432

</dl>

11433

</dd>

11434

<dt>error</dt>

11435

<dd>Any error that occurred along the transaction lifecycle.</dd>

11436

</dl>

11437

</div>

11438

11439

11440

</li>

11441

11442

</ul>

11443

</div>

11444

11445

11446

11447

11448

</div>

11449

11450

11451

</div>

11452

11453

</div>

11454

</div>

11455

11456

</div>

11457

</div>

11458

</div>

11459

</div>

11460

</div>

11461

</div>

11462

11463

11464

11465

11466

11467

11468

11469

11470

</body>

11471

</html>

Older »