~bac/juju-gui/trunkcopy

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

2167

2168

2169

2170

2171

2172

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

2173

</div>

2174

2175

2176

</li>

2177

2178

2179

2180

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

2181

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

2182

2183

2184

2185

2186

2187

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

2188

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

2189

</div>

2190

2191

2192

</li>

2193

2194

2195

2196

2197

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

2198

2199

2200

2201

2202

2203

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

2204

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

2205

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

2206

</div>

2207

2208

2209

</li>

2210

2211

</ul>

2212

</div>

2213

2214

2215

2216

2217

2218

</div>

2219

2220

2221

2222

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

2223

2224

2225

2226

2227

2228

2229

2230

2231

2232

</li>

2233

2234

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

2235

</div>

2236

2237

2238

2239

2240

2241

2242

2243

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

2244

2245

2246

2247

2248

2249

2250

2251

2252

2253

2254

2255

<p>Inherited from

2256

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

2257

2258

2259

2260

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

2261

2262

</p>

2263

2264

2265

2266

2267

2268

</div>

2269

2270

2271

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

2272

</div>

2273

2274

2275

2276

<h4>Parameters:</h4>

2277

2278

2279

2280

2281

2282

2283

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

2284

2285

2286

2287

2288

2289

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

2290

</div>

2291

2292

2293

</li>

2294

2295

</ul>

2296

</div>

2297

2298

2299

2300

2301

2302

</div>

2303

2304

2305

2306

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

2307

2308

2309

2310

2311

2312

2313

2314

<code>allAttrs</code>

2315

2316

</li>

2317

2318

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

2319

</div>

2320

2321

2322

2323

2324

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

2325

</span>

2326

2327

2328

2329

2330

2331

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

2332

2333

2334

2335

2336

2337

2338

2339

2340

2341

2342

2343

<p>Inherited from

2344

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

2345

2346

2347

2348

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

2349

2350

</p>

2351

2352

2353

2354

2355

2356

</div>

2357

2358

2359

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

2360

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

2361

2362

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

2363

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

2364

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

2365

</div>

2366

2367

2368

2369

<h4>Parameters:</h4>

2370

2371

2372

2373

2374

2375

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

2376

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

2377

2378

2379

2380

2381

2382

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

2383

(subclass first, Base last)</p>

2384

</div>

2385

2386

2387

</li>

2388

2389

</ul>

2390

</div>

2391

2392

2393

2394

2395

<h4>Returns:</h4>

2396

2397

2398

2399

2400

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

2401

2402

The aggregate set of ATTRS definitions for the instance

2403

2404

</div>

2405

</div>

2406

2407

2408

2409

</div>

2410

2411

2412

2413

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

2414

2415

2416

2417

2418

2419

2420

2421

2422

2423

2424

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

2425

2426

2427

2428

2429

2430

2431

2432

2433

2434

2435

<p>Inherited from

2436

2437

BaseCore

2438

</a>

2439

2440

but overwritten in

2441

2442

2443

2444

2445

2446

</p>

2447

2448

2449

2450

2451

2452

</div>

2453

2454

2455

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

2456

this class.</p>

2457

</div>

2458

2459

2460

2461

2462

2463

2464

</div>

2465

2466

2467

2468

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

2469

2470

2471

2472

2473

2474

2475

2476

2477

2478

2479

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

2480

2481

2482

2483

2484

2485

2486

2487

2488

2489

2490

2491

<p>Inherited from

2492

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

2493

2494

2495

2496

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

2497

2498

</p>

2499

2500

2501

2502

2503

2504

</div>

2505

2506

2507

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

2508

</div>

2509

2510

2511

2512

2513

2514

2515

</div>

2516

2517

2518

2519

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

2520

2521

2522

2523

2524

2525

2526

2527

2528

2529

2530

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

2531

2532

2533

2534

2535

2536

2537

2538

2539

2540

2541

2542

<p>Inherited from

2543

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

2544

2545

2546

2547

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

2548

2549

</p>

2550

2551

2552

2553

2554

2555

</div>

2556

2557

2558

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

2559

</div>

2560

2561

2562

2563

2564

2565

2566

</div>

2567

2568

2569

2570

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

2571

2572

2573

2574

2575

2576

2577

2578

2579

2580

</li>

2581

2582

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

2583

</div>

2584

2585

2586

2587

2588

2589

2590

2591

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

2592

2593

2594

2595

2596

2597

2598

2599

2600

2601

2602

2603

2604

<p>

2605

2606

Defined in

2607

2608

2609

2610

2611

<a href="../files/scrollview_js_scrollbars-plugin.js.html#l238"><code>scrollview/js/scrollbars-plugin.js:238</code></a>

2612

2613

</p>

2614

2615

2616

2617

2618

2619

</div>

2620

2621

2622

<p>Clears child cache</p>

2623

</div>

2624

2625

2626

2627

<h4>Parameters:</h4>

2628

2629

2630

2631

2632

2633

2634

2635

2636

2637

2638

2639

2640

2641

</div>

2642

2643

2644

</li>

2645

2646

</ul>

2647

</div>

2648

2649

2650

2651

2652

2653

</div>

2654

2655

2656

2657

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

2658

2659

2660

2661

2662

2663

2664

2665

2666

2667

</li>

2668

2669

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

2670

</div>

2671

2672

2673

2674

2675

2676

2677

2678

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

2679

2680

2681

2682

2683

2684

2685

2686

2687

2688

2689

2690

<p>Inherited from

2691

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

2692

2693

2694

2695

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

2696

2697

</p>

2698

2699

2700

2701

2702

2703

</div>

2704

2705

2706

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

2707

</div>

2708

2709

2710

2711

<h4>Parameters:</h4>

2712

2713

2714

2715

2716

2717

2718

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

2719

2720

2721

2722

2723

2724

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

2725

</div>

2726

2727

2728

</li>

2729

2730

</ul>

2731

</div>

2732

2733

2734

2735

2736

2737

</div>

2738

2739

2740

2741

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

2742

2743

2744

2745

2746

2747

2748

2749

2750

</span>

2751

2752

2753

2754

2755

2756

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

2757

2758

2759

2760

2761

2762

2763

2764

2765

2766

2767

2768

2769

<p>

2770

2771

Defined in

2772

2773

2774

2775

2776

<a href="../files/scrollview_js_scrollbars-plugin.js.html#l534"><code>scrollview/js/scrollbars-plugin.js:534</code></a>

2777

2778

</p>

2779

2780

2781

2782

2783

2784

</div>

2785

2786

2787

<p>Creates default node instances for scrollbars</p>

2788

</div>

2789

2790

2791

2792

2793

2794

<h4>Returns:</h4>

2795

2796

2797

2798

2799

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

2800

2801

The Y.Node instance for the scrollbar

2802

2803

</div>

2804

</div>

2805

2806

2807

2808

</div>

2809

2810

2811

2812

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

2813

2814

2815

2816

2817

2818

2819

2820

2821

2822

</li>

2823

2824

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

2825

</div>

2826

2827

2828

2829

2830

2831

2832

2833

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

2834

2835

2836

2837

2838

2839

2840

2841

2842

2843

2844

2845

<p>Inherited from

2846

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

2847

2848

2849

2850

2851

2852

</p>

2853

2854

2855

2856

2857

2858

</div>

2859

2860

2861

<p>Default destroy event handler</p>

2862

</div>

2863

2864

2865

2866

<h4>Parameters:</h4>

2867

2868

2869

2870

2871

2872

2873

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

2874

2875

2876

2877

2878

2879

<p>Event object</p>

2880

</div>

2881

2882

2883

</li>

2884

2885

</ul>

2886

</div>

2887

2888

2889

2890

2891

2892

</div>

2893

2894

2895

2896

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

2897

2898

2899

2900

2901

2902

2903

2904

2905

2906

</li>

2907

2908

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

2909

</div>

2910

2911

2912

2913

2914

2915

2916

2917

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

2918

2919

2920

2921

2922

2923

2924

2925

2926

2927

2928

2929

<p>Inherited from

2930

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

2931

2932

2933

2934

2935

2936

</p>

2937

2938

2939

2940

2941

2942

</div>

2943

2944

2945

<p>Default init event handler</p>

2946

</div>

2947

2948

2949

2950

<h4>Parameters:</h4>

2951

2952

2953

2954

2955

2956

2957

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

2958

2959

2960

2961

2962

2963

<p>Event object, with a cfg property which

2964

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

2965

</div>

2966

2967

2968

</li>

2969

2970

</ul>

2971

</div>

2972

2973

2974

2975

2976

2977

</div>

2978

2979

2980

2981

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

2982

2983

2984

2985

2986

2987

2988

2989

2990

2991

2992

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

2993

2994

2995

2996

2997

2998

2999

3000

3001

3002

3003

3004

<p>Inherited from

3005

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

3006

3007

3008

3009

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

3010

3011

</p>

3012

3013

3014

3015

3016

3017

</div>

3018

3019

3020

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

3021

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

3022

</div>

3023

3024

3025

3026

3027

3028

3029

</div>

3030

3031

3032

3033

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

3034

3035

3036

3037

3038

3039

3040

3041

<code>allAttrs</code>

3042

3043

</li>

3044

3045

3046

3047

<code>userVals</code>

3048

3049

</li>

3050

3051

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

3052

</div>

3053

3054

3055

3056

3057

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

3058

</span>

3059

3060

3061

3062

3063

3064

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

3065

3066

3067

3068

3069

3070

3071

3072

3073

3074

3075

3076

<p>Inherited from

3077

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

3078

3079

3080

3081

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

3082

3083

</p>

3084

3085

3086

3087

3088

3089

</div>

3090

3091

3092

3093

</div>

3094

3095

3096

3097

<h4>Parameters:</h4>

3098

3099

3100

3101

3102

3103

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

3104

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

3105

3106

3107

3108

3109

3110

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

3111

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

3112

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

3113

</div>

3114

3115

3116

</li>

3117

3118

3119

3120

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

3121

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

3122

3123

3124

3125

3126

3127

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

3128

</div>

3129

3130

3131

</li>

3132

3133

</ul>

3134

</div>

3135

3136

3137

3138

3139

<h4>Returns:</h4>

3140

3141

3142

3143

3144

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

3145

3146

The set of adhoc attributes passed in, in the form

3147

of an object with attribute name/configuration pairs.

3148

3149

</div>

3150

</div>

3151

3152

3153

3154

</div>

3155

3156

3157

3158

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

3159

3160

3161

3162

3163

3164

3165

3166

<code>clazz</code>

3167

3168

</li>

3169

3170

3171

3172

<code>allCfgs</code>

3173

3174

</li>

3175

3176

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

3177

</div>

3178

3179

3180

3181

3182

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

3183

</span>

3184

3185

3186

3187

3188

3189

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

3190

3191

3192

3193

3194

3195

3196

3197

3198

3199

3200

3201

<p>Inherited from

3202

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

3203

3204

3205

3206

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

3207

3208

</p>

3209

3210

3211

3212

3213

3214

</div>

3215

3216

3217

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

3218

initialization. Returns a disposable object with the attributes defined for

3219

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

3220

</div>

3221

3222

3223

3224

<h4>Parameters:</h4>

3225

3226

3227

3228

3229

3230

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

3231

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

3232

3233

3234

3235

3236

3237

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

3238

</div>

3239

3240

3241

</li>

3242

3243

3244

3245

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

3246

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

3247

3248

3249

3250

3251

3252

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

3253

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

3254

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

3255

</div>

3256

3257

3258

</li>

3259

3260

</ul>

3261

</div>

3262

3263

3264

3265

3266

<h4>Returns:</h4>

3267

3268

3269

3270

3271

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

3272

3273

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

3274

of an object with attribute name/configuration pairs.

3275

3276

</div>

3277

</div>

3278

3279

3280

3281

</div>

3282

3283

3284

3285

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

3286

3287

3288

3289

3290

3291

3292

3293

<code>attrName</code>

3294

3295

</li>

3296

3297

3298

3299

<code>subAttrName</code>

3300

3301

</li>

3302

3303

3304

3305

<code>currVal</code>

3306

3307

</li>

3308

3309

3310

3311

<code>newVal</code>

3312

3313

</li>

3314

3315

3316

3317

3318

3319

</li>

3320

3321

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

3322

</div>

3323

3324

3325

3326

3327

3328

3329

3330

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

3331

3332

3333

3334

3335

3336

3337

3338

3339

3340

3341

3342

<p>Inherited from

3343

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

3344

3345

3346

3347

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

3348

3349

</p>

3350

3351

3352

3353

3354

3355

</div>

3356

3357

3358

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

3359

</div>

3360

3361

3362

3363

<h4>Parameters:</h4>

3364

3365

3366

3367

3368

3369

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

3370

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

3371

3372

3373

3374

3375

3376

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

3377

</div>

3378

3379

3380

</li>

3381

3382

3383

3384

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

3385

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

3386

3387

3388

3389

3390

3391

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

3392

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

3393

</div>

3394

3395

3396

</li>

3397

3398

3399

3400

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

3401

3402

3403

3404

3405

3406

3407

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

3408

</div>

3409

3410

3411

</li>

3412

3413

3414

3415

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

3416

3417

3418

3419

3420

3421

3422

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

3423

</div>

3424

3425

3426

</li>

3427

3428

3429

3430

3431

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

3432

3433

3434

3435

3436

3437

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

3438

</div>

3439

3440

3441

</li>

3442

3443

</ul>

3444

</div>

3445

3446

3447

3448

3449

3450

</div>

3451

3452

3453

3454

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

3455

3456

3457

3458

3459

3460

3461

3462

3463

3464

</li>

3465

3466

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

3467

</div>

3468

3469

3470

3471

3472

3473

</span>

3474

3475

3476

3477

3478

3479

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

3480

3481

3482

3483

3484

3485

3486

3487

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

3488

3489

3490

3491

3492

3493

<p>Inherited from

3494

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

3495

3496

3497

3498

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

3499

3500

</p>

3501

3502

3503

3504

3505

3506

</div>

3507

3508

3509

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

3510

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

3511

3512

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

3513

</div>

3514

3515

3516

3517

<h4>Parameters:</h4>

3518

3519

3520

3521

3522

3523

3524

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

3525

3526

3527

3528

3529

3530

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

3531

</div>

3532

3533

3534

</li>

3535

3536

</ul>

3537

</div>

3538

3539

3540

3541

3542

<h4>Returns:</h4>

3543

3544

3545

3546

3547

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

3548

3549

The value of the attribute.

3550

3551

</div>

3552

</div>

3553

3554

3555

3556

</div>

3557

3558

3559

3560

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

3561

3562

3563

3564

3565

3566

3567

3568

3569

3570

</li>

3571

3572

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

3573

</div>

3574

3575

3576

3577

3578

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

3579

</span>

3580

3581

3582

3583

3584

3585

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

3586

3587

3588

3589

3590

3591

3592

3593

3594

3595

3596

3597

<p>Inherited from

3598

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

3599

3600

3601

3602

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

3603

3604

</p>

3605

3606

3607

3608

3609

3610

</div>

3611

3612

3613

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

3614

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

3615

configuration properties for all attributes.</p>

3616

</div>

3617

3618

3619

3620

<h4>Parameters:</h4>

3621

3622

3623

3624

3625

3626

3627

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

3628

3629

3630

3631

3632

3633

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

3634

</div>

3635

3636

3637

</li>

3638

3639

</ul>

3640

</div>

3641

3642

3643

3644

3645

<h4>Returns:</h4>

3646

3647

3648

3649

3650

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

3651

3652

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

3653

3654

</div>

3655

</div>

3656

3657

3658

3659

</div>

3660

3661

3662

3663

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

3664

3665

3666

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

</span>

3673

3674

3675

3676

3677

3678

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

3679

3680

3681

3682

3683

3684

3685

3686

3687

3688

3689

3690

<p>Inherited from

3691

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

3692

