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

2076

2077

2078

2079

2080

2081

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

2082

</div>

2083

2084

2085

</li>

2086

2087

2088

2089

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

2090

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

2091

2092

2093

2094

2095

2096

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

2097

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

2098

</div>

2099

2100

2101

</li>

2102

2103

2104

2105

2106

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

2107

2108

2109

2110

2111

2112

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

2113

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

2114

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

2115

</div>

2116

2117

2118

</li>

2119

2120

</ul>

2121

</div>

2122

2123

2124

2125

2126

2127

</div>

2128

2129

2130

2131

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

2132

2133

2134

2135

2136

2137

2138

2139

2140

2141

</li>

2142

2143

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

2144

</div>

2145

2146

2147

2148

2149

2150

2151

2152

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

2153

2154

2155

2156

2157

2158

2159

2160

2161

2162

2163

2164

<p>Inherited from

2165

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

2166

2167

2168

2169

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

2170

2171

</p>

2172

2173

2174

2175

2176

2177

</div>

2178

2179

2180

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

2181

</div>

2182

2183

2184

2185

<h4>Parameters:</h4>

2186

2187

2188

2189

2190

2191

2192

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

2193

2194

2195

2196

2197

2198

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

2199

</div>

2200

2201

2202

</li>

2203

2204

</ul>

2205

</div>

2206

2207

2208

2209

2210

2211

</div>

2212

2213

2214

2215

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

2216

2217

2218

2219

2220

2221

2222

2223

2224

2225

</li>

2226

2227

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

2228

</div>

2229

2230

2231

2232

2233

2234

2235

2236

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

2237

2238

2239

2240

2241

2242

2243

2244

2245

2246

2247

2248

2249

<p>

2250

2251

Defined in

2252

2253

2254

2255

2256

<a href="../files/calendar_js_calendarnavigator.js.html#l160"><code>calendar/js/calendarnavigator.js:160</code></a>

2257

2258

</p>

2259

2260

2261

2262

2263

2264

</div>

2265

2266

2267

<p>Private utility method that adds months to the host calendar date

2268

based on the control click and the shiftByMonths property.</p>

2269

</div>

2270

2271

2272

2273

<h4>Parameters:</h4>

2274

2275

2276

2277

2278

2279

2280

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

2281

2282

2283

2284

2285

2286

<p>Click event from the controls</p>

2287

</div>

2288

2289

2290

</li>

2291

2292

</ul>

2293

</div>

2294

2295

2296

2297

2298

2299

</div>

2300

2301

2302

2303

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

2304

2305

2306

2307

2308

2309

2310

2311

<code>allAttrs</code>

2312

2313

</li>

2314

2315

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

2316

</div>

2317

2318

2319

2320

2321

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

2322

</span>

2323

2324

2325

2326

2327

2328

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

2329

2330

2331

2332

2333

2334

2335

2336

2337

2338

2339

2340

<p>Inherited from

2341

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

2342

2343

2344

2345

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

2346

2347

</p>

2348

2349

2350

2351

2352

2353

</div>

2354

2355

2356

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

2357

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

2358

2359

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

2360

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

2361

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

2362

</div>

2363

2364

2365

2366

<h4>Parameters:</h4>

2367

2368

2369

2370

2371

2372

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

2373

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

2374

2375

2376

2377

2378

2379

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

2380

(subclass first, Base last)</p>

2381

</div>

2382

2383

2384

</li>

2385

2386

</ul>

2387

</div>

2388

2389

2390

2391

2392

<h4>Returns:</h4>

2393

2394

2395

2396

2397

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

2398

2399

The aggregate set of ATTRS definitions for the instance

2400

2401

</div>

2402

</div>

2403

2404

2405

2406

</div>

2407

2408

2409

2410

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

2411

2412

2413

2414

2415

2416

2417

2418

2419

2420

2421

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

2422

2423

2424

2425

2426

2427

2428

2429

2430

2431

2432

<p>Inherited from

2433

2434

BaseCore

2435

</a>

2436

2437

but overwritten in

2438

2439

2440

2441

2442

2443

</p>

2444

2445

2446

2447

2448

2449

</div>

2450

2451

2452

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

2453

this class.</p>

2454

</div>

2455

2456

2457

2458

2459

2460

2461

</div>

2462

2463

2464

2465

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

2466

2467

2468

2469

2470

2471

2472

2473

2474

2475

2476

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

2477

2478

2479

2480

2481

2482

2483

2484

2485

2486

2487

2488

<p>Inherited from

2489

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

2490

2491

2492

2493

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

2494

2495

</p>

2496

2497

2498

2499

2500

2501

</div>

2502

2503

2504

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

2505

</div>

2506

2507

2508

2509

2510

2511

2512

</div>

2513

2514

2515

2516

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

2517

2518

2519

2520

2521

2522

2523

2524

2525

2526

2527

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

2528

2529

2530

2531

2532

2533

2534

2535

2536

2537

2538

2539

<p>Inherited from

2540

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

2541

2542

2543

2544

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

2545

2546

</p>

2547

2548

2549

2550

2551

2552

</div>

2553

2554

2555

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

2556

</div>

2557

2558

2559

2560

2561

2562

2563

</div>

2564

2565

2566

2567

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

2568

2569

2570

2571

2572

2573

2574

2575

2576

2577

</li>

2578

2579

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

2580

</div>

2581

2582

2583

2584

2585

2586

2587

2588

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

2589

2590

2591

2592

2593

2594

2595

2596

2597

2598

2599

2600

<p>Inherited from

2601

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

2602

2603

2604

2605

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

2606

2607

</p>

2608

2609

2610

2611

2612

2613

</div>

2614

2615

2616

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

2617

</div>

2618

2619

2620

2621

<h4>Parameters:</h4>

2622

2623

2624

2625

2626

2627

2628

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

2629

2630

2631

2632

2633

2634

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

2635

</div>

2636

2637

2638

</li>

2639

2640

</ul>

2641

</div>

2642

2643

2644

2645

2646

2647

</div>

2648

2649

2650

2651

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

2652

2653

2654

2655

2656

2657

2658

2659

2660

2661

</li>

2662

2663

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

2664

</div>

2665

2666

2667

2668

2669

2670

2671

2672

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

2673

2674

2675

2676

2677

2678

2679

2680

2681

2682

2683

2684

<p>Inherited from

2685

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

2686

2687

2688

2689

2690

2691

</p>

2692

2693

2694

2695

2696

2697

</div>

2698

2699

2700

<p>Default destroy event handler</p>

2701

</div>

2702

2703

2704

2705

<h4>Parameters:</h4>

2706

2707

2708

2709

2710

2711

2712

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

2713

2714

2715

2716

2717

2718

<p>Event object</p>

2719

</div>

2720

2721

2722

</li>

2723

2724

</ul>

2725

</div>

2726

2727

2728

2729

2730

2731

</div>

2732

2733

2734

2735

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

2736

2737

2738

2739

2740

2741

2742

2743

2744

2745

</li>

2746

2747

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

2748

</div>

2749

2750

2751

2752

2753

2754

2755

2756

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

2757

2758

2759

2760

2761

2762

2763

2764

2765

2766

2767

2768

<p>Inherited from

2769

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

2770

2771

2772

2773

2774

2775

</p>

2776

2777

2778

2779

2780

2781

</div>

2782

2783

2784

<p>Default init event handler</p>

2785

</div>

2786

2787

2788

2789

<h4>Parameters:</h4>

2790

2791

2792

2793

2794

2795

2796

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

2797

2798

2799

2800

2801

2802

<p>Event object, with a cfg property which

2803

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

2804

</div>

2805

2806

2807

</li>

2808

2809

</ul>

2810

</div>

2811

2812

2813

2814

2815

2816

</div>

2817

2818

2819

2820

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

2821

2822

2823

2824

2825

2826

2827

2828

2829

2830

2831

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

2832

2833

2834

2835

2836

2837

2838

2839

2840

2841

2842

2843

<p>Inherited from

2844

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

2845

2846

2847

2848

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

2849

2850

</p>

2851

2852

2853

2854

2855

2856

</div>

2857

2858

2859

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

2860

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

2861

</div>

2862

2863

2864

2865

2866

2867

2868

</div>

2869

2870

2871

2872

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

2873

2874

2875

2876

2877

2878

2879

2880

<code>allAttrs</code>

2881

2882

</li>

2883

2884

2885

2886

<code>userVals</code>

2887

2888

</li>

2889

2890

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

2891

</div>

2892

2893

2894

2895

2896

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

2897

</span>

2898

2899

2900

2901

2902

2903

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

2904

2905

2906

2907

2908

2909

2910

2911

2912

2913

2914

2915

<p>Inherited from

2916

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

2917

2918

2919

2920

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

2921

2922

</p>

2923

2924

2925

2926

2927

2928

</div>

2929

2930

2931

2932

</div>

2933

2934

2935

2936

<h4>Parameters:</h4>

2937

2938

2939

2940

2941

2942

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

2943

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

2944

2945

2946

2947

2948

2949

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

2950

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

2951

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

2952

</div>

2953

2954

2955

</li>

2956

2957

2958

2959

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

2960

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

2961

2962

2963

2964

2965

2966

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

2967

</div>

2968

2969

2970

</li>

2971

2972

</ul>

2973

</div>

2974

2975

2976

2977

2978

<h4>Returns:</h4>

2979

2980

2981

2982

2983

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

2984

2985

The set of adhoc attributes passed in, in the form

2986

of an object with attribute name/configuration pairs.

2987

2988

</div>

2989

</div>

2990

2991

2992

2993

</div>

2994

2995

2996

2997

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

2998

2999

3000

3001

3002

3003

3004

3005

<code>clazz</code>

3006

3007

</li>

3008

3009

3010

3011

<code>allCfgs</code>

3012

3013

</li>

3014

3015

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

3016

</div>

3017

3018

3019

3020

3021

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

3022

</span>

3023

3024

3025

3026

3027

3028

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

3029

3030

3031

3032

3033

3034

3035

3036

3037

3038

3039

3040

<p>Inherited from

3041

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

3042

3043

3044

3045

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

3046

3047

</p>

3048

3049

3050

3051

3052

3053

</div>

3054

3055

3056

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

3057

initialization. Returns a disposable object with the attributes defined for

3058

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

3059

</div>

3060

3061

3062

3063

<h4>Parameters:</h4>

3064

3065

3066

3067

3068

3069

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

3070

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

3071

3072

3073

3074

3075

3076

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

3077

</div>

3078

3079

3080

</li>

3081

3082

3083

3084

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

3085

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

3086

3087

3088

3089

3090

3091

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

3092

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

3093

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

3094

</div>

3095

3096

3097

</li>

3098

3099

</ul>

3100

</div>

3101

3102

3103

3104

3105

<h4>Returns:</h4>

3106

3107

3108

3109

3110

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

3111

3112

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

3113

of an object with attribute name/configuration pairs.

3114

3115

</div>

3116

</div>

3117

3118

3119

3120

</div>

3121

3122

3123

3124

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

3125

3126

3127

3128

3129

3130

3131

3132

<code>attrName</code>

3133

3134

</li>

3135

3136

3137

3138

<code>subAttrName</code>

3139

3140

</li>

3141

3142

3143

3144

<code>currVal</code>

3145

3146

</li>

3147

3148

3149

3150

<code>newVal</code>

3151

3152

</li>

3153

3154

3155

3156

3157

3158

</li>

3159

3160

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

3161

</div>

3162

3163

3164

3165

3166

3167

3168

3169

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

3170

3171

3172

3173

3174

3175

3176

3177

3178

3179

3180

3181

<p>Inherited from

3182

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

3183

3184

3185

3186

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

3187

3188

</p>

3189

3190

3191

3192

3193

3194

</div>

3195

3196

3197

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

3198

</div>

3199

3200

3201

3202

<h4>Parameters:</h4>

3203

3204

3205

3206

3207

3208

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

3209

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

3210

3211

3212

3213

3214

3215

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

3216

</div>

3217

3218

3219

</li>

3220

3221

3222

3223

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

3224

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

3225

3226

3227

3228

3229

3230

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

3231

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

3232

</div>

3233

3234

3235

</li>

3236

3237

3238

3239

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

3240

3241

3242

3243

3244

3245

3246

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

3247

</div>

3248

3249

3250

</li>

3251

3252

3253

3254

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

3255

3256

3257

3258

3259

3260

3261

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

3262

</div>

3263

3264

3265

</li>

3266

3267

3268

3269

3270

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

3271

3272

3273

3274

3275

3276

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

3277

</div>

3278

3279

3280

</li>

3281

3282

</ul>

3283

</div>

3284

3285

3286

3287

3288

3289

</div>

3290

3291

3292

3293

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

3294

3295

3296

3297

3298

3299

3300

3301

3302

3303

</li>

3304

3305

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

3306

</div>

3307

3308

3309

3310

3311

3312

</span>

3313

3314

3315

3316

3317

3318

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

3319

3320

3321

3322

3323

3324

3325

3326

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

3327

3328

3329

3330

3331

3332

<p>Inherited from

3333

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

3334

3335

3336

3337

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

3338

3339

</p>

3340

3341

3342

3343

3344

3345

</div>

3346

3347

3348

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

3349

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

3350

3351

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

3352

</div>

3353

3354

3355

3356

<h4>Parameters:</h4>

3357

3358

3359

3360

3361

3362

3363

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

3364

3365

3366

3367

3368

3369

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

3370

</div>

3371

3372

3373

</li>

3374

3375

</ul>

3376

</div>

3377

3378

3379

3380

3381

<h4>Returns:</h4>

3382

3383

3384

3385

3386

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

3387

3388

The value of the attribute.

3389

3390

</div>

3391

</div>

3392

3393

3394

3395

</div>

3396

3397

3398

3399

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

3400

3401

3402

3403

3404

3405

3406

3407

3408

3409

</li>

3410

3411

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

3412

</div>

3413

3414

3415

3416

3417

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

3418

</span>

3419

3420

3421

3422

3423

3424

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

3425

3426

3427

3428

3429

3430

3431

3432

3433

3434

3435

3436

<p>Inherited from

3437

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

3438

3439

3440

3441

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

3442

3443

</p>

3444

3445

3446

3447

3448

3449

</div>

3450

3451

3452

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

3453

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

3454

configuration properties for all attributes.</p>

3455

</div>

3456

3457

3458

3459

<h4>Parameters:</h4>

3460

3461

3462

3463

3464

3465

3466

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

3467

3468

3469

3470

3471

3472

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

3473

</div>

