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

2014

2015

2016

2017

2018

2019

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

2020

</div>

2021

2022

2023

</li>

2024

2025

2026

2027

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

2028

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

2029

2030

2031

2032

2033

2034

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

2035

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

2036

</div>

2037

2038

2039

</li>

2040

2041

2042

2043

2044

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

2045

2046

2047

2048

2049

2050

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

2051

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

2052

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

2053

</div>

2054

2055

2056

</li>

2057

2058

</ul>

2059

</div>

2060

2061

2062

2063

2064

2065

</div>

2066

2067

2068

2069

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

2070

2071

2072

2073

2074

2075

2076

2077

2078

2079

</li>

2080

2081

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

2082

</div>

2083

2084

2085

2086

2087

2088

2089

2090

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

2091

2092

2093

2094

2095

2096

2097

2098

2099

2100

2101

2102

<p>Inherited from

2103

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

2104

2105

2106

2107

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

2108

2109

</p>

2110

2111

2112

2113

2114

2115

</div>

2116

2117

2118

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

2119

</div>

2120

2121

2122

2123

<h4>Parameters:</h4>

2124

2125

2126

2127

2128

2129

2130

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

2131

2132

2133

2134

2135

2136

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

2137

</div>

2138

2139

2140

</li>

2141

2142

</ul>

2143

</div>

2144

2145

2146

2147

2148

2149

</div>

2150

2151

2152

2153

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

2154

2155

2156

2157

2158

2159

2160

2161

<code>allAttrs</code>

2162

2163

</li>

2164

2165

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

2166

</div>

2167

2168

2169

2170

2171

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

2172

</span>

2173

2174

2175

2176

2177

2178

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

2179

2180

2181

2182

2183

2184

2185

2186

2187

2188

2189

2190

<p>Inherited from

2191

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

2192

2193

2194

2195

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

2196

2197

</p>

2198

2199

2200

2201

2202

2203

</div>

2204

2205

2206

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

2207

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

2208

2209

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

2210

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

2211

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

2212

</div>

2213

2214

2215

2216

<h4>Parameters:</h4>

2217

2218

2219

2220

2221

2222

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

2223

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

2224

2225

2226

2227

2228

2229

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

2230

(subclass first, Base last)</p>

2231

</div>

2232

2233

2234

</li>

2235

2236

</ul>

2237

</div>

2238

2239

2240

2241

2242

<h4>Returns:</h4>

2243

2244

2245

2246

2247

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

2248

2249

The aggregate set of ATTRS definitions for the instance

2250

2251

</div>

2252

</div>

2253

2254

2255

2256

</div>

2257

2258

2259

2260

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

2261

2262

2263

2264

2265

2266

2267

2268

2269

2270

2271

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

2272

2273

2274

2275

2276

2277

2278

2279

2280

2281

2282

<p>Inherited from

2283

2284

BaseCore

2285

</a>

2286

2287

but overwritten in

2288

2289

2290

2291

2292

2293

</p>

2294

2295

2296

2297

2298

2299

</div>

2300

2301

2302

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

2303

this class.</p>

2304

</div>

2305

2306

2307

2308

2309

2310

2311

</div>

2312

2313

2314

2315

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

2316

2317

2318

2319

2320

2321

2322

2323

2324

2325

2326

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

2327

2328

2329

2330

2331

2332

2333

2334

2335

2336

2337

2338

<p>Inherited from

2339

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

2340

2341

2342

2343

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

2344

2345

</p>

2346

2347

2348

2349

2350

2351

</div>

2352

2353

2354

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

2355

</div>

2356

2357

2358

2359

2360

2361

2362

</div>

2363

2364

2365

2366

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

2367

2368

2369

2370

2371

2372

2373

2374

2375

2376

2377

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

2378

2379

2380

2381

2382

2383

2384

2385

2386

2387

2388

2389

<p>Inherited from

2390

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

2391

2392

2393

2394

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

2395

2396

</p>

2397

2398

2399

2400

2401

2402

</div>

2403

2404

2405

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

2406

</div>

2407

2408

2409

2410

2411

2412

2413

</div>

2414

2415

2416

2417

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

2418

2419

2420

2421

2422

2423

2424

2425

2426

2427

</li>

2428

2429

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

2430

</div>

2431

2432

2433

2434

2435

2436

2437

2438

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

2439

2440

2441

2442

2443

2444

2445

2446

2447

2448

2449

2450

<p>Inherited from

2451

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

2452

2453

2454

2455

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

2456

2457

</p>

2458

2459

2460

2461

2462

2463

</div>

2464

2465

2466

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

2467

</div>

2468

2469

2470

2471

<h4>Parameters:</h4>

2472

2473

2474

2475

2476

2477

2478

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

2479

2480

2481

2482

2483

2484

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

2485

</div>

2486

2487

2488

</li>

2489

2490

</ul>

2491

</div>

2492

2493

2494

2495

2496

2497

</div>

2498

2499

2500

2501

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

2502

2503

2504

2505

2506

2507

2508

2509

2510

2511

</li>

2512

2513

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

2514

</div>

2515

2516

2517

2518

2519

2520

2521

2522

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

2523

2524

2525

2526

2527

2528

2529

2530

2531

2532

2533

2534

<p>Inherited from

2535

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

2536

2537

2538

2539

2540

2541

</p>

2542

2543

2544

2545

2546

2547

</div>

2548

2549

2550

<p>Default destroy event handler</p>

2551

</div>

2552

2553

2554

2555

<h4>Parameters:</h4>

2556

2557

2558

2559

2560

2561

2562

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

2563

2564

2565

2566

2567

2568

<p>Event object</p>

2569

</div>

2570

2571

2572

</li>

2573

2574

</ul>

2575

</div>

2576

2577

2578

2579

2580

2581

</div>

2582

2583

2584

2585

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

2586

2587

2588

2589

2590

2591

2592

2593

2594

2595

</li>

2596

2597

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

2598

</div>

2599

2600

2601

2602

2603

2604

2605

2606

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

2607

2608

2609

2610

2611

2612

2613

2614

2615

2616

2617

2618

<p>Inherited from

2619

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

2620

2621

2622

2623

2624

2625

</p>

2626

2627

2628

2629

2630

2631

</div>

2632

2633

2634

<p>Default init event handler</p>

2635

</div>

2636

2637

2638

2639

<h4>Parameters:</h4>

2640

2641

2642

2643

2644

2645

2646

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

2647

2648

2649

2650

2651

2652

<p>Event object, with a cfg property which

2653

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

2654

</div>

2655

2656

2657

</li>

2658

2659

</ul>

2660

</div>

2661

2662

2663

2664

2665

2666

</div>

2667

2668

2669

2670

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

2671

2672

2673

2674

2675

2676

2677

2678

2679

2680

2681

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

2682

2683

2684

2685

2686

2687

2688

2689

2690

2691

2692

2693

<p>Inherited from

2694

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

2695

2696

2697

2698

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

2699

2700

</p>

2701

2702

2703

2704

2705

2706

</div>

2707

2708

2709

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

2710

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

2711

</div>

2712

2713

2714

2715

2716

2717

2718

</div>

2719

2720

2721

2722

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

2723

2724

2725

2726

2727

2728

2729

2730

<code>allAttrs</code>

2731

2732

</li>

2733

2734

2735

2736

<code>userVals</code>

2737

2738

</li>

2739

2740

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

2741

</div>

2742

2743

2744

2745

2746

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

2747

</span>

2748

2749

2750

2751

2752

2753

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

2754

2755

2756

2757

2758

2759

2760

2761

2762

2763

2764

2765

<p>Inherited from

2766

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

2767

2768

2769

2770

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

2771

2772

</p>

2773

2774

2775

2776

2777

2778

</div>

2779

2780

2781

2782

</div>

2783

2784

2785

2786

<h4>Parameters:</h4>

2787

2788

2789

2790

2791

2792

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

2793

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

2794

2795

2796

2797

2798

2799

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

2800

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

2801

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

2802

</div>

2803

2804

2805

</li>

2806

2807

2808

2809

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

2810

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

2811

2812

2813

2814

2815

2816

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

2817

</div>

2818

2819

2820

</li>

2821

2822

</ul>

2823

</div>

2824

2825

2826

2827

2828

<h4>Returns:</h4>

2829

2830

2831

2832

2833

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

2834

2835

The set of adhoc attributes passed in, in the form

2836

of an object with attribute name/configuration pairs.

2837

2838

</div>

2839

</div>

2840

2841

2842

2843

</div>

2844

2845

2846

2847

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

2848

2849

2850

2851

2852

2853

2854

2855

<code>clazz</code>

2856

2857

</li>

2858

2859

2860

2861

<code>allCfgs</code>

2862

2863

</li>

2864

2865

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

2866

</div>

2867

2868

2869

2870

2871

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

2872

</span>

2873

2874

2875

2876

2877

2878

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

2879

2880

2881

2882

2883

2884

2885

2886

2887

2888

2889

2890

<p>Inherited from

2891

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

2892

2893

2894

2895

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

2896

2897

</p>

2898

2899

2900

2901

2902

2903

</div>

2904

2905

2906

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

2907

initialization. Returns a disposable object with the attributes defined for

2908

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

2909

</div>

2910

2911

2912

2913

<h4>Parameters:</h4>

2914

2915

2916

2917

2918

2919

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

2920

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

2921

2922

2923

2924

2925

2926

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

2927

</div>

2928

2929

2930

</li>

2931

2932

2933

2934

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

2935

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

2936

2937

2938

2939

2940

2941

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

2942

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

2943

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

2944

</div>

2945

2946

2947

</li>

2948

2949

</ul>

2950

</div>

2951

2952

2953

2954

2955

<h4>Returns:</h4>

2956

2957

2958

2959

2960

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

2961

2962

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

2963

of an object with attribute name/configuration pairs.

2964

2965

</div>

2966

</div>

2967

2968

2969

2970

</div>

2971

2972

2973

2974

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

2975

2976

2977

2978

2979

2980

2981

2982

<code>attrName</code>

2983

2984

</li>

2985

2986

2987

2988

<code>subAttrName</code>

2989

2990

</li>

2991

2992

2993

2994

<code>currVal</code>

2995

2996

</li>

2997

2998

2999

3000

<code>newVal</code>

3001

3002

</li>

3003

3004

3005

3006

3007

3008

</li>

3009

3010

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

3011

</div>

3012

3013

3014

3015

3016

3017

3018

3019

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

3020

3021

3022

3023

3024

3025

3026

3027

3028

3029

3030

3031

<p>Inherited from

3032

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

3033

3034

3035

3036

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

3037

3038

</p>

3039

3040

3041

3042

3043

3044

</div>

3045

3046

3047

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

3048

</div>

3049

3050

3051

3052

<h4>Parameters:</h4>

3053

3054

3055

3056

3057

3058

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

3059

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

3060

3061

3062

3063

3064

3065

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

3066

</div>

3067

3068

3069

</li>

3070

3071

3072

3073

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

3074

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

3075

3076

3077

3078

3079

3080

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

3081

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

3082

</div>

3083

3084

3085

</li>

3086

3087

3088

3089

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

3090

3091

3092

3093

