~smagoun/whoopsie/whoopsie-lp1017637

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

2038

2039

2040

2041

2042

2043

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

2044

</div>

2045

2046

2047

</li>

2048

2049

2050

2051

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

2052

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

2053

2054

2055

2056

2057

2058

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

2059

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

2060

</div>

2061

2062

2063

</li>

2064

2065

2066

2067

2068

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

2069

2070

2071

2072

2073

2074

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

2075

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

2076

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

2077

</div>

2078

2079

2080

</li>

2081

2082

</ul>

2083

</div>

2084

2085

2086

2087

2088

2089

</div>

2090

2091

2092

2093

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

2094

2095

2096

2097

2098

2099

2100

2101

2102

2103

</li>

2104

2105

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

2106

</div>

2107

2108

2109

2110

2111

2112

2113

2114

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

2115

2116

2117

2118

2119

2120

2121

2122

2123

2124

2125

2126

<p>Inherited from

2127

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

2128

2129

2130

2131

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

2132

2133

</p>

2134

2135

2136

2137

2138

2139

</div>

2140

2141

2142

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

2143

</div>

2144

2145

2146

2147

<h4>Parameters:</h4>

2148

2149

2150

2151

2152

2153

2154

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

2155

2156

2157

2158

2159

2160

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

2161

</div>

2162

2163

2164

</li>

2165

2166

</ul>

2167

</div>

2168

2169

2170

2171

2172

2173

</div>

2174

2175

2176

2177

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

2178

2179

2180

2181

2182

2183

2184

2185

2186

2187

2188

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

2189

2190

2191

2192

2193

2194

2195

2196

2197

2198

2199

2200

<p>Inherited from

2201

<a href="../classes/Plugin.EditorParaBase.html#method__afterContentChange">Plugin.EditorParaBase</a>:

2202

2203

2204

2205

<a href="../files/editor_js_editor-para-base.js.html#l57"><code>editor/js/editor-para-base.js:57</code></a>

2206

2207

</p>

2208

2209

2210

2211

2212

2213

</div>

2214

2215

2216

<p>Performs a block element filter when the Editor after an content change</p>

2217

</div>

2218

2219

2220

2221

2222

2223

2224

</div>

2225

2226

2227

2228

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

2229

2230

2231

2232

2233

2234

2235

2236

2237

2238

2239

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

2240

2241

2242

2243

2244

2245

2246

2247

2248

2249

2250

2251

<p>Inherited from

2252

<a href="../classes/Plugin.EditorParaBase.html#method__afterEditorReady">Plugin.EditorParaBase</a>:

2253

2254

2255

2256

<a href="../files/editor_js_editor-para-base.js.html#l43"><code>editor/js/editor-para-base.js:43</code></a>

2257

2258

</p>

2259

2260

2261

2262

2263

2264

</div>

2265

2266

2267

<p>Performs a block element filter when the Editor is first ready</p>

2268

</div>

2269

2270

2271

2272

2273

2274

2275

</div>

2276

2277

2278

2279

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

2280

2281

2282

2283

2284

2285

2286

2287

2288

2289

2290

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

2291

2292

2293

2294

2295

2296

2297

2298

2299

2300

2301

2302

<p>Inherited from

2303

<a href="../classes/Plugin.EditorParaBase.html#method__afterPaste">Plugin.EditorParaBase</a>:

2304

2305

2306

2307

<a href="../files/editor_js_editor-para-base.js.html#l68"><code>editor/js/editor-para-base.js:68</code></a>

2308

2309

</p>

2310

2311

2312

2313

2314

2315

</div>

2316

2317

2318

<p>Performs block/paste filtering after paste.</p>

2319

</div>

2320

2321

2322

2323

2324

2325

2326

</div>

2327

2328

2329

2330

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

2331

2332

2333

2334

2335

2336

2337

2338

<code>allAttrs</code>

2339

2340

</li>

2341

2342

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

2343

</div>

2344

2345

2346

2347

2348

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

2349

</span>

2350

2351

2352

2353

2354

2355

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

2356

2357

2358

2359

2360

2361

2362

2363

2364

2365

2366

2367

<p>Inherited from

2368

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

2369

2370

2371

2372

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

2373

2374

</p>

2375

2376

2377

2378

2379

2380

</div>

2381

2382

2383

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

2384

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

2385

2386

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

2387

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

2388

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

2389

</div>

2390

2391

2392

2393

<h4>Parameters:</h4>

2394

2395

2396

2397

2398

2399

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

2400

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

2401

2402

2403

2404

2405

2406

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

2407

(subclass first, Base last)</p>

2408

</div>

2409

2410

2411

</li>

2412

2413

</ul>

2414

</div>

2415

2416

2417

2418

2419

<h4>Returns:</h4>

2420

2421

2422

2423

2424

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

2425

2426

The aggregate set of ATTRS definitions for the instance

2427

2428

</div>

2429

</div>

2430

2431

2432

2433

</div>

2434

2435

2436

2437

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

2438

2439

2440

2441

2442

2443

2444

2445

2446

2447

2448

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

2449

2450

2451

2452

2453

2454

2455

2456

2457

2458

2459

<p>Inherited from

2460

2461

BaseCore

2462

</a>

2463

2464

but overwritten in

2465

2466

2467

2468

2469

2470

</p>

2471

2472

2473

2474

2475

2476

</div>

2477

2478

2479

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

2480

this class.</p>

2481

</div>

2482

2483

2484

2485

2486

2487

2488

</div>

2489

2490

2491

2492

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

2493

2494

2495

2496

2497

2498

2499

2500

2501

2502

2503

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

2504

2505

2506

2507

2508

2509

2510

2511

2512

2513

2514

2515

<p>Inherited from

2516

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

2517

2518

2519

2520

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

2521

2522

</p>

2523

2524

2525

2526

2527

2528

</div>

2529

2530

2531

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

2532

</div>

2533

2534

2535

2536

2537

2538

2539

</div>

2540

2541

2542

2543

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

2544

2545

2546

2547

2548

2549

2550

2551

2552

2553

2554

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

2555

2556

2557

2558

2559

2560

2561

2562

2563

2564

2565

2566

<p>Inherited from

2567

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

2568

2569

2570

2571

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

2572

2573

</p>

2574

2575

2576

2577

2578

2579

</div>

2580

2581

2582

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

2583

</div>

2584

2585

2586

2587

2588

2589

2590

</div>

2591

2592

2593

2594

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

2595

2596

2597

2598

2599

2600

2601

2602

2603

2604

</li>

2605

2606

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

2607

</div>

2608

2609

2610

2611

2612

2613

2614

2615

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

2616

2617

2618

2619

2620

2621

2622

2623

2624

2625

2626

2627

<p>Inherited from

2628

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

2629

2630

2631

2632

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

2633

2634

</p>

2635

2636

2637

2638

2639

2640

</div>

2641

2642

2643

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

2644

</div>

2645

2646

2647

2648

<h4>Parameters:</h4>

2649

2650

2651

2652

2653

2654

2655

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

2656

2657

2658

2659

2660

2661

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

2662

</div>

2663

2664

2665

</li>

2666

2667

</ul>

2668

</div>

2669

2670

2671

2672

2673

2674

</div>

2675

2676

2677

2678

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

2679

2680

2681

2682

2683

2684

2685

2686

2687

2688

</li>

2689

2690

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

2691

</div>

2692

2693

2694

2695

2696

2697

2698

2699

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

2700

2701

2702

2703

2704

2705

2706

2707

2708

2709

2710

2711

<p>Inherited from

2712

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

2713

2714

2715

2716

2717

2718

</p>

2719

2720

2721

2722

2723

2724

</div>

2725

2726

2727

<p>Default destroy event handler</p>

2728

</div>

2729

2730

2731

2732

<h4>Parameters:</h4>

2733

2734

2735

2736

2737

2738

2739

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

2740

2741

2742

2743

2744

2745

<p>Event object</p>

2746

</div>

2747

2748

2749

</li>

2750

2751

</ul>

2752

</div>

2753

2754

2755

2756

2757

2758

</div>

2759

2760

2761

2762

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

2763

2764

2765

2766

2767

2768

2769

2770

2771

2772

</li>

2773

2774

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

2775

</div>

2776

2777

2778

2779

2780

2781

2782

2783

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

2784

2785

2786

2787

2788

2789

2790

2791

2792

2793

2794

2795

<p>Inherited from

2796

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

2797

2798

2799

2800

2801

2802

</p>

2803

2804

2805

2806

2807

2808

</div>

2809

2810

2811

<p>Default init event handler</p>

2812

</div>

2813

2814

2815

2816

<h4>Parameters:</h4>

2817

2818

2819

2820

2821

2822

2823

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

2824

2825

2826

2827

2828

2829

<p>Event object, with a cfg property which

2830

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

2831

</div>

2832

2833

2834

</li>

2835

2836

</ul>

2837

</div>

2838

2839

2840

2841

2842

2843

</div>

2844

2845

2846

2847

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

2848

2849

2850

2851

2852

2853

2854

2855

2856

2857

2858

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

2859

2860

2861

2862

2863

2864

2865

2866

2867

2868

2869

2870

<p>Inherited from

2871

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

2872

2873

2874

2875

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

2876

2877

</p>

2878

2879

2880

2881

2882

2883

</div>

2884

2885

2886

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

2887

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

2888

</div>

2889

2890

2891

2892

2893

2894

2895

</div>

2896

2897

2898

2899

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

2900

2901

2902

2903

2904

2905

2906

2907

<code>allAttrs</code>

2908

2909

</li>

2910

2911

2912

2913

<code>userVals</code>

2914

2915

</li>

2916

2917

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

2918

</div>

2919

2920

2921

2922

2923

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

2924

</span>

2925

2926

2927

2928

2929

2930

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

2931

2932

2933

2934

2935

2936

2937

2938

2939

2940

2941

2942

<p>Inherited from

2943

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

2944

2945

2946

2947

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

2948

2949

</p>

2950

2951

2952

2953

2954

2955

</div>

2956

2957

2958

2959

</div>

2960

2961

2962

2963

<h4>Parameters:</h4>

2964

2965

2966

2967

2968

2969

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

2970

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

2971

2972

2973

2974

2975

2976

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

2977

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

2978

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

2979

</div>

2980

2981

2982

</li>

2983

2984

2985

2986

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

2987

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

2988

2989

2990

2991

2992

2993

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

2994

</div>

2995

2996

2997

</li>

2998

2999

</ul>

3000

</div>

3001

3002

3003

3004

3005

<h4>Returns:</h4>

3006

3007

3008

3009

3010

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

3011

3012

The set of adhoc attributes passed in, in the form

3013

of an object with attribute name/configuration pairs.

3014

3015

</div>

3016

</div>

3017

3018

3019

3020

</div>

3021

3022

3023

3024

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

3025

3026

3027

3028

3029

3030

3031

3032

<code>clazz</code>

3033

3034

</li>

3035

3036

3037

3038

<code>allCfgs</code>

3039

3040

</li>

3041

3042

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

3043

</div>

3044

3045

3046

3047

3048

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

3049

</span>

3050

3051

3052

3053

3054

3055

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

3056

3057

3058

3059

3060

3061

3062

3063

3064

3065

3066

3067

<p>Inherited from

3068

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

3069

3070

3071

3072

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

3073

3074

</p>

3075

3076

3077

3078

3079

3080

</div>

3081

3082

3083

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

3084

