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

2017

2018

2019

2020

2021

2022

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

2023

</div>

2024

2025

2026

</li>

2027

2028

2029

2030

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

2031

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

2032

2033

2034

2035

2036

2037

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

2038

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

2039

</div>

2040

2041

2042

</li>

2043

2044

2045

2046

2047

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

2048

2049

2050

2051

2052

2053

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

2054

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

2055

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

2056

</div>

2057

2058

2059

</li>

2060

2061

</ul>

2062

</div>

2063

2064

2065

2066

2067

2068

</div>

2069

2070

2071

2072

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

2073

2074

2075

2076

2077

2078

2079

2080

2081

2082

</li>

2083

2084

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

2085

</div>

2086

2087

2088

2089

2090

2091

2092

2093

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

2094

2095

2096

2097

2098

2099

2100

2101

2102

2103

2104

2105

<p>Inherited from

2106

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

2107

2108

2109

2110

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

2111

2112

</p>

2113

2114

2115

2116

2117

2118

</div>

2119

2120

2121

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

2122

</div>

2123

2124

2125

2126

<h4>Parameters:</h4>

2127

2128

2129

2130

2131

2132

2133

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

2134

2135

2136

2137

2138

2139

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

2140

</div>

2141

2142

2143

</li>

2144

2145

</ul>

2146

</div>

2147

2148

2149

2150

2151

2152

</div>

2153

2154

2155

2156

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

2157

2158

2159

2160

2161

2162

2163

2164

<code>allAttrs</code>

2165

2166

</li>

2167

2168

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

2169

</div>

2170

2171

2172

2173

2174

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

2175

</span>

2176

2177

2178

2179

2180

2181

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

2182

2183

2184

2185

2186

2187

2188

2189

2190

2191

2192

2193

<p>Inherited from

2194

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

2195

2196

2197

2198

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

2199

2200

</p>

2201

2202

2203

2204

2205

2206

</div>

2207

2208

2209

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

2210

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

2211

2212

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

2213

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

2214

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

2215

</div>

2216

2217

2218

2219

<h4>Parameters:</h4>

2220

2221

2222

2223

2224

2225

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

2226

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

2227

2228

2229

2230

2231

2232

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

2233

(subclass first, Base last)</p>

2234

</div>

2235

2236

2237

</li>

2238

2239

</ul>

2240

</div>

2241

2242

2243

2244

2245

<h4>Returns:</h4>

2246

2247

2248

2249

2250

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

2251

2252

The aggregate set of ATTRS definitions for the instance

2253

2254

</div>

2255

</div>

2256

2257

2258

2259

</div>

2260

2261

2262

2263

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

2264

2265

2266

2267

2268

2269

2270

2271

2272

2273

2274

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

2275

2276

2277

2278

2279

2280

2281

2282

2283

2284

2285

<p>Inherited from

2286

2287

BaseCore

2288

</a>

2289

2290

but overwritten in

2291

2292

2293

2294

2295

2296

</p>

2297

2298

2299

2300

2301

2302

</div>

2303

2304

2305

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

2306

this class.</p>

2307

</div>

2308

2309

2310

2311

2312

2313

2314

</div>

2315

2316

2317

2318

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

2319

2320

2321

2322

2323

2324

2325

2326

2327

2328

2329

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

2330

2331

2332

2333

2334

2335

2336

2337

2338

2339

2340

2341

<p>Inherited from

2342

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

2343

2344

2345

2346

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

2347

2348

</p>

2349

2350

2351

2352

2353

2354

</div>

2355

2356

2357

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

2358

</div>

2359

2360

2361

2362

2363

2364

2365

</div>

2366

2367

2368

2369

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

2370

2371

2372

2373

2374

2375

2376

2377

2378

2379

2380

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

2381

2382

2383

2384

2385

2386

2387

2388

2389

2390

2391

2392

<p>Inherited from

2393

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

2394

2395

2396

2397

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

2398

2399

</p>

2400

2401

2402

2403

2404

2405

</div>

2406

2407

2408

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

2409

</div>

2410

2411

2412

2413

2414

2415

2416

</div>

2417

2418

2419

2420

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

2421

2422

2423

2424

2425

2426

2427

2428

2429

2430

</li>

2431

2432

2433

2434

<code>request</code>

2435

2436

</li>

2437

2438

2439

2440

<code>callback</code>

2441

2442

</li>

2443

2444

2445

2446

2447

2448

</li>

2449

2450

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

2451

</div>

2452

2453

2454

2455

2456

2457

2458

2459

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

2460

2461

2462

2463

2464

2465

2466

2467

2468

2469

2470

2471

2472

<p>

2473

2474

Defined in

2475

2476

2477

2478

2479

<a href="../files/datasource_js_datasource-xmlschema.js.html#l66"><code>datasource/js/datasource-xmlschema.js:66</code></a>

2480

2481

</p>

2482

2483

2484

2485

2486

2487

</div>

2488

2489

2490

<p>Parses raw data into a normalized response.</p>

2491

</div>

2492

2493

2494

2495

<h4>Parameters:</h4>

2496

2497

2498

2499

2500

2501

2502

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

2503

2504

2505

2506

2507

2508

<p>Unique transaction ID.</p>

2509

</div>

2510

2511

2512

</li>

2513

2514

2515

2516

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

2517

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

2518

2519

2520

2521

2522

2523

<p>The request.</p>

2524

</div>

2525

2526

2527

</li>

2528

2529

2530

2531

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

2532

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

2533

2534

2535

2536

2537

2538

<p>The callback object with the following properties:

2539

<dl>

2540

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

2541

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

2542

</dl></p>

2543

</div>

2544

2545

2546

</li>

2547

2548

2549

2550

2551

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

2552

2553

2554

2555

2556

2557

2558

</div>

2559

2560

2561

</li>

2562

2563

</ul>

2564

</div>

2565

2566

2567

2568

2569

2570

</div>

2571

2572

2573

2574

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

2575

2576

2577

2578

2579

2580

2581

2582

2583

2584

</li>

2585

2586

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

2587

</div>

2588

2589

2590

2591

2592

2593

2594

2595

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

2596

2597

2598

2599

2600

2601

2602

2603

2604

2605

2606

2607

<p>Inherited from

2608

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

2609

2610

2611

2612

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

2613

2614

</p>

2615

2616

2617

2618

2619

2620

</div>

2621

2622

2623

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

2624

</div>

2625

2626

2627

2628

<h4>Parameters:</h4>

2629

2630

2631

2632

2633

2634

2635

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

2636

2637

2638

2639

2640

2641

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

2642

</div>

2643

2644

2645

</li>

2646

2647

</ul>

2648

</div>

2649

2650

2651

2652

2653

2654

</div>

2655

2656

2657

2658

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

2659

2660

2661

2662

2663

2664

2665

2666

2667

2668

</li>

2669

2670

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

2671

</div>

2672

2673

2674

2675

2676

2677

2678

2679

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

2680

2681

2682

2683

2684

2685

2686

2687

2688

2689

2690

2691

<p>Inherited from

2692

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

2693

2694

2695

2696

2697

2698

</p>

2699

2700

2701

2702

2703

2704

</div>

2705

2706

2707

<p>Default destroy event handler</p>

2708

</div>

2709

2710

2711

2712

<h4>Parameters:</h4>

2713

2714

2715

2716

2717

2718

2719

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

2720

2721

2722

2723

2724

2725

<p>Event object</p>

2726

</div>

2727

2728

2729

</li>

2730

2731

</ul>

2732

</div>

2733

2734

2735

2736

2737

2738

</div>

2739

2740

2741

2742

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

2743

2744

2745

2746

2747

2748

2749

2750

2751

2752

</li>

2753

2754

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

2755

</div>

2756

2757

2758

2759

2760

2761

2762

2763

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

2764

2765

2766

2767

2768

2769

2770

2771

2772

2773

2774

2775

<p>Inherited from

2776

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

2777

2778

2779

2780

2781

2782

</p>

2783

2784

2785

2786

2787

2788

</div>

2789

2790

2791

<p>Default init event handler</p>

2792

</div>

2793

2794

2795

2796

<h4>Parameters:</h4>

2797

2798

2799

2800

2801

2802

2803

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

2804

2805

2806

2807

2808

2809

<p>Event object, with a cfg property which

2810

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

2811

</div>

2812

2813

2814

</li>

2815

2816

</ul>

2817

</div>

2818

2819

2820

2821

2822

2823

</div>

2824

2825

2826

2827

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

2828

2829

2830

2831

2832

2833

2834

2835

2836

2837

2838

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

2839

2840

2841

2842

2843

2844

2845

2846

2847

2848

2849

2850

<p>Inherited from

2851

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

2852

2853

2854

2855

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

2856

2857

</p>

2858

2859

2860

2861

2862

2863

</div>

2864

2865

2866

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

2867

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

2868

</div>

2869

2870

2871

2872

2873

2874

2875

</div>

2876

2877

2878

2879

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

2880

2881

2882

2883

2884

2885

2886

2887

<code>allAttrs</code>

2888

2889

</li>

2890

2891

2892

2893

<code>userVals</code>

2894

2895

</li>

2896

2897

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

2898

</div>

2899

2900

2901

2902

2903

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

2904

</span>

2905

2906

2907

2908

2909

2910

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

2911

2912

2913

2914

2915

2916

2917

2918

2919

2920

2921

2922

<p>Inherited from

2923

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

2924

2925

2926

2927

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

2928

2929

</p>

2930

2931

2932

2933

2934

2935

</div>

2936

2937

2938

2939

</div>

2940

2941

2942

2943

<h4>Parameters:</h4>

2944

2945

2946

2947

2948

2949

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

2950

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

2951

2952

2953

2954

2955

2956

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

2957

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

2958

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

2959

</div>

2960

2961

2962

</li>

2963

2964

2965

2966

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

2967

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

2968

2969

2970

2971

2972

2973

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

2974

</div>

2975

2976

2977

</li>

2978

2979

</ul>

2980

</div>

2981

2982

2983

2984

2985

<h4>Returns:</h4>

2986

2987

2988

2989

2990

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

2991

2992

The set of adhoc attributes passed in, in the form

2993

of an object with attribute name/configuration pairs.

2994

2995

</div>

2996

</div>

2997

2998

2999

3000

</div>

3001

3002

3003

3004

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

3005

3006

3007

3008

3009

3010

3011

3012

<code>clazz</code>

3013

3014

</li>

3015

3016

3017

3018

<code>allCfgs</code>

3019

3020

</li>

3021

3022

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

3023

</div>

3024

3025

3026

3027

3028

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

3029

</span>

3030

3031

3032

3033

3034

3035

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

3036

3037

3038

3039

3040

3041

3042

3043

3044

3045

3046

3047

<p>Inherited from

3048

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

3049

3050

3051

3052

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

3053

3054

</p>

3055

3056

3057

3058

3059

3060

</div>

3061

3062

3063

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

3064

initialization. Returns a disposable object with the attributes defined for

3065

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

3066

</div>

3067

3068

3069

3070

<h4>Parameters:</h4>

3071

3072

3073

3074

3075

3076

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

3077

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

3078

3079

3080

3081

3082

3083

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

3084

</div>

3085

3086

3087

</li>

3088

3089

3090

3091

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

3092

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

3093

3094

3095

3096

3097

3098

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

3099

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

3100

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

3101

</div>

3102

3103

3104

</li>

3105

3106

</ul>

3107

</div>

3108

3109

3110

3111

3112

<h4>Returns:</h4>

3113

3114

3115

3116

3117

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

3118

3119

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

3120

of an object with attribute name/configuration pairs.

3121

3122

</div>

3123

</div>

3124

3125

3126

3127

</div>

3128

3129

3130

3131

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

3132

3133

3134

3135

3136

3137

3138

3139

<code>attrName</code>

3140

3141

</li>

3142

3143

3144

3145

<code>subAttrName</code>

3146

3147

</li>

3148

3149

3150

3151

<code>currVal</code>

3152

3153

</li>

3154

3155

3156

3157

<code>newVal</code>

3158

3159

</li>

3160

3161

3162

3163

3164

3165

</li>

3166

3167

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

3168

</div>

3169

3170

3171

3172

3173

3174

3175

3176

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

3177

3178

3179

3180

3181

3182

3183

3184

3185

3186

3187

3188

<p>Inherited from

3189

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

3190

3191

3192

3193

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

3194

3195

</p>

3196

3197

3198

3199

3200

3201

</div>

3202

3203

3204

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

3205

</div>

3206

3207

3208

3209

<h4>Parameters:</h4>

3210

3211

3212

3213

3214

3215

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

3216

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

3217

3218

3219

3220

3221

3222

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

3223

</div>

3224

3225

3226

</li>

3227

3228

3229

3230

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

3231

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

3232

3233

3234

3235

3236

3237

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

3238

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

3239

</div>

3240

3241

3242

</li>

3243

3244

3245

3246

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

3247

3248

3249

3250

3251

3252

3253

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

3254

</div>

3255

3256

3257

</li>

3258

3259

3260

3261

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

3262

3263

3264

3265

3266

3267

3268

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

3269

</div>

3270

3271

3272

</li>

3273

3274

3275

3276

3277

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

3278

3279

3280

3281

3282

3283

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

3284

</div>

3285

3286

3287

</li>

3288

3289

</ul>

3290

</div>

3291

