~smagoun/whoopsie/whoopsie-lp1017637

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

2130

2131

2132

2133

2134

2135

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

2136

</div>

2137

2138

2139

</li>

2140

2141

2142

2143

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

2144

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

2145

2146

2147

2148

2149

2150

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

2151

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

2152

</div>

2153

2154

2155

</li>

2156

2157

2158

2159

2160

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

2161

2162

2163

2164

2165

2166

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

2167

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

2168

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

2169

</div>

2170

2171

2172

</li>

2173

2174

</ul>

2175

</div>

2176

2177

2178

2179

2180

2181

</div>

2182

2183

2184

2185

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

2186

2187

2188

2189

2190

2191

2192

2193

2194

2195

</li>

2196

2197

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

2198

</div>

2199

2200

2201

2202

2203

2204

2205

2206

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

2207

2208

2209

2210

2211

2212

2213

2214

2215

2216

2217

2218

<p>Inherited from

2219

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

2220

2221

2222

2223

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

2224

2225

</p>

2226

2227

2228

2229

2230

2231

</div>

2232

2233

2234

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

2235

</div>

2236

2237

2238

2239

<h4>Parameters:</h4>

2240

2241

2242

2243

2244

2245

2246

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

2247

2248

2249

2250

2251

2252

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

2253

</div>

2254

2255

2256

</li>

2257

2258

</ul>

2259

</div>

2260

2261

2262

2263

2264

2265

</div>

2266

2267

2268

2269

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

2270

2271

2272

2273

2274

2275

2276

2277

<code>allAttrs</code>

2278

2279

</li>

2280

2281

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

2282

</div>

2283

2284

2285

2286

2287

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

2288

</span>

2289

2290

2291

2292

2293

2294

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

2295

2296

2297

2298

2299

2300

2301

2302

2303

2304

2305

2306

<p>Inherited from

2307

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

2308

2309

2310

2311

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

2312

2313

</p>

2314

2315

2316

2317

2318

2319

</div>

2320

2321

2322

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

2323

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

2324

2325

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

2326

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

2327

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

2328

</div>

2329

2330

2331

2332

<h4>Parameters:</h4>

2333

2334

2335

2336

2337

2338

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

2339

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

2340

2341

2342

2343

2344

2345

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

2346

(subclass first, Base last)</p>

2347

</div>

2348

2349

2350

</li>

2351

2352

</ul>

2353

</div>

2354

2355

2356

2357

2358

<h4>Returns:</h4>

2359

2360

2361

2362

2363

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

2364

2365

The aggregate set of ATTRS definitions for the instance

2366

2367

</div>

2368

</div>

2369

2370

2371

2372

</div>

2373

2374

2375

2376

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

2377

2378

2379

2380

2381

2382

2383

2384

2385

2386

2387

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

2388

2389

2390

2391

2392

2393

2394

2395

2396

2397

2398

<p>Inherited from

2399

2400

BaseCore

2401

</a>

2402

2403

but overwritten in

2404

2405

2406

2407

2408

2409

</p>

2410

2411

2412

2413

2414

2415

</div>

2416

2417

2418

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

2419

this class.</p>

2420

</div>

2421

2422

2423

2424

2425

2426

2427

</div>

2428

2429

2430

2431

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

2432

2433

2434

2435

2436

2437

2438

2439

2440

2441

2442

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

2443

2444

2445

2446

2447

2448

2449

2450

2451

2452

2453

2454

<p>Inherited from

2455

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

2456

2457

2458

2459

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

2460

2461

</p>

2462

2463

2464

2465

2466

2467

</div>

2468

2469

2470

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

2471

</div>

2472

2473

2474

2475

2476

2477

2478

</div>

2479

2480

2481

2482

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

2483

2484

2485

2486

2487

2488

2489

2490

2491

2492

2493

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

2494

2495

2496

2497

2498

2499

2500

2501

2502

2503

2504

2505

<p>Inherited from

2506

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

2507

2508

2509

2510

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

2511

2512

</p>

2513

2514

2515

2516

2517

2518

</div>

2519

2520

2521

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

2522

</div>

2523

2524

2525

2526

2527

2528

2529

</div>

2530

2531

2532

2533

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

2534

2535

2536

2537

2538

2539

2540

2541

2542

2543

</li>

2544

2545

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

2546

</div>

2547

2548

2549

2550

2551

2552

2553

2554

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

2555

2556

2557

2558

2559

2560

2561

2562

2563

2564

2565

2566

<p>Inherited from

2567

<a href="../classes/Cache.html#method__defAddFn">Cache</a>:

2568

2569

2570

2571

<a href="../files/cache_js_cache-base.js.html#l242"><code>cache/js/cache-base.js:242</code></a>

2572

2573

</p>

2574

2575

2576

2577

2578

2579

</div>

2580

2581

2582

<p>Adds entry to cache.</p>

2583

</div>

2584

2585

2586

2587

<h4>Parameters:</h4>

2588

2589

2590

2591

2592

2593

2594

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

2595

2596

2597

2598

2599

2600

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

2601

2602

<dl>

2603

<dt>entry (Object)</dt> <dd>The cached entry.</dd>

2604

</dl>

2605

</div>

2606

2607

2608

</li>

2609

2610

</ul>

2611

</div>

2612

2613

2614

2615

2616

2617

</div>

2618

2619

2620

2621

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

2622

2623

2624

2625

2626

2627

2628

2629

2630

2631

</li>

2632

2633

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

2634

</div>

2635

2636

2637

2638

2639

2640

2641

2642

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

2643

2644

2645

2646

2647

2648

2649

2650

2651

2652

2653

2654

<p>Inherited from

2655

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

2656

2657

2658

2659

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

2660

2661

</p>

2662

2663

2664

2665

2666

2667

</div>

2668

2669

2670

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

2671

</div>

2672

2673

2674

2675

<h4>Parameters:</h4>

2676

2677

2678

2679

2680

2681

2682

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

2683

2684

2685

2686

2687

2688

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

2689

</div>

2690

2691

2692

</li>

2693

2694

</ul>

2695

</div>

2696

2697

2698

2699

2700

2701

</div>

2702

2703

2704

2705

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

2706

2707

2708

2709

2710

2711

2712

2713

2714

2715

</li>

2716

2717

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

2718

</div>

2719

2720

2721

2722

2723

2724

2725

2726

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

2727

2728

2729

2730

2731

2732

2733

2734

2735

2736

2737

2738

<p>Inherited from

2739

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

2740

2741

2742

2743

2744

2745

</p>

2746

2747

2748

2749

2750

2751

</div>

2752

2753

2754

<p>Default destroy event handler</p>

2755

</div>

2756

2757

2758

2759

<h4>Parameters:</h4>

2760

2761

2762

2763

2764

2765

2766

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

2767

2768

2769

2770

2771

2772

<p>Event object</p>

2773

</div>

2774

2775

2776

</li>

2777

2778

</ul>

2779

</div>

2780

2781

2782

2783

2784

2785

</div>

2786

2787

2788

2789

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

2790

2791

2792

2793

2794

2795

2796

2797

2798

2799

</li>

2800

2801

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

2802

</div>

2803

2804

2805

2806

2807

2808

2809

2810

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

2811

2812

2813

2814

2815

2816

2817

2818

2819

2820

2821

2822

<p>Inherited from

2823

<a href="../classes/Cache.html#method__defFlushFn">Cache</a>:

2824

2825

2826

2827

<a href="../files/cache_js_cache-base.js.html#l277"><code>cache/js/cache-base.js:277</code></a>

2828

2829

</p>

2830

2831

2832

2833

2834

2835

</div>

2836

2837

2838

<p>Flushes cache.</p>

2839

</div>

2840

2841

2842

2843

<h4>Parameters:</h4>

2844

2845

2846

2847

2848

2849

2850

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

2851

2852

2853

2854

2855

2856

<p>Event Facade object.</p>

2857

</div>

2858

2859

2860

</li>

2861

2862

</ul>

2863

</div>

2864

2865

2866

2867

2868

2869

</div>

2870

2871

2872

2873

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

2874

2875

2876

2877

2878

2879

2880

2881

2882

2883

</li>

2884

2885

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

2886

</div>

2887

2888

2889

2890

2891

2892

2893

2894

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

2895

2896

2897

2898

2899

2900

2901

2902

2903

2904

2905

2906

<p>Inherited from

2907

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

2908

2909

2910

2911

2912

2913

</p>

2914

2915

2916

2917

2918

2919

</div>

2920

2921

2922

<p>Default init event handler</p>

2923

</div>

2924

2925

2926

2927

<h4>Parameters:</h4>

2928

2929

2930

2931

2932

2933

2934

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

2935

2936

2937

2938

2939

2940

<p>Event object, with a cfg property which

2941

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

2942

</div>

2943

2944

2945

</li>

2946

2947

</ul>

2948

</div>

2949

2950

2951

2952

2953

2954

</div>

2955

2956

2957

2958

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

2959

2960

2961

2962

2963

2964

2965

2966

2967

2968

2969

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

2970

2971

2972

2973

2974

2975

2976

2977

2978

2979

2980

2981

<p>Inherited from

2982

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

2983

2984

2985

2986

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

2987

2988

</p>

2989

2990

2991

2992

2993

2994

</div>

2995

2996

2997

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

2998

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

2999

</div>

3000

3001

3002

3003

3004

3005

3006

</div>

3007

3008

3009

3010

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

3011

3012

3013

3014

3015

3016

3017

3018

<code>allAttrs</code>

3019

3020

</li>

3021

3022

3023

3024

<code>userVals</code>

3025

3026

</li>

3027

3028

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

3029

</div>

3030

3031

3032

3033

3034

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

3035

</span>

3036

3037

3038

3039

3040

3041

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

3042

3043

3044

3045

3046

3047

3048

3049

3050

3051

3052

3053

<p>Inherited from

3054

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

3055

3056

3057

3058

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

3059

3060

</p>

3061

3062

3063

3064

3065

3066

</div>

3067

3068

3069

3070

</div>

3071

3072

3073

3074

<h4>Parameters:</h4>

3075

3076

3077

3078

3079

3080

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

3081

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

3082

3083

3084

3085

3086

3087

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

3088

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

3089

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

3090

</div>

3091

3092

3093

</li>

3094

3095

3096

3097

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

3098

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

3099

3100

3101

3102

3103

3104

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

3105

</div>

3106

3107

3108

</li>

3109

3110

</ul>

3111

</div>

3112

3113

3114

3115

3116

<h4>Returns:</h4>

3117

3118

3119

3120

3121

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

3122

3123

The set of adhoc attributes passed in, in the form

3124

of an object with attribute name/configuration pairs.

3125

3126

</div>

3127

</div>

3128

3129

3130

3131

</div>

3132

3133

3134

3135

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

3136

3137

3138

3139

3140

3141

3142

3143

<code>clazz</code>

3144

3145

</li>

3146

3147

3148

3149

<code>allCfgs</code>

3150

3151

</li>

3152

3153

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

3154

</div>

3155

3156

3157

3158

3159

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

3160

</span>

3161

3162

3163

3164

3165

3166

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

3167

3168

3169

3170

3171

3172

3173

3174

3175

3176

3177

3178

<p>Inherited from

3179

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

3180

3181

3182

3183

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

3184

3185

</p>

3186

3187

3188

3189

3190

3191

</div>

3192

3193

3194

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

3195

initialization. Returns a disposable object with the attributes defined for

3196

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

3197

</div>

3198

3199

3200

3201

<h4>Parameters:</h4>

3202

3203

3204

3205

3206

3207

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

3208

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

3209

3210

3211

3212

3213

3214

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

3215

</div>

3216

3217

3218

</li>

3219

3220

3221

3222

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

3223

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

3224

3225

3226

3227

3228

3229

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

3230

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

3231

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

3232

</div>

3233

3234

3235

</li>

3236

3237

</ul>

3238

</div>

3239

3240

3241

3242

3243

<h4>Returns:</h4>

3244

3245

3246

3247

3248

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

3249

3250

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

3251

of an object with attribute name/configuration pairs.

3252

3253

</div>

3254

</div>

3255

3256

3257

3258

</div>

3259

3260

3261

3262

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

3263

3264

3265

3266

3267

3268

3269

3270

<code>attrName</code>

3271

3272

</li>

3273

3274

3275

3276

<code>subAttrName</code>

3277

3278

</li>

3279

3280

3281

3282

<code>currVal</code>

3283

3284

</li>

3285

3286

3287

3288

<code>newVal</code>

3289

3290

</li>

3291

3292

3293

3294

3295

3296

</li>

3297

3298

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

3299

</div>

3300

3301

3302

3303

3304

3305

3306

3307

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

3308

3309

3310

3311

3312

3313

3314

3315

3316

3317

3318

3319

<p>Inherited from

3320

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

3321

3322

3323

3324

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

3325

3326

</p>

3327

3328

3329

3330

3331

3332

</div>

3333

3334

3335

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

3336

</div>

3337

3338

3339

3340

<h4>Parameters:</h4>

3341

3342

3343

3344

3345

3346

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

3347

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

3348

3349

3350

3351

3352

3353

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

3354

</div>

3355

3356

3357

</li>

3358

3359

3360

3361

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

3362

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

3363

3364

3365

3366

3367

3368

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

3369

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

3370

</div>

3371

3372

3373

</li>

3374

3375

3376

3377

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

3378

3379

3380

3381

3382

3383

3384

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

3385

</div>

3386

3387

3388

</li>

3389

3390

3391

3392

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

3393

3394

3395

3396

3397

3398

3399

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

3400

</div>

3401

3402

3403

</li>

3404

3405

3406

3407

3408

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

3409

3410

3411

3412

3413

3414

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

3415

</div>

3416

3417

3418

</li>

3419

3420

</ul>

3421

</div>

3422

3423

3424

3425

3426

3427

</div>

3428

3429

3430

3431

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

3432

3433

3434

3435

3436

3437

3438

3439

3440

3441

</li>

3442

3443

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

3444

</div>

3445

3446

3447

3448

3449

3450

</span>

3451

3452

3453

3454

3455

3456

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

3457

3458

3459

3460

3461

3462

3463

3464

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

3465

3466

3467

3468

3469

3470

<p>Inherited from

3471

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

3472

3473

3474

3475

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

3476

3477

</p>

3478

3479

3480

3481

3482

3483

</div>

3484

3485

3486

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

3487

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

3488

3489

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

3490

</div>

3491

3492

3493

3494

<h4>Parameters:</h4>

3495

3496

3497

3498

3499

3500

3501

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

3502

3503

3504

3505

3506

3507

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

3508

</div>

3509

3510

3511

</li>

3512

3513

</ul>

3514

</div>

3515

3516

3517

3518

3519

<h4>Returns:</h4>

3520

3521

3522

3523

3524

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

3525

3526

The value of the attribute.

3527

3528

</div>

3529

</div>

3530

3531

3532

3533

</div>

3534

3535

3536

3537

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

3538

3539

3540

3541

3542

3543

3544

3545

3546

3547

</li>

3548

3549

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

3550

</div>

3551

3552

3553

3554

3555

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

3556

</span>

3557

3558

3559

3560

3561

3562

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

3563

3564

3565

3566

3567

3568

3569

3570

3571

3572

3573

3574

<p>Inherited from

3575

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

3576

3577

3578

3579

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

3580

3581

</p>

3582

3583

3584

3585

3586

3587

</div>

3588

3589

3590

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

3591

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

3592

configuration properties for all attributes.</p>

3593

</div>

3594

3595

3596

3597

<h4>Parameters:</h4>

3598

3599

3600

3601

3602

3603

3604

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

3605

3606

3607

3608

3609

3610

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

3611

</div>

3612

3613

3614

</li>

3615

3616

</ul>

3617

</div>

3618

3619

3620

3621

3622

<h4>Returns:</h4>

3623

3624

3625

3626

3627

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

3628

3629

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

3630

3631

</div>

3632

</div>

3633

3634

3635

3636

</div>

3637

3638

3639

3640

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

3641

3642

3643

3644

3645

3646

3647

3648

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

3649

</span>

3650

3651

3652

3653

3654

3655

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

3656

3657

3658

3659

3660

3661

3662

3663

3664

3665

3666

3667

<p>Inherited from

3668

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

3669

3670

3671

3672

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

3673

3674

</p>

3675

3676

3677

3678

3679

3680

</div>

3681

3682

3683

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

3684

the class hierarchy.</p>

3685

</div>

3686

3687

3688

3689

3690

3691

<h4>Returns:</h4>

3692

3693

3694

3695

3696

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

3697

3698

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

3699

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

3700

the cached value.

3701

3702