initialization. Returns a disposable object with the attributes defined for

3085

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

3086

</div>

3087

3088

3089

3090

<h4>Parameters:</h4>

3091

3092

3093

3094

3095

3096

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

3097

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

3098

3099

3100

3101

3102

3103

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

3104

</div>

3105

3106

3107

</li>

3108

3109

3110

3111

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

3112

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

3113

3114

3115

3116

3117

3118

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

3119

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

3120

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

3121

</div>

3122

3123

3124

</li>

3125

3126

</ul>

3127

</div>

3128

3129

3130

3131

3132

<h4>Returns:</h4>

3133

3134

3135

3136

3137

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

3138

3139

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

3140

of an object with attribute name/configuration pairs.

3141

3142

</div>

3143

</div>

3144

3145

3146

3147

</div>

3148

3149

3150

3151

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

3152

3153

3154

3155

3156

3157

3158

3159

<code>attrName</code>

3160

3161

</li>

3162

3163

3164

3165

<code>subAttrName</code>

3166

3167

</li>

3168

3169

3170

3171

<code>currVal</code>

3172

3173

</li>

3174

3175

3176

3177

<code>newVal</code>

3178

3179

</li>

3180

3181

3182

3183

3184

3185

</li>

3186

3187

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

3188

</div>

3189

3190

3191

3192

3193

3194

3195

3196

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

3197

3198

3199

3200

3201

3202

3203

3204

3205

3206

3207

3208

<p>Inherited from

3209

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

3210

3211

3212

3213

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

3214

3215

</p>

3216

3217

3218

3219

3220

3221

</div>

3222

3223

3224

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

3225

</div>

3226

3227

3228

3229

<h4>Parameters:</h4>

3230

3231

3232

3233

3234

3235

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

3236

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

3237

3238

3239

3240

3241

3242

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

3243

</div>

3244

3245

3246

</li>

3247

3248

3249

3250

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

3251

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

3252

3253

3254

3255

3256

3257

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

3258

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

3259

</div>

3260

3261

3262

</li>

3263

3264

3265

3266

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

3267

3268

3269

3270

3271

3272

3273

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

3274

</div>

3275

3276

3277

</li>

3278

3279

3280

3281

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

3282

3283

3284

3285

3286

3287

3288

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

3289

</div>

3290

3291

3292

</li>

3293

3294

3295

3296

3297

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

3298

3299

3300

3301

3302

3303

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

3304

</div>

3305

3306

3307

</li>

3308

3309

</ul>

3310

</div>

3311

3312

3313

3314

3315

3316

</div>

3317

3318

3319

3320

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

3321

3322

3323

3324

3325

3326

3327

3328

3329

3330

3331

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

3332

3333

3334

3335

3336

3337

3338

3339

3340

3341

3342

3343

<p>Inherited from

3344

<a href="../classes/Plugin.EditorParaBase.html#method__fixFirstPara">Plugin.EditorParaBase</a>:

3345

3346

3347

3348

<a href="../files/editor_js_editor-para-base.js.html#l19"><code>editor/js/editor-para-base.js:19</code></a>

3349

3350

</p>

3351

3352

3353

3354

3355

3356

</div>

3357

3358

3359

<p>Utility method to create an empty paragraph when the document is empty.</p>

3360

</div>

3361

3362

3363

3364

3365

3366

3367

</div>

3368

3369

3370

3371

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

3372

3373

3374

3375

3376

3377

3378

3379

3380

3381

</li>

3382

3383

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

3384

</div>

3385

3386

3387

3388

3389

3390

</span>

3391

3392

3393

3394

3395

3396

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

3397

3398

3399

3400

3401

3402

3403

3404

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

3405

3406

3407

3408

3409

3410

<p>Inherited from

3411

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

3412

3413

3414

3415

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

3416

3417

</p>

3418

3419

3420

3421

3422

3423

</div>

3424

3425

3426

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

3427

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

3428

3429

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

3430

</div>

3431

3432

3433

3434

<h4>Parameters:</h4>

3435

3436

3437

3438

3439

3440

3441

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

3442

3443

3444

3445

3446

3447

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

3448

</div>

3449

3450

3451

</li>

3452

3453

</ul>

3454

</div>

3455

3456

3457

3458

3459

<h4>Returns:</h4>

3460

3461

3462

3463

3464

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

3465

3466

The value of the attribute.

3467

3468

</div>

3469

</div>

3470

3471

3472

3473

</div>

3474

3475

3476

3477

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

3478

3479

3480

3481

3482

3483

3484

3485

3486

3487

</li>

3488

3489

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

3490

</div>

3491

3492

3493

3494

3495

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

3496

</span>

3497

3498

3499

3500

3501

3502

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

3503

3504

3505

3506

3507

3508

3509

3510

3511

3512

3513

3514

<p>Inherited from

3515

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

3516

3517

3518

3519

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

3520

3521

</p>

3522

3523

3524

3525

3526

3527

</div>

3528

3529

3530

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

3531

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

3532

configuration properties for all attributes.</p>

3533

</div>

3534

3535

3536

3537

<h4>Parameters:</h4>

3538

3539

3540

3541

3542

3543

3544

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

3545

3546

3547

3548

3549

3550

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

3551

</div>

3552

3553

3554

</li>

3555

3556

</ul>

3557

</div>

3558

3559

3560

3561

3562

<h4>Returns:</h4>

3563

3564

3565

3566

3567

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

3568

3569

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

3570

3571

</div>

3572

</div>

3573

3574

3575

3576

</div>

3577

3578

3579

3580

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

3581

3582

3583

3584

3585

3586

3587

3588

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

3589

</span>

3590

3591

3592

3593

3594

3595

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

3596

3597

3598

3599

3600

3601

3602

3603

3604

3605

3606

3607

<p>Inherited from

3608

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

3609

3610

3611

3612

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

3613

3614

</p>

3615

3616

3617

3618

3619

3620

</div>

3621

3622

3623

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

3624

the class hierarchy.</p>

3625

</div>

3626

3627

3628

3629

3630

3631

<h4>Returns:</h4>

3632

3633

3634

3635

3636

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

3637

3638

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

3639

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

3640

the cached value.

3641

3642

</div>

3643

</div>

3644

3645

3646

3647

</div>

3648

3649

3650

3651

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

3652

3653

3654

3655

3656

3657

3658

3659

3660

3661

</li>

3662

3663

3664

3665

3666

3667

</li>

3668

3669

3670

3671

<code>initValues</code>

3672

3673

</li>

3674

3675

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

3676

</div>

3677

3678

3679

3680

3681

3682

</span>

3683

3684

3685

3686

3687

3688

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

3689

3690

3691

3692

3693

3694

3695

3696

3697

3698

3699

<p>Inherited from

3700

3701

AttributeCore

3702

</a>

3703

3704

but overwritten in

3705

3706

3707

3708

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

3709

3710

</p>

3711

3712

3713

3714

3715

3716

</div>

3717

3718

3719

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

3720

either the default configuration provided, or the

3721

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

3722

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

3723

</div>

3724

3725

3726

3727

<h4>Parameters:</h4>

3728

3729

3730

3731

3732

3733

3734

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

3735

3736

3737

3738

3739

3740

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

3741

</div>

3742

3743

3744

</li>

3745

3746

3747

3748

3749

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

3750

3751

3752

3753

3754

3755

<p>The attribute configuration object</p>

3756

</div>

3757

3758

3759

</li>

3760

3761

3762

3763

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

3764

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

3765

3766

3767

3768

3769

3770

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

3771

</div>

3772

3773

3774

</li>

3775

3776

</ul>

3777

</div>

3778

3779

3780

3781

3782

<h4>Returns:</h4>

3783

3784

3785

3786

3787

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

3788

3789

The initial value of the attribute.

3790

3791

</div>

3792

</div>

3793

3794

3795

3796

</div>

3797

3798

3799

3800

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

3801

3802

3803

3804

3805

3806

3807

3808

<code>attrs</code>

3809

3810

</li>

3811

3812

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

3813

</div>

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

</span>

3820

3821

3822

3823

3824

3825

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

3826

3827

3828

3829

3830

3831

3832

3833

3834

3835

3836

3837

<p>Inherited from

3838

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

3839

3840

3841

3842

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

3843

3844

</p>

3845

3846

3847

3848

3849

3850

</div>

3851

3852

3853

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

3854

</div>

3855

3856

3857

3858

<h4>Parameters:</h4>

3859

3860

3861

3862

3863

3864

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

3865

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

3866

3867

3868

3869

3870

3871

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

3872

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

3873

</div>

3874

3875

3876

</li>

3877

3878

</ul>

3879

</div>

3880

3881

3882

3883

3884

<h4>Returns:</h4>

3885

3886

3887

3888

3889

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

3890

3891

An object with attribute name/value pairs.

3892

3893

</div>

3894

</div>

3895

3896

3897

3898

</div>

3899

3900

3901

3902

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

3903

3904

3905

3906

3907

3908

3909

3910

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

3911

</span>

3912

3913

3914

3915

3916

3917

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

3918

3919

3920

3921

3922

3923

3924

3925

3926

3927

3928

3929

<p>Inherited from

3930

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

3931

3932

3933

3934

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

3935

3936

</p>

3937

3938

3939

3940

3941

3942

</div>

3943

3944

3945

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

3946

</div>

3947

3948

3949

3950

3951

3952

<h4>Returns:</h4>

3953

3954

3955

3956

3957

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

3958

3959

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

3960

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

3961

cached value.

3962

3963

</div>

3964

</div>

3965

3966

3967

3968

</div>

3969

3970

3971

3972

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

3973

3974

3975

3976

3977

3978

3979

3980

3981

3982

</li>

3983

3984

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

3985

</div>

3986

3987

3988

3989

3990

3991

</span>

3992

3993

3994

3995

3996

3997

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

3998

3999

4000

4001

4002

4003

4004

4005

4006

4007

4008

4009

<p>Inherited from

4010

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

4011

4012

4013

4014

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

4015

4016

</p>

4017

4018

4019

4020

4021

4022

</div>

4023

4024

4025

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

4026

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

4027

</div>

4028

4029

4030

4031

<h4>Parameters:</h4>

4032

4033

4034

4035

4036

4037

4038

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

4039

4040

4041

4042

4043

4044

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

4045

</div>

4046

4047

4048

</li>

4049

4050

</ul>

4051

</div>

4052

4053

4054

4055

4056

<h4>Returns:</h4>

4057

4058

4059

4060

4061

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

4062

4063

The stored value of the attribute

4064

4065

</div>

4066

</div>

4067

4068

4069

4070

</div>

4071

4072

4073

4074

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

4075

4076

4077

4078

4079

4080

4081

4082

4083

4084

4085

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

4086

4087

4088

4089

4090

4091

4092

4093

4094

4095

4096

4097

<p>Inherited from

4098

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

4099

4100

4101

4102

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

4103

4104

</p>

4105

4106

4107

4108

4109

4110

</div>

4111

4112

4113

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

4114

event type is not prefixed, the instance prefix is

4115

applied to the supplied type.</p>

4116

</div>

4117

4118

4119

4120

4121

4122

4123

</div>

4124

4125

4126

4127

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

4128

4129

4130

4131

4132

4133

4134

4135

<code>attrs</code>

4136

4137

</li>

4138

4139

4140

4141

<code>values</code>

4142

4143

</li>

4144

4145

4146

4147

4148

4149

</li>

4150

4151

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

4152