3474

3475

3476

</li>

3477

3478

</ul>

3479

</div>

3480

3481

3482

3483

3484

<h4>Returns:</h4>

3485

3486

3487

3488

3489

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

3490

3491

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

3492

3493

</div>

3494

</div>

3495

3496

3497

3498

</div>

3499

3500

3501

3502

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

3503

3504

3505

3506

3507

3508

3509

3510

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

3511

</span>

3512

3513

3514

3515

3516

3517

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

3518

3519

3520

3521

3522

3523

3524

3525

3526

3527

3528

3529

<p>Inherited from

3530

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

3531

3532

3533

3534

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

3535

3536

</p>

3537

3538

3539

3540

3541

3542

</div>

3543

3544

3545

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

3546

the class hierarchy.</p>

3547

</div>

3548

3549

3550

3551

3552

3553

<h4>Returns:</h4>

3554

3555

3556

3557

3558

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

3559

3560

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

3561

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

3562

the cached value.

3563

3564

</div>

3565

</div>

3566

3567

3568

3569

</div>

3570

3571

3572

3573

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

3574

3575

3576

3577

3578

3579

3580

3581

3582

3583

</li>

3584

3585

3586

3587

3588

3589

</li>

3590

3591

3592

3593

<code>initValues</code>

3594

3595

</li>

3596

3597

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

3598

</div>

3599

3600

3601

3602

3603

3604

</span>

3605

3606

3607

3608

3609

3610

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

3611

3612

3613

3614

3615

3616

3617

3618

3619

3620

3621

<p>Inherited from

3622

3623

AttributeCore

3624

</a>

3625

3626

but overwritten in

3627

3628

3629

3630

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

3631

3632

</p>

3633

3634

3635

3636

3637

3638

</div>

3639

3640

3641

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

3642

either the default configuration provided, or the

3643

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

3644

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

3645

</div>

3646

3647

3648

3649

<h4>Parameters:</h4>

3650

3651

3652

3653

3654

3655

3656

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

3657

3658

3659

3660

3661

3662

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

3663

</div>

3664

3665

3666

</li>

3667

3668

3669

3670

3671

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

3672

3673

3674

3675

3676

3677

<p>The attribute configuration object</p>

3678

</div>

3679

3680

3681

</li>

3682

3683

3684

3685

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

3686

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

3687

3688

3689

3690

3691

3692

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

3693

</div>

3694

3695

3696

</li>

3697

3698

</ul>

3699

</div>

3700

3701

3702

3703

3704

<h4>Returns:</h4>

3705

3706

3707

3708

3709

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

3710

3711

The initial value of the attribute.

3712

3713

</div>

3714

</div>

3715

3716

3717

3718

</div>

3719

3720

3721

3722

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

3723

3724

3725

3726

3727

3728

3729

3730

<code>attrs</code>

3731

3732

</li>

3733

3734

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

3735

</div>

3736

3737

3738

3739

3740

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

3741

</span>

3742

3743

3744

3745

3746

3747

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

3748

3749

3750

3751

3752

3753

3754

3755

3756

3757

3758

3759

<p>Inherited from

3760

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

3761

3762

3763

3764

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

3765

3766

</p>

3767

3768

3769

3770

3771

3772

</div>

3773

3774

3775

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

3776

</div>

3777

3778

3779

3780

<h4>Parameters:</h4>

3781

3782

3783

3784

3785

3786

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

3787

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

3788

3789

3790

3791

3792

3793

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

3794

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

3795

</div>

3796

3797

3798

</li>

3799

3800

</ul>

3801

</div>

3802

3803

3804

3805

3806

<h4>Returns:</h4>

3807

3808

3809

3810

3811

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

3812

3813

An object with attribute name/value pairs.

3814

3815

</div>

3816

</div>

3817

3818

3819

3820

</div>

3821

3822

3823

3824

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

3825

3826

3827

3828

3829

3830

3831

3832

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

3833

</span>

3834

3835

3836

3837

3838

3839

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

3840

3841

3842

3843

3844

3845

3846

3847

3848

3849

3850

3851

<p>Inherited from

3852

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

3853

3854

3855

3856

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

3857

3858

</p>

3859

3860

3861

3862

3863

3864

</div>

3865

3866

3867

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

3868

</div>

3869

3870

3871

3872

3873

3874

<h4>Returns:</h4>

3875

3876

3877

3878

3879

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

3880

3881

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

3882

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

3883

cached value.

3884

3885

</div>

3886

</div>

3887

3888

3889

3890

</div>

3891

3892

3893

3894

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

3895

3896

3897

3898

3899

3900

3901

3902

3903

3904

</li>

3905

3906

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

3907

</div>

3908

3909

3910

3911

3912

3913

</span>

3914

3915

3916

3917

3918

3919

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

3920

3921

3922

3923

3924

3925

3926

3927

3928

3929

3930

3931

<p>Inherited from

3932

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

3933

3934

3935

3936

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

3937

3938

</p>

3939

3940

3941

3942

3943

3944

</div>

3945

3946

3947

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

3948

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

3949

</div>

3950

3951

3952

3953

<h4>Parameters:</h4>

3954

3955

3956

3957

3958

3959

3960

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

3961

3962

3963

3964

3965

3966

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

3967

</div>

3968

3969

3970

</li>

3971

3972

</ul>

3973

</div>

3974

3975

3976

3977

3978

<h4>Returns:</h4>

3979

3980

3981

3982

3983

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

3984

3985

The stored value of the attribute

3986

3987

</div>

3988

</div>

3989

3990

3991

3992

</div>

3993

3994

3995

3996

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

3997

3998

3999

4000

4001

4002

4003

4004

4005

4006

4007

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

4008

4009

4010

4011

4012

4013

4014

4015

4016

4017

4018

4019

<p>Inherited from

4020

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

4021

4022

4023

4024

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

4025

4026

</p>

4027

4028

4029

4030

4031

4032

</div>

4033

4034

4035

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

4036

event type is not prefixed, the instance prefix is

4037

applied to the supplied type.</p>

4038

</div>

4039

4040

4041

4042

4043

4044

4045

</div>

4046

4047

4048

4049

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

4050

4051

4052

4053

4054

4055

4056

4057

<code>attrs</code>

4058

4059

</li>

4060

4061

4062

4063

<code>values</code>

4064

4065

</li>

4066

4067

4068

4069

4070

4071

</li>

4072

4073

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

4074

</div>

4075

4076

4077

4078

4079

4080

4081

4082

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

4083

4084

4085

4086

4087

4088

4089

4090

4091

4092

4093

4094

<p>Inherited from

4095

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

4096

4097

4098

4099

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

4100

4101

</p>

4102

4103

4104

4105

4106

4107

</div>

4108

4109

4110

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

4111

constructor.</p>

4112

</div>

4113

4114

4115

4116

<h4>Parameters:</h4>

4117

4118

4119

4120

4121

4122

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

4123

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

4124

4125

4126

4127

4128

4129

<p>The attributes to add during construction (passed through to <a href="#method_addAttrs">addAttrs</a>). These can also be defined on the constructor being augmented with Attribute by defining the ATTRS property on the constructor.</p>

4130

</div>

4131

4132

4133

</li>

4134

4135

4136

4137

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

4138

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

4139

4140

4141

4142

4143

4144

<p>The initial attribute values to apply (passed through to <a href="#method_addAttrs">addAttrs</a>). These are not merged/cloned. The caller is responsible for isolating user provided values if required.</p>

4145

</div>

4146

4147

4148

</li>

4149

4150

4151

4152

4153

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

4154

4155

4156

4157

4158

4159

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

4160

</div>

4161

4162

4163

</li>

4164

4165

</ul>

4166

</div>

4167

4168

4169

4170

4171

4172

</div>

4173

4174

4175

4176

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

4177

4178

4179

4180

4181

4182

4183

4184

4185

4186

4187

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

4188

4189

4190

4191

4192

4193

4194

4195

4196

4197

4198

<p>Inherited from

4199

4200

BaseCore

4201

</a>

4202

4203

but overwritten in

4204

4205

4206

4207

4208

4209

</p>

4210

4211

4212

4213

4214

4215

</div>

4216

4217

4218

<p>Initializes Attribute</p>

4219

</div>

4220

4221

4222

4223

4224

4225

4226

</div>

4227

4228

4229

4230

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

4231

4232

4233

4234

4235

4236

4237

4238

<code>attrs</code>

4239

4240

</li>

4241

4242

4243

4244

<code>values</code>

4245

4246

</li>

4247

4248

4249

4250

4251

4252

</li>

4253

4254

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

4255

</div>

4256

4257

4258

4259

4260

4261

4262

4263

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

4264

4265

4266

4267

4268

4269

4270

4271

4272

4273

4274

4275

<p>Inherited from

4276

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

4277

4278

4279

4280

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

4281

4282

</p>

4283

4284

4285

4286

4287

4288

</div>

4289

4290

4291

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

4292

</div>

4293

4294

4295

4296

<h4>Parameters:</h4>

4297

4298

4299

4300

4301

4302

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

4303

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

4304

4305

4306

4307

4308

4309

4310

</div>

4311

4312

4313

</li>

4314

4315

4316

4317

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

4318

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

4319

4320

4321

4322

4323

4324

4325

</div>

4326

4327

4328

</li>

4329

4330

4331

4332

4333

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

4334

4335

4336

4337

4338

4339

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

4340

</div>

4341

4342

4343

</li>

4344

4345

</ul>

4346

</div>

4347

4348

4349

4350

4351

4352

</div>

4353

4354

4355

4356

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

4357

4358

4359

4360

4361

4362

4363

4364

<code>config</code>

4365

4366

</li>

4367

4368

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

4369

</div>

4370

4371

4372

4373

4374

4375

4376

4377

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

4378

4379

4380

4381

4382

4383

4384

4385

4386

4387

4388

<p>Inherited from

4389

4390

BaseCore

4391

</a>

4392

4393

but overwritten in

4394

4395

4396

4397

4398

4399

</p>

4400

4401

4402

4403

4404

4405

</div>

4406

4407

4408

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

4409

</div>

4410

4411

4412

4413

<h4>Parameters:</h4>

4414

4415

4416

4417

4418

4419

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

4420

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

4421

4422

4423

4424

4425

4426

<p>The constructor configuration object</p>

4427

</div>

4428

4429

4430

</li>

4431

4432

</ul>

4433

</div>

4434

4435

4436

4437

4438

4439

</div>

4440

4441

4442

4443

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

4444

4445

4446

4447

4448

4449

4450

4451

<code>userVals</code>

4452

4453

</li>

4454

4455

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

4456

</div>

4457

4458

4459

4460

4461

4462

4463

4464

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

4465

4466

4467

4468

4469

4470

4471

4472

4473

4474

4475

4476

<p>Inherited from

4477

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

4478

4479

4480

4481

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

4482

4483

</p>

4484

4485

4486

4487

4488

4489

</div>

4490

4491

4492

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

4493

initializing attributes for each class defined in the class's

4494

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

4495

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

4496

</div>

4497

4498

4499

4500

<h4>Parameters:</h4>

4501

4502

4503

4504

4505

4506

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

4507

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

4508

4509

4510

4511

4512

4513

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

4514

</div>

4515

4516

4517

</li>

4518

4519

</ul>

4520

</div>

4521

4522

4523

4524

4525

4526

</div>

4527

4528

4529

4530

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

4531

4532

4533

4534

4535

4536

4537

4538

4539

4540

4541

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

4542

4543

4544

4545

4546

4547

4548

4549

4550

4551

4552

4553

<p>Inherited from

4554

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

4555

4556

4557

4558

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

4559

4560

</p>

4561

4562

4563

4564

4565

4566

</div>

4567

4568

4569

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

4570

the array of classes and aggregate set of attribute configurations

4571

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

4572

</div>

4573

4574

4575

4576

4577

4578

4579

</div>

4580

4581

4582

4583

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

4584

4585

4586

4587

4588

4589

4590

4591

4592

4593

4594

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

4595

4596

4597

4598

4599

4600

4601

4602

4603

4604

4605

4606

4607

<p>

4608

4609

Defined in

4610

4611

4612

4613

4614

<a href="../files/calendar_js_calendarnavigator.js.html#l248"><code>calendar/js/calendarnavigator.js:248</code></a>

4615

4616

</p>

4617

4618

4619

4620

4621

4622

</div>

4623

4624

4625

<p>Protected render assist method that initialized and renders the navigation controls.</p>

4626

</div>

4627

4628

4629

4630

4631

4632

4633

</div>

4634

4635

4636

4637

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

4638

4639

4640

4641

4642

4643

4644

4645

4646

4647

</li>

4648

4649

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

4650

</div>

4651

4652

4653

4654

4655

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

4656

</span>

4657

4658

4659

4660

4661

4662

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

4663

4664

4665

4666

4667

4668

4669

4670

4671

4672

4673

4674

<p>Inherited from

4675

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

4676

4677

4678

4679

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

4680

4681

</p>

4682

4683

4684

4685

4686

4687

</div>

4688

4689

4690

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

4691

added lazily and still requires initialization.</p>

4692

</div>

4693

4694

4695

4696

<h4>Parameters:</h4>

4697

4698

4699

4700

4701

4702

4703

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

4704

4705

4706

4707

4708

4709

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

4710

</div>

4711

4712

4713

</li>

4714

4715

</ul>

4716

</div>

4717

4718

4719

4720

4721

<h4>Returns:</h4>

4722

4723

4724

4725

4726

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

4727

4728

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

4729

4730

</div>

4731

</div>

4732

4733

4734

4735

</div>

4736

4737

4738

4739

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

4740

4741

4742

4743

4744

4745

4746

4747

4748

4749

</li>

4750

4751

4752

4753

4754

4755

</li>

4756

4757

4758

4759

4760

4761

</li>

4762

4763

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

4764

</div>

4765

4766

4767

4768

4769

4770

4771

4772

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

4773

4774

4775

4776

4777

4778

4779

4780

4781

4782

4783

4784

<p>Inherited from

4785

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

4786

4787

4788

4789

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

4790

4791

</p>

4792

4793

4794

4795

4796

4797

</div>

4798

4799

4800

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

4801

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

4802

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

4803

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

4804

be subscribed to like other events to monitor the event

4805

system. Inividual published events can have monitoring

4806

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

4807

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

4808

</div>

4809

4810

4811

4812

<h4>Parameters:</h4>

4813

4814

4815

4816

4817

4818

4819

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

4820

4821

4822

4823

4824

4825

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

4826

</div>

4827

4828

