~bcsaller/juju-gui/charmFind

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

2018

2019

2020

2021

2022

2023

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

2024

</div>

2025

2026

2027

</li>

2028

2029

2030

2031

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

2032

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

2033

2034

2035

2036

2037

2038

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

2039

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

2040

</div>

2041

2042

2043

</li>

2044

2045

2046

2047

2048

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

2049

2050

2051

2052

2053

2054

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

2055

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

2056

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

2057

</div>

2058

2059

2060

</li>

2061

2062

</ul>

2063

</div>

2064

2065

2066

2067

2068

2069

</div>

2070

2071

2072

2073

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

2074

2075

2076

2077

2078

2079

2080

2081

2082

2083

</li>

2084

2085

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

2086

</div>

2087

2088

2089

2090

2091

2092

2093

2094

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

2095

2096

2097

2098

2099

2100

2101

2102

2103

2104

2105

2106

<p>Inherited from

2107

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

2108

2109

2110

2111

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

2112

2113

</p>

2114

2115

2116

2117

2118

2119

</div>

2120

2121

2122

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

2123

</div>

2124

2125

2126

2127

<h4>Parameters:</h4>

2128

2129

2130

2131

2132

2133

2134

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

2135

2136

2137

2138

2139

2140

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

2141

</div>

2142

2143

2144

</li>

2145

2146

</ul>

2147

</div>

2148

2149

2150

2151

2152

2153

</div>

2154

2155

2156

2157

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

2158

2159

2160

2161

2162

2163

2164

2165

<code>allAttrs</code>

2166

2167

</li>

2168

2169

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

2170

</div>

2171

2172

2173

2174

2175

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

2176

</span>

2177

2178

2179

2180

2181

2182

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

2183

2184

2185

2186

2187

2188

2189

2190

2191

2192

2193

2194

<p>Inherited from

2195

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

2196

2197

2198

2199

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

2200

2201

</p>

2202

2203

2204

2205

2206

2207

</div>

2208

2209

2210

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

2211

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

2212

2213

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

2214

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

2215

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

2216

</div>

2217

2218

2219

2220

<h4>Parameters:</h4>

2221

2222

2223

2224

2225

2226

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

2227

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

2228

2229

2230

2231

2232

2233

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

2234

(subclass first, Base last)</p>

2235

</div>

2236

2237

2238

</li>

2239

2240

</ul>

2241

</div>

2242

2243

2244

2245

2246

<h4>Returns:</h4>

2247

2248

2249

2250

2251

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

2252

2253

The aggregate set of ATTRS definitions for the instance

2254

2255

</div>

2256

</div>

2257

2258

2259

2260

</div>

2261

2262

2263

2264

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

2265

2266

2267

2268

2269

2270

2271

2272

2273

2274

2275

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

2276

2277

2278

2279

2280

2281

2282

2283

2284

2285

2286

<p>Inherited from

2287

2288

BaseCore

2289

</a>

2290

2291

but overwritten in

2292

2293

2294

2295

2296

2297

</p>

2298

2299

2300

2301

2302

2303

</div>

2304

2305

2306

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

2307

this class.</p>

2308

</div>

2309

2310

2311

2312

2313

2314

2315

</div>

2316

2317

2318

2319

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

2320

2321

2322

2323

2324

2325

2326

2327

2328

2329

2330

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

2331

2332

2333

2334

2335

2336

2337

2338

2339

2340

2341

2342

<p>Inherited from

2343

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

2344

2345

2346

2347

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

2348

2349

</p>

2350

2351

2352

2353

2354

2355

</div>

2356

2357

2358

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

2359

</div>

2360

2361

2362

2363

2364

2365

2366

</div>

2367

2368

2369

2370

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

2371

2372

2373

2374

2375

2376

2377

2378

2379

2380

2381

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

2382

2383

2384

2385

2386

2387

2388

2389

2390

2391

2392

2393

<p>Inherited from

2394

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

2395

2396

2397

2398

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

2399

2400

</p>

2401

2402

2403

2404

2405

2406

</div>

2407

2408

2409

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

2410

</div>

2411

2412

2413

2414

2415

2416

2417

</div>

2418

2419

2420

2421

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

2422

2423

2424

2425

2426

2427

2428

2429

2430

2431

</li>

2432

2433

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

2434

</div>

2435

2436

2437

2438

2439

2440

2441

2442

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

2443

2444

2445

2446

2447

2448

2449

2450

2451

2452

2453

2454

<p>Inherited from

2455

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

2456

2457

2458

2459

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

2460

2461

</p>

2462

2463

2464

2465

2466

2467

</div>

2468

2469

2470

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

2471

</div>

2472

2473

2474

2475

<h4>Parameters:</h4>

2476

2477

2478

2479

2480

2481

2482

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

2483

2484

2485

2486

2487

2488

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

2489

</div>

2490

2491

2492

</li>

2493

2494

</ul>

2495

</div>

2496

2497

2498

2499

2500

2501

</div>

2502

2503

2504

2505

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

2506

2507

2508

2509

2510

2511

2512

2513

2514

2515

</li>

2516

2517

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

2518

</div>

2519

2520

2521

2522

2523

2524

2525

2526

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

2527

2528

2529

2530

2531

2532

2533

2534

2535

2536

2537

2538

<p>Inherited from

2539

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

2540

2541

2542

2543

2544

2545

</p>

2546

2547

2548

2549

2550

2551

</div>

2552

2553

2554

<p>Default destroy event handler</p>

2555

</div>

2556

2557

2558

2559

<h4>Parameters:</h4>

2560

2561

2562

2563

2564

2565

2566

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

2567

2568

2569

2570

2571

2572

<p>Event object</p>

2573

</div>

2574

2575

2576

</li>

2577

2578

</ul>

2579

</div>

2580

2581

2582

2583

2584

2585

</div>

2586

2587

2588

2589

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

2590

2591

2592

2593

2594

2595

2596

2597

2598

2599

</li>

2600

2601

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

2602

</div>

2603

2604

2605

2606

2607

2608

2609

2610

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

2611

2612

2613

2614

2615

2616

2617

2618

2619

2620

2621

2622

<p>Inherited from

2623

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

2624

2625

2626

2627

2628

2629

</p>

2630

2631

2632

2633

2634

2635

</div>

2636

2637

2638

<p>Default init event handler</p>

2639

</div>

2640

2641

2642

2643

<h4>Parameters:</h4>

2644

2645

2646

2647

2648

2649

2650

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

2651

2652

2653

2654

2655

2656

<p>Event object, with a cfg property which

2657

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

2658

</div>

2659

2660

2661

</li>

2662

2663

</ul>

2664

</div>

2665

2666

2667

2668

2669

2670

</div>

2671

2672

2673

2674

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

2675

2676

2677

2678

2679

2680

2681

2682

2683

2684

2685

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

2686

2687

2688

2689

2690

2691

2692

2693

2694

2695

2696

2697

<p>Inherited from

2698

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

2699

2700

2701

2702

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

2703

2704

</p>

2705

2706

2707

2708

2709

2710

</div>

2711

2712

2713

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

2714

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

2715

</div>

2716

2717

2718

2719

2720

2721

2722

</div>

2723

2724

2725

2726

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

2727

2728

2729

2730

2731

2732

2733

2734

<code>allAttrs</code>

2735

2736

</li>

2737

2738

2739

2740

<code>userVals</code>

2741

2742

</li>

2743

2744

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

2745

</div>

2746

2747

2748

2749

2750

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

2751

</span>

2752

2753

2754

2755

2756

2757

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

2758

2759

2760

2761

2762

2763

2764

2765

2766

2767

2768

2769

<p>Inherited from

2770

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

2771

2772

2773

2774

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

2775

2776

</p>

2777

2778

2779

2780

2781

2782

</div>

2783

2784

2785

2786

</div>

2787

2788

2789

2790

<h4>Parameters:</h4>

2791

2792

2793

2794

2795

2796

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

2797

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

2798

2799

2800

2801

2802

2803

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

2804

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

2805

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

2806

</div>

2807

2808

2809

</li>

2810

2811

2812

2813

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

2814

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

2815

2816

2817

2818

2819

2820

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

2821

</div>

2822

2823

2824

</li>

2825

2826

</ul>

2827

</div>

2828

2829

2830

2831

2832

<h4>Returns:</h4>

2833

2834

2835

2836

2837

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

2838

2839

The set of adhoc attributes passed in, in the form

2840

of an object with attribute name/configuration pairs.

2841

2842

</div>

2843

</div>

2844

2845

2846

2847

</div>

2848

2849

2850

2851

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

2852

2853

2854

2855

2856

2857

2858

2859

<code>clazz</code>

2860

2861

</li>

2862

2863

2864

2865

<code>allCfgs</code>

2866

2867

</li>

2868

2869

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

2870

</div>

2871

2872

2873

2874

2875

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

2876

</span>

2877

2878

2879

2880

2881

2882

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

2883

2884

2885

2886

2887

2888

2889

2890

2891

2892

2893

2894

<p>Inherited from

2895

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

2896

2897

2898

2899

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

2900

2901

</p>

2902

2903

2904

2905

2906

2907

</div>

2908

2909

2910

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

2911

initialization. Returns a disposable object with the attributes defined for

2912

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

2913

</div>

2914

2915

2916

2917

<h4>Parameters:</h4>

2918

2919

2920

2921

2922

2923

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

2924

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

2925

2926

2927

2928

2929

2930

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

2931

</div>

2932

2933

2934

</li>

2935

2936

2937

2938

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

2939

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

2940

2941

2942

2943

2944

2945

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

2946

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

2947

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

2948

</div>

2949

2950

2951

</li>

2952

2953

</ul>

2954

</div>

2955

2956

2957

2958

2959

<h4>Returns:</h4>

2960

2961

2962

2963

2964

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

2965

2966

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

2967

of an object with attribute name/configuration pairs.

2968

2969

</div>

2970

</div>

2971

2972

2973

2974

</div>

2975

2976

2977

2978

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

2979

2980

2981

2982

2983

2984

2985

2986

<code>attrName</code>

2987

2988

</li>

2989

2990

2991

2992

<code>subAttrName</code>

2993

2994

</li>

2995

2996

2997

2998

<code>currVal</code>

2999

3000

</li>

3001

3002

3003

3004

<code>newVal</code>

3005

3006

</li>

3007

3008

3009

3010

3011

3012

</li>

3013

3014

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

3015

</div>

3016

3017

3018

3019

3020

3021

3022

3023

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

3024

3025

3026

3027

3028

3029

3030

3031

3032

3033

3034

3035

<p>Inherited from

3036

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

3037

3038

3039

3040

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

3041

3042

</p>

3043

3044

3045

3046

3047

3048

</div>

3049

3050

3051

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

3052

</div>

3053

3054

3055

3056

<h4>Parameters:</h4>

3057

3058

3059

3060

3061

3062

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

3063

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

3064

3065

3066

3067

3068

3069

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

3070

</div>

3071

3072

3073

</li>

3074

3075

3076

3077

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

3078

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

3079

3080

3081

3082

3083

3084

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

3085

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

3086

</div>

3087

3088

3089

</li>

3090

3091

3092

3093

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

3094

3095

3096

3097

3098

3099

3100

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

3101

</div>

3102

3103

3104

</li>

3105

3106

3107

3108

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

3109

3110

3111

3112

3113

3114

3115

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

3116

</div>

3117

3118

3119

</li>

3120

3121

3122

3123

3124

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

3125

3126

3127

3128

3129

3130

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

3131

</div>

3132

3133

3134

</li>

3135

3136

</ul>

3137

</div>

3138

3139

3140

3141

3142

3143

</div>

3144

3145

3146

3147

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

3148

3149

3150

3151

3152

3153

3154

3155

3156

3157

</li>

3158

3159

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

3160

</div>

3161

3162

3163

3164

3165

3166

</span>

3167

3168

3169

3170

3171

3172

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

3173

3174

3175

3176

3177

3178

3179

3180

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

3181

3182

3183

3184

3185

3186

<p>Inherited from

3187

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

3188

3189

3190

3191

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

3192

3193

</p>

3194

3195

3196

3197

3198

3199

</div>

3200

3201

3202

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

3203

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

3204

3205

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

3206

</div>

3207

3208

3209

3210

<h4>Parameters:</h4>

3211

3212

3213

3214

3215

3216

3217

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

3218

3219

3220

3221

3222

3223

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

3224

</div>

3225

3226

3227

</li>

3228

3229

</ul>

3230

</div>

3231

3232

3233

3234

3235

<h4>Returns:</h4>

3236

3237

3238

3239

3240

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

3241

3242

The value of the attribute.

3243

3244

</div>

3245

</div>

3246

3247

3248

3249

</div>

3250

3251

3252

3253

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

3254

3255

3256

3257

3258

3259

3260

3261

3262

3263

</li>

3264

3265

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

3266

</div>

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

</span>

3273

3274

3275

3276

3277

3278

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

3279

3280

3281

3282

3283

3284

3285

3286

3287

3288

3289

3290

<p>Inherited from

3291

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

3292

3293

3294

3295

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

3296

3297

</p>