3292

3293

3294

3295

3296

</div>

3297

3298

3299

3300

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

3301

3302

3303

3304

3305

3306

3307

3308

3309

3310

</li>

3311

3312

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

3313

</div>

3314

3315

3316

3317

3318

3319

</span>

3320

3321

3322

3323

3324

3325

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

3326

3327

3328

3329

3330

3331

3332

3333

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

3334

3335

3336

3337

3338

3339

<p>Inherited from

3340

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

3341

3342

3343

3344

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

3345

3346

</p>

3347

3348

3349

3350

3351

3352

</div>

3353

3354

3355

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

3356

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

3357

3358

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

3359

</div>

3360

3361

3362

3363

<h4>Parameters:</h4>

3364

3365

3366

3367

3368

3369

3370

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

3371

3372

3373

3374

3375

3376

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

3377

</div>

3378

3379

3380

</li>

3381

3382

</ul>

3383

</div>

3384

3385

3386

3387

3388

<h4>Returns:</h4>

3389

3390

3391

3392

3393

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

3394

3395

The value of the attribute.

3396

3397

</div>

3398

</div>

3399

3400

3401

3402

</div>

3403

3404

3405

3406

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

3407

3408

3409

3410

3411

3412

3413

3414

3415

3416

</li>

3417

3418

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

3419

</div>

3420

3421

3422

3423

3424

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

3425

</span>

3426

3427

3428

3429

3430

3431

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

3432

3433

3434

3435

3436

3437

3438

3439

3440

3441

3442

3443

<p>Inherited from

3444

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

3445

3446

3447

3448

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

3449

3450

</p>

3451

3452

3453

3454

3455

3456

</div>

3457

3458

3459

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

3460

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

3461

configuration properties for all attributes.</p>

3462

</div>

3463

3464

3465

3466

<h4>Parameters:</h4>

3467

3468

3469

3470

3471

3472

3473

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

3474

3475

3476

3477

3478

3479

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

3480

</div>

3481

3482

3483

</li>

3484

3485

</ul>

3486

</div>

3487

3488

3489

3490

3491

<h4>Returns:</h4>

3492

3493

3494

3495

3496

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

3497

3498

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

3499

3500

</div>

3501

</div>

3502

3503

3504

3505

</div>

3506

3507

3508

3509

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

3510

3511

3512

3513

3514

3515

3516

3517

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

3518

</span>

3519

3520

3521

3522

3523

3524

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

3525

3526

3527

3528

3529

3530

3531

3532

3533

3534

3535

3536

<p>Inherited from

3537

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

3538

3539

3540

3541

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

3542

3543

</p>

3544

3545

3546

3547

3548

3549

</div>

3550

3551

3552

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

3553

the class hierarchy.</p>

3554

</div>

3555

3556

3557

3558

3559

3560

<h4>Returns:</h4>

3561

3562

3563

3564

3565

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

3566

3567

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

3568

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

3569

the cached value.

3570

3571

</div>

3572

</div>

3573

3574

3575

3576

</div>

3577

3578

3579

3580

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

3581

3582

3583

3584

3585

3586

3587

3588

3589

3590

</li>

3591

3592

3593

3594

3595

3596

</li>

3597

3598

3599

3600

<code>initValues</code>

3601

3602

</li>

3603

3604

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

3605

</div>

3606

3607

3608

3609

3610

3611

</span>

3612

3613

3614

3615

3616

3617

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

3618

3619

3620

3621

3622

3623

3624

3625

3626

3627

3628

<p>Inherited from

3629

3630

Attribute

3631

</a>

3632

3633

but overwritten in

3634

3635

3636

3637

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

3638

3639

</p>

3640

3641

3642

3643

3644

3645

</div>

3646

3647

3648

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

3649

either the default configuration provided, or the

3650

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

3651

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

3652

</div>

3653

3654

3655

3656

<h4>Parameters:</h4>

3657

3658

3659

3660

3661

3662

3663

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

3664

3665

3666

3667

3668

3669

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

3670

</div>

3671

3672

3673

</li>

3674

3675

3676

3677

3678

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

3679

3680

3681

3682

3683

3684

<p>The attribute configuration object</p>

3685

</div>

3686

3687

3688

</li>

3689

3690

3691

3692

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

3693

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

3694

3695

3696

3697

3698

3699

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

3700

</div>

3701

3702

3703

</li>

3704

3705

</ul>

3706

</div>

3707

3708

3709

3710

3711

<h4>Returns:</h4>

3712

3713

3714

3715

3716

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

3717

3718

The initial value of the attribute.

3719

3720

</div>

3721

</div>

3722

3723

3724

3725

</div>

3726

3727

3728

3729

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

3730

3731

3732

3733

3734

3735

3736

3737

<code>attrs</code>

3738

3739

</li>

3740

3741

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

3742

</div>

3743

3744

3745

3746

3747

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

3748

</span>

3749

3750

3751

3752

3753

3754

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

3755

3756

3757

3758

3759

3760

3761

3762

3763

3764

3765

3766

<p>Inherited from

3767

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

3768

3769

3770

3771

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

3772

3773

</p>

3774

3775

3776

3777

3778

3779

</div>

3780

3781

3782

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

3783

</div>

3784

3785

3786

3787

<h4>Parameters:</h4>

3788

3789

3790

3791

3792

3793

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

3794

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

3795

3796

3797

3798

3799

3800

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

3801

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

3802

</div>

3803

3804

3805

</li>

3806

3807

</ul>

3808

</div>

3809

3810

3811

3812

3813

<h4>Returns:</h4>

3814

3815

3816

3817

3818

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

3819

3820

An object with attribute name/value pairs.

3821

3822

</div>

3823

</div>

3824

3825

3826

3827

</div>

3828

3829

3830

3831

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

3832

3833

3834

3835

3836

3837

3838

3839

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

3840

</span>

3841

3842

3843

3844

3845

3846

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

3847

3848

3849

3850

3851

3852

3853

3854

3855

3856

3857

3858

<p>Inherited from

3859

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

3860

3861

3862

3863

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

3864

3865

</p>

3866

3867

3868

3869

3870

3871

</div>

3872

3873

3874

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

3875

</div>

3876

3877

3878

3879

3880

3881

<h4>Returns:</h4>

3882

3883

3884

3885

3886

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

3887

3888

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

3889

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

3890

cached value.

3891

3892

</div>

3893

</div>

3894

3895

3896

3897

</div>

3898

3899

3900

3901

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

3902

3903

3904

3905

3906

3907

3908

3909

3910

3911

</li>

3912

3913

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

3914

</div>

3915

3916

3917

3918

3919

3920

</span>

3921

3922

3923

3924

3925

3926

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

3927

3928

3929

3930

3931

3932

3933

3934

3935

3936

3937

3938

<p>Inherited from

3939

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

3940

3941

3942

3943

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

3944

3945

</p>

3946

3947

3948

3949

3950

3951

</div>

3952

3953

3954

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

3955

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

3956

</div>

3957

3958

3959

3960

<h4>Parameters:</h4>

3961

3962

3963

3964

3965

3966

3967

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

3968

3969

3970

3971

3972

3973

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

3974

</div>

3975

3976

3977

</li>

3978

3979

</ul>

3980

</div>

3981

3982

3983

3984

3985

<h4>Returns:</h4>

3986

3987

3988

3989

3990

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

3991

3992

The stored value of the attribute

3993

3994

</div>

3995

</div>

3996

3997

3998

3999

</div>

4000

4001

4002

4003

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

4004

4005

4006

4007

4008

4009

4010

4011

4012

4013

4014

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

4015

4016

4017

4018

4019

4020

4021

4022

4023

4024

4025

4026

<p>Inherited from

4027

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

4028

4029

4030

4031

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

4032

4033

</p>

4034

4035

4036

4037

4038

4039

</div>

4040

4041

4042

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

4043

event type is not prefixed, the instance prefix is

4044

applied to the supplied type.</p>

4045

</div>

4046

4047

4048

4049

4050

4051

4052

</div>

4053

4054

4055

4056

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

4057

4058

4059

4060

4061

4062

4063

4064

<code>attrs</code>

4065

4066

</li>

4067

4068

4069

4070

<code>values</code>

4071

4072

</li>

4073

4074

4075

4076

4077

4078

</li>

4079

4080

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

4081

</div>

4082

4083

4084

4085

4086

4087

4088

4089

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

4090

4091

4092

4093

4094

4095

4096

4097

4098

4099

4100

4101

<p>Inherited from

4102

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

4103

4104

4105

4106

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

4107

4108

</p>

4109

4110

4111

4112

4113

4114

</div>

4115

4116

4117

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

4118

constructor.</p>

4119

</div>

4120

4121

4122

4123

<h4>Parameters:</h4>

4124

4125

4126

4127

4128

4129

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

4130

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

4131

4132

4133

4134

4135

4136

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

4137

</div>

4138

4139

4140

</li>

4141

4142

4143

4144

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

4145

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

4146

4147

4148

4149

4150

4151

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

4152

</div>

4153

4154

4155

</li>

4156

4157

4158

4159

4160

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

4161

4162

4163

4164

4165

4166

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

4167

</div>

4168

4169

4170

</li>

4171

4172

</ul>

4173

</div>

4174

4175

4176

4177

4178

4179

</div>

4180

4181

4182

4183

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

4184

4185

4186

4187

4188

4189

4190

4191

4192

4193

4194

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

4195

4196

4197

4198

4199

4200

4201

4202

4203

4204

4205

<p>Inherited from

4206

4207

BaseCore

4208

</a>

4209

4210

but overwritten in

4211

4212

4213

4214

4215

4216

</p>

4217

4218

4219

4220

4221

4222

</div>

4223

4224

4225

<p>Initializes Attribute</p>

4226

</div>

4227

4228

4229

4230

4231

4232

4233

</div>

4234

4235

4236

4237

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

4238

4239

4240

4241

4242

4243

4244

4245

<code>attrs</code>

4246

4247

</li>

4248

4249

4250

4251

<code>values</code>

4252

4253

</li>

4254

4255

4256

4257

4258

4259

</li>

4260

4261

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

4262

</div>

4263

4264

4265

4266

4267

4268

4269

4270

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

4271

4272

4273

4274

4275

4276

4277

4278

4279

4280

4281

4282

<p>Inherited from

4283

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

4284

4285

4286

4287

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

4288

4289

</p>

4290

4291

4292

4293

4294

4295

</div>

4296

4297

4298

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

4299

</div>

4300

4301

4302

4303

<h4>Parameters:</h4>

4304

4305

4306

4307

4308

4309

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

4310

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

4311

4312

4313

4314

4315

4316

4317

</div>

4318

4319

4320

</li>

4321

4322

4323

4324

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

4325

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

4326

4327

4328

4329

4330

4331

4332

</div>

4333

4334

4335

</li>

4336

4337

4338

4339

4340

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

4341

4342

4343

4344

4345

4346

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

4347

</div>

4348

4349

4350

</li>

4351

4352

</ul>

4353

</div>

4354

4355

4356

4357

4358

4359

</div>

4360

4361

4362

4363

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

4364

4365

4366

4367

4368

4369

4370

4371

<code>config</code>

4372

4373

</li>

4374

4375

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

4376

</div>

4377

4378

4379

4380

4381

4382

4383

4384

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

4385

4386

4387

4388

4389

4390

4391

4392

4393

4394

4395

<p>Inherited from

4396

4397

BaseCore

4398

</a>

4399

4400

but overwritten in

4401

4402

4403

4404

4405

4406

</p>

4407

4408

4409

4410

4411

4412

</div>

4413

4414

4415

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

4416

</div>

4417

4418

4419

4420

<h4>Parameters:</h4>

4421

4422

4423

4424

4425

4426

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

4427

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

4428

4429

4430

4431

4432

4433

<p>The constructor configuration object</p>

4434

</div>

4435

4436

4437

</li>

4438

4439

</ul>

4440

</div>

4441

4442

4443

4444

4445

4446

</div>

4447

4448

4449

4450

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

4451

4452

4453

4454

4455

4456

4457

4458

<code>userVals</code>

4459

4460

</li>

4461

4462

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

4463

</div>

4464

4465

4466

4467

4468

4469

4470

4471

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

4472

4473

4474

4475

4476

4477

4478

4479

4480

4481

4482

4483

<p>Inherited from

4484

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

4485

4486

4487

4488

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

4489

4490

</p>

4491

4492

4493

4494

4495

4496

</div>

4497

4498

4499

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

4500

initializing attributes for each class defined in the class's

4501

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

4502

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

4503

</div>

4504

4505

4506

4507

<h4>Parameters:</h4>

4508

4509

4510

4511

4512

4513

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

4514

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

4515

4516

4517

4518

4519

4520

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

4521

</div>

4522

4523

4524

</li>

4525

4526

</ul>

4527

</div>

4528

4529

4530

4531

4532

4533

</div>

4534

4535

4536

4537

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

4538

4539

4540

4541

4542

4543

4544

4545

4546

4547

4548

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

4549

4550

4551

4552

4553

4554

4555

4556

4557

4558

4559

4560

<p>Inherited from

4561

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

4562

4563

4564

4565

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

4566

4567

</p>

4568

4569

4570

4571

4572

4573

</div>

4574

4575

4576

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

4577

the array of classes and aggregate set of attribute configurations

4578

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

4579

</div>