3693

3694

3695

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

3696

3697

</p>

3698

3699

3700

3701

3702

3703

</div>

3704

3705

3706

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

3707

the class hierarchy.</p>

3708

</div>

3709

3710

3711

3712

3713

3714

<h4>Returns:</h4>

3715

3716

3717

3718

3719

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

3720

3721

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

3722

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

3723

the cached value.

3724

3725

</div>

3726

</div>

3727

3728

3729

3730

</div>

3731

3732

3733

3734

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

3735

3736

3737

3738

3739

3740

3741

3742

3743

3744

</li>

3745

3746

3747

3748

3749

3750

</li>

3751

3752

3753

3754

<code>initValues</code>

3755

3756

</li>

3757

3758

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

3759

</div>

3760

3761

3762

3763

3764

3765

</span>

3766

3767

3768

3769

3770

3771

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

3772

3773

3774

3775

3776

3777

3778

3779

3780

3781

3782

<p>Inherited from

3783

3784

Attribute

3785

</a>

3786

3787

but overwritten in

3788

3789

3790

3791

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

3792

3793

</p>

3794

3795

3796

3797

3798

3799

</div>

3800

3801

3802

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

3803

either the default configuration provided, or the

3804

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

3805

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

3806

</div>

3807

3808

3809

3810

<h4>Parameters:</h4>

3811

3812

3813

3814

3815

3816

3817

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

3818

3819

3820

3821

3822

3823

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

3824

</div>

3825

3826

3827

</li>

3828

3829

3830

3831

3832

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

3833

3834

3835

3836

3837

3838

<p>The attribute configuration object</p>

3839

</div>

3840

3841

3842

</li>

3843

3844

3845

3846

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

3847

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

3848

3849

3850

3851

3852

3853

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

3854

</div>

3855

3856

3857

</li>

3858

3859

</ul>

3860

</div>

3861

3862

3863

3864

3865

<h4>Returns:</h4>

3866

3867

3868

3869

3870

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

3871

3872

The initial value of the attribute.

3873

3874

</div>

3875

</div>

3876

3877

3878

3879

</div>

3880

3881

3882

3883

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

3884

3885

3886

3887

3888

3889

3890

3891

<code>attrs</code>

3892

3893

</li>

3894

3895

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

3896

</div>

3897

3898

3899

3900

3901

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

3902

</span>

3903

3904

3905

3906

3907

3908

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

3909

3910

3911

3912

3913

3914

3915

3916

3917

3918

3919

3920

<p>Inherited from

3921

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

3922

3923

3924

3925

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

3926

3927

</p>

3928

3929

3930

3931

3932

3933

</div>

3934

3935

3936

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

3937

</div>

3938

3939

3940

3941

<h4>Parameters:</h4>

3942

3943

3944

3945

3946

3947

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

3948

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

3949

3950

3951

3952

3953

3954

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

3955

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

3956

</div>

3957

3958

3959

</li>

3960

3961

</ul>

3962

</div>

3963

3964

3965

3966

3967

<h4>Returns:</h4>

3968

3969

3970

3971

3972

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

3973

3974

An object with attribute name/value pairs.

3975

3976

</div>

3977

</div>

3978

3979

3980

3981

</div>

3982

3983

3984

3985

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

3986

3987

3988

3989

3990

3991

3992

3993

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

3994

</span>

3995

3996

3997

3998

3999

4000

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

4001

4002

4003

4004

4005

4006

4007

4008

4009

4010

4011

4012

<p>Inherited from

4013

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

4014

4015

4016

4017

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

4018

4019

</p>

4020

4021

4022

4023

4024

4025

</div>

4026

4027

4028

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

4029

</div>

4030

4031

4032

4033

4034

4035

<h4>Returns:</h4>

4036

4037

4038

4039

4040

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

4041

4042

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

4043

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

4044

cached value.

4045

4046

</div>

4047

</div>

4048

4049

4050

4051

</div>

4052

4053

4054

4055

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

4056

4057

4058

4059

4060

4061

4062

4063

4064

4065

</li>

4066

4067

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

4068

</div>

4069

4070

4071

4072

4073

4074

</span>

4075

4076

4077

4078

4079

4080

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

4081

4082

4083

4084

4085

4086

4087

4088

4089

4090

4091

4092

<p>Inherited from

4093

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

4094

4095

4096

4097

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

4098

4099

</p>

4100

4101

4102

4103

4104

4105

</div>

4106

4107

4108

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

4109

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

4110

</div>

4111

4112

4113

4114

<h4>Parameters:</h4>

4115

4116

4117

4118

4119

4120

4121

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

4122

4123

4124

4125

4126

4127

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

4128

</div>

4129

4130

4131

</li>

4132

4133

</ul>

4134

</div>

4135

4136

4137

4138

4139

<h4>Returns:</h4>

4140

4141

4142

4143

4144

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

4145

4146

The stored value of the attribute

4147

4148

</div>

4149

</div>

4150

4151

4152

4153

</div>

4154

4155

4156

4157

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

4158

4159

4160

4161

4162

4163

4164

4165

4166

4167

4168

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

4169

4170

4171

4172

4173

4174

4175

4176

4177

4178

4179

4180

<p>Inherited from

4181

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

4182

4183

4184

4185

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

4186

4187

</p>

4188

4189

4190

4191

4192

4193

</div>

4194

4195

4196

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

4197

event type is not prefixed, the instance prefix is

4198

applied to the supplied type.</p>

4199

</div>

4200

4201

4202

4203

4204

4205

4206

</div>

4207

4208

4209

4210

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

4211

4212

4213

4214

4215

4216

4217

4218

4219

4220

4221

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

4222

4223

4224

4225

4226

4227

4228

4229

4230

4231

4232

4233

4234

<p>

4235

4236

Defined in

4237

4238

4239

4240

4241

<a href="../files/scrollview_js_scrollbars-plugin.js.html#l155"><code>scrollview/js/scrollbars-plugin.js:155</code></a>

4242

4243

</p>

4244

4245

4246

4247

4248

4249

</div>

4250

4251

4252

<p>Set up the DOM nodes for the scrollbars. This method is invoked whenever the

4253

host's _uiDimensionsChange fires, giving us the opportunity to remove un-needed

4254

scrollbars, as well as add one if necessary.</p>

4255

</div>

4256

4257

4258

4259

4260

4261

4262

</div>

4263

4264

4265

4266

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

4267

4268

4269

4270

4271

4272

4273

4274

4275

4276

</li>

4277

4278

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

4279

</div>

4280

4281

4282

4283

4284

4285

4286

4287

4288

4289

4290

4291

4292

4293

4294

4295

4296

4297

4298

<p>

4299

4300

Defined in

4301

4302

4303

4304

4305

<a href="../files/scrollview_js_scrollbars-plugin.js.html#l174"><code>scrollview/js/scrollbars-plugin.js:174</code></a>

4306

4307

</p>

4308

4309

4310

4311

4312

4313

</div>

4314

4315

4316

<p>Handler for the scrollEnd event fired by the host. Default implementation flashes the scrollbar</p>

4317

</div>

4318

4319

4320

4321

<h4>Parameters:</h4>

4322

4323

4324

4325

4326

4327

4328

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

4329

4330

4331

4332

4333

4334

<p>The event facade.</p>

4335

</div>

4336

4337

4338

</li>

4339

4340

</ul>

4341

</div>

4342

4343

4344

4345

4346

4347

</div>

4348

4349

4350

4351

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

4352

4353

4354

4355

4356

4357

4358

4359

<code>attrs</code>

4360

4361

</li>

4362

4363

4364

4365

<code>values</code>

4366

4367

</li>

4368

4369

4370

4371

4372

4373

</li>

4374

4375

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

4376

</div>

4377

4378

4379

4380

4381

4382

4383

4384

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

4385

4386

4387

4388

4389

4390

4391

4392

4393

4394

4395

4396

<p>Inherited from

4397

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

4398

4399

4400

4401

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

4402

4403

</p>

4404

4405

4406

4407

4408

4409

</div>

4410

4411

4412

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

4413

constructor.</p>

4414

</div>

4415

4416

4417

4418

<h4>Parameters:</h4>

4419

4420

4421

4422

4423

4424

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

4425

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

4426

4427

4428

4429

4430

4431

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

4432

</div>

4433

4434

4435

</li>

4436

4437

4438

4439

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

4440

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

4441

4442

4443

4444

4445

4446

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

4447

</div>

4448

4449

4450

</li>

4451

4452

4453

4454

4455

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

4456

4457

4458

4459

4460

4461

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

4462

</div>

4463

4464

4465

</li>

4466

4467

</ul>

4468

</div>

4469

4470

4471

4472

4473

4474

</div>

4475

4476

4477

4478

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

4479

4480

4481

4482

4483

4484

4485

4486

4487

4488

4489

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

4490

4491

4492

4493

4494

4495

4496

4497

4498

4499

4500

<p>Inherited from

4501

4502

BaseCore

4503

</a>

4504

4505

but overwritten in

4506

4507

4508

4509

4510

4511

</p>

4512

4513

4514

4515

4516

4517

</div>

4518

4519

4520

<p>Initializes Attribute</p>

4521

</div>

4522

4523

4524

4525

4526

4527

4528

</div>

4529

4530

4531

4532

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

4533

4534

4535

4536

4537

4538

4539

4540

<code>attrs</code>

4541

4542

</li>

4543

4544

4545

4546

<code>values</code>

4547

4548

</li>

4549

4550

4551

4552

4553

4554

</li>

4555

4556

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

4557

</div>

4558

4559

4560

4561

4562

4563

4564

4565

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

4566

4567

4568

4569

4570

4571

4572

4573

4574

4575

4576

4577

<p>Inherited from

4578

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

4579

4580

4581

4582

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

4583

4584

</p>

4585

4586

4587

4588

4589

4590

</div>

4591

4592

4593

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

4594

</div>

4595

4596

4597

4598

<h4>Parameters:</h4>

4599

4600

4601

4602

4603

4604

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

4605

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

4606

4607

4608

4609

4610

4611

4612

</div>

4613

4614

4615

</li>

4616

4617

4618

4619

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

4620

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

4621

4622

4623

4624

4625

4626

4627

</div>

4628

4629

4630

</li>

4631

4632

4633

4634

4635

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

4636

4637

4638

4639

4640

4641

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

4642

</div>

4643

4644

4645

</li>

4646

4647

</ul>

4648

</div>

4649

4650

4651

4652

4653

4654

</div>

4655

4656

4657

4658

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

4659

4660

4661

4662

4663

4664

4665

4666

<code>config</code>

4667

4668

</li>

4669

4670

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

4671

</div>

4672

4673

4674

4675

4676

4677

4678

4679

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

4680

4681

4682

4683

4684

4685

4686

4687

4688

4689

4690

<p>Inherited from

4691

4692

BaseCore

4693

</a>

4694

4695

but overwritten in

4696

4697

4698

4699

4700

4701

</p>

4702

4703

4704

4705

4706

4707

</div>

4708

4709

4710

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

4711

</div>

4712

4713

4714

4715

<h4>Parameters:</h4>

4716

4717

4718

4719

4720

4721

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

4722

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

4723

4724

4725

4726

4727

4728

<p>The constructor configuration object</p>

4729

</div>

4730

4731

4732

</li>

4733

4734

</ul>

4735

</div>

4736

4737

4738

4739

4740

4741

</div>

4742

4743

4744

4745

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

4746

4747

4748

4749

4750

4751

4752

4753

<code>userVals</code>

4754

4755

</li>

4756

4757

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

4758

</div>

4759

4760

4761

4762

4763

4764

4765

4766

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

4767

4768

4769

4770

4771

4772

4773

4774

4775

4776

4777

4778

<p>Inherited from

4779

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

4780

4781

4782

4783

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

4784

4785

</p>

4786

4787

4788

4789

4790

4791

</div>

4792

4793

4794

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

4795

initializing attributes for each class defined in the class's

4796

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

4797

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

4798

</div>

4799

4800

4801

4802

<h4>Parameters:</h4>

4803

4804

4805

4806

4807

4808

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

4809

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

4810

4811

4812

4813

4814

4815

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

4816

</div>

4817

4818

4819

</li>

4820

4821

</ul>

4822

</div>

4823

4824

4825

4826

4827

4828

</div>

4829

4830

4831

4832

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

4833

4834

4835

4836

4837

4838

4839

4840

4841

4842

4843

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

4844

4845

4846

4847

4848

4849

4850

4851

4852

4853

4854

4855

<p>Inherited from

4856

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

4857

4858

4859

4860

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

4861

4862

</p>

4863

4864

4865

4866

4867

4868

</div>

4869

4870

4871

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

4872

the array of classes and aggregate set of attribute configurations

4873

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

4874

</div>

4875

4876

4877

4878

4879

4880

4881

</div>

4882

4883

4884

4885

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

4886

4887

4888

4889

4890

4891

4892

4893

4894

4895

</li>

4896

4897

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

4898

</div>

4899

4900

4901

4902

4903

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

4904

</span>

4905

4906

4907

4908

4909

4910

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

4911

4912

4913

4914

4915

4916

4917

4918

4919

4920

4921

4922

<p>Inherited from

4923

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

4924

4925

4926

4927

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

4928

4929

</p>

4930

4931

4932

4933

4934

4935

</div>

4936

4937

4938

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

4939

added lazily and still requires initialization.</p>

4940

</div>

4941

4942

4943

4944

<h4>Parameters:</h4>

4945

4946

4947

4948

4949

4950

4951

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

4952

4953

4954

4955

4956

4957

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

4958

</div>

4959

4960

4961

</li>

4962

4963

</ul>

4964

</div>

4965

4966

4967

4968

4969

<h4>Returns:</h4>

4970

4971

4972

4973

4974

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

4975

4976

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

4977

4978

</div>

4979

</div>

4980

4981

4982

4983

</div>

4984

4985

4986

4987

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

4988

4989

4990

4991

4992

4993

4994

4995

4996

4997

</li>

4998

4999

5000

5001

5002

5003

</li>

5004

5005

5006

5007

5008

5009

</li>

5010

5011

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

5012

</div>

5013

5014

5015

5016

5017

5018

5019

5020

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

5021

5022

5023

5024

5025

5026

5027

5028

5029

5030

5031

5032

<p>Inherited from

5033

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

5034

5035

5036

5037

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

5038

5039

</p>

5040

5041

5042

5043

5044

5045

</div>

5046

5047

5048

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

5049

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

5050

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

5051

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

5052

be subscribed to like other events to monitor the event

5053

system. Inividual published events can have monitoring

5054

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

5055

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

5056

</div>

5057

5058

5059

5060

<h4>Parameters:</h4>

5061

5062

5063

5064

5065

5066

5067

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

5068

5069

5070

5071

5072

5073

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

5074

</div>

5075

5076

5077

</li>

5078

5079

5080

5081

5082

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

5083

5084

5085

5086

5087

5088

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

5089

</div>

5090

5091

5092

</li>

5093

5094

5095

5096

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>Information about the event interaction, such as

5104

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

5105

</div>

5106

5107

5108

</li>

5109

5110

</ul>

5111

</div>

5112

5113

5114

5115

5116

5117

</div>

5118

5119

5120

5121

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

5122

5123

5124

5125

5126

5127

5128

5129

<code>valueHash</code>

5130

5131

</li>

5132

5133

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

5134

</div>

5135

5136

5137

5138

5139

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

5140

</span>

5141

5142

5143

5144

5145

5146

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

5147

5148

5149

5150

5151

5152

5153

5154

5155

5156

5157

<p>Inherited from

5158

5159

Attribute

5160

</a>

5161

5162

but overwritten in

5163

5164

5165

5166

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

5167

5168

</p>

5169

5170

5171

5172

5173

5174

</div>

5175

5176

5177

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

5178

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

5179

</div>

5180

5181

5182

5183

<h4>Parameters:</h4>