3298

3299

3300

3301

3302

3303

</div>

3304

3305

3306

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

3307

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

3308

configuration properties for all attributes.</p>

3309

</div>

3310

3311

3312

3313

<h4>Parameters:</h4>

3314

3315

3316

3317

3318

3319

3320

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

3321

3322

3323

3324

3325

3326

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

3327

</div>

3328

3329

3330

</li>

3331

3332

</ul>

3333

</div>

3334

3335

3336

3337

3338

<h4>Returns:</h4>

3339

3340

3341

3342

3343

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

3344

3345

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

3346

3347

</div>

3348

</div>

3349

3350

3351

3352

</div>

3353

3354

3355

3356

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

3357

3358

3359

3360

3361

3362

3363

3364

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

3365

</span>

3366

3367

3368

3369

3370

3371

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

3372

3373

3374

3375

3376

3377

3378

3379

3380

3381

3382

3383

<p>Inherited from

3384

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

3385

3386

3387

3388

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

3389

3390

</p>

3391

3392

3393

3394

3395

3396

</div>

3397

3398

3399

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

3400

the class hierarchy.</p>

3401

</div>

3402

3403

3404

3405

3406

3407

<h4>Returns:</h4>

3408

3409

3410

3411

3412

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

3413

3414

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

3415

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

3416

the cached value.

3417

3418

</div>

3419

</div>

3420

3421

3422

3423

</div>

3424

3425

3426

3427

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

3428

3429

3430

3431

3432

3433

3434

3435

3436

3437

</li>

3438

3439

3440

3441

3442

3443

</li>

3444

3445

3446

3447

<code>initValues</code>

3448

3449

</li>

3450

3451

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

3452

</div>

3453

3454

3455

3456

3457

3458

</span>

3459

3460

3461

3462

3463

3464

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

3465

3466

3467

3468

3469

3470

3471

3472

3473

3474

3475

<p>Inherited from

3476

3477

Attribute

3478

</a>

3479

3480

but overwritten in

3481

3482

3483

3484

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

3485

3486

</p>

3487

3488

3489

3490

3491

3492

</div>

3493

3494

3495

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

3496

either the default configuration provided, or the

3497

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

3498

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

3499

</div>

3500

3501

3502

3503

<h4>Parameters:</h4>

3504

3505

3506

3507

3508

3509

3510

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

3511

3512

3513

3514

3515

3516

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

3517

</div>

3518

3519

3520

</li>

3521

3522

3523

3524

3525

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

3526

3527

3528

3529

3530

3531

<p>The attribute configuration object</p>

3532

</div>

3533

3534

3535

</li>

3536

3537

3538

3539

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

3540

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

3541

3542

3543

3544

3545

3546

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

3547

</div>

3548

3549

3550

</li>

3551

3552

</ul>

3553

</div>

3554

3555

3556

3557

3558

<h4>Returns:</h4>

3559

3560

3561

3562

3563

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

3564

3565

The initial value of the attribute.

3566

3567

</div>

3568

</div>

3569

3570

3571

3572

</div>

3573

3574

3575

3576

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

3577

3578

3579

3580

3581

3582

3583

3584

<code>attrs</code>

3585

3586

</li>

3587

3588

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

3589

</div>

3590

3591

3592

3593

3594

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

3595

</span>

3596

3597

3598

3599

3600

3601

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

3602

3603

3604

3605

3606

3607

3608

3609

3610

3611

3612

3613

<p>Inherited from

3614

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

3615

3616

3617

3618

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

3619

3620

</p>

3621

3622

3623

3624

3625

3626

</div>

3627

3628

3629

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

3630

</div>

3631

3632

3633

3634

<h4>Parameters:</h4>

3635

3636

3637

3638

3639

3640

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

3641

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

3642

3643

3644

3645

3646

3647

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

3648

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

3649

</div>

3650

3651

3652

</li>

3653

3654

</ul>

3655

</div>

3656

3657

3658

3659

3660

<h4>Returns:</h4>

3661

3662

3663

3664

3665

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

3666

3667

An object with attribute name/value pairs.

3668

3669

</div>

3670

</div>

3671

3672

3673

3674

</div>

3675

3676

3677

3678

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

3679

3680

3681

3682

3683

3684

3685

3686

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

3687

</span>

3688

3689

3690

3691

3692

3693

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

3694

3695

3696

3697

3698

3699

3700

3701

3702

3703

3704

3705

<p>Inherited from

3706

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

3707

3708

3709

3710

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

3711

3712

</p>

3713

3714

3715

3716

3717

3718

</div>

3719

3720

3721

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

3722

</div>

3723

3724

3725

3726

3727

3728

<h4>Returns:</h4>

3729

3730

3731

3732

3733

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

3734

3735

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

3736

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

3737

cached value.

3738

3739

</div>

3740

</div>

3741

3742

3743

3744

</div>

3745

3746

3747

3748

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

3749

3750

3751

3752

3753

3754

3755

3756

3757

3758

</li>

3759

3760

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

3761

</div>

3762

3763

3764

3765

3766

3767

</span>

3768

3769

3770

3771

3772

3773

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

3774

3775

3776

3777

3778

3779

3780

3781

3782

3783

3784

3785

<p>Inherited from

3786

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

3787

3788

3789

3790

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

3791

3792

</p>

3793

3794

3795

3796

3797

3798

</div>

3799

3800

3801

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

3802

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

3803

</div>

3804

3805

3806

3807

<h4>Parameters:</h4>

3808

3809

3810

3811

3812

3813

3814

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

3815

3816

3817

3818

3819

3820

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

3821

</div>

3822

3823

3824

</li>

3825

3826

</ul>

3827

</div>

3828

3829

3830

3831

3832

<h4>Returns:</h4>

3833

3834

3835

3836

3837

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

3838

3839

The stored value of the attribute

3840

3841

</div>

3842

</div>

3843

3844

3845

3846

</div>

3847

3848

3849

3850

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

3851

3852

3853

3854

3855

3856

3857

3858

3859

3860

3861

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

3862

3863

3864

3865

3866

3867

3868

3869

3870

3871

3872

3873

<p>Inherited from

3874

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

3875

3876

3877

3878

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

3879

3880

</p>

3881

3882

3883

3884

3885

3886

</div>

3887

3888

3889

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

3890

event type is not prefixed, the instance prefix is

3891

applied to the supplied type.</p>

3892

</div>

3893

3894

3895

3896

3897

3898

3899

</div>

3900

3901

3902

3903

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

3904

3905

3906

3907

3908

3909

3910

3911

<code>attrs</code>

3912

3913

</li>

3914

3915

3916

3917

<code>values</code>

3918

3919

</li>

3920

3921

3922

3923

3924

3925

</li>

3926

3927

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

3928

</div>

3929

3930

3931

3932

3933

3934

3935

3936

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

3937

3938

3939

3940

3941

3942

3943

3944

3945

3946

3947

3948

<p>Inherited from

3949

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

3950

3951

3952

3953

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

3954

3955

</p>

3956

3957

3958

3959

3960

3961

</div>

3962

3963

3964

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

3965

constructor.</p>

3966

</div>

3967

3968

3969

3970

<h4>Parameters:</h4>

3971

3972

3973

3974

3975

3976

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

3977

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

3978

3979

3980

3981

3982

3983

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

3984

</div>

3985

3986

3987

</li>

3988

3989

3990

3991

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

3992

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

3993

3994

3995

3996

3997

3998

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

3999

</div>

4000

4001

4002

</li>

4003

4004

4005

4006

4007

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

4008

4009

4010

4011

4012

4013

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

4014

</div>

4015

4016

4017

</li>

4018

4019

</ul>

4020

</div>

4021

4022

4023

4024

4025

4026

</div>

4027

4028

4029

4030

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

4031

4032

4033

4034

4035

4036

4037

4038

4039

4040

4041

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

4042

4043

4044

4045

4046

4047

4048

4049

4050

4051

4052

<p>Inherited from

4053

4054

BaseCore

4055

</a>

4056

4057

but overwritten in

4058

4059

4060

4061

4062

4063

</p>

4064

4065

4066

4067

4068

4069

</div>

4070

4071

4072

<p>Initializes Attribute</p>

4073

</div>

4074

4075

4076

4077

4078

4079

4080

</div>

4081

4082

4083

4084

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

4085

4086

4087

4088

4089

4090

4091

4092

<code>attrs</code>

4093

4094

</li>

4095

4096

4097

4098

<code>values</code>

4099

4100

</li>

4101

4102

4103

4104

4105

4106

</li>

4107

4108

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

4109

</div>

4110

4111

4112

4113

4114

4115

4116

4117

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

4118

4119

4120

4121

4122

4123

4124

4125

4126

4127

4128

4129

<p>Inherited from

4130

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

4131

4132

4133

4134

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

4135

4136

</p>

4137

4138

4139

4140

4141

4142

</div>

4143

4144

4145

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

4146

</div>

4147

4148

4149

4150

<h4>Parameters:</h4>

4151

4152

4153

4154

4155

4156

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

4157

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

4158

4159

4160

4161

4162

4163

4164

</div>

4165

4166

4167

</li>

4168

4169

4170

4171

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

4172

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

4173

4174

4175

4176

4177

4178

4179

</div>

4180

4181

4182

</li>

4183

4184

4185

4186

4187

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

4188

4189

4190

4191

4192

4193

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

4194

</div>

4195

4196

4197

</li>

4198

4199

</ul>

4200

</div>

4201

4202

4203

4204

4205

4206

</div>

4207

4208

4209

4210

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

4211

4212

4213

4214

4215

4216

4217

4218

<code>config</code>

4219

4220

</li>

4221

4222

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

4223

</div>

4224

4225

4226

4227

4228

4229

4230

4231

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

4232

4233

4234

4235

4236

4237

4238

4239

4240

4241

4242

<p>Inherited from

4243

4244

BaseCore

4245

</a>

4246

4247

but overwritten in

4248

4249

4250

4251

4252

4253

</p>

4254

4255

4256

4257

4258

4259

</div>

4260

4261

4262

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

4263

</div>

4264

4265

4266

4267

<h4>Parameters:</h4>

4268

4269

4270

4271

4272

4273

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

4274

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

4275

4276

4277

4278

4279

4280

<p>The constructor configuration object</p>

4281

</div>

4282

4283

4284

</li>

4285

4286

</ul>

4287

</div>

4288

4289

4290

4291

4292

4293

</div>

4294

4295

4296

4297

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

4298

4299

4300

4301

4302

4303

4304

4305

<code>userVals</code>

4306

4307

</li>

4308

4309

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

4310

</div>

4311

4312

4313

4314

4315

4316

4317

4318

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

4319

4320

4321

4322

4323

4324

4325

4326

4327

4328

4329

4330

<p>Inherited from

4331

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

4332

4333

4334

4335

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

4336

4337

</p>

4338

4339

4340

4341

4342

4343

</div>

4344

4345

4346

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

4347

initializing attributes for each class defined in the class's

4348

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

4349

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

4350

</div>

4351

4352

4353

4354

<h4>Parameters:</h4>

4355

4356

4357

4358

4359

4360

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

4361

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

4362

4363

4364

4365

4366

4367

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

4368

</div>

4369

4370

4371

</li>

4372

4373

</ul>

4374

</div>

4375

4376

4377

4378

4379

4380

</div>

4381

4382

4383

4384

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

4385

4386

4387

4388

4389

4390

4391

4392

4393

4394

4395

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

4396

4397

4398

4399

4400

4401

4402

4403

4404

4405

4406

4407

<p>Inherited from

4408

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

4409

4410

4411

4412

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

4413

4414

</p>

4415

4416

4417

4418

4419

4420

</div>

4421

4422

4423

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

4424

the array of classes and aggregate set of attribute configurations

4425

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

4426

</div>

4427

4428

4429

4430

4431

4432

4433

</div>

4434

4435

4436

4437

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

4438

4439

4440

4441

4442

4443

4444

4445

4446

4447

</li>

4448

4449

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

4450

</div>

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

</span>

4457

4458

4459

4460

4461

4462

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

4463

4464

4465

4466

4467

4468

4469

4470

4471

4472

4473

4474

<p>Inherited from

4475

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

4476

4477

4478

4479

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

4480

4481

</p>

4482

4483

4484

4485

4486

4487

</div>

4488

4489

4490

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

4491

added lazily and still requires initialization.</p>

4492

</div>

4493

4494

4495

4496

<h4>Parameters:</h4>

4497

4498

4499

4500

4501

4502

4503

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

4504

4505

4506

4507

4508

4509

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

4510

</div>

4511

4512

4513

</li>

4514

4515

</ul>

4516

</div>

4517

4518

4519

4520

4521

<h4>Returns:</h4>

4522

4523

4524

4525

4526

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

4527

4528

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

4529

4530

</div>

4531

</div>

4532

4533

4534

4535

</div>

4536

4537

4538

4539

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

4540

4541

4542

4543

4544

4545

4546

4547

4548

4549

</li>

4550

4551

4552

4553

4554

4555

</li>

4556

4557

4558

4559

4560

4561

</li>

4562

4563

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

4564

</div>

4565