4580

4581

4582

4583

4584

4585

4586

</div>

4587

4588

4589

4590

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

4591

4592

4593

4594

4595

4596

4597

4598

4599

4600

</li>

4601

4602

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

4603

</div>

4604

4605

4606

4607

4608

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

4609

</span>

4610

4611

4612

4613

4614

4615

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

4616

4617

4618

4619

4620

4621

4622

4623

4624

4625

4626

4627

<p>Inherited from

4628

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

4629

4630

4631

4632

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

4633

4634

</p>

4635

4636

4637

4638

4639

4640

</div>

4641

4642

4643

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

4644

added lazily and still requires initialization.</p>

4645

</div>

4646

4647

4648

4649

<h4>Parameters:</h4>

4650

4651

4652

4653

4654

4655

4656

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

4657

4658

4659

4660

4661

4662

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

4663

</div>

4664

4665

4666

</li>

4667

4668

</ul>

4669

</div>

4670

4671

4672

4673

4674

<h4>Returns:</h4>

4675

4676

4677

4678

4679

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

4680

4681

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

4682

4683

</div>

4684

</div>

4685

4686

4687

4688

</div>

4689

4690

4691

4692

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

4693

4694

4695

4696

4697

4698

4699

4700

4701

4702

</li>

4703

4704

4705

4706

4707

4708

</li>

4709

4710

4711

4712

4713

4714

</li>

4715

4716

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

4717

</div>

4718

4719

4720

4721

4722

4723

4724

4725

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

4726

4727

4728

4729

4730

4731

4732

4733

4734

4735

4736

4737

<p>Inherited from

4738

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

4739

4740

4741

4742

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

4743

4744

</p>

4745

4746

4747

4748

4749

4750

</div>

4751

4752

4753

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

4754

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

4755

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

4756

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

4757

be subscribed to like other events to monitor the event

4758

system. Inividual published events can have monitoring

4759

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

4760

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

4761

</div>

4762

4763

4764

4765

<h4>Parameters:</h4>

4766

4767

4768

4769

4770

4771

4772

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

4773

4774

4775

4776

4777

4778

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

4779

</div>

4780

4781

4782

</li>

4783

4784

4785

4786

4787

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

4788

4789

4790

4791

4792

4793

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

4794

</div>

4795

4796

4797

</li>

4798

4799

4800

4801

4802

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

4803

4804

4805

4806

4807

4808

<p>Information about the event interaction, such as

4809

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

4810

</div>

4811

4812

4813

</li>

4814

4815

</ul>

4816

</div>

4817

4818

4819

4820

4821

4822

</div>

4823

4824

4825

4826

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

4827

4828

4829

4830

4831

4832

4833

4834

<code>valueHash</code>

4835

4836

</li>

4837

4838

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

4839

</div>

4840

4841

4842

4843

4844

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

4845

</span>

4846

4847

4848

4849

4850

4851

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

4852

4853

4854

4855

4856

4857

4858

4859

4860

4861

4862

<p>Inherited from

4863

4864

Attribute

4865

</a>

4866

4867

but overwritten in

4868

4869

4870

4871

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

4872

4873

</p>

4874

4875

4876

4877

4878

4879

</div>

4880

4881

4882

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

4883

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

4884

</div>

4885

4886

4887

4888

<h4>Parameters:</h4>

4889

4890

4891

4892

4893

4894

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

4895

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

4896

4897

4898

4899

4900

4901

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

4902

</div>

4903

4904

4905

</li>

4906

4907

</ul>

4908

</div>

4909

4910

4911

4912

4913

<h4>Returns:</h4>

4914

4915

4916

4917

4918

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

4919

4920

4921

</div>

4922

</div>

4923

4924

4925

4926

</div>

4927

4928

4929

4930

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

4931

4932

4933

4934

4935

4936

4937

4938

4939

4940

4941

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

4942

4943

4944

4945

4946

4947

4948

4949

4950

4951

4952

4953

<p>Inherited from

4954

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

4955

4956

4957

4958

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

4959

4960

</p>

4961

4962

4963

4964

4965

4966

</div>

4967

4968

4969

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

4970

and the prefixed event name from _getType

4971

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

4972

</div>

4973

4974

4975

4976

4977

4978

4979

</div>

4980

4981

4982

4983

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

4984

4985

4986

4987

4988

4989

4990

4991

<code>config</code>

4992

4993

</li>

4994

4995

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

4996

</div>

4997

4998

4999

5000

5001

5002

5003

5004

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

5005

5006

5007

5008

5009

5010

5011

5012

5013

5014

5015

5016

<p>Inherited from

5017

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

5018

5019

5020

5021

5022

5023

</p>

5024

5025

5026

5027

5028

5029

</div>

5030

5031

5032

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

5033

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

5034

construction, prior to init.</p>

5035

</div>

5036

5037

5038

5039

<h4>Parameters:</h4>

5040

5041

5042

5043

5044

5045

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

5046

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

5047

5048

5049

5050

5051

5052

<p>The user configuration object</p>

5053

</div>

5054

5055

5056

</li>

5057

5058

</ul>

5059

</div>

5060

5061

5062

5063

5064

5065

</div>

5066

5067

5068

5069

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

5070

5071

5072

5073

5074

5075

5076

5077

<code>attrs</code>

5078

5079

</li>

5080

5081

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

5082

</div>

5083

5084

5085

5086

5087

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

5088

</span>

5089

5090

5091

5092

5093

5094

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

5095

5096

5097

5098

5099

5100

5101

5102

5103

5104

5105

5106

<p>Inherited from

5107

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

5108

5109

5110

5111

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

5112

5113

</p>

5114

5115

5116

5117

5118

5119

</div>

5120

5121

5122

<p>Utility method to protect an attribute configuration

5123

hash, by merging the entire object and the individual

5124

attr config objects.</p>

5125

</div>

5126

5127

5128

5129

<h4>Parameters:</h4>

5130

5131

5132

5133

5134

5135

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

5136

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

5137

5138

5139

5140

5141

5142

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

5143

</div>

5144

5145

5146

</li>

5147

5148

</ul>

5149

</div>

5150

5151

5152

5153

5154

<h4>Returns:</h4>

5155

5156

5157

5158

5159

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

5160

5161

A protected version of the attrs argument.

5162

5163

</div>

5164

</div>

5165

5166

5167

5168

</div>

5169

5170

5171

5172

5173

5174

5175

5176

5177

5178

5179

5180

5181

5182

</li>

5183

5184

5185

5186

5187

5188

</li>

5189

5190

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

5191

</div>

5192

5193

5194

5195

5196

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

5197

</span>

5198

5199

5200

5201

5202

5203

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

5204

5205

5206

5207

5208

5209

5210

5211

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

5212

5213

5214

5215

5216

<p>Inherited from

5217

5218

AttributeEvents

5219

</a>

5220

5221

but overwritten in

5222

5223

5224

5225

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

5226

5227

</p>

5228

5229

5230

5231

5232

5233

</div>

5234

5235

5236

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

5237

</div>

5238

5239

5240

5241

<h4>Parameters:</h4>

5242

5243

5244

5245

5246

5247

5248

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

5249

5250

5251

5252

5253

5254

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

5255

</div>

5256

5257

5258

</li>

5259

5260

5261

5262

5263

5264

5265

5266

5267

5268

5269

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

5270

</div>

5271

5272

5273

</li>

5274

5275

</ul>

5276

</div>

5277

5278

5279

5280

5281

<h4>Returns:</h4>

5282

5283

5284

5285

5286

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

5287

5288

A reference to the host object.

5289

5290

</div>

5291

</div>

5292

5293

5294

5295

</div>

5296

5297

5298

5299

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

5300

5301

5302

5303

5304

5305

5306

5307

5308

5309

</li>

5310

5311

5312

5313

<code>value</code>

5314

5315

</li>

5316

5317

5318

5319

5320

5321

</li>

5322

5323

5324

5325

<code>force</code>

5326

5327

</li>

5328

5329

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

5330

</div>

5331

5332

5333

5334

5335

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

5336

</span>

5337

5338

5339

5340

5341

5342

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

5343

5344

5345

5346

5347

5348

5349

5350

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

5351

5352

5353

5354

5355

5356

<p>Inherited from

5357

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

5358

5359

5360

5361

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

5362

5363

</p>

5364

5365

5366

5367

5368

5369

</div>

5370

5371

5372

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

5373

5374

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

5375

</div>

5376

5377

5378

5379

<h4>Parameters:</h4>

5380

5381

5382

5383

5384

5385

5386

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

5387

5388

5389

5390

5391

5392

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

5393

</div>

5394

5395

5396

</li>

5397

5398

5399

5400

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

5401

5402

5403

5404

5405

5406

5407

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

5408

</div>

5409

5410

5411

</li>

5412

5413

5414

5415

5416

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

5417

5418

5419

5420

5421

5422

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

5423

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

5424

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

5425

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

5426

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

5427

</div>

5428

5429

5430

</li>

5431

5432

5433

5434

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

5435

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

5436

5437

5438

5439

5440

5441

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

5442

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

5443

</div>

5444

5445

5446

</li>

5447

5448

</ul>

5449

</div>

5450

5451

5452

5453

5454

<h4>Returns:</h4>

5455

5456

5457

5458

5459

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

5460

5461

A reference to the host object.

5462

5463

</div>

5464

</div>

5465

5466

5467

5468

</div>

5469

5470

5471

5472

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

5473

5474

5475

5476

5477

5478

5479

5480

<code>attrs</code>

5481

5482

</li>

5483

5484

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

5485

</div>

5486

5487

5488

5489

5490

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

5491

</span>

5492

5493

5494

5495

5496

5497

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

5498

5499

5500

5501

5502

5503

5504

5505

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

5506

5507

5508

5509

5510

5511

<p>Inherited from

5512

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

5513

5514

5515

5516

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

5517

5518

</p>

5519

5520

5521

5522

5523

5524

</div>

5525

5526

5527

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

5528

</div>

5529

5530

5531

5532

<h4>Parameters:</h4>

5533

5534

5535

5536

5537

5538

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

5539

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

5540

5541

5542

5543

5544

5545

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

5546

</div>

5547

5548

5549

</li>

5550

5551

</ul>

5552

</div>

5553

5554

5555

5556

5557

<h4>Returns:</h4>

5558

5559

5560

5561

5562

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

5563

5564

A reference to the host object.

5565

5566

</div>

5567

</div>

5568

5569

5570

5571

</div>

5572

5573

5574

5575

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

5576

5577

5578

5579

5580

5581

5582

5583

<code>attrName</code>

5584

5585

</li>

5586

5587

5588

5589

<code>subAttrName</code>

5590

5591

</li>

5592

5593

5594

5595

<code>prevVal</code>

5596

5597

</li>

5598

5599

5600

5601

<code>newVal</code>

5602

5603

</li>

5604

5605

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

5606

</div>

5607

5608

5609

5610

5611

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

5612

</span>

5613

5614

5615

5616

5617

5618

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

5619

5620

5621

5622

5623

5624

5625

5626

5627

5628

5629

5630

<p>Inherited from

5631

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

5632

5633

5634

5635

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

5636

5637

</p>

5638

5639

5640

5641

5642

5643

</div>

5644

5645

5646

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

5647

if validation and setter passes.</p>

5648

</div>

5649

5650

5651

5652

<h4>Parameters:</h4>

5653

5654

5655

5656

5657

5658

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

5659

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

5660

5661

5662

5663

5664

5665

<p>The attribute name.</p>

5666

</div>

5667

5668

5669

</li>

5670

5671

5672

5673

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

5674

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

5675

5676

5677

5678

5679

5680

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

5681

</div>

5682

5683

5684

</li>

5685

5686

5687

5688

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

5689

5690

5691

5692

5693

5694

5695

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

5696

</div>

5697

5698

5699

</li>

5700

5701

5702

5703

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

5704

5705

5706

5707

5708

5709

5710

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

5711

</div>

5712

5713

5714

</li>

5715

5716

</ul>

5717

</div>

5718

5719

5720

5721

5722

<h4>Returns:</h4>

5723

5724

5725

5726

5727

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

5728

5729

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

5730

5731

</div>

5732

</div>

5733

5734

5735

5736

</div>

5737

5738

5739

5740

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

5741

5742

5743

5744

5745

5746

5747

5748

5749

5750

</li>

5751

5752

5753

5754

<code>value</code>

5755

5756

</li>

5757

5758

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

5759

</div>

5760

5761

5762

5763

5764

5765

5766

5767

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

5768

5769

5770

5771

5772

5773

5774

5775

5776

5777

5778

5779

<p>Inherited from

5780

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

5781

5782

5783

5784

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

5785

5786

</p>

5787

5788

5789

5790

5791

5792

</div>

5793

5794

5795

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

5796

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

5797

</div>

5798

5799

5800

5801

<h4>Parameters:</h4>

5802

5803

5804

5805

5806

5807

5808

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

5809

5810

5811

5812

5813

5814

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

5815

</div>

5816

5817

5818

</li>

5819

5820

5821

5822

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

5823

5824

5825

5826

5827

5828

5829

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

5830

</div>

5831

5832

5833

</li>

5834

5835

</ul>

5836

</div>

5837

5838

5839

5840

5841

5842

</div>

5843

5844

5845

5846

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

5847

5848

5849

5850

5851

5852

5853