4829

</li>

4830

4831

4832

4833

4834

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

4835

4836

4837

4838

4839

4840

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

4841

</div>

4842

4843

4844

</li>

4845

4846

4847

4848

4849

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

4850

4851

4852

4853

4854

4855

<p>Information about the event interaction, such as

4856

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

4857

</div>

4858

4859

4860

</li>

4861

4862

</ul>

4863

</div>

4864

4865

4866

4867

4868

4869

</div>

4870

4871

4872

4873

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

4874

4875

4876

4877

4878

4879

4880

4881

<code>valueHash</code>

4882

4883

</li>

4884

4885

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

4886

</div>

4887

4888

4889

4890

4891

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

4892

</span>

4893

4894

4895

4896

4897

4898

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

4899

4900

4901

4902

4903

4904

4905

4906

4907

4908

4909

<p>Inherited from

4910

4911

AttributeCore

4912

</a>

4913

4914

but overwritten in

4915

4916

4917

4918

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

4919

4920

</p>

4921

4922

4923

4924

4925

4926

</div>

4927

4928

4929

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

4930

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

4931

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

4932

</div>

4933

4934

4935

4936

<h4>Parameters:</h4>

4937

4938

4939

4940

4941

4942

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

4943

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

4944

4945

4946

4947

4948

4949

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

4950

</div>

4951

4952

4953

</li>

4954

4955

</ul>

4956

</div>

4957

4958

4959

4960

4961

<h4>Returns:</h4>

4962

4963

4964

4965

4966

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

4967

4968

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

4969

containing simple and complex attribute values respectively keyed

4970

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

4971

4972

</div>

4973

</div>

4974

4975

4976

4977

</div>

4978

4979

4980

4981

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

4982

4983

4984

4985

4986

4987

4988

4989

4990

4991

4992

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

4993

4994

4995

4996

4997

4998

4999

5000

5001

5002

5003

5004

<p>Inherited from

5005

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

5006

5007

5008

5009

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

5010

5011

</p>

5012

5013

5014

5015

5016

5017

</div>

5018

5019

5020

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

5021

and the prefixed event name from _getType

5022

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

5023

</div>

5024

5025

5026

5027

5028

5029

5030

</div>

5031

5032

5033

5034

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

5035

5036

5037

5038

5039

5040

5041

5042

<code>config</code>

5043

5044

</li>

5045

5046

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

5047

</div>

5048

5049

5050

5051

5052

5053

5054

5055

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

5056

5057

5058

5059

5060

5061

5062

5063

5064

5065

5066

5067

<p>Inherited from

5068

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

5069

5070

5071

5072

5073

5074

</p>

5075

5076

5077

5078

5079

5080

</div>

5081

5082

5083

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

5084

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

5085

construction, prior to init.</p>

5086

</div>

5087

5088

5089

5090

<h4>Parameters:</h4>

5091

5092

5093

5094

5095

5096

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

5097

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

5098

5099

5100

5101

5102

5103

<p>The user configuration object</p>

5104

</div>

5105

5106

5107

</li>

5108

5109

</ul>

5110

</div>

5111

5112

5113

5114

5115

5116

</div>

5117

5118

5119

5120

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

5121

5122

5123

5124

5125

5126

5127

5128

<code>attrs</code>

5129

5130

</li>

5131

5132

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

5133

</div>

5134

5135

5136

5137

5138

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

5139

</span>

5140

5141

5142

5143

5144

5145

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

5146

5147

5148

5149

5150

5151

5152

5153

5154

5155

5156

5157

<p>Inherited from

5158

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

5159

5160

5161

5162

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

5163

5164

</p>

5165

5166

5167

5168

5169

5170

</div>

5171

5172

5173

<p>Utility method to protect an attribute configuration

5174

hash, by merging the entire object and the individual

5175

attr config objects.</p>

5176

</div>

5177

5178

5179

5180

<h4>Parameters:</h4>

5181

5182

5183

5184

5185

5186

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

5187

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

5188

5189

5190

5191

5192

5193

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

5194

</div>

5195

5196

5197

</li>

5198

5199

</ul>

5200

</div>

5201

5202

5203

5204

5205

<h4>Returns:</h4>

5206

5207

5208

5209

5210

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

5211

5212

A protected version of the attrs argument.

5213

5214

</div>

5215

</div>

5216

5217

5218

5219

</div>

5220

5221

5222

5223

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

5224

5225

5226

5227

5228

5229

5230

5231

5232

5233

5234

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

5235

5236

5237

5238

5239

5240

5241

5242

5243

5244

5245

5246

5247

<p>

5248

5249

Defined in

5250

5251

5252

5253

5254

<a href="../files/calendar_js_calendarnavigator.js.html#l234"><code>calendar/js/calendarnavigator.js:234</code></a>

5255

5256

</p>

5257

5258

5259

5260

5261

5262

</div>

5263

5264

5265

<p>Private render assist method that renders the next month control</p>

5266

</div>

5267

5268

5269

5270

5271

5272

5273

</div>

5274

5275

5276

5277

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

5278

5279

5280

5281

5282

5283

5284

5285

5286

5287

5288

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

5289

5290

5291

5292

5293

5294

5295

5296

5297

5298

5299

5300

5301

<p>

5302

5303

Defined in

5304

5305

5306

5307

5308

<a href="../files/calendar_js_calendarnavigator.js.html#l220"><code>calendar/js/calendarnavigator.js:220</code></a>

5309

5310

</p>

5311

5312

5313

5314

5315

5316

</div>

5317

5318

5319

<p>Private render assist method that renders the previous month control</p>

5320

</div>

5321

5322

5323

5324

5325

5326

5327

</div>

5328

5329

5330

5331

5332

5333

5334

5335

5336

5337

5338

5339

5340

5341

</li>

5342

5343

5344

5345

5346

5347

</li>

5348

5349

5350

5351

5352

5353

</li>

5354

5355

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

5356

</div>

5357

5358

5359

5360

5361

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

5362

</span>

5363

5364

5365

5366

5367

5368

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

5369

5370

5371

5372

5373

5374

5375

5376

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

5377

5378

5379

5380

5381

<p>Inherited from

5382

5383

AttributeCore

5384

</a>

5385

5386

but overwritten in

5387

5388

5389

5390

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

5391

5392

</p>

5393

5394

5395

5396

5397

5398

</div>

5399

5400

5401

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

5402

</div>

5403

5404

5405

5406

<h4>Parameters:</h4>

5407

5408

5409

5410

5411

5412

5413

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

5414

5415

5416

5417

5418

5419

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

5420

</div>

5421

5422

5423

</li>

5424

5425

5426

5427

5428

5429

5430

5431

5432

5433

5434

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

5435

</div>

5436

5437

5438

</li>

5439

5440

5441

5442

5443

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

5444

5445

5446

5447

5448

5449

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

5450

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

5451

</div>

5452

5453

5454

</li>

5455

5456

</ul>

5457

</div>

5458

5459

5460

5461

5462

<h4>Returns:</h4>

5463

5464

5465

5466

5467

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

5468

5469

A reference to the host object.

5470

5471

</div>

5472

</div>

5473

5474

5475

5476

</div>

5477

5478

5479

5480

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

5481

5482

5483

5484

5485

5486

5487

5488

5489

5490

</li>

5491

5492

5493

5494

<code>value</code>

5495

5496

</li>

5497

5498

5499

5500

5501

5502

</li>

5503

5504

5505

5506

<code>force</code>

5507

5508

</li>

5509

5510

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

5511

</div>

5512

5513

5514

5515

5516

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

5517

</span>

5518

5519

5520

5521

5522

5523

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

5524

5525

5526

5527

5528

5529

5530

5531

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

5532

5533

5534

5535

5536

5537

<p>Inherited from

5538

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

5539

5540

5541

5542

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

5543

5544

</p>

5545

5546

5547

5548

5549

5550

</div>

5551

5552

5553

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

5554

5555

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

5556

</div>

5557

5558

5559

5560

<h4>Parameters:</h4>

5561

5562

5563

5564

5565

5566

5567

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

5568

5569

5570

5571

5572

5573

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

5574

</div>

5575

5576

5577

</li>

5578

5579

5580

5581

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

5582

5583

5584

5585

5586

5587

5588

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

5589

</div>

5590

5591

5592

</li>

5593

5594

5595

5596

5597

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

5598

5599

5600

5601

5602

5603

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

5604

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

5605

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

5606

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

5607

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

5608

</div>

5609

5610

5611

</li>

5612

5613

5614

5615

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

5616

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

5617

5618

5619

5620

5621

5622

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

5623

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

5624

</div>

5625

5626

5627

</li>

5628

5629

</ul>

5630

</div>

5631

5632

5633

5634

5635

<h4>Returns:</h4>

5636

5637

5638

5639

5640

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

5641

5642

A reference to the host object.

5643

5644

</div>

5645

</div>

5646

5647

5648

5649

</div>

5650

5651

5652

5653

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

5654

5655

5656

5657

5658

5659

5660

5661

<code>attrs</code>

5662

5663

</li>

5664

5665

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

5666

</div>

5667

5668

5669

5670

5671

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

5672

</span>

5673

5674

5675

5676

5677

5678

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

5679

5680

5681

5682

5683

5684

5685

5686

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

5687

5688

5689

5690

5691

5692

<p>Inherited from

5693

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

5694

5695

5696

5697

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

5698

5699

</p>

5700

5701

5702

5703

5704

5705

</div>

5706

5707

5708

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

5709

</div>

5710

5711

5712

5713

<h4>Parameters:</h4>

5714

5715

5716

5717

5718

5719

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

5720

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

5721

5722

5723

5724

5725

5726

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

5727

</div>

5728

5729

5730

</li>

5731

5732

</ul>

5733

</div>

5734

5735

5736

5737

5738

<h4>Returns:</h4>

5739

5740

5741

5742

5743

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

5744

5745

A reference to the host object.

5746

5747

</div>

5748

</div>

5749

5750

5751

5752

</div>

5753

5754

5755

5756

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

5757

5758

5759

5760

5761

5762

5763

5764

<code>attrName</code>

5765

5766

</li>

5767

5768

5769

5770

<code>subAttrName</code>

5771

5772

</li>

5773

5774

5775

5776

<code>prevVal</code>

5777

5778

</li>

5779

5780

5781

5782

<code>newVal</code>

5783

5784

</li>

5785

5786

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

5787

</div>

5788

5789

5790

5791

5792

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

5793

</span>

5794

5795

5796

5797

5798

5799

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

5800

5801

5802

5803

5804

5805

5806

5807

5808

5809

5810

5811

<p>Inherited from

5812

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

5813

5814

5815

5816

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

5817

5818

</p>

5819

5820

5821

5822

5823

5824

</div>

5825

5826

5827

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

5828

if validation and setter passes.</p>

5829

</div>

5830

5831

5832

5833

<h4>Parameters:</h4>

5834

5835

5836

5837

5838

5839

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

5840

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

5841

5842

5843

5844

5845

5846

<p>The attribute name.</p>

5847

</div>

5848

5849

5850

</li>

5851

5852

5853

5854

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

5855

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

5856

5857

5858

5859

5860

5861

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

5862

</div>

5863

5864

5865

</li>

5866

5867

5868

5869

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

5870

5871

5872

5873

5874

5875

5876

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

5877

</div>

5878

5879

5880

</li>

5881

5882

5883

5884

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

5885

5886

5887

5888

5889

5890

5891

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

5892

</div>

5893

5894

5895

</li>

5896

5897

</ul>

5898

</div>

5899

5900

5901

5902

5903

<h4>Returns:</h4>

5904

5905

5906

5907

5908

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

5909

5910

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

5911

5912

</div>

5913

</div>

5914

5915

5916

5917

</div>

5918

5919

5920

5921

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

5922

5923

5924

5925

5926

5927

5928

5929

5930

5931

</li>

5932

5933

5934

5935

<code>value</code>

5936

5937

</li>

5938

5939

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

5940

</div>

5941

5942

5943

5944

5945

5946

5947

5948

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

5949

5950

5951

5952

5953

5954

5955

5956

5957

5958

5959

5960

<p>Inherited from

5961

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

5962

5963

5964

5965

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

5966

5967

</p>

5968

5969

5970

5971

5972

5973

</div>

5974

5975

5976

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

5977

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

5978

</div>

5979

5980

5981

5982

<h4>Parameters:</h4>

5983

5984

5985

5986

5987

5988

5989

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

5990

5991

5992

5993

5994

5995

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

5996

</div>

5997

5998

5999

</li>

6000

6001

6002

6003

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

6004

6005

6006

6007

6008

6009

6010

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

6011

</div>

6012

6013

6014

</li>

6015

6016

</ul>

6017

</div>

6018

6019

6020

6021

6022

6023

</div>

6024

6025

6026

6027

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

6028

6029

6030

6031

6032

6033

6034

6035

6036

6037

</li>

6038

6039

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

6040

</div>

6041

6042

6043

6044

6045

6046

6047

6048

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

6049

6050

6051

6052

6053

6054

6055

6056

6057

6058

6059

6060

6061

<p>

6062

6063

Defined in

6064

6065

6066

6067

6068

<a href="../files/calendar_js_calendarnavigator.js.html#l143"><code>calendar/js/calendarnavigator.js:143</code></a>

6069

6070

</p>

6071

6072

6073

6074

6075

6076

</div>

6077

6078

6079

<p>Private utility method that subtracts months from the host calendar date

6080

based on the control click and the shiftByMonths property.</p>

6081

</div>

6082

6083

6084

6085

<h4>Parameters:</h4>

6086

6087

6088

6089

6090

6091

6092

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

6093

6094

6095

6096

6097

6098

<p>Click event from the controls</p>

6099

</div>

6100

6101

6102

</li>

6103

6104

</ul>

6105

</div>

6106

6107

6108

6109

6110

6111

</div>

6112

6113

6114

6115

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

6116

6117

6118

6119

6120

6121

6122

6123

6124

6125

</li>

6126

6127

6128

6129

<code>config</code>

6130

6131

</li>

6132

6133

6134

6135

6136

6137

</li>

6138

6139

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

6140

</div>

6141

6142

6143

6144

6145

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

6146

</span>

6147

6148

6149

6150

6151

6152

6153

6154

6155

6156

6157

6158

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

6159

6160

6161

6162

6163

6164

<p>Inherited from

6165

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

6166

6167

6168

6169

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

6170

6171

</p>

6172

6173

6174

6175

6176

6177

</div>

6178

6179

6180

<p>

6181

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

6182