5184

5185

5186

5187

5188

5189

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

5190

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

5191

5192

5193

5194

5195

5196

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

5197

</div>

5198

5199

5200

</li>

5201

5202

</ul>

5203

</div>

5204

5205

5206

5207

5208

<h4>Returns:</h4>

5209

5210

5211

5212

5213

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

5214

5215

5216

</div>

5217

</div>

5218

5219

5220

5221

</div>

5222

5223

5224

5225

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

5226

5227

5228

5229

5230

5231

5232

5233

5234

5235

5236

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

5237

5238

5239

5240

5241

5242

5243

5244

5245

5246

5247

5248

<p>Inherited from

5249

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

5250

5251

5252

5253

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

5254

5255

</p>

5256

5257

5258

5259

5260

5261

</div>

5262

5263

5264

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

5265

and the prefixed event name from _getType

5266

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

5267

</div>

5268

5269

5270

5271

5272

5273

5274

</div>

5275

5276

5277

5278

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

5279

5280

5281

5282

5283

5284

5285

5286

<code>config</code>

5287

5288

</li>

5289

5290

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

5291

</div>

5292

5293

5294

5295

5296

5297

5298

5299

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

5300

5301

5302

5303

5304

5305

5306

5307

5308

5309

5310

5311

<p>Inherited from

5312

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

5313

5314

5315

5316

5317

5318

</p>

5319

5320

5321

5322

5323

5324

</div>

5325

5326

5327

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

5328

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

5329

construction, prior to init.</p>

5330

</div>

5331

5332

5333

5334

<h4>Parameters:</h4>

5335

5336

5337

5338

5339

5340

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

5341

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

5342

5343

5344

5345

5346

5347

<p>The user configuration object</p>

5348

</div>

5349

5350

5351

</li>

5352

5353

</ul>

5354

</div>

5355

5356

5357

5358

5359

5360

</div>

5361

5362

5363

5364

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

5365

5366

5367

5368

5369

5370

5371

5372

<code>attrs</code>

5373

5374

</li>

5375

5376

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

5377

</div>

5378

5379

5380

5381

5382

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

5383

</span>

5384

5385

5386

5387

5388

5389

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

5390

5391

5392

5393

5394

5395

5396

5397

5398

5399

5400

5401

<p>Inherited from

5402

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

5403

5404

5405

5406

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

5407

5408

</p>

5409

5410

5411

5412

5413

5414

</div>

5415

5416

5417

<p>Utility method to protect an attribute configuration

5418

hash, by merging the entire object and the individual

5419

attr config objects.</p>

5420

</div>

5421

5422

5423

5424

<h4>Parameters:</h4>

5425

5426

5427

5428

5429

5430

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

5431

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

5432

5433

5434

5435

5436

5437

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

5438

</div>

5439

5440

5441

</li>

5442

5443

</ul>

5444

</div>

5445

5446

5447

5448

5449

<h4>Returns:</h4>

5450

5451

5452

5453

5454

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

5455

5456

A protected version of the attrs argument.

5457

5458

</div>

5459

</div>

5460

5461

5462

5463

</div>

5464

5465

5466

5467

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

5468

5469

5470

5471

5472

5473

5474

5475

5476

5477

</li>

5478

5479

5480

5481

5482

5483

</li>

5484

5485

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

5486

</div>

5487

5488

5489

5490

5491

5492

5493

5494

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

5495

5496

5497

5498

5499

5500

5501

5502

5503

5504

5505

5506

5507

<p>

5508

5509

Defined in

5510

5511

5512

5513

5514

<a href="../files/scrollview_js_scrollbars-plugin.js.html#l186"><code>scrollview/js/scrollbars-plugin.js:186</code></a>

5515

5516

</p>

5517

5518

5519

5520

5521

5522

</div>

5523

5524

5525

<p>Adds or removes a scrollbar node from the document.</p>

5526

</div>

5527

5528

5529

5530

<h4>Parameters:</h4>

5531

5532

5533

5534

5535

5536

5537

5538

5539

5540

5541

5542

5543

<p>The scrollbar node</p>

5544

</div>

5545

5546

5547

</li>

5548

5549

5550

5551

5552

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

5553

5554

5555

5556

5557

5558

<p>true, to add the node, false to remove it</p>

5559

</div>

5560

5561

5562

</li>

5563

5564

</ul>

5565

</div>

5566

5567

5568

5569

5570

5571

</div>

5572

5573

5574

5575

5576

5577

5578

5579

5580

5581

5582

5583

5584

5585

</li>

5586

5587

5588

5589

5590

5591

</li>

5592

5593

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

5594

</div>

5595

5596

5597

5598

5599

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

5600

</span>

5601

5602

5603

5604

5605

5606

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

5607

5608

5609

5610

5611

5612

5613

5614

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

5615

5616

5617

5618

5619

<p>Inherited from

5620

5621

AttributeEvents

5622

</a>

5623

5624

but overwritten in

5625

5626

5627

5628

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

5629

5630

</p>

5631

5632

5633

5634

5635

5636

</div>

5637

5638

5639

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

5640

</div>

5641

5642

5643

5644

<h4>Parameters:</h4>

5645

5646

5647

5648

5649

5650

5651

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

5652

5653

5654

5655

5656

5657

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

5658

</div>

5659

5660

5661

</li>

5662

5663

5664

5665

5666

5667

5668

5669

5670

5671

5672

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

5673

</div>

5674

5675

5676

</li>

5677

5678

</ul>

5679

</div>

5680

5681

5682

5683

5684

<h4>Returns:</h4>

5685

5686

5687

5688

5689

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

5690

5691

A reference to the host object.

5692

5693

</div>

5694

</div>

5695

5696

5697

5698

</div>

5699

5700

5701

5702

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

5703

5704

5705

5706

5707

5708

5709

5710

5711

5712

</li>

5713

5714

5715

5716

<code>value</code>

5717

5718

</li>

5719

5720

5721

5722

5723

5724

</li>

5725

5726

5727

5728

<code>force</code>

5729

5730

</li>

5731

5732

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

5733

</div>

5734

5735

5736

5737

5738

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

5739

</span>

5740

5741

5742

5743

5744

5745

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

5746

5747

5748

5749

5750

5751

5752

5753

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

5754

5755

5756

5757

5758

5759

<p>Inherited from

5760

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

5761

5762

5763

5764

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

5765

5766

</p>

5767

5768

5769

5770

5771

5772

</div>

5773

5774

5775

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

5776

5777

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

5778

</div>

5779

5780

5781

5782

<h4>Parameters:</h4>

5783

5784

5785

5786

5787

5788

5789

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

5790

5791

5792

5793

5794

5795

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

5796

</div>

5797

5798

5799

</li>

5800

5801

5802

5803

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

5804

5805

5806

5807

5808

5809

5810

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

5811

</div>

5812

5813

5814

</li>

5815

5816

5817

5818

5819

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

5820

5821

5822

5823

5824

5825

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

5826

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

5827

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

5828

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

5829

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

5830

</div>

5831

5832

5833

</li>

5834

5835

5836

5837

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

5838

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

5839

5840

5841

5842

5843

5844

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

5845

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

5846

</div>

5847

5848

5849

</li>

5850

5851

</ul>

5852

</div>

5853

5854

5855

5856

5857

<h4>Returns:</h4>

5858

5859

5860

5861

5862

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

5863

5864

A reference to the host object.

5865

5866

</div>

5867

</div>

5868

5869

5870

5871

</div>

5872

5873

5874

5875

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

5876

5877

5878

5879

5880

5881

5882

5883

<code>attrs</code>

5884

5885

</li>

5886

5887

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

5888

</div>

5889

5890

5891

5892

5893

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

5894

</span>

5895

5896

5897

5898

5899

5900

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

5901

5902

5903

5904

5905

5906

5907

5908

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

5909

5910

5911

5912

5913

5914

<p>Inherited from

5915

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

5916

5917

5918

5919

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

5920

5921

</p>

5922

5923

5924

5925

5926

5927

</div>

5928

5929

5930

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

5931

</div>

5932

5933

5934

5935

<h4>Parameters:</h4>

5936

5937

5938

5939

5940

5941

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

5942

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

5943

5944

5945

5946

5947

5948

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

5949

</div>

5950

5951

5952

</li>

5953

5954

</ul>

5955

</div>

5956

5957

5958

5959

5960

<h4>Returns:</h4>

5961

5962

5963

5964

5965

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

5966

5967

A reference to the host object.

5968

5969

</div>

5970

</div>

5971

5972

5973

5974

</div>

5975

5976

5977

5978

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

5979

5980

5981

5982

5983

5984

5985

5986

<code>attrName</code>

5987

5988

</li>

5989

5990

5991

5992

<code>subAttrName</code>

5993

5994

</li>

5995

5996

5997

5998

<code>prevVal</code>

5999

6000

</li>

6001

6002

6003

6004

<code>newVal</code>

6005

6006

</li>

6007

6008

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

6009

</div>

6010

6011

6012

6013

6014

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

6015

</span>

6016

6017

6018

6019

6020

6021

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

6022

6023

6024

6025

6026

6027

6028

6029

6030

6031

6032

6033

<p>Inherited from

6034

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

6035

6036

6037

6038

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

6039

6040

</p>

6041

6042

6043

6044

6045

6046

</div>

6047

6048

6049

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

6050

if validation and setter passes.</p>

6051

</div>

6052

6053

6054

6055

<h4>Parameters:</h4>

6056

6057

6058

6059

6060

6061

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

6062

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

6063

6064

6065

6066

6067

6068

<p>The attribute name.</p>

6069

</div>

6070

6071

6072

</li>

6073

6074

6075

6076

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

6077

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

6078

6079

6080

6081

6082

6083

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

6084

</div>

6085

6086

6087

</li>

6088

6089

6090

6091

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

6092

6093

6094

6095

6096

6097

6098

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

6099

</div>

6100

6101

6102

</li>

6103

6104

6105

6106

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

6107

6108

6109

6110

6111

6112

6113

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

6114

</div>

6115

6116

6117

</li>

6118

6119

</ul>

6120

</div>

6121

6122

6123

6124

6125

<h4>Returns:</h4>

6126

6127

6128

6129

6130

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

6131

6132

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

6133

6134

</div>

6135

</div>

6136

6137

6138

6139

</div>

6140

6141

6142

6143

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

6144

6145

6146

6147

6148

6149

6150

6151

6152

6153

</li>

6154

6155

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

6156

</div>

6157

6158

6159

6160

6161

6162

6163

6164

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

6165

6166

6167

6168

6169

6170

6171

6172

6173

6174

6175

6176

6177

<p>

6178

6179

Defined in

6180

6181

6182

6183

6184

<a href="../files/scrollview_js_scrollbars-plugin.js.html#l209"><code>scrollview/js/scrollbars-plugin.js:209</code></a>

6185

6186

</p>

6187

6188

6189

6190

6191

6192

</div>

6193

6194

6195

<p>Caches scrollbar child element information,

6196

to optimize _update implementation</p>

6197

</div>

6198

6199

6200

6201

<h4>Parameters:</h4>

6202

6203

6204

6205

6206

6207

6208

6209

6210

6211

6212

6213

6214

6215

</div>

6216

6217

6218

</li>

6219

6220

</ul>

6221

</div>

6222

6223

6224

6225

6226

6227

</div>

6228

6229

6230

6231

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

6232

6233

6234

6235

6236

6237

6238

6239

6240

6241

</li>

6242

6243

6244

6245

6246

6247

</li>

6248

6249

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

6250

</div>

6251

6252

6253

6254

6255

6256

</span>

6257

6258

6259

6260

6261

6262

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

6263

6264

6265

6266

6267

6268

6269

6270

6271

6272

6273

6274

6275

<p>

6276

6277

Defined in

6278

6279

6280

6281

6282

<a href="../files/scrollview_js_scrollbars-plugin.js.html#l510"><code>scrollview/js/scrollbars-plugin.js:510</code></a>

6283

6284

</p>

6285

6286

6287

6288

6289

6290

</div>

6291

6292

6293

<p>Setter for the verticalNode and horizontalNode attributes</p>

6294

</div>

6295

6296

6297

6298

<h4>Parameters:</h4>

6299

6300

6301

6302

6303

6304

6305

6306

6307

6308

6309

6310

6311

<p>The Y.Node instance for the scrollbar</p>

6312

</div>

6313

6314

6315

</li>

6316

6317

6318

6319

6320

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

6321

6322

6323

6324

6325

6326

<p>The attribute name</p>

6327

</div>

6328

6329

6330

</li>

6331

6332

</ul>

6333

</div>

6334

6335

6336

6337

6338

<h4>Returns:</h4>

6339

6340

6341

6342

6343

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

6344

6345

The Y.Node instance for the scrollbar

6346

6347

</div>

6348

</div>

6349

6350

6351

6352

</div>

6353

6354

6355

6356

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

6357

6358

6359

6360

6361

6362

6363

6364

6365

6366

</li>

6367

6368

6369

6370

<code>value</code>

6371

6372

</li>

6373

6374

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

6375

</div>

6376

6377

6378

6379

6380

6381

6382

6383

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

6384

6385

6386

6387

6388

6389

6390

6391

6392

6393

6394

6395

<p>Inherited from

6396

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

6397

6398

6399

6400

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

6401

6402

</p>

6403

6404

6405

6406

6407

6408

</div>

6409

6410

6411

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

6412

internal state object, or the state proxy if it exits</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/String" class="crosslink external" target="_blank">String</a></span>

6425

6426

6427

6428

6429

6430

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

6431

</div>

6432

6433

6434

</li>

6435

6436

6437

6438

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

6439

6440

6441

6442

6443

6444

6445

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

6446

</div>

6447

6448

6449

</li>

6450

6451

</ul>

6452

</div>

6453

6454

6455

6456

6457

6458

</div>

6459

6460

6461

6462

6463

6464

6465

6466

6467

6468

6469

6470

6471

6472

</li>

6473

6474

6475

6476

<code>animated</code>

6477

6478

</li>

6479

6480

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

6481

</div>

6482

6483

6484

6485

6486

6487

6488

6489

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

6490

6491

6492

6493

6494

6495

6496

6497

6498

6499

6500

6501

6502

<p>

6503

6504

Defined in

6505

6506

6507

6508

6509

<a href="../files/scrollview_js_scrollbars-plugin.js.html#l460"><code>scrollview/js/scrollbars-plugin.js:460</code></a>

6510

6511

</p>

6512

6513

6514

6515

6516

6517

</div>

6518

6519

6520

<p>Internal hide/show implementation utility method</p>

6521

</div>

6522

6523

6524

6525

<h4>Parameters:</h4>

6526

6527

6528

6529

6530

6531

6532

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

6533

6534

6535

6536

6537

6538

<p>Whether to show or hide the scrollbar</p>

6539

</div>

6540

6541

6542

</li>

6543

6544

6545

6546

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

6547

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

6548

6549

6550

6551

6552

6553

<p>Whether or not to animate while showing/hide</p>

6554

</div>

6555

6556

6557

</li>

6558

6559

</ul>

6560

</div>

6561

6562

6563

6564

6565

6566

</div>

6567

6568

6569

6570

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

6571

6572

6573

6574

6575

6576

6577

6578

6579

6580

</li>

6581

6582

6583

6584

6585

6586

</li>

6587

6588

6589

6590

<code>duration</code>

6591

6592

</li>

6593

6594

6595

6596

<code>easing</code>

6597

6598

</li>

6599

6600

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

6601

</div>

6602

6603

6604

6605

6606

6607

6608

6609

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

6610

6611

6612

6613

6614

6615

6616

6617

6618

6619

6620

6621

6622

<p>

6623

6624

Defined in

6625

6626

6627

6628

6629

<a href="../files/scrollview_js_scrollbars-plugin.js.html#l408"><code>scrollview/js/scrollbars-plugin.js:408</code></a>

6630