4566

4567

4568

4569

4570

4571

4572

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

4573

4574

4575

4576

4577

4578

4579

4580

4581

4582

4583

4584

<p>Inherited from

4585

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

4586

4587

4588

4589

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

4590

4591

</p>

4592

4593

4594

4595

4596

4597

</div>

4598

4599

4600

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

4601

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

4602

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

4603

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

4604

be subscribed to like other events to monitor the event

4605

system. Inividual published events can have monitoring

4606

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

4607

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

4608

</div>

4609

4610

4611

4612

<h4>Parameters:</h4>

4613

4614

4615

4616

4617

4618

4619

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

4620

4621

4622

4623

4624

4625

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

4626

</div>

4627

4628

4629

</li>

4630

4631

4632

4633

4634

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

4635

4636

4637

4638

4639

4640

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

4641

</div>

4642

4643

4644

</li>

4645

4646

4647

4648

4649

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

4650

4651

4652

4653

4654

4655

<p>Information about the event interaction, such as

4656

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

4657

</div>

4658

4659

4660

</li>

4661

4662

</ul>

4663

</div>

4664

4665

4666

4667

4668

4669

</div>

4670

4671

4672

4673

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

4674

4675

4676

4677

4678

4679

4680

4681

<code>valueHash</code>

4682

4683

</li>

4684

4685

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

4686

</div>

4687

4688

4689

4690

4691

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

4692

</span>

4693

4694

4695

4696

4697

4698

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

4699

4700

4701

4702

4703

4704

4705

4706

4707

4708

4709

<p>Inherited from

4710

4711

Attribute

4712

</a>

4713

4714

but overwritten in

4715

4716

4717

4718

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

4719

4720

</p>

4721

4722

4723

4724

4725

4726

</div>

4727

4728

4729

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

4730

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

4731

</div>

4732

4733

4734

4735

<h4>Parameters:</h4>

4736

4737

4738

4739

4740

4741

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

4742

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

4743

4744

4745

4746

4747

4748

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

4749

</div>

4750

4751

4752

</li>

4753

4754

</ul>

4755

</div>

4756

4757

4758

4759

4760

<h4>Returns:</h4>

4761

4762

4763

4764

4765

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

4766

4767

4768

</div>

4769

</div>

4770

4771

4772

4773

</div>

4774

4775

4776

4777

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

4778

4779

4780

4781

4782

4783

4784

4785

4786

4787

4788

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

4789

4790

4791

4792

4793

4794

4795

4796

4797

4798

4799

4800

<p>Inherited from

4801

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

4802

4803

4804

4805

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

4806

4807

</p>

4808

4809

4810

4811

4812

4813

</div>

4814

4815

4816

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

4817

and the prefixed event name from _getType

4818

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

4819

</div>

4820

4821

4822

4823

4824

4825

4826

</div>

4827

4828

4829

4830

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

4831

4832

4833

4834

4835

4836

4837

4838

<code>config</code>

4839

4840

</li>

4841

4842

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

4843

</div>

4844

4845

4846

4847

4848

4849

4850

4851

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

4852

4853

4854

4855

4856

4857

4858

4859

4860

4861

4862

4863

<p>Inherited from

4864

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

4865

4866

4867

4868

4869

4870

</p>

4871

4872

4873

4874

4875

4876

</div>

4877

4878

4879

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

4880

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

4881

construction, prior to init.</p>

4882

</div>

4883

4884

4885

4886

<h4>Parameters:</h4>

4887

4888

4889

4890

4891

4892

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

4893

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

4894

4895

4896

4897

4898

4899

<p>The user configuration object</p>

4900

</div>

4901

4902

4903

</li>

4904

4905

</ul>

4906

</div>

4907

4908

4909

4910

4911

4912

</div>

4913

4914

4915

4916

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

4917

4918

4919

4920

4921

4922

4923

4924

<code>attrs</code>

4925

4926

</li>

4927

4928

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

4929

</div>

4930

4931

4932

4933

4934

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

4935

</span>

4936

4937

4938

4939

4940

4941

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

4942

4943

4944

4945

4946

4947

4948

4949

4950

4951

4952

4953

<p>Inherited from

4954

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

4955

4956

4957

4958

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

4959

4960

</p>

4961

4962

4963

4964

4965

4966

</div>

4967

4968

4969

<p>Utility method to protect an attribute configuration

4970

hash, by merging the entire object and the individual

4971

attr config objects.</p>

4972

</div>

4973

4974

4975

4976

<h4>Parameters:</h4>

4977

4978

4979

4980

4981

4982

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

4983

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

4984

4985

4986

4987

4988

4989

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

4990

</div>

4991

4992

4993

</li>

4994

4995

</ul>

4996

</div>

4997

4998

4999

5000

5001

<h4>Returns:</h4>

5002

5003

5004

5005

5006

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

5007

5008

A protected version of the attrs argument.

5009

5010

</div>

5011

</div>

5012

5013

5014

5015

</div>

5016

5017

5018

5019

5020

5021

5022

5023

5024

5025

5026

5027

5028

5029

</li>

5030

5031

5032

5033

5034

5035

</li>

5036

5037

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

5038

</div>

5039

5040

5041

5042

5043

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

5044

</span>

5045

5046

5047

5048

5049

5050

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

5051

5052

5053

5054

5055

5056

5057

5058

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

5059

5060

5061

5062

5063

<p>Inherited from

5064

5065

AttributeEvents

5066

</a>

5067

5068

but overwritten in

5069

5070

5071

5072

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

5073

5074

</p>

5075

5076

5077

5078

5079

5080

</div>

5081

5082

5083

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

5084

</div>

5085

5086

5087

5088

<h4>Parameters:</h4>

5089

5090

5091

5092

5093

5094

5095

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

5096

5097

5098

5099

5100

5101

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

5102

</div>

5103

5104

5105

</li>

5106

5107

5108

5109

5110

5111

5112

5113

5114

5115

5116

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

5117

</div>

5118

5119

5120

</li>

5121

5122

</ul>

5123

</div>

5124

5125

5126

5127

5128

<h4>Returns:</h4>

5129

5130

5131

5132

5133

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

5134

5135

A reference to the host object.

5136

5137

</div>

5138

</div>

5139

5140

5141

5142

</div>

5143

5144

5145

5146

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

5147

5148

5149

5150

5151

5152

5153

5154

5155

5156

</li>

5157

5158

5159

5160

<code>value</code>

5161

5162

</li>

5163

5164

5165

5166

5167

5168

</li>

5169

5170

5171

5172

<code>force</code>

5173

5174

</li>

5175

5176

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

5177

</div>

5178

5179

5180

5181

5182

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

5183

</span>

5184

5185

5186

5187

5188

5189

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

5190

5191

5192

5193

5194

5195

5196

5197

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

5198

5199

5200

5201

5202

5203

<p>Inherited from

5204

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

5205

5206

5207

5208

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

5209

5210

</p>

5211

5212

5213

5214

5215

5216

</div>

5217

5218

5219

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

5220

5221

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

5222

</div>

5223

5224

5225

5226

<h4>Parameters:</h4>

5227

5228

5229

5230

5231

5232

5233

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

5234

5235

5236

5237

5238

5239

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

5240

</div>

5241

5242

5243

</li>

5244

5245

5246

5247

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

5248

5249

5250

5251

5252

5253

5254

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

5255

</div>

5256

5257

5258

</li>

5259

5260

5261

5262

5263

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

5264

5265

5266

5267

5268

5269

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

5270

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

5271

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

5272

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

5273

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

5274

</div>

5275

5276

5277

</li>

5278

5279

5280

5281

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

5282

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

5283

5284

5285

5286

5287

5288

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

5289

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

5290

</div>

5291

5292

5293

</li>

5294

5295

</ul>

5296

</div>

5297

5298

5299

5300

5301

<h4>Returns:</h4>

5302

5303

5304

5305

5306

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

5307

5308

A reference to the host object.

5309

5310

</div>

5311

</div>

5312

5313

5314

5315

</div>

5316

5317

5318

5319

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

5320

5321

5322

5323

5324

5325

5326

5327

<code>attrs</code>

5328

5329

</li>

5330

5331

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

5332

</div>

5333

5334

5335

5336

5337

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

5338

</span>

5339

5340

5341

5342

5343

5344

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

5345

5346

5347

5348

5349

5350

5351

5352

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

5353

5354

5355

5356

5357

5358

<p>Inherited from

5359

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

5360

5361

5362

5363

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

5364

5365

</p>

5366

5367

5368

5369

5370

5371

</div>

5372

5373

5374

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

5375

</div>

5376

5377

5378

5379

<h4>Parameters:</h4>

5380

5381

5382

5383

5384

5385

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

5386

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

5387

5388

5389

5390

5391

5392

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

5393

</div>

5394

5395

5396

</li>

5397

5398

</ul>

5399

</div>

5400

5401

5402

5403

5404

<h4>Returns:</h4>

5405

5406

5407

5408

5409

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

5410

5411

A reference to the host object.

5412

5413

</div>

5414

</div>

5415

5416

5417

5418

</div>

5419

5420

5421

5422

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

5423

5424

5425

5426

5427

5428

5429

5430

<code>attrName</code>

5431

5432

</li>

5433

5434

5435

5436

<code>subAttrName</code>

5437

5438

</li>

5439

5440

5441

5442

<code>prevVal</code>

5443

5444

</li>

5445

5446

5447

5448

<code>newVal</code>

5449

5450

</li>

5451

5452

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

5453

</div>

5454

5455

5456

5457

5458

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

5459

</span>

5460

5461

5462

5463

5464

5465

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

5466

5467

5468

5469

5470

5471

5472

5473

5474

5475

5476

5477

<p>Inherited from

5478

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

5479

5480

5481

5482

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

5483

5484

</p>

5485

5486

5487

5488

5489

5490

</div>

5491

5492

5493

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

5494

if validation and setter passes.</p>

5495

</div>

5496

5497

5498

5499

<h4>Parameters:</h4>

5500

5501

5502

5503

5504

5505

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

5506

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

5507

5508

5509

5510

5511

5512

<p>The attribute name.</p>

5513

</div>

5514

5515

5516

</li>

5517

5518

5519

5520

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

5521

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

5522

5523

5524

5525

5526

5527

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

5528

</div>

5529

5530

5531

</li>

5532

5533

5534

5535

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

5536

5537

5538

5539

5540

5541

5542

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

5543

</div>

5544

5545

5546

</li>

5547

5548

5549

5550

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

5551

5552

5553

5554

5555

5556

5557

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

5558

</div>

5559

5560

5561

</li>

5562

5563

</ul>

5564

</div>

5565

5566

5567

5568

5569

<h4>Returns:</h4>

5570

5571

5572

5573

5574

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

5575

5576

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

5577

5578

</div>

5579

</div>

5580

5581

5582

5583

</div>

5584

5585

5586

5587

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

5588

5589

5590

5591

5592

5593

5594

5595

5596

5597

</li>

5598

5599

5600

5601

<code>value</code>

5602

5603

</li>

5604

5605

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

5606

</div>

5607

5608

5609

5610

5611

5612

5613

5614

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

5615

5616

5617

5618

5619

5620

5621

5622

5623

5624

5625

5626

<p>Inherited from

5627

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

5628

5629

5630

5631

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

5632

5633

</p>

5634

5635

5636

5637

5638

5639

</div>

5640

5641

5642

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

5643

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

5644

</div>

5645

5646

5647

5648

<h4>Parameters:</h4>

5649

5650

5651

5652

5653

5654

5655

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

5656

5657

5658

5659

5660

5661

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

5662

</div>

5663

5664

5665

</li>

5666

5667

5668

5669

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

5670

5671

5672

5673

5674

5675

5676

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

5677

</div>

5678

5679

5680

</li>

5681

5682

</ul>

5683

</div>

5684

5685

5686

5687

5688

5689

</div>

5690

5691

5692

5693

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

5694

5695

5696

5697

5698

5699

5700

5701

5702

5703

</li>

5704

5705

5706

5707

<code>config</code>

5708

5709

</li>

5710

5711

5712

5713

5714

5715

</li>

5716

5717

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

5718

</div>

5719

5720

5721

5722

5723

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

5724

</span>

5725

5726

5727

5728

5729

5730

5731

5732

5733

5734

5735

5736

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

5737

5738

5739

5740

5741

5742

<p>Inherited from

5743

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

5744

5745

5746

5747

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

5748

5749

</p>

5750

5751

5752

5753

5754

5755

</div>

5756

5757

5758

<p>

5759

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

5760

</p>

5761

5762

<p>

5763

The config argument object supports the following properties:

5764

</p>

5765

5766

<dl>

5767

<dt>value <Any></dt>

5768

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

5769

5770

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

5771

<dd>

5772

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

5773

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

5774

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

5775

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

5776

case the value property is used.</p>

5777

5778

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

5779

</dd>

5780

5781

<dt>readOnly <boolean></dt>

5782

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

5783

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

5784

5785

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

5786

<dd>

5787

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

5788

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

5789

constructor configuration arguments, or by invoking set.

5790

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

5791

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

5792

</dd>

5793