</div>

3703

</div>

3704

3705

3706

3707

</div>

3708

3709

3710

3711

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

3712

3713

3714

3715

3716

3717

3718

3719

3720

3721

</li>

3722

3723

3724

3725

3726

3727

</li>

3728

3729

3730

3731

<code>initValues</code>

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 private">private</span>

3749

3750

3751

3752

3753

3754

3755

3756

3757

3758

3759

<p>Inherited from

3760

3761

AttributeCore

3762

</a>

3763

3764

but overwritten in

3765

3766

3767

3768

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

3769

3770

</p>

3771

3772

3773

3774

3775

3776

</div>

3777

3778

3779

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

3780

either the default configuration provided, or the

3781

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

3782

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

3783

</div>

3784

3785

3786

3787

<h4>Parameters:</h4>

3788

3789

3790

3791

3792

3793

3794

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

3795

3796

3797

3798

3799

3800

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

3801

</div>

3802

3803

3804

</li>

3805

3806

3807

3808

3809

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

3810

3811

3812

3813

3814

3815

<p>The attribute configuration object</p>

3816

</div>

3817

3818

3819

</li>

3820

3821

3822

3823

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

3824

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

3825

3826

3827

3828

3829

3830

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

3831

</div>

3832

3833

3834

</li>

3835

3836

</ul>

3837

</div>

3838

3839

3840

3841

3842

<h4>Returns:</h4>

3843

3844

3845

3846

3847

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

3848

3849

The initial value of the attribute.

3850

3851

</div>

3852

</div>

3853

3854

3855

3856

</div>

3857

3858

3859

3860

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

3861

3862

3863

3864

3865

3866

3867

3868

<code>attrs</code>

3869

3870

</li>

3871

3872

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

3873

</div>

3874

3875

3876

3877

3878

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

3879

</span>

3880

3881

3882

3883

3884

3885

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

3886

3887

3888

3889

3890

3891

3892

3893

3894

3895

3896

3897

<p>Inherited from

3898

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

3899

3900

3901

3902

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

3903

3904

</p>

3905

3906

3907

3908

3909

3910

</div>

3911

3912

3913

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

3914

</div>

3915

3916

3917

3918

<h4>Parameters:</h4>

3919

3920

3921

3922

3923

3924

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

3925

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

3926

3927

3928

3929

3930

3931

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

3932

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

3933

</div>

3934

3935

3936

</li>

3937

3938

</ul>

3939

</div>

3940

3941

3942

3943

3944

<h4>Returns:</h4>

3945

3946

3947

3948

3949

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

3950

3951

An object with attribute name/value pairs.

3952

3953

</div>

3954

</div>

3955

3956

3957

3958

</div>

3959

3960

3961

3962

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

3963

3964

3965

3966

3967

3968

3969

3970

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

3971

</span>

3972

3973

3974

3975

3976

3977

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

3978

3979

3980

3981

3982

3983

3984

3985

3986

3987

3988

3989

<p>Inherited from

3990

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

3991

3992

3993

3994

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

3995

3996

</p>

3997

3998

3999

4000

4001

4002

</div>

4003

4004

4005

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

4006

</div>

4007

4008

4009

4010

4011

4012

<h4>Returns:</h4>

4013

4014

4015

4016

4017

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

4018

4019

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

4020

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

4021

cached value.

4022

4023

</div>

4024

</div>

4025

4026

4027

4028

</div>

4029

4030

4031

4032

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

4033

4034

4035

4036

4037

4038

4039

4040

4041

4042

4043

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

4044

4045

4046

4047

4048

4049

4050

4051

4052

4053

4054

4055

<p>Inherited from

4056

<a href="../classes/Cache.html#method__getEntries">Cache</a>:

4057

4058

4059

4060

<a href="../files/cache_js_cache-base.js.html#l231"><code>cache/js/cache-base.js:231</code></a>

4061

4062

</p>

4063

4064

4065

4066

4067

4068

</div>

4069

4070

4071

<p>Gets all entries.</p>

4072

</div>

4073

4074

4075

4076

4077

4078

4079

</div>

4080

4081

4082

4083

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

4084

4085

4086

4087

4088

4089

4090

4091

4092

4093

4094

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

4095

4096

4097

4098

4099

4100

4101

4102

4103

4104

4105

4106

<p>Inherited from

4107

<a href="../classes/Cache.html#method__getSize">Cache</a>:

4108

4109

4110

4111

<a href="../files/cache_js_cache-base.js.html#l221"><code>cache/js/cache-base.js:221</code></a>

4112

4113

</p>

4114

4115

4116

4117

4118

4119

</div>

4120

4121

4122

4123

</div>

4124

4125

4126

4127

4128

4129

4130

</div>

4131

4132

4133

4134

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

4135

4136

4137

4138

4139

4140

4141

4142

4143

4144

</li>

4145

4146

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

4147

</div>

4148

4149

4150

4151

4152

4153

</span>

4154

4155

4156

4157

4158

4159

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

4160

4161

4162

4163

4164

4165

4166

4167

4168

4169

4170

4171

<p>Inherited from

4172

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

4173

4174

4175

4176

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

4177

4178

</p>

4179

4180

4181

4182

4183

4184

</div>

4185

4186

4187

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

4188

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

4189

</div>

4190

4191

4192

4193

<h4>Parameters:</h4>

4194

4195

4196

4197

4198

4199

4200

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

4201

4202

4203

4204

4205

4206

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

4207

</div>

4208

4209

4210

</li>

4211

4212

</ul>

4213

</div>

4214

4215

4216

4217

4218

<h4>Returns:</h4>

4219

4220

4221

4222

4223

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

4224

4225

The stored value of the attribute

4226

4227

</div>

4228

</div>

4229

4230

4231

4232

</div>

4233

4234

4235

4236

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

4237

4238

4239

4240

4241

4242

4243

4244

4245

4246

4247

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

4248

4249

4250

4251

4252

4253

4254

4255

4256

4257

4258

4259

<p>Inherited from

4260

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

4261

4262

4263

4264

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

4265

4266

</p>

4267

4268

4269

4270

4271

4272

</div>

4273

4274

4275

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

4276

event type is not prefixed, the instance prefix is

4277

applied to the supplied type.</p>

4278

</div>

4279

4280

4281

4282

4283

4284

4285

</div>

4286

4287

4288

4289

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

4290

4291

4292

4293

4294

4295

4296

4297

<code>attrs</code>

4298

4299

</li>

4300

4301

4302

4303

<code>values</code>

4304

4305

</li>

4306

4307

4308

4309

4310

4311

</li>

4312

4313

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

4314

</div>

4315

4316

4317

4318

4319

4320

4321

4322

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

4323

4324

4325

4326

4327

4328

4329

4330

4331

4332

4333

4334

<p>Inherited from

4335

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

4336

4337

4338

4339

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

4340

4341

</p>

4342

4343

4344

4345

4346

4347

</div>

4348

4349

4350

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

4351

constructor.</p>

4352

</div>

4353

4354

4355

4356

<h4>Parameters:</h4>

4357

4358

4359

4360

4361

4362

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

4363

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

4364

4365

4366

4367

4368

4369

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

4370

</div>

4371

4372

4373

</li>

4374

4375

4376

4377

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

4378

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

4379

4380

4381

4382

4383

4384

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

4385

</div>

4386

4387

4388

</li>

4389

4390

4391

4392

4393

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

4394

4395

4396

4397

4398

4399

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

4400

</div>

4401

4402

4403

</li>

4404

4405

</ul>

4406

</div>

4407

4408

4409

4410

4411

4412

</div>

4413

4414

4415

4416

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

4417

4418

4419

4420

4421

4422

4423

4424

4425

4426

4427

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

4428

4429

4430

4431

4432

4433

4434

4435

4436

4437

4438

<p>Inherited from

4439

4440

BaseCore

4441

</a>

4442

4443

but overwritten in

4444

4445

4446

4447

4448

4449

</p>

4450

4451

4452

4453

4454

4455

</div>

4456

4457

4458

<p>Initializes Attribute</p>

4459

</div>

4460

4461

4462

4463

4464

4465

4466

</div>

4467

4468

4469

4470

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

4471

4472

4473

4474

4475

4476

4477

4478

<code>attrs</code>

4479

4480

</li>

4481

4482

4483

4484

<code>values</code>

4485

4486

</li>

4487

4488

4489

4490

4491

4492

</li>

4493

4494

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

4495

</div>

4496

4497

4498

4499

4500

4501

4502

4503

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

4504

4505

4506

4507

4508

4509

4510

4511

4512

4513

4514

4515

<p>Inherited from

4516

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

4517

4518

4519

4520

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

4521

4522

</p>

4523

4524

4525

4526

4527

4528

</div>

4529

4530

4531

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

4532

</div>

4533

4534

4535

4536

<h4>Parameters:</h4>

4537

4538

4539

4540

4541

4542

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

4543

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

4544

4545

4546

4547

4548

4549

4550

</div>

4551

4552

4553

</li>

4554

4555

4556

4557

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

4558

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

4559

4560

4561

4562

4563

4564

4565

</div>

4566

4567

4568

</li>

4569

4570

4571

4572

4573

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

4574

4575

4576

4577

4578

4579

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

4580

</div>

4581

4582

4583

</li>

4584

4585

</ul>

4586

</div>

4587

4588

4589

4590

4591

4592

</div>

4593

4594

4595

4596

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

4597

4598

4599

4600

4601

4602

4603

4604

<code>config</code>

4605

4606

</li>

4607

4608

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

4609

</div>

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>Internal construction logic for Base.</p>

4649

</div>

4650

4651

4652

4653

<h4>Parameters:</h4>

4654

4655

4656

4657

4658

4659

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

4660

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

4661

4662

4663

4664

4665

4666

<p>The constructor configuration object</p>

4667

</div>

4668

4669

4670

</li>

4671

4672

</ul>

4673

</div>

4674

4675

4676

4677

4678

4679

</div>

4680

4681

4682

4683

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

4684

4685

4686

4687

4688

4689

4690

4691

<code>userVals</code>

4692

4693

</li>

4694

4695

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

4696

</div>

4697

4698

4699

4700

4701

4702

4703

4704

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

4705

4706

4707

4708

4709

4710

4711

4712

4713

4714

4715

4716

<p>Inherited from

4717

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

4718

4719

4720

4721

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

4722

4723

</p>

4724

4725

4726

4727

4728

4729

</div>

4730

4731

4732

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

4733

initializing attributes for each class defined in the class's

4734

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

4735

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

4736

</div>

4737

4738

4739

4740

<h4>Parameters:</h4>

4741

4742

4743

4744

4745

4746

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

4747

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

4748

4749

4750

4751

4752

4753

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

4754

</div>

4755

4756

4757

</li>

4758

4759

</ul>

4760

</div>

4761

4762

4763

4764

4765

4766

</div>

4767

4768

4769

4770

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

4771

4772

4773

4774

4775

4776

4777

4778

4779

4780

4781

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

4782

4783

4784

4785

4786

4787

4788

4789

4790

4791

4792

4793

<p>Inherited from

4794

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

4795

4796

4797

4798

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

4799

4800

</p>

4801

4802

4803

4804

4805

4806

</div>

4807

4808

4809

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

4810

the array of classes and aggregate set of attribute configurations

4811

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

4812

</div>

4813

4814

4815

4816

4817

4818

4819

</div>

4820

4821

4822

4823

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

4824

4825

4826

4827

4828

4829

4830

4831

4832

4833

</li>

4834

4835

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

4836

</div>

4837

4838

4839

4840

4841

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

4842

</span>

4843

4844

4845

4846

4847

4848

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

4849

4850

4851

4852

4853

4854

4855

4856

4857

4858

4859

4860

<p>Inherited from

4861

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

4862

4863

4864

4865

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

4866

4867

</p>

4868

4869

4870

4871

4872

4873

</div>

4874

4875

4876

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

4877

added lazily and still requires initialization.</p>

4878

</div>

4879

4880

4881

4882

<h4>Parameters:</h4>

4883

4884

4885

4886

4887

4888

4889

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

4890

4891

4892

4893

4894

4895

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

4896

</div>

4897

4898

4899

</li>

4900

4901

</ul>

4902

</div>

4903

4904

4905

4906

4907

<h4>Returns:</h4>

4908

4909

4910

4911

4912

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

4913

4914

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

4915

4916

</div>

4917

</div>

4918

4919

4920

4921

</div>

4922

4923

4924

4925

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

4926

4927

4928

4929

4930

4931

4932

4933

<code>request</code>

4934

4935

</li>

4936

4937

4938

4939

<code>entry</code>

4940

4941

</li>

4942

4943

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

4944

</div>

4945

4946

4947

4948

4949

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

4950

</span>

4951

4952

4953

4954

4955

4956

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

4957

4958

4959

4960

4961

4962

4963

4964

4965

4966

4967

4968

<p>Inherited from

4969

<a href="../classes/Cache.html#method__isMatch">Cache</a>:

4970

4971

4972

4973

<a href="../files/cache_js_cache-base.js.html#l306"><code>cache/js/cache-base.js:306</code></a>

4974

4975

</p>

4976

4977

4978

4979

4980

4981

</div>

4982

4983

4984

<p>Default overridable method compares current request with given cache entry.

4985

Returns true if current request matches the cached request, otherwise

4986

false. Implementers should override this method to customize the

4987

cache-matching algorithm.</p>

4988

</div>

4989

4990

4991

4992

<h4>Parameters:</h4>

4993

4994

4995

4996

4997

4998

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

4999

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

5000

5001

5002

5003

5004

5005

<p>Request object.</p>

5006

</div>

5007

5008

5009

</li>

5010

5011

5012

5013

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

5014

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

5015

5016

5017

5018

5019

5020

<p>Cached entry.</p>

5021

</div>

5022

5023

5024

</li>

5025

5026

</ul>

5027

</div>

5028

5029

5030

5031

5032

<h4>Returns:</h4>

5033

5034

5035

5036

5037

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

5038

5039

True if current request matches given cached request, false otherwise.

5040

5041

</div>

5042

</div>

5043

5044

5045

5046

</div>

5047

5048

5049

5050

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

5051

5052

5053

5054

5055

5056

5057

5058

5059

5060

</li>

5061

5062

5063

5064

5065

5066

</li>

5067

5068

5069

5070

5071

5072

</li>

5073

5074

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

5075

</div>

5076

5077

5078

5079

5080

5081

5082

5083

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

5084

5085

5086

5087

5088

5089

5090

5091

5092

5093

5094

5095

<p>Inherited from

5096

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

5097

5098

5099

5100

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

5101

5102

</p>

5103

5104

5105

5106

5107

5108

</div>

5109

5110

5111

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

5112

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

5113

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

5114

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

5115

be subscribed to like other events to monitor the event

5116

system. Inividual published events can have monitoring

5117

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

5118

it published) by setting the events 'monitor' config.</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>'attach', 'detach', 'fire', or 'publish'</p>

5137

</div>

5138

5139

5140

</li>

5141

5142

5143

5144

5145

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

5146

5147

5148

5149

5150

5151

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

5152

</div>

5153

5154

5155

</li>

5156

5157

5158

5159

5160

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

5161

5162

5163

5164

5165

5166

<p>Information about the event interaction, such as

5167

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

5168

</div>

5169

5170

5171

</li>

5172

5173

</ul>

5174

</div>

5175

5176

5177

5178

5179

5180

</div>

5181

5182

5183

5184

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

5185

5186

5187

5188

5189

5190

5191

5192

<code>valueHash</code>

5193

5194

</li>

5195

5196

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

5197

</div>

5198

5199

5200

5201

5202

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

5203

</span>

5204

5205

5206

5207

5208

5209

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

5210

5211

5212

5213

5214

5215

5216

5217

5218

5219

5220

<p>Inherited from

5221

5222

AttributeCore

5223

</a>

5224

5225

but overwritten in

5226

5227

5228

5229

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

5230

5231

</p>

5232

5233

5234

5235

5236

5237

</div>

5238

5239

5240

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

5241

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

5242

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

5243

</div>

5244

5245

5246

5247

<h4>Parameters:</h4>

5248

5249

5250

5251

5252

5253

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

5254

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

5255

5256

5257

5258

5259

5260

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

5261

</div>

5262

5263

5264

</li>

5265

5266

</ul>

5267

</div>

5268

5269

5270

5271

5272

<h4>Returns:</h4>

5273

5274

5275

5276

5277

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

5278

5279

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

5280

containing simple and complex attribute values respectively keyed

5281

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

5282

5283

</div>

5284

</div>

5285

5286

5287

5288

</div>

5289

5290

5291

5292

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

5293