</p>

6183

6184

<p>

6185

The config argument object supports the following properties:

6186

</p>

6187

6188

<dl>

6189

<dt>value <Any></dt>

6190

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

6191

6192

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

6193

<dd>

6194

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

6195

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

6196

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

6197

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

6198

case the value property is used.</p>

6199

6200

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

6201

</dd>

6202

6203

<dt>readOnly <boolean></dt>

6204

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

6205

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

6206

6207

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

6208

<dd>

6209

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

6210

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

6211

constructor configuration arguments, or by invoking set.

6212

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

6213

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

6214

</dd>

6215

6216

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

6217

<dd>

6218

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

6219

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

6220

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

6221

the value from being stored.

6222

</p>

6223

6224

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

6225

</dd>

6226

6227

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

6228

<dd>

6229

<p>

6230

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

6231

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

6232

invoke get.

6233

</p>

6234

6235

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

6236

</dd>

6237

6238

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

6239

<dd>

6240

<p>

6241

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

6242

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

6243

</p>

6244

6245

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

6246

</dd>

6247

6248

<dt>lazyAdd <boolean></dt>

6249

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

6250

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

6251

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

6252

6253

</dl>

6254

6255

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

6256

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

6257

6258

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

6259

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

6260

</div>

6261

6262

6263

6264

<h4>Parameters:</h4>

6265

6266

6267

6268

6269

6270

6271

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

6272

6273

6274

6275

6276

6277

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

6278

</div>

6279

6280

6281

</li>

6282

6283

6284

6285

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

6286

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

6287

6288

6289

6290

6291

6292

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

6293

6294

<p>

6295

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

6296

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

6297

</p>

6298

</div>

6299

6300

6301

</li>

6302

6303

6304

6305

6306

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

6307

6308

6309

6310

6311

6312

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

6313

</div>

6314

6315

6316

</li>

6317

6318

</ul>

6319

</div>

6320

6321

6322

6323

6324

<h4>Returns:</h4>

6325

6326

6327

6328

6329

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

6330

6331

A reference to the host object.

6332

6333

</div>

6334

</div>

6335

6336

6337

6338

</div>

6339

6340

6341

6342

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

6343

6344

6345

6346

6347

6348

6349

6350

6351

6352

</li>

6353

6354

6355

6356

<code>values</code>

6357

6358

</li>

6359

6360

6361

6362

6363

6364

</li>

6365

6366

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

6367

</div>

6368

6369

6370

6371

6372

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

6373

</span>

6374

6375

6376

6377

6378

6379

6380

6381

6382

6383

6384

6385

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

6386

6387

6388

6389

6390

6391

<p>Inherited from

6392

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

6393

6394

6395

6396

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

6397

6398

</p>

6399

6400

6401

6402

6403

6404

</div>

6405

6406

6407

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

6408

6409

<p>

6410

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

6411

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

6412

</p>

6413

</div>

6414

6415

6416

6417

<h4>Parameters:</h4>

6418

6419

6420

6421

6422

6423

6424

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

6425

6426

6427

6428

6429

6430

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

6431

</div>

6432

6433

6434

</li>

6435

6436

6437

6438

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

6439

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

6440

6441

6442

6443

6444

6445

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

6446

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

6447

</div>

6448

6449

6450

</li>

6451

6452

6453

6454

6455

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

6456

6457

6458

6459

6460

6461

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

6462

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

6463

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

6464

</div>

6465

6466

6467

</li>

6468

6469

</ul>

6470

</div>

6471

6472

6473

6474

6475

<h4>Returns:</h4>

6476

6477

6478

6479

6480

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

6481

6482

A reference to the host object.

6483

6484

</div>

6485

</div>

6486

6487

6488

6489

</div>

6490

6491

6492

6493

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

6494

6495

6496

6497

6498

6499

6500

6501

6502

6503

</li>

6504

6505

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

6506

</div>

6507

6508

6509

6510

6511

6512

6513

6514

6515

6516

6517

6518

6519

6520

6521

6522

6523

6524

<p>Inherited from

6525

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

6526

6527

6528

6529

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

6530

6531

</p>

6532

6533

6534

6535

6536

6537

</div>

6538

6539

6540

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

6541

is determined by the order registered. Multiple targets can

6542

be specified.</p>

6543

6544

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

6545

6546

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

6547

</div>

6548

6549

6550

6551

<h4>Parameters:</h4>

6552

6553

6554

6555

6556

6557

6558

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

6559

6560

6561

6562

6563

6564

<p>the target to add</p>

6565

</div>

6566

6567

6568

</li>

6569

6570

</ul>

6571

</div>

6572

6573

6574

6575

6576

6577

</div>

6578

6579

6580

6581

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

6582

6583

6584

6585

6586

6587

6588

6589

6590

6591

</li>

6592

6593

6594

6595

6596

6597

</li>

6598

6599

6600

6601

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

6602

6603

</li>

6604

6605

6606

6607

6608

6609

</li>

6610

6611

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

6612

</div>

6613

6614

6615

6616

6617

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

6618

</span>

6619

6620

6621

6622

6623

6624

6625

6626

6627

6628

6629

6630

6631

6632

6633

6634

<p>Inherited from

6635

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

6636

6637

6638

6639

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

6640

6641

</p>

6642

6643

6644

6645

6646

6647

</div>

6648

6649

6650

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

6651

supplied callback will execute after any listeners add

6652

via the subscribe method, and after the default function,

6653

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

6654

</div>

6655

6656

6657

6658

<h4>Parameters:</h4>

6659

6660

6661

6662

6663

6664

6665

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

6666

6667

6668

6669

6670

6671

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

6672

</div>

6673

6674

6675

</li>

6676

6677

6678

6679

6680

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

6681

6682

6683

6684

6685

6686

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

6687

</div>

6688

6689

6690

</li>

6691

6692

6693

6694

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

6695

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

6696

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

6697

6698

6699

6700

6701

6702

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

6703

</div>

6704

6705

6706

</li>

6707

6708

6709

6710

6711

6712

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

6713

6714

6715

6716

6717

6718

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

6719

</div>

6720

6721

6722

</li>

6723

6724

</ul>

6725

</div>

6726

6727

6728

6729

6730

<h4>Returns:</h4>

6731

6732

6733

6734

6735

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

6736

6737

A subscription handle capable of detaching the

6738

subscription

6739

6740

</div>

6741

</div>

6742

6743

6744

6745

</div>

6746

6747

6748

6749

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

6750

6751

6752

6753

6754

6755

6756

6757

6758

6759

</li>

6760

6761

6762

6763

6764

6765

</li>

6766

6767

6768

6769

<code>context</code>

6770

6771

</li>

6772

6773

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

6774

</div>

6775

6776

6777

6778

6779

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

6780

</span>

6781

6782

6783

6784

6785

6786

6787

6788

6789

6790

6791

6792

6793

6794

6795

6796

<p>Inherited from

6797

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

6798

6799

6800

6801

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

6802

6803

</p>

6804

6805

6806

6807

6808

6809

</div>

6810

6811

6812

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

6813

6814

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

6815

</div>

6816

6817

6818

6819

<h4>Parameters:</h4>

6820

6821

6822

6823

6824

6825

6826

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

6827

6828

6829

6830

6831

6832

<p>The event type.</p>

6833

</div>

6834

6835

6836

</li>

6837

6838

6839

6840

6841

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

6842

6843

6844

6845

6846

6847

<p>The listener.</p>

6848

</div>

6849

6850

6851

</li>

6852

6853

6854

6855

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

6856

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

6857

6858

6859

6860

6861

6862

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

6863

</div>

6864

6865

6866

</li>

6867

6868

</ul>

6869

</div>

6870

6871

6872

6873

6874

<h4>Returns:</h4>

6875

6876

6877

6878

6879

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

6880

6881

handle The detach handle for the listener.

6882

6883

</div>

6884

</div>

6885

6886

6887

6888

</div>

6889

6890

6891

6892

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

6893

6894

6895

6896

6897

6898

6899

6900

<code>method</code>

6901

6902

</li>

6903

6904

6905

6906

6907

6908

</li>

6909

6910

6911

6912

<code>context</code>

6913

6914

</li>

6915

6916

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

6917

</div>

6918

6919

6920

6921

6922

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

6923

</span>

6924

6925

6926

6927

6928

6929

6930

6931

6932

6933

6934

6935

6936

6937

6938

6939

<p>Inherited from

6940

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

6941

6942

6943

6944

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

6945

6946

</p>

6947

6948

6949

6950

6951

6952

</div>

6953

6954

6955

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

6956

6957

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

6958

</div>

6959

6960

6961

6962

<h4>Parameters:</h4>

6963

6964

6965

6966

6967

6968

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

6969

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

6970

6971

6972

6973

6974

6975

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

6976

</div>

6977

6978

6979

</li>

6980

6981

6982

6983

6984

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

6985

6986

6987

6988

6989

6990

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

6991

</div>

6992

6993

6994

</li>

6995

6996

6997

6998

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

6999

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

7000

7001

7002

7003

7004

7005

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

7006

</div>

7007

7008

7009

</li>

7010

7011

</ul>

7012

</div>

7013

7014

7015

7016

7017

<h4>Returns:</h4>

7018

7019

7020

7021

7022

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

7023

7024

handle The detach handle for the injected function.

7025

7026

</div>

7027

</div>

7028

7029

7030

7031

</div>

7032

7033

7034

7035

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

7036

7037

7038

7039

7040

7041

7042

7043

7044

7045

</li>

7046

7047

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

7048

</div>

7049

7050

7051

7052

7053

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

7054

</span>

7055

7056

7057

7058

7059

7060

7061

7062

7063

7064

7065

7066

7067

7068

7069

7070

<p>Inherited from

7071

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

7072

7073

7074

7075

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

7076

7077

</p>

7078

7079

7080

7081

7082

7083

</div>

7084

7085

7086

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

7087

</div>

7088

7089

7090

7091

<h4>Parameters:</h4>

7092

7093

7094

7095

7096

7097

7098

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

7099

7100

7101

7102

7103

7104

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

7105

</div>

7106

7107

7108

</li>

7109

7110

</ul>

7111

</div>

7112

7113

7114

7115

7116

<h4>Returns:</h4>

7117

7118

7119

7120

7121

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

7122

7123

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.

7124

7125

</div>

7126

</div>

7127

7128

7129

7130

</div>

7131

7132

7133

7134

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

7135

7136

7137

7138

7139

7140

7141

7142

7143

</span>

7144

7145

7146

7147

7148

7149

7150

7151

7152

7153

7154

7155

7156

7157

7158

7159

<p>Inherited from

7160

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

7161

7162

7163

7164

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

7165

7166

</p>

7167

7168

7169

7170

7171

7172

</div>

7173

7174

7175

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

7176

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

7177

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

7178

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

7179

7180

<p>For DOM and custom events:

7181

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

7182

7183

<p>For methods:

7184

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

7185

</div>

7186

7187

7188

7189

7190

7191

<h4>Returns:</h4>

7192

7193

7194

7195

7196

detach handle

7197

7198

</div>

7199

</div>

7200

7201

7202

7203

</div>

7204

7205

7206

7207

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

7208

7209

7210

7211

7212

7213

7214

7215

<code>method</code>

7216

7217

</li>

7218

7219

7220

7221

7222

7223

</li>

7224

7225

7226

7227

<code>context</code>

7228

7229

</li>

7230

7231

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

7232

</div>

7233

7234

7235

7236

7237

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

7238

</span>

7239

7240

7241

7242

7243

7244

7245

7246

7247

7248

7249

7250

7251

7252

7253

7254

<p>Inherited from

7255

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

7256

7257

7258

7259

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

7260

7261

</p>

7262

7263

7264

7265

7266

7267

</div>

7268

7269

7270

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

7271

7272

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

7273

</div>

7274

7275

7276

7277

<h4>Parameters:</h4>

7278

7279

7280

7281

7282

7283

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

7284

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

7285

7286

7287

7288

7289

7290

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

7291

</div>

7292

7293

7294

</li>

7295

7296

7297

7298

7299

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

7300

7301

7302

7303

7304

7305

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

7306

</div>

7307

7308

7309

</li>

7310

7311

7312

7313

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

7314

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

7315

7316

7317

7318

7319

7320

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

7321

</div>

7322

7323

7324

</li>

7325

7326

</ul>

7327

</div>

7328

7329

7330

7331

7332

<h4>Returns:</h4>

7333

7334

7335

7336

7337

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

7338

7339

handle The detach handle for the injected function.

7340

7341

</div>

7342

</div>

7343

7344

7345

7346

</div>

7347

7348

7349

7350

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

7351

7352

7353

7354

7355

7356

7357

7358

7359

7360

</li>

7361

7362

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

7363

</div>

7364

7365

7366

7367

7368

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

7369

</span>

7370

7371

7372

7373

7374

7375

7376

7377

7378

7379

7380

7381

7382

7383

7384

7385

<p>Inherited from

7386

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

7387

7388

7389

7390

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

7391

7392

</p>

7393

7394

7395

7396

7397

7398

</div>

7399

7400

7401

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

7402

</div>

7403

7404

7405

7406

<h4>Parameters:</h4>

7407

7408

7409

7410

7411

7412

7413

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

7414

7415

7416

7417

7418

7419

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

7420

</div>

7421

7422

7423

</li>

7424

7425

</ul>

7426

</div>

7427

7428

7429

7430

7431

<h4>Returns:</h4>

7432

7433

7434

7435

7436

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

7437

7438

the aggregated return value from Event.Custom.fire

7439

7440

</div>

7441

</div>

7442

7443

7444

7445

</div>

7446

7447

7448

7449

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

7450

7451

7452

7453

7454

7455

7456

7457

7458

</span>

7459

7460

7461

7462

7463

7464

7465

7466

7467

7468

7469

7470

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

7471

7472

7473

7474

7475

<p>Inherited from

7476

7477

BaseCore

7478

</a>

7479

7480

but overwritten in

7481

7482

7483

7484

7485

7486

</p>

7487

7488

7489

7490

7491

7492

</div>

7493

7494

7495

<p>

7496

Destroy lifecycle method. Fires the destroy

7497

event, prior to invoking destructors for the

7498

class hierarchy.

7499

</p>

7500

7501

<p>

7502

Subscribers to the destroy

7503

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

7504

from proceeding.

7505

</p>

7506

</div>

7507

7508

7509

7510

7511

7512

<h4>Returns:</h4>

7513

7514

7515

7516

7517

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

7518

7519

A reference to this object

7520

7521

</div>