</div>

4153

4154

4155

4156

4157

4158

4159

4160

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

4161

4162

4163

4164

4165

4166

4167

4168

4169

4170

4171

4172

<p>Inherited from

4173

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

4174

4175

4176

4177

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

4178

4179

</p>

4180

4181

4182

4183

4184

4185

</div>

4186

4187

4188

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

4189

constructor.</p>

4190

</div>

4191

4192

4193

4194

<h4>Parameters:</h4>

4195

4196

4197

4198

4199

4200

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

4201

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

4202

4203

4204

4205

4206

4207

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

4208

</div>

4209

4210

4211

</li>

4212

4213

4214

4215

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

4216

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

4217

4218

4219

4220

4221

4222

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

4223

</div>

4224

4225

4226

</li>

4227

4228

4229

4230

4231

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

4232

4233

4234

4235

4236

4237

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

4238

</div>

4239

4240

4241

</li>

4242

4243

</ul>

4244

</div>

4245

4246

4247

4248

4249

4250

</div>

4251

4252

4253

4254

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

4255

4256

4257

4258

4259

4260

4261

4262

4263

4264

4265

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

4266

4267

4268

4269

4270

4271

4272

4273

4274

4275

4276

<p>Inherited from

4277

4278

BaseCore

4279

</a>

4280

4281

but overwritten in

4282

4283

4284

4285

4286

4287

</p>

4288

4289

4290

4291

4292

4293

</div>

4294

4295

4296

<p>Initializes Attribute</p>

4297

</div>

4298

4299

4300

4301

4302

4303

4304

</div>

4305

4306

4307

4308

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

4309

4310

4311

4312

4313

4314

4315

4316

<code>attrs</code>

4317

4318

</li>

4319

4320

4321

4322

<code>values</code>

4323

4324

</li>

4325

4326

4327

4328

4329

4330

</li>

4331

4332

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

4333

</div>

4334

4335

4336

4337

4338

4339

4340

4341

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

4342

4343

4344

4345

4346

4347

4348

4349

4350

4351

4352

4353

<p>Inherited from

4354

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

4355

4356

4357

4358

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

4359

4360

</p>

4361

4362

4363

4364

4365

4366

</div>

4367

4368

4369

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

4370

</div>

4371

4372

4373

4374

<h4>Parameters:</h4>

4375

4376

4377

4378

4379

4380

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

4381

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

4382

4383

4384

4385

4386

4387

4388

</div>

4389

4390

4391

</li>

4392

4393

4394

4395

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

4396

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

4397

4398

4399

4400

4401

4402

4403

</div>

4404

4405

4406

</li>

4407

4408

4409

4410

4411

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

4412

4413

4414

4415

4416

4417

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

4418

</div>

4419

4420

4421

</li>

4422

4423

</ul>

4424

</div>

4425

4426

4427

4428

4429

4430

</div>

4431

4432

4433

4434

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

4435

4436

4437

4438

4439

4440

4441

4442

<code>config</code>

4443

4444

</li>

4445

4446

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

4447

</div>

4448

4449

4450

4451

4452

4453

4454

4455

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

4456

4457

4458

4459

4460

4461

4462

4463

4464

4465

4466

<p>Inherited from

4467

4468

BaseCore

4469

</a>

4470

4471

but overwritten in

4472

4473

4474

4475

4476

4477

</p>

4478

4479

4480

4481

4482

4483

</div>

4484

4485

4486

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

4487

</div>

4488

4489

4490

4491

<h4>Parameters:</h4>

4492

4493

4494

4495

4496

4497

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

4498

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

4499

4500

4501

4502

4503

4504

<p>The constructor configuration object</p>

4505

</div>

4506

4507

4508

</li>

4509

4510

</ul>

4511

</div>

4512

4513

4514

4515

4516

4517

</div>

4518

4519

4520

4521

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

4522

4523

4524

4525

4526

4527

4528

4529

<code>userVals</code>

4530

4531

</li>

4532

4533

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

4534

</div>

4535

4536

4537

4538

4539

4540

4541

4542

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

4543

4544

4545

4546

4547

4548

4549

4550

4551

4552

4553

4554

<p>Inherited from

4555

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

4556

4557

4558

4559

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

4560

4561

</p>

4562

4563

4564

4565

4566

4567

</div>

4568

4569

4570

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

4571

initializing attributes for each class defined in the class's

4572

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

4573

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

4574

</div>

4575

4576

4577

4578

<h4>Parameters:</h4>

4579

4580

4581

4582

4583

4584

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

4585

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

4586

4587

4588

4589

4590

4591

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

4592

</div>

4593

4594

4595

</li>

4596

4597

</ul>

4598

</div>

4599

4600

4601

4602

4603

4604

</div>

4605

4606

4607

4608

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

4609

4610

4611

4612

4613

4614

4615

4616

4617

4618

4619

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

4620

4621

4622

4623

4624

4625

4626

4627

4628

4629

4630

4631

<p>Inherited from

4632

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

4633

4634

4635

4636

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

4637

4638

</p>

4639

4640

4641

4642

4643

4644

</div>

4645

4646

4647

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

4648

the array of classes and aggregate set of attribute configurations

4649

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

4650

</div>

4651

4652

4653

4654

4655

4656

4657

</div>

4658

4659

4660

4661

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

4662

4663

4664

4665

4666

4667

4668

4669

4670

4671

</li>

4672

4673

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

4674

</div>

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

</span>

4681

4682

4683

4684

4685

4686

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

4687

4688

4689

4690

4691

4692

4693

4694

4695

4696

4697

4698

<p>Inherited from

4699

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

4700

4701

4702

4703

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

4704

4705

</p>

4706

4707

4708

4709

4710

4711

</div>

4712

4713

4714

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

4715

added lazily and still requires initialization.</p>

4716

</div>

4717

4718

4719

4720

<h4>Parameters:</h4>

4721

4722

4723

4724

4725

4726

4727

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

4728

4729

4730

4731

4732

4733

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

4734

</div>

4735

4736

4737

</li>

4738

4739

</ul>

4740

</div>

4741

4742

4743

4744

4745

<h4>Returns:</h4>

4746

4747

4748

4749

4750

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

4751

4752

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

4753

4754

</div>

4755

</div>

4756

4757

4758

4759

</div>

4760

4761

4762

4763

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

4764

4765

4766

4767

4768

4769

4770

4771

4772

4773

</li>

4774

4775

4776

4777

4778

4779

</li>

4780

4781

4782

4783

4784

4785

</li>

4786

4787

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

4788

</div>

4789

4790

4791

4792

4793

4794

4795

4796

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

4797

4798

4799

4800

4801

4802

4803

4804

4805

4806

4807

4808

<p>Inherited from

4809

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

4810

4811

4812

4813

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

4814

4815

</p>

4816

4817

4818

4819

4820

4821

</div>

4822

4823

4824

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

4825

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

4826

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

4827

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

4828

be subscribed to like other events to monitor the event

4829

system. Inividual published events can have monitoring

4830

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

4831

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

4832

</div>

4833

4834

4835

4836

<h4>Parameters:</h4>

4837

4838

4839

4840

4841

4842

4843

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

4844

4845

4846

4847

4848

4849

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

4850

</div>

4851

4852

4853

</li>

4854

4855

4856

4857

4858

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

4859

4860

4861

4862

4863

4864

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

4865

</div>

4866

4867

4868

</li>

4869

4870

4871

4872

4873

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

4874

4875

4876

4877

4878

4879

<p>Information about the event interaction, such as

4880

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

4881

</div>

4882

4883

4884

</li>

4885

4886

</ul>

4887

</div>

4888

4889

4890

4891

4892

4893

</div>

4894

4895

4896

4897

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

4898

4899

4900

4901

4902

4903

4904

4905

<code>valueHash</code>

4906

4907

</li>

4908

4909

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

4910

</div>

4911

4912

4913

4914

4915

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

4916

</span>

4917

4918

4919

4920

4921

4922

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

4923

4924

4925

4926

4927

4928

4929

4930

4931

4932

4933

<p>Inherited from

4934

4935

AttributeCore

4936

</a>

4937

4938

but overwritten in

4939

4940

4941

4942

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

4943

4944

</p>

4945

4946

4947

4948

4949

4950

</div>

4951

4952

4953

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

4954

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

4955

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

4956

</div>

4957

4958

4959

4960

<h4>Parameters:</h4>

4961

4962

4963

4964

4965

4966

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

4967

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

4968

4969

4970

4971

4972

4973

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

4974

</div>

4975

4976

4977

</li>

4978

4979

</ul>

4980

</div>

4981

4982

4983

4984

4985

<h4>Returns:</h4>

4986

4987

4988

4989

4990

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

4991

4992

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

4993

containing simple and complex attribute values respectively keyed

4994

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

4995

4996

</div>

4997

</div>

4998

4999

5000

5001

</div>

5002

5003

5004

5005

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

5006

5007

5008

5009

5010

5011

5012

5013

5014

5015

5016

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

5017

5018

5019

5020

5021

5022

5023

5024

5025

5026

5027

5028

5029

<p>

5030

5031

Defined in

5032

5033

5034

5035

5036

<a href="../files/editor_js_editor-para.js.html#l19"><code>editor/js/editor-para.js:19</code></a>

5037

5038

</p>

5039

5040

5041

5042

5043

5044

</div>

5045

5046

5047

<p>nodeChange handler to handle fixing an empty document.</p>

5048

</div>

5049

5050

5051

5052

5053

5054

5055

</div>

5056

5057

5058

5059

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

5060

5061

5062

5063

5064

5065

5066

5067

5068

5069

5070

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

5071

5072

5073

5074

5075

5076

5077

5078

5079

5080

5081

5082

<p>Inherited from

5083

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

5084

5085

5086

5087

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

5088

5089

</p>

5090

5091

5092

5093

5094

5095

</div>

5096

5097

5098

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

5099

and the prefixed event name from _getType

5100

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

5101

</div>

5102

5103

5104

5105

5106

5107

5108

</div>

5109

5110

5111

5112

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

5113

5114

5115

5116

5117

5118

5119

5120

<code>config</code>

5121

5122

</li>

5123

5124

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

5125

</div>

5126

5127

5128

5129

5130

5131

5132

5133

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

5134

5135

5136

5137

5138

5139

5140

5141

5142

5143

5144

5145

<p>Inherited from

5146

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

5147

5148

5149

5150

5151

5152

</p>

5153

5154

5155

5156

5157

5158

</div>

5159

5160

5161

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

5162

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

5163

construction, prior to init.</p>

5164

</div>

5165

5166

5167

5168

<h4>Parameters:</h4>

5169

5170

5171

5172

5173

5174

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

5175

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

5176

5177

5178

5179

5180

5181

<p>The user configuration object</p>

5182

</div>

5183

5184

5185

</li>

5186

5187

</ul>

5188

</div>

5189

5190

5191

5192

5193

5194

</div>

5195

5196

5197

5198

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

5199

5200

5201

5202

5203

5204

5205

5206

<code>attrs</code>

5207

5208

</li>

5209

5210

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

5211

</div>

5212

5213

5214

5215

5216

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

5217

</span>

5218

5219

5220

5221

5222

5223

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

5224

5225

5226

5227

5228

5229

5230

5231

5232

5233

5234

5235

<p>Inherited from

5236

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

5237

5238

5239

5240

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

5241

5242

</p>

5243

5244

5245

5246

5247

5248

</div>

5249