6631

</p>

6632

6633

6634

6635

6636

6637

</div>

6638

6639

6640

<p>AOP method, invoked after the host's _uiScrollTo method,

6641

to position and resize the scroll bars</p>

6642

</div>

6643

6644

6645

6646

<h4>Parameters:</h4>

6647

6648

6649

6650

6651

6652

6653

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

6654

6655

6656

6657

6658

6659

<p>The current scrollX value</p>

6660

</div>

6661

6662

6663

</li>

6664

6665

6666

6667

6668

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

6669

6670

6671

6672

6673

6674

<p>The current scrollY value</p>

6675

</div>

6676

6677

6678

</li>

6679

6680

6681

6682

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

6683

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

6684

6685

6686

6687

6688

6689

<p>Number of ms of animation (optional) - used when snapping to bounds</p>

6690

</div>

6691

6692

6693

</li>

6694

6695

6696

6697

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

6698

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

6699

6700

6701

6702

6703

6704

<p>Optional easing equation to use during the animation, if duration is set</p>

6705

</div>

6706

6707

6708

</li>

6709

6710

</ul>

6711

</div>

6712

6713

6714

6715

6716

6717

</div>

6718

6719

6720

6721

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

6722

6723

6724

6725

6726

6727

6728

6729

<code>scrollbar</code>

6730

6731

</li>

6732

6733

6734

6735

<code>current</code>

6736

6737

</li>

6738

6739

6740

6741

<code>duration</code>

6742

6743

</li>

6744

6745

6746

6747

<code>horiz</code>

6748

6749

</li>

6750

6751

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

6752

</div>

6753

6754

6755

6756

6757

6758

6759

6760

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

6761

6762

6763

6764

6765

6766

6767

6768

6769

6770

6771

6772

6773

<p>

6774

6775

Defined in

6776

6777

6778

6779

6780

<a href="../files/scrollview_js_scrollbars-plugin.js.html#l249"><code>scrollview/js/scrollbars-plugin.js:249</code></a>

6781

6782

</p>

6783

6784

6785

6786

6787

6788

</div>

6789

6790

6791

<p>Utility method, to move/resize either vertical or horizontal scrollbars</p>

6792

</div>

6793

6794

6795

6796

<h4>Parameters:</h4>

6797

6798

6799

6800

6801

6802

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

6803

6804

6805

6806

6807

6808

6809

<p>The scrollbar node.</p>

6810

</div>

6811

6812

6813

</li>

6814

6815

6816

6817

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

6818

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

6819

6820

6821

6822

6823

6824

<p>The current scroll position.</p>

6825

</div>

6826

6827

6828

</li>

6829

6830

6831

6832

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

6833

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

6834

6835

6836

6837

6838

6839

<p>The transition duration.</p>

6840

</div>

6841

6842

6843

</li>

6844

6845

6846

6847

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

6848

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

6849

6850

6851

6852

6853

6854

<p>true if horizontal, false if vertical.</p>

6855

</div>

6856

6857

6858

</li>

6859

6860

</ul>

6861

</div>

6862

6863

6864

6865

6866

6867

</div>

6868

6869

6870

6871

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

6872

6873

6874

6875

6876

6877

6878

6879

6880

6881

</li>

6882

6883

6884

6885

<code>config</code>

6886

6887

</li>

6888

6889

6890

6891

6892

6893

</li>

6894

6895

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

6896

</div>

6897

6898

6899

6900

6901

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

6902

</span>

6903

6904

6905

6906

6907

6908

6909

6910

6911

6912

6913

6914

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

6915

6916

6917

6918

6919

6920

<p>Inherited from

6921

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

6922

6923

6924

6925

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

6926

6927

</p>

6928

6929

6930

6931

6932

6933

</div>

6934

6935

6936

<p>

6937

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

6938

</p>

6939

6940

<p>

6941

The config argument object supports the following properties:

6942

</p>

6943

6944

<dl>

6945

<dt>value <Any></dt>

6946

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

6947

6948

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

6949

<dd>

6950

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

6951

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

6952

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

6953

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

6954

case the value property is used.</p>

6955

6956

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

6957

</dd>

6958

6959

<dt>readOnly <boolean></dt>

6960

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

6961

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

6962

6963

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

6964

<dd>

6965

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

6966

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

6967

constructor configuration arguments, or by invoking set.

6968

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

6969

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

6970

</dd>

6971

6972

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

6973

<dd>

6974

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

6975

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

6976

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

6977

the value from being stored.

6978

</p>

6979

6980

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

6981

</dd>

6982

6983

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

6984

<dd>

6985

<p>

6986

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

6987

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

6988

invoke get.

6989

</p>

6990

6991

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

6992

</dd>

6993

6994

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

6995

<dd>

6996

<p>

6997

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

6998

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

6999

</p>

7000

7001

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

7002

</dd>

7003

7004

<dt>lazyAdd <boolean></dt>

7005

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

7006

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

7007

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

7008

7009

</dl>

7010

7011

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

7012

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

7013

7014

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

7015

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

7016

</div>

7017

7018

7019

7020

<h4>Parameters:</h4>

7021

7022

7023

7024

7025

7026

7027

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

7028

7029

7030

7031

7032

7033

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

7034

</div>

7035

7036

7037

</li>

7038

7039

7040

7041

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

7042

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

7043

7044

7045

7046

7047

7048

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

7049

7050

<p>

7051

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

7052

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

7053

</p>

7054

</div>

7055

7056

7057

</li>

7058

7059

7060

7061

7062

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

7063

7064

7065

7066

7067

7068

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

7069

</div>

7070

7071

7072

</li>

7073

7074

</ul>

7075

</div>

7076

7077

7078

7079

7080

<h4>Returns:</h4>

7081

7082

7083

7084

7085

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

7086

7087

A reference to the host object.

7088

7089

</div>

7090

</div>

7091

7092

7093

7094

</div>

7095

7096

7097

7098

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

7099

7100

7101

7102

7103

7104

7105

7106

7107

7108

</li>

7109

7110

7111

7112

<code>values</code>

7113

7114

</li>

7115

7116

7117

7118

7119

7120

</li>

7121

7122

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

7123

</div>

7124

7125

7126

7127

7128

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

7129

</span>

7130

7131

7132

7133

7134

7135

7136

7137

7138

7139

7140

7141

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

7142

7143

7144

7145

7146

7147

<p>Inherited from

7148

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

7149

7150

7151

7152

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

7153

7154

</p>

7155

7156

7157

7158

7159

7160

</div>

7161

7162

7163

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

7164

7165

<p>

7166

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

7167

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

7168

</p>

7169

</div>

7170

7171

7172

7173

<h4>Parameters:</h4>

7174

7175

7176

7177

7178

7179

7180

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

7181

7182

7183

7184

7185

7186

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

7187

</div>

7188

7189

7190

</li>

7191

7192

7193

7194

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

7195

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

7196

7197

7198

7199

7200

7201

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

7202

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

7203

</div>

7204

7205

7206

</li>

7207

7208

7209

7210

7211

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

7212

7213

7214

7215

7216

7217

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

7218

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

7219

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

7220

</div>

7221

7222

7223

</li>

7224

7225

</ul>

7226

</div>

7227

7228

7229

7230

7231

<h4>Returns:</h4>

7232

7233

7234

7235

7236

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

7237

7238

A reference to the host object.

7239

7240

</div>

7241

</div>

7242

7243

7244

7245

</div>

7246

7247

7248

7249

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

7250

7251

7252

7253

7254

7255

7256

7257

7258

7259

</li>

7260

7261

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

7262

</div>

7263

7264

7265

7266

7267

7268

7269

7270

7271

7272

7273

7274

7275

7276

7277

7278

7279

7280

<p>Inherited from

7281

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

7282

7283

7284

7285

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

7286

7287

</p>

7288

7289

7290

7291

7292

7293

</div>

7294

7295

7296

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

7297

is determined by the order registered. Multiple targets can

7298

be specified.</p>

7299

7300

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

7301

7302

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

7303

</div>

7304

7305

7306

7307

<h4>Parameters:</h4>

7308

7309

7310

7311

7312

7313

7314

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

7315

7316

7317

7318

7319

7320

<p>the target to add</p>

7321

</div>

7322

7323

7324

</li>

7325

7326

</ul>

7327

</div>

7328

7329

7330

7331

7332

7333

</div>

7334

7335

7336

7337

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

7338

7339

7340

7341

7342

7343

7344

7345

7346

7347

</li>

7348

7349

7350

7351

7352

7353

</li>

7354

7355

7356

7357

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

7358

7359

</li>

7360

7361

7362

7363

7364

7365

</li>

7366

7367

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

7368

</div>

7369

7370

7371

7372

7373

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

7374

</span>

7375

7376

7377

7378

7379

7380

7381

7382

7383

7384

7385

7386

7387

7388

7389

7390

<p>Inherited from

7391

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

7392

7393

7394

7395

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

7396

7397

</p>

7398

7399

7400

7401

7402

7403

</div>

7404

7405

7406

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

7407

supplied callback will execute after any listeners add

7408

via the subscribe method, and after the default function,

7409

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

7410

</div>

7411

7412

7413

7414

<h4>Parameters:</h4>

7415

7416

7417

7418

7419

7420

7421

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

7422

7423

7424

7425

7426

7427

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

7428

</div>

7429

7430

7431

</li>

7432

7433

7434

7435

7436

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

7437

7438

7439

7440

7441

7442

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

7443

</div>

7444

7445

7446

</li>

7447

7448

7449

7450

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

7451

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

7452

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

7453

7454

7455

7456

7457

7458

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

7459

</div>

7460

7461

7462

</li>

7463

7464

7465

7466

7467

7468

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

7469

7470

7471

7472

7473

7474

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

7475

</div>

7476

7477

7478

</li>

7479

7480

</ul>

7481

</div>

7482

7483

7484

7485

7486

<h4>Returns:</h4>

7487

7488

7489

7490

7491

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

7492

7493

A subscription handle capable of detaching the

7494

subscription

7495

7496

</div>

7497

</div>

7498

7499

7500

7501

</div>

7502

7503

7504

7505

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

7506

7507

7508

7509

7510

7511

7512

7513

7514

7515

</li>

7516

7517

7518

7519

7520

7521

</li>

7522

7523

7524

7525

<code>context</code>

7526

7527

</li>

7528

7529

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

7530

</div>

7531

7532

7533

7534

7535

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

7536

</span>

7537

7538

7539

7540

7541

7542

7543

7544

7545

7546

7547

7548

7549

7550

7551

7552

<p>Inherited from

7553

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

7554

7555

7556

7557

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

7558

7559

</p>

7560

7561

7562

7563

7564

7565

</div>

7566

7567

7568

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

7569

7570

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

7571

</div>

7572

7573

7574

7575

<h4>Parameters:</h4>

7576

7577

7578

7579

7580

7581

7582

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

7583

7584

7585

7586

7587

7588

<p>The event type.</p>

7589

</div>

7590

7591

7592

</li>

7593

7594

7595

7596

7597

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

7598

7599

7600

7601

7602

7603

<p>The listener.</p>

7604

</div>

7605

7606

7607

</li>

7608

7609

7610

7611

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

7612

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

7613

7614

7615

7616

7617

7618

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

7619

</div>

7620

7621

7622

</li>

7623

7624

</ul>

7625

</div>

7626

7627

7628

7629

7630

<h4>Returns:</h4>

7631

7632

7633

7634

7635

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

7636

7637

handle The detach handle for the listener.

7638

7639

</div>

7640

</div>

7641

7642

7643

7644

</div>

7645

7646

7647

7648

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

7649

7650

7651

7652

7653

7654

7655

7656

<code>method</code>

7657

7658

</li>

7659

7660

7661

7662

7663

7664

</li>

7665

7666

7667

7668

<code>context</code>

7669

7670

</li>

7671

7672

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

7673

</div>

7674

7675

7676

7677

7678

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

7679

</span>

7680

7681

7682

7683

7684

7685

7686

7687

7688

7689

7690

7691

7692

7693

7694

7695

<p>Inherited from

7696

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

7697

7698

7699

7700

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

7701

7702

</p>

7703

7704

7705

7706

7707

7708

</div>

7709

7710

7711

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

7712

7713

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

7714

</div>

7715

7716

7717

7718

<h4>Parameters:</h4>

7719

7720

7721

7722

7723

7724

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

7725

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

7726

7727

7728

7729

7730

7731

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

7732

</div>

7733

7734

7735

</li>

7736

7737

7738

7739

7740

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

7741

7742

7743

7744

7745

7746

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

7747

</div>

7748

7749

7750

</li>

7751

7752

7753

7754

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

7755

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

7756

7757

7758

7759

7760

7761

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

7762

</div>

7763

7764

7765

</li>

7766

7767

</ul>

7768

</div>

7769

7770

7771

7772

7773

<h4>Returns:</h4>

7774

7775

7776

7777

7778

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

7779

7780

handle The detach handle for the injected function.

7781

7782

</div>

7783

</div>

7784

7785

7786

7787

</div>

7788

7789

7790

7791

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

7792

7793

7794

7795

7796

7797

7798

7799

7800

7801

</li>

7802

7803

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

7804

</div>

7805

7806

7807

7808

7809

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

7810

</span>

7811

7812

7813

7814

7815

7816

7817

7818

7819

7820

7821

7822

7823

7824

7825

7826

<p>Inherited from

7827

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

7828

7829

7830

7831

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

7832

7833

</p>

7834

7835

7836

7837

7838

7839

</div>

7840

7841

7842

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

7843

</div>

7844

7845

7846

7847

<h4>Parameters:</h4>

7848

7849

7850

7851

7852

7853

7854

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

7855

7856

7857

7858

7859

7860

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

7861

</div>

7862

7863

7864

</li>

7865

7866

</ul>

7867

</div>

7868

7869

7870

7871

7872

<h4>Returns:</h4>

7873

7874

7875

7876

7877

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

7878

7879

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.

7880

7881

</div>

7882

</div>

7883

7884

7885

7886

</div>

7887

7888

7889

7890

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

7891

7892

7893

7894

7895

7896

7897

7898

7899

</span>

7900

7901

7902

7903

7904

7905

7906

7907

7908

7909

7910

7911

7912

7913

7914

7915

<p>Inherited from

7916

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

7917

7918

7919

7920

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

7921

7922

</p>

7923

7924

7925

7926

7927

7928

</div>

7929

7930

7931

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

7932

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

7933

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

7934

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

7935

7936

<p>For DOM and custom events:

7937

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

7938

7939

<p>For methods:

7940

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

7941

</div>

7942

7943

7944

7945

7946

7947

<h4>Returns:</h4>

7948

7949

7950

7951

7952

detach handle

7953

7954

</div>

7955

</div>

7956

7957

7958

7959

</div>

7960

7961

7962

7963

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

7964

7965

7966

7967

7968

7969

7970

7971

<code>method</code>

7972

7973

</li>

7974

7975

7976

7977

7978

7979

</li>

7980

7981

7982

7983

<code>context</code>

7984

7985

</li>

7986

7987

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

7988

</div>

7989

7990

7991

7992

7993

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

7994

</span>

7995

7996

7997

7998

7999

8000

8001

8002

8003

8004

8005

8006

8007

8008

8009

8010

<p>Inherited from

8011

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

8012

8013

8014

8015

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

8016

8017

</p>

8018

8019

8020

8021

8022

8023

</div>

8024

8025

8026

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

8027

8028

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

8029

</div>

8030

8031

8032

8033

<h4>Parameters:</h4>

8034

8035

8036

8037

8038

8039

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

8040

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

8041

8042

8043

8044

8045

8046

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

8047

</div>

8048

8049

8050

</li>

8051

8052

8053

8054

8055

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

8056

8057

8058

8059

8060

8061

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

8062

</div>

8063

8064

8065

</li>

8066

8067

8068

8069

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

8070

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

8071

8072