3094

3095

3096

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

3097

</div>

3098

3099

3100

</li>

3101

3102

3103

3104

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

3105

3106

3107

3108

3109

3110

3111

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

3112

</div>

3113

3114

3115

</li>

3116

3117

3118

3119

3120

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

3121

3122

3123

3124

3125

3126

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

3127

</div>

3128

3129

3130

</li>

3131

3132

</ul>

3133

</div>

3134

3135

3136

3137

3138

3139

</div>

3140

3141

3142

3143

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

3144

3145

3146

3147

3148

3149

3150

3151

3152

3153

</li>

3154

3155

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

3156

</div>

3157

3158

3159

3160

3161

3162

</span>

3163

3164

3165

3166

3167

3168

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

3169

3170

3171

3172

3173

3174

3175

3176

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

3177

3178

3179

3180

3181

3182

<p>Inherited from

3183

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

3184

3185

3186

3187

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

3188

3189

</p>

3190

3191

3192

3193

3194

3195

</div>

3196

3197

3198

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

3199

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

3200

3201

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

3202

</div>

3203

3204

3205

3206

<h4>Parameters:</h4>

3207

3208

3209

3210

3211

3212

3213

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

3214

3215

3216

3217

3218

3219

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

3220

</div>

3221

3222

3223

</li>

3224

3225

</ul>

3226

</div>

3227

3228

3229

3230

3231

<h4>Returns:</h4>

3232

3233

3234

3235

3236

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

3237

3238

The value of the attribute.

3239

3240

</div>

3241

</div>

3242

3243

3244

3245

</div>

3246

3247

3248

3249

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

3250

3251

3252

3253

3254

3255

3256

3257

3258

3259

</li>

3260

3261

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

3262

</div>

3263

3264

3265

3266

3267

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

3268

</span>

3269

3270

3271

3272

3273

3274

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

3275

3276

3277

3278

3279

3280

3281

3282

3283

3284

3285

3286

<p>Inherited from

3287

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

3288

3289

3290

3291

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

3292

3293

</p>

3294

3295

3296

3297

3298

3299

</div>

3300

3301

3302

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

3303

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

3304

configuration properties for all attributes.</p>

3305

</div>

3306

3307

3308

3309

<h4>Parameters:</h4>

3310

3311

3312

3313

3314

3315

3316

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

3317

3318

3319

3320

3321

3322

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

3323

</div>

3324

3325

3326

</li>

3327

3328

</ul>

3329

</div>

3330

3331

3332

3333

3334

<h4>Returns:</h4>

3335

3336

3337

3338

3339

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

3340

3341

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

3342

3343

</div>

3344

</div>

3345

3346

3347

3348

</div>

3349

3350

3351

3352

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

3353

3354

3355

3356

3357

3358

3359

3360

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

3361

</span>

3362

3363

3364

3365

3366

3367

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

3368

3369

3370

3371

3372

3373

3374

3375

3376

3377

3378

3379

<p>Inherited from

3380

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

3381

3382

3383

3384

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

3385

3386

</p>

3387

3388

3389

3390

3391

3392

</div>

3393

3394

3395

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

3396

the class hierarchy.</p>

3397

</div>

3398

3399

3400

3401

3402

3403

<h4>Returns:</h4>

3404

3405

3406

3407

3408

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

3409

3410

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

3411

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

3412

the cached value.

3413

3414

</div>

3415

</div>

3416

3417

3418

3419

</div>

3420

3421

3422

3423

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

3424

3425

3426

3427

3428

3429

3430

3431

3432

3433

</li>

3434

3435

3436

3437

3438

3439

</li>

3440

3441

3442

3443

<code>initValues</code>

3444

3445

</li>

3446

3447

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

3448

</div>

3449

3450

3451

3452

3453

3454

</span>

3455

3456

3457

3458

3459

3460

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

3461

3462

3463

3464

3465

3466

3467

3468

3469

3470

3471

<p>Inherited from

3472

3473

AttributeCore

3474

</a>

3475

3476

but overwritten in

3477

3478

3479

3480

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

3481

3482

</p>

3483

3484

3485

3486

3487

3488

</div>

3489

3490

3491

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

3492

either the default configuration provided, or the

3493

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

3494

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

3495

</div>

3496

3497

3498

3499

<h4>Parameters:</h4>

3500

3501

3502

3503

3504

3505

3506

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

3507

3508

3509

3510

3511

3512

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

3513

</div>

3514

3515

3516

</li>

3517

3518

3519

3520

3521

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

3522

3523

3524

3525

3526

3527

<p>The attribute configuration object</p>

3528

</div>

3529

3530

3531

</li>

3532

3533

3534

3535

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

3536

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

3537

3538

3539

3540

3541

3542

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

3543

</div>

3544

3545

3546

</li>

3547

3548

</ul>

3549

</div>

3550

3551

3552

3553

3554

<h4>Returns:</h4>

3555

3556

3557

3558

3559

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

3560

3561

The initial value of the attribute.

3562

3563

</div>

3564

</div>

3565

3566

3567

3568

</div>

3569

3570

3571

3572

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

3573

3574

3575

3576

3577

3578

3579

3580

<code>attrs</code>

3581

3582

</li>

3583

3584

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

3585

</div>

3586

3587

3588

3589

3590

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

3591

</span>

3592

3593

3594

3595

3596

3597

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

3598

3599

3600

3601

3602

3603

3604

3605

3606

3607

3608

3609

<p>Inherited from

3610

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

3611

3612

3613

3614

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

3615

3616

</p>

3617

3618

3619

3620

3621

3622

</div>

3623

3624

3625

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

3626

</div>

3627

3628

3629

3630

<h4>Parameters:</h4>

3631

3632

3633

3634

3635

3636

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

3637

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

3638

3639

3640

3641

3642

3643

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

3644

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

3645

</div>

3646

3647

3648

</li>

3649

3650

</ul>

3651

</div>

3652

3653

3654

3655

3656

<h4>Returns:</h4>

3657

3658

3659

3660

3661

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

3662

3663

An object with attribute name/value pairs.

3664

3665

</div>

3666

</div>

3667

3668

3669

3670

</div>

3671

3672

3673

3674

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

3675

3676

3677

3678

3679

3680

3681

3682

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

3683

</span>

3684

3685

3686

3687

3688

3689

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

3690

3691

3692

3693

3694

3695

3696

3697

3698

3699

3700

3701

<p>Inherited from

3702

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

3703

3704

3705

3706

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

3707

3708

</p>

3709

3710

3711

3712

3713

3714

</div>

3715

3716

3717

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

3718

</div>

3719

3720

3721

3722

3723

3724

<h4>Returns:</h4>

3725

3726

3727

3728

3729

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

3730

3731

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

3732

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

3733

cached value.

3734

3735

</div>

3736

</div>

3737

3738

3739

3740

</div>

3741

3742

3743

3744

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

3745

3746

3747

3748

3749

3750

3751

3752

3753

3754

</li>

3755

3756

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

3757

</div>

3758

3759

3760

3761

3762

3763

</span>

3764

3765

3766

3767

3768

3769

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

3770

3771

3772

3773

3774

3775

3776

3777

3778

3779

3780

3781

<p>Inherited from

3782

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

3783

3784

3785

3786

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

3787

3788

</p>

3789

3790

3791

3792

3793

3794

</div>

3795

3796

3797

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

3798

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

3799

</div>

3800

3801

3802

3803

<h4>Parameters:</h4>

3804

3805

3806

3807

3808

3809

3810

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

3811

3812

3813

3814

3815

3816

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

3817

</div>

3818

3819

3820

</li>

3821

3822

</ul>

3823

</div>

3824

3825

3826

3827

3828

<h4>Returns:</h4>

3829

3830

3831

3832

3833

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

3834

3835

The stored value of the attribute

3836

3837

</div>

3838

</div>

3839

3840

3841

3842

</div>

3843

3844

3845

3846

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

3847

3848

3849

3850

3851

3852

3853

3854

3855

3856

3857

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

3858

3859

3860

3861

3862

3863

3864

3865

3866

3867

3868

3869

<p>Inherited from

3870

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

3871

3872

3873

3874

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

3875

3876

</p>

3877

3878

3879

3880

3881

3882

</div>

3883

3884

3885

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

3886

event type is not prefixed, the instance prefix is

3887

applied to the supplied type.</p>

3888

</div>

3889

3890

3891

3892

3893

3894

3895

</div>

3896

3897

3898

3899

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

3900

3901

3902

3903

3904

3905

3906

3907

<code>attrs</code>

3908

3909

</li>

3910

3911

3912

3913

<code>values</code>

3914

3915

</li>

3916

3917

3918

3919

3920

3921

</li>

3922

3923

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

3924

</div>

3925

3926

3927

3928

3929

3930

3931

3932

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

3933

3934

3935

3936

3937

3938

3939

3940

3941

3942

3943

3944

<p>Inherited from

3945

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

3946

3947

3948

3949

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

3950

3951

</p>

3952

3953

3954

3955

3956

3957

</div>

3958

3959

3960

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

3961

constructor.</p>

3962

</div>

3963

3964

3965

3966

<h4>Parameters:</h4>

3967

3968

3969

3970

3971

3972

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

3973

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

3974

3975

3976

3977

3978

3979

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

3980

</div>

3981

3982

3983

</li>

3984

3985

3986

3987

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

3988

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

3989

3990

3991

3992

3993

3994

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

3995

</div>

3996

3997

3998

</li>

3999

4000

4001

4002

4003

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

4004

4005

4006

4007

4008

4009

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

4010

</div>

4011

4012

4013

</li>

4014

4015

</ul>

4016

</div>

4017

4018

4019

4020

4021

4022

</div>

4023

4024

4025

4026

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

4027

4028

4029

4030

4031

4032

4033

4034

4035

4036

4037

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

4038

4039

4040

4041

4042

4043

4044

4045

4046

4047

4048

<p>Inherited from

4049

4050

BaseCore

4051

</a>

4052

4053

but overwritten in

4054

4055

4056

4057

4058

4059

</p>

4060

4061

4062

4063

4064

4065

</div>

4066

4067

4068

<p>Initializes Attribute</p>

4069

</div>

4070

4071

4072

4073

4074

4075

4076

</div>

4077

4078

4079

4080

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

4081

4082

4083

4084

4085

4086

4087

4088

<code>attrs</code>

4089

4090

</li>

4091

4092

4093

4094

<code>values</code>

4095

4096

</li>

4097

4098

4099

4100

4101

4102

</li>

4103

4104

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

4105

</div>

4106

4107

4108

4109

4110

4111

4112

4113

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

4114

4115

4116

4117

4118

4119

4120

4121

4122

4123

4124

4125

<p>Inherited from

4126

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

4127

4128

4129

4130

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

4131

4132

</p>

4133

4134

4135

4136

4137

4138

</div>

4139

4140

4141

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

4142

</div>

4143

4144

4145

4146

<h4>Parameters:</h4>

4147

4148

4149

4150

4151

4152

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

4153

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

4154

4155

4156

4157

4158

4159

4160

</div>

4161

4162

4163

</li>

4164

4165

4166

4167

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

4168

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

4169

4170