5250

5251

<p>Utility method to protect an attribute configuration

5252

hash, by merging the entire object and the individual

5253

attr config objects.</p>

5254

</div>

5255

5256

5257

5258

<h4>Parameters:</h4>

5259

5260

5261

5262

5263

5264

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

5265

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

5266

5267

5268

5269

5270

5271

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

5272

</div>

5273

5274

5275

</li>

5276

5277

</ul>

5278

</div>

5279

5280

5281

5282

5283

<h4>Returns:</h4>

5284

5285

5286

5287

5288

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

5289

5290

A protected version of the attrs argument.

5291

5292

</div>

5293

</div>

5294

5295

5296

5297

</div>

5298

5299

5300

5301

5302

5303

5304

5305

5306

5307

5308

5309

5310

5311

</li>

5312

5313

5314

5315

5316

5317

</li>

5318

5319

5320

5321

5322

5323

</li>

5324

5325

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

5326

</div>

5327

5328

5329

5330

5331

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

5332

</span>

5333

5334

5335

5336

5337

5338

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

5339

5340

5341

5342

5343

5344

5345

5346

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

5347

5348

5349

5350

5351

<p>Inherited from

5352

5353

AttributeCore

5354

</a>

5355

5356

but overwritten in

5357

5358

5359

5360

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

5361

5362

</p>

5363

5364

5365

5366

5367

5368

</div>

5369

5370

5371

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

5372

</div>

5373

5374

5375

5376

<h4>Parameters:</h4>

5377

5378

5379

5380

5381

5382

5383

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

5384

5385

5386

5387

5388

5389

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

5390

</div>

5391

5392

5393

</li>

5394

5395

5396

5397

5398

5399

5400

5401

5402

5403

5404

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

5405

</div>

5406

5407

5408

</li>

5409

5410

5411

5412

5413

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

5414

5415

5416

5417

5418

5419

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

5420

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

5421

</div>

5422

5423

5424

</li>

5425

5426

</ul>

5427

</div>

5428

5429

5430

5431

5432

<h4>Returns:</h4>

5433

5434

5435

5436

5437

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

5438

5439

A reference to the host object.

5440

5441

</div>

5442

</div>

5443

5444

5445

5446

</div>

5447

5448

5449

5450

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

5451

5452

5453

5454

5455

5456

5457

5458

5459

5460

</li>

5461

5462

5463

5464

<code>value</code>

5465

5466

</li>

5467

5468

5469

5470

5471

5472

</li>

5473

5474

5475

5476

<code>force</code>

5477

5478

</li>

5479

5480

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

5481

</div>

5482

5483

5484

5485

5486

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

5487

</span>

5488

5489

5490

5491

5492

5493

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

5494

5495

5496

5497

5498

5499

5500

5501

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

5502

5503

5504

5505

5506

5507

<p>Inherited from

5508

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

5509

5510

5511

5512

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

5513

5514

</p>

5515

5516

5517

5518

5519

5520

</div>

5521

5522

5523

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

5524

5525

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

5526

</div>

5527

5528

5529

5530

<h4>Parameters:</h4>

5531

5532

5533

5534

5535

5536

5537

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

5538

5539

5540

5541

5542

5543

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

5544

</div>

5545

5546

5547

</li>

5548

5549

5550

5551

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

5552

5553

5554

5555

5556

5557

5558

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

5559

</div>

5560

5561

5562

</li>

5563

5564

5565

5566

5567

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

5568

5569

5570

5571

5572

5573

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

5574

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

5575

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

5576

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

5577

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

5578

</div>

5579

5580

5581

</li>

5582

5583

5584

5585

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

5586

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

5587

5588

5589

5590

5591

5592

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

5593

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

5594

</div>

5595

5596

5597

</li>

5598

5599

</ul>

5600

</div>

5601

5602

5603

5604

5605

<h4>Returns:</h4>

5606

5607

5608

5609

5610

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

5611

5612

A reference to the host object.

5613

5614

</div>

5615

</div>

5616

5617

5618

5619

</div>

5620

5621

5622

5623

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

5624

5625

5626

5627

5628

5629

5630

5631

<code>attrs</code>

5632

5633

</li>

5634

5635

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

5636

</div>

5637

5638

5639

5640

5641

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

5642

</span>

5643

5644

5645

5646

5647

5648

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

5649

5650

5651

5652

5653

5654

5655

5656

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

5657

5658

5659

5660

5661

5662

<p>Inherited from

5663

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

5664

5665

5666

5667

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

5668

5669

</p>

5670

5671

5672

5673

5674

5675

</div>

5676

5677

5678

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

5679

</div>

5680

5681

5682

5683

<h4>Parameters:</h4>

5684

5685

5686

5687

5688

5689

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

5690

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

5691

5692

5693

5694

5695

5696

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

5697

</div>

5698

5699

5700

</li>

5701

5702

</ul>

5703

</div>

5704

5705

5706

5707

5708

<h4>Returns:</h4>

5709

5710

5711

5712

5713

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

5714

5715

A reference to the host object.

5716

5717

</div>

5718

</div>

5719

5720

5721

5722

</div>

5723

5724

5725

5726

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

5727

5728

5729

5730

5731

5732

5733

5734

<code>attrName</code>

5735

5736

</li>

5737

5738

5739

5740

<code>subAttrName</code>

5741

5742

</li>

5743

5744

5745

5746

<code>prevVal</code>

5747

5748

</li>

5749

5750

5751

5752

<code>newVal</code>

5753

5754

</li>

5755

5756

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

5757

</div>

5758

5759

5760

5761

5762

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

5763

</span>

5764

5765

5766

5767

5768

5769

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

5770

5771

5772

5773

5774

5775

5776

5777

5778

5779

5780

5781

<p>Inherited from

5782

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

5783

5784

5785

5786

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

5787

5788

</p>

5789

5790

5791

5792

5793

5794

</div>

5795

5796

5797

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

5798

if validation and setter passes.</p>

5799

</div>

5800

5801

5802

5803

<h4>Parameters:</h4>

5804

5805

5806

5807

5808

5809

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

5810

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

5811

5812

5813

5814

5815

5816

<p>The attribute name.</p>

5817

</div>

5818

5819

5820

</li>

5821

5822

5823

5824

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

5825

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

5826

5827

5828

5829

5830

5831

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

5832

</div>

5833

5834

5835

</li>

5836

5837

5838

5839

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

5840

5841

5842

5843

5844

5845

5846

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

5847

</div>

5848

5849

5850

</li>

5851

5852

5853

5854

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

5855

5856

5857

5858

5859

5860

5861

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

5862

</div>

5863

5864

5865

</li>

5866

5867

</ul>

5868

</div>

5869

5870

5871

5872

5873

<h4>Returns:</h4>

5874

5875

5876

5877

5878

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

5879

5880

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

5881

5882

</div>

5883

</div>

5884

5885

5886

5887

</div>

5888

5889

5890

5891

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

5892

5893

5894

5895

5896

5897

5898

5899

5900

5901

</li>

5902

5903

5904

5905

<code>value</code>

5906

5907

</li>

5908

5909

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

5910

</div>

5911

5912

5913

5914

5915

5916

5917

5918

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

5919

5920

5921

5922

5923

5924

5925

5926

5927

5928

5929

5930

<p>Inherited from

5931

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

5932

5933

5934

5935

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

5936

5937

</p>

5938

5939

5940

5941

5942

5943

</div>

5944

5945

5946

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

5947

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

5948

</div>

5949

5950

5951

5952

<h4>Parameters:</h4>

5953

5954

5955

5956

5957

5958

5959

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

5960

5961

5962

5963

5964

5965

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

5966

</div>

5967

5968

5969

</li>

5970

5971

5972

5973

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

5974

5975

5976

5977

5978

5979

5980

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

5981

</div>

5982

5983

5984

</li>

5985

5986

</ul>

5987

</div>

5988

5989

5990

5991

5992

5993

</div>

5994

5995

5996

5997

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

5998

5999

6000

6001

6002

6003

6004

6005

6006

6007

</li>

6008

6009

6010

6011

<code>config</code>

6012

6013

</li>

6014

6015

6016

6017

6018

6019

</li>

6020

6021

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

6022

</div>

6023

6024

6025

6026

6027

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

6028

</span>

6029

6030

6031

6032

6033

6034

6035

6036

6037

6038

6039

6040

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

6041

6042

6043

6044

6045

6046

<p>Inherited from

6047

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

6048

6049

6050

6051

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

6052

6053

</p>

6054

6055

6056

6057

6058

6059

</div>

6060

6061

6062

<p>

6063

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

6064

</p>

6065

6066

<p>

6067

The config argument object supports the following properties:

6068

</p>

6069

6070

<dl>

6071

<dt>value <Any></dt>

6072

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

6073

6074

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

6075

<dd>

6076

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

6077

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

6078

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

6079

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

6080

case the value property is used.</p>

6081

6082

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

6083

</dd>

6084

6085

<dt>readOnly <boolean></dt>

6086

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

6087

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

6088

6089

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

6090

<dd>

6091

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

6092

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

6093

constructor configuration arguments, or by invoking set.

6094

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

6095

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

6096

</dd>

6097

6098

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

6099

<dd>

6100

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

6101

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

6102

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

6103

the value from being stored.

6104

</p>

6105

6106

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

6107

</dd>

6108

6109

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

6110

<dd>

6111

<p>

6112

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

6113

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

6114

invoke get.

6115

</p>

6116

6117

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

6118

</dd>

6119

6120

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

6121

<dd>

6122

<p>

6123

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

6124

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

6125

</p>

6126

6127

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

6128

</dd>

6129

6130

<dt>lazyAdd <boolean></dt>

6131

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

6132

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

6133

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

6134

6135

</dl>

6136

6137

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

6138

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

6139

6140

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

6141

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

6142

</div>

6143

6144

6145

6146

<h4>Parameters:</h4>

6147

6148

6149

6150

6151

6152

6153

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

6154

6155

6156

6157

6158

6159

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

6160

</div>

6161

6162

6163

</li>

6164

6165

6166

6167

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

6168

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

6169

6170

6171

6172

6173

6174

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

6175

6176

<p>

6177

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

6178

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

6179

</p>

6180

</div>

6181

6182

6183

</li>

6184

6185

6186

6187

6188

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

6189

6190

6191

6192

6193

6194

<p>(optional) Whether or not to add this attribute lazily (on the first call to get/set).</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>addAttrs</code></h3>

6225

6226

6227

6228

6229

6230

6231

6232

6233

6234

</li>

6235

6236

6237

6238

<code>values</code>

6239

6240

</li>

6241

6242

6243

6244

6245

6246

</li>

6247

6248

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

6249

</div>

6250

6251

6252

6253

6254

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

6255

</span>

6256

6257

6258

6259

6260

6261

6262

6263

6264

6265

6266

6267

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

6268

6269

6270

6271

6272

6273

<p>Inherited from

6274

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

6275

6276

6277

6278

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

6279

6280

</p>

6281

6282

6283

6284

6285

6286

</div>

6287

6288

6289

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

6290

6291

<p>

6292

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

6293

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

6294

</p>

6295

</div>

6296

6297

6298

6299

<h4>Parameters:</h4>

6300

6301

6302

6303

6304

6305

6306

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

6307

6308

6309

6310

6311

6312

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

6313

</div>

6314

6315

6316

</li>

6317

6318

6319

6320

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

6321

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

6322

6323

6324

6325