5794

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

5795

<dd>

5796

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

5797

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

5798

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

5799

the value from being stored.

5800

</p>

5801

5802

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

5803

</dd>

5804

5805

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

5806

<dd>

5807

<p>

5808

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

5809

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

5810

invoke get.

5811

</p>

5812

5813

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

5814

</dd>

5815

5816

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

5817

<dd>

5818

<p>

5819

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

5820

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

5821

</p>

5822

5823

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

5824

</dd>

5825

5826

<dt>lazyAdd <boolean></dt>

5827

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

5828

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

5829

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

5830

5831

</dl>

5832

5833

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

5834

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

5835

5836

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

5837

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

5838

</div>

5839

5840

5841

5842

<h4>Parameters:</h4>

5843

5844

5845

5846

5847

5848

5849

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

5850

5851

5852

5853

5854

5855

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

5856

</div>

5857

5858

5859

</li>

5860

5861

5862

5863

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

5864

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

5865

5866

5867

5868

5869

5870

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

5871

5872

<p>

5873

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

5874

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

5875

</p>

5876

</div>

5877

5878

5879

</li>

5880

5881

5882

5883

5884

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

5885

5886

5887

5888

5889

5890

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

5891

</div>

5892

5893

5894

</li>

5895

5896

</ul>

5897

</div>

5898

5899

5900

5901

5902

<h4>Returns:</h4>

5903

5904

5905

5906

5907

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

5908

5909

A reference to the host object.

5910

5911

</div>

5912

</div>

5913

5914

5915

5916

</div>

5917

5918

5919

5920

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

5921

5922

5923

5924

5925

5926

5927

5928

5929

5930

</li>

5931

5932

5933

5934

<code>values</code>

5935

5936

</li>

5937

5938

5939

5940

5941

5942

</li>

5943

5944

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

5945

</div>

5946

5947

5948

5949

5950

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

5951

</span>

5952

5953

5954

5955

5956

5957

5958

5959

5960

5961

5962

5963

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

5964

5965

5966

5967

5968

5969

<p>Inherited from

5970

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

5971

5972

5973

5974

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

5975

5976

</p>

5977

5978

5979

5980

5981

5982

</div>

5983

5984

5985

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

5986

5987

<p>

5988

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

5989

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

5990

</p>

5991

</div>

5992

5993

5994

5995

<h4>Parameters:</h4>

5996

5997

5998

5999

6000

6001

6002

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

6003

6004

6005

6006

6007

6008

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

6009

</div>

6010

6011

6012

</li>

6013

6014

6015

6016

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

6017

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

6018

6019

6020

6021

6022

6023

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

6024

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

6025

</div>

6026

6027

6028

</li>

6029

6030

6031

6032

6033

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

6034

6035

6036

6037

6038

6039

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

6040

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

6041

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

6042

</div>

6043

6044

6045

</li>

6046

6047

</ul>

6048

</div>

6049

6050

6051

6052

6053

<h4>Returns:</h4>

6054

6055

6056

6057

6058

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

6059

6060

A reference to the host object.

6061

6062

</div>

6063

</div>

6064

6065

6066

6067

</div>

6068

6069

6070

6071

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

6072

6073

6074

6075

6076

6077

6078

6079

6080

6081

</li>

6082

6083

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

6084

</div>

6085

6086

6087

6088

6089

6090

6091

6092

6093

6094

6095

6096

6097

6098

6099

6100

6101

6102

<p>Inherited from

6103

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

6104

6105

6106

6107

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

6108

6109

</p>

6110

6111

6112

6113

6114

6115

</div>

6116

6117

6118

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

6119

is determined by the order registered. Multiple targets can

6120

be specified.</p>

6121

6122

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

6123

6124

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

6125

</div>

6126

6127

6128

6129

<h4>Parameters:</h4>

6130

6131

6132

6133

6134

6135

6136

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

6137

6138

6139

6140

6141

6142

<p>the target to add</p>

6143

</div>

6144

6145

6146

</li>

6147

6148

</ul>

6149

</div>

6150

6151

6152

6153

6154

6155

</div>

6156

6157

6158

6159

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

6160

6161

6162

6163

6164

6165

6166

6167

6168

6169

</li>

6170

6171

6172

6173

6174

6175

</li>

6176

6177

6178

6179

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

6180

6181

</li>

6182

6183

6184

6185

6186

6187

</li>

6188

6189

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

6190

</div>

6191

6192

6193

6194

6195

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

6196

</span>

6197

6198

6199

6200

6201

6202

6203

6204

6205

6206

6207

6208

6209

6210

6211

6212

<p>Inherited from

6213

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

6214

6215

6216

6217

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

6218

6219

</p>

6220

6221

6222

6223

6224

6225

</div>

6226

6227

6228

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

6229

supplied callback will execute after any listeners add

6230

via the subscribe method, and after the default function,

6231

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

6232

</div>

6233

6234

6235

6236

<h4>Parameters:</h4>

6237

6238

6239

6240

6241

6242

6243

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

6244

6245

6246

6247

6248

6249

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

6250

</div>

6251

6252

6253

</li>

6254

6255

6256

6257

6258

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

6259

6260

6261

6262

6263

6264

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

6265

</div>

6266

6267

6268

</li>

6269

6270

6271

6272

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

6273

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

6274

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

6275

6276

6277

6278

6279

6280

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

6281

</div>

6282

6283

6284

</li>

6285

6286

6287

6288

6289

6290

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

6291

6292

6293

6294

6295

6296

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

6297

</div>

6298

6299

6300

</li>

6301

6302

</ul>

6303

</div>

6304

6305

6306

6307

6308

<h4>Returns:</h4>

6309

6310

6311

6312

6313

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

6314

6315

A subscription handle capable of detaching the

6316

subscription

6317

6318

</div>

6319

</div>

6320

6321

6322

6323

</div>

6324

6325

6326

6327

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

6328

6329

6330

6331

6332

6333

6334

6335

6336

6337

</li>

6338

6339

6340

6341

6342

6343

</li>

6344

6345

6346

6347

<code>context</code>

6348

6349

</li>

6350

6351

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

6352

</div>

6353

6354

6355

6356

6357

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

6358

</span>

6359

6360

6361

6362

6363

6364

6365

6366

6367

6368

6369

6370

6371

6372

6373

6374

6375

<p>

6376

6377

Defined in

6378

6379

6380

6381

6382

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

6383

6384

</p>

6385

6386

6387

6388

6389

6390

</div>

6391

6392

6393

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

6394

6395

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

6396

</div>

6397

6398

6399

6400

<h4>Parameters:</h4>

6401

6402

6403

6404

6405

6406

6407

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

6408

6409

6410

6411

6412

6413

<p>The event type.</p>

6414

</div>

6415

6416

6417

</li>

6418

6419

6420

6421

6422

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

6423

6424

6425

6426

6427

6428

<p>The listener.</p>

6429

</div>

6430

6431

6432

</li>

6433

6434

6435

6436

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

6437

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

6438

6439

6440

6441

6442

6443

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

6444

</div>

6445

6446

6447

</li>

6448

6449

</ul>

6450

</div>

6451

6452

6453

6454

6455

<h4>Returns:</h4>

6456

6457

6458

6459

6460

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

6461

6462

handle The detach handle for the listener.

6463

6464

</div>

6465

</div>

6466

6467

6468

6469

</div>

6470

6471

6472

6473

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

6474

6475

6476

6477

6478

6479

6480

6481

<code>method</code>

6482

6483

</li>

6484

6485

6486

6487

6488

6489

</li>

6490

6491

6492

6493

<code>context</code>

6494

6495

</li>

6496

6497

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

6498

</div>

6499

6500

6501

6502

6503

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

6504

</span>

6505

6506

6507

6508

6509

6510

6511

6512

6513

6514

6515

6516

6517

6518

6519

6520

6521

<p>

6522

6523

Defined in

6524

6525

6526

6527

6528

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

6529

6530

</p>

6531

6532

6533

6534

6535

6536

</div>

6537

6538

6539

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

6540

6541

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

6542

</div>

6543

6544

6545

6546

<h4>Parameters:</h4>

6547

6548

6549

6550

6551

6552

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

6553

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

6554

6555

6556

6557

6558

6559

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

6560

</div>

6561

6562

6563

</li>

6564

6565

6566

6567

6568

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

6569

6570

6571

6572

6573

6574

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

6575

</div>

6576

6577

6578

</li>

6579

6580

6581

6582

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

6583

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

6584

6585

6586

6587

6588

6589

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

6590

</div>

6591

6592

6593

</li>

6594

6595

</ul>

6596

</div>

6597

6598

6599

6600

6601

<h4>Returns:</h4>

6602

6603

6604

6605

6606

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

6607

6608

handle The detach handle for the injected function.

6609

6610

</div>

6611

</div>

6612

6613

6614

6615

</div>

6616

6617

6618

6619

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

6620

6621

6622

6623

6624

6625

6626

6627

6628

6629

</li>

6630

6631

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

6632

</div>

6633

6634

6635

6636

6637

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

6638

</span>

6639

6640

6641

6642

6643

6644

6645

6646

6647

6648

6649

6650

6651

6652

6653

6654

<p>Inherited from

6655

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

6656

6657

6658

6659

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

6660

6661

</p>

6662

6663

6664

6665

6666

6667

</div>

6668

6669

6670

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

6671

</div>

6672

6673

6674

6675

<h4>Parameters:</h4>

6676

6677

6678

6679

6680

6681

6682

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

6683

6684

6685

6686

6687

6688

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

6689

</div>

6690

6691

6692

</li>

6693

6694

</ul>

6695

</div>

6696

6697

6698

6699

6700

<h4>Returns:</h4>

6701

6702

6703

6704

6705

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

6706

6707

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.

6708

6709

</div>

6710

</div>

6711

6712

6713

6714

</div>

6715

6716

6717

6718

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

6719

6720

6721

6722

6723

6724

6725

6726

6727

</span>

6728

6729

6730

6731

6732

6733

6734

6735

6736

6737

6738

6739

6740

6741

6742

6743

<p>Inherited from

6744

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

6745

6746

6747

6748

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

6749

6750

</p>

6751

6752

6753

6754

6755

6756

</div>

6757

6758

6759

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

6760

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

6761

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

6762

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

6763

6764

<p>For DOM and custom events:

6765

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

6766

6767

<p>For methods:

6768

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

6769

</div>

6770

6771

6772

6773

6774

6775

<h4>Returns:</h4>

6776

6777

6778

6779

6780

detach handle

6781

6782

</div>

6783

</div>

6784

6785

6786

6787

</div>

6788

6789

6790

6791

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

6792

6793

6794

6795

6796

6797

6798

6799

<code>method</code>

6800

6801

</li>

6802

6803

6804

6805

6806

6807

</li>

6808

6809

6810

6811

<code>context</code>

6812

6813

</li>

6814

6815

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

6816

</div>

6817

6818

6819

6820

6821

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

6822

</span>

6823

6824

6825

6826

6827

6828

6829

6830

6831

6832

6833

6834

6835

6836

6837

6838

6839

<p>

6840

6841

Defined in

6842

6843

6844

6845

6846

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

6847

6848

</p>

6849

6850

6851

6852

6853

6854

</div>

6855

6856

6857

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

6858

6859

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

6860

</div>

6861

6862

6863

6864

<h4>Parameters:</h4>

6865

6866

6867

6868

6869

6870

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

6871

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

6872

6873

6874

6875

6876

6877

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

6878

</div>

6879

6880

6881

</li>

6882

6883

6884

6885

6886

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

6887

6888

6889

6890

6891

6892

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

6893

</div>

6894

6895

6896

</li>

6897

6898

6899

6900

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

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

6903

6904

6905

6906

6907

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

6908

</div>

6909

6910

6911

</li>

6912

6913

</ul>

6914

</div>

6915

6916

6917

6918

6919

<h4>Returns:</h4>

6920

6921

6922

6923

6924

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

6925

6926

handle The detach handle for the injected function.

6927

6928

</div>

6929

</div>

6930

6931

6932

6933

</div>

6934

6935

6936

6937

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

6938

6939

6940

6941

6942

6943

6944

6945

6946

6947

</li>

6948

6949

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

6950

</div>

6951

6952

6953

6954

6955

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

6956

</span>

6957

6958

6959

6960

6961

6962

6963

6964

6965

6966

6967

6968

6969

6970

6971

6972

<p>Inherited from

6973

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

6974

6975

6976

6977

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

6978

6979

</p>

6980

6981

6982

6983

6984

6985

</div>

6986

6987

6988

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

6989

</div>

6990

6991

6992

6993

<h4>Parameters:</h4>

6994

6995

6996

6997

6998

6999

7000

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

7001

7002

7003

7004

7005

7006

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

7007

</div>

7008

7009

7010

</li>

7011

7012

</ul>

7013

</div>

7014

7015

7016

7017

7018

<h4>Returns:</h4>

7019

7020

7021

7022

7023

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

7024

7025

the aggregated return value from Event.Custom.fire

7026

7027

</div>

7028

</div>

7029

7030

7031

7032

</div>

7033

7034

7035

7036

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