4171

4172

4173

4174

4175

</div>

4176

4177

4178

</li>

4179

4180

4181

4182

4183

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

4184

4185

4186

4187

4188

4189

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

4190

</div>

4191

4192

4193

</li>

4194

4195

</ul>

4196

</div>

4197

4198

4199

4200

4201

4202

</div>

4203

4204

4205

4206

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

4207

4208

4209

4210

4211

4212

4213

4214

<code>config</code>

4215

4216

</li>

4217

4218

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

4219

</div>

4220

4221

4222

4223

4224

4225

4226

4227

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

4228

4229

4230

4231

4232

4233

4234

4235

4236

4237

4238

<p>Inherited from

4239

4240

BaseCore

4241

</a>

4242

4243

but overwritten in

4244

4245

4246

4247

4248

4249

</p>

4250

4251

4252

4253

4254

4255

</div>

4256

4257

4258

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

4259

</div>

4260

4261

4262

4263

<h4>Parameters:</h4>

4264

4265

4266

4267

4268

4269

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

4270

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

4271

4272

4273

4274

4275

4276

<p>The constructor configuration object</p>

4277

</div>

4278

4279

4280

</li>

4281

4282

</ul>

4283

</div>

4284

4285

4286

4287

4288

4289

</div>

4290

4291

4292

4293

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

4294

4295

4296

4297

4298

4299

4300

4301

<code>userVals</code>

4302

4303

</li>

4304

4305

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

4306

</div>

4307

4308

4309

4310

4311

4312

4313

4314

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

4315

4316

4317

4318

4319

4320

4321

4322

4323

4324

4325

4326

<p>Inherited from

4327

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

4328

4329

4330

4331

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

4332

4333

</p>

4334

4335

4336

4337

4338

4339

</div>

4340

4341

4342

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

4343

initializing attributes for each class defined in the class's

4344

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

4345

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

4346

</div>

4347

4348

4349

4350

<h4>Parameters:</h4>

4351

4352

4353

4354

4355

4356

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

4357

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

4358

4359

4360

4361

4362

4363

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

4364

</div>

4365

4366

4367

</li>

4368

4369

</ul>

4370

</div>

4371

4372

4373

4374

4375

4376

</div>

4377

4378

4379

4380

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

4381

4382

4383

4384

4385

4386

4387

4388

4389

4390

4391

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

4392

4393

4394

4395

4396

4397

4398

4399

4400

4401

4402

4403

<p>Inherited from

4404

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

4405

4406

4407

4408

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

4409

4410

</p>

4411

4412

4413

4414

4415

4416

</div>

4417

4418

4419

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

4420

the array of classes and aggregate set of attribute configurations

4421

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

4422

</div>

4423

4424

4425

4426

4427

4428

4429

</div>

4430

4431

4432

4433

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

4434

4435

4436

4437

4438

4439

4440

4441

4442

4443

</li>

4444

4445

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

4446

</div>

4447

4448

4449

4450

4451

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

4452

</span>

4453

4454

4455

4456

4457

4458

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

4459

4460

4461

4462

4463

4464

4465

4466

4467

4468

4469

4470

<p>Inherited from

4471

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

4472

4473

4474

4475

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

4476

4477

</p>

4478

4479

4480

4481

4482

4483

</div>

4484

4485

4486

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

4487

added lazily and still requires initialization.</p>

4488

</div>

4489

4490

4491

4492

<h4>Parameters:</h4>

4493

4494

4495

4496

4497

4498

4499

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

4500

4501

4502

4503

4504

4505

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

4506

</div>

4507

4508

4509

</li>

4510

4511

</ul>

4512

</div>

4513

4514

4515

4516

4517

<h4>Returns:</h4>

4518

4519

4520

4521

4522

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

4523

4524

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

4525

4526

</div>

4527

</div>

4528

4529

4530

4531

</div>

4532

4533

4534

4535

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

4536

4537

4538

4539

4540

4541

4542

4543

4544

4545

</li>

4546

4547

4548

4549

4550

4551

</li>

4552

4553

4554

4555

4556

4557

</li>

4558

4559

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

4560

</div>

4561

4562

4563

4564

4565

4566

4567

4568

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

4569

4570

4571

4572

4573

4574

4575

4576

4577

4578

4579

4580

<p>Inherited from

4581

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

4582

4583

4584

4585

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

4586

4587

</p>

4588

4589

4590

4591

4592

4593

</div>

4594

4595

4596

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

4597

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

4598

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

4599

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

4600

be subscribed to like other events to monitor the event

4601

system. Inividual published events can have monitoring

4602

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

4603

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

4604

</div>

4605

4606

4607

4608

<h4>Parameters:</h4>

4609

4610

4611

4612

4613

4614

4615

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

4616

4617

4618

4619

4620

4621

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

4622

</div>

4623

4624

4625

</li>

4626

4627

4628

4629

4630

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

4631

4632

4633

4634

4635

4636

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

4637

</div>

4638

4639

4640

</li>

4641

4642

4643

4644

4645

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

4646

4647

4648

4649

4650

4651

<p>Information about the event interaction, such as

4652

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

4653

</div>

4654

4655

4656

</li>

4657

4658

</ul>

4659

</div>

4660

4661

4662

4663

4664

4665

</div>

4666

4667

4668

4669

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

4670

4671

4672

4673

4674

4675

4676

4677

<code>valueHash</code>

4678

4679

</li>

4680

4681

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

4682

</div>

4683

4684

4685

4686

4687

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

4688

</span>

4689

4690

4691

4692

4693

4694

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

4695

4696

4697

4698

4699

4700

4701

4702

4703

4704

4705

<p>Inherited from

4706

4707

AttributeCore

4708

</a>

4709

4710

but overwritten in

4711

4712

4713

4714

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

4715

4716

</p>

4717

4718

4719

4720

4721

4722

</div>

4723

4724

4725

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

4726

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

4727

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

4728

</div>

4729

4730

4731

4732

<h4>Parameters:</h4>

4733

4734

4735

4736

4737

4738

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

4739

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

4740

4741

4742

4743

4744

4745

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

4746

</div>

4747

4748

4749

</li>

4750

4751

</ul>

4752

</div>

4753

4754

4755

4756

4757

<h4>Returns:</h4>

4758

4759

4760

4761

4762

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

4763

4764

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

4765

containing simple and complex attribute values respectively keyed

4766

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

4767

4768

</div>

4769

</div>

4770

4771

4772

4773

</div>

4774

4775

4776

4777

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

4778

4779

4780

4781

4782

4783

4784

4785

4786

4787

</li>

4788

4789

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

4790

</div>

4791

4792

4793

4794

4795

4796

4797

4798

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

4799

4800

4801

4802

4803

4804

4805

4806

4807

4808

4809

4810

4811

<p>

4812

4813

Defined in

4814

4815

4816

4817

4818

<a href="../files/editor_js_editor-tab.js.html#l16"><code>editor/js/editor-tab.js:16</code></a>

4819

4820

</p>

4821

4822

4823

4824

4825

4826

</div>

4827

4828

4829

<p>Listener for host's nodeChange event and captures the tabkey interaction.</p>

4830

</div>

4831

4832

4833

4834

<h4>Parameters:</h4>

4835

4836

4837

4838

4839

4840

4841

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

4842

4843

4844

4845

4846

4847

<p>The Event facade passed from the host.</p>

4848

</div>

4849

4850

4851

</li>

4852

4853

</ul>

4854

</div>

4855

4856

4857

4858

4859

4860

</div>

4861

4862

4863

4864

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

4865

4866

4867

4868

4869

4870

4871

4872

4873

4874

4875

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

4876

4877

4878

4879

4880

4881

4882

4883

4884

4885

4886

4887

<p>Inherited from

4888

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

4889

4890

4891

4892

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

4893

4894

</p>

4895

4896

4897

4898

4899

4900

</div>

4901

4902

4903

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

4904

and the prefixed event name from _getType

4905

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

4906

</div>

4907

4908

4909

4910

4911

4912

4913

</div>

4914

4915

4916

4917

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

4918

4919

4920

4921

4922

4923

4924

4925

<code>config</code>

4926

4927

</li>

4928

4929

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

4930

</div>

4931

4932

4933

4934

4935

4936

4937

4938

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

4939

4940

4941

4942

4943

4944

4945

4946

4947

4948

4949

4950

<p>Inherited from

4951

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

4952

4953

4954

4955

4956

4957

</p>

4958

4959

4960

4961

4962

4963

</div>

4964

4965

4966

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

4967

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

4968

construction, prior to init.</p>

4969

</div>

4970

4971

4972

4973

<h4>Parameters:</h4>

4974

4975

4976

4977

4978

4979

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

4980

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

4981

4982

4983

4984

4985

4986

<p>The user configuration object</p>

4987

</div>

4988

4989

4990

</li>

4991

4992

</ul>

4993

</div>

4994

4995

4996

4997

4998

4999

</div>

5000

5001

5002

5003

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

5004

5005

5006

5007

5008

5009

5010

5011

<code>attrs</code>

5012

5013

</li>

5014

5015

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

5016

</div>

5017

5018

5019

5020

5021

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

5022

</span>

5023

5024

5025

5026

5027

5028

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

5029

5030

5031

5032

5033

5034

5035

5036

5037

5038

5039

5040

<p>Inherited from

5041

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

5042

5043

5044

5045

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

5046

5047

</p>

5048

5049

5050

5051

5052

5053

</div>

5054

5055

5056

<p>Utility method to protect an attribute configuration

5057

hash, by merging the entire object and the individual

5058

attr config objects.</p>

5059

</div>

5060

5061

5062

5063

<h4>Parameters:</h4>

5064

5065

5066

5067

5068

5069

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

5070

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

5071

5072

5073

5074

5075

5076

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

5077

</div>

5078

5079

5080

</li>

5081

5082

</ul>

5083

</div>

5084

5085

5086

5087

5088

<h4>Returns:</h4>

5089

5090

5091

5092

5093

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

5094

5095

A protected version of the attrs argument.

5096

5097

</div>

5098

</div>

5099

5100

5101

5102

</div>

5103

5104

5105

5106

5107

5108

5109

5110

5111

5112

5113

5114

5115

5116

</li>

5117

5118

5119

5120

5121

5122

</li>

5123

5124

5125

5126

5127

5128

</li>

5129

5130

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

5131

</div>

5132

5133

5134

5135

5136

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

5137

</span>

5138

5139

5140

5141

5142

5143

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

5144

5145

5146

5147

5148

5149

5150

5151

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

5152

5153

5154

5155

5156

<p>Inherited from

5157

5158

AttributeCore

5159

</a>

5160

5161

but overwritten in

5162

5163

5164

5165

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

5166

5167

</p>

5168

5169

5170

5171

5172

5173

</div>

5174

5175

5176

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

5177

</div>

5178

5179

5180

5181

<h4>Parameters:</h4>

5182

5183

5184

5185

5186

5187

5188

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

5189

5190

5191

5192

5193

5194

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

5195

</div>

5196

5197

5198

</li>

5199

5200

5201

5202

5203

5204

5205

5206

5207

5208

5209

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

5210

</div>

5211

5212

5213

</li>