5294

5295

5296

5297

5298

5299

5300

5301

5302

5303

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

5304

5305

5306

5307

5308

5309

5310

5311

5312

5313

5314

5315

<p>Inherited from

5316

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

5317

5318

5319

5320

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

5321

5322

</p>

5323

5324

5325

5326

5327

5328

</div>

5329

5330

5331

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

5332

and the prefixed event name from _getType

5333

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

5334

</div>

5335

5336

5337

5338

5339

5340

5341

</div>

5342

5343

5344

5345

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

5346

5347

5348

5349

5350

5351

5352

5353

<code>request</code>

5354

5355

</li>

5356

5357

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

5358

</div>

5359

5360

5361

5362

5363

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

5364

</span>

5365

5366

5367

5368

5369

5370

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

5371

5372

5373

5374

5375

5376

5377

5378

5379

5380

5381

5382

<p>Inherited from

5383

<a href="../classes/Cache.html#method__position">Cache</a>:

5384

5385

5386

5387

<a href="../files/cache_js_cache-base.js.html#l325"><code>cache/js/cache-base.js:325</code></a>

5388

5389

</p>

5390

5391

5392

5393

5394

5395

</div>

5396

5397

5398

<p>Returns position of a request in the entries array, otherwise null.</p>

5399

</div>

5400

5401

5402

5403

<h4>Parameters:</h4>

5404

5405

5406

5407

5408

5409

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

5410

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

5411

5412

5413

5414

5415

5416

<p>Request object.</p>

5417

</div>

5418

5419

5420

</li>

5421

5422

</ul>

5423

</div>

5424

5425

5426

5427

5428

<h4>Returns:</h4>

5429

5430

5431

5432

5433

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

5434

5435

Array position if found, null otherwise.

5436

5437

</div>

5438

</div>

5439

5440

5441

5442

</div>

5443

5444

5445

5446

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

5447

5448

5449

5450

5451

5452

5453

5454

<code>config</code>

5455

5456

</li>

5457

5458

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

5459

</div>

5460

5461

5462

5463

5464

5465

5466

5467

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

5468

5469

5470

5471

5472

5473

5474

5475

5476

5477

5478

5479

<p>Inherited from

5480

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

5481

5482

5483

5484

5485

5486

</p>

5487

5488

5489

5490

5491

5492

</div>

5493

5494

5495

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

5496

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

5497

construction, prior to init.</p>

5498

</div>

5499

5500

5501

5502

<h4>Parameters:</h4>

5503

5504

5505

5506

5507

5508

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

5509

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

5510

5511

5512

5513

5514

5515

<p>The user configuration object</p>

5516

</div>

5517

5518

5519

</li>

5520

5521

</ul>

5522

</div>

5523

5524

5525

5526

5527

5528

</div>

5529

5530

5531

5532

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

5533

5534

5535

5536

5537

5538

5539

5540

<code>attrs</code>

5541

5542

</li>

5543

5544

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

5545

</div>

5546

5547

5548

5549

5550

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

5551

</span>

5552

5553

5554

5555

5556

5557

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

5558

5559

5560

5561

5562

5563

5564

5565

5566

5567

5568

5569

<p>Inherited from

5570

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

5571

5572

5573

5574

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

5575

5576

</p>

5577

5578

5579

5580

5581

5582

</div>

5583

5584

5585

<p>Utility method to protect an attribute configuration

5586

hash, by merging the entire object and the individual

5587

attr config objects.</p>

5588

</div>

5589

5590

5591

5592

<h4>Parameters:</h4>

5593

5594

5595

5596

5597

5598

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

5599

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

5600

5601

5602

5603

5604

5605

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

5606

</div>

5607

5608

5609

</li>

5610

5611

</ul>

5612

</div>

5613

5614

5615

5616

5617

<h4>Returns:</h4>

5618

5619

5620

5621

5622

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

5623

5624

A protected version of the attrs argument.

5625

5626

</div>

5627

</div>

5628

5629

5630

5631

</div>

5632

5633

5634

5635

5636

5637

5638

5639

5640

5641

5642

5643

5644

5645

</li>

5646

5647

5648

5649

5650

5651

</li>

5652

5653

5654

5655

5656

5657

</li>

5658

5659

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

5660

</div>

5661

5662

5663

5664

5665

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

5666

</span>

5667

5668

5669

5670

5671

5672

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

5673

5674

5675

5676

5677

5678

5679

5680

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

5681

5682

5683

5684

5685

<p>Inherited from

5686

5687

AttributeCore

5688

</a>

5689

5690

but overwritten in

5691

5692

5693

5694

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

5695

5696

</p>

5697

5698

5699

5700

5701

5702

</div>

5703

5704

5705

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

5706

</div>

5707

5708

5709

5710

<h4>Parameters:</h4>

5711

5712

5713

5714

5715

5716

5717

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

5718

5719

5720

5721

5722

5723

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

5724

</div>

5725

5726

5727

</li>

5728

5729

5730

5731

5732

5733

5734

5735

5736

5737

5738

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

5739

</div>

5740

5741

5742

</li>

5743

5744

5745

5746

5747

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

5748

5749

5750

5751

5752

5753

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

5754

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

5755

</div>

5756

5757

5758

</li>

5759

5760

</ul>

5761

</div>

5762

5763

5764

5765

5766

<h4>Returns:</h4>

5767

5768

5769

5770

5771

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

5772

5773

A reference to the host object.

5774

5775

</div>

5776

</div>

5777

5778

5779

5780

</div>

5781

5782

5783

5784

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

5785

5786

5787

5788

5789

5790

5791

5792

5793

5794

</li>

5795

5796

5797

5798

<code>value</code>

5799

5800

</li>

5801

5802

5803

5804

5805

5806

</li>

5807

5808

5809

5810

<code>force</code>

5811

5812

</li>

5813

5814

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

5815

</div>

5816

5817

5818

5819

5820

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

5821

</span>

5822

5823

5824

5825

5826

5827

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

5828

5829

5830

5831

5832

5833

5834

5835

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

5836

5837

5838

5839

5840

5841

<p>Inherited from

5842

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

5843

5844

5845

5846

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

5847

5848

</p>

5849

5850

5851

5852

5853

5854

</div>

5855

5856

5857

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

5858

5859

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

5860

</div>

5861

5862

5863

5864

<h4>Parameters:</h4>

5865

5866

5867

5868

5869

5870

5871

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

5872

5873

5874

5875

5876

5877

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

5878

</div>

5879

5880

5881

</li>

5882

5883

5884

5885

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

5886

5887

5888

5889

5890

5891

5892

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

5893

</div>

5894

5895

5896

</li>

5897

5898

5899

5900

5901

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

5902

5903

5904

5905

5906

5907

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

5908

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

5909

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

5910

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

5911

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

5912

</div>

5913

5914

5915

</li>

5916

5917

5918

5919

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

5920

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

5921

5922

5923

5924

5925

5926

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

5927

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

5928

</div>

5929

5930

5931

</li>

5932

5933

</ul>

5934

</div>

5935

5936

5937

5938

5939

<h4>Returns:</h4>

5940

5941

5942

5943

5944

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

5945

5946

A reference to the host object.

5947

5948

</div>

5949

</div>

5950

5951

5952

5953

</div>

5954

5955

5956

5957

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

5958

5959

5960

5961

5962

5963

5964

5965

<code>attrs</code>

5966

5967

</li>

5968

5969

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

5970

</div>

5971

5972

5973

5974

5975

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

5976

</span>

5977

5978

5979

5980

5981

5982

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

5983

5984

5985

5986

5987

5988

5989

5990

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

5991

5992

5993

5994

5995

5996

<p>Inherited from

5997

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

5998

5999

6000

6001

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

6002

6003

</p>

6004

6005

6006

6007

6008

6009

</div>

6010

6011

6012

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

6013

</div>

6014

6015

6016

6017

<h4>Parameters:</h4>

6018

6019

6020

6021

6022

6023

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

6024

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

6025

6026

6027

6028

6029

6030

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

6031

</div>

6032

6033

6034

</li>

6035

6036

</ul>

6037

</div>

6038

6039

6040

6041

6042

<h4>Returns:</h4>

6043

6044

6045

6046

6047

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

6048

6049

A reference to the host object.

6050

6051

</div>

6052

</div>

6053

6054

6055

6056

</div>

6057

6058

6059

6060

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

6061

6062

6063

6064

6065

6066

6067

6068

<code>attrName</code>

6069

6070

</li>

6071

6072

6073

6074

<code>subAttrName</code>

6075

6076

</li>

6077

6078

6079

6080

<code>prevVal</code>

6081

6082

</li>

6083

6084

6085

6086

<code>newVal</code>

6087

6088

</li>

6089

6090

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

6091

</div>

6092

6093

6094

6095

6096

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

6097

</span>

6098

6099

6100

6101

6102

6103

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

6104

6105

6106

6107

6108

6109

6110

6111

6112

6113

6114

6115

<p>Inherited from

6116

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

6117

6118

6119

6120

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

6121

6122

</p>

6123

6124

6125

6126

6127

6128

</div>

6129

6130

6131

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

6132

if validation and setter passes.</p>

6133

</div>

6134

6135

6136

6137

<h4>Parameters:</h4>

6138

6139

6140

6141

6142

6143

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

6144

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

6145

6146

6147

6148

6149

6150

<p>The attribute name.</p>

6151

</div>

6152

6153

6154

</li>

6155

6156

6157

6158

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

6159

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

6160

6161

6162

6163

6164

6165

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

6166

</div>

6167

6168

6169

</li>

6170

6171

6172

6173

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

6174

6175

6176

6177

6178

6179

6180

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

6181

</div>

6182

6183

6184

</li>

6185

6186

6187

6188

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

6189

6190

6191

6192

6193

6194

6195

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

6196

</div>

6197

6198

6199

</li>

6200

6201

</ul>

6202

</div>

6203

6204

6205

6206

6207

<h4>Returns:</h4>

6208

6209

6210

6211

6212

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

6213

6214

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

6215

6216

</div>

6217

</div>

6218

6219

6220

6221

</div>

6222

6223

6224

6225

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

6226

6227

6228

6229

6230

6231

6232

6233

6234

6235

6236

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

6237

6238

6239

6240

6241

6242

6243

6244

6245

6246

6247

6248

<p>Inherited from

6249

<a href="../classes/Cache.html#method__setMax">Cache</a>:

6250

6251

6252

6253

<a href="../files/cache_js_cache-base.js.html#l198"><code>cache/js/cache-base.js:198</code></a>

6254

6255

</p>

6256

6257

6258

6259

6260

6261

</div>

6262

6263

6264

6265

</div>

6266

6267

6268

6269

6270

6271

6272

</div>

6273

6274

6275

6276

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

6277

6278

6279

6280

6281

6282

6283

6284

6285

6286

</li>

6287

6288

6289

6290

<code>value</code>

6291

6292

</li>

6293

6294

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

6295

</div>

6296

6297

6298

6299

6300

6301

6302

6303

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

6304

6305

6306

6307

6308

6309

6310

6311

6312

6313

6314

6315

<p>Inherited from

6316

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

6317

6318

6319

6320

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

6321

6322

</p>

6323

6324

6325

6326

6327

6328

</div>

6329

6330

6331

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

6332

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

6333

</div>

6334

6335

6336

6337

<h4>Parameters:</h4>

6338

6339

6340

6341

6342

6343

6344

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

6345

6346

6347

6348

6349

6350

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

6351

</div>

6352

6353

6354

</li>

6355

6356

6357

6358

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

6359

6360

6361

6362

6363

6364

6365

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

6366

</div>

6367

6368

6369

</li>

6370

6371

</ul>

6372

</div>

6373

6374

6375

6376

6377

6378

</div>

6379

6380

6381

6382

6383

6384

6385

6386

6387

6388

6389

6390

<code>request</code>

6391

6392

</li>

6393

6394

6395

6396

<code>response</code>

6397

6398

</li>

6399

6400

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

6401

</div>

6402

6403

6404

6405

6406

6407

6408

6409

6410

6411

6412

6413

6414

6415

6416

6417

6418

6419

<p>Inherited from

6420

<a href="../classes/Cache.html#method_add">Cache</a>:

6421

6422

6423

6424

<a href="../files/cache_js_cache-base.js.html#l358"><code>cache/js/cache-base.js:358</code></a>

6425

6426

</p>

6427

6428

6429

6430

6431

6432

</div>

6433

6434

6435

<p>Adds a new entry to the cache of the format

6436

{request:request, response:response, cached:cached, expires:expires}.

6437

If cache is full, evicts the stalest entry before adding the new one.</p>

6438

</div>

6439

6440

6441

6442

<h4>Parameters:</h4>

6443

6444

6445

6446

6447

6448

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

6449

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

6450

6451

6452

6453

6454

6455

<p>Request value.</p>

6456

</div>

6457

6458

6459

</li>

6460

6461

6462

6463

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

6464

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

6465

6466

6467

6468

6469

6470

<p>Response value.</p>

6471

</div>

6472

6473

6474

</li>

6475

6476

</ul>

6477

</div>

6478

6479

6480

6481

6482

6483

</div>

6484

6485

6486

6487

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

6488

6489

6490

6491

6492

6493

6494

6495

6496

6497

</li>

6498

6499

6500

6501

<code>config</code>

6502

6503

</li>

6504

6505

6506

6507

6508

6509

</li>

6510

6511

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

6512

</div>

6513

6514

6515

6516

6517

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

6518

</span>

6519

6520

6521

6522

6523

6524

6525

6526

6527

6528

6529

6530

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

6531

6532

6533

6534

6535

6536

<p>Inherited from

6537

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

6538

6539

6540

6541

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

6542

6543

</p>

6544

6545

6546

6547

6548

6549

</div>

6550

6551

6552

<p>

6553

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

6554

</p>

6555

6556

<p>

6557

The config argument object supports the following properties:

6558

</p>

6559

6560

<dl>

6561

<dt>value <Any></dt>

6562

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

6563

6564

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

6565

<dd>

6566

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

6567

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

6568

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

6569

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

6570

case the value property is used.</p>

6571

6572

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

6573

</dd>

6574

6575

<dt>readOnly <boolean></dt>

6576

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

6577

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

6578

6579

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

6580

<dd>

6581

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

6582

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

6583

constructor configuration arguments, or by invoking set.

6584

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

6585

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

6586

</dd>

6587

6588

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

6589

<dd>

6590

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

6591

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

6592

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

6593

the value from being stored.

6594

</p>

6595

6596

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

6597

</dd>

6598

6599

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

6600

<dd>

6601

<p>

6602

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

6603

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

6604

invoke get.

6605

</p>

6606

6607

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

6608

</dd>

6609

6610

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

6611

<dd>

6612

<p>

6613

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

6614

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

6615

</p>

6616

6617

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

6618

</dd>

6619

6620

<dt>lazyAdd <boolean></dt>

6621

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

6622

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

6623

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

6624

6625

</dl>

6626

6627

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

6628

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

6629

6630

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

6631

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

6632

</div>

6633

6634

6635

6636

<h4>Parameters:</h4>

6637

6638

6639

6640

6641

6642

6643

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

6644

6645

6646

6647

6648

6649

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

6650

</div>

6651

6652

6653

</li>

6654

6655

6656

6657

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

6658

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

6659

6660

6661

6662

6663

6664

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

6665

6666

<p>

6667

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

6668

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

6669

</p>

6670

</div>

6671

6672

6673

</li>

6674

6675

6676

6677

6678

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

6679

6680

6681

6682

6683

6684

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

6685

</div>

6686

6687

6688

</li>

6689

6690

</ul>

6691

</div>

6692

6693

6694

6695

6696

<h4>Returns:</h4>

6697

6698

6699

6700

6701

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

6702

6703

A reference to the host object.

6704

6705

</div>

6706

</div>

6707

6708

6709

6710

</div>

6711

6712

6713

6714

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

6715

6716

6717

6718

6719

6720

6721

6722

6723

6724

</li>

6725

6726

6727

6728

<code>values</code>

6729

6730

</li>

6731

6732

6733

6734

6735

6736

</li>

6737

6738

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

6739

</div>

6740

6741

6742

6743

6744

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

6745

</span>

6746

6747

6748

6749

6750

6751

6752

6753

6754

6755

6756

6757

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

6758

6759

6760

6761

6762

6763

<p>Inherited from

6764

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

6765

6766

6767

6768

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

6769

6770

</p>

6771

6772

6773

6774

6775

6776

</div>

6777

6778

6779

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

6780

6781

<p>

6782

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

6783

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

6784

</p>

6785

</div>

6786

6787

6788

6789