7037

7038

7039

7040

7041

7042

7043

7044

7045

</span>

7046

7047

7048

7049

7050

7051

7052

7053

7054

7055

7056

7057

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

7058

7059

7060

7061

7062

<p>Inherited from

7063

7064

BaseCore

7065

</a>

7066

7067

but overwritten in

7068

7069

7070

7071

7072

7073

</p>

7074

7075

7076

7077

7078

7079

</div>

7080

7081

7082

<p>

7083

Destroy lifecycle method. Fires the destroy

7084

event, prior to invoking destructors for the

7085

class hierarchy.

7086

</p>

7087

7088

<p>

7089

Subscribers to the destroy

7090

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

7091

from proceeding.

7092

</p>

7093

</div>

7094

7095

7096

7097

7098

7099

<h4>Returns:</h4>

7100

7101

7102

7103

7104

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

7105

7106

A reference to this object

7107

7108

</div>

7109

</div>

7110

7111

7112

7113

</div>

7114

7115

7116

7117

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

7118

7119

7120

7121

7122

7123

7124

7125

7126

7127

7128

7129

7130

7131

7132

7133

7134

7135

7136

7137

7138

7139

<p>

7140

7141

Defined in

7142

7143

7144

7145

7146

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

7147

7148

</p>

7149

7150

7151

7152

7153

7154

</div>

7155

7156

7157

<p>Destructor lifecycle implementation.</p>

7158

7159

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

7160

</div>

7161

7162

7163

7164

7165

7166

7167

</div>

7168

7169

7170

7171

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

7172

7173

7174

7175

7176

7177

7178

7179

7180

7181

</li>

7182

7183

7184

7185

7186

7187

</li>

7188

7189

7190

7191

<code>context</code>

7192

7193

</li>

7194

7195

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

7196

</div>

7197

7198

7199

7200

7201

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

7202

</span>

7203

7204

7205

7206

7207

7208

7209

7210

7211

7212

7213

7214

7215

7216

7217

7218

<p>Inherited from

7219

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

7220

7221

7222

7223

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

7224

7225

</p>

7226

7227

7228

7229

7230

7231

</div>

7232

7233

7234

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

7235

</div>

7236

7237

7238

7239

<h4>Parameters:</h4>

7240

7241

7242

7243

7244

7245

7246

7247

7248

7249

7250

7251

7252

<p>Either the handle to the subscriber or the

7253

type of event. If the type

7254

is not specified, it will attempt to remove

7255

the listener from all hosted events.</p>

7256

</div>

7257

7258

7259

</li>

7260

7261

7262

7263

7264

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

7265

7266

7267

7268

7269

7270

<p>The subscribed function to unsubscribe, if not

7271

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

7272

</div>

7273

7274

7275

</li>

7276

7277

7278

7279

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

7280

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

7281

7282

7283

7284

7285

7286

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

7287

optional, but if supplied will be used to

7288

disambiguate multiple listeners that are the same

7289

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

7290

that lives on the prototype)</p>

7291

</div>

7292

7293

7294

</li>

7295

7296

</ul>

7297

</div>

7298

7299

7300

7301

7302

<h4>Returns:</h4>

7303

7304

7305

7306

7307

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

7308

7309

the host

7310

7311

</div>

7312

</div>

7313

7314

7315

7316

</div>

7317

7318

7319

7320

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

7321

7322

7323

7324

7325

7326

7327

7328

7329

7330

</li>

7331

7332

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

7333

</div>

7334

7335

7336

7337

7338

7339

7340

7341

7342

7343

7344

7345

7346

7347

7348

7349

7350

7351

<p>Inherited from

7352

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

7353

7354

7355

7356

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

7357

7358

</p>

7359

7360

7361

7362

7363

7364

</div>

7365

7366

7367

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

7368

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

7369

be removed.</p>

7370

</div>

7371

7372

7373

7374

<h4>Parameters:</h4>

7375

7376

7377

7378

7379

7380

7381

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

7382

7383

7384

7385

7386

7387

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

7388

</div>

7389

7390

7391

</li>

7392

7393

</ul>

7394

</div>

7395

7396

7397

7398

7399

7400

</div>

7401

7402

7403

7404

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

7405

7406

7407

7408

7409

7410

7411

7412

<code>strMethod</code>

7413

7414

</li>

7415

7416

7417

7418

7419

7420

</li>

7421

7422

7423

7424

<code>context</code>

7425

7426

</li>

7427

7428

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

7429

</div>

7430

7431

7432

7433

7434

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

7435

</span>

7436

7437

7438

7439

7440

7441

7442

7443

7444

7445

7446

7447

7448

7449

7450

7451

7452

<p>

7453

7454

Defined in

7455

7456

7457

7458

7459

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

7460

7461

</p>

7462

7463

7464

7465

7466

7467

</div>

7468

7469

7470

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

7471

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

7472

</div>

7473

7474

7475

7476

<h4>Parameters:</h4>

7477

7478

7479

7480

7481

7482

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

7483

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

7484

7485

7486

7487

7488

7489

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

7490

</div>

7491

7492

7493

</li>

7494

7495

7496

7497

7498

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

7499

7500

7501

7502

7503

7504

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

7505

</div>

7506

7507

7508

</li>

7509

7510

7511

7512

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

7513

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

7514

7515

7516

7517

7518

7519

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

7520

</div>

7521

7522

7523

</li>

7524

7525

</ul>

7526

</div>

7527

7528

7529

7530

7531

<h4>Returns:</h4>

7532

7533

7534

7535

7536

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

7537

7538

handle The detach handle for the listener.

7539

7540

</div>

7541

</div>

7542

7543

7544

7545

</div>

7546

7547

7548

7549

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

7550

7551

7552

7553

7554

7555

7556

7557

<code>strMethod</code>

7558

7559

</li>

7560

7561

7562

7563

7564

7565

</li>

7566

7567

7568

7569

<code>context</code>

7570

7571

</li>

7572

7573

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

7574

</div>

7575

7576

7577

7578

7579

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

7580

</span>

7581

7582

7583

7584

7585

7586

7587

7588

7589

7590

7591

7592

7593

7594

7595

7596

7597

<p>

7598

7599

Defined in

7600

7601

7602

7603

7604

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

7605

7606

</p>

7607

7608

7609

7610

7611

7612

</div>

7613

7614

7615

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

7616

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

7617

</div>

7618

7619

7620

7621

<h4>Parameters:</h4>

7622

7623

7624

7625

7626

7627

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

7628

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

7629

7630

7631

7632

7633

7634

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

7635

</div>

7636

7637

7638

</li>

7639

7640

7641

7642

7643

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

7644

7645

7646

7647

7648

7649

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

7650

</div>

7651

7652

7653

</li>

7654

7655

7656

7657

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

7658

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

7659

7660

7661

7662

7663

7664

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

7665

</div>

7666

7667

7668

</li>

7669

7670

</ul>

7671

</div>

7672

7673

7674

7675

7676

<h4>Returns:</h4>

7677

7678

7679

7680

7681

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

7682

7683

handle The detach handle for the handler.

7684

7685

</div>

7686

</div>

7687

7688

7689

7690

</div>

7691

7692

7693

7694

7695

7696

7697

7698

7699

7700

7701

7702

7703

7704

</li>

7705

7706

7707

7708

<code>arguments</code>

7709

7710

</li>

7711

7712

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

7713

</div>

7714

7715

7716

7717

7718

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

7719

</span>

7720

7721

7722

7723

7724

7725

7726

7727

7728

7729

7730

7731

7732

7733

7734

7735

<p>Inherited from

7736

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

7737

7738

7739

7740

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

7741

7742

</p>

7743

7744

7745

7746

7747

7748

</div>

7749

7750

7751

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

7752

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

7753

following parameters.</p>

7754

7755

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

7756

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

7757

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

7758

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

7759

be published on this object first.</p>

7760

7761

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

7762

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

7763

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

7764

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

7765

in place of the original object.</p>

7766

</div>

7767

7768

7769

7770

<h4>Parameters:</h4>

7771

7772

7773

7774

7775

7776

7777

7778

7779

7780

7781

7782

7783

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

7784

a 'type' property.</p>

7785

</div>

7786

7787

7788

</li>

7789

7790

7791

7792

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

7793

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

7794

7795

7796

7797

7798

7799

<p>an arbitrary set of parameters to pass to

7800

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

7801

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

7802

parameter after the properties the object literal contains are copied to

7803

the event facade.</p>

7804

</div>

7805

7806

7807

</li>

7808

7809

</ul>

7810

</div>

7811

7812

7813

7814

7815

<h4>Returns:</h4>

7816

7817

7818

7819

7820

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

7821

7822

the event host

7823

7824

</div>

7825

</div>

7826

7827

7828

7829

</div>

7830

7831

7832

7833

7834

7835

7836

7837

7838

7839

7840

7841

7842

7843

</li>

7844

7845

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

7846

</div>

7847

7848

7849

7850

7851

7852

</span>

7853

7854

7855

7856

7857

7858

7859

7860

7861

7862

7863

7864

7865

7866

7867

7868

<p>Inherited from

7869

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

7870

7871

7872

7873

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

7874

7875

</p>

7876

7877

7878

7879

7880

7881

</div>

7882

7883

7884

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

7885

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

7886

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

7887

</div>

7888

7889

7890

7891

<h4>Parameters:</h4>

7892

7893

7894

7895

7896

7897

7898

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

7899

7900

7901

7902

7903

7904

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

7905

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

7906

</div>

7907

7908

7909

</li>

7910

7911

</ul>

7912

</div>

7913

7914

7915

7916

7917

<h4>Returns:</h4>

7918

7919

7920

7921

7922

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

7923

7924

The value of the attribute

7925

7926

</div>

7927

</div>

7928

7929

7930

7931

</div>

7932

7933

7934

7935

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

7936

7937

7938

7939

7940

7941

7942

7943

<code>attrs</code>

7944

7945

</li>

7946

7947

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

7948

</div>

7949

7950

7951

7952

7953

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

7954

</span>

7955

7956

7957

7958

7959

7960

7961

7962

7963

7964

7965

7966

7967

7968

7969

7970

<p>Inherited from

7971

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

7972

7973

7974

7975

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

7976

7977

</p>

7978

7979

7980

7981

7982

7983

</div>

7984

7985

7986

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

7987

</div>

7988

7989

7990

7991

<h4>Parameters:</h4>

7992

7993

7994

7995

7996

7997

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

7998

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

7999

8000

8001

8002

8003

8004

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

8005

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

8006

</div>

8007

8008

8009

</li>

8010

8011

</ul>

8012

</div>

8013

8014

8015

8016

8017

<h4>Returns:</h4>

8018

8019

8020

8021

8022

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

8023

8024

An object with attribute name/value pairs.

8025

8026

</div>

8027

</div>

8028

8029

8030

8031

</div>

8032

8033

8034

8035

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

8036

8037

8038

8039

8040

8041

8042

8043

8044

8045

</li>

8046

8047

8048

8049

<code>prefixed</code>

8050

8051

</li>

8052

8053

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

8054

</div>

8055

8056

8057

8058

8059

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

8060

</span>

8061

8062

8063

8064

8065

8066

8067

8068

8069

8070

8071

8072

8073

8074

8075

8076

<p>Inherited from

8077

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

8078

8079

8080

8081

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

8082

8083

</p>

8084

8085

8086

8087

8088

8089

</div>

8090

8091

8092

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

8093

falsy value otherwise</p>

8094

</div>

8095

8096

8097

8098

<h4>Parameters:</h4>

8099

8100

8101

8102

8103

8104

8105

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

8106

8107

8108

8109

8110

8111

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

8112

</div>

8113

8114

8115

</li>

8116

8117

8118

8119

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

8120

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

8121

8122

8123

8124

8125

8126

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

8127

</div>

8128

8129

8130

</li>

8131

8132

</ul>

8133

</div>

8134

8135

8136

8137

8138

<h4>Returns:</h4>

8139

8140

8141

8142

8143

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

8144

8145

the custom event or null

8146

8147

</div>

8148

</div>

8149

8150

8151

8152

</div>

8153

8154

8155

8156

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

8157

8158

8159

8160

8161

8162

8163

8164

8165

</span>

8166

8167

8168

8169

8170

8171

8172

8173

8174

8175

8176

8177

8178

8179

8180

8181

<p>Inherited from

8182

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

8183

8184

8185

8186

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

8187

8188

</p>

8189

8190

8191

8192

8193

8194

</div>

8195

8196

8197

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

8198

</div>

8199

8200

8201

8202

8203

8204

<h4>Returns:</h4>

8205

8206

8207

8208

8209

EventTarget[]

8210

8211

</div>

8212

</div>

8213

8214

8215

8216

</div>

8217

8218

8219

8220

8221

8222

8223

8224

8225

8226

8227

8228

<code>config</code>

8229

8230

</li>

8231

8232

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

8233

</div>

8234

8235

8236

8237

8238

8239

</span>

8240

8241

8242

8243

8244

8245

8246

8247

8248

8249

8250

8251

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

8252

8253

8254

8255

8256

<p>Inherited from

8257

8258