5214

5215

5216

5217

5218

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

5219

5220

5221

5222

5223

5224

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

5225

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

5226

</div>

5227

5228

5229

</li>

5230

5231

</ul>

5232

</div>

5233

5234

5235

5236

5237

<h4>Returns:</h4>

5238

5239

5240

5241

5242

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

5243

5244

A reference to the host object.

5245

5246

</div>

5247

</div>

5248

5249

5250

5251

</div>

5252

5253

5254

5255

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

5256

5257

5258

5259

5260

5261

5262

5263

5264

5265

</li>

5266

5267

5268

5269

<code>value</code>

5270

5271

</li>

5272

5273

5274

5275

5276

5277

</li>

5278

5279

5280

5281

<code>force</code>

5282

5283

</li>

5284

5285

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

5286

</div>

5287

5288

5289

5290

5291

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

5292

</span>

5293

5294

5295

5296

5297

5298

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

5299

5300

5301

5302

5303

5304

5305

5306

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

5307

5308

5309

5310

5311

5312

<p>Inherited from

5313

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

5314

5315

5316

5317

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

5318

5319

</p>

5320

5321

5322

5323

5324

5325

</div>

5326

5327

5328

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

5329

5330

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

5331

</div>

5332

5333

5334

5335

<h4>Parameters:</h4>

5336

5337

5338

5339

5340

5341

5342

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

5343

5344

5345

5346

5347

5348

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

5349

</div>

5350

5351

5352

</li>

5353

5354

5355

5356

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

5357

5358

5359

5360

5361

5362

5363

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

5364

</div>

5365

5366

5367

</li>

5368

5369

5370

5371

5372

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

5373

5374

5375

5376

5377

5378

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

5379

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

5380

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

5381

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

5382

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

5383

</div>

5384

5385

5386

</li>

5387

5388

5389

5390

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

5391

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

5392

5393

5394

5395

5396

5397

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

5398

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

5399

</div>

5400

5401

5402

</li>

5403

5404

</ul>

5405

</div>

5406

5407

5408

5409

5410

<h4>Returns:</h4>

5411

5412

5413

5414

5415

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

5416

5417

A reference to the host object.

5418

5419

</div>

5420

</div>

5421

5422

5423

5424

</div>

5425

5426

5427

5428

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

5429

5430

5431

5432

5433

5434

5435

5436

<code>attrs</code>

5437

5438

</li>

5439

5440

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

5441

</div>

5442

5443

5444

5445

5446

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

5447

</span>

5448

5449

5450

5451

5452

5453

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

5454

5455

5456

5457

5458

5459

5460

5461

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

5462

5463

5464

5465

5466

5467

<p>Inherited from

5468

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

5469

5470

5471

5472

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

5473

5474

</p>

5475

5476

5477

5478

5479

5480

</div>

5481

5482

5483

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

5484

</div>

5485

5486

5487

5488

<h4>Parameters:</h4>

5489

5490

5491

5492

5493

5494

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

5495

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

5496

5497

5498

5499

5500

5501

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

5502

</div>

5503

5504

5505

</li>

5506

5507

</ul>

5508

</div>

5509

5510

5511

5512

5513

<h4>Returns:</h4>

5514

5515

5516

5517

5518

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

5519

5520

A reference to the host object.

5521

5522

</div>

5523

</div>

5524

5525

5526

5527

</div>

5528

5529

5530

5531

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

5532

5533

5534

5535

5536

5537

5538

5539

<code>attrName</code>

5540

5541

</li>

5542

5543

5544

5545

<code>subAttrName</code>

5546

5547

</li>

5548

5549

5550

5551

<code>prevVal</code>

5552

5553

</li>

5554

5555

5556

5557

<code>newVal</code>

5558

5559

</li>

5560

5561

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

5562

</div>

5563

5564

5565

5566

5567

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

5568

</span>

5569

5570

5571

5572

5573

5574

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

5575

5576

5577

5578

5579

5580

5581

5582

5583

5584

5585

5586

<p>Inherited from

5587

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

5588

5589

5590

5591

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

5592

5593

</p>

5594

5595

5596

5597

5598

5599

</div>

5600

5601

5602

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

5603

if validation and setter passes.</p>

5604

</div>

5605

5606

5607

5608

<h4>Parameters:</h4>

5609

5610

5611

5612

5613

5614

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

5615

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

5616

5617

5618

5619

5620

5621

<p>The attribute name.</p>

5622

</div>

5623

5624

5625

</li>

5626

5627

5628

5629

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

5630

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

5631

5632

5633

5634

5635

5636

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

5637

</div>

5638

5639

5640

</li>

5641

5642

5643

5644

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

5645

5646

5647

5648

5649

5650

5651

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

5652

</div>

5653

5654

5655

</li>

5656

5657

5658

5659

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

5660

5661

5662

5663

5664

5665

5666

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

5667

</div>

5668

5669

5670

</li>

5671

5672

</ul>

5673

</div>

5674

5675

5676

5677

5678

<h4>Returns:</h4>

5679

5680

5681

5682

5683

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

5684

5685

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

5686

5687

</div>

5688

</div>

5689

5690

5691

5692

</div>

5693

5694

5695

5696

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

5697

5698

5699

5700

5701

5702

5703

5704

5705

5706

</li>

5707

5708

5709

5710

<code>value</code>

5711

5712

</li>

5713

5714

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

5715

</div>

5716

5717

5718

5719

5720

5721

5722

5723

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

5724

5725

5726

5727

5728

5729

5730

5731

5732

5733

5734

5735

<p>Inherited from

5736

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

5737

5738

5739

5740

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

5741

5742

</p>

5743

5744

5745

5746

5747

5748

</div>

5749

5750

5751

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

5752

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

5753

</div>

5754

5755

5756

5757

<h4>Parameters:</h4>

5758

5759

5760

5761

5762

5763

5764

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

5765

5766

5767

5768

5769

5770

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

5771

</div>

5772

5773

5774

</li>

5775

5776

5777

5778

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

5779

5780

5781

5782

5783

5784

5785

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

5786

</div>

5787

5788

5789

</li>

5790

5791

</ul>

5792

</div>

5793

5794

5795

5796

5797

5798

</div>

5799

5800

5801

5802

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

5803

5804

5805

5806

5807

5808

5809

5810

5811

5812

</li>

5813

5814

5815

5816

<code>config</code>

5817

5818

</li>

5819

5820

5821

5822

5823

5824

</li>

5825

5826

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

5827

</div>

5828

5829

5830

5831

5832

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

5833

</span>

5834

5835

5836

5837

5838

5839

5840

5841

5842

5843

5844

5845

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

5846

5847

5848

5849

5850

5851

<p>Inherited from

5852

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

5853

5854

5855

5856

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

5857

5858

</p>

5859

5860

5861

5862

5863

5864

</div>

5865

5866

5867

<p>

5868

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

5869

</p>

5870

5871

<p>

5872

The config argument object supports the following properties:

5873

</p>

5874

5875

<dl>

5876

<dt>value <Any></dt>

5877

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

5878

5879

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

5880

<dd>

5881

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

5882

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

5883

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

5884

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

5885

case the value property is used.</p>

5886

5887

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

5888

</dd>

5889

5890

<dt>readOnly <boolean></dt>

5891

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

5892

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

5893

5894

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

5895

<dd>

5896

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

5897

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

5898

constructor configuration arguments, or by invoking set.

5899

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

5900

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

5901

</dd>

5902

5903

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

5904

<dd>

5905

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

5906

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

5907

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

5908

the value from being stored.

5909

</p>

5910

5911

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

5912

</dd>

5913

5914

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

5915

<dd>

5916

<p>

5917

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

5918

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

5919

invoke get.

5920

</p>

5921

5922

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

5923

</dd>

5924

5925

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

5926

<dd>

5927

<p>

5928

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

5929

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

5930

</p>

5931

5932

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

5933

</dd>

5934

5935

<dt>lazyAdd <boolean></dt>

5936

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

5937

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

5938

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

5939

5940

</dl>

5941

5942

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

5943

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

5944

5945

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

5946

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

5947

</div>

5948

5949

5950

5951

<h4>Parameters:</h4>

5952

5953

5954

5955

5956

5957

5958

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

5959

5960

5961

5962

5963

5964

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

5965

</div>

5966

5967

5968

</li>

5969

5970

5971

5972

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

5973

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

5974

5975

5976

5977

5978

5979

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

5980

5981

<p>

5982

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

5983

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

5984

</p>

5985

</div>

5986

5987

5988

</li>

5989

5990

5991

5992

5993

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

5994

5995

5996

5997

5998

5999

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

6000

</div>

6001

6002

6003

</li>

6004

6005

</ul>

6006

</div>

6007

6008

6009

6010

6011

<h4>Returns:</h4>

6012

6013

6014

6015

6016

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

6017

6018

A reference to the host object.

6019

6020

</div>

6021

</div>

6022

6023

6024

6025

</div>

6026

6027

6028

6029

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

6030

6031

6032

6033

6034

6035

6036

6037

6038

6039

</li>

6040

6041

6042

6043

<code>values</code>

6044

6045

</li>

6046

6047

6048

6049

6050

6051

</li>

6052

6053

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

6054

</div>

6055

6056

6057

6058

6059

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

6060

</span>

6061

6062

6063

6064

6065

6066

6067

6068

6069

6070

6071

6072

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

6073

6074

6075

6076

6077

6078

<p>Inherited from

6079

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

6080

6081

6082

6083

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

6084

6085

</p>

6086

6087

6088

6089

6090

6091

</div>

6092

6093

6094

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

6095

6096

<p>

6097

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

6098

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

6099

</p>

6100

</div>

6101

6102

6103

6104

<h4>Parameters:</h4>

6105

6106

6107

6108

6109

6110

6111

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

6112

6113

6114

6115

6116

6117

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

6118

</div>

6119

6120

6121

</li>

6122

6123

6124

6125

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

6126

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

6127

6128

6129

6130

6131

6132

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

6133

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

6134

</div>

6135

6136

6137

</li>

6138

6139

6140

6141

6142

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

6143

6144

6145

6146

6147

6148

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

6149

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

6150

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

6151

</div>

6152

6153

6154

</li>

6155

6156

</ul>

6157

</div>

6158

6159

6160

6161

6162

<h4>Returns:</h4>

6163

6164

6165

6166

6167

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

6168

6169

A reference to the host object.

6170

6171

</div>

6172

</div>

6173

6174

6175

6176

</div>

6177

6178

6179

6180

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

6181

6182

6183

6184

6185

6186

6187

6188

6189

6190

</li>

6191

6192

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

6193

</div>

6194

6195

6196

6197

6198

6199

6200

6201

6202

6203

6204

6205

6206

6207

6208

6209

6210

6211

<p>Inherited from

6212

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

6213

6214

6215

6216

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

6217

6218

</p>

6219

6220

6221

6222

6223

6224

</div>

6225

6226

6227

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

6228

is determined by the order registered. Multiple targets can

6229

be specified.</p>

6230

6231

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

6232

6233

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

6234

</div>

6235

6236

6237

6238

<h4>Parameters:</h4>

6239

6240

6241

6242

6243