7522

</div>

7523

7524

7525

7526

</div>

7527

7528

7529

7530

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

7531

7532

7533

7534

7535

7536

7537

7538

7539

7540

7541

7542

7543

7544

7545

7546

7547

7548

7549

7550

<p>Inherited from

7551

7552

Plugin.Base

7553

</a>

7554

7555

but overwritten in

7556

7557

7558

7559

<a href="../files/calendar_js_calendarnavigator.js.html#l133"><code>calendar/js/calendarnavigator.js:133</code></a>

7560

7561

</p>

7562

7563

7564

7565

7566

7567

</div>

7568

7569

7570

<p>The initializer destructor implementation. Responsible for destroying the initialized

7571

control mechanisms.</p>

7572

</div>

7573

7574

7575

7576

7577

7578

7579

</div>

7580

7581

7582

7583

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

7584

7585

7586

7587

7588

7589

7590

7591

7592

7593

</li>

7594

7595

7596

7597

7598

7599

</li>

7600

7601

7602

7603

<code>context</code>

7604

7605

</li>

7606

7607

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

7608

</div>

7609

7610

7611

7612

7613

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

7614

</span>

7615

7616

7617

7618

7619

7620

7621

7622

7623

7624

7625

7626

7627

7628

7629

7630

<p>Inherited from

7631

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

7632

7633

7634

7635

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

7636

7637

</p>

7638

7639

7640

7641

7642

7643

</div>

7644

7645

7646

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

7647

</div>

7648

7649

7650

7651

<h4>Parameters:</h4>

7652

7653

7654

7655

7656

7657

7658

7659

7660

7661

7662

7663

7664

<p>Either the handle to the subscriber or the

7665

type of event. If the type

7666

is not specified, it will attempt to remove

7667

the listener from all hosted events.</p>

7668

</div>

7669

7670

7671

</li>

7672

7673

7674

7675

7676

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

7677

7678

7679

7680

7681

7682

<p>The subscribed function to unsubscribe, if not

7683

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

7684

</div>

7685

7686

7687

</li>

7688

7689

7690

7691

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

7692

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

7693

7694

7695

7696

7697

7698

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

7699

optional, but if supplied will be used to

7700

disambiguate multiple listeners that are the same

7701

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

7702

that lives on the prototype)</p>

7703

</div>

7704

7705

7706

</li>

7707

7708

</ul>

7709

</div>

7710

7711

7712

7713

7714

<h4>Returns:</h4>

7715

7716

7717

7718

7719

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

7720

7721

the host

7722

7723

</div>

7724

</div>

7725

7726

7727

7728

</div>

7729

7730

7731

7732

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

7733

7734

7735

7736

7737

7738

7739

7740

7741

7742

</li>

7743

7744

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

7745

</div>

7746

7747

7748

7749

7750

7751

7752

7753

7754

7755

7756

7757

7758

7759

7760

7761

7762

7763

<p>Inherited from

7764

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

7765

7766

7767

7768

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

7769

7770

</p>

7771

7772

7773

7774

7775

7776

</div>

7777

7778

7779

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

7780

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

7781

be removed.</p>

7782

</div>

7783

7784

7785

7786

<h4>Parameters:</h4>

7787

7788

7789

7790

7791

7792

7793

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

7794

7795

7796

7797

7798

7799

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

7800

</div>

7801

7802

7803

</li>

7804

7805

</ul>

7806

</div>

7807

7808

7809

7810

7811

7812

</div>

7813

7814

7815

7816

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

7817

7818

7819

7820

7821

7822

7823

7824

<code>strMethod</code>

7825

7826

</li>

7827

7828

7829

7830

7831

7832

</li>

7833

7834

7835

7836

<code>context</code>

7837

7838

</li>

7839

7840

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

7841

</div>

7842

7843

7844

7845

7846

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

7847

</span>

7848

7849

7850

7851

7852

7853

7854

7855

7856

7857

7858

7859

7860

7861

7862

7863

<p>Inherited from

7864

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

7865

7866

7867

7868

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

7869

7870

</p>

7871

7872

7873

7874

7875

7876

</div>

7877

7878

7879

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

7880

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

7881

</div>

7882

7883

7884

7885

<h4>Parameters:</h4>

7886

7887

7888

7889

7890

7891

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

7892

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

7893

7894

7895

7896

7897

7898

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

7899

</div>

7900

7901

7902

</li>

7903

7904

7905

7906

7907

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

7908

7909

7910

7911

7912

7913

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

7914

</div>

7915

7916

7917

</li>

7918

7919

7920

7921

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

7922

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

7923

7924

7925

7926

7927

7928

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

7929

</div>

7930

7931

7932

</li>

7933

7934

</ul>

7935

</div>

7936

7937

7938

7939

7940

<h4>Returns:</h4>

7941

7942

7943

7944

7945

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

7946

7947

handle The detach handle for the listener.

7948

7949

</div>

7950

</div>

7951

7952

7953

7954

</div>

7955

7956

7957

7958

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

7959

7960

7961

7962

7963

7964

7965

7966

<code>strMethod</code>

7967

7968

</li>

7969

7970

7971

7972

7973

7974

</li>

7975

7976

7977

7978

<code>context</code>

7979

7980

</li>

7981

7982

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

7983

</div>

7984

7985

7986

7987

7988

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

7989

</span>

7990

7991

7992

7993

7994

7995

7996

7997

7998

7999

8000

8001

8002

8003

8004

8005

<p>Inherited from

8006

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

8007

8008

8009

8010

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

8011

8012

</p>

8013

8014

8015

8016

8017

8018

</div>

8019

8020

8021

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

8022

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

8023

</div>

8024

8025

8026

8027

<h4>Parameters:</h4>

8028

8029

8030

8031

8032

8033

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

8034

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

8035

8036

8037

8038

8039

8040

<p>The event to listen for, or method to inject logic before.</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 handler function. For events, the "on" moment listener. For methods, the function to execute before the given method is executed.</p>

8056

</div>

8057

8058

8059

</li>

8060

8061

8062

8063

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

8064

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

8065

8066

8067

8068

8069

8070

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

8071

</div>

8072

8073

8074

</li>

8075

8076

</ul>

8077

</div>

8078

8079

8080

8081

8082

<h4>Returns:</h4>

8083

8084

8085

8086

8087

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

8088

8089

handle The detach handle for the handler.

8090

8091

</div>

8092

</div>

8093

8094

8095

8096

</div>

8097

8098

8099

8100

8101

8102

8103

8104

8105

8106

8107

8108

8109

8110

</li>

8111

8112

8113

8114

<code>arguments</code>

8115

8116

</li>

8117

8118

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

8119

</div>

8120

8121

8122

8123

8124

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

8125

</span>

8126

8127

8128

8129

8130

8131

8132

8133

8134

8135

8136

8137

8138

8139

8140

8141

<p>Inherited from

8142

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

8143

8144

8145

8146

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

8147

8148

</p>

8149

8150

8151

8152

8153

8154

</div>

8155

8156

8157

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

8158

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

8159

following parameters.</p>

8160

8161

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

8162

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

8163

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

8164

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

8165

be published on this object first.</p>

8166

8167

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

8168

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

8169

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

8170

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

8171

in place of the original object.</p>

8172

</div>

8173

8174

8175

8176

<h4>Parameters:</h4>

8177

8178

8179

8180

8181

8182

8183

8184

8185

8186

8187

8188

8189

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

8190

a 'type' property.</p>

8191

</div>

8192

8193

8194

</li>

8195

8196

8197

8198

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

8199

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

8200

8201

8202

8203

8204

8205

<p>an arbitrary set of parameters to pass to

8206

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

8207

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

8208

parameter after the properties the object literal contains are copied to

8209

the event facade.</p>

8210

</div>

8211

8212

8213

</li>

8214

8215

</ul>

8216

</div>

8217

8218

8219

8220

8221

<h4>Returns:</h4>

8222

8223

8224

8225

8226

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

8227

8228

the event host

8229

8230

</div>

8231

</div>

8232

8233

8234

8235

</div>

8236

8237

8238

8239

8240

8241

8242

8243

8244

8245

8246

8247

8248

8249

</li>

8250

8251

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

8252

</div>

8253

8254

8255

8256

8257

8258

</span>

8259

8260

8261

8262

8263

8264

8265

8266

8267

8268

8269

8270

8271

8272

8273

8274

<p>Inherited from

8275

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

8276

8277

8278

8279

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

8280

8281

</p>

8282

8283

8284

8285

8286

8287

</div>

8288

8289

8290

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

8291

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

8292

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

8293

</div>

8294

8295

8296

8297

<h4>Parameters:</h4>

8298

8299

8300

8301

8302

8303

8304

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

8305

8306

8307

8308

8309

8310

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

8311

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

8312

</div>

8313

8314

8315

</li>

8316

8317

</ul>

8318

</div>

8319

8320

8321

8322

8323

<h4>Returns:</h4>

8324

8325

8326

8327

8328

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

8329

8330

The value of the attribute

8331

8332

</div>

8333

</div>

8334

8335

8336

8337

</div>

8338

8339

8340

8341

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

8342

8343

8344

8345

8346

8347

8348

8349

<code>attrs</code>

8350

8351

</li>

8352

8353

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

8354

</div>

8355

8356

8357

8358

8359

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

8360

</span>

8361

8362

8363

8364

8365

8366

8367

8368

8369

8370

8371

8372

8373

8374

8375

8376

<p>Inherited from

8377

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

8378

8379

8380

8381

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

8382

8383

</p>

8384

8385

8386

8387

8388

8389

</div>

8390

8391

8392

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

8393

</div>

8394

8395

8396

8397

<h4>Parameters:</h4>

8398

8399

8400

8401

8402

8403

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

8404

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

8405

8406

8407

8408

8409

8410

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

8411

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

8412

</div>

8413

8414

8415

</li>

8416

8417

</ul>

8418

</div>

8419

8420

8421

8422

8423

<h4>Returns:</h4>

8424

8425

8426

8427

8428

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

8429

8430

An object with attribute name/value pairs.

8431

8432

</div>

8433

</div>

8434

8435

8436

8437

</div>

8438

8439

8440

8441

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

8442

8443

8444

8445

8446

8447

8448

8449

8450

8451

</li>

8452

8453

8454

8455

<code>prefixed</code>

8456

8457

</li>

8458

8459

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

8460

</div>

8461

8462

8463

8464

8465

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

8466

</span>

8467

8468

8469

8470

8471

8472

8473

8474

8475

8476

8477

8478

8479

8480

8481

8482

<p>Inherited from

8483

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

8484

8485

8486

8487

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

8488

8489

</p>

8490

8491

8492

8493

8494

8495

</div>

8496

8497

8498

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

8499

falsy value otherwise</p>

8500

</div>

8501

8502

8503

8504

<h4>Parameters:</h4>

8505

8506

8507

8508

8509

8510

8511

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

8512

8513

8514

8515

8516

8517

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

8518

</div>

8519

8520

8521

</li>

8522

8523

8524

8525

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

8526

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

8527

8528

8529

8530

8531

8532

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

8533

</div>

8534

8535

8536

</li>

8537

8538

</ul>

8539

</div>

8540

8541

8542

8543

8544

<h4>Returns:</h4>

8545

8546

8547

8548

8549

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

8550

8551

the custom event or null

8552

8553

</div>

8554

</div>

8555

8556

8557

8558

</div>

8559

8560

8561

8562

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

8563

8564

8565

8566

8567

8568

8569

8570

8571

</span>

8572

8573

8574

8575

8576

8577

8578

8579

8580

8581

8582

8583

8584

8585

8586

8587

<p>Inherited from

8588

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

8589

8590

8591

8592

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

8593

8594

</p>

8595

8596

8597

8598

8599

8600

</div>

8601

8602

8603

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

8604

</div>

8605

8606

8607

8608

8609

8610

<h4>Returns:</h4>

8611

8612

8613

8614

8615

EventTarget[]

8616

8617

</div>

8618

</div>

8619

8620

8621

8622

</div>

8623

8624

8625

8626

8627

8628

8629

8630

8631

8632

8633

8634

<code>config</code>

8635

8636

</li>

8637

8638

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

8639

</div>

8640

8641

8642

8643

8644

8645

</span>

8646

8647

8648

8649

8650

8651

8652

8653

8654

8655

8656

8657

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

8658

8659

8660

8661

8662

<p>Inherited from

8663

8664

BaseCore

8665

</a>

8666

8667

but overwritten in

8668

8669

8670

8671

8672

8673

</p>

8674

8675

8676

8677

8678

8679

</div>

8680

8681

8682

<p>Init lifecycle method, invoked during construction.

8683

Fires the init event prior to setting up attributes and

8684

invoking initializers for the class hierarchy.</p>

8685

</div>

8686

8687

8688

8689

<h4>Parameters:</h4>

8690

8691

8692

8693

8694

8695

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

8696

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

8697

8698

8699

8700

8701

8702

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

8703

</div>

8704

8705

8706

</li>

8707

8708

</ul>

8709

</div>

8710

8711

8712

8713

8714

<h4>Returns:</h4>

8715

8716

8717

8718

8719

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

8720

8721

A reference to this object

8722

8723

</div>

8724

</div>

8725

8726

8727

8728

</div>

8729

8730

8731

8732

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

8733

8734

8735

8736

8737

8738

8739

8740

<code>config</code>

8741

8742

</li>

8743

8744

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

8745

</div>

8746

8747

8748

8749

8750

8751

8752

8753

8754

8755

8756

8757

8758

8759

8760

8761

8762

<p>Inherited from

8763

8764

Plugin.Base

8765

</a>

8766

8767

but overwritten in

8768

8769

8770

8771

<a href="../files/calendar_js_calendarnavigator.js.html#l117"><code>calendar/js/calendarnavigator.js:117</code></a>

8772

8773

</p>

8774

8775

8776

8777

8778

8779

</div>

8780

8781

8782

<p>The initializer lifecycle implementation. Modifies the host widget's

8783

render to add navigation controls.</p>

8784

</div>

8785

8786

8787

8788

<h4>Parameters:</h4>

8789

8790

8791

8792

8793

8794

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

8795

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

8796

8797

8798

8799

8800

8801

<p>The user configuration for the plugin</p>

8802

</div>

8803

8804

8805

</li>

8806

8807

</ul>

8808

</div>

8809

8810

8811

8812

8813

8814

</div>

8815

8816

8817

8818

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

8819

8820

8821

8822

8823

8824

8825

8826

8827

8828

</li>

8829

8830

8831

8832