6326

6327

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

6328

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

6329

</div>

6330

6331

6332

</li>

6333

6334

6335

6336

6337

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

6338

6339

6340

6341

6342

6343

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

6344

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

6345

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

6346

</div>

6347

6348

6349

</li>

6350

6351

</ul>

6352

</div>

6353

6354

6355

6356

6357

<h4>Returns:</h4>

6358

6359

6360

6361

6362

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

6363

6364

A reference to the host object.

6365

6366

</div>

6367

</div>

6368

6369

6370

6371

</div>

6372

6373

6374

6375

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

6376

6377

6378

6379

6380

6381

6382

6383

6384

6385

</li>

6386

6387

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

6388

</div>

6389

6390

6391

6392

6393

6394

6395

6396

6397

6398

6399

6400

6401

6402

6403

6404

6405

6406

<p>Inherited from

6407

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

6408

6409

6410

6411

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

6412

6413

</p>

6414

6415

6416

6417

6418

6419

</div>

6420

6421

6422

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

6423

is determined by the order registered. Multiple targets can

6424

be specified.</p>

6425

6426

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

6427

6428

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

6429

</div>

6430

6431

6432

6433

<h4>Parameters:</h4>

6434

6435

6436

6437

6438

6439

6440

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

6441

6442

6443

6444

6445

6446

<p>the target to add</p>

6447

</div>

6448

6449

6450

</li>

6451

6452

</ul>

6453

</div>

6454

6455

6456

6457

6458

6459

</div>

6460

6461

6462

6463

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

6464

6465

6466

6467

6468

6469

6470

6471

6472

6473

</li>

6474

6475

6476

6477

6478

6479

</li>

6480

6481

6482

6483

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

6484

6485

</li>

6486

6487

6488

6489

6490

6491

</li>

6492

6493

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

6494

</div>

6495

6496

6497

6498

6499

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

6500

</span>

6501

6502

6503

6504

6505

6506

6507

6508

6509

6510

6511

6512

6513

6514

6515

6516

<p>Inherited from

6517

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

6518

6519

6520

6521

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

6522

6523

</p>

6524

6525

6526

6527

6528

6529

</div>

6530

6531

6532

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

6533

supplied callback will execute after any listeners add

6534

via the subscribe method, and after the default function,

6535

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

6536

</div>

6537

6538

6539

6540

<h4>Parameters:</h4>

6541

6542

6543

6544

6545

6546

6547

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

6548

6549

6550

6551

6552

6553

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

6554

</div>

6555

6556

6557

</li>

6558

6559

6560

6561

6562

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

6563

6564

6565

6566

6567

6568

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

6569

</div>

6570

6571

6572

</li>

6573

6574

6575

6576

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

6577

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

6578

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

6579

6580

6581

6582

6583

6584

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

6585

</div>

6586

6587

6588

</li>

6589

6590

6591

6592

6593

6594

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

6595

6596

6597

6598

6599

6600

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

6601

</div>

6602

6603

6604

</li>

6605

6606

</ul>

6607

</div>

6608

6609

6610

6611

6612

<h4>Returns:</h4>

6613

6614

6615

6616

6617

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

6618

6619

A subscription handle capable of detaching the

6620

subscription

6621

6622

</div>

6623

</div>

6624

6625

6626

6627

</div>

6628

6629

6630

6631

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

6632

6633

6634

6635

6636

6637

6638

6639

6640

6641

</li>

6642

6643

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

6644

</div>

6645

6646

6647

6648

6649

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

6650

</span>

6651

6652

6653

6654

6655

6656

6657

6658

6659

6660

6661

6662

6663

6664

6665

6666

<p>Inherited from

6667

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

6668

6669

6670

6671

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

6672

6673

</p>

6674

6675

6676

6677

6678

6679

</div>

6680

6681

6682

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

6683

</div>

6684

6685

6686

6687

<h4>Parameters:</h4>

6688

6689

6690

6691

6692

6693

6694

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

6695

6696

6697

6698

6699

6700

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

6701

</div>

6702

6703

6704

</li>

6705

6706

</ul>

6707

</div>

6708

6709

6710

6711

6712

<h4>Returns:</h4>

6713

6714

6715

6716

6717

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

6718

6719

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.

6720

6721

</div>

6722

</div>

6723

6724

6725

6726

</div>

6727

6728

6729

6730

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

6731

6732

6733

6734

6735

6736

6737

6738

6739

</span>

6740

6741

6742

6743

6744

6745

6746

6747

6748

6749

6750

6751

6752

6753

6754

6755

<p>Inherited from

6756

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

6757

6758

6759

6760

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

6761

6762

</p>

6763

6764

6765

6766

6767

6768

</div>

6769

6770

6771

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

6772

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

6773

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

6774

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

6775

6776

<p>For DOM and custom events:

6777

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

6778

6779

<p>For methods:

6780

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

6781

</div>

6782

6783

6784

6785

6786

6787

<h4>Returns:</h4>

6788

6789

6790

6791

6792

detach handle

6793

6794

</div>

6795

</div>

6796

6797

6798

6799

</div>

6800

6801

6802

6803

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

6804

6805

6806

6807

6808

6809

6810

6811

6812

6813

</li>

6814

6815

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

6816

</div>

6817

6818

6819

6820

6821

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

6822

</span>

6823

6824

6825

6826

6827

6828

6829

6830

6831

6832

6833

6834

6835

6836

6837

6838

<p>Inherited from

6839

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

6840

6841

6842

6843

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

6844

6845

</p>

6846

6847

6848

6849

6850

6851

</div>

6852

6853

6854

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

6855

</div>

6856

6857

6858

6859

<h4>Parameters:</h4>

6860

6861

6862

6863

6864

6865

6866

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

6867

6868

6869

6870

6871

6872

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

6873

</div>

6874

6875

6876

</li>

6877

6878

</ul>

6879

</div>

6880

6881

6882

6883

6884

<h4>Returns:</h4>

6885

6886

6887

6888

6889

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

6890

6891

the aggregated return value from Event.Custom.fire

6892

6893

</div>

6894

</div>

6895

6896

6897

6898

</div>

6899

6900

6901

6902

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

6903

6904

6905

6906

6907

6908

6909

6910

6911

</span>

6912

6913

6914

6915

6916

6917

6918

6919

6920

6921

6922

6923

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

6924

6925

6926

6927

6928

<p>Inherited from

6929

6930

BaseCore

6931

</a>

6932

6933

but overwritten in

6934

6935

6936

6937

6938

6939

</p>

6940

6941

6942

6943

6944

6945

</div>

6946

6947

6948

<p>

6949

Destroy lifecycle method. Fires the destroy

6950

event, prior to invoking destructors for the

6951

class hierarchy.

6952

</p>

6953

6954

<p>

6955

Subscribers to the destroy

6956

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

6957

from proceeding.

6958

</p>

6959

</div>

6960

6961

6962

6963

6964

6965

<h4>Returns:</h4>

6966

6967

6968

6969

6970

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

6971

6972

A reference to this object

6973

6974

</div>

6975

</div>

6976

6977

6978

6979

</div>

6980

6981

6982

6983

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

6984

6985

6986

6987

6988

6989

6990

6991

6992

6993

</li>

6994

6995

6996

6997

6998

6999

</li>

7000

7001

7002

7003

<code>context</code>

7004

7005

</li>

7006

7007

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

7008

</div>

7009

7010

7011

7012

7013

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

7014

</span>

7015

7016

7017

7018

7019

7020

7021

7022

7023

7024

7025

7026

7027

7028

7029

7030

<p>Inherited from

7031

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

7032

7033

7034

7035

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

7036

7037

</p>

7038

7039

7040

7041

7042

7043

</div>

7044

7045

7046

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

7047

</div>

7048

7049

7050

7051

<h4>Parameters:</h4>

7052

7053

7054

7055

7056

7057

7058

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

7059

7060

7061

7062

7063

7064

<p>Either the handle to the subscriber or the

7065

type of event. If the type

7066

is not specified, it will attempt to remove

7067

the listener from all hosted events.</p>

7068

</div>

7069

7070

7071

</li>

7072

7073

7074

7075

7076

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

7077

7078

7079

7080

7081

7082

<p>The subscribed function to unsubscribe, if not

7083

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

7084

</div>

7085

7086

7087

</li>

7088

7089

7090

7091

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

7092

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

7093

7094

7095

7096

7097

7098

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

7099

optional, but if supplied will be used to

7100

disambiguate multiple listeners that are the same

7101

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

7102

that lives on the prototype)</p>

7103

</div>

7104

7105

7106

</li>

7107

7108

</ul>

7109

</div>

7110

7111

7112

7113

7114

<h4>Returns:</h4>

7115

7116

7117

7118

7119

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

7120

7121

the host

7122

7123

</div>

7124

</div>

7125

7126

7127

7128

</div>

7129

7130

7131

7132

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

7133

7134

7135

7136

7137

7138

7139

7140

7141

7142

</li>

7143

7144

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

7145

</div>

7146

7147

7148

7149

7150

7151

7152

7153

7154

7155

7156

7157

7158

7159

7160

7161

7162

7163

<p>Inherited from

7164

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

7165

7166

7167

7168

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

7169

7170

</p>

7171

7172

7173

7174

7175

7176

</div>

7177

7178

7179

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

7180

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

7181

be removed.</p>

7182

</div>

7183

7184

7185

7186

<h4>Parameters:</h4>

7187

7188

7189

7190

7191

7192

7193

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

7194

7195

7196

7197

7198

7199

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

7200

</div>

7201

7202

7203

</li>

7204

7205

</ul>

7206

</div>

7207

7208

7209

7210

7211

7212

</div>

7213

7214

7215

7216

7217

7218

7219

7220

7221

7222

7223

7224

7225

7226

</li>

7227

7228

7229

7230

<code>arguments</code>

7231

7232

</li>

7233

7234

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

7235

</div>

7236

7237

7238

7239

7240

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

7241

</span>

7242

7243

7244

7245

7246

7247

7248

7249

7250

7251

7252

7253

7254

7255

7256

7257

<p>Inherited from

7258

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

7259

7260

7261

7262

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

7263

7264

</p>

7265

7266

7267

7268

7269

7270

</div>

7271

7272

7273

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

7274

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

7275

following parameters.</p>

7276

7277

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

7278

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

7279

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

7280

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

7281

be published on this object first.</p>

7282

7283

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

7284

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

7285

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

7286

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

7287

in place of the original object.</p>

7288

</div>

7289

7290

7291

7292

<h4>Parameters:</h4>

7293

7294

7295

7296

7297

7298

7299

7300

7301

7302

7303

7304

7305

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

7306

a 'type' property.</p>

7307

</div>

7308

7309

7310

</li>

7311

7312

7313

7314

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

7315

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

7316

7317

7318

7319

7320

7321

<p>an arbitrary set of parameters to pass to

7322

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

7323

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

7324

parameter after the properties the object literal contains are copied to

7325

the event facade.</p>

7326

</div>

7327

7328

7329

</li>

7330

7331

</ul>

7332

</div>

7333

7334

7335

7336

7337

<h4>Returns:</h4>

7338

7339

7340

7341

7342

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

7343

7344

the event host

7345

7346

</div>

7347

</div>

7348

7349

7350

7351

</div>

7352

7353

7354

7355

7356

7357

7358

7359

7360

7361

7362

7363

7364

7365

</li>

7366

7367

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

7368

</div>

7369

7370