6244

6245

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

6246

6247

6248

6249

6250

6251

<p>the target to add</p>

6252

</div>

6253

6254

6255

</li>

6256

6257

</ul>

6258

</div>

6259

6260

6261

6262

6263

6264

</div>

6265

6266

6267

6268

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

6269

6270

6271

6272

6273

6274

6275

6276

6277

6278

</li>

6279

6280

6281

6282

6283

6284

</li>

6285

6286

6287

6288

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

6289

6290

</li>

6291

6292

6293

6294

6295

6296

</li>

6297

6298

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

6299

</div>

6300

6301

6302

6303

6304

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

6305

</span>

6306

6307

6308

6309

6310

6311

6312

6313

6314

6315

6316

6317

6318

6319

6320

6321

<p>Inherited from

6322

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

6323

6324

6325

6326

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

6327

6328

</p>

6329

6330

6331

6332

6333

6334

</div>

6335

6336

6337

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

6338

supplied callback will execute after any listeners add

6339

via the subscribe method, and after the default function,

6340

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

6341

</div>

6342

6343

6344

6345

<h4>Parameters:</h4>

6346

6347

6348

6349

6350

6351

6352

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

6353

6354

6355

6356

6357

6358

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

6359

</div>

6360

6361

6362

</li>

6363

6364

6365

6366

6367

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

6368

6369

6370

6371

6372

6373

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

6374

</div>

6375

6376

6377

</li>

6378

6379

6380

6381

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

6382

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

6383

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

6384

6385

6386

6387

6388

6389

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

6390

</div>

6391

6392

6393

</li>

6394

6395

6396

6397

6398

6399

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

6400

6401

6402

6403

6404

6405

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

6406

</div>

6407

6408

6409

</li>

6410

6411

</ul>

6412

</div>

6413

6414

6415

6416

6417

<h4>Returns:</h4>

6418

6419

6420

6421

6422

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

6423

6424

A subscription handle capable of detaching the

6425

subscription

6426

6427

</div>

6428

</div>

6429

6430

6431

6432

</div>

6433

6434

6435

6436

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

6437

6438

6439

6440

6441

6442

6443

6444

6445

6446

</li>

6447

6448

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

6449

</div>

6450

6451

6452

6453

6454

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

6455

</span>

6456

6457

6458

6459

6460

6461

6462

6463

6464

6465

6466

6467

6468

6469

6470

6471

<p>Inherited from

6472

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

6473

6474

6475

6476

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

6477

6478

</p>

6479

6480

6481

6482

6483

6484

</div>

6485

6486

6487

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

6488

</div>

6489

6490

6491

6492

<h4>Parameters:</h4>

6493

6494

6495

6496

6497

6498

6499

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

6500

6501

6502

6503

6504

6505

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

6506

</div>

6507

6508

6509

</li>

6510

6511

</ul>

6512

</div>

6513

6514

6515

6516

6517

<h4>Returns:</h4>

6518

6519

6520

6521

6522

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

6523

6524

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.

6525

6526

</div>

6527

</div>

6528

6529

6530

6531

</div>

6532

6533

6534

6535

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

6536

6537

6538

6539

6540

6541

6542

6543

6544

</span>

6545

6546

6547

6548

6549

6550

6551

6552

6553

6554

6555

6556

6557

6558

6559

6560

<p>Inherited from

6561

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

6562

6563

6564

6565

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

6566

6567

</p>

6568

6569

6570

6571

6572

6573

</div>

6574

6575

6576

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

6577

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

6578

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

6579

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

6580

6581

<p>For DOM and custom events:

6582

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

6583

6584

<p>For methods:

6585

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

6586

</div>

6587

6588

6589

6590

6591

6592

<h4>Returns:</h4>

6593

6594

6595

6596

6597

detach handle

6598

6599

</div>

6600

</div>

6601

6602

6603

6604

</div>

6605

6606

6607

6608

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

6609

6610

6611

6612

6613

6614

6615

6616

6617

6618

</li>

6619

6620

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

6621

</div>

6622

6623

6624

6625

6626

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

6627

</span>

6628

6629

6630

6631

6632

6633

6634

6635

6636

6637

6638

6639

6640

6641

6642

6643

<p>Inherited from

6644

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

6645

6646

6647

6648

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

6649

6650

</p>

6651

6652

6653

6654

6655

6656

</div>

6657

6658

6659

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

6660

</div>

6661

6662

6663

6664

<h4>Parameters:</h4>

6665

6666

6667

6668

6669

6670

6671

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

6672

6673

6674

6675

6676

6677

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

6678

</div>

6679

6680

6681

</li>

6682

6683

</ul>

6684

</div>

6685

6686

6687

6688

6689

<h4>Returns:</h4>

6690

6691

6692

6693

6694

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

6695

6696

the aggregated return value from Event.Custom.fire

6697

6698

</div>

6699

</div>

6700

6701

6702

6703

</div>

6704

6705

6706

6707

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

6708

6709

6710

6711

6712

6713

6714

6715

6716

</span>

6717

6718

6719

6720

6721

6722

6723

6724

6725

6726

6727

6728

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

6729

6730

6731

6732

6733

<p>Inherited from

6734

6735

BaseCore

6736

</a>

6737

6738

but overwritten in

6739

6740

6741

6742

6743

6744

</p>

6745

6746

6747

6748

6749

6750

</div>

6751

6752

6753

<p>

6754

Destroy lifecycle method. Fires the destroy

6755

event, prior to invoking destructors for the

6756

class hierarchy.

6757

</p>

6758

6759

<p>

6760

Subscribers to the destroy

6761

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

6762

from proceeding.

6763

</p>

6764

</div>

6765

6766

6767

6768

6769

6770

<h4>Returns:</h4>

6771

6772

6773

6774

6775

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

6776

6777

A reference to this object

6778

6779

</div>

6780

</div>

6781

6782

6783

6784

</div>

6785

6786

6787

6788

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

6789

6790

6791

6792

6793

6794

6795

6796

6797

6798

</li>

6799

6800

6801

6802

6803

6804

</li>

6805

6806

6807

6808

<code>context</code>

6809

6810

</li>

6811

6812

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

6813

</div>

6814

6815

6816

6817

6818

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

6819

</span>

6820

6821

6822

6823

6824

6825

6826

6827

6828

6829

6830

6831

6832

6833

6834

6835

<p>Inherited from

6836

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

6837

6838

6839

6840

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

6841

6842

</p>

6843

6844

6845

6846

6847

6848

</div>

6849

6850

6851

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

6852

</div>

6853

6854

6855

6856

<h4>Parameters:</h4>

6857

6858

6859

6860

6861

6862

6863

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

6864

6865

6866

6867

6868

6869

<p>Either the handle to the subscriber or the

6870

type of event. If the type

6871

is not specified, it will attempt to remove

6872

the listener from all hosted events.</p>

6873

</div>

6874

6875

6876

</li>

6877

6878

6879

6880

6881

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

6882

6883

6884

6885

6886

6887

<p>The subscribed function to unsubscribe, if not

6888

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

6889

</div>

6890

6891

6892

</li>

6893

6894

6895

6896

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

6897

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

6898

6899

6900

6901

6902

6903

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

6904

optional, but if supplied will be used to

6905

disambiguate multiple listeners that are the same

6906

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

6907

that lives on the prototype)</p>

6908

</div>

6909

6910

6911

</li>

6912

6913

</ul>

6914

</div>

6915

6916

6917

6918

6919

<h4>Returns:</h4>

6920

6921

6922

6923

6924

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

6925

6926

the host

6927

6928

</div>

6929

</div>

6930

6931

6932

6933

</div>

6934

6935

6936

6937

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

6938

6939

6940

6941

6942

6943

6944

6945

6946

6947

</li>

6948

6949

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

6950

</div>

6951

6952

6953

6954

6955

6956

6957

6958

6959

6960

6961

6962

6963

6964

6965

6966

6967

6968

<p>Inherited from

6969

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

6970

6971

6972

6973

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

6974

6975

</p>

6976

6977

6978

6979

6980

6981

</div>

6982

6983

6984

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

6985

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

6986

be removed.</p>

6987

</div>

6988

6989

6990

6991

<h4>Parameters:</h4>

6992

6993

6994

6995

6996

6997

6998

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

6999

7000

7001

7002

7003

7004

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

7005

</div>

7006

7007

7008

</li>

7009

7010

</ul>

7011

</div>

7012

7013

7014

7015

7016

7017

</div>

7018

7019

7020

7021

7022

7023

7024

7025

7026

7027

7028

7029

7030

7031

</li>

7032

7033

7034

7035

<code>arguments</code>

7036

7037

</li>

7038

7039

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

7040

</div>

7041

7042

7043

7044

7045

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

7046

</span>

7047

7048

7049

7050

7051

7052

7053

7054

7055

7056

7057

7058

7059

7060

7061

7062

<p>Inherited from

7063

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

7064

7065

7066

7067

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

7068

7069

</p>

7070

7071

7072

7073

7074

7075

</div>

7076

7077

7078

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

7079

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

7080

following parameters.</p>

7081

7082

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

7083

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

7084

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

7085

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

7086

be published on this object first.</p>

7087

7088

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

7089

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

7090

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

7091

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

7092

in place of the original object.</p>

7093

</div>

7094

7095

7096

7097

<h4>Parameters:</h4>

7098

7099

7100

7101

7102

7103

7104

7105

7106

7107

7108

7109

7110

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

7111

a 'type' property.</p>

7112

</div>

7113

7114

7115

</li>

7116

7117

7118

7119

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

7120

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

7121

7122

7123

7124

7125

7126

<p>an arbitrary set of parameters to pass to

7127

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

7128

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

7129

parameter after the properties the object literal contains are copied to

7130

the event facade.</p>

7131

</div>

7132

7133

7134

</li>

7135

7136

</ul>

7137

</div>

7138

7139

7140

7141

7142

<h4>Returns:</h4>

7143

7144

7145

7146

7147

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

7148

7149

the event host

7150

7151

</div>

7152

</div>

7153

7154

7155

7156

</div>

7157

7158

7159

7160

7161

7162

7163

7164

7165

7166

7167

7168

7169

7170

</li>

7171

7172

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

7173

</div>

7174

7175

7176

7177

7178

7179

</span>

7180

7181

7182

7183

7184

7185

7186

7187

7188

7189

7190

7191

7192

7193

7194

7195

<p>Inherited from

7196

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

7197

7198

7199

7200

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

7201

7202

</p>

7203

7204

7205

7206

7207

7208

</div>

7209

7210

7211

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

7212

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

7213

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

7214

</div>

7215

7216

7217

7218

<h4>Parameters:</h4>

7219

7220

7221

7222

7223

7224

7225

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

7226

7227

7228

7229

7230

7231

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

7232

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

7233

</div>

7234

7235

7236

</li>

7237

7238

</ul>

7239

</div>

7240

7241

7242

7243

7244

<h4>Returns:</h4>

7245

7246

7247

7248

7249

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

7250

7251

The value of the attribute

7252

7253

</div>

7254

</div>

7255

7256

7257

7258

</div>

7259

7260

7261

7262

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

7263

7264

7265

7266