5854

5855

5856

</li>

5857

5858

5859

5860

<code>config</code>

5861

5862

</li>

5863

5864

5865

5866

5867

5868

</li>

5869

5870

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

5871

</div>

5872

5873

5874

5875

5876

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

5877

</span>

5878

5879

5880

5881

5882

5883

5884

5885

5886

5887

5888

5889

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

5890

5891

5892

5893

5894

5895

<p>Inherited from

5896

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

5897

5898

5899

5900

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

5901

5902

</p>

5903

5904

5905

5906

5907

5908

</div>

5909

5910

5911

<p>

5912

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

5913

</p>

5914

5915

<p>

5916

The config argument object supports the following properties:

5917

</p>

5918

5919

<dl>

5920

<dt>value <Any></dt>

5921

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

5922

5923

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

5924

<dd>

5925

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

5926

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

5927

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

5928

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

5929

case the value property is used.</p>

5930

5931

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

5932

</dd>

5933

5934

<dt>readOnly <boolean></dt>

5935

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

5936

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

5937

5938

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

5939

<dd>

5940

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

5941

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

5942

constructor configuration arguments, or by invoking set.

5943

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

5944

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

5945

</dd>

5946

5947

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

5948

<dd>

5949

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

5950

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

5951

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

5952

the value from being stored.

5953

</p>

5954

5955

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

5956

</dd>

5957

5958

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

5959

<dd>

5960

<p>

5961

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

5962

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

5963

invoke get.

5964

</p>

5965

5966

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

5967

</dd>

5968

5969

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

5970

<dd>

5971

<p>

5972

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

5973

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

5974

</p>

5975

5976

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

5977

</dd>

5978

5979

<dt>lazyAdd <boolean></dt>

5980

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

5981

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

5982

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

5983

5984

</dl>

5985

5986

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

5987

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

5988

5989

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

5990

and are not intended for public use.</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/String" class="crosslink external" target="_blank">String</a></span>

6003

6004

6005

6006

6007

6008

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

6009

</div>

6010

6011

6012

</li>

6013

6014

6015

6016

<code class="param-name">config</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 configuration property/value pairs, specifying the configuration for the attribute.</p>

6024

6025

<p>

6026

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

6027

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

6028

</p>

6029

</div>

6030

6031

6032

</li>

6033

6034

6035

6036

6037

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

6038

6039

6040

6041

6042

6043

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

6044

</div>

6045

6046

6047

</li>

6048

6049

</ul>

6050

</div>

6051

6052

6053

6054

6055

<h4>Returns:</h4>

6056

6057

6058

6059

6060

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

6061

6062

A reference to the host object.

6063

6064

</div>

6065

</div>

6066

6067

6068

6069

</div>

6070

6071

6072

6073

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

6074

6075

6076

6077

6078

6079

6080

6081

6082

6083

</li>

6084

6085

6086

6087

<code>values</code>

6088

6089

</li>

6090

6091

6092

6093

6094

6095

</li>

6096

6097

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

6098

</div>

6099

6100

6101

6102

6103

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

6104

</span>

6105

6106

6107

6108

6109

6110

6111

6112

6113

6114

6115

6116

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

6117

6118

6119

6120

6121

6122

<p>Inherited from

6123

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

6124

6125

6126

6127

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

6128

6129

</p>

6130

6131

6132

6133

6134

6135

</div>

6136

6137

6138

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

6139

6140

<p>

6141

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

6142

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

6143

</p>

6144

</div>

6145

6146

6147

6148

<h4>Parameters:</h4>

6149

6150

6151

6152

6153

6154

6155

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

6156

6157

6158

6159

6160

6161

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

6162

</div>

6163

6164

6165

</li>

6166

6167

6168

6169

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

6170

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

6171

6172

6173

6174

6175

6176

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

6177

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

6178

</div>

6179

6180

6181

</li>

6182

6183

6184

6185

6186

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

6187

6188

6189

6190

6191

6192

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

6193

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

6194

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

6195

</div>

6196

6197

6198

</li>

6199

6200

</ul>

6201

</div>

6202

6203

6204

6205

6206

<h4>Returns:</h4>

6207

6208

6209

6210

6211

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

6212

6213

A reference to the host object.

6214

6215

</div>

6216

</div>

6217

6218

6219

6220

</div>

6221

6222

6223

6224

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

6225

6226

6227

6228

6229

6230

6231

6232

6233

6234

</li>

6235

6236

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

6237

</div>

6238

6239

6240

6241

6242

6243

6244

6245

6246

6247

6248

6249

6250

6251

6252

6253

6254

6255

<p>Inherited from

6256

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

6257

6258

6259

6260

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

6261

6262

</p>

6263

6264

6265

6266

6267

6268

</div>

6269

6270

6271

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

6272

is determined by the order registered. Multiple targets can

6273

be specified.</p>

6274

6275

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

6276

6277

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

6278

</div>

6279

6280

6281

6282

<h4>Parameters:</h4>

6283

6284

6285

6286

6287

6288

6289

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

6290

6291

6292

6293

6294

6295

<p>the target to add</p>

6296

</div>

6297

6298

6299

</li>

6300

6301

</ul>

6302

</div>

6303

6304

6305

6306

6307

6308

</div>

6309

6310

6311

6312

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

6313

6314

6315

6316

6317

6318

6319

6320

6321

6322

</li>

6323

6324

6325

6326

6327

6328

</li>

6329

6330

6331

6332

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

6333

6334

</li>

6335

6336

6337

6338

6339

6340

</li>

6341

6342

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

6343

</div>

6344

6345

6346

6347

6348

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

6349

</span>

6350

6351

6352

6353

6354

6355

6356

6357

6358

6359

6360

6361

6362

6363

6364

6365

<p>Inherited from

6366

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

6367

6368

6369

6370

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

6371

6372

</p>

6373

6374

6375

6376

6377

6378

</div>

6379

6380

6381

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

6382

supplied callback will execute after any listeners add

6383

via the subscribe method, and after the default function,

6384

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

6385

</div>

6386

6387

6388

6389

<h4>Parameters:</h4>

6390

6391

6392

6393

6394

6395

6396

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

6397

6398

6399

6400

6401

6402

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

6403

</div>

6404

6405

6406

</li>

6407

6408

6409

6410

6411

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

6412

6413

6414

6415

6416

6417

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

6418

</div>

6419

6420

6421

</li>

6422

6423

6424

6425

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

6426

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

6427

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

6428

6429

6430

6431

6432

6433

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

6434

</div>

6435

6436

6437

</li>

6438

6439

6440

6441

6442

6443

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

6444

6445

6446

6447

6448

6449

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

6450

</div>

6451

6452

6453

</li>

6454

6455

</ul>

6456

</div>

6457

6458

6459

6460

6461

<h4>Returns:</h4>

6462

6463

6464

6465

6466

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

6467

6468

A subscription handle capable of detaching the

6469

subscription

6470

6471

</div>

6472

</div>

6473

6474

6475

6476

</div>

6477

6478

6479

6480

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

6481

6482

6483

6484

6485

6486

6487

6488

6489

6490

</li>

6491

6492

6493

6494

6495

6496

</li>

6497

6498

6499

6500

<code>context</code>

6501

6502

</li>

6503

6504

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

6505

</div>

6506

6507

6508

6509

6510

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

6511

</span>

6512

6513

6514

6515

6516

6517

6518

6519

6520

6521

6522

6523

6524

6525

6526

6527

<p>Inherited from

6528

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

6529

6530

6531

6532

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

6533

6534

</p>

6535

6536

6537

6538

6539

6540

</div>

6541

6542

6543

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

6544

6545

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

6546

</div>

6547

6548

6549

6550

<h4>Parameters:</h4>

6551

6552

6553

6554

6555

6556

6557

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

6558

6559

6560

6561

6562

6563

<p>The event type.</p>

6564

</div>

6565

6566

6567

</li>

6568

6569

6570

6571

6572

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

6573

6574

6575

6576

6577

6578

<p>The listener.</p>

6579

</div>

6580

6581

6582

</li>

6583

6584

6585

6586

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

6587

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

6588

6589

6590

6591

6592

6593

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

6594

</div>

6595

6596

6597

</li>

6598

6599

</ul>

6600

</div>

6601

6602

6603

6604

6605

<h4>Returns:</h4>

6606

6607

6608

6609

6610

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

6611

6612

handle The detach handle for the listener.

6613

6614

</div>

6615

</div>

6616

6617

6618

6619

</div>

6620

6621

6622

6623

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

6624

6625

6626

6627

6628

6629

6630

6631

<code>method</code>

6632

6633

</li>

6634

6635

6636

6637

6638

6639

</li>

6640

6641

6642

6643

<code>context</code>

6644

6645

</li>

6646

6647

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

6648

</div>

6649

6650

6651

6652

6653

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

6654

</span>

6655

6656

6657

6658

6659

6660

6661

6662

6663

6664

6665

6666

6667

6668

6669

6670

<p>Inherited from

6671

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

6672

6673

6674

6675

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

6676

6677

</p>

6678

6679

6680

6681

6682

6683

</div>

6684

6685

6686

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

6687

6688

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

6689

</div>

6690

6691

6692

6693

<h4>Parameters:</h4>

6694

6695

6696

6697

6698

6699

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

6700

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

6701

6702

6703

6704

6705

6706

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

6707

</div>

6708

6709

6710

</li>

6711

6712

6713

6714

6715

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

6716

6717

6718

6719

6720

6721

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

6722

</div>

6723

6724

6725

</li>

6726

6727

6728

6729

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

6730

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

6731

6732

6733

6734

6735

6736

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

6737

</div>

6738

6739

6740

</li>

6741

6742

</ul>

6743

</div>

6744

6745

6746

6747

6748

<h4>Returns:</h4>

6749

6750

6751

6752

6753

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

6754

6755

handle The detach handle for the injected function.

6756

6757

</div>

6758

</div>

6759

6760

6761

6762

</div>

6763

6764

6765

6766

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

6767

6768

6769

6770

6771

6772

6773

6774

6775

6776

</li>

6777

6778

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

6779

</div>

6780

6781

6782

6783

6784

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

6785

</span>

6786

6787

6788

6789

6790

6791

6792

6793

6794

6795

6796

6797

6798

6799

6800

6801

<p>Inherited from

6802

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

6803

6804

6805

6806

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

6807

6808

</p>

6809

6810

6811

6812

6813

6814

</div>

6815

6816

6817

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

6818

</div>

6819

6820

6821

6822

<h4>Parameters:</h4>

6823

6824

6825

6826

6827

6828

6829

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

6830

6831

6832

6833

6834

6835

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

6836

</div>

6837

6838

6839

</li>

6840

6841

</ul>

6842

</div>

6843

6844

6845

6846

6847

<h4>Returns:</h4>

6848

6849

6850

6851

6852

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

6853

6854

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.

6855

6856

</div>

6857

</div>

6858

6859

6860

6861

</div>

6862

6863

6864

6865

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

6866

6867

6868

6869

6870

6871

6872

6873

6874

</span>

6875

6876

6877

6878

6879

6880

6881

6882

6883

6884

6885

6886

6887

6888

6889

6890

<p>Inherited from

6891

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

6892

6893

6894

6895

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

6896

6897

</p>

6898

6899

6900

6901

6902

6903

</div>

6904

6905

6906

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

6907

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

6908

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

6909

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

6910

6911

<p>For DOM and custom events:

6912

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

6913

6914

<p>For methods:

6915

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

6916

</div>

6917

6918

6919

6920

6921

6922

<h4>Returns:</h4>

6923

6924

6925

6926

6927

detach handle

6928

6929

</div>

6930

</div>

6931

6932

6933

6934

</div>

6935

6936

6937

6938

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

6939

6940

6941

6942

6943

6944

6945

6946

<code>method</code>

6947

6948

</li>

6949

6950

6951

6952

6953

6954

</li>

6955

6956

6957

6958

<code>context</code>

6959

6960

</li>

6961

6962

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

6963

</div>

6964

6965

6966

6967

6968

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

6969

</span>

6970

6971

6972

6973

6974

6975

6976

6977

6978

6979

6980

6981

6982

6983

6984

6985

<p>Inherited from

6986

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

6987

6988

6989

6990

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

6991

6992

</p>

6993

6994

6995

6996

6997

6998

</div>

6999

7000

7001

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

7002

7003

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

7004

</div>

7005

7006

7007

7008

<h4>Parameters:</h4>

7009

7010

7011

7012

7013

7014

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

7015

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

7016

7017

7018

7019

7020

7021

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

7022

</div>

7023

7024

7025

</li>

7026

7027

7028

7029

7030

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

7031

7032

7033

7034

7035

7036

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

7037

</div>

7038

7039

7040

</li>

7041

7042

7043

7044

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

7045

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

7046

7047

7048

7049

7050

7051

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

7052

</div>

7053

7054

7055

</li>

7056

7057

</ul>

7058

</div>

7059

7060

7061

7062

7063

<h4>Returns:</h4>

7064

7065

7066

7067

7068

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

7069

7070

handle The detach handle for the injected function.

7071

7072

</div>

7073

</div>

7074

7075

7076

7077

</div>

7078

7079

7080

7081

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

7082

7083

7084

7085

7086

7087

7088

7089

7090

7091

</li>

7092

7093

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

7094

</div>

7095

7096

7097

7098