BaseCore

8259

</a>

8260

8261

but overwritten in

8262

8263

8264

8265

8266

8267

</p>

8268

8269

8270

8271

8272

8273

</div>

8274

8275

8276

<p>Init lifecycle method, invoked during construction.

8277

Fires the init event prior to setting up attributes and

8278

invoking initializers for the class hierarchy.</p>

8279

</div>

8280

8281

8282

8283

<h4>Parameters:</h4>

8284

8285

8286

8287

8288

8289

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

8290

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

8291

8292

8293

8294

8295

8296

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

8297

</div>

8298

8299

8300

</li>

8301

8302

</ul>

8303

</div>

8304

8305

8306

8307

8308

<h4>Returns:</h4>

8309

8310

8311

8312

8313

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

8314

8315

A reference to this object

8316

8317

</div>

8318

</div>

8319

8320

8321

8322

</div>

8323

8324

8325

8326

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

8327

8328

8329

8330

8331

8332

8333

8334

<code>config</code>

8335

8336

</li>

8337

8338

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

8339

</div>

8340

8341

8342

8343

8344

8345

8346

8347

8348

8349

8350

8351

8352

8353

8354

8355

8356

8357

8358

<p>

8359

8360

Defined in

8361

8362

8363

8364

8365

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

8366

8367

</p>

8368

8369

8370

8371

8372

8373

</div>

8374

8375

8376

<p>Initializer lifecycle implementation.</p>

8377

</div>

8378

8379

8380

8381

<h4>Parameters:</h4>

8382

8383

8384

8385

8386

8387

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

8388

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

8389

8390

8391

8392

8393

8394

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

8395

</div>

8396

8397

8398

</li>

8399

8400

</ul>

8401

</div>

8402

8403

8404

8405

8406

8407

</div>

8408

8409

8410

8411

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

8412

8413

8414

8415

8416

8417

8418

8419

8420

8421

</li>

8422

8423

8424

8425

<code>config</code>

8426

8427

</li>

8428

8429

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

8430

</div>

8431

8432

8433

8434

8435

8436

8437

8438

8439

8440

8441

8442

8443

8444

8445

8446

8447

8448

<p>Inherited from

8449

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

8450

8451

8452

8453

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

8454

8455

</p>

8456

8457

8458

8459

8460

8461

</div>

8462

8463

8464

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

8465

8466

<p>

8467

The properties which can be modified through this interface are limited

8468

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

8469

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

8470

broadcast and getter.

8471

</p>

8472

</div>

8473

8474

8475

8476

<h4>Parameters:</h4>

8477

8478

8479

8480

8481

8482

8483

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

8484

8485

8486

8487

8488

8489

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

8490

</div>

8491

8492

8493

</li>

8494

8495

8496

8497

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

8498

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

8499

8500

8501

8502

8503

8504

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

8505

</div>

8506

8507

8508

</li>

8509

8510

</ul>

8511

</div>

8512

8513

8514

8515

8516

8517

</div>

8518

8519

8520

8521

8522

8523

8524

8525

8526

8527

8528

8529

8530

8531

</li>

8532

8533

8534

8535

8536

8537

</li>

8538

8539

8540

8541

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

8542

8543

</li>

8544

8545

8546

8547

8548

8549

</li>

8550

8551

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

8552

</div>

8553

8554

8555

8556

8557

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

8558

</span>

8559

8560

8561

8562

8563

8564

8565

8566

8567

8568

8569

8570

8571

8572

8573

8574

<p>Inherited from

8575

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

8576

8577

8578

8579

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

8580

8581

</p>

8582

8583

8584

8585

8586

8587

</div>

8588

8589

8590

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

8591

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

8592

8593

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

8594

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

8595

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

8596

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

8597

API for all available properties and methods. Subscribers to

8598

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

8599

after the event name.</p>

8600

8601

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

8602

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

8603

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

8604

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

8605

8606

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

8607

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

8608

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

8609

</div>

8610

8611

8612

8613

<h4>Parameters:</h4>

8614

8615

8616

8617

8618

8619

8620

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

8621

8622

8623

8624

8625

8626

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

8627

</div>

8628

8629

8630

</li>

8631

8632

8633

8634

8635

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

8636

8637

8638

8639

8640

8641

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

8642

</div>

8643

8644

8645

</li>

8646

8647

8648

8649

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

8650

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

8651

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

8652

8653

8654

8655

8656

8657

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

8658

</div>

8659

8660

8661

</li>

8662

8663

8664

8665

8666

8667

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

8668

8669

8670

8671

8672

8673

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

8674

</div>

8675

8676

8677

</li>

8678

8679

</ul>

8680

</div>

8681

8682

8683

8684

8685

<h4>Returns:</h4>

8686

8687

8688

8689

8690

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

8691

8692

A subscription handle capable of detaching that

8693

subscription

8694

8695

</div>

8696

</div>

8697

8698

8699

8700

</div>

8701

8702

8703

8704

8705

8706

8707

8708

8709

8710

8711

8712

8713

8714

</li>

8715

8716

8717

8718

8719

8720

</li>

8721

8722

8723

8724

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

8725

8726

</li>

8727

8728

8729

8730

8731

8732

</li>

8733

8734

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

8735

</div>

8736

8737

8738

8739

8740

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

8741

</span>

8742

8743

8744

8745

8746

8747

8748

8749

8750

8751

8752

8753

8754

8755

8756

8757

<p>Inherited from

8758

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

8759

8760

8761

8762

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

8763

8764

</p>

8765

8766

8767

8768

8769

8770

</div>

8771

8772

8773

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

8774

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

8775

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

8776

</div>

8777

8778

8779

8780

<h4>Parameters:</h4>

8781

8782

8783

8784

8785

8786

8787

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

8788

8789

8790

8791

8792

8793

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

8794

</div>

8795

8796

8797

</li>

8798

8799

8800

8801

8802

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

8803

8804

8805

8806

8807

8808

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

8809

</div>

8810

8811

8812

</li>

8813

8814

8815

8816

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

8817

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

8818

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

8819

8820

8821

8822

8823

8824

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

8825

</div>

8826

8827

8828

</li>

8829

8830

8831

8832

8833

8834

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

8835

8836

8837

8838

8839

8840

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

8841

</div>

8842

8843

8844

</li>

8845

8846

</ul>

8847

</div>

8848

8849

8850

8851

8852

<h4>Returns:</h4>

8853

8854

8855

8856

8857

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

8858

8859

A subscription handle capable of detaching the

8860

subscription

8861

8862

</div>

8863

</div>

8864

8865

8866

8867

</div>

8868

8869

8870

8871

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

8872

8873

8874

8875

8876

8877

8878

8879

8880

8881

</li>

8882

8883

8884

8885

8886

8887

</li>

8888

8889

8890

8891

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

8892

8893

</li>

8894

8895

8896

8897

8898

8899

</li>

8900

8901

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

8902

</div>

8903

8904

8905

8906

8907

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

8908

</span>

8909

8910

8911

8912

8913

8914

8915

8916

8917

8918

8919

8920

8921

8922

8923

8924

<p>Inherited from

8925

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

8926

8927

8928

8929

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

8930

8931

</p>

8932

8933

8934

8935

8936

8937

</div>

8938

8939

8940

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

8941

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

8942

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

8943

</div>

8944

8945

8946

8947

<h4>Parameters:</h4>

8948

8949

8950

8951

8952

8953

8954

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

8955

8956

8957

8958

8959

8960

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

8961

</div>

8962

8963

8964

</li>

8965

8966

8967

8968

8969

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

8970

8971

8972

8973

8974

8975

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

8976

</div>

8977

8978

8979

</li>

8980

8981

8982

8983

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

8984

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

8985

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

8986

8987

8988

8989

8990

8991

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

8992

</div>

8993

8994

8995

</li>

8996

8997

8998

8999

9000

9001

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

9002

9003

9004

9005

9006

9007

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

9008

</div>

9009

9010

9011

</li>

9012

9013

</ul>

9014

</div>

9015

9016

9017

9018

9019

<h4>Returns:</h4>

9020

9021

9022

9023

9024

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

9025

9026

A subscription handle capable of detaching that

9027

subscription

9028

9029

</div>

9030

</div>

9031

9032

9033

9034

</div>

9035

9036

9037

9038

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

9039

9040

9041

9042

9043

9044

9045

9046

9047

9048

</li>

9049

9050

9051

9052

9053

9054

</li>

9055

9056

9057

9058

<code>context</code>

9059

9060

</li>

9061

9062

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

9063

</div>

9064

9065

9066

9067

9068

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

9069

</span>

9070

9071

9072

9073

9074

9075

9076

9077

9078

9079

9080

9081

9082

9083

9084

9085

9086

<p>

9087

9088

Defined in

9089

9090

9091

9092

9093

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

9094

9095

</p>

9096

9097

9098

9099

9100

9101

</div>

9102

9103

9104

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

9105

9106

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

9107

</div>

9108

9109

9110

9111

<h4>Parameters:</h4>

9112

9113

9114

9115

9116

9117

9118

9119

9120

9121

9122

9123

9124

<p>The event type.</p>

9125

</div>

9126

9127

9128

</li>

9129

9130

9131

9132

9133

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

9134

9135

9136

9137

9138

9139

<p>The listener.</p>

9140

</div>

9141

9142

9143

</li>

9144

9145

9146

9147

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

9148

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

9149

9150

9151

9152

9153

9154

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

9155

</div>

9156

9157

9158

</li>

9159

9160

</ul>

9161

</div>

9162

9163

9164

9165

9166

<h4>Returns:</h4>

9167

9168

9169

9170

9171

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

9172

9173

handle The detach handle for the listener.

9174

9175

</div>

9176

</div>

9177

9178

9179

9180

</div>

9181

9182

9183

9184

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

9185

9186

9187

9188

9189

9190

9191

9192

9193

9194

</li>

9195

9196

9197

9198

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

9199

9200

</li>

9201

9202

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

9203

</div>

9204

9205

9206

9207

9208

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

9209

</span>

9210

9211

9212

9213

9214

9215

9216

9217

9218

9219

9220

9221

9222

9223

9224

9225

<p>Inherited from

9226

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

9227

9228

9229

9230

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

9231

9232

</p>

9233

9234

9235

9236

9237

9238

<p>Available since 3.3.0</p>

9239

9240

</div>

9241

9242

9243

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

9244

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

9245

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

9246

to include the prefix one is supplied or the event target

9247

is configured with a default prefix.</p>

9248

</div>

9249

9250

9251

9252

<h4>Parameters:</h4>

9253

9254

9255

9256

9257

9258

9259

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

9260

9261

9262

9263

9264

9265

9266

</div>

9267

9268

9269

</li>

9270

9271

9272

9273

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

9274

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

9275

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

9276

9277

9278

9279

9280

9281

<p>the prefix</p>

9282

</div>

9283

9284

9285

</li>

9286

9287

</ul>

9288

</div>

9289

9290

9291

9292

9293

<h4>Returns:</h4>

9294

9295

9296

9297

9298

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

9299

9300

an array containing:

9301

* the detach category, if supplied,

9302

* the prefixed event type,

9303

* whether or not this is an after listener,

9304

* the supplied event type

9305

9306

</div>

9307

</div>

9308

9309

9310

9311

</div>

9312

9313

9314

9315

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

9316

9317

9318

9319

9320

9321

9322

9323

9324

9325

</li>

9326

9327

9328

9329

9330

9331

</li>

9332

9333

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

9334

</div>

9335

9336

9337

9338

9339

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

9340

</span>

9341

9342

9343

9344

9345

9346

9347

9348

9349

9350

9351

9352

9353

9354

9355

9356

<p>Inherited from

9357

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

9358

9359

9360

9361

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

9362

9363

</p>

9364

9365

9366

9367

9368

9369

</div>

9370

9371

9372

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

9373

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

9374

case the custom event is returned.</p>

9375

</div>

9376

9377

9378

9379

<h4>Parameters:</h4>

9380

9381

9382

9383

9384

9385

9386

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

9387

9388

9389

9390

9391

9392

<p>the type, or name of the event</p>

9393

</div>

9394

9395

9396

</li>

9397

9398

9399

9400

9401

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>

9402

9403

9404

9405

9406

9407

<p>optional config params. Valid properties are:</p>

9408

9409

<p><ul>

9410

<li>

9411

'broadcast': whether or not the YUI instance and YUI global are notified when the event is fired (false)

9412

</li>

9413

<li>

9414

'bubbles': whether or not this event bubbles (true)

9415

Events can only bubble if emitFacade is true.

9416

</li>

9417

<li>

9418

'context': the default execution context for the listeners (this)

9419

</li>

9420

<li>

9421

'defaultFn': the default function to execute when this event fires if preventDefault was not called

9422

</li>

9423

<li>

9424

'emitFacade': whether or not this event emits a facade (false)

9425

</li>

9426

<li>

9427

'prefix': the prefix for this targets events, e.g., 'menu' in 'menu:click'

9428

</li>

9429

<li>

9430

'fireOnce': if an event is configured to fire once, new subscribers after

9431

the fire will be notified immediately.

9432

</li>