7267

7268

7269

7270

<code>attrs</code>

7271

7272

</li>

7273

7274

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

7275

</div>

7276

7277

7278

7279

7280

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

7281

</span>

7282

7283

7284

7285

7286

7287

7288

7289

7290

7291

7292

7293

7294

7295

7296

7297

<p>Inherited from

7298

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

7299

7300

7301

7302

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

7303

7304

</p>

7305

7306

7307

7308

7309

7310

</div>

7311

7312

7313

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

7314

</div>

7315

7316

7317

7318

<h4>Parameters:</h4>

7319

7320

7321

7322

7323

7324

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

7325

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

7326

7327

7328

7329

7330

7331

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

7332

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

7333

</div>

7334

7335

7336

</li>

7337

7338

</ul>

7339

</div>

7340

7341

7342

7343

7344

<h4>Returns:</h4>

7345

7346

7347

7348

7349

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

7350

7351

An object with attribute name/value pairs.

7352

7353

</div>

7354

</div>

7355

7356

7357

7358

</div>

7359

7360

7361

7362

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

7363

7364

7365

7366

7367

7368

7369

7370

7371

7372

</li>

7373

7374

7375

7376

<code>prefixed</code>

7377

7378

</li>

7379

7380

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

7381

</div>

7382

7383

7384

7385

7386

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

7387

</span>

7388

7389

7390

7391

7392

7393

7394

7395

7396

7397

7398

7399

7400

7401

7402

7403

<p>Inherited from

7404

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

7405

7406

7407

7408

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

7409

7410

</p>

7411

7412

7413

7414

7415

7416

</div>

7417

7418

7419

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

7420

falsy value otherwise</p>

7421

</div>

7422

7423

7424

7425

<h4>Parameters:</h4>

7426

7427

7428

7429

7430

7431

7432

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

7433

7434

7435

7436

7437

7438

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

7439

</div>

7440

7441

7442

</li>

7443

7444

7445

7446

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

7447

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

7448

7449

7450

7451

7452

7453

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

7454

</div>

7455

7456

7457

</li>

7458

7459

</ul>

7460

</div>

7461

7462

7463

7464

7465

<h4>Returns:</h4>

7466

7467

7468

7469

7470

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

7471

7472

the custom event or null

7473

7474

</div>

7475

</div>

7476

7477

7478

7479

</div>

7480

7481

7482

7483

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

7484

7485

7486

7487

7488

7489

7490

7491

7492

</span>

7493

7494

7495

7496

7497

7498

7499

7500

7501

7502

7503

7504

7505

7506

7507

7508

<p>Inherited from

7509

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

7510

7511

7512

7513

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

7514

7515

</p>

7516

7517

7518

7519

7520

7521

</div>

7522

7523

7524

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

7525

</div>

7526

7527

7528

7529

7530

7531

<h4>Returns:</h4>

7532

7533

7534

7535

7536

EventTarget[]

7537

7538

</div>

7539

</div>

7540

7541

7542

7543

</div>

7544

7545

7546

7547

7548

7549

7550

7551

7552

7553

7554

7555

<code>config</code>

7556

7557

</li>

7558

7559

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

7560

</div>

7561

7562

7563

7564

7565

7566

</span>

7567

7568

7569

7570

7571

7572

7573

7574

7575

7576

7577

7578

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

7579

7580

7581

7582

7583

<p>Inherited from

7584

7585

BaseCore

7586

</a>

7587

7588

but overwritten in

7589

7590

7591

7592

7593

7594

</p>

7595

7596

7597

7598

7599

7600

</div>

7601

7602

7603

<p>Init lifecycle method, invoked during construction.

7604

Fires the init event prior to setting up attributes and

7605

invoking initializers for the class hierarchy.</p>

7606

</div>

7607

7608

7609

7610

<h4>Parameters:</h4>

7611

7612

7613

7614

7615

7616

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

7617

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

7618

7619

7620

7621

7622

7623

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

7624

</div>

7625

7626

7627

</li>

7628

7629

</ul>

7630

</div>

7631

7632

7633

7634

7635

<h4>Returns:</h4>

7636

7637

7638

7639

7640

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

7641

7642

A reference to this object

7643

7644

</div>

7645

</div>

7646

7647

7648

7649

</div>

7650

7651

7652

7653

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

7654

7655

7656

7657

7658

7659

7660

7661

7662

7663

</li>

7664

7665

7666

7667

<code>config</code>

7668

7669

</li>

7670

7671

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

7672

</div>

7673

7674

7675

7676

7677

7678

7679

7680

7681

7682

7683

7684

7685

7686

7687

7688

7689

7690

<p>Inherited from

7691

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

7692

7693

7694

7695

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

7696

7697

</p>

7698

7699

7700

7701

7702

7703

</div>

7704

7705

7706

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

7707

7708

<p>

7709

The properties which can be modified through this interface are limited

7710

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

7711

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

7712

broadcast and getter.

7713

</p>

7714

</div>

7715

7716

7717

7718

<h4>Parameters:</h4>

7719

7720

7721

7722

7723

7724

7725

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

7726

7727

7728

7729

7730

7731

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

7732

</div>

7733

7734

7735

</li>

7736

7737

7738

7739

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

7740

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

7741

7742

7743

7744

7745

7746

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

7747

</div>

7748

7749

7750

</li>

7751

7752

</ul>

7753

</div>

7754

7755

7756

7757

7758

7759

</div>

7760

7761

7762

7763

7764

7765

7766

7767

7768

7769

7770

7771

7772

7773

</li>

7774

7775

7776

7777

7778

7779

</li>

7780

7781

7782

7783

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

7784

7785

</li>

7786

7787

7788

7789

7790

7791

</li>

7792

7793

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

7794

</div>

7795

7796

7797

7798

7799

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

7800

</span>

7801

7802

7803

7804

7805

7806

7807

7808

7809

7810

7811

7812

7813

7814

7815

7816

<p>Inherited from

7817

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

7818

7819

7820

7821

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

7822

7823

</p>

7824

7825

7826

7827

7828

7829

</div>

7830

7831

7832

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

7833

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

7834

7835

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

7836

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

7837

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

7838

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

7839

API for all available properties and methods. Subscribers to

7840

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

7841

after the event name.</p>

7842

7843

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

7844

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

7845

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

7846

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

7847

7848

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

7849

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

7850

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

7851

</div>

7852

7853

7854

7855

<h4>Parameters:</h4>

7856

7857

7858

7859

7860

7861

7862

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

7863

7864

7865

7866

7867

7868

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

7869

</div>

7870

7871

7872

</li>

7873

7874

7875

7876

7877

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

7878

7879

7880

7881

7882

7883

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

7884

</div>

7885

7886

7887

</li>

7888

7889

7890

7891

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

7892

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

7893

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

7894

7895

7896

7897

7898

7899

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

7900

</div>

7901

7902

7903

</li>

7904

7905

7906

7907

7908

7909

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

7910

7911

7912

7913

7914

7915

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

7916

</div>

7917

7918

7919

</li>

7920

7921

</ul>

7922

</div>

7923

7924

7925

7926

7927

<h4>Returns:</h4>

7928

7929

7930

7931

7932

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

7933

7934

A subscription handle capable of detaching that

7935

subscription

7936

7937

</div>

7938

</div>

7939

7940

7941

7942

</div>

7943

7944

7945

7946

7947

7948

7949

7950

7951

7952

7953

7954

7955

7956

</li>

7957

7958

7959

7960

7961

7962

</li>

7963

7964

7965

7966

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

7967

7968

</li>

7969

7970

7971

7972

7973

7974

</li>

7975

7976

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

7977

</div>

7978

7979

7980

7981

7982

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

7983

</span>

7984

7985

7986

7987

7988

7989

7990

7991

7992

7993

7994

7995

7996

7997

7998

7999

<p>Inherited from

8000

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

8001

8002

8003

8004

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

8005

8006

</p>

8007

8008

8009

8010

8011

8012

</div>

8013

8014

8015

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

8016

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

8017

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

8018

</div>

8019

8020

8021

8022

<h4>Parameters:</h4>

8023

8024

8025

8026

8027

8028

8029

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

8030

8031

8032

8033

8034

8035

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

8036

</div>

8037

8038

8039

</li>

8040

8041

8042

8043

8044

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

8045

8046

8047

8048

8049

8050

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

8051

</div>

8052

8053

8054

</li>

8055

8056

8057

8058

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

8059

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

8060

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

8061

8062

8063

8064

8065

8066

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

8067

</div>

8068

8069

8070

</li>

8071

8072

8073

8074

8075

8076

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

8077

8078

8079

8080

8081

8082

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

8083

</div>

8084

8085

8086

</li>

8087

8088

</ul>

8089

</div>

8090

8091

8092

8093

8094

<h4>Returns:</h4>

8095

8096

8097

8098

8099

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

8100

8101

A subscription handle capable of detaching the

8102

subscription

8103

8104

</div>

8105

</div>

8106

8107

8108

8109

</div>

8110

8111

8112

8113

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

8114

8115

8116

8117

8118

8119

8120

8121

8122

8123

</li>

8124

8125

8126

8127

8128

8129

</li>

8130

8131

8132

8133

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

8134

8135

</li>

8136

8137

8138

8139

8140

8141

</li>

8142

8143

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

8144

</div>

8145

8146

8147

8148

8149

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

8150

</span>

8151

8152

8153

8154

8155

8156

8157

8158

8159

8160

8161

8162

8163

8164

8165

8166

<p>Inherited from

8167

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

8168

8169

8170

8171

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

8172

8173

</p>

8174

8175

8176

8177

8178

8179

</div>

8180

8181

8182

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

8183

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

8184

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

8185

</div>

8186

8187

8188

8189

<h4>Parameters:</h4>

8190

8191

8192

8193

8194

8195

8196

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

8197

8198

8199

8200

8201

8202

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

8203

</div>

8204

8205

8206

</li>

8207

8208

8209

8210

8211

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

8212

8213

8214

8215

8216

8217

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

8218

</div>

8219

8220

8221

</li>

8222

8223

8224

8225

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

8226

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

8227

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

8228

8229

8230

8231

8232

8233

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

8234

</div>

8235

8236

8237

</li>

8238

8239

8240

8241

8242

8243

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

8244

8245

8246

8247

8248

8249

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

8250

</div>

8251

8252

8253

</li>

8254

8255

</ul>

8256

</div>

8257

8258

8259

8260

8261

<h4>Returns:</h4>

8262

8263

8264

8265

8266

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

8267

8268

A subscription handle capable of detaching that

8269

subscription

8270

8271

</div>

8272

</div>

8273

8274

8275

8276

</div>

8277

8278

8279

8280

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

8281

8282

8283

8284

8285

8286

8287

8288

8289

8290

</li>

8291

8292

8293

8294

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

8295

8296

</li>

8297

8298

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

8299

</div>

8300

8301

8302

8303

8304

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

8305

</span>

8306

8307

8308

8309

8310

8311

8312

8313

8314

8315

8316

8317

8318

8319

8320

8321

<p>Inherited from

8322

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

8323

8324

8325

8326

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

8327

8328

</p>

8329

8330

8331

8332