<h4>Parameters:</h4>

6790

6791

6792

6793

6794

6795

6796

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

6797

6798

6799

6800

6801

6802

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

6803

</div>

6804

6805

6806

</li>

6807

6808

6809

6810

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

6811

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

6812

6813

6814

6815

6816

6817

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

6818

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

6819

</div>

6820

6821

6822

</li>

6823

6824

6825

6826

6827

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

6828

6829

6830

6831

6832

6833

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

6834

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

6835

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

6836

</div>

6837

6838

6839

</li>

6840

6841

</ul>

6842

</div>

6843

6844

6845

6846

6847

<h4>Returns:</h4>

6848

6849

6850

6851

6852

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

6853

6854

A reference to the host object.

6855

6856

</div>

6857

</div>

6858

6859

6860

6861

</div>

6862

6863

6864

6865

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

6866

6867

6868

6869

6870

6871

6872

6873

6874

6875

</li>

6876

6877

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

6878

</div>

6879

6880

6881

6882

6883

6884

6885

6886

6887

6888

6889

6890

6891

6892

6893

6894

6895

6896

<p>Inherited from

6897

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

6898

6899

6900

6901

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

6902

6903

</p>

6904

6905

6906

6907

6908

6909

</div>

6910

6911

6912

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

6913

is determined by the order registered. Multiple targets can

6914

be specified.</p>

6915

6916

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

6917

6918

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

6919

</div>

6920

6921

6922

6923

<h4>Parameters:</h4>

6924

6925

6926

6927

6928

6929

6930

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

6931

6932

6933

6934

6935

6936

<p>the target to add</p>

6937

</div>

6938

6939

6940

</li>

6941

6942

</ul>

6943

</div>

6944

6945

6946

6947

6948

6949

</div>

6950

6951

6952

6953

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

6954

6955

6956

6957

6958

6959

6960

6961

6962

6963

</li>

6964

6965

6966

6967

6968

6969

</li>

6970

6971

6972

6973

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

6974

6975

</li>

6976

6977

6978

6979

6980

6981

</li>

6982

6983

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

6984

</div>

6985

6986

6987

6988

6989

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

6990

</span>

6991

6992

6993

6994

6995

6996

6997

6998

6999

7000

7001

7002

7003

7004

7005

7006

<p>Inherited from

7007

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

7008

7009

7010

7011

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

7012

7013

</p>

7014

7015

7016

7017

7018

7019

</div>

7020

7021

7022

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

7023

supplied callback will execute after any listeners add

7024

via the subscribe method, and after the default function,

7025

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

7026

</div>

7027

7028

7029

7030

<h4>Parameters:</h4>

7031

7032

7033

7034

7035

7036

7037

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

7038

7039

7040

7041

7042

7043

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

7044

</div>

7045

7046

7047

</li>

7048

7049

7050

7051

7052

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

7053

7054

7055

7056

7057

7058

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

7059

</div>

7060

7061

7062

</li>

7063

7064

7065

7066

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

7067

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

7068

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

7069

7070

7071

7072

7073

7074

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

7075

</div>

7076

7077

7078

</li>

7079

7080

7081

7082

7083

7084

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

7085

7086

7087

7088

7089

7090

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

7091

</div>

7092

7093

7094

</li>

7095

7096

</ul>

7097

</div>

7098

7099

7100

7101

7102

<h4>Returns:</h4>

7103

7104

7105

7106

7107

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

7108

7109

A subscription handle capable of detaching the

7110

subscription

7111

7112

</div>

7113

</div>

7114

7115

7116

7117

</div>

7118

7119

7120

7121

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

7122

7123

7124

7125

7126

7127

7128

7129

7130

7131

</li>

7132

7133

7134

7135

7136

7137

</li>

7138

7139

7140

7141

<code>context</code>

7142

7143

</li>

7144

7145

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

7146

</div>

7147

7148

7149

7150

7151

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

7152

</span>

7153

7154

7155

7156

7157

7158

7159

7160

7161

7162

7163

7164

7165

7166

7167

7168

<p>Inherited from

7169

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

7170

7171

7172

7173

<a href="../files/plugin_js_plugin.js.html#l168"><code>plugin/js/plugin.js:168</code></a>

7174

7175

</p>

7176

7177

7178

7179

7180

7181

</div>

7182

7183

7184

<p>Listens for the "after" moment of events fired by the host object.</p>

7185

7186

<p>Listeners attached through this method will be detached when the plugin is unplugged.</p>

7187

</div>

7188

7189

7190

7191

<h4>Parameters:</h4>

7192

7193

7194

7195

7196

7197

7198

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

7199

7200

7201

7202

7203

7204

<p>The event type.</p>

7205

</div>

7206

7207

7208

</li>

7209

7210

7211

7212

7213

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

7214

7215

7216

7217

7218

7219

<p>The listener.</p>

7220

</div>

7221

7222

7223

</li>

7224

7225

7226

7227

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

7228

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

7229

7230

7231

7232

7233

7234

<p>The execution context. Defaults to the plugin instance.</p>

7235

</div>

7236

7237

7238

</li>

7239

7240

</ul>

7241

</div>

7242

7243

7244

7245

7246

<h4>Returns:</h4>

7247

7248

7249

7250

7251

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

7252

7253

handle The detach handle for the listener.

7254

7255

</div>

7256

</div>

7257

7258

7259

7260

</div>

7261

7262

7263

7264

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

7265

7266

7267

7268

7269

7270

7271

7272

<code>method</code>

7273

7274

</li>

7275

7276

7277

7278

7279

7280

</li>

7281

7282

7283

7284

<code>context</code>

7285

7286

</li>

7287

7288

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

7289

</div>

7290

7291

7292

7293

7294

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

7295

</span>

7296

7297

7298

7299

7300

7301

7302

7303

7304

7305

7306

7307

7308

7309

7310

7311

<p>Inherited from

7312

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

7313

7314

7315

7316

<a href="../files/plugin_js_plugin.js.html#l202"><code>plugin/js/plugin.js:202</code></a>

7317

7318

</p>

7319

7320

7321

7322

7323

7324

</div>

7325

7326

7327

<p>Injects a function to be executed after a given method on host object.</p>

7328

7329

<p>The function will be detached when the plugin is unplugged.</p>

7330

</div>

7331

7332

7333

7334

<h4>Parameters:</h4>

7335

7336

7337

7338

7339

7340

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

7341

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

7342

7343

7344

7345

7346

7347

<p>The name of the method to inject the function after.</p>

7348

</div>

7349

7350

7351

</li>

7352

7353

7354

7355

7356

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

7357

7358

7359

7360

7361

7362

<p>The function to inject.</p>

7363

</div>

7364

7365

7366

</li>

7367

7368

7369

7370

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

7371

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

7372

7373

7374

7375

7376

7377

<p>The execution context. Defaults to the plugin instance.</p>

7378

</div>

7379

7380

7381

</li>

7382

7383

</ul>

7384

</div>

7385

7386

7387

7388

7389

<h4>Returns:</h4>

7390

7391

7392

7393

7394

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

7395

7396

handle The detach handle for the injected function.

7397

7398

</div>

7399

</div>

7400

7401

7402

7403

</div>

7404

7405

7406

7407

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

7408

7409

7410

7411

7412

7413

7414

7415

7416

7417

</li>

7418

7419

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

7420

</div>

7421

7422

7423

7424

7425

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

7426

</span>

7427

7428

7429

7430

7431

7432

7433

7434

7435

7436

7437

7438

7439

7440

7441

7442

<p>Inherited from

7443

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

7444

7445

7446

7447

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

7448

7449

</p>

7450

7451

7452

7453

7454

7455

</div>

7456

7457

7458

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

7459

</div>

7460

7461

7462

7463

<h4>Parameters:</h4>

7464

7465

7466

7467

7468

7469

7470

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

7471

7472

7473

7474

7475

7476

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

7477

</div>

7478

7479

7480

</li>

7481

7482

</ul>

7483

</div>

7484

7485

7486

7487

7488

<h4>Returns:</h4>

7489

7490

7491

7492

7493

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

7494

7495

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.

7496

7497

</div>

7498

</div>

7499

7500

7501

7502

</div>

7503

7504

7505

7506

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

7507

7508

7509

7510

7511

7512

7513

7514

7515

</span>

7516

7517

7518

7519

7520

7521

7522

7523

7524

7525

7526

7527

7528

7529

7530

7531

<p>Inherited from

7532

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

7533

7534

7535

7536

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

7537

7538

</p>

7539

7540

7541

7542

7543

7544

</div>

7545

7546

7547

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

7548

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

7549

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

7550

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

7551

7552

<p>For DOM and custom events:

7553

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

7554

7555

<p>For methods:

7556

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

7557

</div>

7558

7559

7560

7561

7562

7563

<h4>Returns:</h4>

7564

7565

7566

7567

7568

detach handle

7569

7570

</div>

7571

</div>

7572

7573

7574

7575

</div>

7576

7577

7578

7579

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

7580

7581

7582

7583

7584

7585

7586

7587

<code>method</code>

7588

7589

</li>

7590

7591

7592

7593

7594

7595

</li>

7596

7597

7598

7599

<code>context</code>

7600

7601

</li>

7602

7603

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

7604

</div>

7605

7606

7607

7608

7609

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

7610

</span>

7611

7612

7613

7614

7615

7616

7617

7618

7619

7620

7621

7622

7623

7624

7625

7626

<p>Inherited from

7627

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

7628

7629

7630

7631

<a href="../files/plugin_js_plugin.js.html#l185"><code>plugin/js/plugin.js:185</code></a>

7632

7633

</p>

7634

7635

7636

7637

7638

7639

</div>

7640

7641

7642

<p>Injects a function to be executed before a given method on host object.</p>

7643

7644

<p>The function will be detached when the plugin is unplugged.</p>

7645

</div>

7646

7647

7648

7649

<h4>Parameters:</h4>

7650

7651

7652

7653

7654

7655

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

7656

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

7657

7658

7659

7660

7661

7662

<p>The name of the method to inject the function before.</p>

7663

</div>

7664

7665

7666

</li>

7667

7668

7669

7670

7671

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

7672

7673

7674

7675

7676

7677

<p>The function to inject.</p>

7678

</div>

7679

7680

7681

</li>

7682

7683

7684

7685

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

7686

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

7687

7688

7689

7690

7691

7692

<p>The execution context. Defaults to the plugin instance.</p>

7693

</div>

7694

7695

7696

</li>

7697

7698

</ul>

7699

</div>

7700

7701

7702

7703

7704

<h4>Returns:</h4>

7705

7706

7707

7708

7709

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

7710

7711

handle The detach handle for the injected function.

7712

7713

</div>

7714

</div>

7715

7716

7717

7718

</div>

7719

7720

7721

7722

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

7723

7724

7725

7726

7727

7728

7729

7730

7731

7732

</li>

7733

7734

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

7735

</div>

7736

7737

7738

7739

7740

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

7741

</span>

7742

7743

7744

7745

7746

7747

7748

7749

7750

7751

7752

7753

7754

7755

7756

7757

<p>Inherited from

7758

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

7759

7760

7761

7762

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

7763

7764

</p>

7765

7766

7767

7768

7769

7770

</div>

7771

7772

7773

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

7774

</div>

7775

7776

7777

7778

<h4>Parameters:</h4>

7779

7780

7781

7782

7783

7784

7785

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

7786

7787

7788

7789

7790

7791

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

7792

</div>

7793

7794

7795

</li>

7796

7797

</ul>

7798

</div>

7799

7800

7801

7802

7803

<h4>Returns:</h4>

7804

7805

7806

7807

7808

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

7809

7810

the aggregated return value from Event.Custom.fire

7811

7812

</div>

7813

</div>

7814

7815

7816

7817

</div>

7818

7819

7820

7821

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

7822

7823

7824

7825

7826

7827

7828

7829

7830

</span>

7831

7832

7833

7834

7835

7836

7837

7838

7839

7840

7841

7842

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

7843

7844

7845

7846

7847

<p>Inherited from

7848

7849

BaseCore

7850

</a>

7851

7852

but overwritten in

7853

7854

7855

7856

7857

7858

</p>

7859

7860

7861

7862

7863

7864

</div>

7865

7866

7867

<p>

7868

Destroy lifecycle method. Fires the destroy

7869

event, prior to invoking destructors for the

7870

class hierarchy.

7871

</p>

7872

7873

<p>

7874

Subscribers to the destroy

7875

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

7876

from proceeding.

7877

</p>

7878

</div>

7879

7880

7881

7882

7883

7884

<h4>Returns:</h4>

7885

7886

7887

7888

7889

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

7890

7891

A reference to this object

7892

7893

</div>

7894

</div>

7895

7896

7897

7898

</div>

7899

7900

7901

7902

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

7903

7904

7905

7906

7907

7908

7909

7910

7911

7912

7913

7914

7915

7916

7917

7918

7919

7920

7921

7922

<p>Inherited from

7923

7924

Cache

7925

</a>

7926

7927

but overwritten in

7928

7929

7930

7931

<a href="../files/plugin_js_plugin.js.html#l89"><code>plugin/js/plugin.js:89</code></a>

7932

7933

</p>

7934

7935

7936

7937

7938

7939

</div>

7940

7941

7942

<p>Destructor lifecycle implementation.</p>

7943

7944

<p>Removes any event listeners or injected methods applied by the Plugin</p>

7945

</div>

7946

7947

7948

7949

7950

7951

7952

</div>

7953

7954

7955

7956

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

7957

7958

7959

7960

7961

7962

7963

7964

7965

7966

</li>

7967

7968

7969

7970

7971

7972

</li>

7973

7974

7975

7976

<code>context</code>

7977

7978

</li>

7979

7980

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

7981

</div>

7982

7983

7984

7985

7986

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

7987

</span>

7988

7989

7990

7991

7992

7993

7994

7995

7996

7997

7998

7999

8000

8001

8002

8003

<p>Inherited from

8004

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

8005

8006

8007

8008

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

8009

8010

</p>

8011

8012

8013

8014

8015

8016

</div>

8017

8018

8019

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

8020

</div>

8021

8022

8023

8024

<h4>Parameters:</h4>

8025

8026

8027

8028

8029

8030

8031

8032

8033

8034

8035

8036

8037

<p>Either the handle to the subscriber or the

8038

type of event. If the type

8039

is not specified, it will attempt to remove

8040

the listener from all hosted events.</p>

8041

</div>

8042

8043

8044

</li>

8045

8046

8047

8048

8049

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

8050

8051

8052

8053

8054

8055

<p>The subscribed function to unsubscribe, if not

8056

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

8057

</div>

8058

8059

8060

</li>

8061

8062

8063

8064

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

8065

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

8066

8067

8068

8069

8070

8071

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

8072

optional, but if supplied will be used to

8073

disambiguate multiple listeners that are the same

8074

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

8075

that lives on the prototype)</p>

8076

</div>

8077

8078

8079

</li>

8080

8081

</ul>

8082

</div>

8083

8084

8085

8086

8087

<h4>Returns:</h4>

8088

8089

8090

8091

8092

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

8093

8094

the host

8095

8096

</div>

8097

</div>

8098

8099

8100

8101

</div>

8102

8103

8104

8105

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

8106

8107

8108

8109

8110

8111

8112

8113

8114

8115

</li>

8116

8117

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

8118

</div>

8119

8120

8121

8122

8123

8124

8125

8126

8127

8128

8129

8130

8131

8132

8133

8134

8135

8136

<p>Inherited from

8137

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

8138

8139

8140

8141

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

8142

8143

</p>

8144

8145

8146

8147

8148

8149

</div>

8150

8151

8152

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

8153

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

8154

be removed.</p>

8155

</div>

8156

8157

8158

8159

<h4>Parameters:</h4>

8160

8161

8162

8163

8164

8165

8166

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

8167

8168

8169

8170

8171

8172

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

8173

</div>

8174

8175

8176

</li>

8177

8178

</ul>

8179

</div>

8180

8181

8182

8183

8184

8185

</div>

8186

8187

8188

8189

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

8190

8191

8192

8193

8194

8195

8196

8197

<code>strMethod</code>

8198

8199

</li>

8200

8201

8202

8203

8204

8205

</li>

8206

8207

8208

8209

<code>context</code>

8210

8211

</li>

8212

8213

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

8214

</div>

8215

8216

8217

8218

8219

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

8220

</span>

8221

8222

8223

8224

8225

8226

8227

8228

8229

8230

8231

8232

8233

8234

8235

8236

<p>Inherited from

8237

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

8238

8239

8240

8241

<a href="../files/plugin_js_plugin.js.html#l128"><code>plugin/js/plugin.js:128</code></a>