9433

<li>

9434

'async': fireOnce event listeners will fire synchronously if the event has already

9435

fired unless async is true.

9436

</li>

9437

<li>

9438

'preventable': whether or not preventDefault() has an effect (true)

9439

</li>

9440

<li>

9441

'preventedFn': a function that is executed when preventDefault is called

9442

</li>

9443

<li>

9444

'queuable': whether or not this event can be queued during bubbling (false)

9445

</li>

9446

<li>

9447

'silent': if silent is true, debug messages are not provided for this event.

9448

</li>

9449

<li>

9450

'stoppedFn': a function that is executed when stopPropagation is called

9451

</li></p>

9452

9453

<p><li>

9454

'monitored': specifies whether or not this event should send notifications about

9455

when the event has been attached, detached, or published.

9456

</li>

9457

<li>

9458

'type': the event type (valid option if not provided as the first parameter to publish)

9459

</li>

9460

</ul></p>

9461

</div>

9462

9463

9464

</li>

9465

9466

</ul>

9467

</div>

9468

9469

9470

9471

9472

<h4>Returns:</h4>

9473

9474

9475

9476

9477

<span class="type"><a href="../classes/CustomEvent.html" class="crosslink">CustomEvent</a></span>:

9478

9479

the custom event

9480

9481

</div>

9482

</div>

9483

9484

9485

9486

</div>

9487

9488

9489

9490

<h3 class="name"><code>removeAttr</code></h3>

9491

9492

9493

9494

9495

9496

9497

9498

9499

9500

</li>

9501

9502

</ul><span class="paren">)</span>

9503

</div>

9504

9505

9506

9507

9508

9509

9510

9511

9512

9513

9514

9515

9516

9517

9518

9519

9520

9521

<p>Inherited from

9522

<a href="../classes/AttributeExtras.html#method_removeAttr">AttributeExtras</a>:

9523

9524

9525

9526

<a href="../files/attribute_js_AttributeExtras.js.html#l77"><code>attribute/js/AttributeExtras.js:77</code></a>

9527

9528

</p>

9529

9530

9531

9532

9533

9534

</div>

9535

9536

9537

<p>Removes an attribute from the host object</p>

9538

</div>

9539

9540

9541

9542

<h4>Parameters:</h4>

9543

9544

9545

9546

9547

9548

9549

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

9550

9551

9552

9553

9554

9555

<p>The name of the attribute to be removed.</p>

9556

</div>

9557

9558

9559

</li>

9560

9561

</ul>

9562

</div>

9563

9564

9565

9566

9567

9568

</div>

9569

9570

9571

9572

<h3 class="name"><code>removeTarget</code></h3>

9573

9574

9575

9576

9577

9578

9579

9580

9581

9582

</li>

9583

9584

</ul><span class="paren">)</span>

9585

</div>

9586

9587

9588

9589

9590

9591

9592

9593

9594

9595

9596

9597

9598

9599

9600

9601

9602

9603

<p>Inherited from

9604

<a href="../classes/EventTarget.html#method_removeTarget">EventTarget</a>:

9605

9606

9607

9608

<a href="../files/event-custom_js_event-facade.js.html#l409"><code>event-custom/js/event-facade.js:409</code></a>

9609

9610

</p>

9611

9612

9613

9614

9615

9616

</div>

9617

9618

9619

<p>Removes a bubble target</p>

9620

</div>

9621

9622

9623

9624

<h4>Parameters:</h4>

9625

9626

9627

9628

9629

9630

9631

<span class="type"><a href="../classes/EventTarget.html" class="crosslink">EventTarget</a></span>

9632

9633

9634

9635

9636

9637

<p>the target to remove</p>

9638

</div>

9639

9640

9641

</li>

9642

9643

</ul>

9644

</div>

9645

9646

9647

9648

9649

9650

</div>

9651

9652

9653

9654

<h3 class="name"><code>reset</code></h3>

9655

9656

9657

9658

9659

9660

9661

9662

9663

9664

</li>

9665

9666

</ul><span class="paren">)</span>

9667

</div>

9668

9669

9670

9671

9672

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>

9673

</span>

9674

9675

9676

9677

9678

9679

9680

9681

9682

9683

9684

9685

<span class="flag chainable">chainable</span>

9686

9687

9688

9689

9690

9691

<p>Inherited from

9692

<a href="../classes/AttributeExtras.html#method_reset">AttributeExtras</a>:

9693

9694

9695

9696

<a href="../files/attribute_js_AttributeExtras.js.html#l87"><code>attribute/js/AttributeExtras.js:87</code></a>

9697

9698

</p>

9699

9700

9701

9702

9703

9704

</div>

9705

9706

9707

<p>Resets the attribute (or all attributes) to its initial value, as long as

9708

the attribute is not readOnly, or writeOnce.</p>

9709

</div>

9710

9711

9712

9713

<h4>Parameters:</h4>

9714

9715

9716

9717

9718

9719

9720

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

9721

9722

9723

9724

9725

9726

<p>Optional. The name of the attribute to reset. If omitted, all attributes are reset.</p>

9727

</div>

9728

9729

9730

</li>

9731

9732

</ul>

9733

</div>

9734

9735

9736

9737

9738

<h4>Returns:</h4>

9739

9740

9741

9742

9743

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>:

9744

9745

A reference to the host object.

9746

9747

</div>

9748

</div>

9749

9750

9751

9752

</div>

9753

9754

9755

9756

9757

9758

9759

9760

9761

9762

9763

9764

9765

9766

</li>

9767

9768

9769

9770

<code>value</code>

9771

9772

</li>

9773

9774

</ul><span class="paren">)</span>

9775

</div>

9776

9777

9778

9779

9780

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>

9781

</span>

9782

9783

9784

9785

9786

9787

9788

9789

9790

9791

9792

9793

<span class="flag chainable">chainable</span>

9794

9795

9796

9797

9798

<p>Inherited from

9799

9800

AttributeEvents

9801

</a>

9802

9803

but overwritten in

9804

9805

9806

9807

<a href="../files/attribute_js_AttributeCore.js.html#l328"><code>attribute/js/AttributeCore.js:328</code></a>

9808

9809

</p>

9810

9811

9812

9813

9814

9815

</div>

9816

9817

9818

<p>Sets the value of an attribute.</p>

9819

</div>

9820

9821

9822

9823

<h4>Parameters:</h4>

9824

9825

9826

9827

9828

9829

9830

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

9831

9832

9833

9834

9835

9836

<p>The name of the attribute. If the

9837

current value of the attribute is an Object, dot notation can be used

9838

to set the value of a property within the object (e.g. <code>set("x.y.z", 5)</code>).</p>

9839

</div>

9840

9841

9842

</li>

9843

9844

9845

9846

<code class="param-name">value</code>

9847

9848

9849

9850

9851

9852

9853

<p>The value to set the attribute to.</p>

9854

</div>

9855

9856

9857

</li>

9858

9859

</ul>

9860

</div>

9861

9862

9863

9864

9865

<h4>Returns:</h4>

9866

9867

9868

9869

9870

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>:

9871

9872

A reference to the host object.

9873

9874

</div>

9875

</div>

9876

9877

9878

9879

</div>

9880

9881

9882

9883

<h3 class="name"><code>setAttrs</code></h3>

9884

9885

9886

9887

9888

9889

9890

9891

<code>attrs</code>

9892

9893

</li>

9894

9895

</ul><span class="paren">)</span>

9896

</div>

9897

9898

9899

9900

9901

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>

9902

</span>

9903

9904

9905

9906

9907

9908

9909

9910

9911

9912

9913

9914

<span class="flag chainable">chainable</span>

9915

9916

9917

9918

9919

<p>Inherited from

9920

9921

AttributeEvents

9922

</a>

9923

9924

but overwritten in

9925

9926

9927

9928

<a href="../files/attribute_js_AttributeCore.js.html#l635"><code>attribute/js/AttributeCore.js:635</code></a>

9929

9930

</p>

9931

9932

9933

9934

9935

9936

</div>

9937

9938

9939

<p>Sets multiple attribute values.</p>

9940

</div>

9941

9942

9943

9944

<h4>Parameters:</h4>

9945

9946

9947

9948

9949

9950

<code class="param-name">attrs</code>

9951

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>

9952

9953

9954

9955

9956

9957

<p>An object with attributes name/value pairs.</p>

9958

</div>

9959

9960

9961

</li>

9962

9963

</ul>

9964

</div>

9965

9966

9967

9968

9969

<h4>Returns:</h4>

9970

9971

9972

9973

9974

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>:

9975

9976

A reference to the host object.

9977

9978

</div>

9979

</div>

9980

9981

9982

9983

</div>

9984

9985

9986

9987

<h3 class="name"><code>subscribe</code></h3>

9988

9989

9990

9991

9992

9993

9994

9995

9996

<span class="flag deprecated" title="use on">deprecated</span>

9997

9998

9999

10000

10001

10002

10003

10004

10005

10006

10007

10008

10009

10010

<p>Inherited from

10011

<a href="../classes/EventTarget.html#method_subscribe">EventTarget</a>:

10012

10013

10014

10015

<a href="../files/event-custom_js_event-target.js.html#l335"><code>event-custom/js/event-target.js:335</code></a>

10016

10017

</p>

10018

10019

10020

10021

<p>Deprecated: use on</p>

10022

10023

10024

10025

</div>

10026

10027

10028

<p>subscribe to an event</p>

10029

</div>

10030

10031

10032

10033

10034

10035

10036

</div>

10037

10038

10039

10040

<h3 class="name"><code>toString</code></h3>

10041

10042

10043

10044

10045

10046

10047

10048

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

10049

</span>

10050

10051

10052

10053

10054

10055

10056

10057

10058

10059

10060

10061

10062

10063

10064

10065

<p>Inherited from

10066

<a href="../classes/BaseCore.html#method_toString">BaseCore</a>:

10067

10068

10069

10070

<a href="../files/base_js_BaseCore.js.html#l592"><code>base/js/BaseCore.js:592</code></a>

10071

10072

</p>

10073

10074

10075

10076

10077

10078

</div>

10079

10080

10081

<p>Default toString implementation. Provides the constructor NAME

10082

and the instance guid, if set.</p>

10083

</div>

10084

10085

10086

10087

10088

10089

<h4>Returns:</h4>

10090

10091

10092

10093

10094

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>:

10095

10096

String representation for this object

10097

10098

</div>

10099

</div>

10100

10101

10102

10103

</div>

10104

10105

10106

10107

<h3 class="name"><code>unsubscribe</code></h3>

10108

10109

10110

10111

10112

10113

10114

10115

10116

<span class="flag deprecated" title="use detach">deprecated</span>

10117

10118

10119

10120

10121

10122

10123

10124

10125

10126

10127

10128

10129

10130

<p>Inherited from

10131

<a href="../classes/EventTarget.html#method_unsubscribe">EventTarget</a>:

10132

10133

10134

10135

<a href="../files/event-custom_js_event-target.js.html#l455"><code>event-custom/js/event-target.js:455</code></a>

10136

10137

</p>

10138

10139

10140

10141

<p>Deprecated: use detach</p>

10142

10143

10144

10145

</div>

10146

10147

10148

<p>detach a listener</p>

10149

</div>

10150

10151

10152

10153

10154

10155

10156

</div>

10157

10158

10159

10160

<h3 class="name"><code>unsubscribeAll</code></h3>

10161

10162

10163

10164

10165

10166

10167

10168

10169

10170

</li>

10171

10172

</ul><span class="paren">)</span>

10173

</div>

10174

10175

10176

10177

10178

10179

<span class="flag deprecated" title="use detachAll">deprecated</span>

10180

10181

10182

10183

10184

10185

10186

10187

10188

10189

10190

10191

10192

10193

<p>Inherited from

10194

<a href="../classes/EventTarget.html#method_unsubscribeAll">EventTarget</a>:

10195

10196

10197

10198

<a href="../files/event-custom_js_event-target.js.html#l476"><code>event-custom/js/event-target.js:476</code></a>

10199

10200

</p>

10201

10202

10203

10204

<p>Deprecated: use detachAll</p>

10205

10206

10207

10208

</div>

10209

10210

10211

<p>Removes all listeners from the specified event. If the event type

10212

is not specified, all listeners from all hosted custom events will

10213

be removed.</p>

10214

</div>

10215

10216

10217

10218

<h4>Parameters:</h4>

10219

10220

10221

10222

10223

10224

10225

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

10226

10227

10228

10229

10230

10231

<p>The type, or name of the event</p>

10232

</div>

10233

10234

10235

</li>

10236

10237

</ul>

10238

</div>

10239

10240

10241

10242

10243

10244

</div>

10245

10246

10247

</div>

10248

10249

10250

10251

10252

<h2 class="off-left">Properties</h2>

10253

10254

10255

10256

<h3 class="name"><code>_allowAdHocAttrs</code></h3>

10257

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>

10258

10259

10260

10261

10262

<span class="flag protected">protected</span>

10263

10264

10265

10266

10267

10268

10269

10270

10271

10272

<p>Inherited from

10273

<a href="../classes/BaseCore.html#property__allowAdHocAttrs">BaseCore</a>:

10274

10275

10276

10277

<a href="../files/base_js_BaseCore.js.html#l100"><code>base/js/BaseCore.js:100</code></a>

10278

10279

</p>

10280

10281

10282

10283

10284

</div>

10285

10286

10287

<p>This property controls whether or not instances of this class should

10288

allow users to add ad-hoc attributes through the constructor configuration

10289

hash.</p>

10290

10291

<p>AdHoc attributes are attributes which are not defined by the class, and are

10292

not handled by the MyClass.<em>NON</em>ATTRS_CFG</p>

10293

</div>

10294

10295

10296

<p><strong>Default:</strong> undefined (false)</p>

10297

10298

10299

10300

10301

10302

</div>

10303

10304

10305

10306

<h3 class="name"><code>_handles</code></h3>

10307

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Array" class="crosslink external" target="_blank">Array</a></span>

10308

10309

10310

10311

10312

<span class="flag private">private</span>

10313

10314

10315

10316

10317

10318

10319

10320

10321

10322

10323

<p>

10324

10325

Defined in

10326

10327

10328

10329

10330

<a href="../files/plugin_js_plugin.js.html#l66"><code>plugin/js/plugin.js:66</code></a>

10331

10332

</p>

10333

10334

10335

10336

10337

</div>

10338

10339

10340

<p>The list of event handles for event listeners or AOP injected methods

10341

applied by the plugin to the host object.</p>

10342

</div>

10343

10344

10345

10346

10347

10348

10349

</div>

10350

10351

10352

10353

<h3 class="name"><code>ATTRS</code></h3>

10354

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>

10355

10356

10357

10358

10359

10360

10361

10362

10363

<span class="flag static">static</span>

10364

10365

10366

10367

10368

10369

10370

<p>

10371

10372

Defined in

10373

10374

10375

10376

10377

<a href="../files/plugin_js_plugin.js.html#l22"><code>plugin/js/plugin.js:22</code></a>

10378

10379

</p>

10380

10381

10382

10383

10384

</div>

10385

10386

10387

<p>Object defining the set of attributes supported by the Plugin.Base class</p>

10388

</div>

10389

10390

10391

10392

10393

10394

10395

</div>

10396

10397

10398

10399

10400

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

10401

10402

10403

10404

10405

10406

10407

10408

10409

<span class="flag static">static</span>

10410

10411

10412

10413

10414

10415

10416

<p>

10417

10418

Defined in

10419

10420

10421

10422

10423

<a href="../files/plugin_js_plugin.js.html#l43"><code>plugin/js/plugin.js:43</code></a>

10424

10425

</p>

10426

10427

10428

10429

10430

</div>

10431

10432

10433

<p>The string identifying the Plugin.Base class. Plugins extending

10434

Plugin.Base should set their own NAME value.</p>

10435

</div>

10436

10437

10438

10439

10440

10441

10442

</div>

10443

10444

10445

10446

10447

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

10448

10449

10450

<span class="flag deprecated" title="Use this.constructor.NAME">deprecated</span>

10451

10452

10453

10454

10455

10456

10457

10458

10459

10460

10461

10462

<p>Inherited from

10463

<a href="../classes/BaseCore.html#property_name">BaseCore</a>:

10464

10465

10466

10467

<a href="../files/base_js_BaseCore.js.html#l196"><code>base/js/BaseCore.js:196</code></a>

10468

10469

</p>

10470

10471

10472

<p>Deprecated: Use this.constructor.NAME</p>

10473

10474

10475

10476

</div>

10477

10478

10479

<p>The string used to identify the class of this object.</p>

10480

</div>

10481

10482

10483

10484

10485

10486

10487

</div>

10488

10489

10490

10491

10492

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

10493

10494

10495

10496

10497

10498

10499

10500

10501

<span class="flag static">static</span>

10502

10503

10504

10505

10506

10507

10508

<p>

10509

10510

Defined in

10511

10512

10513

10514

10515

<a href="../files/plugin_js_plugin.js.html#l53"><code>plugin/js/plugin.js:53</code></a>

10516

10517

</p>

10518

10519

10520

10521

10522

</div>

10523

10524

10525

<p>The name of the property the the plugin will be attached to

10526

when plugged into a Plugin Host. Plugins extending Plugin.Base,

10527

should set their own NS value.</p>

10528

</div>

10529

10530

10531

10532

10533

10534

10535

</div>

10536

10537

10538

</div>

10539

10540

10541

10542

10543

<h2 class="off-left">Attributes</h2>

10544

10545

10546

10547

10548

<h3 class="name"><code>destroyed</code></h3>

10549

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>

10550

10551

10552

10553

10554

10555

10556

10557

10558

10559

10560

10561

10562

<p>Inherited from

10563

<a href="../classes/BaseCore.html#attr_destroyed">BaseCore</a>:

10564

10565

10566

10567

<a href="../files/base_js_BaseCore.js.html#l157"><code>base/js/BaseCore.js:157</code></a>

10568

10569

</p>

10570

10571

10572

10573

10574

</div>

10575

10576

10577

<p>Flag indicating whether or not this object

10578

has been through the destroy lifecycle phase.</p>

10579

</div>

10580

10581

10582

<p><strong>Default:</strong> false</p>

10583

10584

10585

10586

10587

<h4>Fires event <code>destroyedChange</code></h4>

10588

10589

<p>

10590

Fires when the value for the configuration attribute <code>destroyed</code> is

10591

changed. You can listen for the event using the <code>on</code> method if you

10592

wish to be notified before the attribute's value has changed, or

10593

using the <code>after</code> method if you wish to be notified after the

10594

attribute's value has changed.

10595

</p>

10596

10597

10598

<h4>Parameters:</h4>

10599

10600

10601

10602

10603

<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>

10604

10605

10606

An Event Facade object with the following

10607

attribute-specific properties added:

10608

</div>

10609

10610

10611

10612

<code class="param-name">prevVal</code>

10613

10614

<div class="param-description">The value of the attribute, prior to it being set.</div>

10615

</li>

10616

10617

<code class="param-name">newVal</code>

10618

10619

<div class="param-description">The value the attribute is to be set to.</div>

10620

</li>

10621

10622

<code class="param-name">attrName</code>

10623

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

10624

<div class="param-description">The name of the attribute being set.</div>

10625

</li>

10626

10627

<code class="param-name">subAttrName</code>

10628

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

10629

<div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div>

10630

</li>

10631

</ul>

10632

</li>

10633

</ul>

10634

</div>

10635

</div>

10636

10637

10638

10639

</div>

10640

10641

10642

10643

10644

10645

<span class="type"><a href="../classes/Plugin.Host.html" class="crosslink">Plugin.Host</a></span>

10646

10647

10648

10649

10650

10651

10652

10653

10654

10655

10656

10657

10658

10659

<p>

10660

10661

Defined in

10662

10663

10664

10665

10666

<a href="../files/plugin_js_plugin.js.html#l31"><code>plugin/js/plugin.js:31</code></a>

10667

10668

</p>

10669

10670

10671

10672

10673

</div>

10674

10675

10676

<p>The plugin's host object.</p>

10677

</div>

10678

10679

10680

10681

10682

10683

<h4>Fires event <code>hostChange</code></h4>

10684

10685

<p>

10686

Fires when the value for the configuration attribute <code>host</code> is

10687

changed. You can listen for the event using the <code>on</code> method if you

10688

wish to be notified before the attribute's value has changed, or

10689

using the <code>after</code> method if you wish to be notified after the

10690

attribute's value has changed.

10691

</p>

10692

10693

10694

<h4>Parameters:</h4>

10695

10696

10697

10698

10699

<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>

10700

10701

10702

An Event Facade object with the following

10703

attribute-specific properties added:

10704

</div>

10705

10706

10707

10708

<code class="param-name">prevVal</code>

10709

10710

<div class="param-description">The value of the attribute, prior to it being set.</div>

10711

</li>

10712

10713

<code class="param-name">newVal</code>

10714

10715

<div class="param-description">The value the attribute is to be set to.</div>

10716

</li>

10717

10718

<code class="param-name">attrName</code>

10719

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

10720

<div class="param-description">The name of the attribute being set.</div>

10721

</li>

10722

10723

<code class="param-name">subAttrName</code>

10724

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

10725

<div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div>

10726

</li>

10727

</ul>

10728

</li>

10729

</ul>

10730

</div>

10731

</div>

10732

10733

10734

10735

</div>

10736

10737

10738

10739

10740

<h3 class="name"><code>initialized</code></h3>

10741

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>

10742

10743

10744

10745

10746

10747

10748

10749

10750

10751

10752

10753

10754

<p>Inherited from

10755

<a href="../classes/BaseCore.html#attr_initialized">BaseCore</a>:

10756

10757

10758

10759

<a href="../files/base_js_BaseCore.js.html#l143"><code>base/js/BaseCore.js:143</code></a>

10760

10761

</p>

10762

10763

10764

10765

10766

</div>

10767

10768

10769

<p>Flag indicating whether or not this object

10770

has been through the init lifecycle phase.</p>

10771

</div>

10772

10773

10774

<p><strong>Default:</strong> false</p>

10775

10776

10777

10778

10779

<h4>Fires event <code>initializedChange</code></h4>

10780

10781

<p>

10782

Fires when the value for the configuration attribute <code>initialized</code> is

10783

changed. You can listen for the event using the <code>on</code> method if you

10784

wish to be notified before the attribute's value has changed, or

10785

using the <code>after</code> method if you wish to be notified after the

10786

attribute's value has changed.

10787

</p>

10788

10789

10790

<h4>Parameters:</h4>

10791

10792

10793

10794

10795

<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>

10796

10797

10798

An Event Facade object with the following

10799

attribute-specific properties added:

10800

</div>

10801

10802

10803

10804

<code class="param-name">prevVal</code>

10805

10806

<div class="param-description">The value of the attribute, prior to it being set.</div>

10807

</li>

10808

10809

<code class="param-name">newVal</code>

10810

10811

<div class="param-description">The value the attribute is to be set to.</div>

10812

</li>

10813

10814

<code class="param-name">attrName</code>

10815

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

10816

<div class="param-description">The name of the attribute being set.</div>

10817

</li>

10818

10819

<code class="param-name">subAttrName</code>

10820

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

10821

<div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div>

10822

</li>

10823

</ul>

10824

</li>

10825

</ul>

10826

</div>

10827

</div>

10828

10829

10830

10831

</div>

10832

10833

10834

</div>

10835

10836

10837

10838

10839

<h2 class="off-left">Events</h2>

10840

10841

10842

10843

<h3 class="name"><code>destroy</code></h3>

10844

10845

10846

10847

10848

10849

10850

10851

10852

10853

10854

10855

10856

10857

<p>Inherited from

10858

<a href="../classes/Base.html#event_destroy">Base</a>:

10859

10860

10861

10862

10863

10864

</p>

10865

10866

10867

10868

10869

</div>

10870

10871

10872

<p>

10873

Lifecycle event for the destroy phase,

10874

fired prior to destruction. Invoking the preventDefault

10875

method on the event object provided to subscribers will

10876

prevent destruction from proceeding.

10877

</p>

10878

10879

<p>

10880

Subscribers to the "after" moment of this event, will be notified

10881

after destruction is complete (and as a result cannot prevent

10882

destruction).

10883

</p>

10884

</div>

10885

10886

10887

10888

<h4>Event Payload:</h4>

10889

10890

10891

10892

10893

10894

10895

<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>

10896

10897

10898

10899

10900

10901

<p>Event object</p>

10902

</div>

10903

10904

10905

</li>

10906

10907

</ul>

10908

</div>

10909

10910

10911

10912

10913

</div>

10914

10915

10916

10917

10918

10919

10920

10921

10922

10923

10924

10925

10926

10927

10928

10929

10930

10931

<p>Inherited from

10932

<a href="../classes/Base.html#event_init">Base</a>:

10933

10934

10935

10936

10937

10938

</p>

10939

10940

10941

10942

10943

</div>

10944

10945

10946

<p>

10947

Lifecycle event for the init phase, fired prior to initialization.

10948

Invoking the preventDefault() method on the event object provided

10949

to subscribers will prevent initialization from occuring.

10950

</p>

10951

10952

<p>

10953

Subscribers to the "after" momemt of this event, will be notified

10954

after initialization of the object is complete (and therefore

10955

cannot prevent initialization).

10956

</p>

10957

</div>

10958

10959

10960

10961

<h4>Event Payload:</h4>

10962

10963

10964

10965

10966

10967

10968

<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>

10969

10970

10971

10972

10973

10974

<p>Event object, with a cfg property which

10975

refers to the configuration object passed to the constructor.</p>

10976

</div>

10977

10978

10979

</li>

10980

10981

</ul>

10982

</div>

10983

10984

10985

10986

10987

</div>

10988

10989

10990

</div>

10991

10992

</div>

10993

</div>

10994

10995

</div>

10996

</div>

10997

</div>

10998

</div>

10999

</div>

11000

</div>

11001

11002

11003

11004

11005

11006

11007

11008

11009

</body>

11010

</html>

Older »