7099

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

7100

</span>

7101

7102

7103

7104

7105

7106

7107

7108

7109

7110

7111

7112

7113

7114

7115

7116

<p>Inherited from

7117

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

7118

7119

7120

7121

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

7122

7123

</p>

7124

7125

7126

7127

7128

7129

</div>

7130

7131

7132

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

7133

</div>

7134

7135

7136

7137

<h4>Parameters:</h4>

7138

7139

7140

7141

7142

7143

7144

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

7145

7146

7147

7148

7149

7150

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

7151

</div>

7152

7153

7154

</li>

7155

7156

</ul>

7157

</div>

7158

7159

7160

7161

7162

<h4>Returns:</h4>

7163

7164

7165

7166

7167

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

7168

7169

the aggregated return value from Event.Custom.fire

7170

7171

</div>

7172

</div>

7173

7174

7175

7176

</div>

7177

7178

7179

7180

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

7181

7182

7183

7184

7185

7186

7187

7188

7189

</span>

7190

7191

7192

7193

7194

7195

7196

7197

7198

7199

7200

7201

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

7202

7203

7204

7205

7206

<p>Inherited from

7207

7208

BaseCore

7209

</a>

7210

7211

but overwritten in

7212

7213

7214

7215

7216

7217

</p>

7218

7219

7220

7221

7222

7223

</div>

7224

7225

7226

<p>

7227

Destroy lifecycle method. Fires the destroy

7228

event, prior to invoking destructors for the

7229

class hierarchy.

7230

</p>

7231

7232

<p>

7233

Subscribers to the destroy

7234

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

7235

from proceeding.

7236

</p>

7237

</div>

7238

7239

7240

7241

7242

7243

<h4>Returns:</h4>

7244

7245

7246

7247

7248

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

7249

7250

A reference to this object

7251

7252

</div>

7253

</div>

7254

7255

7256

7257

</div>

7258

7259

7260

7261

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

7262

7263

7264

7265

7266

7267

7268

7269

7270

7271

7272

7273

7274

7275

7276

7277

7278

7279

7280

7281

7282

<p>Inherited from

7283

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

7284

7285

7286

7287

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

7288

7289

</p>

7290

7291

7292

7293

7294

7295

</div>

7296

7297

7298

<p>Destructor lifecycle implementation.</p>

7299

7300

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

7301

</div>

7302

7303

7304

7305

7306

7307

7308

</div>

7309

7310

7311

7312

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

7313

7314

7315

7316

7317

7318

7319

7320

7321

7322

</li>

7323

7324

7325

7326

7327

7328

</li>

7329

7330

7331

7332

<code>context</code>

7333

7334

</li>

7335

7336

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

7337

</div>

7338

7339

7340

7341

7342

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

7343

</span>

7344

7345

7346

7347

7348

7349

7350

7351

7352

7353

7354

7355

7356

7357

7358

7359

<p>Inherited from

7360

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

7361

7362

7363

7364

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

7365

7366

</p>

7367

7368

7369

7370

7371

7372

</div>

7373

7374

7375

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

7376

</div>

7377

7378

7379

7380

<h4>Parameters:</h4>

7381

7382

7383

7384

7385

7386

7387

7388

7389

7390

7391

7392

7393

<p>Either the handle to the subscriber or the

7394

type of event. If the type

7395

is not specified, it will attempt to remove

7396

the listener from all hosted events.</p>

7397

</div>

7398

7399

7400

</li>

7401

7402

7403

7404

7405

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

7406

7407

7408

7409

7410

7411

<p>The subscribed function to unsubscribe, if not

7412

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

7413

</div>

7414

7415

7416

</li>

7417

7418

7419

7420

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

7421

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

7422

7423

7424

7425

7426

7427

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

7428

optional, but if supplied will be used to

7429

disambiguate multiple listeners that are the same

7430

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

7431

that lives on the prototype)</p>

7432

</div>

7433

7434

7435

</li>

7436

7437

</ul>

7438

</div>

7439

7440

7441

7442

7443

<h4>Returns:</h4>

7444

7445

7446

7447

7448

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

7449

7450

the host

7451

7452

</div>

7453

</div>

7454

7455

7456

7457

</div>

7458

7459

7460

7461

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

7462

7463

7464

7465

7466

7467

7468

7469

7470

7471

</li>

7472

7473

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

7474

</div>

7475

7476

7477

7478

7479

7480

7481

7482

7483

7484

7485

7486

7487

7488

7489

7490

7491

7492

<p>Inherited from

7493

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

7494

7495

7496

7497

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

7498

7499

</p>

7500

7501

7502

7503

7504

7505

</div>

7506

7507

7508

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

7509

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

7510

be removed.</p>

7511

</div>

7512

7513

7514

7515

<h4>Parameters:</h4>

7516

7517

7518

7519

7520

7521

7522

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

7523

7524

7525

7526

7527

7528

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

7529

</div>

7530

7531

7532

</li>

7533

7534

</ul>

7535

</div>

7536

7537

7538

7539

7540

7541

</div>

7542

7543

7544

7545

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

7546

7547

7548

7549

7550

7551

7552

7553

<code>strMethod</code>

7554

7555

</li>

7556

7557

7558

7559

7560

7561

</li>

7562

7563

7564

7565

<code>context</code>

7566

7567

</li>

7568

7569

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

7570

</div>

7571

7572

7573

7574

7575

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

7576

</span>

7577

7578

7579

7580

7581

7582

7583

7584

7585

7586

7587

7588

7589

7590

7591

7592

<p>Inherited from

7593

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

7594

7595

7596

7597

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

7598

7599

</p>

7600

7601

7602

7603

7604

7605

</div>

7606

7607

7608

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

7609

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

7610

</div>

7611

7612

7613

7614

<h4>Parameters:</h4>

7615

7616

7617

7618

7619

7620

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

7621

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

7622

7623

7624

7625

7626

7627

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

7628

</div>

7629

7630

7631

</li>

7632

7633

7634

7635

7636

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

7637

7638

7639

7640

7641

7642

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

7643

</div>

7644

7645

7646

</li>

7647

7648

7649

7650

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

7651

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

7652

7653

7654

7655

7656

7657

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

7658

</div>

7659

7660

7661

</li>

7662

7663

</ul>

7664

</div>

7665

7666

7667

7668

7669

<h4>Returns:</h4>

7670

7671

7672

7673

7674

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

7675

7676

handle The detach handle for the listener.

7677

7678

</div>

7679

</div>

7680

7681

7682

7683

</div>

7684

7685

7686

7687

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

7688

7689

7690

7691

7692

7693

7694

7695

<code>strMethod</code>

7696

7697

</li>

7698

7699

7700

7701

7702

7703

</li>

7704

7705

7706

7707

<code>context</code>

7708

7709

</li>

7710

7711

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

7712

</div>

7713

7714

7715

7716

7717

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

7718

</span>

7719

7720

7721

7722

7723

7724

7725

7726

7727

7728

7729

7730

7731

7732

7733

7734

<p>Inherited from

7735

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

7736

7737

7738

7739

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

7740

7741

</p>

7742

7743

7744

7745

7746

7747

</div>

7748

7749

7750

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

7751

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

7752

</div>

7753

7754

7755

7756

<h4>Parameters:</h4>

7757

7758

7759

7760

7761

7762

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

7763

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

7764

7765

7766

7767

7768

7769

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

7770

</div>

7771

7772

7773

</li>

7774

7775

7776

7777

7778

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

7779

7780

7781

7782

7783

7784

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

7785

</div>

7786

7787

7788

</li>

7789

7790

7791

7792

<code class="param-name">context</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 optional context to call the handler with. The default context is the plugin instance.</p>

7800

</div>

7801

7802

7803

</li>

7804

7805

</ul>

7806

</div>

7807

7808

7809

7810

7811

<h4>Returns:</h4>

7812

7813

7814

7815

7816

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

7817

7818

handle The detach handle for the handler.

7819

7820

</div>

7821

</div>

7822

7823

7824

7825

</div>

7826

7827

7828

7829

7830

7831

7832

7833

7834

7835

7836

7837

7838

7839

</li>

7840

7841

7842

7843

<code>arguments</code>

7844

7845

</li>

7846

7847

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

7848

</div>

7849

7850

7851

7852

7853

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

7854

</span>

7855

7856

7857

7858

7859

7860

7861

7862

7863

7864

7865

7866

7867

7868

7869

7870

<p>Inherited from

7871

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

7872

7873

7874

7875

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

7876

7877

</p>

7878

7879

7880

7881

7882

7883

</div>

7884

7885

7886

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

7887

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

7888

following parameters.</p>

7889

7890

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

7891

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

7892

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

7893

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

7894

be published on this object first.</p>

7895

7896

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

7897

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

7898

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

7899

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

7900

in place of the original object.</p>

7901

</div>

7902

7903

7904

7905

<h4>Parameters:</h4>

7906

7907

7908

7909

7910

7911

7912

7913

7914

7915

7916

7917

7918

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

7919

a 'type' property.</p>

7920

</div>

7921

7922

7923

</li>

7924

7925

7926

7927

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

7928

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

7929

7930

7931

7932

7933

7934

<p>an arbitrary set of parameters to pass to

7935

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

7936

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

7937

parameter after the properties the object literal contains are copied to

7938

the event facade.</p>

7939

</div>

7940

7941

7942

</li>

7943

7944

</ul>

7945

</div>

7946

7947

7948

7949

7950

<h4>Returns:</h4>

7951

7952

7953

7954

7955

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

7956

7957

the event host

7958

7959

</div>

7960

</div>

7961

7962

7963

7964

</div>

7965

7966

7967

7968

7969

7970

7971

7972

7973

7974

7975

7976

7977

7978

</li>

7979

7980

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

7981

</div>

7982

7983

7984

7985

7986

7987

</span>

7988

7989

7990

7991

7992

7993

7994

7995

7996

7997

7998

7999

8000

8001

8002

8003

<p>Inherited from

8004

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

8005

8006

8007

8008

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

8009

8010

</p>

8011

8012

8013

8014

8015

8016

</div>

8017

8018

8019

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

8020

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

8021

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

8022

</div>

8023

8024

8025

8026

<h4>Parameters:</h4>

8027

8028

8029

8030

8031

8032

8033

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

8034

8035

8036

8037

8038

8039

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

8040

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

8041

</div>

8042

8043

8044

</li>

8045

8046

</ul>

8047

</div>

8048

8049

8050

8051

8052

<h4>Returns:</h4>

8053

8054

8055

8056

8057

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

8058

8059

The value of the attribute

8060

8061

</div>

8062

</div>

8063

8064

8065

8066

</div>

8067

8068

8069

8070

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

8071

8072

8073

8074

8075

8076

8077

8078

<code>attrs</code>

8079

8080

</li>

8081

8082

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

8083

</div>

8084

8085

8086

8087

8088

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

8089

</span>

8090

8091

8092

8093

8094

8095

8096

8097

8098

8099

8100

8101

8102

8103

8104

8105

<p>Inherited from

8106

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

8107

8108

8109

8110

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

8111

8112

</p>

8113

8114

8115

8116

8117

8118

</div>

8119

8120

8121

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

8122

</div>

8123

8124

8125

8126

<h4>Parameters:</h4>

8127

8128

8129

8130

8131

8132

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

8133

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

8134

8135

8136

8137

8138

8139

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

8140

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

8141

</div>

8142

8143

8144

</li>

8145

8146

</ul>

8147

</div>

8148

8149

8150

8151

8152

<h4>Returns:</h4>

8153

8154

8155

8156

8157

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

8158

8159

An object with attribute name/value pairs.

8160

8161

</div>

8162

</div>

8163

8164

8165

8166

</div>

8167

8168

8169

8170

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

8171

8172

8173

8174

8175

8176

8177

8178

8179

8180

</li>

8181

8182

8183

8184

<code>prefixed</code>

8185

8186

</li>

8187

8188

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

8189

</div>

8190

8191

8192

8193

8194

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

8195

</span>

8196

8197

8198

8199

8200

8201

8202

8203

8204

8205

8206

8207

8208

8209

8210

8211

<p>Inherited from

8212

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

8213

8214

8215

8216

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

8217

8218

</p>

8219

8220

8221

8222

8223

8224

</div>

8225

8226

8227

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

8228

falsy value otherwise</p>

8229

</div>

8230

8231

8232

8233

<h4>Parameters:</h4>

8234

8235

8236

8237

8238

8239

8240

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

8241

8242

8243

8244

8245

8246

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

8247

</div>

8248

8249

8250

</li>

8251

8252

8253

8254

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

8255

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

8256

8257

8258

8259

8260

8261

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

8262

</div>

8263

8264

8265

</li>

8266

8267

</ul>

8268

</div>

8269

8270

8271

8272

8273

<h4>Returns:</h4>

8274

8275

8276

8277

8278

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

8279

8280

the custom event or null

8281

8282

</div>

8283

</div>

8284

8285

8286

8287

</div>

8288

8289

8290

8291

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

8292

8293

8294

8295

8296

8297

8298

8299

8300

</span>

8301

8302

8303

8304

8305

8306

8307

8308

8309

8310

8311

8312

8313

8314

8315

8316

<p>Inherited from

8317

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

8318

8319

8320

8321

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

8322

8323

</p>

8324

8325

8326

8327

8328

8329

</div>

8330

8331