8242

8243

</p>

8244

8245

8246

8247

8248

8249

</div>

8250

8251

8252

<p>Listens for the "after" moment of events fired by the host,

8253

or injects code "after" a given method on the host.</p>

8254

</div>

8255

8256

8257

8258

<h4>Parameters:</h4>

8259

8260

8261

8262

8263

8264

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

8265

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

8266

8267

8268

8269

8270

8271

<p>The event to listen for, or method to inject logic after.</p>

8272

</div>

8273

8274

8275

</li>

8276

8277

8278

8279

8280

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

8281

8282

8283

8284

8285

8286

<p>The handler function. For events, the "after" moment listener. For methods, the function to execute after the given method is executed.</p>

8287

</div>

8288

8289

8290

</li>

8291

8292

8293

8294

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

8295

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

8296

8297

8298

8299

8300

8301

<p>An optional context to call the handler with. The default context is the plugin instance.</p>

8302

</div>

8303

8304

8305

</li>

8306

8307

</ul>

8308

</div>

8309

8310

8311

8312

8313

<h4>Returns:</h4>

8314

8315

8316

8317

8318

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

8319

8320

handle The detach handle for the listener.

8321

8322

</div>

8323

</div>

8324

8325

8326

8327

</div>

8328

8329

8330

8331

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

8332

8333

8334

8335

8336

8337

8338

8339

<code>strMethod</code>

8340

8341

</li>

8342

8343

8344

8345

8346

8347

</li>

8348

8349

8350

8351

<code>context</code>

8352

8353

</li>

8354

8355

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

8356

</div>

8357

8358

8359

8360

8361

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

8362

</span>

8363

8364

8365

8366

8367

8368

8369

8370

8371

8372

8373

8374

8375

8376

8377

8378

<p>Inherited from

8379

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

8380

8381

8382

8383

<a href="../files/plugin_js_plugin.js.html#l105"><code>plugin/js/plugin.js:105</code></a>

8384

8385

</p>

8386

8387

8388

8389

8390

8391

</div>

8392

8393

8394

<p>Listens for the "on" moment of events fired by the host,

8395

or injects code "before" a given method on the host.</p>

8396

</div>

8397

8398

8399

8400

<h4>Parameters:</h4>

8401

8402

8403

8404

8405

8406

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

8407

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

8408

8409

8410

8411

8412

8413

<p>The event to listen for, or method to inject logic before.</p>

8414

</div>

8415

8416

8417

</li>

8418

8419

8420

8421

8422

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

8423

8424

8425

8426

8427

8428

<p>The handler function. For events, the "on" moment listener. For methods, the function to execute before the given method is executed.</p>

8429

</div>

8430

8431

8432

</li>

8433

8434

8435

8436

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

8437

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

8438

8439

8440

8441

8442

8443

<p>An optional context to call the handler with. The default context is the plugin instance.</p>

8444

</div>

8445

8446

8447

</li>

8448

8449

</ul>

8450

</div>

8451

8452

8453

8454

8455

<h4>Returns:</h4>

8456

8457

8458

8459

8460

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

8461

8462

handle The detach handle for the handler.

8463

8464

</div>

8465

</div>

8466

8467

8468

8469

</div>

8470

8471

8472

8473

8474

8475

8476

8477

8478

8479

8480

8481

8482

8483

</li>

8484

8485

8486

8487

<code>arguments</code>

8488

8489

</li>

8490

8491

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

8492

</div>

8493

8494

8495

8496

8497

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

8498

</span>

8499

8500

8501

8502

8503

8504

8505

8506

8507

8508

8509

8510

8511

8512

8513

8514

<p>Inherited from

8515

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

8516

8517

8518

8519

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

8520

8521

</p>

8522

8523

8524

8525

8526

8527

</div>

8528

8529

8530

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

8531

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

8532

following parameters.</p>

8533

8534

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

8535

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

8536

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

8537

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

8538

be published on this object first.</p>

8539

8540

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

8541

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

8542

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

8543

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

8544

in place of the original object.</p>

8545

</div>

8546

8547

8548

8549

<h4>Parameters:</h4>

8550

8551

8552

8553

8554

8555

8556

8557

8558

8559

8560

8561

8562

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

8563

a 'type' property.</p>

8564

</div>

8565

8566

8567

</li>

8568

8569

8570

8571

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

8572

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

8573

8574

8575

8576

8577

8578

<p>an arbitrary set of parameters to pass to

8579

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

8580

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

8581

parameter after the properties the object literal contains are copied to

8582

the event facade.</p>

8583

</div>

8584

8585

8586

</li>

8587

8588

</ul>

8589

</div>

8590

8591

8592

8593

8594

<h4>Returns:</h4>

8595

8596

8597

8598

8599

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

8600

8601

the event host

8602

8603

</div>

8604

</div>

8605

8606

8607

8608

</div>

8609

8610

8611

8612

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

8613

8614

8615

8616

8617

8618

8619

8620

8621

8622

8623

8624

8625

8626

8627

8628

8629

8630

8631

8632

8633

<p>Inherited from

8634

<a href="../classes/Cache.html#method_flush">Cache</a>:

8635

8636

8637

8638

<a href="../files/cache_js_cache-base.js.html#l384"><code>cache/js/cache-base.js:384</code></a>

8639

8640

</p>

8641

8642

8643

8644

8645

8646

</div>

8647

8648

8649

<p>Flushes cache.</p>

8650

</div>

8651

8652

8653

8654

8655

8656

8657

</div>

8658

8659

8660

8661

8662

8663

8664

8665

8666

8667

8668

8669

8670

8671

</li>

8672

8673

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

8674

</div>

8675

8676

8677

8678

8679

8680

</span>

8681

8682

8683

8684

8685

8686

8687

8688

8689

8690

8691

8692

8693

8694

8695

8696

<p>Inherited from

8697

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

8698

8699

8700

8701

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

8702

8703

</p>

8704

8705

8706

8707

8708

8709

</div>

8710

8711

8712

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

8713

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

8714

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

8715

</div>

8716

8717

8718

8719

<h4>Parameters:</h4>

8720

8721

8722

8723

8724

8725

8726

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

8727

8728

8729

8730

8731

8732

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

8733

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

8734

</div>

8735

8736

8737

</li>

8738

8739

</ul>

8740

</div>

8741

8742

8743

8744

8745

<h4>Returns:</h4>

8746

8747

8748

8749

8750

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

8751

8752

The value of the attribute

8753

8754

</div>

8755

</div>

8756

8757

8758

8759

</div>

8760

8761

8762

8763

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

8764

8765

8766

8767

8768

8769

8770

8771

<code>attrs</code>

8772

8773

</li>

8774

8775

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

8776

</div>

8777

8778

8779

8780

8781

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

8782

</span>

8783

8784

8785

8786

8787

8788

8789

8790

8791

8792

8793

8794

8795

8796

8797

8798

<p>Inherited from

8799

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

8800

8801

8802

8803

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

8804

8805

</p>

8806

8807

8808

8809

8810

8811

</div>

8812

8813

8814

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

8815

</div>

8816

8817

8818

8819

<h4>Parameters:</h4>

8820

8821

8822

8823

8824

8825

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

8826

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

8827

8828

8829

8830

8831

8832

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

8833

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

8834

</div>

8835

8836

8837

</li>

8838

8839

</ul>

8840

</div>

8841

8842

8843

8844

8845

<h4>Returns:</h4>

8846

8847

8848

8849

8850

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

8851

8852

An object with attribute name/value pairs.

8853

8854

</div>

8855

</div>

8856

8857

8858

8859

</div>

8860

8861

8862

8863

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

8864

8865

8866

8867

8868

8869

8870

8871

8872

8873

</li>

8874

8875

8876

8877

<code>prefixed</code>

8878

8879

</li>

8880

8881

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

8882

</div>

8883

8884

8885

8886

8887

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

8888

</span>

8889

8890

8891

8892

8893

8894

8895

8896

8897

8898

8899

8900

8901

8902

8903

8904

<p>Inherited from

8905

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

8906

8907

8908

8909

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

8910

8911

</p>

8912

8913

8914

8915

8916

8917

</div>

8918

8919

8920

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

8921

falsy value otherwise</p>

8922

</div>

8923

8924

8925

8926

<h4>Parameters:</h4>

8927

8928

8929

8930

8931

8932

8933

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

8934

8935

8936

8937

8938

8939

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

8940

</div>

8941

8942

8943

</li>

8944

8945

8946

8947

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

8948

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

8949

8950

8951

8952

8953

8954

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

8955

</div>

8956

8957

8958

</li>

8959

8960

</ul>

8961

</div>

8962

8963

8964

8965

8966

<h4>Returns:</h4>

8967

8968

8969

8970

8971

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

8972

8973

the custom event or null

8974

8975

</div>

8976

</div>

8977

8978

8979

8980

</div>

8981

8982

8983

8984

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

8985

8986

8987

8988

8989

8990

8991

8992

8993

</span>

8994

8995

8996

8997

8998

8999

9000

9001

9002

9003

9004

9005

9006

9007

9008

9009

<p>Inherited from

9010

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

9011

9012

9013

9014

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

9015

9016

</p>

9017

9018

9019

9020

9021

9022

</div>

9023

9024

9025

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

9026

</div>

9027

9028

9029

9030

9031

9032

<h4>Returns:</h4>

9033

9034

9035

9036

9037

EventTarget[]

9038

9039

</div>

9040

</div>

9041

9042

9043

9044

</div>

9045

9046

9047

9048

9049

9050

9051

9052

9053

9054

9055

9056

<code>config</code>

9057

9058

</li>

9059

9060

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

9061

</div>

9062

9063

9064

9065

9066

9067

</span>

9068

9069

9070

9071

9072

9073

9074

9075

9076

9077

9078

9079

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

9080

9081

9082

9083

9084

<p>Inherited from

9085

9086

BaseCore

9087

</a>

9088

9089

but overwritten in

9090

9091

9092

9093

9094

9095

</p>

9096

9097

9098

9099

9100

9101

</div>

9102

9103

9104

<p>Init lifecycle method, invoked during construction.

9105

Fires the init event prior to setting up attributes and

9106

invoking initializers for the class hierarchy.</p>

9107

</div>

9108

9109

9110

9111

<h4>Parameters:</h4>

9112

9113

9114

9115

9116

9117

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

9118

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

9119

9120

9121

9122

9123

9124

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

9125

</div>

9126

9127

9128

</li>

9129

9130

</ul>

9131

</div>

9132

9133

9134

9135

9136

<h4>Returns:</h4>

9137

9138

9139

9140

9141

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

9142

9143

A reference to this object

9144

9145

</div>

9146

</div>

9147

9148

9149

9150

</div>

9151

9152

9153

9154

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

9155

9156

9157

9158

9159

9160

9161

9162

<code>config</code>

9163

9164

</li>

9165

9166

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

9167

</div>

9168

9169

9170

9171

9172

9173

9174

9175

9176

9177

9178

9179

9180

9181

9182

9183

9184

<p>Inherited from

9185

9186

Cache

9187

</a>

9188

9189

but overwritten in

9190

9191

9192

9193

<a href="../files/plugin_js_plugin.js.html#l77"><code>plugin/js/plugin.js:77</code></a>

9194

9195

</p>

9196

9197

9198

9199

9200

9201

</div>

9202

9203

9204

<p>Initializer lifecycle implementation.</p>

9205

</div>

9206

9207

9208

9209

<h4>Parameters:</h4>

9210

9211

9212

9213

9214

9215

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

9216

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

9217

9218

9219

9220

9221

9222

<p>Configuration object with property name/value pairs.</p>

9223

</div>

9224

9225

9226

</li>

9227

9228

</ul>

9229

</div>

9230

9231

9232

9233

9234

9235

</div>

9236

9237

9238

9239

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

9240

9241

9242

9243

9244

9245

9246

9247

9248

9249

</li>

9250

9251

9252

9253

<code>config</code>

9254

9255

</li>

9256

9257

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

9258

</div>

9259

9260

9261

9262

9263

9264

9265

9266

9267

9268

9269

9270

9271

9272

9273

9274

9275

9276

<p>Inherited from

9277

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

9278

9279

9280

9281

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

9282

9283

</p>

9284

9285

9286

9287

9288

9289

</div>

9290

9291

9292

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

9293

9294

<p>

9295

The properties which can be modified through this interface are limited

9296

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

9297

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

9298

broadcast and getter.

9299

</p>

9300

</div>

9301

9302

9303

9304

<h4>Parameters:</h4>

9305

9306

9307

9308

9309

9310

9311

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

9312

9313

9314

9315

9316

9317

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

9318

</div>

9319

9320

9321

</li>

9322

9323

9324

9325

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

9326

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

9327

9328

9329

9330

9331

9332

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

9333

</div>

9334

9335

9336

</li>

9337

9338

</ul>

9339

</div>

9340

9341

9342

9343

9344

9345

</div>

9346

9347

9348

9349

9350

9351

9352

9353

9354

9355

9356

9357

9358

9359

</li>

9360

9361

9362

9363

9364

9365

</li>

9366

9367

9368

9369

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

9370

9371

</li>

9372

9373

9374

9375

9376

9377

</li>

9378

9379

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

9380

</div>

9381

9382

9383

9384

9385

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

9386

</span>

9387

9388

9389

9390

9391

9392

9393

9394

9395

9396

9397

9398

9399

9400

9401

9402

<p>Inherited from

9403

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

9404

9405

9406

9407

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

9408

9409

</p>

9410

9411

9412

9413

9414

9415

</div>

9416

9417

9418

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

9419

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

9420

9421

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

9422

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

9423

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

9424

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

9425

API for all available properties and methods. Subscribers to

9426

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

9427

after the event name.</p>

9428

9429

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

9430

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

9431

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

9432

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

9433

9434

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

9435

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

9436

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

9437

</div>

9438

9439

9440

9441

<h4>Parameters:</h4>

9442

9443

9444

9445

9446

9447

9448

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

9449

9450

9451

9452

9453

9454

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

9455

</div>

9456

9457

9458

</li>

9459

9460

9461

9462

9463

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

9464

9465

9466

9467

9468

9469

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

9470

</div>

9471

9472

9473

</li>

9474

9475

9476

9477

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

9478

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

9479

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

9480

9481

9482

9483

9484

9485

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

9486

</div>

9487

9488

9489

</li>

9490

9491

9492

9493

9494

9495

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

9496

9497

9498

9499

9500

9501

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

9502

</div>

9503

9504

9505

</li>

9506

9507

</ul>

9508

</div>

9509

9510

9511

9512

9513

<h4>Returns:</h4>

9514

9515

9516

9517

9518

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

9519

9520

A subscription handle capable of detaching that

9521

subscription

9522

9523

</div>

9524

</div>

9525

9526

9527

9528

</div>

9529

9530

9531

9532

9533

9534

9535

9536

9537

9538

9539

9540

9541

9542

</li>

9543

9544

9545

9546

9547

9548

</li>

9549

9550

9551

9552

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

9553

9554

</li>

9555

9556

9557

9558

9559

9560

</li>

9561

9562

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

9563

</div>

9564

9565

9566

9567

9568

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

9569

</span>

9570

9571

9572

9573

9574

9575

9576

9577

9578

9579

9580

9581

9582

9583

9584

9585

<p>Inherited from

9586

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

9587

9588

9589

9590

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

9591

9592

</p>

9593

9594

9595

9596

9597

9598

</div>

9599

9600

9601

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

9602

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

9603

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

9604

</div>

9605

9606

9607

9608

<h4>Parameters:</h4>

9609

9610

9611

9612

9613

9614

9615

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

9616

9617

9618

9619

9620

9621

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

9622

</div>

9623

9624

9625

</li>

9626

9627

9628

9629

9630

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

9631

9632

9633

9634

9635

9636

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

9637

</div>

9638

9639

9640

</li>

9641

9642

9643

9644

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

9645

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

9646

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

9647

9648

9649

9650

9651

9652

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

9653

</div>

9654

9655

9656

</li>

9657

9658

9659

9660

9661

9662

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

9663

9664

9665

9666

9667

9668

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

9669

</div>

9670

9671

9672

</li>

9673

9674

</ul>

9675

</div>

9676

9677

9678

9679

9680

<h4>Returns:</h4>

9681

9682

9683

9684

9685

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

9686

9687

A subscription handle capable of detaching the

9688

subscription

9689

9690

</div>

9691

</div>

9692

9693

9694

9695

</div>

9696

9697

9698

9699

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

9700

9701

9702

9703

9704

9705

9706

9707

9708

9709

</li>

9710

9711

9712

9713