8073

8074

8075

8076

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

8077

</div>

8078

8079

8080

</li>

8081

8082

</ul>

8083

</div>

8084

8085

8086

8087

8088

<h4>Returns:</h4>

8089

8090

8091

8092

8093

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

8094

8095

handle The detach handle for the injected function.

8096

8097

</div>

8098

</div>

8099

8100

8101

8102

</div>

8103

8104

8105

8106

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

8107

8108

8109

8110

8111

8112

8113

8114

8115

8116

</li>

8117

8118

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

8119

</div>

8120

8121

8122

8123

8124

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</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_bubble">EventTarget</a>:

8143

8144

8145

8146

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

8147

8148

</p>

8149

8150

8151

8152

8153

8154

</div>

8155

8156

8157

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

8158

</div>

8159

8160

8161

8162

<h4>Parameters:</h4>

8163

8164

8165

8166

8167

8168

8169

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

8170

8171

8172

8173

8174

8175

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

8176

</div>

8177

8178

8179

</li>

8180

8181

</ul>

8182

</div>

8183

8184

8185

8186

8187

<h4>Returns:</h4>

8188

8189

8190

8191

8192

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

8193

8194

the aggregated return value from Event.Custom.fire

8195

8196

</div>

8197

</div>

8198

8199

8200

8201

</div>

8202

8203

8204

8205

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

8206

8207

8208

8209

8210

8211

8212

8213

8214

</span>

8215

8216

8217

8218

8219

8220

8221

8222

8223

8224

8225

8226

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

8227

8228

8229

8230

8231

<p>Inherited from

8232

8233

BaseCore

8234

</a>

8235

8236

but overwritten in

8237

8238

8239

8240

8241

8242

</p>

8243

8244

8245

8246

8247

8248

</div>

8249

8250

8251

<p>

8252

Destroy lifecycle method. Fires the destroy

8253

event, prior to invoking destructors for the

8254

class hierarchy.

8255

</p>

8256

8257

<p>

8258

Subscribers to the destroy

8259

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

8260

from proceeding.

8261

</p>

8262

</div>

8263

8264

8265

8266

8267

8268

<h4>Returns:</h4>

8269

8270

8271

8272

8273

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

8274

8275

A reference to this object

8276

8277

</div>

8278

</div>

8279

8280

8281

8282

</div>

8283

8284

8285

8286

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

8287

8288

8289

8290

8291

8292

8293

8294

8295

8296

8297

8298

8299

8300

8301

8302

8303

8304

8305

8306

8307

<p>Inherited from

8308

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

8309

8310

8311

8312

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

8313

8314

</p>

8315

8316

8317

8318

8319

8320

</div>

8321

8322

8323

<p>Destructor lifecycle implementation.</p>

8324

8325

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

8326

</div>

8327

8328

8329

8330

8331

8332

8333

</div>

8334

8335

8336

8337

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

8338

8339

8340

8341

8342

8343

8344

8345

8346

8347

</li>

8348

8349

8350

8351

8352

8353

</li>

8354

8355

8356

8357

<code>context</code>

8358

8359

</li>

8360

8361

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

8362

</div>

8363

8364

8365

8366

8367

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

8368

</span>

8369

8370

8371

8372

8373

8374

8375

8376

8377

8378

8379

8380

8381

8382

8383

8384

<p>Inherited from

8385

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

8386

8387

8388

8389

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

8390

8391

</p>

8392

8393

8394

8395

8396

8397

</div>

8398

8399

8400

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

8401

</div>

8402

8403

8404

8405

<h4>Parameters:</h4>

8406

8407

8408

8409

8410

8411

8412

8413

8414

8415

8416

8417

8418

<p>Either the handle to the subscriber or the

8419

type of event. If the type

8420

is not specified, it will attempt to remove

8421

the listener from all hosted events.</p>

8422

</div>

8423

8424

8425

</li>

8426

8427

8428

8429

8430

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

8431

8432

8433

8434

8435

8436

<p>The subscribed function to unsubscribe, if not

8437

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

8438

</div>

8439

8440

8441

</li>

8442

8443

8444

8445

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

8446

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

8447

8448

8449

8450

8451

8452

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

8453

optional, but if supplied will be used to

8454

disambiguate multiple listeners that are the same

8455

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

8456

that lives on the prototype)</p>

8457

</div>

8458

8459

8460

</li>

8461

8462

</ul>

8463

</div>

8464

8465

8466

8467

8468

<h4>Returns:</h4>

8469

8470

8471

8472

8473

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

8474

8475

the host

8476

8477

</div>

8478

</div>

8479

8480

8481

8482

</div>

8483

8484

8485

8486

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

8487

8488

8489

8490

8491

8492

8493

8494

8495

8496

</li>

8497

8498

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

8499

</div>

8500

8501

8502

8503

8504

8505

8506

8507

8508

8509

8510

8511

8512

8513

8514

8515

8516

8517

<p>Inherited from

8518

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

8519

8520

8521

8522

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

8523

8524

</p>

8525

8526

8527

8528

8529

8530

</div>

8531

8532

8533

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

8534

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

8535

be removed.</p>

8536

</div>

8537

8538

8539

8540

<h4>Parameters:</h4>

8541

8542

8543

8544

8545

8546

8547

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

8548

8549

8550

8551

8552

8553

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

8554

</div>

8555

8556

8557

</li>

8558

8559

</ul>

8560

</div>

8561

8562

8563

8564

8565

8566

</div>

8567

8568

8569

8570

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

8571

8572

8573

8574

8575

8576

8577

8578

<code>strMethod</code>

8579

8580

</li>

8581

8582

8583

8584

8585

8586

</li>

8587

8588

8589

8590

<code>context</code>

8591

8592

</li>

8593

8594

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

8595

</div>

8596

8597

8598

8599

8600

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

8601

</span>

8602

8603

8604

8605

8606

8607

8608

8609

8610

8611

8612

8613

8614

8615

8616

8617

<p>Inherited from

8618

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

8619

8620

8621

8622

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

8623

8624

</p>

8625

8626

8627

8628

8629

8630

</div>

8631

8632

8633

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

8634

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

8635

</div>

8636

8637

8638

8639

<h4>Parameters:</h4>

8640

8641

8642

8643

8644

8645

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

8646

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

8647

8648

8649

8650

8651

8652

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

8653

</div>

8654

8655

8656

</li>

8657

8658

8659

8660

8661

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

8662

8663

8664

8665

8666

8667

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

8668

</div>

8669

8670

8671

</li>

8672

8673

8674

8675

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

8676

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

8677

8678

8679

8680

8681

8682

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

8683

</div>

8684

8685

8686

</li>

8687

8688

</ul>

8689

</div>

8690

8691

8692

8693

8694

<h4>Returns:</h4>

8695

8696

8697

8698

8699

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

8700

8701

handle The detach handle for the listener.

8702

8703

</div>

8704

</div>

8705

8706

8707

8708

</div>

8709

8710

8711

8712

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

8713

8714

8715

8716

8717

8718

8719

8720

<code>strMethod</code>

8721

8722

</li>

8723

8724

8725

8726

8727

8728

</li>

8729

8730

8731

8732

<code>context</code>

8733

8734

</li>

8735

8736

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

8737

</div>

8738

8739

8740

8741

8742

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

8743

</span>

8744

8745

8746

8747

8748

8749

8750

8751

8752

8753

8754

8755

8756

8757

8758

8759

<p>Inherited from

8760

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

8761

8762

8763

8764

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

8765

8766

</p>

8767

8768

8769

8770

8771

8772

</div>

8773

8774

8775

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

8776

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

8777

</div>

8778

8779

8780

8781

<h4>Parameters:</h4>

8782

8783

8784

8785

8786

8787

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

8788

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

8789

8790

8791

8792

8793

8794

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

8795

</div>

8796

8797

8798

</li>

8799

8800

8801

8802

8803

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

8804

8805

8806

8807

8808

8809

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

8810

</div>

8811

8812

8813

</li>

8814

8815

8816

8817

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

8818

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

8819

8820

8821

8822

8823

8824

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

8825

</div>

8826

8827

8828

</li>

8829

8830

</ul>

8831

</div>

8832

8833

8834

8835

8836

<h4>Returns:</h4>

8837

8838

8839

8840

8841

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

8842

8843

handle The detach handle for the handler.

8844

8845

</div>

8846

</div>

8847

8848

8849

8850

</div>

8851

8852

8853

8854

8855

8856

8857

8858

8859

8860

8861

8862

8863

8864

</li>

8865

8866

8867

8868

<code>arguments</code>

8869

8870

</li>

8871

8872

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

8873

</div>

8874

8875

8876

8877

8878

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

8879

</span>

8880

8881

8882

8883

8884

8885

8886

8887

8888

8889

8890

8891

8892

8893

8894

8895

<p>Inherited from

8896

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

8897

8898

8899

8900

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

8901

8902

</p>

8903

8904

8905

8906

8907

8908

</div>

8909

8910

8911

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

8912

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

8913

following parameters.</p>

8914

8915

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

8916

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

8917

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

8918

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

8919

be published on this object first.</p>

8920

8921

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

8922

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

8923

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

8924

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

8925

in place of the original object.</p>

8926

</div>

8927

8928

8929

8930

<h4>Parameters:</h4>

8931

8932

8933

8934

8935

8936

8937

8938

8939

8940

8941

8942

8943

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

8944

a 'type' property.</p>

8945

</div>

8946

8947

8948

</li>

8949

8950

8951

8952

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

8953

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

8954

8955

8956

8957

8958

8959

<p>an arbitrary set of parameters to pass to

8960

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

8961

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

8962

parameter after the properties the object literal contains are copied to

8963

the event facade.</p>

8964

</div>

8965

8966

8967

</li>

8968

8969

</ul>

8970

</div>

8971

8972

8973

8974

8975

<h4>Returns:</h4>

8976

8977

8978

8979

8980

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

8981

8982

the event host

8983

8984

</div>

8985

</div>

8986

8987

8988

8989

</div>

8990

8991

8992

8993

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

8994

8995

8996

8997

8998

8999

9000

9001

9002

9003

9004

9005

9006

9007

9008

9009

9010

9011

9012

9013

9014

9015

<p>

9016

9017

Defined in

9018

9019

9020

9021

9022

<a href="../files/scrollview_js_scrollbars-plugin.js.html#l498"><code>scrollview/js/scrollbars-plugin.js:498</code></a>

9023

9024

</p>

9025

9026

9027

9028

9029

9030

</div>

9031

9032

9033

<p>Momentarily flash the scroll bars to indicate current scroll position</p>

9034

</div>

9035

9036

9037

9038

9039

9040

9041

</div>

9042

9043

9044

9045

9046

9047

9048

9049

9050

9051

9052

9053

9054

9055

</li>

9056

9057

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

9058

</div>

9059

9060

9061

9062

9063

9064

</span>

9065

9066

9067

9068

9069

9070

9071

9072

9073

9074

9075

9076

9077

9078

9079

9080

<p>Inherited from

9081

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

9082

9083

9084

9085

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

9086

9087

</p>

9088

9089

9090

9091

9092

9093

</div>

9094

9095

9096

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

9097

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

9098

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

9099

</div>

9100

9101

9102

9103

<h4>Parameters:</h4>

9104

9105

9106

9107

9108

9109

9110

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

9111

9112

9113

9114

9115

9116

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

9117

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

9118

</div>

9119

9120

9121

</li>

9122

9123

</ul>

9124

</div>

9125

9126

9127

9128

9129

<h4>Returns:</h4>

9130

9131

9132

9133

9134

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

9135

9136

The value of the attribute

9137

9138

</div>

9139

</div>

9140

9141

9142

9143

</div>

9144

9145

9146

9147

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

9148

9149

9150

9151

9152

9153

9154

9155

<code>attrs</code>

9156

9157

</li>

9158

9159

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

9160

</div>

9161

9162

9163

9164

9165

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

9166

</span>

9167

9168

9169

9170

9171

9172

9173

9174

9175

9176

9177

9178

9179

9180

9181

9182

<p>Inherited from

9183

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

9184

9185

9186

9187

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

9188

9189

</p>

9190

9191

9192

9193

9194

9195

</div>

9196

9197

9198

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

9199

</div>

9200

9201

9202

9203

<h4>Parameters:</h4>

9204

9205

9206

9207

9208

9209

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

9210

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

9211

9212

9213

9214

9215

9216

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

9217

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

9218

</div>

9219

9220

9221

</li>

9222

9223

</ul>

9224

</div>

9225

9226

9227

9228

9229

<h4>Returns:</h4>

9230

9231

9232

9233

9234

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

9235

9236

An object with attribute name/value pairs.

9237

9238

</div>

9239

</div>

9240

9241

9242

9243

</div>

9244

9245

9246

9247

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

9248

9249

9250

9251

9252

9253

9254

9255

9256

9257

</li>

9258

9259

9260

9261

<code>prefixed</code>

9262

9263

</li>

9264

9265

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

9266

</div>

9267

9268

9269

9270

9271

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

9272

</span>

9273

9274

9275

9276

9277

9278

9279

9280

9281

9282

9283

9284

9285

9286

9287

9288

<p>Inherited from

9289

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

9290

9291

9292

9293

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

9294

9295

</p>

9296

9297

9298

9299

9300

9301

</div>

9302

9303

9304

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

9305

falsy value otherwise</p>

9306

</div>

9307

9308

9309

9310

<h4>Parameters:</h4>

9311

9312

9313

9314

9315

9316

9317

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

9318

9319

9320

9321

9322

9323

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

9324

</div>

9325

9326

9327

</li>

9328

9329

9330

9331

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

9332

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

9333

9334

9335

9336

9337

9338

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

9339

</div>

9340

9341

9342

</li>

9343

9344

</ul>

9345

</div>

9346

9347

9348

9349

9350

<h4>Returns:</h4>

9351

9352

9353

9354

9355

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

9356

9357

the custom event or null

9358

9359

</div>

9360

</div>

9361

9362

9363

9364

</div>

9365

9366

9367

9368

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

9369

9370

9371

9372

9373

9374

9375

9376

9377

</span>

9378

9379

9380

9381

9382

9383

9384

9385

9386

9387

9388

9389

9390

9391

9392

9393

<p>Inherited from

9394

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

9395

9396

9397

9398

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

9399

9400

</p>

9401

9402

9403

9404

9405

9406

</div>

9407

9408

9409

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

9410

</div>

9411

9412

9413

9414

9415

9416

<h4>Returns:</h4>

9417

9418

9419

9420

9421

EventTarget[]

9422

9423

</div>

9424

</div>

9425

9426

9427

9428

</div>

9429

9430

9431

9432

9433

9434

9435

9436

9437

9438

9439

9440

<code>animated</code>

9441

9442

</li>

9443

9444

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

9445

</div>

9446

9447

9448

9449

9450

9451

9452

9453

9454

9455

9456

9457

9458

9459

9460

9461

9462

9463

9464

<p>

9465

9466

Defined in

9467

9468

9469

9470

9471

<a href="../files/scrollview_js_scrollbars-plugin.js.html#l450"><code>scrollview/js/scrollbars-plugin.js:450</code></a>

9472

9473

</p>

9474

9475

9476

9477

9478

9479

</div>

9480

9481

9482

<p>Hide the scroll bar indicators</p>

9483

</div>

9484

9485

9486

9487

<h4>Parameters:</h4>

9488

9489

9490

9491

9492

9493

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

9494

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

9495

9496

9497

9498

9499

9500

<p>Whether or not to animate the hiding</p>

9501

</div>

9502

9503

9504

</li>

9505

9506

</ul>

9507

</div>

9508

9509

9510

9511

9512

9513

</div>

9514

9515

9516

9517

9518

9519

9520

9521

9522

9523

9524

9525

<code>config</code>

9526

9527

</li>

9528

9529

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

9530

</div>

9531

9532

9533

9534

9535