8333

8334

<p>Available since 3.3.0</p>

8335

8336

</div>

8337

8338

8339

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

8340

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

8341

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

8342

to include the prefix one is supplied or the event target

8343

is configured with a default prefix.</p>

8344

</div>

8345

8346

8347

8348

<h4>Parameters:</h4>

8349

8350

8351

8352

8353

8354

8355

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

8356

8357

8358

8359

8360

8361

8362

</div>

8363

8364

8365

</li>

8366

8367

8368

8369

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

8370

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

8371

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

8372

8373

8374

8375

8376

8377

<p>the prefix</p>

8378

</div>

8379

8380

8381

</li>

8382

8383

</ul>

8384

</div>

8385

8386

8387

8388

8389

<h4>Returns:</h4>

8390

8391

8392

8393

8394

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

8395

8396

an array containing:

8397

* the detach category, if supplied,

8398

* the prefixed event type,

8399

* whether or not this is an after listener,

8400

* the supplied event type

8401

8402

</div>

8403

</div>

8404

8405

8406

8407

</div>

8408

8409

8410

8411

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

8412

8413

8414

8415

8416

8417

8418

8419

8420

8421

</li>

8422

8423

8424

8425

8426

8427

</li>

8428

8429

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

8430

</div>

8431

8432

8433

8434

8435

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

8436

</span>

8437

8438

8439

8440

8441

8442

8443

8444

8445

8446

8447

8448

8449

8450

8451

8452

<p>Inherited from

8453

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

8454

8455

8456

8457

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

8458

8459

</p>

8460

8461

8462

8463

8464

8465

</div>

8466

8467

8468

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

8469

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

8470

case the custom event is returned.</p>

8471

</div>

8472

8473

8474

8475

<h4>Parameters:</h4>

8476

8477

8478

8479

8480

8481

8482

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

8483

8484

8485

8486

8487

8488

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

8489

</div>

8490

8491

8492

</li>

8493

8494

8495

8496

8497

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

8498

8499

8500

8501

8502

8503

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

8504

8505

<p><ul>

8506

<li>

8507

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

8508

</li>

8509

<li>

8510

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

8511

Events can only bubble if emitFacade is true.

8512

</li>

8513

<li>

8514

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

8515

</li>

8516

<li>

8517

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

8518

</li>

8519

<li>

8520

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

8521

</li>

8522

<li>

8523

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

8524

</li>

8525

<li>

8526

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

8527

the fire will be notified immediately.

8528

</li>

8529

<li>

8530

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

8531

fired unless async is true.

8532

</li>

8533

<li>

8534

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

8535

</li>

8536

<li>

8537

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

8538

</li>

8539

<li>

8540

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

8541

</li>

8542

<li>

8543

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

8544

</li>

8545

<li>

8546

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

8547

</li></p>

8548

8549

<p><li>

8550

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

8551

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

8552

</li>

8553

<li>

8554

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

8555

</li>

8556

</ul></p>

8557

</div>

8558

8559

8560

</li>

8561

8562

</ul>

8563

</div>

8564

8565

8566

8567

8568

<h4>Returns:</h4>

8569

8570

8571

8572

8573

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

8574

8575

the custom event

8576

8577

</div>

8578

</div>

8579

8580

8581

8582

</div>

8583

8584

8585

8586

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

8587

8588

8589

8590

8591

8592

8593

8594

8595

8596

</li>

8597

8598

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

8599

</div>

8600

8601

8602

8603

8604

8605

8606

8607

8608

8609

8610

8611

8612

8613

8614

8615

8616

8617

<p>Inherited from

8618

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

8619

8620

8621

8622

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

8623

8624

</p>

8625

8626

8627

8628

8629

8630

</div>

8631

8632

8633

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

8634

</div>

8635

8636

8637

8638

<h4>Parameters:</h4>

8639

8640

8641

8642

8643

8644

8645

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

8646

8647

8648

8649

8650

8651

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

8652

</div>

8653

8654

8655

</li>

8656

8657

</ul>

8658

</div>

8659

8660

8661

8662

8663

8664

</div>

8665

8666

8667

8668

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

8669

8670

8671

8672

8673

8674

8675

8676

8677

8678

</li>

8679

8680

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

8681

</div>

8682

8683

8684

8685

8686

8687

8688

8689

8690

8691

8692

8693

8694

8695

8696

8697

8698

8699

<p>Inherited from

8700

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

8701

8702

8703

8704

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

8705

8706

</p>

8707

8708

8709

8710

8711

8712

</div>

8713

8714

8715

<p>Removes a bubble target</p>

8716

</div>

8717

8718

8719

8720

<h4>Parameters:</h4>

8721

8722

8723

8724

8725

8726

8727

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

8728

8729

8730

8731

8732

8733

<p>the target to remove</p>

8734

</div>

8735

8736

8737

</li>

8738

8739

</ul>

8740

</div>

8741

8742

8743

8744

8745

8746

</div>

8747

8748

8749

8750

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

8751

8752

8753

8754

8755

8756

8757

8758

8759

8760

</li>

8761

8762

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

8763

</div>

8764

8765

8766

8767

8768

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

8769

</span>

8770

8771

8772

8773

8774

8775

8776

8777

8778

8779

8780

8781

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

8782

8783

8784

8785

8786

8787

<p>Inherited from

8788

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

8789

8790

8791

8792

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

8793

8794

</p>

8795

8796

8797

8798

8799

8800

</div>

8801

8802

8803

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

8804

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

8805

</div>

8806

8807

8808

8809

<h4>Parameters:</h4>

8810

8811

8812

8813

8814

8815

8816

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

8817

8818

8819

8820

8821

8822

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

8823

</div>

8824

8825

8826

</li>

8827

8828

</ul>

8829

</div>

8830

8831

8832

8833

8834

<h4>Returns:</h4>

8835

8836

8837

8838

8839

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

8840

8841

A reference to the host object.

8842

8843

</div>

8844

</div>

8845

8846

8847

8848

</div>

8849

8850

8851

8852

8853

8854

8855

8856

8857

8858

8859

8860

8861

8862

</li>

8863

8864

8865

8866

<code>value</code>

8867

8868

</li>

8869

8870

8871

8872

8873

8874

</li>

8875

8876

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

8877

</div>

8878

8879

8880

8881

8882

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

8883

</span>

8884

8885

8886

8887

8888

8889

8890

8891

8892

8893

8894

8895

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

8896

8897

8898

8899

8900

<p>Inherited from

8901

8902

AttributeCore

8903

</a>

8904

8905

but overwritten in

8906

8907

8908

8909

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

8910

8911

</p>

8912

8913

8914

8915

8916

8917

</div>

8918

8919

8920

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

8921

</div>

8922

8923

8924

8925

<h4>Parameters:</h4>

8926

8927

8928

8929

8930

8931

8932

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

8933

8934

8935

8936

8937

8938

<p>The name of the attribute. If the

8939

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

8940

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

8941

</div>

8942

8943

8944

</li>

8945

8946

8947

8948

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

8949

8950

8951

8952

8953

8954

8955

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

8956

</div>

8957

8958

8959

</li>

8960

8961

8962

8963

8964

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

8965

8966

8967

8968

8969

8970

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

8971

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

8972

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

8973

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

8974

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

8975

</div>

8976

8977

8978

</li>

8979

8980

</ul>

8981

</div>

8982

8983

8984

8985

8986

<h4>Returns:</h4>

8987

8988

8989

8990

8991

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

8992

8993

A reference to the host object.

8994

8995

</div>

8996

</div>

8997

8998

8999

9000

</div>

9001

9002

9003

9004

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

9005

9006

9007

9008

9009

9010

9011

9012

<code>attrs</code>

9013

9014

</li>

9015

9016

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

9017

</div>

9018

9019

9020

9021

9022

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

9023

</span>

9024

9025

9026

9027

9028

9029

9030

9031

9032

9033

9034

9035

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

9036

9037

9038

9039

9040

<p>Inherited from

9041

9042

AttributeCore

9043

</a>

9044

9045

but overwritten in

9046

9047

9048

9049

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

9050

9051

</p>

9052

9053

9054

9055

9056

9057

</div>

9058

9059

9060

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

9061

</div>

9062

9063

9064

9065

<h4>Parameters:</h4>

9066

9067

9068

9069

9070

9071

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

9072

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

9073

9074

9075

9076

9077

9078

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

9079

</div>

9080

9081

9082

</li>

9083

9084

</ul>

9085

</div>

9086

9087

9088

9089

9090

<h4>Returns:</h4>

9091

9092

9093

9094

9095

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

9096

9097

A reference to the host object.

9098

9099

</div>

9100

</div>

9101

9102

9103

9104

</div>

9105

9106

9107

9108

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

9109

9110

9111

9112

9113

9114

9115

9116

9117

<span class="flag deprecated" title="use on">deprecated</span>

9118

9119

9120

9121

9122

9123

9124

9125

9126

9127

9128

9129

9130

9131

<p>Inherited from

9132

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

9133

9134

9135

9136

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

9137

9138

</p>

9139

9140

9141

9142

<p>Deprecated: use on</p>

9143

9144

9145

9146

</div>

9147

9148

9149

<p>subscribe to an event</p>

9150

</div>

9151

9152

9153

9154

9155

9156

9157

</div>

9158

9159

9160

9161

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

9162

9163

9164

9165

9166

9167

9168

9169

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

9170

</span>

9171

9172

9173

9174

9175

9176

9177

9178

9179

9180

9181

9182

9183

9184

9185

9186

<p>Inherited from

9187

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

9188

9189

9190

9191

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

9192

9193

</p>

9194

9195

9196

9197

9198

9199

</div>

9200

9201

9202

<p>Default toString implementation. Provides the constructor NAME

9203

and the instance guid, if set.</p>

9204

</div>

9205

9206

9207

9208

9209

9210

<h4>Returns:</h4>

9211

9212

9213

9214

9215

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

9216

9217

String representation for this object

9218

9219

</div>

9220

</div>

9221

9222

9223

9224

</div>

9225

9226

9227

9228

<h3 class="name"><code>unsubscribe</code></h3>

9229

9230

9231

9232

9233

9234

9235

9236

9237

<span class="flag deprecated" title="use detach">deprecated</span>

9238

9239

9240

9241

9242

9243

9244

9245

9246

9247

9248

9249

9250

9251

<p>Inherited from

9252

<a href="../classes/EventTarget.html#method_unsubscribe">EventTarget</a>:

9253

9254

9255

9256

<a href="../files/event-custom_js_event-target.js.html#l455"><code>event-custom/js/event-target.js:455</code></a>

9257

9258

</p>

9259

9260

9261

9262

<p>Deprecated: use detach</p>

9263

9264

9265

9266

</div>

9267

9268

9269

<p>detach a listener</p>

9270

</div>

9271

9272

9273

9274

9275

9276

9277

</div>

9278

9279

9280

9281

<h3 class="name"><code>unsubscribeAll</code></h3>

9282

9283

9284

9285

9286

9287

9288

9289

9290

9291

</li>

9292

9293

</ul><span class="paren">)</span>

9294

</div>

9295

9296

9297

9298

9299

9300