9714

9715

</li>

9716

9717

9718

9719

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

9720

9721

</li>

9722

9723

9724

9725

9726

9727

</li>

9728

9729

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

9730

</div>

9731

9732

9733

9734

9735

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

9736

</span>

9737

9738

9739

9740

9741

9742

9743

9744

9745

9746

9747

9748

9749

9750

9751

9752

<p>Inherited from

9753

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

9754

9755

9756

9757

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

9758

9759

</p>

9760

9761

9762

9763

9764

9765

</div>

9766

9767

9768

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

9769

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

9770

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

9771

</div>

9772

9773

9774

9775

<h4>Parameters:</h4>

9776

9777

9778

9779

9780

9781

9782

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

9783

9784

9785

9786

9787

9788

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

9789

</div>

9790

9791

9792

</li>

9793

9794

9795

9796

9797

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

9798

9799

9800

9801

9802

9803

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

9804

</div>

9805

9806

9807

</li>

9808

9809

9810

9811

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

9812

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

9813

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

9814

9815

9816

9817

9818

9819

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

9820

</div>

9821

9822

9823

</li>

9824

9825

9826

9827

9828

9829

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

9830

9831

9832

9833

9834

9835

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

9836

</div>

9837

9838

9839

</li>

9840

9841

</ul>

9842

</div>

9843

9844

9845

9846

9847

<h4>Returns:</h4>

9848

9849

9850

9851

9852

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

9853

9854

A subscription handle capable of detaching that

9855

subscription

9856

9857

</div>

9858

</div>

9859

9860

9861

9862

</div>

9863

9864

9865

9866

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

9867

9868

9869

9870

9871

9872

9873

9874

9875

9876

</li>

9877

9878

9879

9880

9881

9882

</li>

9883

9884

9885

9886

<code>context</code>

9887

9888

</li>

9889

9890

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

9891

</div>

9892

9893

9894

9895

9896

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

9897

</span>

9898

9899

9900

9901

9902

9903

9904

9905

9906

9907

9908

9909

9910

9911

9912

9913

<p>Inherited from

9914

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

9915

9916

9917

9918

<a href="../files/plugin_js_plugin.js.html#l151"><code>plugin/js/plugin.js:151</code></a>

9919

9920

</p>

9921

9922

9923

9924

9925

9926

</div>

9927

9928

9929

<p>Listens for the "on" moment of events fired by the host object.</p>

9930

9931

<p>Listeners attached through this method will be detached when the plugin is unplugged.</p>

9932

</div>

9933

9934

9935

9936

<h4>Parameters:</h4>

9937

9938

9939

9940

9941

9942

9943

9944

9945

9946

9947

9948

9949

<p>The event type.</p>

9950

</div>

9951

9952

9953

</li>

9954

9955

9956

9957

9958

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

9959

9960

9961

9962

9963

9964

<p>The listener.</p>

9965

</div>

9966

9967

9968

</li>

9969

9970

9971

9972

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

9973

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

9974

9975

9976

9977

9978

9979

<p>The execution context. Defaults to the plugin instance.</p>

9980

</div>

9981

9982

9983

</li>

9984

9985

</ul>

9986

</div>

9987

9988

9989

9990

9991

<h4>Returns:</h4>

9992

9993

9994

9995

9996

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

9997

9998

handle The detach handle for the listener.

9999

10000

</div>

10001

</div>

10002

10003

10004

10005

</div>

10006

10007

10008

10009

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

10010

10011

10012

10013

10014

10015

10016

10017

10018

10019

</li>

10020

10021

10022

10023

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

10024

10025

</li>

10026

10027

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

10028

</div>

10029

10030

10031

10032

10033

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

10034

</span>

10035

10036

10037

10038

10039

10040

10041

10042

10043

10044

10045

10046

10047

10048

10049

10050

<p>Inherited from

10051

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

10052

10053

10054

10055

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

10056

10057

</p>

10058

10059

10060

10061

10062

10063

<p>Available since 3.3.0</p>

10064

10065

</div>

10066

10067

10068

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

10069

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

10070

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

10071

to include the prefix one is supplied or the event target

10072

is configured with a default prefix.</p>

10073

</div>

10074

10075

10076

10077

<h4>Parameters:</h4>

10078

10079

10080

10081

10082

10083

10084

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

10085

10086

10087

10088

10089

10090

10091

</div>

10092

10093

10094

</li>

10095

10096

10097

10098

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

10099

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

10100

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

10101

10102

10103

10104

10105

10106

<p>the prefix</p>

10107

</div>

10108

10109

10110

</li>

10111

10112

</ul>

10113

</div>

10114

10115

10116

10117

10118

<h4>Returns:</h4>

10119

10120

10121

10122

10123

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Array" class="crosslink external" target="_blank">Array</a></span>:

10124

10125

an array containing:

10126

* the detach category, if supplied,

10127

* the prefixed event type,

10128

* whether or not this is an after listener,

10129

* the supplied event type

10130

10131

</div>

10132

</div>

10133

10134

10135

10136

</div>

10137

10138

10139

10140

<h3 class="name"><code>publish</code></h3>

10141

10142

10143

10144

10145

10146

10147

10148

10149

10150

</li>

10151

10152

10153

10154

10155

10156

</li>

10157

10158

</ul><span class="paren">)</span>

10159

</div>

10160

10161

10162

10163

10164

<span class="type"><a href="../classes/CustomEvent.html" class="crosslink">CustomEvent</a></span>

10165

</span>

10166

10167

10168

10169

10170

10171

10172

10173

10174

10175

10176

10177

10178

10179

10180

10181

<p>Inherited from

10182

<a href="../classes/EventTarget.html#method_publish">EventTarget</a>:

10183

10184

10185

10186

<a href="../files/event-custom_js_event-target.js.html#l489"><code>event-custom/js/event-target.js:489</code></a>

10187

10188

</p>

10189

10190

10191

10192

10193

10194

</div>

10195

10196

10197

<p>Creates a new custom event of the specified type. If a custom event

10198

by that name already exists, it will not be re-created. In either

10199

case the custom event is returned.</p>

10200

</div>

10201

10202

10203

10204

<h4>Parameters:</h4>

10205

10206

10207

10208

10209

10210

10211

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

10212

10213

10214

10215

10216

10217

<p>the type, or name of the event</p>

10218

</div>

10219

10220

10221

</li>

10222

10223

10224

10225

10226

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>

10227

10228

10229

10230

10231

10232

<p>optional config params. Valid properties are:</p>

10233

10234

<p><ul>

10235

<li>

10236

'broadcast': whether or not the YUI instance and YUI global are notified when the event is fired (false)

10237

</li>

10238

<li>

10239

'bubbles': whether or not this event bubbles (true)

10240

Events can only bubble if emitFacade is true.

10241

</li>

10242

<li>

10243

'context': the default execution context for the listeners (this)

10244

</li>

10245

<li>

10246

'defaultFn': the default function to execute when this event fires if preventDefault was not called

10247

</li>

10248

<li>

10249

'emitFacade': whether or not this event emits a facade (false)

10250

</li>

10251

<li>

10252

'prefix': the prefix for this targets events, e.g., 'menu' in 'menu:click'

10253

</li>

10254

<li>

10255

'fireOnce': if an event is configured to fire once, new subscribers after

10256

the fire will be notified immediately.

10257

</li>

10258

<li>

10259

'async': fireOnce event listeners will fire synchronously if the event has already

10260

fired unless async is true.

10261

</li>

10262

<li>

10263

'preventable': whether or not preventDefault() has an effect (true)

10264

</li>

10265

<li>

10266

'preventedFn': a function that is executed when preventDefault is called

10267

</li>

10268

<li>

10269

'queuable': whether or not this event can be queued during bubbling (false)

10270

</li>

10271

<li>

10272

'silent': if silent is true, debug messages are not provided for this event.

10273

</li>

10274

<li>

10275

'stoppedFn': a function that is executed when stopPropagation is called

10276

</li></p>

10277

10278

<p><li>

10279

'monitored': specifies whether or not this event should send notifications about

10280

when the event has been attached, detached, or published.

10281

</li>

10282

<li>

10283

'type': the event type (valid option if not provided as the first parameter to publish)

10284

</li>

10285

</ul></p>

10286

</div>

10287

10288

10289

</li>

10290

10291

</ul>

10292

</div>

10293

10294

10295

10296

10297

<h4>Returns:</h4>

10298

10299

10300

10301

10302

<span class="type"><a href="../classes/CustomEvent.html" class="crosslink">CustomEvent</a></span>:

10303

10304

the custom event

10305

10306

</div>

10307

</div>

10308

10309

10310

10311

</div>

10312

10313

10314

10315

<h3 class="name"><code>removeAttr</code></h3>

10316

10317

10318

10319

10320

10321

10322

10323

10324

10325

</li>

10326

10327

</ul><span class="paren">)</span>

10328

</div>

10329

10330

10331

10332

10333

10334

10335

10336

10337

10338

10339

10340

10341

10342

10343

10344

10345

10346

<p>Inherited from

10347

<a href="../classes/AttributeExtras.html#method_removeAttr">AttributeExtras</a>:

10348

10349

10350

10351

<a href="../files/attribute_js_AttributeExtras.js.html#l77"><code>attribute/js/AttributeExtras.js:77</code></a>

10352

10353

</p>

10354

10355

10356

10357

10358

10359

</div>

10360

10361

10362

<p>Removes an attribute from the host object</p>

10363

</div>

10364

10365

10366

10367

<h4>Parameters:</h4>

10368

10369

10370

10371

10372

10373

10374

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

10375

10376

10377

10378

10379

10380

<p>The name of the attribute to be removed.</p>

10381

</div>

10382

10383

10384

</li>

10385

10386

</ul>

10387

</div>

10388

10389

10390

10391

10392

10393

</div>

10394

10395

10396

10397

<h3 class="name"><code>removeTarget</code></h3>

10398

10399

10400

10401

10402

10403

10404

10405

10406

10407

</li>

10408

10409

</ul><span class="paren">)</span>

10410

</div>

10411

10412

10413

10414

10415

10416

10417

10418

10419

10420

10421

10422

10423

10424

10425

10426

10427

10428

<p>Inherited from

10429

<a href="../classes/EventTarget.html#method_removeTarget">EventTarget</a>:

10430

10431

10432

10433

<a href="../files/event-custom_js_event-facade.js.html#l409"><code>event-custom/js/event-facade.js:409</code></a>

10434

10435

</p>

10436

10437

10438

10439

10440

10441

</div>

10442

10443

10444

<p>Removes a bubble target</p>

10445

</div>

10446

10447

10448

10449

<h4>Parameters:</h4>

10450

10451

10452

10453

10454

10455

10456

<span class="type"><a href="../classes/EventTarget.html" class="crosslink">EventTarget</a></span>

10457

10458

10459

10460

10461

10462

<p>the target to remove</p>

10463

</div>

10464

10465

10466

</li>

10467

10468

</ul>

10469

</div>

10470

10471

10472

10473

10474

10475

</div>

10476

10477

10478

10479

<h3 class="name"><code>reset</code></h3>

10480

10481

10482

10483

10484

10485

10486

10487

10488

10489

</li>

10490

10491

</ul><span class="paren">)</span>

10492

</div>

10493

10494

10495

10496

10497

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>

10498

</span>

10499

10500

10501

10502

10503

10504

10505

10506

10507

10508

10509

10510

<span class="flag chainable">chainable</span>

10511

10512

10513

10514

10515

10516

<p>Inherited from

10517

<a href="../classes/AttributeExtras.html#method_reset">AttributeExtras</a>:

10518

10519

10520

10521

<a href="../files/attribute_js_AttributeExtras.js.html#l87"><code>attribute/js/AttributeExtras.js:87</code></a>

10522

10523

</p>

10524

10525

10526

10527

10528

10529

</div>

10530

10531

10532

<p>Resets the attribute (or all attributes) to its initial value, as long as

10533

the attribute is not readOnly, or writeOnce.</p>

10534

</div>

10535

10536

10537

10538

<h4>Parameters:</h4>

10539

10540

10541

10542

10543

10544

10545

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

10546

10547

10548

10549

10550

10551

<p>Optional. The name of the attribute to reset. If omitted, all attributes are reset.</p>

10552

</div>

10553

10554

10555

</li>

10556

10557

</ul>

10558

</div>

10559

10560

10561

10562

10563

<h4>Returns:</h4>

10564

10565

10566

10567

10568

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>:

10569

10570

A reference to the host object.

10571

10572

</div>

10573

</div>

10574

10575

10576

10577

</div>

10578

10579

10580

10581

<h3 class="name"><code>retrieve</code></h3>

10582

10583

10584

10585

10586

10587

10588

10589

<code>request</code>

10590

10591

</li>

10592

10593

</ul><span class="paren">)</span>

10594

</div>

10595

10596

10597

10598

10599

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>

10600

</span>

10601

10602

10603

10604

10605

10606

10607

10608

10609

10610

10611

10612

10613

10614

10615

10616

<p>Inherited from

10617

<a href="../classes/Cache.html#method_retrieve">Cache</a>:

10618

10619

10620

10621

<a href="../files/cache_js_cache-base.js.html#l393"><code>cache/js/cache-base.js:393</code></a>

10622

10623

</p>

10624

10625

10626

10627

10628

10629

</div>

10630

10631

10632

<p>Retrieves cached object for given request, if available, and refreshes

10633

entry in the cache. Returns null if there is no cache match.</p>

10634

</div>

10635

10636

10637

10638

<h4>Parameters:</h4>

10639

10640

10641

10642

10643

10644

<code class="param-name">request</code>

10645

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>

10646

10647

10648

10649

10650

10651

<p>Request object.</p>

10652

</div>

10653

10654

10655

</li>

10656

10657

</ul>

10658

</div>

10659

10660

10661

10662

10663

<h4>Returns:</h4>

10664

10665

10666

10667

10668

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>:

10669

10670

Cached object with the properties request and response, or null.

10671

10672

</div>

10673

</div>

10674

10675

10676

10677

</div>

10678

10679

10680

10681

10682

10683

10684

10685

10686

10687

10688

10689

10690

10691

</li>

10692

10693

10694

10695

<code>value</code>

10696

10697

</li>

10698

10699

10700

10701

10702

10703

</li>

10704

10705

</ul><span class="paren">)</span>

10706

</div>

10707

10708

10709

10710

10711

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>

10712

</span>

10713

10714

10715

10716

10717

10718

10719

10720

10721

10722

10723

10724

<span class="flag chainable">chainable</span>

10725

10726

10727

10728

10729

<p>Inherited from

10730

10731

AttributeCore

10732

</a>

10733

10734

but overwritten in

10735

10736

10737

10738

<a href="../files/attribute_js_AttributeEvents.js.html#l41"><code>attribute/js/AttributeEvents.js:41</code></a>

10739

10740

</p>

10741

10742

10743

10744

10745

10746

</div>

10747

10748

10749

<p>Sets the value of an attribute.</p>

10750

</div>

10751

10752

10753

10754

<h4>Parameters:</h4>

10755

10756

10757

10758

10759

10760

10761

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

10762

10763

10764

10765

10766

10767

<p>The name of the attribute. If the

10768

current value of the attribute is an Object, dot notation can be used

10769

to set the value of a property within the object (e.g. <code>set("x.y.z", 5)</code>).</p>

10770

</div>

10771

10772

10773

</li>

10774

10775

10776

10777

<code class="param-name">value</code>

10778

10779

10780

10781

10782

10783

10784

<p>The value to set the attribute to.</p>

10785

</div>

10786

10787

10788

</li>

10789

10790

10791

10792

10793

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>

10794

10795

10796

10797

10798

10799

<p>(Optional) Optional event data to be mixed into

10800

the event facade passed to subscribers of the attribute's change event. This

10801

can be used as a flexible way to identify the source of a call to set, allowing

10802

the developer to distinguish between set called internally by the host, vs.

10803

set called externally by the application developer.</p>

10804

</div>

10805

10806

10807

</li>

10808

10809

</ul>

10810

</div>

10811

10812

10813

10814

10815

<h4>Returns:</h4>

10816

10817

10818

10819

10820

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>:

10821

10822

A reference to the host object.

10823

10824

</div>

10825

</div>

10826

10827

10828

10829

</div>

10830

10831

10832

10833

<h3 class="name"><code>setAttrs</code></h3>

10834

10835

10836

10837

10838

10839

10840

10841

<code>attrs</code>

10842

10843

</li>

10844

10845

</ul><span class="paren">)</span>

10846

</div>

10847

10848

10849

10850

10851

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>

10852

</span>

10853

10854

10855

10856