9536

</span>

9537

9538

9539

9540

9541

9542

9543

9544

9545

9546

9547

9548

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

9549

9550

9551

9552

9553

<p>Inherited from

9554

9555

BaseCore

9556

</a>

9557

9558

but overwritten in

9559

9560

9561

9562

9563

9564

</p>

9565

9566

9567

9568

9569

9570

</div>

9571

9572

9573

<p>Init lifecycle method, invoked during construction.

9574

Fires the init event prior to setting up attributes and

9575

invoking initializers for the class hierarchy.</p>

9576

</div>

9577

9578

9579

9580

<h4>Parameters:</h4>

9581

9582

9583

9584

9585

9586

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

9587

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

9588

9589

9590

9591

9592

9593

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

9594

</div>

9595

9596

9597

</li>

9598

9599

</ul>

9600

</div>

9601

9602

9603

9604

9605

<h4>Returns:</h4>

9606

9607

9608

9609

9610

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

9611

9612

A reference to this object

9613

9614

</div>

9615

</div>

9616

9617

9618

9619

</div>

9620

9621

9622

9623

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

9624

9625

9626

9627

9628

9629

9630

9631

9632

9633

9634

9635

9636

9637

9638

9639

9640

9641

9642

9643

<p>Inherited from

9644

9645

Plugin.Base

9646

</a>

9647

9648

but overwritten in

9649

9650

9651

9652

<a href="../files/scrollview_js_scrollbars-plugin.js.html#l142"><code>scrollview/js/scrollbars-plugin.js:142</code></a>

9653

9654

</p>

9655

9656

9657

9658

9659

9660

</div>

9661

9662

9663

<p>Designated initializer</p>

9664

</div>

9665

9666

9667

9668

9669

9670

9671

</div>

9672

9673

9674

9675

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

9676

9677

9678

9679

9680

9681

9682

9683

9684

9685

</li>

9686

9687

9688

9689

<code>config</code>

9690

9691

</li>

9692

9693

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

9694

</div>

9695

9696

9697

9698

9699

9700

9701

9702

9703

9704

9705

9706

9707

9708

9709

9710

9711

9712

<p>Inherited from

9713

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

9714

9715

9716

9717

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

9718

9719

</p>

9720

9721

9722

9723

9724

9725

</div>

9726

9727

9728

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

9729

9730

<p>

9731

The properties which can be modified through this interface are limited

9732

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

9733

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

9734

broadcast and getter.

9735

</p>

9736

</div>

9737

9738

9739

9740

<h4>Parameters:</h4>

9741

9742

9743

9744

9745

9746

9747

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

9748

9749

9750

9751

9752

9753

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

9754

</div>

9755

9756

9757

</li>

9758

9759

9760

9761

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

9762

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

9763

9764

9765

9766

9767

9768

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

9769

</div>

9770

9771

9772

</li>

9773

9774

</ul>

9775

</div>

9776

9777

9778

9779

9780

9781

</div>

9782

9783

9784

9785

9786

9787

9788

9789

9790

9791

9792

9793

9794

9795

</li>

9796

9797

9798

9799

9800

9801

</li>

9802

9803

9804

9805

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

9806

9807

</li>

9808

9809

9810

9811

9812

9813

</li>

9814

9815

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

9816

</div>

9817

9818

9819

9820

9821

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

9822

</span>

9823

9824

9825

9826

9827

9828

9829

9830

9831

9832

9833

9834

9835

9836

9837

9838

<p>Inherited from

9839

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

9840

9841

9842

9843

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

9844

9845

</p>

9846

9847

9848

9849

9850

9851

</div>

9852

9853

9854

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

9855

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

9856

9857

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

9858

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

9859

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

9860

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

9861

API for all available properties and methods. Subscribers to

9862

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

9863

after the event name.</p>

9864

9865

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

9866

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

9867

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

9868

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

9869

9870

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

9871

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

9872

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

9873

</div>

9874

9875

9876

9877

<h4>Parameters:</h4>

9878

9879

9880

9881

9882

9883

9884

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

9885

9886

9887

9888

9889

9890

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

9891

</div>

9892

9893

9894

</li>

9895

9896

9897

9898

9899

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

9900

9901

9902

9903

9904

9905

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

9906

</div>

9907

9908

9909

</li>

9910

9911

9912

9913

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

9914

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

9915

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

9916

9917

9918

9919

9920

9921

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

9922

</div>

9923

9924

9925

</li>

9926

9927

9928

9929

9930

9931

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

9932

9933

9934

9935

9936

9937

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

9938

</div>

9939

9940

9941

</li>

9942

9943

</ul>

9944

</div>

9945

9946

9947

9948

9949

<h4>Returns:</h4>

9950

9951

9952

9953

9954

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

9955

9956

A subscription handle capable of detaching that

9957

subscription

9958

9959

</div>

9960

</div>

9961

9962

9963

9964

</div>

9965

9966

9967

9968

9969

9970

9971

9972

9973

9974

9975

9976

9977

9978

</li>

9979

9980

9981

9982

9983

9984

</li>

9985

9986

9987

9988

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

9989

9990

</li>

9991

9992

9993

9994

9995

9996

</li>

9997

9998

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

9999

</div>

10000

10001

10002

10003

10004

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

10005

</span>

10006

10007

10008

10009

10010

10011

10012

10013

10014

10015

10016

10017

10018

10019

10020

10021

<p>Inherited from

10022

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

10023

10024

10025

10026

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

10027

10028

</p>

10029

10030

10031

10032

10033

10034

</div>

10035

10036

10037

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

10038

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

10039

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

10040

</div>

10041

10042

10043

10044

<h4>Parameters:</h4>

10045

10046

10047

10048

10049

10050

10051

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

10052

10053

10054

10055

10056

10057

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

10058

</div>

10059

10060

10061

</li>

10062

10063

10064

10065

10066

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

10067

10068

10069

10070

10071

10072

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

10073

</div>

10074

10075

10076

</li>

10077

10078

10079

10080

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

10081

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

10082

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

10083

10084

10085

10086

10087

10088

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

10089

</div>

10090

10091

10092

</li>

10093

10094

10095

10096

10097

10098

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

10099

10100

10101

10102

10103

10104

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

10105

</div>

10106

10107

10108

</li>

10109

10110

</ul>

10111

</div>

10112

10113

10114

10115

10116

<h4>Returns:</h4>

10117

10118

10119

10120

10121

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

10122

10123

A subscription handle capable of detaching the

10124

subscription

10125

10126

</div>

10127

</div>

10128

10129

10130

10131

</div>

10132

10133

10134

10135

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

10136

10137

10138

10139

10140

10141

10142

10143

10144

10145

</li>

10146

10147

10148

10149

10150

10151

</li>

10152

10153

10154

10155

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

10156

10157

</li>

10158

10159

10160

10161

10162

10163

</li>

10164

10165

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

10166

</div>

10167

10168

10169

10170

10171

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

10172

</span>

10173

10174

10175

10176

10177

10178

10179

10180

10181

10182

10183

10184

10185

10186

10187

10188

<p>Inherited from

10189

<a href="../classes/EventTarget.html#method_onceAfter">EventTarget</a>:

10190

10191

10192

10193

<a href="../files/event-custom_js_event-target.js.html#l150"><code>event-custom/js/event-target.js:150</code></a>

10194

10195

</p>

10196

10197

10198

10199

10200

10201

</div>

10202

10203

10204

<p>Listen to a custom event hosted by this object one time.

10205

This is the equivalent to <code>after</code> except the

10206

listener is immediatelly detached when it is executed.</p>

10207

</div>

10208

10209

10210

10211

<h4>Parameters:</h4>

10212

10213

10214

10215

10216

10217

10218

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

10219

10220

10221

10222

10223

10224

<p>The name of the event</p>

10225

</div>

10226

10227

10228

</li>

10229

10230

10231

10232

10233

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function</a></span>

10234

10235

10236

10237

10238

10239

<p>The callback to execute in response to the event</p>

10240

</div>

10241

10242

10243

</li>

10244

10245

10246

10247

<code class="param-name optional">[context]</code>

10248

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>

10249

<span class="flag optional" title="This parameter is optional.">optional</span>

10250

10251

10252

10253

10254

10255

<p>Override <code>this</code> object in callback</p>

10256

</div>

10257

10258

10259

</li>

10260

10261

10262

10263

10264

10265

<span class="flag optional" title="This parameter is optional.">optional</span>

10266

10267

10268

10269

10270

10271

<p>0..n additional arguments to supply to the subscriber</p>

10272

</div>

10273

10274

10275

</li>

10276

10277

</ul>

10278

</div>

10279

10280

10281

10282

10283

<h4>Returns:</h4>

10284

10285

10286

10287

10288

<span class="type"><a href="../classes/EventHandle.html" class="crosslink">EventHandle</a></span>:

10289

10290

A subscription handle capable of detaching that

10291

subscription

10292

10293

</div>

10294

</div>

10295

10296

10297

10298

</div>

10299

10300

10301

10302

<h3 class="name"><code>onHostEvent</code></h3>

10303

10304

10305

10306

10307

10308

10309

10310

10311

10312

</li>

10313

10314

10315

10316

10317

10318

</li>

10319

10320

10321

10322

<code>context</code>

10323

10324

</li>

10325

10326

</ul><span class="paren">)</span>

10327

</div>

10328

10329

10330

10331

10332

<span class="type"><a href="../classes/EventHandle.html" class="crosslink">EventHandle</a></span>

10333

</span>

10334

10335

10336

10337

10338

10339

10340

10341

10342

10343

10344

10345

10346

10347

10348

10349

<p>Inherited from

10350

<a href="../classes/Plugin.Base.html#method_onHostEvent">Plugin.Base</a>:

10351

10352

10353

10354

<a href="../files/plugin_js_plugin.js.html#l151"><code>plugin/js/plugin.js:151</code></a>

10355

10356

</p>

10357

10358

10359

10360

10361

10362

</div>

10363

10364

10365

<p>Listens for the "on" moment of events fired by the host object.</p>

10366

10367

<p>Listeners attached through this method will be detached when the plugin is unplugged.</p>

10368

</div>

10369

10370

10371

10372

<h4>Parameters:</h4>

10373

10374

10375

10376

10377

10378

10379

10380

10381

10382

10383

10384

10385

<p>The event type.</p>

10386

</div>

10387

10388

10389

</li>

10390

10391

10392

10393

10394

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function</a></span>

10395

10396

10397

10398

10399

10400

<p>The listener.</p>

10401

</div>

10402

10403

10404

</li>

10405

10406

10407

10408

<code class="param-name">context</code>

10409

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>

10410

10411

10412

10413

10414

10415

<p>The execution context. Defaults to the plugin instance.</p>

10416

</div>

10417

10418

10419

</li>

10420

10421

</ul>

10422

</div>

10423

10424

10425

10426

10427

<h4>Returns:</h4>

10428

10429

10430

10431

10432

<span class="type"><a href="../classes/EventHandle.html" class="crosslink">EventHandle</a></span>:

10433

10434

handle The detach handle for the listener.

10435

10436

</div>

10437

</div>

10438

10439

10440

10441

</div>

10442

10443

10444

10445

<h3 class="name"><code>parseType</code></h3>

10446

10447

10448

10449

10450

10451

10452

10453

10454

10455

</li>

10456

10457

10458

10459

<code class="optional">[pre=this._yuievt.config.prefix]</code>

10460

10461

</li>

10462

10463

</ul><span class="paren">)</span>

10464

</div>

10465

10466

10467

10468

10469

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Array" class="crosslink external" target="_blank">Array</a></span>

10470

</span>

10471

10472

10473

10474

10475

10476

10477

10478

10479

10480

10481

10482

10483

10484

10485

10486

<p>Inherited from

10487

<a href="../classes/EventTarget.html#method_parseType">EventTarget</a>:

10488

10489

10490

10491

<a href="../files/event-custom_js_event-target.js.html#l172"><code>event-custom/js/event-target.js:172</code></a>

10492

10493

</p>

10494

10495

10496

10497

10498

10499

<p>Available since 3.3.0</p>

10500

10501

</div>

10502

10503

10504

<p>Takes the type parameter passed to 'on' and parses out the

10505

various pieces that could be included in the type. If the

10506

event type is passed without a prefix, it will be expanded

10507

to include the prefix one is supplied or the event target

10508

is configured with a default prefix.</p>

10509

</div>

10510

10511

10512

10513

<h4>Parameters:</h4>

10514

10515

10516

10517

10518

10519

10520

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

10521

10522

10523

10524

10525

10526

10527

</div>

10528

10529

10530

</li>

10531

10532

10533

10534

<code class="param-name optional">[pre=this._yuievt.config.prefix]</code>

10535

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

10536

<span class="flag optional" title="This parameter is optional.">optional</span>

10537

10538

10539

10540

10541

10542

<p>the prefix</p>

10543

</div>

10544

10545

10546

</li>

10547

10548

</ul>

10549

</div>

10550

10551

10552

10553

10554

<h4>Returns:</h4>

10555

10556

10557

10558

10559

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Array" class="crosslink external" target="_blank">Array</a></span>:

10560

10561

an array containing:

10562

* the detach category, if supplied,

10563

* the prefixed event type,

10564

* whether or not this is an after listener,

10565

* the supplied event type

10566

10567

</div>

10568

</div>

10569

10570

10571

10572

</div>

10573

10574

10575

10576

<h3 class="name"><code>publish</code></h3>

10577

10578

10579

10580

10581

10582

10583

10584

10585

10586

</li>

10587

10588

10589

10590

10591

10592

</li>

10593

10594

</ul><span class="paren">)</span>

10595

</div>

10596

10597

10598

10599

10600

<span class="type"><a href="../classes/CustomEvent.html" class="crosslink">CustomEvent</a></span>

10601

</span>

10602

10603

10604

10605

10606

10607

10608

10609

10610

10611

10612

10613

10614

10615

10616

10617

<p>Inherited from

10618

<a href="../classes/EventTarget.html#method_publish">EventTarget</a>:

10619

10620

10621

10622

<a href="../files/event-custom_js_event-target.js.html#l489"><code>event-custom/js/event-target.js:489</code></a>

10623

10624

</p>

10625

10626

10627

10628

10629

10630

</div>

10631

10632

10633

<p>Creates a new custom event of the specified type. If a custom event

10634

by that name already exists, it will not be re-created. In either

10635

case the custom event is returned.</p>

10636

</div>

10637

10638

10639

10640

<h4>Parameters:</h4>

10641

10642

10643

10644

10645

10646

10647

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

10648

10649

10650

10651

10652

10653

<p>the type, or name of the event</p>

10654

</div>

10655

10656

10657

</li>

10658

10659

10660

10661

10662

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>

10663

10664

10665

10666

10667

10668

<p>optional config params. Valid properties are:</p>

10669

10670

<p><ul>

10671

<li>

10672

'broadcast': whether or not the YUI instance and YUI global are notified when the event is fired (false)

10673

</li>

10674

<li>

10675

'bubbles': whether or not this event bubbles (true)

10676

Events can only bubble if emitFacade is true.

10677

</li>

10678

<li>

10679

'context': the default execution context for the listeners (this)

10680

</li>

10681

<li>

10682

'defaultFn': the default function to execute when this event fires if preventDefault was not called

10683

</li>

10684

<li>

10685

'emitFacade': whether or not this event emits a facade (false)

10686

</li>

10687

<li>

10688

'prefix': the prefix for this targets events, e.g., 'menu' in 'menu:click'

10689

</li>

10690

<li>

10691

'fireOnce': if an event is configured to fire once, new subscribers after

10692

the fire will be notified immediately.

10693

</li>

10694

<li>

10695

'async': fireOnce event listeners will fire synchronously if the event has already

10696

fired unless async is true.

10697

</li>

10698

<li>

10699

'preventable': whether or not preventDefault() has an effect (true)

10700

</li>