8332

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

8333

</div>

8334

8335

8336

8337

8338

8339

<h4>Returns:</h4>

8340

8341

8342

8343

8344

EventTarget[]

8345

8346

</div>

8347

</div>

8348

8349

8350

8351

</div>

8352

8353

8354

8355

8356

8357

8358

8359

8360

8361

8362

8363

<code>config</code>

8364

8365

</li>

8366

8367

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

8368

</div>

8369

8370

8371

8372

8373

8374

</span>

8375

8376

8377

8378

8379

8380

8381

8382

8383

8384

8385

8386

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

8387

8388

8389

8390

8391

<p>Inherited from

8392

8393

BaseCore

8394

</a>

8395

8396

but overwritten in

8397

8398

8399

8400

8401

8402

</p>

8403

8404

8405

8406

8407

8408

</div>

8409

8410

8411

<p>Init lifecycle method, invoked during construction.

8412

Fires the init event prior to setting up attributes and

8413

invoking initializers for the class hierarchy.</p>

8414

</div>

8415

8416

8417

8418

<h4>Parameters:</h4>

8419

8420

8421

8422

8423

8424

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

8425

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

8426

8427

8428

8429

8430

8431

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

8432

</div>

8433

8434

8435

</li>

8436

8437

</ul>

8438

</div>

8439

8440

8441

8442

8443

<h4>Returns:</h4>

8444

8445

8446

8447

8448

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

8449

8450

A reference to this object

8451

8452

</div>

8453

</div>

8454

8455

8456

8457

</div>

8458

8459

8460

8461

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

8462

8463

8464

8465

8466

8467

8468

8469

<code>config</code>

8470

8471

</li>

8472

8473

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

8474

</div>

8475

8476

8477

8478

8479

8480

8481

8482

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

8483

8484

8485

8486

8487

8488

8489

8490

8491

8492

8493

<p>Inherited from

8494

8495

Plugin.Base

8496

</a>

8497

8498

but overwritten in

8499

8500

8501

8502

<a href="../files/datasource_js_datasource-xmlschema.js.html#l55"><code>datasource/js/datasource-xmlschema.js:55</code></a>

8503

8504

</p>

8505

8506

8507

8508

8509

8510

</div>

8511

8512

8513

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

8514

</div>

8515

8516

8517

8518

<h4>Parameters:</h4>

8519

8520

8521

8522

8523

8524

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

8525

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

8526

8527

8528

8529

8530

8531

<p>Config object.</p>

8532

</div>

8533

8534

8535

</li>

8536

8537

</ul>

8538

</div>

8539

8540

8541

8542

8543

8544

</div>

8545

8546

8547

8548

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

8549

8550

8551

8552

8553

8554

8555

8556

8557

8558

</li>

8559

8560

8561

8562

<code>config</code>

8563

8564

</li>

8565

8566

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

8567

</div>

8568

8569

8570

8571

8572

8573

8574

8575

8576

8577

8578

8579

8580

8581

8582

8583

8584

8585

<p>Inherited from

8586

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

8587

8588

8589

8590

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

8591

8592

</p>

8593

8594

8595

8596

8597

8598

</div>

8599

8600

8601

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

8602

8603

<p>

8604

The properties which can be modified through this interface are limited

8605

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

8606

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

8607

broadcast and getter.

8608

</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 attribute whose configuration is to be updated.</p>

8627

</div>

8628

8629

8630

</li>

8631

8632

8633

8634

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

8635

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

8636

8637

8638

8639

8640

8641

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

8642

</div>

8643

8644

8645

</li>

8646

8647

</ul>

8648

</div>

8649

8650

8651

8652

8653

8654

</div>

8655

8656

8657

8658

8659

8660

8661

8662

8663

8664

8665

8666

8667

8668

</li>

8669

8670

8671

8672

8673

8674

</li>

8675

8676

8677

8678

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

8679

8680

</li>

8681

8682

8683

8684

8685

8686

</li>

8687

8688

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

8689

</div>

8690

8691

8692

8693

8694

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

8695

</span>

8696

8697

8698

8699

8700

8701

8702

8703

8704

8705

8706

8707

8708

8709

8710

8711

<p>Inherited from

8712

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

8713

8714

8715

8716

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

8717

8718

</p>

8719

8720

8721

8722

8723

8724

</div>

8725

8726

8727

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

8728

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

8729

8730

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

8731

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

8732

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

8733

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

8734

API for all available properties and methods. Subscribers to

8735

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

8736

after the event name.</p>

8737

8738

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

8739

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

8740

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

8741

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

8742

8743

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

8744

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

8745

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

8746

</div>

8747

8748

8749

8750

<h4>Parameters:</h4>

8751

8752

8753

8754

8755

8756

8757

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

8758

8759

8760

8761

8762

8763

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

8764

</div>

8765

8766

8767

</li>

8768

8769

8770

8771

8772

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

8773

8774

8775

8776

8777

8778

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

8779

</div>

8780

8781

8782

</li>

8783

8784

8785

8786

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

8787

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

8788

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

8789

8790

8791

8792

8793

8794

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

8795

</div>

8796

8797

8798

</li>

8799

8800

8801

8802

8803

8804

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

8805

8806

8807

8808

8809

8810

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

8811

</div>

8812

8813

8814

</li>

8815

8816

</ul>

8817

</div>

8818

8819

8820

8821

8822

<h4>Returns:</h4>

8823

8824

8825

8826

8827

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

8828

8829

A subscription handle capable of detaching that

8830

subscription

8831

8832

</div>

8833

</div>

8834

8835

8836

8837

</div>

8838

8839

8840

8841

8842

8843

8844

8845

8846

8847

8848

8849

8850

8851

</li>

8852

8853

8854

8855

8856

8857

</li>

8858

8859

8860

8861

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

8862

8863

</li>

8864

8865

8866

8867

8868

8869

</li>

8870

8871

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

8872

</div>

8873

8874

8875

8876

8877

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

8878

</span>

8879

8880

8881

8882

8883

8884

8885

8886

8887

8888

8889

8890

8891

8892

8893

8894

<p>Inherited from

8895

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

8896

8897

8898

8899

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

8900

8901

</p>

8902

8903

8904

8905

8906

8907

</div>

8908

8909

8910

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

8911

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

8912

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

8913

</div>

8914

8915

8916

8917

<h4>Parameters:</h4>

8918

8919

8920

8921

8922

8923

8924

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

8925

8926

8927

8928

8929

8930

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

8931

</div>

8932

8933

8934

</li>

8935

8936

8937

8938

8939

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

8940

8941

8942

8943

8944

8945

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

8946

</div>

8947

8948

8949

</li>

8950

8951

8952

8953

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

8954

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

8955

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

8956

8957

8958

8959

8960

8961

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

8962

</div>

8963

8964

8965

</li>

8966

8967

8968

8969

8970

8971

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

8972

8973

8974

8975

8976

8977

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

8978

</div>

8979

8980

8981

</li>

8982

8983

</ul>

8984

</div>

8985

8986

8987

8988

8989

<h4>Returns:</h4>

8990

8991

8992

8993

8994

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

8995

8996

A subscription handle capable of detaching the

8997

subscription

8998

8999

</div>

9000

</div>

9001

9002

9003

9004

</div>

9005

9006

9007

9008

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

9009

9010

9011

9012

9013

9014

9015

9016

9017

9018

</li>

9019

9020

9021

9022

9023

9024

</li>

9025

9026

9027

9028

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

9029

9030

</li>

9031

9032

9033

9034

9035

9036

</li>

9037

9038

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

9039

</div>

9040

9041

9042

9043

9044

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

9045

</span>

9046

9047

9048

9049

9050

9051

9052

9053

9054

9055

9056

9057

9058

9059

9060

9061

<p>Inherited from

9062

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

9063

9064

9065

9066

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

9067

9068

</p>

9069

9070

9071

9072

9073

9074

</div>

9075

9076

9077

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

9078

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

9079

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

9080

</div>

9081

9082

9083

9084

<h4>Parameters:</h4>

9085

9086

9087

9088

9089

9090

9091

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

9092

9093

9094

9095

9096

9097

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

9098

</div>

9099

9100

9101

</li>

9102

9103

9104

9105

9106

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

9107

9108

9109

9110

9111

9112

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

9113

</div>

9114

9115

9116

</li>

9117

9118

9119

9120

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

9121

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

9122

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

9123

9124

9125

9126

9127

9128

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

9129

</div>

9130

9131

9132

</li>

9133

9134

9135

9136

9137

9138

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

9139

9140

9141

9142

9143

9144

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

9145

</div>

9146

9147

9148

</li>

9149

9150

</ul>

9151

</div>

9152

9153

9154

9155

9156

<h4>Returns:</h4>

9157

9158

9159

9160

9161

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

9162

9163

A subscription handle capable of detaching that

9164

subscription

9165

9166

</div>

9167

</div>

9168

9169

9170

9171

</div>

9172

9173

9174

9175

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

9176

9177

9178

9179

9180

9181

9182

9183

9184

9185

</li>

9186

9187

9188

9189

9190

9191

</li>

9192

9193

9194

9195

<code>context</code>

9196

9197

</li>

9198

9199

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

9200

</div>

9201

9202

9203

9204

9205

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

9206

</span>

9207

9208

9209

9210

9211

9212

9213

9214

9215

9216

9217

9218

9219

9220

9221

9222

<p>Inherited from

9223

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

9224

9225

9226

9227

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

9228

9229

</p>

9230

9231

9232

9233

9234

9235

</div>

9236

9237

9238

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

9239

9240

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

9241

</div>

9242

9243

9244

9245

<h4>Parameters:</h4>

9246

9247

9248

9249

9250

9251

9252

9253

9254

9255

9256

9257

9258

<p>The event type.</p>

9259

</div>

9260

9261

9262

</li>

9263

9264

9265

9266

9267

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

9268

9269

9270

9271

9272

9273

<p>The listener.</p>

9274

</div>

9275

9276

9277

</li>

9278

9279

9280

9281

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

9282

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

9283

9284

9285

9286

9287

9288

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

9289

</div>

9290

9291

9292

</li>

9293

9294

</ul>

9295

</div>

9296

9297

9298

9299

9300

<h4>Returns:</h4>

9301

9302

9303

9304

9305

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

9306

9307

handle The detach handle for the listener.

9308

9309

</div>

9310

</div>

9311

9312

9313

9314

</div>

9315

9316

9317

9318

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

9319

9320

9321

9322

9323

9324

9325

9326

9327

9328

</li>

9329

9330

9331

9332

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

9333

9334

</li>

9335

9336

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

9337

</div>

9338

9339

9340

9341

9342

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

9343

</span>

9344

9345

9346

9347

9348

9349

9350

9351

9352

9353

9354

9355

9356

9357

9358

9359

<p>Inherited from

9360

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

9361

9362

9363

9364

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

9365

9366

</p>

9367

9368

9369

9370

9371

9372

<p>Available since 3.3.0</p>

9373

9374

</div>

9375

9376

9377

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

9378

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

9379

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

9380

to include the prefix one is supplied or the event target

9381

is configured with a default prefix.</p>

9382

</div>

9383

9384

9385

9386

<h4>Parameters:</h4>

9387

9388

9389

9390

9391

9392

9393

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

9394

9395

9396

9397

9398

9399

9400

</div>

9401

9402

9403

</li>

9404

9405

9406

9407

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

9408

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

9409

<span class="flag optional" title="This parameter is optional.">optional</span>

9410

9411

9412

9413

9414

9415

<p>the prefix</p>

9416

</div>

9417

9418

9419

</li>

9420

9421

</ul>

9422

</div>

9423

9424

9425

9426

9427

<h4>Returns:</h4>

9428

9429

9430

9431

9432

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Array" class="crosslink external" target="_blank">Array</a></span>:

9433

9434

an array containing:

9435

* the detach category, if supplied,

9436

* the prefixed event type,

9437

* whether or not this is an after listener,

9438

* the supplied event type

9439

9440

</div>

9441

</div>

9442

9443

9444

9445

</div>

9446

9447

9448

9449

<h3 class="name"><code>publish</code></h3>

9450

9451

9452

9453

9454

9455

9456

9457

9458

9459

</li>

9460

9461

9462

9463

9464

9465

</li>

9466

9467

</ul><span class="paren">)</span>

9468

</div>

9469

9470

9471

9472

9473

<span class="type"><a href="../classes/CustomEvent.html" class="crosslink">CustomEvent</a></span>

9474

</span>

9475

9476

9477

9478

9479

9480

9481

9482

9483

9484

9485

9486

9487

9488

9489

9490

<p>Inherited from

9491

<a href="../classes/EventTarget.html#method_publish">EventTarget</a>:

9492

9493

9494

9495

<a href="../files/event-custom_js_event-target.js.html#l489"><code>event-custom/js/event-target.js:489</code></a>

9496

9497

</p>

9498

9499

9500

9501

9502

9503

</div>

9504

9505

9506

<p>Creates a new custom event of the specified type. If a custom event

9507

by that name already exists, it will not be re-created. In either

9508

case the custom event is returned.</p>

9509

</div>

9510

9511

9512

9513

<h4>Parameters:</h4>

9514

9515

9516

9517

9518

9519

9520

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

9521

9522

9523

9524

9525

9526

<p>the type, or name of the event</p>

9527

</div>

9528

9529