10857

10858

10859

10860

10861

10862

10863

10864

<span class="flag chainable">chainable</span>

10865

10866

10867

10868

10869

<p>Inherited from

10870

10871

AttributeCore

10872

</a>

10873

10874

but overwritten in

10875

10876

10877

10878

<a href="../files/attribute_js_AttributeEvents.js.html#l82"><code>attribute/js/AttributeEvents.js:82</code></a>

10879

10880

</p>

10881

10882

10883

10884

10885

10886

</div>

10887

10888

10889

<p>Sets multiple attribute values.</p>

10890

</div>

10891

10892

10893

10894

<h4>Parameters:</h4>

10895

10896

10897

10898

10899

10900

<code class="param-name">attrs</code>

10901

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>

10902

10903

10904

10905

10906

10907

<p>An object with attributes name/value pairs.</p>

10908

</div>

10909

10910

10911

</li>

10912

10913

</ul>

10914

</div>

10915

10916

10917

10918

10919

<h4>Returns:</h4>

10920

10921

10922

10923

10924

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>:

10925

10926

A reference to the host object.

10927

10928

</div>

10929

</div>

10930

10931

10932

10933

</div>

10934

10935

10936

10937

<h3 class="name"><code>subscribe</code></h3>

10938

10939

10940

10941

10942

10943

10944

10945

10946

<span class="flag deprecated" title="use on">deprecated</span>

10947

10948

10949

10950

10951

10952

10953

10954

10955

10956

10957

10958

10959

10960

<p>Inherited from

10961

<a href="../classes/EventTarget.html#method_subscribe">EventTarget</a>:

10962

10963

10964

10965

<a href="../files/event-custom_js_event-target.js.html#l335"><code>event-custom/js/event-target.js:335</code></a>

10966

10967

</p>

10968

10969

10970

10971

<p>Deprecated: use on</p>

10972

10973

10974

10975

</div>

10976

10977

10978

<p>subscribe to an event</p>

10979

</div>

10980

10981

10982

10983

10984

10985

10986

</div>

10987

10988

10989

10990

<h3 class="name"><code>toString</code></h3>

10991

10992

10993

10994

10995

10996

10997

10998

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

10999

</span>

11000

11001

11002

11003

11004

11005

11006

11007

11008

11009

11010

11011

11012

11013

11014

11015

<p>Inherited from

11016

<a href="../classes/BaseCore.html#method_toString">BaseCore</a>:

11017

11018

11019

11020

<a href="../files/base_js_BaseCore.js.html#l592"><code>base/js/BaseCore.js:592</code></a>

11021

11022

</p>

11023

11024

11025

11026

11027

11028

</div>

11029

11030

11031

<p>Default toString implementation. Provides the constructor NAME

11032

and the instance guid, if set.</p>

11033

</div>

11034

11035

11036

11037

11038

11039

<h4>Returns:</h4>

11040

11041

11042

11043

11044

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>:

11045

11046

String representation for this object

11047

11048

</div>

11049

</div>

11050

11051

11052

11053

</div>

11054

11055

11056

11057

<h3 class="name"><code>unsubscribe</code></h3>

11058

11059

11060

11061

11062

11063

11064

11065

11066

<span class="flag deprecated" title="use detach">deprecated</span>

11067

11068

11069

11070

11071

11072

11073

11074

11075

11076

11077

11078

11079

11080

<p>Inherited from

11081

<a href="../classes/EventTarget.html#method_unsubscribe">EventTarget</a>:

11082

11083

11084

11085

<a href="../files/event-custom_js_event-target.js.html#l455"><code>event-custom/js/event-target.js:455</code></a>

11086

11087

</p>

11088

11089

11090

11091

<p>Deprecated: use detach</p>

11092

11093

11094

11095

</div>

11096

11097

11098

<p>detach a listener</p>

11099

</div>

11100

11101

11102

11103

11104

11105

11106

</div>

11107

11108

11109

11110

<h3 class="name"><code>unsubscribeAll</code></h3>

11111

11112

11113

11114

11115

11116

11117

11118

11119

11120

</li>

11121

11122

</ul><span class="paren">)</span>

11123

</div>

11124

11125

11126

11127

11128

11129

<span class="flag deprecated" title="use detachAll">deprecated</span>

11130

11131

11132

11133

11134

11135

11136

11137

11138

11139

11140

11141

11142

11143

<p>Inherited from

11144

<a href="../classes/EventTarget.html#method_unsubscribeAll">EventTarget</a>:

11145

11146

11147

11148

<a href="../files/event-custom_js_event-target.js.html#l476"><code>event-custom/js/event-target.js:476</code></a>

11149

11150

</p>

11151

11152

11153

11154

<p>Deprecated: use detachAll</p>

11155

11156

11157

11158

</div>

11159

11160

11161

<p>Removes all listeners from the specified event. If the event type

11162

is not specified, all listeners from all hosted custom events will

11163

be removed.</p>

11164

</div>

11165

11166

11167

11168

<h4>Parameters:</h4>

11169

11170

11171

11172

11173

11174

11175

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

11176

11177

11178

11179

11180

11181

<p>The type, or name of the event</p>

11182

</div>

11183

11184

11185

</li>

11186

11187

</ul>

11188

</div>

11189

11190

11191

11192

11193

11194

</div>

11195

11196

11197

</div>

11198

11199

11200

11201

11202

<h2 class="off-left">Properties</h2>

11203

11204

11205

11206

<h3 class="name"><code>_allowAdHocAttrs</code></h3>

11207

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>

11208

11209

11210

11211

11212

<span class="flag protected">protected</span>

11213

11214

11215

11216

11217

11218

11219

11220

11221

11222

<p>Inherited from

11223

<a href="../classes/BaseCore.html#property__allowAdHocAttrs">BaseCore</a>:

11224

11225

11226

11227

<a href="../files/base_js_BaseCore.js.html#l100"><code>base/js/BaseCore.js:100</code></a>

11228

11229

</p>

11230

11231

11232

11233

11234

</div>

11235

11236

11237

<p>This property controls whether or not instances of this class should

11238

allow users to add ad-hoc attributes through the constructor configuration

11239

hash.</p>

11240

11241

<p>AdHoc attributes are attributes which are not defined by the class, and are

11242

not handled by the MyClass.<em>NON</em>ATTRS_CFG</p>

11243

</div>

11244

11245

11246

<p><strong>Default:</strong> undefined (false)</p>

11247

11248

11249

11250

11251

11252

</div>

11253

11254

11255

11256

<h3 class="name"><code>_entries</code></h3>

11257

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object[]</a></span>

11258

11259

11260

11261

11262

<span class="flag private">private</span>

11263

11264

11265

11266

11267

11268

11269

11270

11271

11272

<p>Inherited from

11273

<a href="../classes/Cache.html#property__entries">Cache</a>:

11274

11275

11276

11277

<a href="../files/cache_js_cache-base.js.html#l117"><code>cache/js/cache-base.js:117</code></a>

11278

11279

</p>

11280

11281

11282

11283

11284

</div>

11285

11286

11287

<p>Array of request/response objects indexed chronologically.</p>

11288

</div>

11289

11290

11291

11292

11293

11294

11295

</div>

11296

11297

11298

11299

<h3 class="name"><code>_handles</code></h3>

11300

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Array" class="crosslink external" target="_blank">Array</a></span>

11301

11302

11303

11304

11305

<span class="flag private">private</span>

11306

11307

11308

11309

11310

11311

11312

11313

11314

11315

<p>Inherited from

11316

<a href="../classes/Plugin.Base.html#property__handles">Plugin.Base</a>:

11317

11318

11319

11320

<a href="../files/plugin_js_plugin.js.html#l66"><code>plugin/js/plugin.js:66</code></a>

11321

11322

</p>

11323

11324

11325

11326

11327

</div>

11328

11329

11330

<p>The list of event handles for event listeners or AOP injected methods

11331

applied by the plugin to the host object.</p>

11332

</div>

11333

11334

11335

11336

11337

11338

11339

</div>

11340

11341

11342

11343

11344

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

11345

11346

11347

11348

11349

11350

11351

<span class="flag final">final</span>

11352

11353

11354

11355

<span class="flag static">static</span>

11356

11357

11358

11359

11360

11361

11362

<p>

11363

11364

Defined in

11365

11366

11367

11368

11369

<a href="../files/cache_js_cache-plugin.js.html#l35"><code>cache/js/cache-plugin.js:35</code></a>

11370

11371

</p>

11372

11373

11374

11375

11376

</div>

11377

11378

11379

<p>Class name.</p>

11380

</div>

11381

11382

11383

11384

11385

11386

11387

</div>

11388

11389

11390

11391

11392

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

11393

11394

11395

<span class="flag deprecated" title="Use this.constructor.NAME">deprecated</span>

11396

11397

11398

11399

11400

11401

11402

11403

11404

11405

11406

11407

<p>Inherited from

11408

<a href="../classes/BaseCore.html#property_name">BaseCore</a>:

11409

11410

11411

11412

<a href="../files/base_js_BaseCore.js.html#l196"><code>base/js/BaseCore.js:196</code></a>

11413

11414

</p>

11415

11416

11417

<p>Deprecated: Use this.constructor.NAME</p>

11418

11419

11420

11421

</div>

11422

11423

11424

<p>The string used to identify the class of this object.</p>

11425

</div>

11426

11427

11428

11429

11430

11431

11432

</div>

11433

11434

11435

11436

11437

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

11438

11439

11440

11441

11442

11443

11444

<span class="flag final">final</span>

11445

11446

11447

11448

<span class="flag static">static</span>

11449

11450

11451

11452

11453

11454

11455

<p>

11456

11457

Defined in

11458

11459

11460

11461

11462

<a href="../files/cache_js_cache-plugin.js.html#l23"><code>cache/js/cache-plugin.js:23</code></a>

11463

11464

</p>

11465

11466

11467

11468

11469

</div>

11470

11471

11472

<p>The namespace for the plugin. This will be the property on the host which

11473

references the plugin instance.</p>

11474

</div>

11475

11476

11477

11478

11479

11480

11481

</div>

11482

11483

11484

</div>

11485

11486

11487

11488

11489

<h2 class="off-left">Attributes</h2>

11490

11491

11492

11493

11494

<h3 class="name"><code>destroyed</code></h3>

11495

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>

11496

11497

11498

11499

11500

11501

11502

11503

11504

11505

11506

11507

11508

<p>Inherited from

11509

<a href="../classes/BaseCore.html#attr_destroyed">BaseCore</a>:

11510

11511

11512

11513

<a href="../files/base_js_BaseCore.js.html#l157"><code>base/js/BaseCore.js:157</code></a>

11514

11515

</p>

11516

11517

11518

11519

11520

</div>

11521

11522

11523

<p>Flag indicating whether or not this object

11524

has been through the destroy lifecycle phase.</p>

11525

</div>

11526

11527

11528

<p><strong>Default:</strong> false</p>

11529

11530

11531

11532

11533

<h4>Fires event <code>destroyedChange</code></h4>

11534

11535

<p>

11536

Fires when the value for the configuration attribute <code>destroyed</code> is

11537

changed. You can listen for the event using the <code>on</code> method if you

11538

wish to be notified before the attribute's value has changed, or

11539

using the <code>after</code> method if you wish to be notified after the

11540

attribute's value has changed.

11541

</p>

11542

11543

11544

<h4>Parameters:</h4>

11545

11546

11547

11548

11549

<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>

11550

11551

11552

An Event Facade object with the following

11553

attribute-specific properties added:

11554

</div>

11555

11556

11557

11558

<code class="param-name">prevVal</code>

11559

11560

<div class="param-description">The value of the attribute, prior to it being set.</div>

11561

</li>

11562

11563

<code class="param-name">newVal</code>

11564

11565

<div class="param-description">The value the attribute is to be set to.</div>

11566

</li>

11567

11568

<code class="param-name">attrName</code>

11569

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

11570

<div class="param-description">The name of the attribute being set.</div>

11571

</li>

11572

11573

<code class="param-name">subAttrName</code>

11574

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

11575

<div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div>

11576

</li>

11577

</ul>

11578

</li>

11579

</ul>

11580

</div>

11581

</div>

11582

11583

11584

11585

</div>

11586

11587

11588

11589

11590

<h3 class="name"><code>entries</code></h3>

11591

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Array" class="crosslink external" target="_blank">Array</a></span>

11592

11593

11594

11595

11596

11597

11598

11599

11600

11601

11602

11603

11604

<p>Inherited from

11605

<a href="../classes/Cache.html#attr_entries">Cache</a>:

11606

11607

11608

11609

<a href="../files/cache_js_cache-base.js.html#l98"><code>cache/js/cache-base.js:98</code></a>

11610

11611

</p>

11612

11613

11614

11615

11616

</div>

11617

11618

11619

<p>Cached entries.</p>

11620

</div>

11621

11622

11623

11624

11625

11626

<h4>Fires event <code>entriesChange</code></h4>

11627

11628

<p>

11629

Fires when the value for the configuration attribute <code>entries</code> is

11630

changed. You can listen for the event using the <code>on</code> method if you

11631

wish to be notified before the attribute's value has changed, or

11632

using the <code>after</code> method if you wish to be notified after the

11633

attribute's value has changed.

11634

</p>

11635

11636

11637

<h4>Parameters:</h4>

11638

11639

11640

11641

11642

<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>

11643

11644

11645

An Event Facade object with the following

11646

attribute-specific properties added:

11647

</div>

11648

11649

11650

11651

<code class="param-name">prevVal</code>

11652

11653

<div class="param-description">The value of the attribute, prior to it being set.</div>

11654

</li>

11655

11656

<code class="param-name">newVal</code>

11657

11658

<div class="param-description">The value the attribute is to be set to.</div>

11659

</li>

11660

11661

<code class="param-name">attrName</code>

11662

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

11663

<div class="param-description">The name of the attribute being set.</div>

11664

</li>

11665

11666

<code class="param-name">subAttrName</code>

11667

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

11668

<div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div>

11669

</li>

11670

</ul>

11671

</li>

11672

</ul>

11673

</div>

11674

</div>

11675

11676

11677

11678

</div>

11679

11680

11681

11682

11683

<h3 class="name"><code>expires</code></h3>

11684

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Date" class="crosslink external" target="_blank">Date</a> | <a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Number" class="crosslink external" target="_blank">Number</a></span>

11685

11686

11687

11688

11689

11690

11691

11692

11693

11694

11695

11696

11697

<p>Inherited from

11698

<a href="../classes/Cache.html#attr_expires">Cache</a>:

11699

11700

11701

11702

<a href="../files/cache_js_cache-base.js.html#l84"><code>cache/js/cache-base.js:84</code></a>

11703

11704

</p>

11705

11706

11707

11708

11709

</div>

11710

11711

11712

<p>Absolute Date when data expires or

11713

relative number of milliseconds. Zero disables expiration.</p>

11714

</div>

11715

11716

11717

<p><strong>Default:</strong> 0</p>

11718

11719

11720

11721

11722

<h4>Fires event <code>expiresChange</code></h4>

11723

11724

<p>

11725

Fires when the value for the configuration attribute <code>expires</code> is

11726

changed. You can listen for the event using the <code>on</code> method if you

11727

wish to be notified before the attribute's value has changed, or

11728

using the <code>after</code> method if you wish to be notified after the

11729

attribute's value has changed.

11730

</p>

11731

11732

11733

<h4>Parameters:</h4>

11734

11735

11736

11737

11738

<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>

11739

11740

11741

An Event Facade object with the following

11742

attribute-specific properties added:

11743

</div>

11744

11745

11746

11747

<code class="param-name">prevVal</code>

11748

11749

<div class="param-description">The value of the attribute, prior to it being set.</div>

11750

</li>

11751

11752

<code class="param-name">newVal</code>

11753

11754

<div class="param-description">The value the attribute is to be set to.</div>

11755

</li>

11756

11757

<code class="param-name">attrName</code>

11758

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

11759

<div class="param-description">The name of the attribute being set.</div>

11760

</li>

11761

11762

<code class="param-name">subAttrName</code>

11763

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

11764

<div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div>

11765

</li>

11766

</ul>

11767

</li>

11768

</ul>

11769

</div>

11770

</div>

11771

11772

11773

11774

</div>

11775

11776

11777

11778

11779

11780

<span class="type"><a href="../classes/Plugin.Host.html" class="crosslink">Plugin.Host</a></span>

11781

11782

11783

11784

11785

11786

11787

11788

11789

11790

11791

11792

11793

<p>Inherited from

11794

<a href="../classes/Plugin.Base.html#attr_host">Plugin.Base</a>:

11795