10701

<li>

10702

'preventedFn': a function that is executed when preventDefault is called

10703

</li>

10704

<li>

10705

'queuable': whether or not this event can be queued during bubbling (false)

10706

</li>

10707

<li>

10708

'silent': if silent is true, debug messages are not provided for this event.

10709

</li>

10710

<li>

10711

'stoppedFn': a function that is executed when stopPropagation is called

10712

</li></p>

10713

10714

<p><li>

10715

'monitored': specifies whether or not this event should send notifications about

10716

when the event has been attached, detached, or published.

10717

</li>

10718

<li>

10719

'type': the event type (valid option if not provided as the first parameter to publish)

10720

</li>

10721

</ul></p>

10722

</div>

10723

10724

10725

</li>

10726

10727

</ul>

10728

</div>

10729

10730

10731

10732

10733

<h4>Returns:</h4>

10734

10735

10736

10737

10738

<span class="type"><a href="../classes/CustomEvent.html" class="crosslink">CustomEvent</a></span>:

10739

10740

the custom event

10741

10742

</div>

10743

</div>

10744

10745

10746

10747

</div>

10748

10749

10750

10751

<h3 class="name"><code>removeAttr</code></h3>

10752

10753

10754

10755

10756

10757

10758

10759

10760

10761

</li>

10762

10763

</ul><span class="paren">)</span>

10764

</div>

10765

10766

10767

10768

10769

10770

10771

10772

10773

10774

10775

10776

10777

10778

10779

10780

10781

10782

<p>Inherited from

10783

<a href="../classes/AttributeExtras.html#method_removeAttr">AttributeExtras</a>:

10784

10785

10786

10787

<a href="../files/attribute_js_AttributeExtras.js.html#l77"><code>attribute/js/AttributeExtras.js:77</code></a>

10788

10789

</p>

10790

10791

10792

10793

10794

10795

</div>

10796

10797

10798

<p>Removes an attribute from the host object</p>

10799

</div>

10800

10801

10802

10803

<h4>Parameters:</h4>

10804

10805

10806

10807

10808

10809

10810

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

10811

10812

10813

10814

10815

10816

<p>The name of the attribute to be removed.</p>

10817

</div>

10818

10819

10820

</li>

10821

10822

</ul>

10823

</div>

10824

10825

10826

10827

10828

10829

</div>

10830

10831

10832

10833

<h3 class="name"><code>removeTarget</code></h3>

10834

10835

10836

10837

10838

10839

10840

10841

10842

10843

</li>

10844

10845

</ul><span class="paren">)</span>

10846

</div>

10847

10848

10849

10850

10851

10852

10853

10854

10855

10856

10857

10858

10859

10860

10861

10862

10863

10864

<p>Inherited from

10865

<a href="../classes/EventTarget.html#method_removeTarget">EventTarget</a>:

10866

10867

10868

10869

<a href="../files/event-custom_js_event-facade.js.html#l409"><code>event-custom/js/event-facade.js:409</code></a>

10870

10871

</p>

10872

10873

10874

10875

10876

10877

</div>

10878

10879

10880

<p>Removes a bubble target</p>

10881

</div>

10882

10883

10884

10885

<h4>Parameters:</h4>

10886

10887

10888

10889

10890

10891

10892

<span class="type"><a href="../classes/EventTarget.html" class="crosslink">EventTarget</a></span>

10893

10894

10895

10896

10897

10898

<p>the target to remove</p>

10899

</div>

10900

10901

10902

</li>

10903

10904

</ul>

10905

</div>

10906

10907

10908

10909

10910

10911

</div>

10912

10913

10914

10915

<h3 class="name"><code>reset</code></h3>

10916

10917

10918

10919

10920

10921

10922

10923

10924

10925

</li>

10926

10927

</ul><span class="paren">)</span>

10928

</div>

10929

10930

10931

10932

10933

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>

10934

</span>

10935

10936

10937

10938

10939

10940

10941

10942

10943

10944

10945

10946

<span class="flag chainable">chainable</span>

10947

10948

10949

10950

10951

10952

<p>Inherited from

10953

<a href="../classes/AttributeExtras.html#method_reset">AttributeExtras</a>:

10954

10955

10956

10957

<a href="../files/attribute_js_AttributeExtras.js.html#l87"><code>attribute/js/AttributeExtras.js:87</code></a>

10958

10959

</p>

10960

10961

10962

10963

10964

10965

</div>

10966

10967

10968

<p>Resets the attribute (or all attributes) to its initial value, as long as

10969

the attribute is not readOnly, or writeOnce.</p>

10970

</div>

10971

10972

10973

10974

<h4>Parameters:</h4>

10975

10976

10977

10978

10979

10980

10981

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

10982

10983

10984

10985

10986

10987

<p>Optional. The name of the attribute to reset. If omitted, all attributes are reset.</p>

10988

</div>

10989

10990

10991

</li>

10992

10993

</ul>

10994

</div>

10995

10996

10997

10998

10999

<h4>Returns:</h4>

11000

11001

11002

11003

11004

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>:

11005

11006

A reference to the host object.

11007

11008

</div>

11009

</div>

11010

11011

11012

11013

</div>

11014

11015

11016

11017

11018

11019

11020

11021

11022

11023

11024

11025

11026

11027

</li>

11028

11029

11030

11031

<code>value</code>

11032

11033

</li>

11034

11035

</ul><span class="paren">)</span>

11036

</div>

11037

11038

11039

11040

11041

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>

11042

</span>

11043

11044

11045

11046

11047

11048

11049

11050

11051

11052

11053

11054

<span class="flag chainable">chainable</span>

11055

11056

11057

11058

11059

<p>Inherited from

11060

11061

AttributeEvents

11062

</a>

11063

11064

but overwritten in

11065

11066

11067

11068

<a href="../files/attribute_js_AttributeCore.js.html#l328"><code>attribute/js/AttributeCore.js:328</code></a>

11069

11070

</p>

11071

11072

11073

11074

11075

11076

</div>

11077

11078

11079

<p>Sets the value of an attribute.</p>

11080

</div>

11081

11082

11083

11084

<h4>Parameters:</h4>

11085

11086

11087

11088

11089

11090

11091

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

11092

11093

11094

11095

11096

11097

<p>The name of the attribute. If the

11098

current value of the attribute is an Object, dot notation can be used

11099

to set the value of a property within the object (e.g. <code>set("x.y.z", 5)</code>).</p>

11100

</div>

11101

11102

11103

</li>

11104

11105

11106

11107

<code class="param-name">value</code>

11108

11109

11110

11111

11112

11113

11114

<p>The value to set the attribute to.</p>

11115

</div>

11116

11117

11118

</li>

11119

11120

</ul>

11121

</div>

11122

11123

11124

11125

11126

<h4>Returns:</h4>

11127

11128

11129

11130

11131

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>:

11132

11133

A reference to the host object.

11134

11135

</div>

11136

</div>

11137

11138

11139

11140

</div>

11141

11142

11143

11144

<h3 class="name"><code>setAttrs</code></h3>

11145

11146

11147

11148

11149

11150

11151

11152

<code>attrs</code>

11153

11154

</li>

11155

11156

</ul><span class="paren">)</span>

11157

</div>

11158

11159

11160

11161

11162

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>

11163

</span>

11164

11165

11166

11167

11168

11169

11170

11171

11172

11173

11174

11175

<span class="flag chainable">chainable</span>

11176

11177

11178

11179

11180

<p>Inherited from

11181

11182

AttributeEvents

11183

</a>

11184

11185

but overwritten in

11186

11187

11188

11189

<a href="../files/attribute_js_AttributeCore.js.html#l635"><code>attribute/js/AttributeCore.js:635</code></a>

11190

11191

</p>

11192

11193

11194

11195

11196

11197

</div>

11198

11199

11200

<p>Sets multiple attribute values.</p>

11201

</div>

11202

11203

11204

11205

<h4>Parameters:</h4>

11206

11207

11208

11209

11210

11211

<code class="param-name">attrs</code>

11212

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>

11213

11214

11215

11216

11217

11218

<p>An object with attributes name/value pairs.</p>

11219

</div>

11220

11221

11222

</li>

11223

11224

</ul>

11225

</div>

11226

11227

11228

11229

11230

<h4>Returns:</h4>

11231

11232

11233

11234

11235

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>:

11236

11237

A reference to the host object.

11238

11239

</div>

11240

</div>

11241

11242

11243

11244

</div>

11245

11246

11247

11248

11249

11250

11251

11252

11253

11254

11255

11256

<code>animated</code>

11257

11258

</li>

11259

11260

</ul><span class="paren">)</span>

11261

</div>

11262

11263

11264

11265

11266

11267

11268

11269

11270

11271

11272

11273

11274

11275

11276

11277

11278

11279

11280

<p>

11281

11282

Defined in

11283

11284

11285

11286

11287

<a href="../files/scrollview_js_scrollbars-plugin.js.html#l440"><code>scrollview/js/scrollbars-plugin.js:440</code></a>

11288

11289

</p>

11290

11291

11292

11293

11294

11295

</div>

11296

11297

11298

<p>Show the scroll bar indicators</p>

11299

</div>

11300

11301

11302

11303

<h4>Parameters:</h4>

11304

11305

11306

11307

11308

11309

<code class="param-name">animated</code>

11310

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>

11311

11312

11313

11314

11315

11316

<p>Whether or not to animate the showing</p>

11317

</div>

11318

11319

11320

</li>

11321

11322

</ul>

11323

</div>

11324

11325

11326

11327

11328

11329

</div>

11330

11331

11332

11333

<h3 class="name"><code>subscribe</code></h3>

11334

11335

11336

11337

11338

11339

11340

11341

11342

<span class="flag deprecated" title="use on">deprecated</span>

11343

11344

11345

11346

11347

11348

11349

11350

11351

11352

11353

11354

11355

11356

<p>Inherited from

11357

<a href="../classes/EventTarget.html#method_subscribe">EventTarget</a>:

11358

11359

11360

11361

<a href="../files/event-custom_js_event-target.js.html#l335"><code>event-custom/js/event-target.js:335</code></a>

11362

11363

</p>

11364

11365

11366

11367

<p>Deprecated: use on</p>

11368

11369

11370

11371

</div>

11372

11373

11374

<p>subscribe to an event</p>

11375

</div>

11376

11377

11378

11379

11380

11381

11382

</div>

11383

11384

11385

11386

<h3 class="name"><code>toString</code></h3>

11387

11388

11389

11390

11391

11392

11393

11394

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

11395

</span>

11396

11397

11398

11399

11400

11401

11402

11403

11404

11405

11406

11407

11408

11409

11410

11411

<p>Inherited from

11412

<a href="../classes/BaseCore.html#method_toString">BaseCore</a>:

11413

11414

11415

11416

<a href="../files/base_js_BaseCore.js.html#l592"><code>base/js/BaseCore.js:592</code></a>

11417

11418

</p>

11419

11420

11421

11422

11423

11424

</div>

11425

11426

11427

<p>Default toString implementation. Provides the constructor NAME

11428

and the instance guid, if set.</p>

11429

</div>

11430

11431

11432

11433

11434

11435

<h4>Returns:</h4>

11436

11437

11438

11439

11440

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>:

11441

11442

String representation for this object

11443

11444

</div>

11445

</div>

11446

11447

11448

11449

</div>

11450

11451

11452

11453

<h3 class="name"><code>unsubscribe</code></h3>

11454

11455

11456

11457

11458

11459

11460

11461

11462

<span class="flag deprecated" title="use detach">deprecated</span>

11463

11464

11465

11466

11467

11468

11469

11470

11471

11472

11473

11474

11475

11476

<p>Inherited from

11477

<a href="../classes/EventTarget.html#method_unsubscribe">EventTarget</a>:

11478

11479

11480

11481

<a href="../files/event-custom_js_event-target.js.html#l455"><code>event-custom/js/event-target.js:455</code></a>

11482

11483

</p>

11484

11485

11486

11487

<p>Deprecated: use detach</p>

11488

11489

11490

11491

</div>

11492

11493

11494

<p>detach a listener</p>

11495

</div>

11496

11497

11498

11499

11500

11501

11502

</div>

11503

11504

11505

11506

<h3 class="name"><code>unsubscribeAll</code></h3>

11507

11508

11509

11510

11511

11512

11513

11514

11515

11516

</li>

11517

11518

</ul><span class="paren">)</span>

11519

</div>

11520

11521

11522

11523

11524

11525

<span class="flag deprecated" title="use detachAll">deprecated</span>

11526

11527

11528

11529

11530

11531

11532

11533

11534

11535

11536

11537

11538

11539

<p>Inherited from

11540

<a href="../classes/EventTarget.html#method_unsubscribeAll">EventTarget</a>:

11541

11542

11543

11544

<a href="../files/event-custom_js_event-target.js.html#l476"><code>event-custom/js/event-target.js:476</code></a>

11545

11546

</p>

11547

11548

11549

11550

<p>Deprecated: use detachAll</p>

11551

11552

11553

11554

</div>

11555

11556

11557

<p>Removes all listeners from the specified event. If the event type

11558

is not specified, all listeners from all hosted custom events will

11559

be removed.</p>

11560

</div>

11561

11562

11563

11564

<h4>Parameters:</h4>

11565

11566

11567

11568

11569

11570

11571

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

11572

11573

11574

11575

11576

11577

<p>The type, or name of the event</p>

11578

</div>

11579

11580

11581

</li>

11582

11583

</ul>

11584

</div>

11585

11586

11587

11588

11589

11590

</div>

11591

11592

11593

</div>

11594

11595

11596

11597

11598

<h2 class="off-left">Properties</h2>

11599

11600

11601

11602

<h3 class="name"><code>_allowAdHocAttrs</code></h3>

11603

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>

11604

11605

11606

11607

11608

<span class="flag protected">protected</span>

11609

11610

11611

11612

11613

11614

11615

11616

11617

11618

<p>Inherited from

11619

<a href="../classes/BaseCore.html#property__allowAdHocAttrs">BaseCore</a>:

11620

11621

11622

11623

<a href="../files/base_js_BaseCore.js.html#l100"><code>base/js/BaseCore.js:100</code></a>

11624

11625

</p>

11626

11627

11628

11629

11630

</div>

11631

11632

11633

<p>This property controls whether or not instances of this class should

11634

allow users to add ad-hoc attributes through the constructor configuration

11635

hash.</p>

11636

11637

<p>AdHoc attributes are attributes which are not defined by the class, and are

11638

not handled by the MyClass.<em>NON</em>ATTRS_CFG</p>

11639

</div>

11640

11641

11642

<p><strong>Default:</strong> undefined (false)</p>

11643

11644

11645

11646

11647

11648

</div>

11649

11650

11651

11652

<h3 class="name"><code>_handles</code></h3>

11653

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Array" class="crosslink external" target="_blank">Array</a></span>

11654

11655

11656

11657

11658

<span class="flag private">private</span>

11659

11660

11661

11662

11663

11664

11665

11666

11667

11668

<p>Inherited from

11669

<a href="../classes/Plugin.Base.html#property__handles">Plugin.Base</a>:

11670

11671

11672

11673

<a href="../files/plugin_js_plugin.js.html#l66"><code>plugin/js/plugin.js:66</code></a>

11674

11675

</p>

11676

11677

11678

11679

11680

</div>

11681

11682

11683

<p>The list of event handles for event listeners or AOP injected methods

11684

applied by the plugin to the host object.</p>

11685

</div>

11686

11687

11688

11689

11690

11691

11692

</div>

11693

11694

11695

11696

<h3 class="name"><code>ATTRS</code></h3>

11697

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>

11698

11699

11700

11701

11702

11703

11704

11705

11706

<span class="flag static">static</span>

11707

11708

11709

11710

11711

11712

11713

<p>

11714

11715

Defined in

11716

11717

11718

11719

11720