7371

7372

7373

7374

</span>

7375

7376

7377

7378

7379

7380

7381

7382

7383

7384

7385

7386

7387

7388

7389

7390

<p>Inherited from

7391

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

7392

7393

7394

7395

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

7396

7397

</p>

7398

7399

7400

7401

7402

7403

</div>

7404

7405

7406

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

7407

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

7408

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

7409

</div>

7410

7411

7412

7413

<h4>Parameters:</h4>

7414

7415

7416

7417

7418

7419

7420

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

7421

7422

7423

7424

7425

7426

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

7427

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

7428

</div>

7429

7430

7431

</li>

7432

7433

</ul>

7434

</div>

7435

7436

7437

7438

7439

<h4>Returns:</h4>

7440

7441

7442

7443

7444

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

7445

7446

The value of the attribute

7447

7448

</div>

7449

</div>

7450

7451

7452

7453

</div>

7454

7455

7456

7457

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

7458

7459

7460

7461

7462

7463

7464

7465

<code>attrs</code>

7466

7467

</li>

7468

7469

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

7470

</div>

7471

7472

7473

7474

7475

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

7476

</span>

7477

7478

7479

7480

7481

7482

7483

7484

7485

7486

7487

7488

7489

7490

7491

7492

<p>Inherited from

7493

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

7494

7495

7496

7497

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

7498

7499

</p>

7500

7501

7502

7503

7504

7505

</div>

7506

7507

7508

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

7509

</div>

7510

7511

7512

7513

<h4>Parameters:</h4>

7514

7515

7516

7517

7518

7519

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

7520

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

7521

7522

7523

7524

7525

7526

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

7527

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

7528

</div>

7529

7530

7531

</li>

7532

7533

</ul>

7534

</div>

7535

7536

7537

7538

7539

<h4>Returns:</h4>

7540

7541

7542

7543

7544

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

7545

7546

An object with attribute name/value pairs.

7547

7548

</div>

7549

</div>

7550

7551

7552

7553

</div>

7554

7555

7556

7557

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

7558

7559

7560

7561

7562

7563

7564

7565

7566

7567

</li>

7568

7569

7570

7571

<code>prefixed</code>

7572

7573

</li>

7574

7575

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

7576

</div>

7577

7578

7579

7580

7581

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

7582

</span>

7583

7584

7585

7586

7587

7588

7589

7590

7591

7592

7593

7594

7595

7596

7597

7598

<p>Inherited from

7599

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

7600

7601

7602

7603

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

7604

7605

</p>

7606

7607

7608

7609

7610

7611

</div>

7612

7613

7614

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

7615

falsy value otherwise</p>

7616

</div>

7617

7618

7619

7620

<h4>Parameters:</h4>

7621

7622

7623

7624

7625

7626

7627

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

7628

7629

7630

7631

7632

7633

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

7634

</div>

7635

7636

7637

</li>

7638

7639

7640

7641

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

7642

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

7643

7644

7645

7646

7647

7648

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

7649

</div>

7650

7651

7652

</li>

7653

7654

</ul>

7655

</div>

7656

7657

7658

7659

7660

<h4>Returns:</h4>

7661

7662

7663

7664

7665

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

7666

7667

the custom event or null

7668

7669

</div>

7670

</div>

7671

7672

7673

7674

</div>

7675

7676

7677

7678

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

7679

7680

7681

7682

7683

7684

7685

7686

7687

</span>

7688

7689

7690

7691

7692

7693

7694

7695

7696

7697

7698

7699

7700

7701

7702

7703

<p>Inherited from

7704

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

7705

7706

7707

7708

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

7709

7710

</p>

7711

7712

7713

7714

7715

7716

</div>

7717

7718

7719

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

7720

</div>

7721

7722

7723

7724

7725

7726

<h4>Returns:</h4>

7727

7728

7729

7730

7731

EventTarget[]

7732

7733

</div>

7734

</div>

7735

7736

7737

7738

</div>

7739

7740

7741

7742

7743

7744

7745

7746

7747

7748

7749

7750

<code>config</code>

7751

7752

</li>

7753

7754

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

7755

</div>

7756

7757

7758

7759

7760

7761

</span>

7762

7763

7764

7765

7766

7767

7768

7769

7770

7771

7772

7773

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

7774

7775

7776

7777

7778

<p>Inherited from

7779

7780

BaseCore

7781

</a>

7782

7783

but overwritten in

7784

7785

7786

7787

7788

7789

</p>

7790

7791

7792

7793

7794

7795

</div>

7796

7797

7798

<p>Init lifecycle method, invoked during construction.

7799

Fires the init event prior to setting up attributes and

7800

invoking initializers for the class hierarchy.</p>

7801

</div>

7802

7803

7804

7805

<h4>Parameters:</h4>

7806

7807

7808

7809

7810

7811

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

7812

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

7813

7814

7815

7816

7817

7818

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

7819

</div>

7820

7821

7822

</li>

7823

7824

</ul>

7825

</div>

7826

7827

7828

7829

7830

<h4>Returns:</h4>

7831

7832

7833

7834

7835

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

7836

7837

A reference to this object

7838

7839

</div>

7840

</div>

7841

7842

7843

7844

</div>

7845

7846

7847

7848

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

7849

7850

7851

7852

7853

7854

7855

7856

7857

7858

</li>

7859

7860

7861

7862

<code>config</code>

7863

7864

</li>

7865

7866

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

7867

</div>

7868

7869

7870

7871

7872

7873

7874

7875

7876

7877

7878

7879

7880

7881

7882

7883

7884

7885

<p>Inherited from

7886

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

7887

7888

7889

7890

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

7891

7892

</p>

7893

7894

7895

7896

7897

7898

</div>

7899

7900

7901

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

7902

7903

<p>

7904

The properties which can be modified through this interface are limited

7905

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

7906

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

7907

broadcast and getter.

7908

</p>

7909

</div>

7910

7911

7912

7913

<h4>Parameters:</h4>

7914

7915

7916

7917

7918

7919

7920

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

7921

7922

7923

7924

7925

7926

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

7927

</div>

7928

7929

7930

</li>

7931

7932

7933

7934

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

7935

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

7936

7937

7938

7939

7940

7941

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

7942

</div>

7943

7944

7945

</li>

7946

7947

</ul>

7948

</div>

7949

7950

7951

7952

7953

7954

</div>

7955

7956

7957

7958

7959

7960

7961

7962

7963

7964

7965

7966

7967

7968

</li>

7969

7970

7971

7972

7973

7974

</li>

7975

7976

7977

7978

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

7979

7980

</li>

7981

7982

7983

7984

7985

7986

</li>

7987

7988

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

7989

</div>

7990

7991

7992

7993

7994

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

7995

</span>

7996

7997

7998

7999

8000

8001

8002

8003

8004

8005

8006

8007

8008

8009

8010

8011

<p>Inherited from

8012

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

8013

8014

8015

8016

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

8017

8018

</p>

8019

8020

8021

8022

8023

8024

</div>

8025

8026

8027

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

8028

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

8029

8030

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

8031

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

8032

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

8033

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

8034

API for all available properties and methods. Subscribers to

8035

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

8036

after the event name.</p>

8037

8038

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

8039

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

8040

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

8041

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

8042

8043

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

8044

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

8045

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

8046

</div>

8047

8048

8049

8050

<h4>Parameters:</h4>

8051

8052

8053

8054

8055

8056

8057

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

8058

8059

8060

8061

8062

8063

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

8064

</div>

8065

8066

8067

</li>

8068

8069

8070

8071

8072

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

8073

8074

8075

8076

8077

8078

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

8079

</div>

8080

8081

8082

</li>

8083

8084

8085

8086

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

8087

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

8088

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

8089

8090

8091

8092

8093

8094

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

8095

</div>

8096

8097

8098

</li>

8099

8100

8101

8102

8103

8104

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

8105

8106

8107

8108

8109

8110

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

8111

</div>

8112

8113

8114

</li>

8115

8116

</ul>

8117

</div>

8118

8119

8120

8121

8122

<h4>Returns:</h4>

8123

8124

8125

8126

8127

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

8128

8129

A subscription handle capable of detaching that

8130

subscription

8131

8132

</div>

8133

</div>

8134

8135

8136

8137

</div>

8138

8139

8140

8141

8142

8143

8144

8145

8146

8147

8148

8149

8150

8151

</li>

8152

8153

8154

8155

8156

8157

</li>

8158

8159

8160

8161

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

8162

8163

</li>

8164

8165

8166

8167

8168

8169

</li>

8170

8171

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

8172

</div>

8173

8174

8175

8176

8177

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

8178

</span>

8179

8180

8181

8182

8183

8184

8185

8186

8187

8188

8189

8190

8191

8192

8193

8194

<p>Inherited from

8195

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

8196

8197

8198

8199

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

8200

8201

</p>

8202

8203

8204

8205

8206

8207

</div>

8208

8209

8210

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

8211

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

8212

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

8213

</div>

8214

8215

8216

8217

<h4>Parameters:</h4>

8218

8219

8220

8221

8222

8223

8224

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

8225

8226

8227

8228

8229

8230

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

8231

</div>

8232

8233

8234

</li>

8235

8236

8237

8238

8239

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

8240

8241

8242

8243

8244

8245

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

8246

</div>

8247

8248

8249

</li>

8250

8251

8252

8253

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

8254

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

8255

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

8256

8257

8258

8259

8260

8261

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

8262

</div>

8263

8264

8265

</li>

8266

8267

8268

8269

8270

8271

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

8272

8273

8274

8275

8276

8277

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

8278

</div>

8279

8280

8281

</li>

8282

8283

</ul>

8284

</div>

8285

8286

8287

8288

8289

<h4>Returns:</h4>

8290

8291

8292

8293

8294

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

8295

8296

A subscription handle capable of detaching the

8297

subscription

8298

8299

</div>

8300

</div>

8301

8302

8303

8304

</div>

8305

8306

8307

8308

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

8309

8310

8311

8312

8313

8314

8315

8316

8317

8318

</li>

8319

8320

8321

8322

8323

8324

</li>

8325

8326

8327

8328

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

8329

8330

</li>

8331

8332

8333

8334

8335

8336

</li>

8337

8338

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

8339

</div>

8340

8341

8342

8343

8344

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

8345

</span>

8346

8347

8348

8349

8350

8351

8352

8353

8354

8355

8356

8357

8358

8359

8360

8361

<p>Inherited from

8362

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

8363

8364

8365

8366

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

8367

8368

</p>

8369

8370

8371

8372

8373

8374

</div>

8375

8376

8377

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

8378

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

8379

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

8380

</div>

8381

8382

8383

8384

<h4>Parameters:</h4>

8385

8386

8387

8388

8389

8390

8391

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

8392

8393

8394

8395

8396

8397

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

8398

</div>

8399

8400

8401

</li>

8402

8403

8404

8405

8406

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

8407

8408

8409

8410

8411

8412

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

8413

</div>

8414

8415

8416

</li>

8417

8418

8419

8420

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

8421

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

8422

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

8423

8424

8425

8426

8427

8428

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

8429

</div>

8430

8431

8432

</li>

8433

8434

8435

8436

8437

8438

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

8439

8440

8441

8442

8443

8444

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

8445

</div>

8446

8447

8448

</li>

8449

8450

</ul>

8451

</div>

8452

8453

8454

8455

8456

<h4>Returns:</h4>

8457

8458

8459

8460

8461

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