11796

11797

11798

<a href="../files/plugin_js_plugin.js.html#l31"><code>plugin/js/plugin.js:31</code></a>

11799

11800

</p>

11801

11802

11803

11804

11805

</div>

11806

11807

11808

<p>The plugin's host object.</p>

11809

</div>

11810

11811

11812

11813

11814

11815

<h4>Fires event <code>hostChange</code></h4>

11816

11817

<p>

11818

Fires when the value for the configuration attribute <code>host</code> is

11819

changed. You can listen for the event using the <code>on</code> method if you

11820

wish to be notified before the attribute's value has changed, or

11821

using the <code>after</code> method if you wish to be notified after the

11822

attribute's value has changed.

11823

</p>

11824

11825

11826

<h4>Parameters:</h4>

11827

11828

11829

11830

11831

<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>

11832

11833

11834

An Event Facade object with the following

11835

attribute-specific properties added:

11836

</div>

11837

11838

11839

11840

<code class="param-name">prevVal</code>

11841

11842

<div class="param-description">The value of the attribute, prior to it being set.</div>

11843

</li>

11844

11845

<code class="param-name">newVal</code>

11846

11847

<div class="param-description">The value the attribute is to be set to.</div>

11848

</li>

11849

11850

<code class="param-name">attrName</code>

11851

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

11852

<div class="param-description">The name of the attribute being set.</div>

11853

</li>

11854

11855

<code class="param-name">subAttrName</code>

11856

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

11857

<div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div>

11858

</li>

11859

</ul>

11860

</li>

11861

</ul>

11862

</div>

11863

</div>

11864

11865

11866

11867

</div>

11868

11869

11870

11871

11872

<h3 class="name"><code>initialized</code></h3>

11873

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>

11874

11875

11876

11877

11878

11879

11880

11881

11882

11883

11884

11885

11886

<p>Inherited from

11887

<a href="../classes/BaseCore.html#attr_initialized">BaseCore</a>:

11888

11889

11890

11891

<a href="../files/base_js_BaseCore.js.html#l143"><code>base/js/BaseCore.js:143</code></a>

11892

11893

</p>

11894

11895

11896

11897

11898

</div>

11899

11900

11901

<p>Flag indicating whether or not this object

11902

has been through the init lifecycle phase.</p>

11903

</div>

11904

11905

11906

<p><strong>Default:</strong> false</p>

11907

11908

11909

11910

11911

<h4>Fires event <code>initializedChange</code></h4>

11912

11913

<p>

11914

Fires when the value for the configuration attribute <code>initialized</code> is

11915

changed. You can listen for the event using the <code>on</code> method if you

11916

wish to be notified before the attribute's value has changed, or

11917

using the <code>after</code> method if you wish to be notified after the

11918

attribute's value has changed.

11919

</p>

11920

11921

11922

<h4>Parameters:</h4>

11923

11924

11925

11926

11927

<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>

11928

11929

11930

An Event Facade object with the following

11931

attribute-specific properties added:

11932

</div>

11933

11934

11935

11936

<code class="param-name">prevVal</code>

11937

11938

<div class="param-description">The value of the attribute, prior to it being set.</div>

11939

</li>

11940

11941

<code class="param-name">newVal</code>

11942

11943

<div class="param-description">The value the attribute is to be set to.</div>

11944

</li>

11945

11946

<code class="param-name">attrName</code>

11947

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

11948

<div class="param-description">The name of the attribute being set.</div>

11949

</li>

11950

11951

<code class="param-name">subAttrName</code>

11952

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

11953

<div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div>

11954

</li>

11955

</ul>

11956

</li>

11957

</ul>

11958

</div>

11959

</div>

11960

11961

11962

11963

</div>

11964

11965

11966

11967

11968

11969

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Number" class="crosslink external" target="_blank">Number</a></span>

11970

11971

11972

11973

11974

11975

11976

11977

11978

11979

11980

11981

11982

<p>Inherited from

11983

<a href="../classes/Cache.html#attr_max">Cache</a>:

11984

11985

11986

11987

<a href="../files/cache_js_cache-base.js.html#l52"><code>cache/js/cache-base.js:52</code></a>

11988

11989

</p>

11990

11991

11992

11993

11994

</div>

11995

11996

11997

<p>Maximum number of entries the Cache can hold.

11998

Set to 0 to turn off caching.</p>

11999

</div>

12000

12001

12002

<p><strong>Default:</strong> 0</p>

12003

12004

12005

12006

12007

<h4>Fires event <code>maxChange</code></h4>

12008

12009

<p>

12010

Fires when the value for the configuration attribute <code>max</code> is

12011

changed. You can listen for the event using the <code>on</code> method if you

12012

wish to be notified before the attribute's value has changed, or

12013

using the <code>after</code> method if you wish to be notified after the

12014

attribute's value has changed.

12015

</p>

12016

12017

12018

<h4>Parameters:</h4>

12019

12020

12021

12022

12023

<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>

12024

12025

12026

An Event Facade object with the following

12027

attribute-specific properties added:

12028

</div>

12029

12030

12031

12032

<code class="param-name">prevVal</code>

12033

12034

<div class="param-description">The value of the attribute, prior to it being set.</div>

12035

</li>

12036

12037

<code class="param-name">newVal</code>

12038

12039

<div class="param-description">The value the attribute is to be set to.</div>

12040

</li>

12041

12042

<code class="param-name">attrName</code>

12043

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

12044

<div class="param-description">The name of the attribute being set.</div>

12045

</li>

12046

12047

<code class="param-name">subAttrName</code>

12048

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

12049

<div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div>

12050

</li>

12051

</ul>

12052

</li>

12053

</ul>

12054

</div>

12055

</div>

12056

12057

12058

12059

</div>

12060

12061

12062

12063

12064

12065

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Number" class="crosslink external" target="_blank">Number</a></span>

12066

12067

12068

12069

12070

12071

12072

12073

12074

12075

12076

12077

12078

<p>Inherited from

12079

<a href="../classes/Cache.html#attr_size">Cache</a>:

12080

12081

12082

12083

<a href="../files/cache_js_cache-base.js.html#l64"><code>cache/js/cache-base.js:64</code></a>

12084

12085

</p>

12086

12087

12088

12089

12090

</div>

12091

12092

12093

<p>Number of entries currently cached.</p>

12094

</div>

12095

12096

12097

12098

12099

12100

<h4>Fires event <code>sizeChange</code></h4>

12101

12102

<p>

12103

Fires when the value for the configuration attribute <code>size</code> is

12104

changed. You can listen for the event using the <code>on</code> method if you

12105

wish to be notified before the attribute's value has changed, or

12106

using the <code>after</code> method if you wish to be notified after the

12107

attribute's value has changed.

12108

</p>

12109

12110

12111

<h4>Parameters:</h4>

12112

12113

12114

12115

12116

<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>

12117

12118

12119

An Event Facade object with the following

12120

attribute-specific properties added:

12121

</div>

12122

12123

12124

12125

<code class="param-name">prevVal</code>

12126

12127

<div class="param-description">The value of the attribute, prior to it being set.</div>

12128

</li>

12129

12130

<code class="param-name">newVal</code>

12131

12132

<div class="param-description">The value the attribute is to be set to.</div>

12133

</li>

12134

12135

<code class="param-name">attrName</code>

12136

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

12137

<div class="param-description">The name of the attribute being set.</div>

12138

</li>

12139

12140

<code class="param-name">subAttrName</code>

12141

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

12142

<div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div>

12143

</li>

12144

</ul>

12145

</li>

12146

</ul>

12147

</div>

12148

</div>

12149

12150

12151

12152

</div>

12153

12154

12155

12156

12157

<h3 class="name"><code>uniqueKeys</code></h3>

12158

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>

12159

12160

12161

12162

12163

12164

12165

12166

12167

12168

12169

12170

12171

<p>Inherited from

12172

<a href="../classes/Cache.html#attr_uniqueKeys">Cache</a>:

12173

12174

12175

12176

<a href="../files/cache_js_cache-base.js.html#l74"><code>cache/js/cache-base.js:74</code></a>

12177

12178

</p>

12179

12180

12181

12182

12183

</div>

12184

12185

12186

<p>Validate uniqueness of stored keys. Default is false and

12187

is more performant.</p>

12188

</div>

12189

12190

12191

12192

12193

12194

<h4>Fires event <code>uniqueKeysChange</code></h4>

12195

12196

<p>

12197

Fires when the value for the configuration attribute <code>uniqueKeys</code> is

12198

changed. You can listen for the event using the <code>on</code> method if you

12199

wish to be notified before the attribute's value has changed, or

12200

using the <code>after</code> method if you wish to be notified after the

12201

attribute's value has changed.

12202

</p>

12203

12204

12205

<h4>Parameters:</h4>

12206

12207

12208

12209

12210

<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>

12211

12212

12213

An Event Facade object with the following

12214

attribute-specific properties added:

12215

</div>

12216

12217

12218

12219

<code class="param-name">prevVal</code>

12220

12221

<div class="param-description">The value of the attribute, prior to it being set.</div>

12222

</li>

12223

12224

<code class="param-name">newVal</code>

12225

12226

<div class="param-description">The value the attribute is to be set to.</div>

12227

</li>

12228

12229

<code class="param-name">attrName</code>

12230

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

12231

<div class="param-description">The name of the attribute being set.</div>

12232

</li>

12233

12234

<code class="param-name">subAttrName</code>

12235

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

12236

<div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div>

12237

</li>

12238

</ul>

12239

</li>

12240

</ul>

12241

</div>

12242

</div>

12243

12244

12245

12246

</div>

12247

12248

12249

</div>

12250

12251

12252

12253

12254

<h2 class="off-left">Events</h2>

12255

12256

12257

12258

12259

12260

12261

12262

12263

12264

12265

12266

12267

12268

12269

12270

12271

12272

<p>Inherited from

12273

<a href="../classes/Cache.html#event_add">Cache</a>:

12274

12275

12276

12277

<a href="../files/cache_js_cache-base.js.html#l140"><code>cache/js/cache-base.js:140</code></a>

12278

12279

</p>

12280

12281

12282

12283

12284

</div>

12285

12286

12287

<p>Fired when an entry is added.</p>

12288

</div>

12289

12290

12291

12292

<h4>Event Payload:</h4>

12293

12294

12295

12296

12297

12298

12299

<span class="type"><a href="../classes/EventFacade.html" class="crosslink">Event.Facade</a></span>

12300

12301

12302

12303

12304

12305

<p>Event Facade with the following properties:</p>

12306

12307

<dl>

12308

<dt>entry (Object)</dt> <dd>The cached entry.</dd>

12309

</dl>

12310

</div>

12311

12312

12313

</li>

12314

12315

</ul>

12316

</div>

12317

12318

12319

12320

12321

</div>

12322

12323

12324

12325

<h3 class="name"><code>destroy</code></h3>

12326

12327

12328

12329

12330

12331

12332

12333

12334

12335

12336

12337

12338

12339

<p>Inherited from

12340

<a href="../classes/Base.html#event_destroy">Base</a>:

12341

12342

12343

12344

12345

12346

</p>

12347

12348

12349

12350

12351

</div>

12352

12353

12354

<p>

12355

Lifecycle event for the destroy phase,

12356

fired prior to destruction. Invoking the preventDefault

12357

method on the event object provided to subscribers will

12358

prevent destruction from proceeding.

12359

</p>

12360

12361

<p>

12362

Subscribers to the "after" moment of this event, will be notified

12363

after destruction is complete (and as a result cannot prevent

12364

destruction).

12365

</p>

12366

</div>

12367

12368

12369

12370

<h4>Event Payload:</h4>

12371

12372

12373

12374

12375

12376

12377

<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>

12378

12379

12380

12381

12382

12383

<p>Event object</p>

12384

</div>

12385

12386

12387

</li>

12388

12389

</ul>

12390

</div>

12391

12392

12393

12394

12395

</div>

12396

12397

12398

12399

<h3 class="name"><code>flush</code></h3>

12400

12401

12402

12403

12404

12405

12406

12407

12408

12409

12410

12411

12412

12413

<p>Inherited from

12414

<a href="../classes/Cache.html#event_flush">Cache</a>:

12415

12416

12417

12418

<a href="../files/cache_js_cache-base.js.html#l151"><code>cache/js/cache-base.js:151</code></a>

12419

12420

</p>

12421

12422

12423

12424

12425

</div>

12426

12427

12428

<p>Fired when the cache is flushed.</p>

12429

</div>

12430

12431

12432

12433

<h4>Event Payload:</h4>

12434

12435

12436

12437

12438

12439

12440

<span class="type"><a href="../classes/EventFacade.html" class="crosslink">Event.Facade</a></span>

12441

12442

12443

12444

12445

12446

<p>Event Facade object.</p>

12447

</div>

12448

12449

12450

</li>

12451

12452

</ul>

12453

</div>

12454

12455

12456

12457

12458

</div>

12459

12460

12461

12462

12463

12464

12465

12466

12467

12468

12469

12470

12471

12472

12473

12474

12475

12476

<p>Inherited from

12477

<a href="../classes/Base.html#event_init">Base</a>:

12478

12479

12480

12481

12482

12483

</p>

12484

12485

12486

12487

12488

</div>

12489

12490

12491

<p>

12492

Lifecycle event for the init phase, fired prior to initialization.

12493

Invoking the preventDefault() method on the event object provided

12494

to subscribers will prevent initialization from occuring.

12495

</p>

12496

12497

<p>

12498

Subscribers to the "after" momemt of this event, will be notified

12499

after initialization of the object is complete (and therefore

12500

cannot prevent initialization).

12501

</p>

12502

</div>

12503

12504

12505

12506

<h4>Event Payload:</h4>

12507

12508

12509

12510

12511

12512

12513

<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>

12514

12515

12516

12517

12518

12519

<p>Event object, with a cfg property which

12520

refers to the configuration object passed to the constructor.</p>

12521

</div>

12522

12523

12524

</li>

12525

12526

</ul>

12527

</div>

12528

12529

12530

12531

12532

</div>

12533

12534

12535

12536

<h3 class="name"><code>request</code></h3>

12537

12538

12539

12540

12541

12542

12543

12544

12545

12546

12547

12548

12549

12550

<p>Inherited from

12551

<a href="../classes/Cache.html#event_request">Cache</a>:

12552

12553

12554

12555

<a href="../files/cache_js_cache-base.js.html#l159"><code>cache/js/cache-base.js:159</code></a>

12556

12557

</p>

12558

12559

12560

12561

12562

</div>

12563

12564

12565

<p>Fired when an entry is requested from the cache.</p>

12566

</div>

12567

12568

12569

12570

<h4>Event Payload:</h4>

12571

12572

12573

12574

12575

12576

12577

<span class="type"><a href="../classes/EventFacade.html" class="crosslink">Event.Facade</a></span>

12578

12579

12580

12581

12582

12583

<p>Event Facade with the following properties:</p>

12584

12585

<dl>

12586

<dt>request (Object)</dt> <dd>The request object.</dd>

12587

</dl>

12588

</div>

12589

12590

12591

</li>

12592

12593

</ul>

12594

</div>

12595

12596

12597

12598

12599

</div>

12600

12601

12602

12603

<h3 class="name"><code>retrieve</code></h3>

12604

12605

12606

12607

12608

12609

12610

12611

12612

12613

12614

12615

12616

12617

<p>Inherited from

12618

<a href="../classes/Cache.html#event_retrieve">Cache</a>:

12619

12620

12621

12622

<a href="../files/cache_js_cache-base.js.html#l168"><code>cache/js/cache-base.js:168</code></a>

12623

12624

</p>

12625

12626

12627

12628

12629

</div>

12630

12631

12632

<p>Fired when an entry is retrieved from the cache.</p>

12633

</div>

12634

12635

12636

12637

<h4>Event Payload:</h4>

12638

12639

12640

12641

12642

12643

12644

<span class="type"><a href="../classes/EventFacade.html" class="crosslink">Event.Facade</a></span>

12645

12646

12647

12648

12649

12650

<p>Event Facade with the following properties:</p>

12651

12652

<dl>

12653

<dt>entry (Object)</dt> <dd>The retrieved entry.</dd>

12654

</dl>

12655

</div>

12656

12657

12658

</li>

12659

12660

</ul>

12661

</div>

12662

12663

12664

12665

12666

</div>

12667

12668

12669

</div>

12670

12671

</div>

12672

</div>

12673

12674

</div>

12675

</div>

12676

</div>

12677

</div>

12678

</div>

12679

</div>

12680

12681

12682

12683

12684

12685

12686

12687

12688

</body>

12689

</html>

Older »