<code>config</code>

8833

8834

</li>

8835

8836

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

8837

</div>

8838

8839

8840

8841

8842

8843

8844

8845

8846

8847

8848

8849

8850

8851

8852

8853

8854

8855

<p>Inherited from

8856

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

8857

8858

8859

8860

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

8861

8862

</p>

8863

8864

8865

8866

8867

8868

</div>

8869

8870

8871

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

8872

8873

<p>

8874

The properties which can be modified through this interface are limited

8875

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

8876

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

8877

broadcast and getter.

8878

</p>

8879

</div>

8880

8881

8882

8883

<h4>Parameters:</h4>

8884

8885

8886

8887

8888

8889

8890

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

8891

8892

8893

8894

8895

8896

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

8897

</div>

8898

8899

8900

</li>

8901

8902

8903

8904

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

8905

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

8906

8907

8908

8909

8910

8911

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

8912

</div>

8913

8914

8915

</li>

8916

8917

</ul>

8918

</div>

8919

8920

8921

8922

8923

8924

</div>

8925

8926

8927

8928

8929

8930

8931

8932

8933

8934

8935

8936

8937

8938

</li>

8939

8940

8941

8942

8943

8944

</li>

8945

8946

8947

8948

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

8949

8950

</li>

8951

8952

8953

8954

8955

8956

</li>

8957

8958

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

8959

</div>

8960

8961

8962

8963

8964

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

8965

</span>

8966

8967

8968

8969

8970

8971

8972

8973

8974

8975

8976

8977

8978

8979

8980

8981

<p>Inherited from

8982

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

8983

8984

8985

8986

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

8987

8988

</p>

8989

8990

8991

8992

8993

8994

</div>

8995

8996

8997

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

8998

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

8999

9000

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

9001

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

9002

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

9003

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

9004

API for all available properties and methods. Subscribers to

9005

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

9006

after the event name.</p>

9007

9008

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

9009

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

9010

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

9011

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

9012

9013

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

9014

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

9015

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

9016

</div>

9017

9018

9019

9020

<h4>Parameters:</h4>

9021

9022

9023

9024

9025

9026

9027

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

9028

9029

9030

9031

9032

9033

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

9034

</div>

9035

9036

9037

</li>

9038

9039

9040

9041

9042

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

9043

9044

9045

9046

9047

9048

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

9049

</div>

9050

9051

9052

</li>

9053

9054

9055

9056

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

9057

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

9058

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

9059

9060

9061

9062

9063

9064

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

9065

</div>

9066

9067

9068

</li>

9069

9070

9071

9072

9073

9074

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

9075

9076

9077

9078

9079

9080

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

9081

</div>

9082

9083

9084

</li>

9085

9086

</ul>

9087

</div>

9088

9089

9090

9091

9092

<h4>Returns:</h4>

9093

9094

9095

9096

9097

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

9098

9099

A subscription handle capable of detaching that

9100

subscription

9101

9102

</div>

9103

</div>

9104

9105

9106

9107

</div>

9108

9109

9110

9111

9112

9113

9114

9115

9116

9117

9118

9119

9120

9121

</li>

9122

9123

9124

9125

9126

9127

</li>

9128

9129

9130

9131

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

9132

9133

</li>

9134

9135

9136

9137

9138

9139

</li>

9140

9141

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

9142

</div>

9143

9144

9145

9146

9147

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

9148

</span>

9149

9150

9151

9152

9153

9154

9155

9156

9157

9158

9159

9160

9161

9162

9163

9164

<p>Inherited from

9165

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

9166

9167

9168

9169

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

9170

9171

</p>

9172

9173

9174

9175

9176

9177

</div>

9178

9179

9180

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

9181

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

9182

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

9183

</div>

9184

9185

9186

9187

<h4>Parameters:</h4>

9188

9189

9190

9191

9192

9193

9194

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

9195

9196

9197

9198

9199

9200

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

9201

</div>

9202

9203

9204

</li>

9205

9206

9207

9208

9209

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

9210

9211

9212

9213

9214

9215

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

9216

</div>

9217

9218

9219

</li>

9220

9221

9222

9223

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

9224

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

9225

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

9226

9227

9228

9229

9230

9231

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

9232

</div>

9233

9234

9235

</li>

9236

9237

9238

9239

9240

9241

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

9242

9243

9244

9245

9246

9247

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

9248

</div>

9249

9250

9251

</li>

9252

9253

</ul>

9254

</div>

9255

9256

9257

9258

9259

<h4>Returns:</h4>

9260

9261

9262

9263

9264

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

9265

9266

A subscription handle capable of detaching the

9267

subscription

9268

9269

</div>

9270

</div>

9271

9272

9273

9274

</div>

9275

9276

9277

9278

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

9279

9280

9281

9282

9283

9284

9285

9286

9287

9288

</li>

9289

9290

9291

9292

9293

9294

</li>

9295

9296

9297

9298

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

9299

9300

</li>

9301

9302

9303

9304

9305

9306

</li>

9307

9308

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

9309

</div>

9310

9311

9312

9313

9314

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

9315

</span>

9316

9317

9318

9319

9320

9321

9322

9323

9324

9325

9326

9327

9328

9329

9330

9331

<p>Inherited from

9332

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

9333

9334

9335

9336

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

9337

9338

</p>

9339

9340

9341

9342

9343

9344

</div>

9345

9346

9347

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

9348

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

9349

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

9350

</div>

9351

9352

9353

9354

<h4>Parameters:</h4>

9355

9356

9357

9358

9359

9360

9361

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

9362

9363

9364

9365

9366

9367

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

9368

</div>

9369

9370

9371

</li>

9372

9373

9374

9375

9376

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

9377

9378

9379

9380

9381

9382

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

9383

</div>

9384

9385

9386

</li>

9387

9388

9389

9390

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

9391

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

9392

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

9393

9394

9395

9396

9397

9398

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

9399

</div>

9400

9401

9402

</li>

9403

9404

9405

9406

9407

9408

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

9409

9410

9411

9412

9413

9414

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

9415

</div>

9416

9417

9418

</li>

9419

9420

</ul>

9421

</div>

9422

9423

9424

9425

9426

<h4>Returns:</h4>

9427

9428

9429

9430

9431

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

9432

9433

A subscription handle capable of detaching that

9434

subscription

9435

9436

</div>

9437

</div>

9438

9439

9440

9441

</div>

9442

9443

9444

9445

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

9446

9447

9448

9449

9450

9451

9452

9453

9454

9455

</li>

9456

9457

9458

9459

9460

9461

</li>

9462

9463

9464

9465

<code>context</code>

9466

9467

</li>

9468

9469

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

9470

</div>

9471

9472

9473

9474

9475

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

9476

</span>

9477

9478

9479

9480

9481

9482

9483

9484

9485

9486

9487

9488

9489

9490

9491

9492

<p>Inherited from

9493

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

9494

9495

9496

9497

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

9498

9499

</p>

9500

9501

9502

9503

9504

9505

</div>

9506

9507

9508

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

9509

9510

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

9511

</div>

9512

9513

9514

9515

<h4>Parameters:</h4>

9516

9517

9518

9519

9520

9521

9522

9523

9524

9525

9526

9527

9528

<p>The event type.</p>

9529

</div>

9530

9531

9532

</li>

9533

9534

9535

9536

9537

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

9538

9539

9540

9541

9542

9543

<p>The listener.</p>

9544

</div>

9545

9546

9547

</li>

9548

9549

9550

9551

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

9552

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

9553

9554

9555

9556

9557

9558

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

9559

</div>

9560

9561

9562

</li>

9563

9564

</ul>

9565

</div>

9566

9567

9568

9569

9570

<h4>Returns:</h4>

9571

9572

9573

9574

9575

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

9576

9577

handle The detach handle for the listener.

9578

9579

</div>

9580

</div>

9581

9582

9583

9584

</div>

9585

9586

9587

9588

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

9589

9590

9591

9592

9593

9594

9595

9596

9597

9598

</li>

9599

9600

9601

9602

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

9603

9604

</li>

9605

9606

</ul><span class="paren">)</span>

9607

</div>

9608

9609

9610

9611

9612

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Array" class="crosslink external" target="_blank">Array</a></span>

9613

</span>

9614

9615

9616

9617

9618

9619

9620

9621

9622

9623

9624

9625

9626

9627

9628

9629

<p>Inherited from

9630

<a href="../classes/EventTarget.html#method_parseType">EventTarget</a>:

9631

9632

9633

9634

<a href="../files/event-custom_js_event-target.js.html#l172"><code>event-custom/js/event-target.js:172</code></a>

9635

9636

</p>

9637

9638

9639

9640

9641

9642

<p>Available since 3.3.0</p>

9643

9644

</div>

9645

9646

9647

<p>Takes the type parameter passed to 'on' and parses out the

9648

various pieces that could be included in the type. If the

9649

event type is passed without a prefix, it will be expanded

9650

to include the prefix one is supplied or the event target

9651

is configured with a default prefix.</p>

9652

</div>

9653

9654

9655

9656

<h4>Parameters:</h4>

9657

9658

9659

9660

9661

9662

9663

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

9664

9665

9666

9667

9668

9669

9670

</div>

9671

9672

9673

</li>

9674

9675

9676

9677

<code class="param-name optional">[pre=this._yuievt.config.prefix]</code>

9678

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

9679

<span class="flag optional" title="This parameter is optional.">optional</span>

9680

9681

9682

9683

9684

9685

<p>the prefix</p>

9686

</div>

9687

9688

9689

</li>

9690

9691

</ul>

9692

</div>

9693

9694

9695

9696

9697

<h4>Returns:</h4>

9698

9699

9700

9701

9702

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Array" class="crosslink external" target="_blank">Array</a></span>:

9703

9704

an array containing:

9705

* the detach category, if supplied,

9706

* the prefixed event type,

9707

* whether or not this is an after listener,

9708

* the supplied event type

9709

9710

</div>

9711

</div>

9712

9713

9714

9715

</div>

9716

9717

9718

9719

<h3 class="name"><code>publish</code></h3>

9720

9721

9722

9723

9724

9725

9726

9727

9728

9729

</li>

9730

9731

9732

9733

9734

9735

</li>

9736

9737

</ul><span class="paren">)</span>

9738

</div>

9739

9740

9741

9742

9743

<span class="type"><a href="../classes/CustomEvent.html" class="crosslink">CustomEvent</a></span>

9744

</span>

9745

9746

9747

9748

9749

9750

9751

9752

9753

9754

9755

9756

9757

9758

9759

9760

<p>Inherited from

9761

<a href="../classes/EventTarget.html#method_publish">EventTarget</a>:

9762

9763

9764

9765

<a href="../files/event-custom_js_event-target.js.html#l489"><code>event-custom/js/event-target.js:489</code></a>

9766

9767

</p>

9768

9769

9770

9771

9772

9773

</div>

9774

9775

9776

<p>Creates a new custom event of the specified type. If a custom event

9777

by that name already exists, it will not be re-created. In either

9778

case the custom event is returned.</p>

9779

</div>

9780

9781

9782

9783

<h4>Parameters:</h4>

9784

9785

9786

9787

9788

9789

9790

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

9791

9792

9793

9794

9795

9796

<p>the type, or name of the event</p>

9797

</div>

9798

9799

9800

</li>

9801

9802

9803

9804

9805

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>

9806

9807

9808

9809

9810

9811

<p>optional config params. Valid properties are:</p>

9812

9813

<p><ul>

9814

<li>

9815

'broadcast': whether or not the YUI instance and YUI global are notified when the event is fired (false)

9816

</li>

9817

<li>

9818

'bubbles': whether or not this event bubbles (true)

9819

Events can only bubble if emitFacade is true.

9820

</li>

9821

<li>

9822

'context': the default execution context for the listeners (this)

9823

</li>

9824

<li>

9825

'defaultFn': the default function to execute when this event fires if preventDefault was not called

9826

</li>

9827

<li>

9828

'emitFacade': whether or not this event emits a facade (false)

9829

</li>

9830

<li>

9831

'prefix': the prefix for this targets events, e.g., 'menu' in 'menu:click'

9832

</li>

9833

<li>

9834

'fireOnce': if an event is configured to fire once, new subscribers after

9835

the fire will be notified immediately.

9836

</li>

9837

<li>

9838

'async': fireOnce event listeners will fire synchronously if the event has already

9839

fired unless async is true.

9840

</li>

9841

<li>

9842

'preventable': whether or not preventDefault() has an effect (true)

9843

</li>

9844

<li>

9845

'preventedFn': a function that is executed when preventDefault is called

9846

</li>

9847

<li>

9848

'queuable': whether or not this event can be queued during bubbling (false)

9849

</li>

9850

<li>

9851

'silent': if silent is true, debug messages are not provided for this event.

9852

</li>

9853

<li>

9854

'stoppedFn': a function that is executed when stopPropagation is called

9855

</li></p>

9856

9857

<p><li>

9858

'monitored': specifies whether or not this event should send notifications about

9859

when the event has been attached, detached, or published.

9860

</li>

9861

<li>

9862

'type': the event type (valid option if not provided as the first parameter to publish)

9863

</li>

9864

</ul></p>

9865

</div>

9866

9867

9868

</li>

9869

9870

</ul>

9871

</div>

9872

9873

9874

9875

9876

<h4>Returns:</h4>

9877

9878

9879

9880

9881

<span class="type"><a href="../classes/CustomEvent.html" class="crosslink">CustomEvent</a></span>:

9882

9883

the custom event

9884

9885

</div>

9886

</div>

9887

9888

9889

9890

</div>

9891

9892

9893

9894

<h3 class="name"><code>removeAttr</code></h3>

9895

9896

9897

9898

9899

9900

9901

9902

9903

9904

</li>

9905

9906

</ul><span class="paren">)</span>

9907

</div>

9908

9909

9910

9911

9912

9913

9914

9915

9916

9917

9918

9919

9920

9921

9922

9923

9924

9925

<p>Inherited from

9926

<a href="../classes/AttributeExtras.html#method_removeAttr">AttributeExtras</a>:

9927

9928

9929

9930

<a href="../files/attribute_js_AttributeExtras.js.html#l77"><code>attribute/js/AttributeExtras.js:77</code></a>

9931

9932

</p>

9933

9934

9935

9936

9937

9938

</div>

9939

9940

9941

<p>Removes an attribute from the host object</p>

9942

</div>

9943

9944

9945

9946

<h4>Parameters:</h4>

9947

9948

9949

9950

9951

9952

9953

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

9954

9955

9956