<a href="../files/scrollview_js_scrollbars-plugin.js.html#l108"><code>scrollview/js/scrollbars-plugin.js:108</code></a>

11721

11722

</p>

11723

11724

11725

11726

11727

</div>

11728

11729

11730

<p>The default attribute configuration for the plugin</p>

11731

</div>

11732

11733

11734

11735

11736

11737

11738

</div>

11739

11740

11741

11742

11743

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

11744

11745

11746

11747

11748

11749

11750

11751

11752

<span class="flag static">static</span>

11753

11754

11755

11756

11757

11758

11759

<p>

11760

11761

Defined in

11762

11763

11764

11765

11766

<a href="../files/scrollview_js_scrollbars-plugin.js.html#l73"><code>scrollview/js/scrollbars-plugin.js:73</code></a>

11767

11768

</p>

11769

11770

11771

11772

11773

</div>

11774

11775

11776

<p>The identity of the plugin</p>

11777

</div>

11778

11779

11780

<p><strong>Default:</strong> 'pluginScrollViewScrollbars'</p>

11781

11782

11783

11784

11785

11786

</div>

11787

11788

11789

11790

11791

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

11792

11793

11794

<span class="flag deprecated" title="Use this.constructor.NAME">deprecated</span>

11795

11796

11797

11798

11799

11800

11801

11802

11803

11804

11805

11806

<p>Inherited from

11807

<a href="../classes/BaseCore.html#property_name">BaseCore</a>:

11808

11809

11810

11811

<a href="../files/base_js_BaseCore.js.html#l196"><code>base/js/BaseCore.js:196</code></a>

11812

11813

</p>

11814

11815

11816

<p>Deprecated: Use this.constructor.NAME</p>

11817

11818

11819

11820

</div>

11821

11822

11823

<p>The string used to identify the class of this object.</p>

11824

</div>

11825

11826

11827

11828

11829

11830

11831

</div>

11832

11833

11834

11835

11836

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

11837

11838

11839

11840

11841

11842

11843

11844

11845

<span class="flag static">static</span>

11846

11847

11848

11849

11850

11851

11852

<p>

11853

11854

Defined in

11855

11856

11857

11858

11859

<a href="../files/scrollview_js_scrollbars-plugin.js.html#l83"><code>scrollview/js/scrollbars-plugin.js:83</code></a>

11860

11861

</p>

11862

11863

11864

11865

11866

</div>

11867

11868

11869

<p>The namespace on which the plugin will reside.</p>

11870

</div>

11871

11872

11873

<p><strong>Default:</strong> 'scrollbars'</p>

11874

11875

11876

11877

11878

11879

</div>

11880

11881

11882

11883

<h3 class="name"><code>SCROLLBAR_TEMPLATE</code></h3>

11884

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>

11885

11886

11887

11888

11889

11890

11891

11892

11893

<span class="flag static">static</span>

11894

11895

11896

11897

11898

11899

11900

<p>

11901

11902

Defined in

11903

11904

11905

11906

11907

<a href="../files/scrollview_js_scrollbars-plugin.js.html#l93"><code>scrollview/js/scrollbars-plugin.js:93</code></a>

11908

11909

</p>

11910

11911

11912

11913

11914

</div>

11915

11916

11917

<p>HTML template for the scrollbar</p>

11918

</div>

11919

11920

11921

11922

11923

11924

11925

</div>

11926

11927

11928

</div>

11929

11930

11931

11932

11933

<h2 class="off-left">Attributes</h2>

11934

11935

11936

11937

11938

<h3 class="name"><code>destroyed</code></h3>

11939

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>

11940

11941

11942

11943

11944

11945

11946

11947

11948

11949

11950

11951

11952

<p>Inherited from

11953

<a href="../classes/BaseCore.html#attr_destroyed">BaseCore</a>:

11954

11955

11956

11957

<a href="../files/base_js_BaseCore.js.html#l157"><code>base/js/BaseCore.js:157</code></a>

11958

11959

</p>

11960

11961

11962

11963

11964

</div>

11965

11966

11967

<p>Flag indicating whether or not this object

11968

has been through the destroy lifecycle phase.</p>

11969

</div>

11970

11971

11972

<p><strong>Default:</strong> false</p>

11973

11974

11975

11976

11977

<h4>Fires event <code>destroyedChange</code></h4>

11978

11979

<p>

11980

Fires when the value for the configuration attribute <code>destroyed</code> is

11981

changed. You can listen for the event using the <code>on</code> method if you

11982

wish to be notified before the attribute's value has changed, or

11983

using the <code>after</code> method if you wish to be notified after the

11984

attribute's value has changed.

11985

</p>

11986

11987

11988

<h4>Parameters:</h4>

11989

11990

11991

11992

11993

<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>

11994

11995

11996

An Event Facade object with the following

11997

attribute-specific properties added:

11998

</div>

11999

12000

12001

12002

<code class="param-name">prevVal</code>

12003

12004

<div class="param-description">The value of the attribute, prior to it being set.</div>

12005

</li>

12006

12007

<code class="param-name">newVal</code>

12008

12009

<div class="param-description">The value the attribute is to be set to.</div>

12010

</li>

12011

12012

<code class="param-name">attrName</code>

12013

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

12014

<div class="param-description">The name of the attribute being set.</div>

12015

</li>

12016

12017

<code class="param-name">subAttrName</code>

12018

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

12019

<div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div>

12020

</li>

12021

</ul>

12022

</li>

12023

</ul>

12024

</div>

12025

</div>

12026

12027

12028

12029

</div>

12030

12031

12032

12033

12034

<h3 class="name"><code>horizontalNode</code></h3>

12035

12036

12037

12038

12039

12040

12041

12042

12043

12044

12045

12046

12047

12048

12049

<p>

12050

12051

Defined in

12052

12053

12054

12055

12056

<a href="../files/scrollview_js_scrollbars-plugin.js.html#l128"><code>scrollview/js/scrollbars-plugin.js:128</code></a>

12057

12058

</p>

12059

12060

12061

12062

12063

</div>

12064

12065

12066

<p>Horizontal scrollbar node</p>

12067

</div>

12068

12069

12070

12071

12072

12073

<h4>Fires event <code>horizontalNodeChange</code></h4>

12074

12075

<p>

12076

Fires when the value for the configuration attribute <code>horizontalNode</code> is

12077

changed. You can listen for the event using the <code>on</code> method if you

12078

wish to be notified before the attribute's value has changed, or

12079

using the <code>after</code> method if you wish to be notified after the

12080

attribute's value has changed.

12081

</p>

12082

12083

12084

<h4>Parameters:</h4>

12085

12086

12087

12088

12089

<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>

12090

12091

12092

An Event Facade object with the following

12093

attribute-specific properties added:

12094

</div>

12095

12096

12097

12098

<code class="param-name">prevVal</code>

12099

12100

<div class="param-description">The value of the attribute, prior to it being set.</div>

12101

</li>

12102

12103

<code class="param-name">newVal</code>

12104

12105

<div class="param-description">The value the attribute is to be set to.</div>

12106

</li>

12107

12108

<code class="param-name">attrName</code>

12109

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

12110

<div class="param-description">The name of the attribute being set.</div>

12111

</li>

12112

12113

<code class="param-name">subAttrName</code>

12114

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

12115

<div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div>

12116

</li>

12117

</ul>

12118

</li>

12119

</ul>

12120

</div>

12121

</div>

12122

12123

12124

12125

</div>

12126

12127

12128

12129

12130

12131

<span class="type"><a href="../classes/Plugin.Host.html" class="crosslink">Plugin.Host</a></span>

12132

12133

12134

12135

12136

12137

12138

12139

12140

12141

12142

12143

12144

<p>Inherited from

12145

<a href="../classes/Plugin.Base.html#attr_host">Plugin.Base</a>:

12146

12147

12148

12149

<a href="../files/plugin_js_plugin.js.html#l31"><code>plugin/js/plugin.js:31</code></a>

12150

12151

</p>

12152

12153

12154

12155

12156

</div>

12157

12158

12159

<p>The plugin's host object.</p>

12160

</div>

12161

12162

12163

12164

12165

12166

<h4>Fires event <code>hostChange</code></h4>

12167

12168

<p>

12169

Fires when the value for the configuration attribute <code>host</code> is

12170

changed. You can listen for the event using the <code>on</code> method if you

12171

wish to be notified before the attribute's value has changed, or

12172

using the <code>after</code> method if you wish to be notified after the

12173

attribute's value has changed.

12174

</p>

12175

12176

12177

<h4>Parameters:</h4>

12178

12179

12180

12181

12182

<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>

12183

12184

12185

An Event Facade object with the following

12186

attribute-specific properties added:

12187

</div>

12188

12189

12190

12191

<code class="param-name">prevVal</code>

12192

12193

<div class="param-description">The value of the attribute, prior to it being set.</div>

12194

</li>

12195

12196

<code class="param-name">newVal</code>

12197

12198

<div class="param-description">The value the attribute is to be set to.</div>

12199

</li>

12200

12201

<code class="param-name">attrName</code>

12202

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

12203

<div class="param-description">The name of the attribute being set.</div>

12204

</li>

12205

12206

<code class="param-name">subAttrName</code>

12207

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

12208

<div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div>

12209

</li>

12210

</ul>

12211

</li>

12212

</ul>

12213

</div>

12214

</div>

12215

12216

12217

12218

</div>

12219

12220

12221

12222

12223

<h3 class="name"><code>initialized</code></h3>

12224

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>

12225

12226

12227

12228

12229

12230

12231

12232

12233

12234

12235

12236

12237

<p>Inherited from

12238

<a href="../classes/BaseCore.html#attr_initialized">BaseCore</a>:

12239

12240

12241

12242

<a href="../files/base_js_BaseCore.js.html#l143"><code>base/js/BaseCore.js:143</code></a>

12243

12244

</p>

12245

12246

12247

12248

12249

</div>

12250

12251

12252

<p>Flag indicating whether or not this object

12253

has been through the init lifecycle phase.</p>

12254

</div>

12255

12256

12257

<p><strong>Default:</strong> false</p>

12258

12259

12260

12261

12262

<h4>Fires event <code>initializedChange</code></h4>

12263

12264

<p>

12265

Fires when the value for the configuration attribute <code>initialized</code> is

12266

changed. You can listen for the event using the <code>on</code> method if you

12267

wish to be notified before the attribute's value has changed, or

12268

using the <code>after</code> method if you wish to be notified after the

12269

attribute's value has changed.

12270

</p>

12271

12272

12273

<h4>Parameters:</h4>

12274

12275

12276

12277

12278

<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>

12279

12280

12281

An Event Facade object with the following

12282

attribute-specific properties added:

12283

</div>

12284

12285

12286

12287

<code class="param-name">prevVal</code>

12288

12289

<div class="param-description">The value of the attribute, prior to it being set.</div>

12290

</li>

12291

12292

<code class="param-name">newVal</code>

12293

12294

<div class="param-description">The value the attribute is to be set to.</div>

12295

</li>

12296

12297

<code class="param-name">attrName</code>

12298

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

12299

<div class="param-description">The name of the attribute being set.</div>

12300

</li>

12301

12302

<code class="param-name">subAttrName</code>

12303

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

12304

<div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div>

12305

</li>

12306

</ul>

12307

</li>

12308

</ul>

12309

</div>

12310

</div>

12311

12312

12313

12314

</div>

12315

12316

12317

12318

12319

<h3 class="name"><code>verticalNode</code></h3>

12320

12321

12322

12323

12324

12325

12326

12327

12328

12329

12330

12331

12332

12333

12334

<p>

12335

12336

Defined in

12337

12338

12339

12340

12341

<a href="../files/scrollview_js_scrollbars-plugin.js.html#l117"><code>scrollview/js/scrollbars-plugin.js:117</code></a>

12342

12343

</p>

12344

12345

12346

12347

12348

</div>

12349

12350

12351

<p>Vertical scrollbar node</p>

12352

</div>

12353

12354

12355

12356

12357

12358

<h4>Fires event <code>verticalNodeChange</code></h4>

12359

12360

<p>

12361

Fires when the value for the configuration attribute <code>verticalNode</code> is

12362

changed. You can listen for the event using the <code>on</code> method if you

12363

wish to be notified before the attribute's value has changed, or

12364

using the <code>after</code> method if you wish to be notified after the

12365

attribute's value has changed.

12366

</p>

12367

12368

12369

<h4>Parameters:</h4>

12370

12371

12372

12373

12374

<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>

12375

12376

12377

An Event Facade object with the following

12378

attribute-specific properties added:

12379

</div>

12380

12381

12382

12383

<code class="param-name">prevVal</code>

12384

12385

<div class="param-description">The value of the attribute, prior to it being set.</div>

12386

</li>

12387

12388

<code class="param-name">newVal</code>

12389

12390

<div class="param-description">The value the attribute is to be set to.</div>

12391

</li>

12392

12393

<code class="param-name">attrName</code>

12394

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

12395

<div class="param-description">The name of the attribute being set.</div>

12396

</li>

12397

12398

<code class="param-name">subAttrName</code>

12399

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

12400

<div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div>

12401

</li>

12402

</ul>

12403

</li>

12404

</ul>

12405

</div>

12406

</div>

12407

12408

12409

12410

</div>

12411

12412

12413

</div>

12414

12415

12416

12417

12418

<h2 class="off-left">Events</h2>

12419

12420

12421

12422

<h3 class="name"><code>destroy</code></h3>

12423

12424

12425

12426

12427

12428

12429

12430

12431

12432

12433

12434

12435

12436

<p>Inherited from

12437

<a href="../classes/Base.html#event_destroy">Base</a>:

12438

12439

12440

12441

12442

12443

</p>

12444

12445

12446

12447

12448

</div>

12449

12450

12451

<p>

12452

Lifecycle event for the destroy phase,

12453

fired prior to destruction. Invoking the preventDefault

12454

method on the event object provided to subscribers will

12455

prevent destruction from proceeding.

12456

</p>

12457

12458

<p>

12459

Subscribers to the "after" moment of this event, will be notified

12460

after destruction is complete (and as a result cannot prevent

12461

destruction).

12462

</p>

12463

</div>

12464

12465

12466

12467

<h4>Event Payload:</h4>

12468

12469

12470

12471

12472

12473

12474

<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>

12475

12476

12477

12478

12479

12480

<p>Event object</p>

12481

</div>

12482

12483

12484

</li>

12485

12486

</ul>

12487

</div>

12488

12489

12490

12491

12492

</div>

12493

12494

12495

12496

12497

12498

12499

12500

12501

12502

12503

12504

12505

12506

12507

12508

12509

12510

<p>Inherited from

12511

<a href="../classes/Base.html#event_init">Base</a>:

12512

12513

12514

12515

12516

12517

</p>

12518

12519

12520

12521

12522

</div>

12523

12524

12525

<p>

12526

Lifecycle event for the init phase, fired prior to initialization.

12527

Invoking the preventDefault() method on the event object provided

12528

to subscribers will prevent initialization from occuring.

12529

</p>

12530

12531

<p>

12532

Subscribers to the "after" momemt of this event, will be notified

12533

after initialization of the object is complete (and therefore

12534

cannot prevent initialization).

12535

</p>

12536

</div>

12537

12538

12539

12540

<h4>Event Payload:</h4>

12541

12542

12543

12544

12545

12546

12547

<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>

12548

12549

12550

12551

12552

12553

<p>Event object, with a cfg property which

12554

refers to the configuration object passed to the constructor.</p>

12555

</div>

12556

12557

12558

</li>

12559

12560

</ul>

12561

</div>

12562

12563

12564

12565

12566

</div>

12567

12568

12569

</div>

12570

12571

</div>

12572

</div>

12573

12574

</div>

12575

</div>

12576

</div>

12577

</div>

12578

</div>

12579

</div>

12580

12581

12582

12583

12584

12585

12586

12587

12588

</body>

12589

</html>

Older »