8462

8463

A subscription handle capable of detaching that

8464

subscription

8465

8466

</div>

8467

</div>

8468

8469

8470

8471

</div>

8472

8473

8474

8475

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

8476

8477

8478

8479

8480

8481

8482

8483

8484

8485

</li>

8486

8487

8488

8489

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

8490

8491

</li>

8492

8493

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

8494

</div>

8495

8496

8497

8498

8499

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

8500

</span>

8501

8502

8503

8504

8505

8506

8507

8508

8509

8510

8511

8512

8513

8514

8515

8516

<p>Inherited from

8517

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

8518

8519

8520

8521

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

8522

8523

</p>

8524

8525

8526

8527

8528

8529

<p>Available since 3.3.0</p>

8530

8531

</div>

8532

8533

8534

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

8535

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

8536

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

8537

to include the prefix one is supplied or the event target

8538

is configured with a default prefix.</p>

8539

</div>

8540

8541

8542

8543

<h4>Parameters:</h4>

8544

8545

8546

8547

8548

8549

8550

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

8551

8552

8553

8554

8555

8556

8557

</div>

8558

8559

8560

</li>

8561

8562

8563

8564

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

8565

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

8566

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

8567

8568

8569

8570

8571

8572

<p>the prefix</p>

8573

</div>

8574

8575

8576

</li>

8577

8578

</ul>

8579

</div>

8580

8581

8582

8583

8584

<h4>Returns:</h4>

8585

8586

8587

8588

8589

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

8590

8591

an array containing:

8592

* the detach category, if supplied,

8593

* the prefixed event type,

8594

* whether or not this is an after listener,

8595

* the supplied event type

8596

8597

</div>

8598

</div>

8599

8600

8601

8602

</div>

8603

8604

8605

8606

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

8607

8608

8609

8610

8611

8612

8613

8614

8615

8616

</li>

8617

8618

8619

8620

8621

8622

</li>

8623

8624

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

8625

</div>

8626

8627

8628

8629

8630

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

8631

</span>

8632

8633

8634

8635

8636

8637

8638

8639

8640

8641

8642

8643

8644

8645

8646

8647

<p>Inherited from

8648

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

8649

8650

8651

8652

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

8653

8654

</p>

8655

8656

8657

8658

8659

8660

</div>

8661

8662

8663

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

8664

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

8665

case the custom event is returned.</p>

8666

</div>

8667

8668

8669

8670

<h4>Parameters:</h4>

8671

8672

8673

8674

8675

8676

8677

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

8678

8679

8680

8681

8682

8683

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

8684

</div>

8685

8686

8687

</li>

8688

8689

8690

8691

8692

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

8693

8694

8695

8696

8697

8698

<p>optional config params. Valid properties are:</p>

8699

8700

<p><ul>

8701

<li>

8702

'broadcast': whether or not the YUI instance and YUI global are notified when the event is fired (false)

8703

</li>

8704

<li>

8705

'bubbles': whether or not this event bubbles (true)

8706

Events can only bubble if emitFacade is true.

8707

</li>

8708

<li>

8709

'context': the default execution context for the listeners (this)

8710

</li>

8711

<li>

8712

'defaultFn': the default function to execute when this event fires if preventDefault was not called

8713

</li>

8714

<li>

8715

'emitFacade': whether or not this event emits a facade (false)

8716

</li>

8717

<li>

8718

'prefix': the prefix for this targets events, e.g., 'menu' in 'menu:click'

8719

</li>

8720

<li>

8721

'fireOnce': if an event is configured to fire once, new subscribers after

8722

the fire will be notified immediately.

8723

</li>

8724

<li>

8725

'async': fireOnce event listeners will fire synchronously if the event has already

8726

fired unless async is true.

8727

</li>

8728

<li>

8729

'preventable': whether or not preventDefault() has an effect (true)

8730

</li>

8731

<li>

8732

'preventedFn': a function that is executed when preventDefault is called

8733

</li>

8734

<li>

8735

'queuable': whether or not this event can be queued during bubbling (false)

8736

</li>

8737

<li>

8738

'silent': if silent is true, debug messages are not provided for this event.

8739

</li>

8740

<li>

8741

'stoppedFn': a function that is executed when stopPropagation is called

8742

</li></p>

8743

8744

<p><li>

8745

'monitored': specifies whether or not this event should send notifications about

8746

when the event has been attached, detached, or published.

8747

</li>

8748

<li>

8749

'type': the event type (valid option if not provided as the first parameter to publish)

8750

</li>

8751

</ul></p>

8752

</div>

8753

8754

8755

</li>

8756

8757

</ul>

8758

</div>

8759

8760

8761

8762

8763

<h4>Returns:</h4>

8764

8765

8766

8767

8768

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

8769

8770

the custom event

8771

8772

</div>

8773

</div>

8774

8775

8776

8777

</div>

8778

8779

8780

8781

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

8782

8783

8784

8785

8786

8787

8788

8789

8790

8791

</li>

8792

8793

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

8794

</div>

8795

8796

8797

8798

8799

8800

8801

8802

8803

8804

8805

8806

8807

8808

8809

8810

8811

8812

<p>Inherited from

8813

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

8814

8815

8816

8817

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

8818

8819

</p>

8820

8821

8822

8823

8824

8825

</div>

8826

8827

8828

<p>Removes an attribute from the host object</p>

8829

</div>

8830

8831

8832

8833

<h4>Parameters:</h4>

8834

8835

8836

8837

8838

8839

8840

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

8841

8842

8843

8844

8845

8846

<p>The name of the attribute to be removed.</p>

8847

</div>

8848

8849

8850

</li>

8851

8852

</ul>

8853

</div>

8854

8855

8856

8857

8858

8859

</div>

8860

8861

8862

8863

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

8864

8865

8866

8867

8868

8869

8870

8871

8872

8873

</li>

8874

8875

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

8876

</div>

8877

8878

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_removeTarget">EventTarget</a>:

8896

8897

8898

8899

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

8900

8901

</p>

8902

8903

8904

8905

8906

8907

</div>

8908

8909

8910

<p>Removes a bubble target</p>

8911

</div>

8912

8913

8914

8915

<h4>Parameters:</h4>

8916

8917

8918

8919

8920

8921

8922

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

8923

8924

8925

8926

8927

8928

<p>the target to remove</p>

8929

</div>

8930

8931

8932

</li>

8933

8934

</ul>

8935

</div>

8936

8937

8938

8939

8940

8941

</div>

8942

8943

8944

8945

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

8946

8947

8948

8949

8950

8951

8952

8953

8954

8955

</li>

8956

8957

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

8958

</div>

8959

8960

8961

8962

8963

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

8964

</span>

8965

8966

8967

8968

8969

8970

8971

8972

8973

8974

8975

8976

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

8977

8978

8979

8980

8981

8982

<p>Inherited from

8983

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

8984

8985

8986

8987

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

8988

8989

</p>

8990

8991

8992

8993

8994

8995

</div>

8996

8997

8998

<p>Resets the attribute (or all attributes) to its initial value, as long as

8999

the attribute is not readOnly, or writeOnce.</p>

9000

</div>

9001

9002

9003

9004

<h4>Parameters:</h4>

9005

9006

9007

9008

9009

9010

9011

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

9012

9013

9014

9015

9016

9017

<p>Optional. The name of the attribute to reset. If omitted, all attributes are reset.</p>

9018

</div>

9019

9020

9021

</li>

9022

9023

</ul>

9024

</div>

9025

9026

9027

9028

9029

<h4>Returns:</h4>

9030

9031

9032

9033

9034

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

9035

9036

A reference to the host object.

9037

9038

</div>

9039

</div>

9040

9041

9042

9043

</div>

9044

9045

9046

9047

9048

9049

9050

9051

9052

9053

9054

9055

9056

9057

</li>

9058

9059

9060

9061

<code>value</code>

9062

9063

</li>

9064

9065

9066

9067

9068

9069

</li>

9070

9071

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

9072

</div>

9073

9074

9075

9076

9077

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

9078

</span>

9079

9080

9081

9082

9083

9084

9085

9086

9087

9088

9089

9090

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

9091

9092

9093

9094

9095

<p>Inherited from

9096

9097

AttributeCore

9098

</a>

9099

9100

but overwritten in

9101

9102

9103

9104

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

9105

9106

</p>

9107

9108

9109

9110

9111

9112

</div>

9113

9114

9115

<p>Sets the value of an attribute.</p>

9116

</div>

9117

9118

9119

9120

<h4>Parameters:</h4>

9121

9122

9123

9124

9125

9126

9127

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

9128

9129

9130

9131

9132

9133

<p>The name of the attribute. If the

9134

current value of the attribute is an Object, dot notation can be used

9135

to set the value of a property within the object (e.g. <code>set("x.y.z", 5)</code>).</p>

9136

</div>

9137

9138

9139

</li>

9140

9141

9142

9143

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

9144

9145

9146

9147

9148

9149

9150

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

9151

</div>

9152

9153

9154

</li>

9155

9156

9157

9158

9159

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

9160

9161

9162

9163

9164

9165

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

9166

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

9167

can be used as a flexible way to identify the source of a call to set, allowing

9168

the developer to distinguish between set called internally by the host, vs.

9169

set called externally by the application developer.</p>

9170

</div>

9171

9172

9173

</li>

9174

9175

</ul>

9176

</div>

9177

9178

9179

9180

9181

<h4>Returns:</h4>

9182

9183

9184

9185

9186

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

9187

9188

A reference to the host object.

9189

9190

</div>

9191

</div>

9192

9193

9194

9195

</div>

9196

9197

9198

9199

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

9200

9201

9202

9203

9204

9205

9206

9207

<code>attrs</code>

9208

9209

</li>

9210

9211

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

9212

</div>

9213

9214

9215

9216

9217

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

9218

</span>

9219

9220

9221

9222

9223

9224

9225

9226

9227

9228

9229

9230

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

9231

9232

9233

9234

9235

<p>Inherited from

9236

9237

AttributeCore

9238

</a>

9239

9240

but overwritten in

9241

9242

9243

9244

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

9245

9246

</p>

9247

9248

9249

9250

9251

9252

</div>

9253

9254

9255

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

9256

</div>

9257

9258

9259

9260

<h4>Parameters:</h4>

9261

9262

9263

9264

9265

9266

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

9267

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

9268

9269

9270

9271

9272

9273

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

9274

</div>

9275

9276

9277

</li>

9278

9279

</ul>

9280

</div>

9281

9282

9283

9284

9285

<h4>Returns:</h4>

9286

9287

9288

9289

9290

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

9291

9292

A reference to the host object.

9293

9294

</div>

9295

</div>

9296

9297

9298

9299

</div>

9300

9301

9302

9303

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

9304

9305

9306

9307

9308

9309

9310

9311

9312

<span class="flag deprecated" title="use on">deprecated</span>

9313

9314

9315

9316

9317

9318

9319

9320

9321

9322

9323

9324

9325

9326

<p>Inherited from

9327

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

9328

9329

9330

9331

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

9332

9333

</p>

9334

9335

9336

9337

<p>Deprecated: use on</p>

9338

9339

9340

9341

</div>

9342

9343

9344

<p>subscribe to an event</p>

9345

</div>

9346

9347

9348

9349

9350

9351

9352

</div>

9353

9354

9355

9356

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

9357

9358

9359

9360

9361

9362

9363

9364

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

9365

</span>

9366

9367

9368

9369