9957

9958

9959

<p>The name of the attribute to be removed.</p>

9960

</div>

9961

9962

9963

</li>

9964

9965

</ul>

9966

</div>

9967

9968

9969

9970

9971

9972

</div>

9973

9974

9975

9976

<h3 class="name"><code>removeTarget</code></h3>

9977

9978

9979

9980

9981

9982

9983

9984

9985

9986

</li>

9987

9988

</ul><span class="paren">)</span>

9989

</div>

9990

9991

9992

9993

9994

9995

9996

9997

9998

9999

10000

10001

10002

10003

10004

10005

10006

10007

<p>Inherited from

10008

<a href="../classes/EventTarget.html#method_removeTarget">EventTarget</a>:

10009

10010

10011

10012

<a href="../files/event-custom_js_event-facade.js.html#l409"><code>event-custom/js/event-facade.js:409</code></a>

10013

10014

</p>

10015

10016

10017

10018

10019

10020

</div>

10021

10022

10023

<p>Removes a bubble target</p>

10024

</div>

10025

10026

10027

10028

<h4>Parameters:</h4>

10029

10030

10031

10032

10033

10034

10035

<span class="type"><a href="../classes/EventTarget.html" class="crosslink">EventTarget</a></span>

10036

10037

10038

10039

10040

10041

<p>the target to remove</p>

10042

</div>

10043

10044

10045

</li>

10046

10047

</ul>

10048

</div>

10049

10050

10051

10052

10053

10054

</div>

10055

10056

10057

10058

<h3 class="name"><code>reset</code></h3>

10059

10060

10061

10062

10063

10064

10065

10066

10067

10068

</li>

10069

10070

</ul><span class="paren">)</span>

10071

</div>

10072

10073

10074

10075

10076

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>

10077

</span>

10078

10079

10080

10081

10082

10083

10084

10085

10086

10087

10088

10089

<span class="flag chainable">chainable</span>

10090

10091

10092

10093

10094

10095

<p>Inherited from

10096

<a href="../classes/AttributeExtras.html#method_reset">AttributeExtras</a>:

10097

10098

10099

10100

<a href="../files/attribute_js_AttributeExtras.js.html#l87"><code>attribute/js/AttributeExtras.js:87</code></a>

10101

10102

</p>

10103

10104

10105

10106

10107

10108

</div>

10109

10110

10111

<p>Resets the attribute (or all attributes) to its initial value, as long as

10112

the attribute is not readOnly, or writeOnce.</p>

10113

</div>

10114

10115

10116

10117

<h4>Parameters:</h4>

10118

10119

10120

10121

10122

10123

10124

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

10125

10126

10127

10128

10129

10130

<p>Optional. The name of the attribute to reset. If omitted, all attributes are reset.</p>

10131

</div>

10132

10133

10134

</li>

10135

10136

</ul>

10137

</div>

10138

10139

10140

10141

10142

<h4>Returns:</h4>

10143

10144

10145

10146

10147

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>:

10148

10149

A reference to the host object.

10150

10151

</div>

10152

</div>

10153

10154

10155

10156

</div>

10157

10158

10159

10160

10161

10162

10163

10164

10165

10166

10167

10168

10169

10170

</li>

10171

10172

10173

10174

<code>value</code>

10175

10176

</li>

10177

10178

10179

10180

10181

10182

</li>

10183

10184

</ul><span class="paren">)</span>

10185

</div>

10186

10187

10188

10189

10190

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>

10191

</span>

10192

10193

10194

10195

10196

10197

10198

10199

10200

10201

10202

10203

<span class="flag chainable">chainable</span>

10204

10205

10206

10207

10208

<p>Inherited from

10209

10210

AttributeCore

10211

</a>

10212

10213

but overwritten in

10214

10215

10216

10217

<a href="../files/attribute_js_AttributeEvents.js.html#l41"><code>attribute/js/AttributeEvents.js:41</code></a>

10218

10219

</p>

10220

10221

10222

10223

10224

10225

</div>

10226

10227

10228

<p>Sets the value of an attribute.</p>

10229

</div>

10230

10231

10232

10233

<h4>Parameters:</h4>

10234

10235

10236

10237

10238

10239

10240

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

10241

10242

10243

10244

10245

10246

<p>The name of the attribute. If the

10247

current value of the attribute is an Object, dot notation can be used

10248

to set the value of a property within the object (e.g. <code>set("x.y.z", 5)</code>).</p>

10249

</div>

10250

10251

10252

</li>

10253

10254

10255

10256

<code class="param-name">value</code>

10257

10258

10259

10260

10261

10262

10263

<p>The value to set the attribute to.</p>

10264

</div>

10265

10266

10267

</li>

10268

10269

10270

10271

10272

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>

10273

10274

10275

10276

10277

10278

<p>(Optional) Optional event data to be mixed into

10279

the event facade passed to subscribers of the attribute's change event. This

10280

can be used as a flexible way to identify the source of a call to set, allowing

10281

the developer to distinguish between set called internally by the host, vs.

10282

set called externally by the application developer.</p>

10283

</div>

10284

10285

10286

</li>

10287

10288

</ul>

10289

</div>

10290

10291

10292

10293

10294

<h4>Returns:</h4>

10295

10296

10297

10298

10299

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>:

10300

10301

A reference to the host object.

10302

10303

</div>

10304

</div>

10305

10306

10307

10308

</div>

10309

10310

10311

10312

<h3 class="name"><code>setAttrs</code></h3>

10313

10314

10315

10316

10317

10318

10319

10320

<code>attrs</code>

10321

10322

</li>

10323

10324

</ul><span class="paren">)</span>

10325

</div>

10326

10327

10328

10329

10330

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>

10331

</span>

10332

10333

10334

10335

10336

10337

10338

10339

10340

10341

10342

10343

<span class="flag chainable">chainable</span>

10344

10345

10346

10347

10348

<p>Inherited from

10349

10350

AttributeCore

10351

</a>

10352

10353

but overwritten in

10354

10355

10356

10357

<a href="../files/attribute_js_AttributeEvents.js.html#l82"><code>attribute/js/AttributeEvents.js:82</code></a>

10358

10359

</p>

10360

10361

10362

10363

10364

10365

</div>

10366

10367

10368

<p>Sets multiple attribute values.</p>

10369

</div>

10370

10371

10372

10373

<h4>Parameters:</h4>

10374

10375

10376

10377

10378

10379

<code class="param-name">attrs</code>

10380

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>

10381

10382

10383

10384

10385

10386

<p>An object with attributes name/value pairs.</p>

10387

</div>

10388

10389

10390

</li>

10391

10392

</ul>

10393

</div>

10394

10395

10396

10397

10398

<h4>Returns:</h4>

10399

10400

10401

10402

10403

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>:

10404

10405

A reference to the host object.

10406

10407

</div>

10408

</div>

10409

10410

10411

10412

</div>

10413

10414

10415

10416

<h3 class="name"><code>subscribe</code></h3>

10417

10418

10419

10420

10421

10422

10423

10424

10425

<span class="flag deprecated" title="use on">deprecated</span>

10426

10427

10428

10429

10430

10431

10432

10433

10434

10435

10436

10437

10438

10439

<p>Inherited from

10440

<a href="../classes/EventTarget.html#method_subscribe">EventTarget</a>:

10441

10442

10443

10444

<a href="../files/event-custom_js_event-target.js.html#l335"><code>event-custom/js/event-target.js:335</code></a>

10445

10446

</p>

10447

10448

10449

10450

<p>Deprecated: use on</p>

10451

10452

10453

10454

</div>

10455

10456

10457

<p>subscribe to an event</p>

10458

</div>

10459

10460

10461

10462

10463

10464

10465

</div>

10466

10467

10468

10469

<h3 class="name"><code>toString</code></h3>

10470

10471

10472

10473

10474

10475

10476

10477

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

10478

</span>

10479

10480

10481

10482

10483

10484

10485

10486

10487

10488

10489

10490

10491

10492

10493

10494

<p>Inherited from

10495

<a href="../classes/BaseCore.html#method_toString">BaseCore</a>:

10496

10497

10498

10499

<a href="../files/base_js_BaseCore.js.html#l592"><code>base/js/BaseCore.js:592</code></a>

10500

10501

</p>

10502

10503

10504

10505

10506

10507

</div>

10508

10509

10510

<p>Default toString implementation. Provides the constructor NAME

10511

and the instance guid, if set.</p>

10512

</div>

10513

10514

10515

10516

10517

10518

<h4>Returns:</h4>

10519

10520

10521

10522

10523

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>:

10524

10525

String representation for this object

10526

10527

</div>

10528

</div>

10529

10530

10531

10532

</div>

10533

10534

10535

10536

<h3 class="name"><code>unsubscribe</code></h3>

10537

10538

10539

10540

10541

10542

10543

10544

10545

<span class="flag deprecated" title="use detach">deprecated</span>

10546

10547

10548

10549

10550

10551

10552

10553

10554

10555

10556

10557

10558

10559

<p>Inherited from

10560

<a href="../classes/EventTarget.html#method_unsubscribe">EventTarget</a>:

10561

10562

10563

10564

<a href="../files/event-custom_js_event-target.js.html#l455"><code>event-custom/js/event-target.js:455</code></a>

10565

10566

</p>

10567

10568

10569

10570

<p>Deprecated: use detach</p>

10571

10572

10573

10574

</div>

10575

10576

10577

<p>detach a listener</p>

10578

</div>

10579

10580

10581

10582

10583

10584

10585

</div>

10586

10587

10588

10589

<h3 class="name"><code>unsubscribeAll</code></h3>

10590

10591

10592

10593

10594

10595

10596

10597

10598

10599

</li>

10600

10601

</ul><span class="paren">)</span>

10602

</div>

10603

10604

10605

10606

10607

10608

<span class="flag deprecated" title="use detachAll">deprecated</span>

10609

10610

10611

10612

10613

10614

10615

10616

10617

10618

10619

10620

10621

10622

<p>Inherited from

10623

<a href="../classes/EventTarget.html#method_unsubscribeAll">EventTarget</a>:

10624

10625

10626

10627

<a href="../files/event-custom_js_event-target.js.html#l476"><code>event-custom/js/event-target.js:476</code></a>

10628

10629

</p>

10630

10631

10632

10633

<p>Deprecated: use detachAll</p>

10634

10635

10636

10637

</div>

10638

10639

10640

<p>Removes all listeners from the specified event. If the event type

10641

is not specified, all listeners from all hosted custom events will

10642

be removed.</p>

10643

</div>

10644

10645

10646

10647

<h4>Parameters:</h4>

10648

10649

10650

10651

10652

10653

10654

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

10655

10656

10657

10658

10659

10660

<p>The type, or name of the event</p>

10661

</div>

10662

10663

10664

</li>

10665

10666

</ul>

10667

</div>

10668

10669

10670

10671

10672

10673

</div>

10674

10675

10676

</div>

10677

10678

10679

10680

10681

<h2 class="off-left">Properties</h2>

10682

10683

10684

10685

<h3 class="name"><code>_allowAdHocAttrs</code></h3>

10686

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>

10687

10688

10689

10690

10691

<span class="flag protected">protected</span>

10692

10693

10694

10695

10696

10697

10698

10699

10700

10701

<p>Inherited from

10702

<a href="../classes/BaseCore.html#property__allowAdHocAttrs">BaseCore</a>:

10703

10704

10705

10706

<a href="../files/base_js_BaseCore.js.html#l100"><code>base/js/BaseCore.js:100</code></a>

10707

10708

</p>

10709

10710

10711

10712

10713

</div>

10714

10715

10716

<p>This property controls whether or not instances of this class should

10717

allow users to add ad-hoc attributes through the constructor configuration

10718

hash.</p>

10719

10720

<p>AdHoc attributes are attributes which are not defined by the class, and are

10721

not handled by the MyClass.<em>NON</em>ATTRS_CFG</p>

10722

</div>

10723

10724

10725

<p><strong>Default:</strong> undefined (false)</p>

10726

10727

10728

10729

10730

10731

</div>

10732

10733

10734

10735

<h3 class="name"><code>_handles</code></h3>

10736

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Array" class="crosslink external" target="_blank">Array</a></span>

10737

10738

10739

10740

10741

<span class="flag private">private</span>

10742

10743

10744

10745

10746

10747

10748

10749

10750

10751

<p>Inherited from

10752

<a href="../classes/Plugin.Base.html#property__handles">Plugin.Base</a>:

10753

10754

10755

10756

<a href="../files/plugin_js_plugin.js.html#l66"><code>plugin/js/plugin.js:66</code></a>

10757

10758

</p>

10759

10760

10761

10762

10763

</div>

10764

10765

10766

<p>The list of event handles for event listeners or AOP injected methods

10767

applied by the plugin to the host object.</p>

10768

</div>

10769

10770

10771

10772

10773

10774

10775

</div>

10776

10777

10778

10779

<h3 class="name"><code>ATTRS</code></h3>

10780

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>

10781

10782

10783

10784

10785

10786

10787

10788

10789

<span class="flag static">static</span>

10790

10791

10792

10793

10794

10795

10796

<p>

10797

10798

Defined in

10799

10800

10801

10802

10803

<a href="../files/calendar_js_calendarnavigator.js.html#l54"><code>calendar/js/calendarnavigator.js:54</code></a>

10804

10805

</p>

10806

10807

10808

10809

10810

</div>

10811

10812

10813

<p>Static property used to define the default attribute

10814

configuration for the plugin.</p>

10815

</div>

10816

10817

10818

10819

10820

10821

10822

</div>

10823

10824

10825

10826

<h3 class="name"><code>CALENDARNAV_STRINGS</code></h3>

10827

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>

10828

10829

10830

10831

10832

<span class="flag protected">protected</span>

10833

10834

10835

10836

10837

10838

<span class="flag static">static</span>

10839

10840

10841

10842

10843

10844

10845

<p>

10846

10847

Defined in

10848

10849

10850

10851

10852

<a href="../files/calendar_js_calendarnavigator.js.html#l76"><code>calendar/js/calendarnavigator.js:76</code></a>

10853

10854

</p>

10855

10856

10857

10858

10859

</div>

10860

10861

10862

<p>The CSS classnames for the calendar navigator controls.</p>

10863

</div>

10864

10865

10866

10867

10868

10869

10870

</div>

10871

10872

10873

10874

10875

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

10876

10877

10878

10879

10880

10881

10882

10883

10884

<span class="flag static">static</span>

10885

10886

10887

10888

10889

10890

10891

<p>

10892

10893