9530

</li>

9531

9532

9533

9534

9535

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>

9536

9537

9538

9539

9540

9541

<p>optional config params. Valid properties are:</p>

9542

9543

<p><ul>

9544

<li>

9545

'broadcast': whether or not the YUI instance and YUI global are notified when the event is fired (false)

9546

</li>

9547

<li>

9548

'bubbles': whether or not this event bubbles (true)

9549

Events can only bubble if emitFacade is true.

9550

</li>

9551

<li>

9552

'context': the default execution context for the listeners (this)

9553

</li>

9554

<li>

9555

'defaultFn': the default function to execute when this event fires if preventDefault was not called

9556

</li>

9557

<li>

9558

'emitFacade': whether or not this event emits a facade (false)

9559

</li>

9560

<li>

9561

'prefix': the prefix for this targets events, e.g., 'menu' in 'menu:click'

9562

</li>

9563

<li>

9564

'fireOnce': if an event is configured to fire once, new subscribers after

9565

the fire will be notified immediately.

9566

</li>

9567

<li>

9568

'async': fireOnce event listeners will fire synchronously if the event has already

9569

fired unless async is true.

9570

</li>

9571

<li>

9572

'preventable': whether or not preventDefault() has an effect (true)

9573

</li>

9574

<li>

9575

'preventedFn': a function that is executed when preventDefault is called

9576

</li>

9577

<li>

9578

'queuable': whether or not this event can be queued during bubbling (false)

9579

</li>

9580

<li>

9581

'silent': if silent is true, debug messages are not provided for this event.

9582

</li>

9583

<li>

9584

'stoppedFn': a function that is executed when stopPropagation is called

9585

</li></p>

9586

9587

<p><li>

9588

'monitored': specifies whether or not this event should send notifications about

9589

when the event has been attached, detached, or published.

9590

</li>

9591

<li>

9592

'type': the event type (valid option if not provided as the first parameter to publish)

9593

</li>

9594

</ul></p>

9595

</div>

9596

9597

9598

</li>

9599

9600

</ul>

9601

</div>

9602

9603

9604

9605

9606

<h4>Returns:</h4>

9607

9608

9609

9610

9611

<span class="type"><a href="../classes/CustomEvent.html" class="crosslink">CustomEvent</a></span>:

9612

9613

the custom event

9614

9615

</div>

9616

</div>

9617

9618

9619

9620

</div>

9621

9622

9623

9624

<h3 class="name"><code>removeAttr</code></h3>

9625

9626

9627

9628

9629

9630

9631

9632

9633

9634

</li>

9635

9636

</ul><span class="paren">)</span>

9637

</div>

9638

9639

9640

9641

9642

9643

9644

9645

9646

9647

9648

9649

9650

9651

9652

9653

9654

9655

<p>Inherited from

9656

<a href="../classes/AttributeExtras.html#method_removeAttr">AttributeExtras</a>:

9657

9658

9659

9660

<a href="../files/attribute_js_AttributeExtras.js.html#l77"><code>attribute/js/AttributeExtras.js:77</code></a>

9661

9662

</p>

9663

9664

9665

9666

9667

9668

</div>

9669

9670

9671

<p>Removes an attribute from the host object</p>

9672

</div>

9673

9674

9675

9676

<h4>Parameters:</h4>

9677

9678

9679

9680

9681

9682

9683

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

9684

9685

9686

9687

9688

9689

<p>The name of the attribute to be removed.</p>

9690

</div>

9691

9692

9693

</li>

9694

9695

</ul>

9696

</div>

9697

9698

9699

9700

9701

9702

</div>

9703

9704

9705

9706

<h3 class="name"><code>removeTarget</code></h3>

9707

9708

9709

9710

9711

9712

9713

9714

9715

9716

</li>

9717

9718

</ul><span class="paren">)</span>

9719

</div>

9720

9721

9722

9723

9724

9725

9726

9727

9728

9729

9730

9731

9732

9733

9734

9735

9736

9737

<p>Inherited from

9738

<a href="../classes/EventTarget.html#method_removeTarget">EventTarget</a>:

9739

9740

9741

9742

<a href="../files/event-custom_js_event-facade.js.html#l409"><code>event-custom/js/event-facade.js:409</code></a>

9743

9744

</p>

9745

9746

9747

9748

9749

9750

</div>

9751

9752

9753

<p>Removes a bubble target</p>

9754

</div>

9755

9756

9757

9758

<h4>Parameters:</h4>

9759

9760

9761

9762

9763

9764

9765

<span class="type"><a href="../classes/EventTarget.html" class="crosslink">EventTarget</a></span>

9766

9767

9768

9769

9770

9771

<p>the target to remove</p>

9772

</div>

9773

9774

9775

</li>

9776

9777

</ul>

9778

</div>

9779

9780

9781

9782

9783

9784

</div>

9785

9786

9787

9788

<h3 class="name"><code>reset</code></h3>

9789

9790

9791

9792

9793

9794

9795

9796

9797

9798

</li>

9799

9800

</ul><span class="paren">)</span>

9801

</div>

9802

9803

9804

9805

9806

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>

9807

</span>

9808

9809

9810

9811

9812

9813

9814

9815

9816

9817

9818

9819

<span class="flag chainable">chainable</span>

9820

9821

9822

9823

9824

9825

<p>Inherited from

9826

<a href="../classes/AttributeExtras.html#method_reset">AttributeExtras</a>:

9827

9828

9829

9830

<a href="../files/attribute_js_AttributeExtras.js.html#l87"><code>attribute/js/AttributeExtras.js:87</code></a>

9831

9832

</p>

9833

9834

9835

9836

9837

9838

</div>

9839

9840

9841

<p>Resets the attribute (or all attributes) to its initial value, as long as

9842

the attribute is not readOnly, or writeOnce.</p>

9843

</div>

9844

9845

9846

9847

<h4>Parameters:</h4>

9848

9849

9850

9851

9852

9853

9854

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

9855

9856

9857

9858

9859

9860

<p>Optional. The name of the attribute to reset. If omitted, all attributes are reset.</p>

9861

</div>

9862

9863

9864

</li>

9865

9866

</ul>

9867

</div>

9868

9869

9870

9871

9872

<h4>Returns:</h4>

9873

9874

9875

9876

9877

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>:

9878

9879

A reference to the host object.

9880

9881

</div>

9882

</div>

9883

9884

9885

9886

</div>

9887

9888

9889

9890

9891

9892

9893

9894

9895

9896

9897

9898

9899

9900

</li>

9901

9902

9903

9904

<code>value</code>

9905

9906

</li>

9907

9908

</ul><span class="paren">)</span>

9909

</div>

9910

9911

9912

9913

9914

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>

9915

</span>

9916

9917

9918

9919

9920

9921

9922

9923

9924

9925

9926

9927

<span class="flag chainable">chainable</span>

9928

9929

9930

9931

9932

<p>Inherited from

9933

9934

AttributeEvents

9935

</a>

9936

9937

but overwritten in

9938

9939

9940

9941

<a href="../files/attribute_js_AttributeCore.js.html#l328"><code>attribute/js/AttributeCore.js:328</code></a>

9942

9943

</p>

9944

9945

9946

9947

9948

9949

</div>

9950

9951

9952

<p>Sets the value of an attribute.</p>

9953

</div>

9954

9955

9956

9957

<h4>Parameters:</h4>

9958

9959

9960

9961

9962

9963

9964

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

9965

9966

9967

9968

9969

9970

<p>The name of the attribute. If the

9971

current value of the attribute is an Object, dot notation can be used

9972

to set the value of a property within the object (e.g. <code>set("x.y.z", 5)</code>).</p>

9973

</div>

9974

9975

9976

</li>

9977

9978

9979

9980

<code class="param-name">value</code>

9981

9982

9983

9984

9985

9986

9987

<p>The value to set the attribute to.</p>

9988

</div>

9989

9990

9991

</li>

9992

9993

</ul>

9994

</div>

9995

9996

9997

9998

9999

<h4>Returns:</h4>

10000

10001

10002

10003

10004

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>:

10005

10006

A reference to the host object.

10007

10008

</div>

10009

</div>

10010

10011

10012

10013

</div>

10014

10015

10016

10017

<h3 class="name"><code>setAttrs</code></h3>

10018

10019

10020

10021

10022

10023

10024

10025

<code>attrs</code>

10026

10027

</li>

10028

10029

</ul><span class="paren">)</span>

10030

</div>

10031

10032

10033

10034

10035

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>

10036

</span>

10037

10038

10039

10040

10041

10042

10043

10044

10045

10046

10047

10048

<span class="flag chainable">chainable</span>

10049

10050

10051

10052

10053

<p>Inherited from

10054

10055

AttributeEvents

10056

</a>

10057

10058

but overwritten in

10059

10060

10061

10062

<a href="../files/attribute_js_AttributeCore.js.html#l635"><code>attribute/js/AttributeCore.js:635</code></a>

10063

10064

</p>

10065

10066

10067

10068

10069

10070

</div>

10071

10072

10073

<p>Sets multiple attribute values.</p>

10074

</div>

10075

10076

10077

10078

<h4>Parameters:</h4>

10079

10080

10081

10082

10083

10084

<code class="param-name">attrs</code>

10085

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>

10086

10087

10088

10089

10090

10091

<p>An object with attributes name/value pairs.</p>

10092

</div>

10093

10094

10095

</li>

10096

10097

</ul>

10098

</div>

10099

10100

10101

10102

10103

<h4>Returns:</h4>

10104

10105

10106

10107

10108

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>:

10109

10110

A reference to the host object.

10111

10112

</div>

10113

</div>

10114

10115

10116

10117

</div>

10118

10119

10120

10121

<h3 class="name"><code>subscribe</code></h3>

10122

10123

10124

10125

10126

10127

10128

10129

10130

<span class="flag deprecated" title="use on">deprecated</span>

10131

10132

10133

10134

10135

10136

10137

10138

10139

10140

10141

10142

10143

10144

<p>Inherited from

10145

<a href="../classes/EventTarget.html#method_subscribe">EventTarget</a>:

10146

10147

10148

10149

<a href="../files/event-custom_js_event-target.js.html#l335"><code>event-custom/js/event-target.js:335</code></a>

10150

10151

</p>

10152

10153

10154

10155

<p>Deprecated: use on</p>

10156

10157

10158

10159

</div>

10160

10161

10162

<p>subscribe to an event</p>

10163

</div>

10164

10165

10166

10167

10168

10169

10170

</div>

10171

10172

10173

10174

<h3 class="name"><code>toString</code></h3>

10175

10176

10177

10178

10179

10180

10181

10182

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

10183

</span>

10184

10185

10186

10187

10188

10189

10190

10191

10192

10193

10194

10195

10196

10197

10198

10199

<p>Inherited from

10200

<a href="../classes/BaseCore.html#method_toString">BaseCore</a>:

10201

10202

10203

10204

<a href="../files/base_js_BaseCore.js.html#l592"><code>base/js/BaseCore.js:592</code></a>

10205

10206

</p>

10207

10208

10209

10210

10211

10212

</div>

10213

10214

10215

<p>Default toString implementation. Provides the constructor NAME

10216

and the instance guid, if set.</p>

10217

</div>

10218

10219

10220

10221

10222

10223

<h4>Returns:</h4>

10224

10225

10226

10227

10228

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>:

10229

10230

String representation for this object

10231

10232

</div>

10233

</div>

10234

10235

10236

10237

</div>

10238

10239

10240

10241

<h3 class="name"><code>unsubscribe</code></h3>

10242

10243

10244

10245

10246

10247

10248

10249

10250

<span class="flag deprecated" title="use detach">deprecated</span>

10251

10252

10253

10254

10255

10256

10257

10258

10259

10260

10261

10262

10263

10264

<p>Inherited from

10265

<a href="../classes/EventTarget.html#method_unsubscribe">EventTarget</a>:

10266

10267

10268

10269

<a href="../files/event-custom_js_event-target.js.html#l455"><code>event-custom/js/event-target.js:455</code></a>

10270

10271

</p>

10272

10273

10274

10275

<p>Deprecated: use detach</p>

10276

10277

10278

10279

</div>

10280

10281

10282

<p>detach a listener</p>

10283

</div>

10284

10285

10286

10287

10288

10289

10290

</div>

10291

10292

10293

10294

<h3 class="name"><code>unsubscribeAll</code></h3>

10295

10296

10297

10298

10299

10300

10301

10302

10303

10304

</li>

10305

10306

</ul><span class="paren">)</span>

10307

</div>

10308

10309

10310

10311

10312

10313

<span class="flag deprecated" title="use detachAll">deprecated</span>

10314

10315

10316

10317

10318

10319

10320

10321

10322

10323

10324

10325

10326

10327

<p>Inherited from

10328

<a href="../classes/EventTarget.html#method_unsubscribeAll">EventTarget</a>:

10329

10330

10331

10332

<a href="../files/event-custom_js_event-target.js.html#l476"><code>event-custom/js/event-target.js:476</code></a>

10333

10334

</p>

10335

10336

10337

10338

<p>Deprecated: use detachAll</p>

10339

10340

10341

10342

</div>

10343

10344

10345

<p>Removes all listeners from the specified event. If the event type

10346

is not specified, all listeners from all hosted custom events will

10347

be removed.</p>

10348

</div>

10349

10350

10351