9370

9371

9372

9373

9374

9375

9376

9377

9378

9379

9380

9381

<p>Inherited from

9382

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

9383

9384

9385

9386

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

9387

9388

</p>

9389

9390

9391

9392

9393

9394

</div>

9395

9396

9397

<p>Default toString implementation. Provides the constructor NAME

9398

and the instance guid, if set.</p>

9399

</div>

9400

9401

9402

9403

9404

9405

<h4>Returns:</h4>

9406

9407

9408

9409

9410

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

9411

9412

String representation for this object

9413

9414

</div>

9415

</div>

9416

9417

9418

9419

</div>

9420

9421

9422

9423

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

9424

9425

9426

9427

9428

9429

9430

9431

9432

<span class="flag deprecated" title="use detach">deprecated</span>

9433

9434

9435

9436

9437

9438

9439

9440

9441

9442

9443

9444

9445

9446

<p>Inherited from

9447

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

9448

9449

9450

9451

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

9452

9453

</p>

9454

9455

9456

9457

<p>Deprecated: use detach</p>

9458

9459

9460

9461

</div>

9462

9463

9464

<p>detach a listener</p>

9465

</div>

9466

9467

9468

9469

9470

9471

9472

</div>

9473

9474

9475

9476

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

9477

9478

9479

9480

9481

9482

9483

9484

9485

9486

</li>

9487

9488

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

9489

</div>

9490

9491

9492

9493

9494

9495

<span class="flag deprecated" title="use detachAll">deprecated</span>

9496

9497

9498

9499

9500

9501

9502

9503

9504

9505

9506

9507

9508

9509

<p>Inherited from

9510

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

9511

9512

9513

9514

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

9515

9516

</p>

9517

9518

9519

9520

<p>Deprecated: use detachAll</p>

9521

9522

9523

9524

</div>

9525

9526

9527

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

9528

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

9529

be removed.</p>

9530

</div>

9531

9532

9533

9534

<h4>Parameters:</h4>

9535

9536

9537

9538

9539

9540

9541

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

9542

9543

9544

9545

9546

9547

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

9548

</div>

9549

9550

9551

</li>

9552

9553

</ul>

9554

</div>

9555

9556

9557

9558

9559

9560

</div>

9561

9562

9563

</div>

9564

9565

9566

9567

9568

<h2 class="off-left">Properties</h2>

9569

9570

9571

9572

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

9573

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

9574

9575

9576

9577

9578

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

9579

9580

9581

9582

9583

9584

9585

9586

9587

9588

<p>Inherited from

9589

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

9590

9591

9592

9593

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

9594

9595

</p>

9596

9597

9598

9599

9600

</div>

9601

9602

9603

<p>This property controls whether or not instances of this class should

9604

allow users to add ad-hoc attributes through the constructor configuration

9605

hash.</p>

9606

9607

<p>AdHoc attributes are attributes which are not defined by the class, and are

9608

not handled by the MyClass.<em>NON</em>ATTRS_CFG</p>

9609

</div>

9610

9611

9612

<p><strong>Default:</strong> undefined (false)</p>

9613

9614

9615

9616

9617

9618

</div>

9619

9620

9621

9622

9623

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

9624

9625

9626

9627

9628

9629

9630

9631

9632

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

9633

9634

9635

9636

9637

9638

9639

<p>

9640

9641

Defined in

9642

9643

9644

9645

9646

<a href="../files/editor_js_editor-para.js.html#l273"><code>editor/js/editor-para.js:273</code></a>

9647

9648

</p>

9649

9650

9651

9652

9653

</div>

9654

9655

9656

<p>editorPara</p>

9657

</div>

9658

9659

9660

9661

9662

9663

9664

</div>

9665

9666

9667

9668

9669

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

9670

9671

9672

<span class="flag deprecated" title="Use this.constructor.NAME">deprecated</span>

9673

9674

9675

9676

9677

9678

9679

9680

9681

9682

9683

9684

<p>Inherited from

9685

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

9686

9687

9688

9689

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

9690

9691

</p>

9692

9693

9694

<p>Deprecated: Use this.constructor.NAME</p>

9695

9696

9697

9698

</div>

9699

9700

9701

<p>The string used to identify the class of this object.</p>

9702

</div>

9703

9704

9705

9706

9707

9708

9709

</div>

9710

9711

9712

9713

9714

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

9715

9716

9717

9718

9719

9720

9721

9722

9723

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

9724

9725

9726

9727

9728

9729

9730

<p>

9731

9732

Defined in

9733

9734

9735

9736

9737

<a href="../files/editor_js_editor-para.js.html#l279"><code>editor/js/editor-para.js:279</code></a>

9738

9739

</p>

9740

9741

9742

9743

9744

</div>

9745

9746

9747

<p>editorPara</p>

9748

</div>

9749

9750

9751

9752

9753

9754

9755

</div>

9756

9757

9758

</div>

9759

9760

9761

9762

9763

<h2 class="off-left">Attributes</h2>

9764

9765

9766

9767

9768

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

9769

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

9770

9771

9772

9773

9774

9775

9776

9777

9778

9779

9780

9781

9782

<p>Inherited from

9783

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

9784

9785

9786

9787

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

9788

9789

</p>

9790

9791

9792

9793

9794

</div>

9795

9796

9797

<p>Flag indicating whether or not this object

9798

has been through the destroy lifecycle phase.</p>

9799

</div>

9800

9801

9802

<p><strong>Default:</strong> false</p>

9803

9804

9805

9806

9807

<h4>Fires event <code>destroyedChange</code></h4>

9808

9809

<p>

9810

Fires when the value for the configuration attribute <code>destroyed</code> is

9811

changed. You can listen for the event using the <code>on</code> method if you

9812

wish to be notified before the attribute's value has changed, or

9813

using the <code>after</code> method if you wish to be notified after the

9814

attribute's value has changed.

9815

</p>

9816

9817

9818

<h4>Parameters:</h4>

9819

9820

9821

9822

9823

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

9824

9825

9826

An Event Facade object with the following

9827

attribute-specific properties added:

9828

</div>

9829

9830

9831

9832

<code class="param-name">prevVal</code>

9833

9834

<div class="param-description">The value of the attribute, prior to it being set.</div>

9835

</li>

9836

9837

<code class="param-name">newVal</code>

9838

9839

<div class="param-description">The value the attribute is to be set to.</div>

9840

</li>

9841

9842

<code class="param-name">attrName</code>

9843

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

9844

<div class="param-description">The name of the attribute being set.</div>

9845

</li>

9846

9847

<code class="param-name">subAttrName</code>

9848

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

9849

<div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div>

9850

</li>

9851

</ul>

9852

</li>

9853

</ul>

9854

</div>

9855

</div>

9856

9857

9858

9859

</div>

9860

9861

9862

9863

9864

<h3 class="name"><code>initialized</code></h3>

9865

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>

9866

9867

9868

9869

9870

9871

9872

9873

9874

9875

9876

9877

9878

<p>Inherited from

9879

<a href="../classes/BaseCore.html#attr_initialized">BaseCore</a>:

9880

9881

9882

9883

<a href="../files/base_js_BaseCore.js.html#l143"><code>base/js/BaseCore.js:143</code></a>

9884

9885

</p>

9886

9887

9888

9889

9890

</div>

9891

9892

9893

<p>Flag indicating whether or not this object

9894

has been through the init lifecycle phase.</p>

9895

</div>

9896

9897

9898

<p><strong>Default:</strong> false</p>

9899

9900

9901

9902

9903

<h4>Fires event <code>initializedChange</code></h4>

9904

9905

<p>

9906

Fires when the value for the configuration attribute <code>initialized</code> is

9907

changed. You can listen for the event using the <code>on</code> method if you

9908

wish to be notified before the attribute's value has changed, or

9909

using the <code>after</code> method if you wish to be notified after the

9910

attribute's value has changed.

9911

</p>

9912

9913

9914

<h4>Parameters:</h4>

9915

9916

9917

9918

9919

<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>

9920

9921

9922

An Event Facade object with the following

9923

attribute-specific properties added:

9924

</div>

9925

9926

9927

9928

<code class="param-name">prevVal</code>

9929

9930

<div class="param-description">The value of the attribute, prior to it being set.</div>

9931

</li>

9932

9933

<code class="param-name">newVal</code>

9934

9935

<div class="param-description">The value the attribute is to be set to.</div>

9936

</li>

9937

9938

<code class="param-name">attrName</code>

9939

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

9940

<div class="param-description">The name of the attribute being set.</div>

9941

</li>

9942

9943

<code class="param-name">subAttrName</code>

9944

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

9945

<div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div>

9946

</li>

9947

</ul>

9948

</li>

9949

</ul>

9950

</div>

9951

</div>

9952

9953

9954

9955

</div>

9956

9957

9958

</div>

9959

9960

9961

9962

9963

<h2 class="off-left">Events</h2>

9964

9965

9966

9967

<h3 class="name"><code>destroy</code></h3>

9968

9969

9970

9971

9972

9973

9974

9975

9976

9977

9978

9979

9980

9981

<p>Inherited from

9982

<a href="../classes/Base.html#event_destroy">Base</a>:

9983

9984

9985

9986

9987

9988

</p>

9989

9990

9991

9992

9993

</div>

9994

9995

9996

<p>

9997

Lifecycle event for the destroy phase,

9998

fired prior to destruction. Invoking the preventDefault

9999

method on the event object provided to subscribers will

10000

prevent destruction from proceeding.

10001

</p>

10002

10003

<p>

10004

Subscribers to the "after" moment of this event, will be notified

10005

after destruction is complete (and as a result cannot prevent

10006

destruction).

10007

</p>

10008

</div>

10009

10010

10011

10012

<h4>Event Payload:</h4>

10013

10014

10015

10016

10017

10018

10019

<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>

10020

10021

10022

10023

10024

10025

<p>Event object</p>

10026

</div>

10027

10028

10029

</li>

10030

10031

</ul>

10032

</div>

10033

10034

10035

10036

10037

</div>

10038

10039

10040

10041

10042

10043

10044

10045

10046

10047

10048

10049

10050

10051

10052

10053

10054

10055

<p>Inherited from

10056

<a href="../classes/Base.html#event_init">Base</a>:

10057

10058

10059

10060

10061

10062

</p>

10063

10064

10065

10066

10067

</div>

10068

10069

10070

<p>

10071

Lifecycle event for the init phase, fired prior to initialization.

10072

Invoking the preventDefault() method on the event object provided

10073

to subscribers will prevent initialization from occuring.

10074

</p>

10075

10076

<p>

10077

Subscribers to the "after" momemt of this event, will be notified

10078

after initialization of the object is complete (and therefore

10079

cannot prevent initialization).

10080

</p>

10081

</div>

10082

10083

10084

10085

<h4>Event Payload:</h4>

10086

10087

10088

10089

10090

10091

10092

<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>

10093

10094

10095

10096

10097

10098

<p>Event object, with a cfg property which

10099

refers to the configuration object passed to the constructor.</p>

10100

</div>

10101

10102

10103

</li>

10104

10105

</ul>

10106

</div>

10107

10108

10109

10110

10111

</div>

10112

10113

10114

</div>

10115

10116

</div>

10117

</div>

10118

10119

</div>

10120

</div>

10121

</div>

10122

</div>

10123

</div>

10124

</div>

10125

10126

10127

10128

10129

10130

10131

10132

10133

</body>

10134

</html>

Older »