Defined in

10894

10895

10896

10897

10898

<a href="../files/calendar_js_calendarnavigator.js.html#l42"><code>calendar/js/calendarnavigator.js:42</code></a>

10899

10900

</p>

10901

10902

10903

10904

10905

</div>

10906

10907

10908

<p>The NAME of the CalendarNavigator class. Used to prefix events generated

10909

by the plugin class.</p>

10910

</div>

10911

10912

10913

<p><strong>Default:</strong> "pluginCalendarNavigator"</p>

10914

10915

10916

10917

10918

10919

</div>

10920

10921

10922

10923

10924

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

10925

10926

10927

<span class="flag deprecated" title="Use this.constructor.NAME">deprecated</span>

10928

10929

10930

10931

10932

10933

10934

10935

10936

10937

10938

10939

<p>Inherited from

10940

<a href="../classes/BaseCore.html#property_name">BaseCore</a>:

10941

10942

10943

10944

<a href="../files/base_js_BaseCore.js.html#l196"><code>base/js/BaseCore.js:196</code></a>

10945

10946

</p>

10947

10948

10949

<p>Deprecated: Use this.constructor.NAME</p>

10950

10951

10952

10953

</div>

10954

10955

10956

<p>The string used to identify the class of this object.</p>

10957

</div>

10958

10959

10960

10961

10962

10963

10964

</div>

10965

10966

10967

10968

<h3 class="name"><code>NEXT_MONTH_CONTROL_TEMPLATE</code></h3>

10969

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

10970

10971

10972

10973

10974

<span class="flag protected">protected</span>

10975

10976

10977

10978

10979

10980

<span class="flag static">static</span>

10981

10982

10983

10984

10985

10986

10987

<p>

10988

10989

Defined in

10990

10991

10992

10993

10994

<a href="../files/calendar_js_calendarnavigator.js.html#l99"><code>calendar/js/calendarnavigator.js:99</code></a>

10995

10996

</p>

10997

10998

10999

11000

11001

</div>

11002

11003

11004

<p>The template for the calendar navigator next month control.</p>

11005

</div>

11006

11007

11008

11009

11010

11011

11012

</div>

11013

11014

11015

11016

11017

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

11018

11019

11020

11021

11022

11023

11024

11025

11026

<span class="flag static">static</span>

11027

11028

11029

11030

11031

11032

11033

<p>

11034

11035

Defined in

11036

11037

11038

11039

11040

<a href="../files/calendar_js_calendarnavigator.js.html#l31"><code>calendar/js/calendarnavigator.js:31</code></a>

11041

11042

</p>

11043

11044

11045

11046

11047

</div>

11048

11049

11050

<p>The namespace for the plugin. This will be the property on the widget, which will

11051

reference the plugin instance, when it's plugged in.</p>

11052

</div>

11053

11054

11055

<p><strong>Default:</strong> "navigator"</p>

11056

11057

11058

11059

11060

11061

</div>

11062

11063

11064

11065

<h3 class="name"><code>PREV_MONTH_CONTROL_TEMPLATE</code></h3>

11066

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

11067

11068

11069

11070

11071

<span class="flag protected">protected</span>

11072

11073

11074

11075

11076

11077

<span class="flag static">static</span>

11078

11079

11080

11081

11082

11083

11084

<p>

11085

11086

Defined in

11087

11088

11089

11090

11091

<a href="../files/calendar_js_calendarnavigator.js.html#l89"><code>calendar/js/calendarnavigator.js:89</code></a>

11092

11093

</p>

11094

11095

11096

11097

11098

</div>

11099

11100

11101

<p>The template for the calendar navigator previous month control.</p>

11102

</div>

11103

11104

11105

11106

11107

11108

11109

</div>

11110

11111

11112

</div>

11113

11114

11115

11116

11117

<h2 class="off-left">Attributes</h2>

11118

11119

11120

11121

11122

<h3 class="name"><code>destroyed</code></h3>

11123

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>

11124

11125

11126

11127

11128

11129

11130

11131

11132

11133

11134

11135

11136

<p>Inherited from

11137

<a href="../classes/BaseCore.html#attr_destroyed">BaseCore</a>:

11138

11139

11140

11141

<a href="../files/base_js_BaseCore.js.html#l157"><code>base/js/BaseCore.js:157</code></a>

11142

11143

</p>

11144

11145

11146

11147

11148

</div>

11149

11150

11151

<p>Flag indicating whether or not this object

11152

has been through the destroy lifecycle phase.</p>

11153

</div>

11154

11155

11156

<p><strong>Default:</strong> false</p>

11157

11158

11159

11160

11161

<h4>Fires event <code>destroyedChange</code></h4>

11162

11163

<p>

11164

Fires when the value for the configuration attribute <code>destroyed</code> is

11165

changed. You can listen for the event using the <code>on</code> method if you

11166

wish to be notified before the attribute's value has changed, or

11167

using the <code>after</code> method if you wish to be notified after the

11168

attribute's value has changed.

11169

</p>

11170

11171

11172

<h4>Parameters:</h4>

11173

11174

11175

11176

11177

<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>

11178

11179

11180

An Event Facade object with the following

11181

attribute-specific properties added:

11182

</div>

11183

11184

11185

11186

<code class="param-name">prevVal</code>

11187

11188

<div class="param-description">The value of the attribute, prior to it being set.</div>

11189

</li>

11190

11191

<code class="param-name">newVal</code>

11192

11193

<div class="param-description">The value the attribute is to be set to.</div>

11194

</li>

11195

11196

<code class="param-name">attrName</code>

11197

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

11198

<div class="param-description">The name of the attribute being set.</div>

11199

</li>

11200

11201

<code class="param-name">subAttrName</code>

11202

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

11203

<div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div>

11204

</li>

11205

</ul>

11206

</li>

11207

</ul>

11208

</div>

11209

</div>

11210

11211

11212

11213

</div>

11214

11215

11216

11217

11218

11219

<span class="type"><a href="../classes/Plugin.Host.html" class="crosslink">Plugin.Host</a></span>

11220

11221

11222

11223

11224

11225

11226

11227

11228

11229

11230

11231

11232

<p>Inherited from

11233

<a href="../classes/Plugin.Base.html#attr_host">Plugin.Base</a>:

11234

11235

11236

11237

<a href="../files/plugin_js_plugin.js.html#l31"><code>plugin/js/plugin.js:31</code></a>

11238

11239

</p>

11240

11241

11242

11243

11244

</div>

11245

11246

11247

<p>The plugin's host object.</p>

11248

</div>

11249

11250

11251

11252

11253

11254

<h4>Fires event <code>hostChange</code></h4>

11255

11256

<p>

11257

Fires when the value for the configuration attribute <code>host</code> is

11258

changed. You can listen for the event using the <code>on</code> method if you

11259

wish to be notified before the attribute's value has changed, or

11260

using the <code>after</code> method if you wish to be notified after the

11261

attribute's value has changed.

11262

</p>

11263

11264

11265

<h4>Parameters:</h4>

11266

11267

11268

11269

11270

<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>

11271

11272

11273

An Event Facade object with the following

11274

attribute-specific properties added:

11275

</div>

11276

11277

11278

11279

<code class="param-name">prevVal</code>

11280

11281

<div class="param-description">The value of the attribute, prior to it being set.</div>

11282

</li>

11283

11284

<code class="param-name">newVal</code>

11285

11286

<div class="param-description">The value the attribute is to be set to.</div>

11287

</li>

11288

11289

<code class="param-name">attrName</code>

11290

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

11291

<div class="param-description">The name of the attribute being set.</div>

11292

</li>

11293

11294

<code class="param-name">subAttrName</code>

11295

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

11296

<div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div>

11297

</li>

11298

</ul>

11299

</li>

11300

</ul>

11301

</div>

11302

</div>

11303

11304

11305

11306

</div>

11307

11308

11309

11310

11311

<h3 class="name"><code>initialized</code></h3>

11312

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>

11313

11314

11315

11316

11317

11318

11319

11320

11321

11322

11323

11324

11325

<p>Inherited from

11326

<a href="../classes/BaseCore.html#attr_initialized">BaseCore</a>:

11327

11328

11329

11330

<a href="../files/base_js_BaseCore.js.html#l143"><code>base/js/BaseCore.js:143</code></a>

11331

11332

</p>

11333

11334

11335

11336

11337

</div>

11338

11339

11340

<p>Flag indicating whether or not this object

11341

has been through the init lifecycle phase.</p>

11342

</div>

11343

11344

11345

<p><strong>Default:</strong> false</p>

11346

11347

11348

11349

11350

<h4>Fires event <code>initializedChange</code></h4>

11351

11352

<p>

11353

Fires when the value for the configuration attribute <code>initialized</code> is

11354

changed. You can listen for the event using the <code>on</code> method if you

11355

wish to be notified before the attribute's value has changed, or

11356

using the <code>after</code> method if you wish to be notified after the

11357

attribute's value has changed.

11358

</p>

11359

11360

11361

<h4>Parameters:</h4>

11362

11363

11364

11365

11366

<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>

11367

11368

11369

An Event Facade object with the following

11370

attribute-specific properties added:

11371

</div>

11372

11373

11374

11375

<code class="param-name">prevVal</code>

11376

11377

<div class="param-description">The value of the attribute, prior to it being set.</div>

11378

</li>

11379

11380

<code class="param-name">newVal</code>

11381

11382

<div class="param-description">The value the attribute is to be set to.</div>

11383

</li>

11384

11385

<code class="param-name">attrName</code>

11386

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

11387

<div class="param-description">The name of the attribute being set.</div>

11388

</li>

11389

11390

<code class="param-name">subAttrName</code>

11391

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

11392

<div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div>

11393

</li>

11394

</ul>

11395

</li>

11396

</ul>

11397

</div>

11398

</div>

11399

11400

11401

11402

</div>

11403

11404

11405

11406

11407

<h3 class="name"><code>shiftByMonths</code></h3>

11408

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Number" class="crosslink external" target="_blank">Number</a></span>

11409

11410

11411

11412

11413

11414

11415

11416

11417

11418

11419

11420

11421

11422

<p>

11423

11424

Defined in

11425

11426

11427

11428

11429

<a href="../files/calendar_js_calendarnavigator.js.html#l64"><code>calendar/js/calendarnavigator.js:64</code></a>

11430

11431

</p>

11432

11433

11434

11435

11436

</div>

11437

11438

11439

<p>The number of months to shift by when the control arrows are clicked.</p>

11440

</div>

11441

11442

11443

<p><strong>Default:</strong> 1 (months)</p>

11444

11445

11446

11447

11448

<h4>Fires event <code>shiftByMonthsChange</code></h4>

11449

11450

<p>

11451

Fires when the value for the configuration attribute <code>shiftByMonths</code> is

11452

changed. You can listen for the event using the <code>on</code> method if you

11453

wish to be notified before the attribute's value has changed, or

11454

using the <code>after</code> method if you wish to be notified after the

11455

attribute's value has changed.

11456

</p>

11457

11458

11459

<h4>Parameters:</h4>

11460

11461

11462

11463

11464

<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>

11465

11466

11467

An Event Facade object with the following

11468

attribute-specific properties added:

11469

</div>

11470

11471

11472

11473

<code class="param-name">prevVal</code>

11474

11475

<div class="param-description">The value of the attribute, prior to it being set.</div>

11476

</li>

11477

11478

<code class="param-name">newVal</code>

11479

11480

<div class="param-description">The value the attribute is to be set to.</div>

11481

</li>

11482

11483

<code class="param-name">attrName</code>

11484

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

11485

<div class="param-description">The name of the attribute being set.</div>

11486

</li>

11487

11488

<code class="param-name">subAttrName</code>

11489

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

11490

<div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div>

11491

</li>

11492

</ul>

11493

</li>

11494

</ul>

11495

</div>

11496

</div>

11497

11498

11499

11500

</div>

11501

11502

11503

</div>

11504

11505

11506

11507

11508

<h2 class="off-left">Events</h2>

11509

11510

11511

11512

<h3 class="name"><code>destroy</code></h3>

11513

11514

11515

11516

11517

11518

11519

11520

11521

11522

11523

11524

11525

11526

<p>Inherited from

11527

<a href="../classes/Base.html#event_destroy">Base</a>:

11528

11529

11530

11531

11532

11533

</p>

11534

11535

11536

11537

11538

</div>

11539

11540

11541

<p>

11542

Lifecycle event for the destroy phase,

11543

fired prior to destruction. Invoking the preventDefault

11544

method on the event object provided to subscribers will

11545

prevent destruction from proceeding.

11546

</p>

11547

11548

<p>

11549

Subscribers to the "after" moment of this event, will be notified

11550

after destruction is complete (and as a result cannot prevent

11551

destruction).

11552

</p>

11553

</div>

11554

11555

11556

11557

<h4>Event Payload:</h4>

11558

11559

11560

11561

11562

11563

11564

<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>

11565

11566

11567

11568

11569

11570

<p>Event object</p>

11571

</div>

11572

11573

11574

</li>

11575

11576

</ul>

11577

</div>

11578

11579

11580

11581

11582

</div>

11583

11584

11585

11586

11587

11588

11589

11590

11591

11592

11593

11594

11595

11596

11597

11598

11599

11600

<p>Inherited from

11601

<a href="../classes/Base.html#event_init">Base</a>:

11602

11603

11604

11605

11606

11607

</p>

11608

11609

11610

11611

11612

</div>

11613

11614

11615

<p>

11616

Lifecycle event for the init phase, fired prior to initialization.

11617

Invoking the preventDefault() method on the event object provided

11618

to subscribers will prevent initialization from occuring.

11619

</p>

11620

11621

<p>

11622

Subscribers to the "after" momemt of this event, will be notified

11623

after initialization of the object is complete (and therefore

11624

cannot prevent initialization).

11625

</p>

11626

</div>

11627

11628

11629

11630

<h4>Event Payload:</h4>

11631

11632

11633

11634

11635

11636

11637

<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>

11638

11639

11640

11641

11642

11643

<p>Event object, with a cfg property which

11644

refers to the configuration object passed to the constructor.</p>

11645

</div>

11646

11647

11648

</li>

11649

11650

</ul>

11651

</div>

11652

11653

11654

11655

11656

</div>

11657

11658

11659

</div>

11660

11661

</div>

11662

</div>

11663

11664

</div>

11665

</div>

11666

</div>

11667

</div>

11668

</div>

11669

</div>

11670

11671

11672

11673

11674

11675

11676

11677

11678

</body>

11679

</html>

Older »