10352

<h4>Parameters:</h4>

10353

10354

10355

10356

10357

10358

10359

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

10360

10361

10362

10363

10364

10365

<p>The type, or name of the event</p>

10366

</div>

10367

10368

10369

</li>

10370

10371

</ul>

10372

</div>

10373

10374

10375

10376

10377

10378

</div>

10379

10380

10381

</div>

10382

10383

10384

10385

10386

<h2 class="off-left">Properties</h2>

10387

10388

10389

10390

<h3 class="name"><code>_allowAdHocAttrs</code></h3>

10391

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>

10392

10393

10394

10395

10396

<span class="flag protected">protected</span>

10397

10398

10399

10400

10401

10402

10403

10404

10405

10406

<p>Inherited from

10407

<a href="../classes/BaseCore.html#property__allowAdHocAttrs">BaseCore</a>:

10408

10409

10410

10411

<a href="../files/base_js_BaseCore.js.html#l100"><code>base/js/BaseCore.js:100</code></a>

10412

10413

</p>

10414

10415

10416

10417

10418

</div>

10419

10420

10421

<p>This property controls whether or not instances of this class should

10422

allow users to add ad-hoc attributes through the constructor configuration

10423

hash.</p>

10424

10425

<p>AdHoc attributes are attributes which are not defined by the class, and are

10426

not handled by the MyClass.<em>NON</em>ATTRS_CFG</p>

10427

</div>

10428

10429

10430

<p><strong>Default:</strong> undefined (false)</p>

10431

10432

10433

10434

10435

10436

</div>

10437

10438

10439

10440

<h3 class="name"><code>_handles</code></h3>

10441

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Array" class="crosslink external" target="_blank">Array</a></span>

10442

10443

10444

10445

10446

<span class="flag private">private</span>

10447

10448

10449

10450

10451

10452

10453

10454

10455

10456

<p>Inherited from

10457

<a href="../classes/Plugin.Base.html#property__handles">Plugin.Base</a>:

10458

10459

10460

10461

<a href="../files/plugin_js_plugin.js.html#l66"><code>plugin/js/plugin.js:66</code></a>

10462

10463

</p>

10464

10465

10466

10467

10468

</div>

10469

10470

10471

<p>The list of event handles for event listeners or AOP injected methods

10472

applied by the plugin to the host object.</p>

10473

</div>

10474

10475

10476

10477

10478

10479

10480

</div>

10481

10482

10483

10484

10485

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

10486

10487

10488

10489

10490

10491

10492

<span class="flag final">final</span>

10493

10494

10495

10496

<span class="flag static">static</span>

10497

10498

10499

10500

10501

10502

10503

<p>

10504

10505

Defined in

10506

10507

10508

10509

10510

<a href="../files/datasource_js_datasource-xmlschema.js.html#l30"><code>datasource/js/datasource-xmlschema.js:30</code></a>

10511

10512

</p>

10513

10514

10515

10516

10517

</div>

10518

10519

10520

<p>Class name.</p>

10521

</div>

10522

10523

10524

10525

10526

10527

10528

</div>

10529

10530

10531

10532

10533

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

10534

10535

10536

<span class="flag deprecated" title="Use this.constructor.NAME">deprecated</span>

10537

10538

10539

10540

10541

10542

10543

10544

10545

10546

10547

10548

<p>Inherited from

10549

<a href="../classes/BaseCore.html#property_name">BaseCore</a>:

10550

10551

10552

10553

<a href="../files/base_js_BaseCore.js.html#l196"><code>base/js/BaseCore.js:196</code></a>

10554

10555

</p>

10556

10557

10558

<p>Deprecated: Use this.constructor.NAME</p>

10559

10560

10561

10562

</div>

10563

10564

10565

<p>The string used to identify the class of this object.</p>

10566

</div>

10567

10568

10569

10570

10571

10572

10573

</div>

10574

10575

10576

10577

10578

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

10579

10580

10581

10582

10583

10584

10585

<span class="flag final">final</span>

10586

10587

10588

10589

<span class="flag static">static</span>

10590

10591

10592

10593

10594

10595

10596

<p>

10597

10598

Defined in

10599

10600

10601

10602

10603

<a href="../files/datasource_js_datasource-xmlschema.js.html#l18"><code>datasource/js/datasource-xmlschema.js:18</code></a>

10604

10605

</p>

10606

10607

10608

10609

10610

</div>

10611

10612

10613

<p>The namespace for the plugin. This will be the property on the host which

10614

references the plugin instance.</p>

10615

</div>

10616

10617

10618

10619

10620

10621

10622

</div>

10623

10624

10625

</div>

10626

10627

10628

10629

10630

<h2 class="off-left">Attributes</h2>

10631

10632

10633

10634

10635

<h3 class="name"><code>destroyed</code></h3>

10636

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>

10637

10638

10639

10640

10641

10642

10643

10644

10645

10646

10647

10648

10649

<p>Inherited from

10650

<a href="../classes/BaseCore.html#attr_destroyed">BaseCore</a>:

10651

10652

10653

10654

<a href="../files/base_js_BaseCore.js.html#l157"><code>base/js/BaseCore.js:157</code></a>

10655

10656

</p>

10657

10658

10659

10660

10661

</div>

10662

10663

10664

<p>Flag indicating whether or not this object

10665

has been through the destroy lifecycle phase.</p>

10666

</div>

10667

10668

10669

<p><strong>Default:</strong> false</p>

10670

10671

10672

10673

10674

<h4>Fires event <code>destroyedChange</code></h4>

10675

10676

<p>

10677

Fires when the value for the configuration attribute <code>destroyed</code> is

10678

changed. You can listen for the event using the <code>on</code> method if you

10679

wish to be notified before the attribute's value has changed, or

10680

using the <code>after</code> method if you wish to be notified after the

10681

attribute's value has changed.

10682

</p>

10683

10684

10685

<h4>Parameters:</h4>

10686

10687

10688

10689

10690

<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>

10691

10692

10693

An Event Facade object with the following

10694

attribute-specific properties added:

10695

</div>

10696

10697

10698

10699

<code class="param-name">prevVal</code>

10700

10701

<div class="param-description">The value of the attribute, prior to it being set.</div>

10702

</li>

10703

10704

<code class="param-name">newVal</code>

10705

10706

<div class="param-description">The value the attribute is to be set to.</div>

10707

</li>

10708

10709

<code class="param-name">attrName</code>

10710

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

10711

<div class="param-description">The name of the attribute being set.</div>

10712

</li>

10713

10714

<code class="param-name">subAttrName</code>

10715

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

10716

<div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div>

10717

</li>

10718

</ul>

10719

</li>

10720

</ul>

10721

</div>

10722

</div>

10723

10724

10725

10726

</div>

10727

10728

10729

10730

10731

10732

<span class="type"><a href="../classes/Plugin.Host.html" class="crosslink">Plugin.Host</a></span>

10733

10734

10735

10736

10737

10738

10739

10740

10741

10742

10743

10744

10745

<p>Inherited from

10746

<a href="../classes/Plugin.Base.html#attr_host">Plugin.Base</a>:

10747

10748

10749

10750

<a href="../files/plugin_js_plugin.js.html#l31"><code>plugin/js/plugin.js:31</code></a>

10751

10752

</p>

10753

10754

10755

10756

10757

</div>

10758

10759

10760

<p>The plugin's host object.</p>

10761

</div>

10762

10763

10764

10765

10766

10767

<h4>Fires event <code>hostChange</code></h4>

10768

10769

<p>

10770

Fires when the value for the configuration attribute <code>host</code> is

10771

changed. You can listen for the event using the <code>on</code> method if you

10772

wish to be notified before the attribute's value has changed, or

10773

using the <code>after</code> method if you wish to be notified after the

10774

attribute's value has changed.

10775

</p>

10776

10777

10778

<h4>Parameters:</h4>

10779

10780

10781

10782

10783

<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>

10784

10785

10786

An Event Facade object with the following

10787

attribute-specific properties added:

10788

</div>

10789

10790

10791

10792

<code class="param-name">prevVal</code>

10793

10794

<div class="param-description">The value of the attribute, prior to it being set.</div>

10795

</li>

10796

10797

<code class="param-name">newVal</code>

10798

10799

<div class="param-description">The value the attribute is to be set to.</div>

10800

</li>

10801

10802

<code class="param-name">attrName</code>

10803

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

10804

<div class="param-description">The name of the attribute being set.</div>

10805

</li>

10806

10807

<code class="param-name">subAttrName</code>

10808

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

10809

<div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div>

10810

</li>

10811

</ul>

10812

</li>

10813

</ul>

10814

</div>

10815

</div>

10816

10817

10818

10819

</div>

10820

10821

10822

10823

10824

<h3 class="name"><code>initialized</code></h3>

10825

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>

10826

10827

10828

10829

10830

10831

10832

10833

10834

10835

10836

10837

10838

<p>Inherited from

10839

<a href="../classes/BaseCore.html#attr_initialized">BaseCore</a>:

10840

10841

10842

10843

<a href="../files/base_js_BaseCore.js.html#l143"><code>base/js/BaseCore.js:143</code></a>

10844

10845

</p>

10846

10847

10848

10849

10850

</div>

10851

10852

10853

<p>Flag indicating whether or not this object

10854

has been through the init lifecycle phase.</p>

10855

</div>

10856

10857

10858

<p><strong>Default:</strong> false</p>

10859

10860

10861

10862

10863

<h4>Fires event <code>initializedChange</code></h4>

10864

10865

<p>

10866

Fires when the value for the configuration attribute <code>initialized</code> is

10867

changed. You can listen for the event using the <code>on</code> method if you

10868

wish to be notified before the attribute's value has changed, or

10869

using the <code>after</code> method if you wish to be notified after the

10870

attribute's value has changed.

10871

</p>

10872

10873

10874

<h4>Parameters:</h4>

10875

10876

10877

10878

10879

<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>

10880

10881

10882

An Event Facade object with the following

10883

attribute-specific properties added:

10884

</div>

10885

10886

10887

10888

<code class="param-name">prevVal</code>

10889

10890

<div class="param-description">The value of the attribute, prior to it being set.</div>

10891

</li>

10892

10893

<code class="param-name">newVal</code>

10894

10895

<div class="param-description">The value the attribute is to be set to.</div>

10896

</li>

10897

10898

<code class="param-name">attrName</code>

10899

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

10900

<div class="param-description">The name of the attribute being set.</div>

10901

</li>

10902

10903

<code class="param-name">subAttrName</code>

10904

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

10905

<div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div>

10906

</li>

10907

</ul>

10908

</li>

10909

</ul>

10910

</div>

10911

</div>

10912

10913

10914

10915

</div>

10916

10917

10918

</div>

10919

10920

10921

10922

10923

<h2 class="off-left">Events</h2>

10924

10925

10926

10927

<h3 class="name"><code>destroy</code></h3>

10928

10929

10930

10931

10932

10933

10934

10935

10936

10937

10938

10939

10940

10941

<p>Inherited from

10942

<a href="../classes/Base.html#event_destroy">Base</a>:

10943

10944

10945

10946

10947

10948

</p>

10949

10950

10951

10952

10953

</div>

10954

10955

10956

<p>

10957

Lifecycle event for the destroy phase,

10958

fired prior to destruction. Invoking the preventDefault

10959

method on the event object provided to subscribers will

10960

prevent destruction from proceeding.

10961

</p>

10962

10963

<p>

10964

Subscribers to the "after" moment of this event, will be notified

10965

after destruction is complete (and as a result cannot prevent

10966

destruction).

10967

</p>

10968

</div>

10969

10970

10971

10972

<h4>Event Payload:</h4>

10973

10974

10975

10976

10977

10978

10979

<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>

10980

10981

10982

10983

10984

10985

<p>Event object</p>

10986

</div>

10987

10988

10989

</li>

10990

10991

</ul>

10992

</div>

10993

10994

10995

10996

10997

</div>

10998

10999

11000

11001

11002

11003

11004

11005

11006

11007

11008

11009

11010

11011

11012

11013

11014

11015

<p>Inherited from

11016

<a href="../classes/Base.html#event_init">Base</a>:

11017

11018

11019

11020

11021

11022

</p>

11023

11024

11025

11026

11027

</div>

11028

11029

11030

<p>

11031

Lifecycle event for the init phase, fired prior to initialization.

11032

Invoking the preventDefault() method on the event object provided

11033

to subscribers will prevent initialization from occuring.

11034

</p>

11035

11036

<p>

11037

Subscribers to the "after" momemt of this event, will be notified

11038

after initialization of the object is complete (and therefore

11039

cannot prevent initialization).

11040

</p>

11041

</div>

11042

11043

11044

11045

<h4>Event Payload:</h4>

11046

11047

11048

11049

11050

11051

11052

<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>

11053

11054

11055

11056

11057

11058

<p>Event object, with a cfg property which

11059

refers to the configuration object passed to the constructor.</p>

11060

</div>

11061

11062

11063

</li>

11064

11065

</ul>

11066

</div>

11067

11068

11069

11070

11071

</div>

11072

11073

11074

</div>

11075

11076

</div>

11077

</div>

11078

11079

</div>

11080

</div>

11081

</div>

11082

</div>

11083

</div>

11084

</div>

11085

11086

11087

11088

11089

11090

11091

11092

11093

</body>

11094

</html>

Older »