<span class="flag deprecated" title="use detachAll">deprecated</span>

9301

9302

9303

9304

9305

9306

9307

9308

9309

9310

9311

9312

9313

9314

<p>Inherited from

9315

<a href="../classes/EventTarget.html#method_unsubscribeAll">EventTarget</a>:

9316

9317

9318

9319

<a href="../files/event-custom_js_event-target.js.html#l476"><code>event-custom/js/event-target.js:476</code></a>

9320

9321

</p>

9322

9323

9324

9325

<p>Deprecated: use detachAll</p>

9326

9327

9328

9329

</div>

9330

9331

9332

<p>Removes all listeners from the specified event. If the event type

9333

is not specified, all listeners from all hosted custom events will

9334

be removed.</p>

9335

</div>

9336

9337

9338

9339

<h4>Parameters:</h4>

9340

9341

9342

9343

9344

9345

9346

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

9347

9348

9349

9350

9351

9352

<p>The type, or name of the event</p>

9353

</div>

9354

9355

9356

</li>

9357

9358

</ul>

9359

</div>

9360

9361

9362

9363

9364

9365

</div>

9366

9367

9368

</div>

9369

9370

9371

9372

9373

<h2 class="off-left">Properties</h2>

9374

9375

9376

9377

<h3 class="name"><code>_allowAdHocAttrs</code></h3>

9378

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>

9379

9380

9381

9382

9383

<span class="flag protected">protected</span>

9384

9385

9386

9387

9388

9389

9390

9391

9392

9393

<p>Inherited from

9394

<a href="../classes/BaseCore.html#property__allowAdHocAttrs">BaseCore</a>:

9395

9396

9397

9398

<a href="../files/base_js_BaseCore.js.html#l100"><code>base/js/BaseCore.js:100</code></a>

9399

9400

</p>

9401

9402

9403

9404

9405

</div>

9406

9407

9408

<p>This property controls whether or not instances of this class should

9409

allow users to add ad-hoc attributes through the constructor configuration

9410

hash.</p>

9411

9412

<p>AdHoc attributes are attributes which are not defined by the class, and are

9413

not handled by the MyClass.<em>NON</em>ATTRS_CFG</p>

9414

</div>

9415

9416

9417

<p><strong>Default:</strong> undefined (false)</p>

9418

9419

9420

9421

9422

9423

</div>

9424

9425

9426

9427

9428

<span class="type">Unknown</span>

9429

9430

9431

9432

9433

9434

9435

9436

9437

<span class="flag static">static</span>

9438

9439

9440

9441

9442

9443

9444

<p>

9445

9446

Defined in

9447

9448

9449

9450

9451

<a href="../files/editor_js_editor-tab.js.html#l42"><code>editor/js/editor-tab.js:42</code></a>

9452

9453

</p>

9454

9455

9456

9457

9458

</div>

9459

9460

9461

<p>editorTab</p>

9462

</div>

9463

9464

9465

9466

9467

9468

9469

</div>

9470

9471

9472

9473

9474

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

9475

9476

9477

<span class="flag deprecated" title="Use this.constructor.NAME">deprecated</span>

9478

9479

9480

9481

9482

9483

9484

9485

9486

9487

9488

9489

<p>Inherited from

9490

<a href="../classes/BaseCore.html#property_name">BaseCore</a>:

9491

9492

9493

9494

<a href="../files/base_js_BaseCore.js.html#l196"><code>base/js/BaseCore.js:196</code></a>

9495

9496

</p>

9497

9498

9499

<p>Deprecated: Use this.constructor.NAME</p>

9500

9501

9502

9503

</div>

9504

9505

9506

<p>The string used to identify the class of this object.</p>

9507

</div>

9508

9509

9510

9511

9512

9513

9514

</div>

9515

9516

9517

9518

9519

<span class="type">Unknown</span>

9520

9521

9522

9523

9524

9525

9526

9527

9528

<span class="flag static">static</span>

9529

9530

9531

9532

9533

9534

9535

<p>

9536

9537

Defined in

9538

9539

9540

9541

9542

<a href="../files/editor_js_editor-tab.js.html#l48"><code>editor/js/editor-tab.js:48</code></a>

9543

9544

</p>

9545

9546

9547

9548

9549

</div>

9550

9551

9552

9553

</div>

9554

9555

9556

9557

9558

9559

9560

</div>

9561

9562

9563

</div>

9564

9565

9566

9567

9568

<h2 class="off-left">Attributes</h2>

9569

9570

9571

9572

9573

<h3 class="name"><code>destroyed</code></h3>

9574

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>

9575

9576

9577

9578

9579

9580

9581

9582

9583

9584

9585

9586

9587

<p>Inherited from

9588

<a href="../classes/BaseCore.html#attr_destroyed">BaseCore</a>:

9589

9590

9591

9592

<a href="../files/base_js_BaseCore.js.html#l157"><code>base/js/BaseCore.js:157</code></a>

9593

9594

</p>

9595

9596

9597

9598

9599

</div>

9600

9601

9602

<p>Flag indicating whether or not this object

9603

has been through the destroy lifecycle phase.</p>

9604

</div>

9605

9606

9607

<p><strong>Default:</strong> false</p>

9608

9609

9610

9611

9612

<h4>Fires event <code>destroyedChange</code></h4>

9613

9614

<p>

9615

Fires when the value for the configuration attribute <code>destroyed</code> is

9616

changed. You can listen for the event using the <code>on</code> method if you

9617

wish to be notified before the attribute's value has changed, or

9618

using the <code>after</code> method if you wish to be notified after the

9619

attribute's value has changed.

9620

</p>

9621

9622

9623

<h4>Parameters:</h4>

9624

9625

9626

9627

9628

<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>

9629

9630

9631

An Event Facade object with the following

9632

attribute-specific properties added:

9633

</div>

9634

9635

9636

9637

<code class="param-name">prevVal</code>

9638

9639

<div class="param-description">The value of the attribute, prior to it being set.</div>

9640

</li>

9641

9642

<code class="param-name">newVal</code>

9643

9644

<div class="param-description">The value the attribute is to be set to.</div>

9645

</li>

9646

9647

<code class="param-name">attrName</code>

9648

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

9649

<div class="param-description">The name of the attribute being set.</div>

9650

</li>

9651

9652

<code class="param-name">subAttrName</code>

9653

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

9654

<div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div>

9655

</li>

9656

</ul>

9657

</li>

9658

</ul>

9659

</div>

9660

</div>

9661

9662

9663

9664

</div>

9665

9666

9667

9668

9669

<h3 class="name"><code>initialized</code></h3>

9670

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>

9671

9672

9673

9674

9675

9676

9677

9678

9679

9680

9681

9682

9683

<p>Inherited from

9684

<a href="../classes/BaseCore.html#attr_initialized">BaseCore</a>:

9685

9686

9687

9688

<a href="../files/base_js_BaseCore.js.html#l143"><code>base/js/BaseCore.js:143</code></a>

9689

9690

</p>

9691

9692

9693

9694

9695

</div>

9696

9697

9698

<p>Flag indicating whether or not this object

9699

has been through the init lifecycle phase.</p>

9700

</div>

9701

9702

9703

<p><strong>Default:</strong> false</p>

9704

9705

9706

9707

9708

<h4>Fires event <code>initializedChange</code></h4>

9709

9710

<p>

9711

Fires when the value for the configuration attribute <code>initialized</code> is

9712

changed. You can listen for the event using the <code>on</code> method if you

9713

wish to be notified before the attribute's value has changed, or

9714

using the <code>after</code> method if you wish to be notified after the

9715

attribute's value has changed.

9716

</p>

9717

9718

9719

<h4>Parameters:</h4>

9720

9721

9722

9723

9724

<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>

9725

9726

9727

An Event Facade object with the following

9728

attribute-specific properties added:

9729

</div>

9730

9731

9732

9733

<code class="param-name">prevVal</code>

9734

9735

<div class="param-description">The value of the attribute, prior to it being set.</div>

9736

</li>

9737

9738

<code class="param-name">newVal</code>

9739

9740

<div class="param-description">The value the attribute is to be set to.</div>

9741

</li>

9742

9743

<code class="param-name">attrName</code>

9744

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

9745

<div class="param-description">The name of the attribute being set.</div>

9746

</li>

9747

9748

<code class="param-name">subAttrName</code>

9749

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

9750

<div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div>

9751

</li>

9752

</ul>

9753

</li>

9754

</ul>

9755

</div>

9756

</div>

9757

9758

9759

9760

</div>

9761

9762

9763

</div>

9764

9765

9766

9767

9768

<h2 class="off-left">Events</h2>

9769

9770

9771

9772

<h3 class="name"><code>destroy</code></h3>

9773

9774

9775

9776

9777

9778

9779

9780

9781

9782

9783

9784

9785

9786

<p>Inherited from

9787

<a href="../classes/Base.html#event_destroy">Base</a>:

9788

9789

9790

9791

9792

9793

</p>

9794

9795

9796

9797

9798

</div>

9799

9800

9801

<p>

9802

Lifecycle event for the destroy phase,

9803

fired prior to destruction. Invoking the preventDefault

9804

method on the event object provided to subscribers will

9805

prevent destruction from proceeding.

9806

</p>

9807

9808

<p>

9809

Subscribers to the "after" moment of this event, will be notified

9810

after destruction is complete (and as a result cannot prevent

9811

destruction).

9812

</p>

9813

</div>

9814

9815

9816

9817

<h4>Event Payload:</h4>

9818

9819

9820

9821

9822

9823

9824

<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>

9825

9826

9827

9828

9829

9830

<p>Event object</p>

9831

</div>

9832

9833

9834

</li>

9835

9836

</ul>

9837

</div>

9838

9839

9840

9841

9842

</div>

9843

9844

9845

9846

9847

9848

9849

9850

9851

9852

9853

9854

9855

9856

9857

9858

9859

9860

<p>Inherited from

9861

<a href="../classes/Base.html#event_init">Base</a>:

9862

9863

9864

9865

9866

9867

</p>

9868

9869

9870

9871

9872

</div>

9873

9874

9875

<p>

9876

Lifecycle event for the init phase, fired prior to initialization.

9877

Invoking the preventDefault() method on the event object provided

9878

to subscribers will prevent initialization from occuring.

9879

</p>

9880

9881

<p>

9882

Subscribers to the "after" momemt of this event, will be notified

9883

after initialization of the object is complete (and therefore

9884

cannot prevent initialization).

9885

</p>

9886

</div>

9887

9888

9889

9890

<h4>Event Payload:</h4>

9891

9892

9893

9894

9895

9896

9897

<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>

9898

9899

9900

9901

9902

9903

<p>Event object, with a cfg property which

9904

refers to the configuration object passed to the constructor.</p>

9905

</div>

9906

9907

9908

</li>

9909

9910

</ul>

9911

</div>

9912

9913

9914

9915

9916

</div>

9917

9918

9919

</div>

9920

9921

</div>

9922

</div>

9923

9924

</div>

9925

</div>

9926

</div>

9927

</div>

9928

</div>

9929

</div>

9930

9931

9932

9933

9934

9935

9936

9937

9938

</body>

9939

</html>

Older »