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

2012

2013

2014

2015

2016

2017

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

2018

</div>

2019

2020

2021

</li>

2022

2023

2024

2025

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

2026

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

2027

2028

2029

2030

2031

2032

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

2033

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

2034

</div>

2035

2036

2037

</li>

2038

2039

2040

2041

2042

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

2043

2044

2045

2046

2047

2048

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

2049

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

2050

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

2051

</div>

2052

2053

2054

</li>

2055

2056

</ul>

2057

</div>

2058

2059

2060

2061

2062

2063

</div>

2064

2065

2066

2067

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

2068

2069

2070

2071

2072

2073

2074

2075

2076

2077

</li>

2078

2079

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

2080

</div>

2081

2082

2083

2084

2085

2086

2087

2088

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

2089

2090

2091

2092

2093

2094

2095

2096

2097

2098

2099

2100

<p>Inherited from

2101

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

2102

2103

2104

2105

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

2106

2107

</p>

2108

2109

2110

2111

2112

2113

</div>

2114

2115

2116

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

2117

</div>

2118

2119

2120

2121

<h4>Parameters:</h4>

2122

2123

2124

2125

2126

2127

2128

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

2129

2130

2131

2132

2133

2134

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

2135

</div>

2136

2137

2138

</li>

2139

2140

</ul>

2141

</div>

2142

2143

2144

2145

2146

2147

</div>

2148

2149

2150

2151

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

2152

2153

2154

2155

2156

2157

2158

2159

<code>allAttrs</code>

2160

2161

</li>

2162

2163

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

2164

</div>

2165

2166

2167

2168

2169

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

2170

</span>

2171

2172

2173

2174

2175

2176

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

2177

2178

2179

2180

2181

2182

2183

2184

2185

2186

2187

2188

<p>Inherited from

2189

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

2190

2191

2192

2193

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

2194

2195

</p>

2196

2197

2198

2199

2200

2201

</div>

2202

2203

2204

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

2205

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

2206

2207

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

2208

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

2209

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

2210

</div>

2211

2212

2213

2214

<h4>Parameters:</h4>

2215

2216

2217

2218

2219

2220

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

2221

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

2222

2223

2224

2225

2226

2227

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

2228

(subclass first, Base last)</p>

2229

</div>

2230

2231

2232

</li>

2233

2234

</ul>

2235

</div>

2236

2237

2238

2239

2240

<h4>Returns:</h4>

2241

2242

2243

2244

2245

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

2246

2247

The aggregate set of ATTRS definitions for the instance

2248

2249

</div>

2250

</div>

2251

2252

2253

2254

</div>

2255

2256

2257

2258

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

2259

2260

2261

2262

2263

2264

2265

2266

2267

2268

2269

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

2270

2271

2272

2273

2274

2275

2276

2277

2278

2279

2280

<p>Inherited from

2281

2282

BaseCore

2283

</a>

2284

2285

but overwritten in

2286

2287

2288

2289

2290

2291

</p>

2292

2293

2294

2295

2296

2297

</div>

2298

2299

2300

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

2301

this class.</p>

2302

</div>

2303

2304

2305

2306

2307

2308

2309

</div>

2310

2311

2312

2313

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

2314

2315

2316

2317

2318

2319

2320

2321

2322

2323

2324

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

2325

2326

2327

2328

2329

2330

2331

2332

2333

2334

2335

2336

<p>Inherited from

2337

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

2338

2339

2340

2341

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

2342

2343

</p>

2344

2345

2346

2347

2348

2349

</div>

2350

2351

2352

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

2353

</div>

2354

2355

2356

2357

2358

2359

2360

</div>

2361

2362

2363

2364

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

2365

2366

2367

2368

2369

2370

2371

2372

2373

2374

2375

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

2376

2377

2378

2379

2380

2381

2382

2383

2384

2385

2386

2387

<p>Inherited from

2388

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

2389

2390

2391

2392

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

2393

2394

</p>

2395

2396

2397

2398

2399

2400

</div>

2401

2402

2403

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

2404

</div>

2405

2406

2407

2408

2409

2410

2411

</div>

2412

2413

2414

2415

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

2416

2417

2418

2419

2420

2421

2422

2423

2424

2425

</li>

2426

2427

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

2428

</div>

2429

2430

2431

2432

2433

2434

2435

2436

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

2437

2438

2439

2440

2441

2442

2443

2444

2445

2446

2447

2448

<p>Inherited from

2449

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

2450

2451

2452

2453

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

2454

2455

</p>

2456

2457

2458

2459

2460

2461

</div>

2462

2463

2464

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

2465

</div>

2466

2467

2468

2469

<h4>Parameters:</h4>

2470

2471

2472

2473

2474

2475

2476

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

2477

2478

2479

2480

2481

2482

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

2483

</div>

2484

2485

2486

</li>

2487

2488

</ul>

2489

</div>

2490

2491

2492

2493

2494

2495

</div>

2496

2497

2498

2499

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

2500

2501

2502

2503

2504

2505

2506

2507

2508

2509

</li>

2510

2511

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

2512

</div>

2513

2514

2515

2516

2517

2518

2519

2520

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

2521

2522

2523

2524

2525

2526

2527

2528

2529

2530

2531

2532

<p>Inherited from

2533

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

2534

2535

2536

2537

2538

2539

</p>

2540

2541

2542

2543

2544

2545

</div>

2546

2547

2548

<p>Default destroy event handler</p>

2549

</div>

2550

2551

2552

2553

<h4>Parameters:</h4>

2554

2555

2556

2557

2558

2559

2560

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

2561

2562

2563

2564

2565

2566

<p>Event object</p>

2567

</div>

2568

2569

2570

</li>

2571

2572

</ul>

2573

</div>

2574

2575

2576

2577

2578

2579

</div>

2580

2581

2582

2583

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

2584

2585

2586

2587

2588

2589

2590

2591

2592

2593

</li>

2594

2595

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

2596

</div>

2597

2598

2599

2600

2601

2602

2603

2604

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

2605

2606

2607

2608

2609

2610

2611

2612

2613

2614

2615

2616

<p>Inherited from

2617

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

2618

2619

2620

2621

2622

2623

</p>

2624

2625

2626

2627

2628

2629

</div>

2630

2631

2632

<p>Default init event handler</p>

2633

</div>

2634

2635

2636

2637

<h4>Parameters:</h4>

2638

2639

2640

2641

2642

2643

2644

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

2645

2646

2647

2648

2649

2650

<p>Event object, with a cfg property which

2651

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

2652

</div>

2653

2654

2655

</li>

2656

2657

</ul>

2658

</div>

2659

2660

2661

2662

2663

2664

</div>

2665

2666

2667

2668

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

2669

2670

2671

2672

2673

2674

2675

2676

2677

2678

2679

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

2680

2681

2682

2683

2684

2685

2686

2687

2688

2689

2690

2691

<p>Inherited from

2692

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

2693

2694

2695

2696

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

2697

2698

</p>

2699

2700

2701

2702

2703

2704

</div>

2705

2706

2707

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

2708

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

2709

</div>

2710

2711

2712

2713

2714

2715

2716

</div>

2717

2718

2719

2720

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

2721

2722

2723

2724

2725

2726

2727

2728

<code>allAttrs</code>

2729

2730

</li>

2731

2732

2733

2734

<code>userVals</code>

2735

2736

</li>

2737

2738

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

2739

</div>

2740

2741

2742

2743

2744

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

2745

</span>

2746

2747

2748

2749

2750

2751

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

2752

2753

2754

2755

2756

2757

2758

2759

2760

2761

2762

2763

<p>Inherited from

2764

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

2765

2766

2767

2768

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

2769

2770

</p>

2771

2772

2773

2774

2775

2776

</div>

2777

2778

2779

2780

</div>

2781

2782

2783

2784

<h4>Parameters:</h4>

2785

2786

2787

2788

2789

2790

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

2791

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

2792

2793

2794

2795

2796

2797

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

2798

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

2799

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

2800

</div>

2801

2802

2803

</li>

2804

2805

2806

2807

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

2808

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

2809

2810

2811

2812

2813

2814

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

2815

</div>

2816

2817

2818

</li>

2819

2820

</ul>

2821

</div>

2822

2823

2824

2825

2826

<h4>Returns:</h4>

2827

2828

2829

2830

2831

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

2832

2833

The set of adhoc attributes passed in, in the form

2834

of an object with attribute name/configuration pairs.

2835

2836

</div>

2837

</div>

2838

2839

2840

2841

</div>

2842

2843

2844

2845

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

2846

2847

2848

2849

2850

2851

2852

2853

<code>clazz</code>

2854

2855

</li>

2856

2857

2858

2859

<code>allCfgs</code>

2860

2861

</li>

2862

2863

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

2864

</div>

2865

2866

2867

2868

2869

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

2870

</span>

2871

2872

2873

2874

2875

2876

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

2877

2878

2879

2880

2881

2882

2883

2884

2885

2886

2887

2888

<p>Inherited from

2889

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

2890

2891

2892

2893

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

2894

2895

</p>

2896

2897

2898

2899

2900

2901

</div>

2902

2903

2904

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

2905

initialization. Returns a disposable object with the attributes defined for

2906

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

2907

</div>

2908

2909

2910

2911

<h4>Parameters:</h4>

2912

2913

2914

2915

2916

2917

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

2918

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

2919

2920

2921

2922

2923

2924

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

2925

</div>

2926

2927

2928

</li>

2929

2930

2931

2932

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

2933

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

2934

2935

2936

2937

2938

2939

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

2940

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

2941

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

2942

</div>

2943

2944

2945

</li>

2946

2947

</ul>

2948

</div>

2949

2950

2951

2952

2953

<h4>Returns:</h4>

2954

2955

2956

2957

2958

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

2959

2960

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

2961

of an object with attribute name/configuration pairs.

2962

2963

</div>

2964

</div>

2965

2966

2967

2968

</div>

2969

2970

2971

2972

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

2973

2974

2975

2976

2977

2978

2979

2980

<code>attrName</code>

2981

2982

</li>

2983

2984

2985

2986

<code>subAttrName</code>

2987

2988

</li>

2989

2990

2991

2992

<code>currVal</code>

2993

2994

</li>

2995

2996

2997

2998

<code>newVal</code>

2999

3000

</li>

3001

3002

3003

3004

3005

3006

</li>

3007

3008

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

3009

</div>

3010

3011

3012

3013

3014

3015

3016

3017

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

3018

3019

3020

3021

3022

3023

3024

3025

3026

3027

3028

3029

<p>Inherited from

3030

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

3031

3032

3033

3034

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

3035

3036

</p>

3037

3038

3039

3040

3041

3042

</div>

3043

3044

3045

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

3046

</div>

3047

3048

3049

3050

<h4>Parameters:</h4>

3051

3052

3053

3054

3055

3056

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

3057

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

3058

3059

3060

3061

3062

3063

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

3064

</div>

3065

3066

3067

</li>

3068

3069

3070

3071

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

3072

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

3073

3074

3075

3076

3077

3078

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

3079

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

3080

</div>

3081

3082

3083

</li>

3084

3085

3086

3087

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

3088

3089

3090

3091

3092

3093

3094

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

3095

</div>

3096

3097

3098

</li>

3099

3100

3101

3102

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

3103

3104

3105

3106

3107

3108

3109

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

3110

</div>

3111

3112

3113

</li>

3114

3115

3116

3117

3118

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

3119

3120

3121

3122

3123

3124

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

3125

</div>

3126

3127

3128

</li>

3129

3130

</ul>

3131

</div>

3132

3133

3134

3135

3136

3137

</div>

3138

3139

3140

3141

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

3142

3143

3144

3145

3146

3147

3148

3149

3150

3151

</li>

3152

3153

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

3154

</div>

3155

3156

3157

3158

3159

3160

</span>

3161

3162

3163

3164

3165

3166

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

3167

3168

3169

3170

3171

3172

3173

3174

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

3175

3176

3177

3178

3179

3180

<p>Inherited from

3181

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

3182

3183

3184

3185

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

3186

3187

</p>

3188

3189

3190

3191

3192

3193

</div>

3194

3195

3196

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

3197

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

3198

3199

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

3200

</div>

3201

3202

3203

3204

<h4>Parameters:</h4>

3205

3206

3207

3208

3209

3210

3211

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

3212

3213

3214

3215

3216

3217

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

3218

</div>

3219

3220

3221

</li>

3222

3223

</ul>

3224

</div>

3225

3226

3227

3228

3229

<h4>Returns:</h4>

3230

3231

3232

3233

3234

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

3235

3236

The value of the attribute.

3237

3238

</div>

3239

</div>

3240

3241

3242

3243

</div>

3244

3245

3246

3247

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

3248

3249

3250

3251

3252

3253

3254

3255

3256

3257

</li>

3258

3259

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

3260

</div>

3261

3262

3263

3264

3265

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

3266

</span>

3267

3268

3269

3270

3271

3272

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

3273

3274

3275

3276

3277

3278

3279

3280

3281

3282

3283

3284

<p>Inherited from

3285

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

3286

3287

3288

3289

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

3290

3291

</p>

3292

3293

3294

3295

3296

3297

</div>

3298

3299

3300

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

3301

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

3302

configuration properties for all attributes.</p>

3303

</div>

3304

3305

3306

3307

<h4>Parameters:</h4>

3308

3309

3310

3311

3312

3313

3314

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

3315

3316

3317

3318

3319

3320

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

3321

</div>

3322

3323

3324

</li>

3325

3326

</ul>

3327

</div>

3328

3329

3330

3331

3332

<h4>Returns:</h4>

3333

3334

3335

3336

3337

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

3338

3339

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

3340

3341

</div>

3342

</div>

3343

3344

3345

3346

</div>

3347

3348

3349

3350

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

3351

3352

3353

3354

3355

3356

3357

3358

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

3359

</span>

3360

3361

3362

3363

3364

3365

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

3366

3367

3368

3369

3370

3371

3372

3373

3374

3375

3376

3377

<p>Inherited from

3378

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

3379

3380

3381

3382

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

3383

3384

</p>

3385

3386

3387

3388

3389

3390

</div>

3391

3392

3393

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

3394

the class hierarchy.</p>

3395

</div>

3396

3397

3398

3399

3400

3401

<h4>Returns:</h4>

3402

3403

3404

3405

3406

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

3407

3408

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

3409

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

3410

the cached value.

3411

3412

</div>

3413

</div>

3414

3415

3416

3417

</div>

3418

3419

3420

3421

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

3422

3423

3424

3425

3426

3427

3428

3429

3430

3431

</li>

3432

3433

3434

3435

3436

3437

</li>

3438

3439

3440

3441

<code>initValues</code>

3442

3443

</li>

3444

3445

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

3446

</div>

3447

3448

3449

3450

3451

3452

</span>

3453

3454

3455

3456

3457

3458

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

3459

3460

3461

3462

3463

3464

3465

3466

3467

3468

3469

<p>Inherited from

3470

3471

AttributeCore

3472

</a>

3473

3474

but overwritten in

3475

3476

3477

3478

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

3479

3480

</p>

3481

3482

3483

3484

3485

3486

</div>

3487

3488

3489

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

3490

either the default configuration provided, or the

3491

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

3492

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

3493

</div>

3494

3495

3496

3497

<h4>Parameters:</h4>

3498

3499

3500

3501

3502

3503

3504

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

3505

3506

3507

3508

3509

3510

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

3511

</div>

3512

3513

3514

</li>

3515

3516

3517

3518

3519

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

3520

3521

3522

3523

3524

3525

<p>The attribute configuration object</p>

3526

</div>

3527

3528

3529

</li>

3530

3531

3532

3533

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

3534

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

3535

3536

3537

3538

3539

3540

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

3541

</div>

3542

3543

3544

</li>

3545

3546

</ul>

3547

</div>

3548

3549

3550

3551

3552

<h4>Returns:</h4>

3553

3554

3555

3556

3557

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

3558

3559

The initial value of the attribute.

3560

3561

</div>

3562

</div>

3563

3564

3565

3566

</div>

3567

3568

3569

3570

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

3571

3572

3573

3574

3575

3576

3577

3578

<code>attrs</code>

3579

3580

</li>

3581

3582

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

3583

</div>

3584

3585

3586

3587

3588

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

3589

</span>

3590

3591

3592

3593

3594

3595

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

3596

3597

3598

3599

3600

3601

3602

3603

3604

3605

3606

3607

<p>Inherited from

3608

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

3609

3610

3611

3612

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

3613

3614

</p>

3615

3616

3617

3618

3619

3620

</div>

3621

3622

3623

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

3624

</div>

3625

3626

3627

3628

<h4>Parameters:</h4>

3629

3630

3631

3632

3633

3634

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

3635

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

3636

3637

3638

3639

3640

3641

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

3642

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

3643

</div>

3644

3645

3646

</li>

3647

3648

</ul>

3649

</div>

3650

3651

3652

3653

3654

<h4>Returns:</h4>

3655

3656

3657

3658

3659

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

3660

3661

An object with attribute name/value pairs.

3662

3663

</div>

3664

</div>

3665

3666

3667

3668

</div>

3669

3670

3671

3672

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

3673

3674

3675

3676

3677

3678

3679

3680

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

3681

</span>

3682

3683

3684

3685

3686

3687

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

3688

3689

3690

3691

3692

3693

3694

3695

3696

3697

3698

3699

<p>Inherited from

3700

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

3701

3702

3703

3704

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

3705

3706

</p>

3707

3708

3709

3710

3711

3712

</div>

3713

3714

3715

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

3716

</div>

3717

3718

3719

3720

3721

3722

<h4>Returns:</h4>

3723

3724

3725

3726

3727

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

3728

3729

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

3730

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

3731

cached value.

3732

3733

</div>

3734

</div>

3735

3736

3737

3738

</div>

3739

3740

3741

3742

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

3743

3744

3745

3746

3747

3748

3749

3750

3751

3752

</li>

3753

3754

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

3755

</div>

3756

3757

3758

3759

3760

3761

</span>

3762

3763

3764

3765

3766

3767

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

3768

3769

3770

3771

3772

3773

3774

3775

3776

3777

3778

3779

<p>Inherited from

3780

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

3781

3782

3783

3784

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

3785

3786

</p>

3787

3788

3789

3790

3791

3792

</div>

3793

3794

3795

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

3796

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

3797

</div>

3798

3799

3800

3801

<h4>Parameters:</h4>

3802

3803

3804

3805

3806

3807

3808

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

3809

3810

3811

3812

3813

3814

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

3815

</div>

3816

3817

3818

</li>

3819

3820

</ul>

3821

</div>

3822

3823

3824

3825

3826

<h4>Returns:</h4>

3827

3828

3829

3830

3831

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

3832

3833

The stored value of the attribute

3834

3835

</div>

3836

</div>

3837

3838

3839

3840

</div>

3841

3842

3843

3844

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

3845

3846

3847

3848

3849

3850

3851

3852

3853

3854

3855

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

3856

3857

3858

3859

3860

3861

3862

3863

3864

3865

3866

3867

<p>Inherited from

3868

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

3869

3870

3871

3872

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

3873

3874

</p>

3875

3876

3877

3878

3879

3880

</div>

3881

3882

3883

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

3884

event type is not prefixed, the instance prefix is

3885

applied to the supplied type.</p>

3886

</div>

3887

3888

3889

3890

3891

3892

3893

</div>

3894

3895

3896

3897

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

3898

3899

3900

3901

3902

3903

3904

3905

<code>attrs</code>

3906

3907

</li>

3908

3909

3910

3911

<code>values</code>

3912

3913

</li>

3914

3915

3916

3917

3918

3919

</li>

3920

3921

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

3922

</div>

3923

3924

3925

3926

3927

3928

3929

3930

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

3931

3932

3933

3934

3935

3936

3937

3938

3939

3940

3941

3942

<p>Inherited from

3943

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

3944

3945

3946

3947

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

3948

3949

</p>

3950

3951

3952

3953

3954

3955

</div>

3956

3957

3958

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

3959

constructor.</p>

3960

</div>

3961

3962

3963

3964

<h4>Parameters:</h4>

3965

3966

3967

3968

3969

3970

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

3971

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

3972

3973

3974

3975

3976

3977

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

3978

</div>

3979

3980

3981

</li>

3982

3983

3984

3985

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

3986

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

3987

3988

3989

3990

3991

3992

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

3993

</div>

3994

3995

3996

</li>

3997

3998

3999

4000

4001

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

4002

4003

4004

4005

4006

4007

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

4008

</div>

4009

4010

4011

</li>

4012

4013

</ul>

4014

</div>

4015

4016

4017

4018

4019

4020

</div>

4021

4022

4023

4024

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

4025

4026

4027

4028

4029

4030

4031

4032

4033

4034

4035

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

4036

4037

4038

4039

4040

4041

4042

4043

4044

4045

4046

<p>Inherited from

4047

4048

BaseCore

4049

</a>

4050

4051

but overwritten in

4052

4053

4054

4055

4056

4057

</p>

4058

4059

4060

4061

4062

4063

</div>

4064

4065

4066

<p>Initializes Attribute</p>

4067

</div>

4068

4069

4070

4071

4072

4073

4074

</div>

4075

4076

4077

4078

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

4079

4080

4081

4082

4083

4084

4085

4086

<code>attrs</code>

4087

4088

</li>

4089

4090

4091

4092

<code>values</code>

4093

4094

</li>

4095

4096

4097

4098

4099

4100

</li>

4101

4102

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

4103

</div>

4104

4105

4106

4107

4108

4109

4110

4111

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

4112

4113

4114

4115

4116

4117

4118

4119

4120

4121

4122

4123

<p>Inherited from

4124

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

4125

4126

4127

4128

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

4129

4130

</p>

4131

4132

4133

4134

4135

4136

</div>

4137

4138

4139

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

4140

</div>

4141

4142

4143

4144

<h4>Parameters:</h4>

4145

4146

4147

4148

4149

4150

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

4151

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

4152

4153

4154

4155

4156

4157

4158

</div>

4159

4160

4161

</li>

4162

4163

4164

4165

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

4166

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

4167

4168

4169

4170

4171

4172

4173

</div>

4174

4175

4176

</li>

4177

4178

4179

4180

4181

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

4182

4183

4184

4185

4186

4187

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

4188

</div>

4189

4190

4191

</li>

4192

4193

</ul>

4194

</div>

4195

4196

4197

4198

4199

4200

</div>

4201

4202

4203

4204

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

4205

4206

4207

4208

4209

4210

4211

4212

<code>config</code>

4213

4214

</li>

4215

4216

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

4217

</div>

4218

4219

4220

4221

4222

4223

4224

4225

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

4226

4227

4228

4229

4230

4231

4232

4233

4234

4235

4236

<p>Inherited from

4237

4238

BaseCore

4239

</a>

4240

4241

but overwritten in

4242

4243

4244

4245

4246

4247

</p>

4248

4249

4250

4251

4252

4253

</div>

4254

4255

4256

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

4257

</div>

4258

4259

4260

4261

<h4>Parameters:</h4>

4262

4263

4264

4265

4266

4267

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

4268

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

4269

4270

4271

4272

4273

4274

<p>The constructor configuration object</p>

4275

</div>

4276

4277

4278

</li>

4279

4280

</ul>

4281

</div>

4282

4283

4284

4285

4286

4287

</div>

4288

4289

4290

4291

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

4292

4293

4294

4295

4296

4297

4298

4299

<code>config</code>

4300

4301

</li>

4302

4303

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

4304

</div>

4305

4306

4307

4308

4309

4310

4311

4312

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

4313

4314

4315

4316

4317

4318

4319

4320

4321

4322

4323

4324

<p>Inherited from

4325

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

4326

4327

4328

4329

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

4330

4331

</p>

4332

4333

4334

4335

4336

4337

</div>

4338

4339

4340

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

4341

</div>

4342

4343

4344

4345

<h4>Parameters:</h4>

4346

4347

4348

4349

4350

4351

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

4352

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

4353

4354

4355

4356

4357

4358

<p>The constructor configuration object</p>

4359

</div>

4360

4361

4362

</li>

4363

4364

</ul>

4365

</div>

4366

4367

4368

4369

4370

4371

</div>

4372

4373

4374

4375

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

4376

4377

4378

4379

4380

4381

4382

4383

<code>userVals</code>

4384

4385

</li>

4386

4387

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

4388

</div>

4389

4390

4391

4392

4393

4394

4395

4396

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

4397

4398

4399

4400

4401

4402

4403

4404

4405

4406

4407

4408

<p>Inherited from

4409

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

4410

4411

4412

4413

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

4414

4415

</p>

4416

4417

4418

4419

4420

4421

</div>

4422

4423

4424

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

4425

initializing attributes for each class defined in the class's

4426

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

4427

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

4428

</div>

4429

4430

4431

4432

<h4>Parameters:</h4>

4433

4434

4435

4436

4437

4438

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

4439

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

4440

4441

4442

4443

4444

4445

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

4446

</div>

4447

4448

4449

</li>

4450

4451

</ul>

4452

</div>

4453

4454

4455

4456

4457

4458

</div>

4459

4460

4461

4462

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

4463

4464

4465

4466

4467

4468

4469

4470

4471

4472

4473

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

4474

4475

4476

4477

4478

4479

4480

4481

4482

4483

4484

4485

<p>Inherited from

4486

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

4487

4488

4489

4490

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

4491

4492

</p>

4493

4494

4495

4496

4497

4498

</div>

4499

4500

4501

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

4502

the array of classes and aggregate set of attribute configurations

4503

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

4504

</div>

4505

4506

4507

4508

4509

4510

4511

</div>

4512

4513

4514

4515

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

4516

4517

4518

4519

4520

4521

4522

4523

4524

4525

</li>

4526

4527

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

4528

</div>

4529

4530

4531

4532

4533

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

4534

</span>

4535

4536

4537

4538

4539

4540

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

4541

4542

4543

4544

4545

4546

4547

4548

4549

4550

4551

4552

<p>Inherited from

4553

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

4554

4555

4556

4557

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

4558

4559

</p>

4560

4561

4562

4563

4564

4565

</div>

4566

4567

4568

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

4569

added lazily and still requires initialization.</p>

4570

</div>

4571

4572

4573

4574

<h4>Parameters:</h4>

4575

4576

4577

4578

4579

4580

4581

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

4582

4583

4584

4585

4586

4587

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

4588

</div>

4589

4590

4591

</li>

4592

4593

</ul>

4594

</div>

4595

4596

4597

4598

4599

<h4>Returns:</h4>

4600

4601

4602

4603

4604

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

4605

4606

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

4607

4608

</div>

4609

</div>

4610

4611

4612

4613

</div>

4614

4615

4616

4617

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

4618

4619

4620

4621

4622

4623

4624

4625

4626

4627

</li>

4628

4629

4630

4631

4632

4633

</li>

4634

4635

4636

4637

4638

4639

</li>

4640

4641

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

4642

</div>

4643

4644

4645

4646

4647

4648

4649

4650

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

4651

4652

4653

4654

4655

4656

4657

4658

4659

4660

4661

4662

<p>Inherited from

4663

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

4664

4665

4666

4667

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

4668

4669

</p>

4670

4671

4672

4673

4674

4675

</div>

4676

4677

4678

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

4679

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

4680

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

4681

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

4682

be subscribed to like other events to monitor the event

4683

system. Inividual published events can have monitoring

4684

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

4685

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

4686

</div>

4687

4688

4689

4690

<h4>Parameters:</h4>

4691

4692

4693

4694

4695

4696

4697

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

4698

4699

4700

4701

4702

4703

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

4704

</div>

4705

4706

4707

</li>

4708

4709

4710

4711

4712

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

4713

4714

4715

4716

4717

4718

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

4719

</div>

4720

4721

4722

</li>

4723

4724

4725

4726

4727

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

4728

4729

4730

4731

4732

4733

<p>Information about the event interaction, such as

4734

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

4735

</div>

4736

4737

4738

</li>

4739

4740

</ul>

4741

</div>

4742

4743

4744

4745

4746

4747

</div>

4748

4749

4750

4751

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

4752

4753

4754

4755

4756

4757

4758

4759

<code>valueHash</code>

4760

4761

</li>

4762

4763

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

4764

</div>

4765

4766

4767

4768

4769

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

4770

</span>

4771

4772

4773

4774

4775

4776

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

4777

4778

4779

4780

4781

4782

4783

4784

4785

4786

4787

<p>Inherited from

4788

4789

AttributeCore

4790

</a>

4791

4792

but overwritten in

4793

4794

4795

4796

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

4797

4798

</p>

4799

4800

4801

4802

4803

4804

</div>

4805

4806

4807

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

4808

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

4809

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

4810

</div>

4811

4812

4813

4814

<h4>Parameters:</h4>

4815

4816

4817

4818

4819

4820

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

4821

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

4822

4823

4824

4825

4826

4827

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

4828

</div>

4829

4830

4831

</li>

4832

4833

</ul>

4834

</div>

4835

4836

4837

4838

4839

<h4>Returns:</h4>

4840

4841

4842

4843

4844

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

4845

4846

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

4847

containing simple and complex attribute values respectively keyed

4848

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

4849

4850

</div>

4851

</div>

4852

4853

4854

4855

</div>

4856

4857

4858

4859

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

4860

4861

4862

4863

4864

4865

4866

4867

4868

4869

4870

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

4871

4872

4873

4874

4875

4876

4877

4878

4879

4880

4881

4882

<p>Inherited from

4883

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

4884

4885

4886

4887

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

4888

4889

</p>

4890

4891

4892

4893

4894

4895

</div>

4896

4897

4898

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

4899

and the prefixed event name from _getType

4900

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

4901

</div>

4902

4903

4904

4905

4906

4907

4908

</div>

4909

4910

4911

4912

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

4913

4914

4915

4916

4917

4918

4919

4920

<code>config</code>

4921

4922

</li>

4923

4924

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

4925

</div>

4926

4927

4928

4929

4930

4931

4932

4933

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

4934

4935

4936

4937

4938

4939

4940

4941

4942

4943

4944

4945

<p>Inherited from

4946

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

4947

4948

4949

4950

4951

4952

</p>

4953

4954

4955

4956

4957

4958

</div>

4959

4960

4961

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

4962

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

4963

construction, prior to init.</p>

4964

</div>

4965

4966

4967

4968

<h4>Parameters:</h4>

4969

4970

4971

4972

4973

4974

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

4975

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

4976

4977

4978

4979

4980

4981

<p>The user configuration object</p>

4982

</div>

4983

4984

4985

</li>

4986

4987

</ul>

4988

</div>

4989

4990

4991

4992

4993

4994

</div>

4995

4996

4997

4998

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

4999

5000

5001

5002

5003

5004

5005

5006

<code>attrs</code>

5007

5008

</li>

5009

5010

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

5011

</div>

5012

5013

5014

5015

5016

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

5017

</span>

5018

5019

5020

5021

5022

5023

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

5024

5025

5026

5027

5028

5029

5030

5031

5032

5033

5034

5035

<p>Inherited from

5036

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

5037

5038

5039

5040

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

5041

5042

</p>

5043

5044

5045

5046

5047

5048

</div>

5049

5050

5051

<p>Utility method to protect an attribute configuration

5052

hash, by merging the entire object and the individual

5053

attr config objects.</p>

5054

</div>

5055

5056

5057

5058

<h4>Parameters:</h4>

5059

5060

5061

5062

5063

5064

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

5065

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

5066

5067

5068

5069

5070

5071

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

5072

</div>

5073

5074

5075

</li>

5076

5077

</ul>

5078

</div>

5079

5080

5081

5082

5083

<h4>Returns:</h4>

5084

5085

5086

5087

5088

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

5089

5090

A protected version of the attrs argument.

5091

5092

</div>

5093

</div>

5094

5095

5096

5097

</div>

5098

5099

5100

5101

5102

5103

5104

5105

5106

5107

5108

5109

5110

5111

</li>

5112

5113

5114

5115

5116

5117

</li>

5118

5119

5120

5121

5122

5123

</li>

5124

5125

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

5126

</div>

5127

5128

5129

5130

5131

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

5132

</span>

5133

5134

5135

5136

5137

5138

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

5139

5140

5141

5142

5143

5144

5145

5146

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

5147

5148

5149

5150

5151

<p>Inherited from

5152

5153

AttributeCore

5154

</a>

5155

5156

but overwritten in

5157

5158

5159

5160

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

5161

5162

</p>

5163

5164

5165

5166

5167

5168

</div>

5169

5170

5171

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

5172

</div>

5173

5174

5175

5176

<h4>Parameters:</h4>

5177

5178

5179

5180

5181

5182

5183

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

5184

5185

5186

5187

5188

5189

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

5190

</div>

5191

5192

5193

</li>

5194

5195

5196

5197

5198

5199

5200

5201

5202

5203

5204

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

5205

</div>

5206

5207

5208

</li>

5209

5210

5211

5212

5213

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

5214

5215

5216

5217

5218

5219

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

5220

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

5221

</div>

5222

5223

5224

</li>

5225

5226

</ul>

5227

</div>

5228

5229

5230

5231

5232

<h4>Returns:</h4>

5233

5234

5235

5236

5237

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

5238

5239

A reference to the host object.

5240

5241

</div>

5242

</div>

5243

5244

5245

5246

</div>

5247

5248

5249

5250

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

5251

5252

5253

5254

5255

5256

5257

5258

5259

5260

</li>

5261

5262

5263

5264

<code>value</code>

5265

5266

</li>

5267

5268

5269

5270

5271

5272

</li>

5273

5274

5275

5276

<code>force</code>

5277

5278

</li>

5279

5280

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

5281

</div>

5282

5283

5284

5285

5286

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

5287

</span>

5288

5289

5290

5291

5292

5293

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

5294

5295

5296

5297

5298

5299

5300

5301

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

5302

5303

5304

5305

5306

5307

<p>Inherited from

5308

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

5309

5310

5311

5312

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

5313

5314

</p>

5315

5316

5317

5318

5319

5320

</div>

5321

5322

5323

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

5324

5325

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

5326

</div>

5327

5328

5329

5330

<h4>Parameters:</h4>

5331

5332

5333

5334

5335

5336

5337

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

5338

5339

5340

5341

5342

5343

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

5344

</div>

5345

5346

5347

</li>

5348

5349

5350

5351

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

5352

5353

5354

5355

5356

5357

5358

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

5359

</div>

5360

5361

5362

</li>

5363

5364

5365

5366

5367

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

5368

5369

5370

5371

5372

5373

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

5374

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

5375

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

5376

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

5377

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

5378

</div>

5379

5380

5381

</li>

5382

5383

5384

5385

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

5386

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

5387

5388

5389

5390

5391

5392

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

5393

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

5394

</div>

5395

5396

5397

</li>

5398

5399

</ul>

5400

</div>

5401

5402

5403

5404

5405

<h4>Returns:</h4>

5406

5407

5408

5409

5410

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

5411

5412

A reference to the host object.

5413

5414

</div>

5415

</div>

5416

5417

5418

5419

</div>

5420

5421

5422

5423

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

5424

5425

5426

5427

5428

5429

5430

5431

<code>attrs</code>

5432

5433

</li>

5434

5435

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

5436

</div>

5437

5438

5439

5440

5441

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

5442

</span>

5443

5444

5445

5446

5447

5448

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

5449

5450

5451

5452

5453

5454

5455

5456

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

5457

5458

5459

5460

5461

5462

<p>Inherited from

5463

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

5464

5465

5466

5467

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

5468

5469

</p>

5470

5471

5472

5473

5474

5475

</div>

5476

5477

5478

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

5479

</div>

5480

5481

5482

5483

<h4>Parameters:</h4>

5484

5485

5486

5487

5488

5489

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

5490

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

5491

5492

5493

5494

5495

5496

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

5497

</div>

5498

5499

5500

</li>

5501

5502

</ul>

5503

</div>

5504

5505

5506

5507

5508

<h4>Returns:</h4>

5509

5510

5511

5512

5513

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

5514

5515

A reference to the host object.

5516

5517

</div>

5518

</div>

5519

5520

5521

5522

</div>

5523

5524

5525

5526

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

5527

5528

5529

5530

5531

5532

5533

5534

<code>attrName</code>

5535

5536

</li>

5537

5538

5539

5540

<code>subAttrName</code>

5541

5542

</li>

5543

5544

5545

5546

<code>prevVal</code>

5547

5548

</li>

5549

5550

5551

5552

<code>newVal</code>

5553

5554

</li>

5555

5556

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

5557

</div>

5558

5559

5560

5561

5562

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

5563

</span>

5564

5565

5566

5567

5568

5569

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

5570

5571

5572

5573

5574

5575

5576

5577

5578

5579

5580

5581

<p>Inherited from

5582

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

5583

5584

5585

5586

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

5587

5588

</p>

5589

5590

5591

5592

5593

5594

</div>

5595

5596

5597

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

5598

if validation and setter passes.</p>

5599

</div>

5600

5601

5602

5603

<h4>Parameters:</h4>

5604

5605

5606

5607

5608

5609

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

5610

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

5611

5612

5613

5614

5615

5616

<p>The attribute name.</p>

5617

</div>

5618

5619

5620

</li>

5621

5622

5623

5624

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

5625

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

5626

5627

5628

5629

5630

5631

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

5632

</div>

5633

5634

5635

</li>

5636

5637

5638

5639

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

5640

5641

5642

5643

5644

5645

5646

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

5647

</div>

5648

5649

5650

</li>

5651

5652

5653

5654

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

5655

5656

5657

5658

5659

5660

5661

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

5662

</div>

5663

5664

5665

</li>

5666

5667

</ul>

5668

</div>

5669

5670

5671

5672

5673

<h4>Returns:</h4>

5674

5675

5676

5677

5678

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

5679

5680

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

5681

5682

</div>

5683

</div>

5684

5685

5686

5687

</div>

5688

5689

5690

5691

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

5692

5693

5694

5695

5696

5697

5698

5699

5700

5701

</li>

5702

5703

5704

5705

<code>value</code>

5706

5707

</li>

5708

5709

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

5710

</div>

5711

5712

5713

5714

5715

5716

5717

5718

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

5719

5720

5721

5722

5723

5724

5725

5726

5727

5728

5729

5730

<p>Inherited from

5731

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

5732

5733

5734

5735

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

5736

5737

</p>

5738

5739

5740

5741

5742

5743

</div>

5744

5745

5746

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

5747

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

5748

</div>

5749

5750

5751

5752

<h4>Parameters:</h4>

5753

5754

5755

5756

5757

5758

5759

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

5760

5761

5762

5763

5764

5765

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

5766

</div>

5767

5768

5769

</li>

5770

5771

5772

5773

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

5774

5775

5776

5777

5778

5779

5780

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

5781

</div>

5782

5783

5784

</li>

5785

5786

</ul>

5787

</div>

5788

5789

5790

5791

5792

5793

</div>

5794

5795

5796

5797

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

5798

5799

5800

5801

5802

5803

5804

5805

5806

5807

</li>

5808

5809

5810

5811

<code>config</code>

5812

5813

</li>

5814

5815

5816

5817

5818

5819

</li>

5820

5821

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

5822

</div>

5823

5824

5825

5826

5827

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

5828

</span>

5829

5830

5831

5832

5833

5834

5835

5836

5837

5838

5839

5840

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

5841

5842

5843

5844

5845

5846

<p>Inherited from

5847

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

5848

5849

5850

5851

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

5852

5853

</p>

5854

5855

5856

5857

5858

5859

</div>

5860

5861

5862

<p>

5863

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

5864

</p>

5865

5866

<p>

5867

The config argument object supports the following properties:

5868

</p>

5869

5870

<dl>

5871

<dt>value <Any></dt>

5872

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

5873

5874

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

5875

<dd>

5876

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

5877

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

5878

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

5879

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

5880

case the value property is used.</p>

5881

5882

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

5883

</dd>

5884

5885

<dt>readOnly <boolean></dt>

5886

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

5887

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

5888

5889

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

5890

<dd>

5891

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

5892

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

5893

constructor configuration arguments, or by invoking set.

5894

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

5895

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

5896

</dd>

5897

5898

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

5899

<dd>

5900

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

5901

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

5902

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

5903

the value from being stored.

5904

</p>

5905

5906

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

5907

</dd>

5908

5909

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

5910

<dd>

5911

<p>

5912

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

5913

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

5914

invoke get.

5915

</p>

5916

5917

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

5918

</dd>

5919

5920

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

5921

<dd>

5922

<p>

5923

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

5924

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

5925

</p>

5926

5927

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

5928

</dd>

5929

5930

<dt>lazyAdd <boolean></dt>

5931

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

5932

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

5933

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

5934

5935

</dl>

5936

5937

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

5938

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

5939

5940

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

5941

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

5942

</div>

5943

5944

5945

5946

<h4>Parameters:</h4>

5947

5948

5949

5950

5951

5952

5953

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

5954

5955

5956

5957

5958

5959

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

5960

</div>

5961

5962

5963

</li>

5964

5965

5966

5967

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

5968

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

5969

5970

5971

5972

5973

5974

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

5975

5976

<p>

5977

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

5978

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

5979

</p>

5980

</div>

5981

5982

5983

</li>

5984

5985

5986

5987

5988

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

5989

5990

5991

5992

5993

5994

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

5995

</div>

5996

5997

5998

</li>

5999

6000

</ul>

6001

</div>

6002

6003

6004

6005

6006

<h4>Returns:</h4>

6007

6008

6009

6010

6011

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

6012

6013

A reference to the host object.

6014

6015

</div>

6016

</div>

6017

6018

6019

6020

</div>

6021

6022

6023

6024

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

6025

6026

6027

6028

6029

6030

6031

6032

6033

6034

</li>

6035

6036

6037

6038

<code>values</code>

6039

6040

</li>

6041

6042

6043

6044

6045

6046

</li>

6047

6048

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

6049

</div>

6050

6051

6052

6053

6054

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

6055

</span>

6056

6057

6058

6059

6060

6061

6062

6063

6064

6065

6066

6067

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

6068

6069

6070

6071

6072

6073

<p>Inherited from

6074

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

6075

6076

6077

6078

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

6079

6080

</p>

6081

6082

6083

6084

6085

6086

</div>

6087

6088

6089

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

6090

6091

<p>

6092

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

6093

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

6094

</p>

6095

</div>

6096

6097

6098

6099

<h4>Parameters:</h4>

6100

6101

6102

6103

6104

6105

6106

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

6107

6108

6109

6110

6111

6112

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

6113

</div>

6114

6115

6116

</li>

6117

6118

6119

6120

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

6121

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

6122

6123

6124

6125

6126

6127

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

6128

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

6129

</div>

6130

6131

6132

</li>

6133

6134

6135

6136

6137

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

6138

6139

6140

6141

6142

6143

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

6144

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

6145

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

6146

</div>

6147

6148

6149

</li>

6150

6151

</ul>

6152

</div>

6153

6154

6155

6156

6157

<h4>Returns:</h4>

6158

6159

6160

6161

6162

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

6163

6164

A reference to the host object.

6165

6166

</div>

6167

</div>

6168

6169

6170

6171

</div>

6172

6173

6174

6175

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

6176

6177

6178

6179

6180

6181

6182

6183

6184

6185

</li>

6186

6187

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

6188

</div>

6189

6190

6191

6192

6193

6194

6195

6196

6197

6198

6199

6200

6201

6202

6203

6204

6205

6206

<p>Inherited from

6207

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

6208

6209

6210

6211

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

6212

6213

</p>

6214

6215

6216

6217

6218

6219

</div>

6220

6221

6222

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

6223

is determined by the order registered. Multiple targets can

6224

be specified.</p>

6225

6226

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

6227

6228

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

6229

</div>

6230

6231

6232

6233

<h4>Parameters:</h4>

6234

6235

6236

6237

6238

6239

6240

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

6241

6242

6243

6244

6245

6246

<p>the target to add</p>

6247

</div>

6248

6249

6250

</li>

6251

6252

</ul>

6253

</div>

6254

6255

6256

6257

6258

6259

</div>

6260

6261

6262

6263

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

6264

6265

6266

6267

6268

6269

6270

6271

6272

6273

</li>

6274

6275

6276

6277

6278

6279

</li>

6280

6281

6282

6283

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

6284

6285

</li>

6286

6287

6288

6289

6290

6291

</li>

6292

6293

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

6294

</div>

6295

6296

6297

6298

6299

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

6300

</span>

6301

6302

6303

6304

6305

6306

6307

6308

6309

6310

6311

6312

6313

6314

6315

6316

<p>Inherited from

6317

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

6318

6319

6320

6321

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

6322

6323

</p>

6324

6325

6326

6327

6328

6329

</div>

6330

6331

6332

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

6333

supplied callback will execute after any listeners add

6334

via the subscribe method, and after the default function,

6335

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

6336

</div>

6337

6338

6339

6340

<h4>Parameters:</h4>

6341

6342

6343

6344

6345

6346

6347

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

6348

6349

6350

6351

6352

6353

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

6354

</div>

6355

6356

6357

</li>

6358

6359

6360

6361

6362

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

6363

6364

6365

6366

6367

6368

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

6369

</div>

6370

6371

6372

</li>

6373

6374

6375

6376

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

6377

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

6378

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

6379

6380

6381

6382

6383

6384

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

6385

</div>

6386

6387

6388

</li>

6389

6390

6391

6392

6393

6394

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

6395

6396

6397

6398

6399

6400

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

6401

</div>

6402

6403

6404

</li>

6405

6406

</ul>

6407

</div>

6408

6409

6410

6411

6412

<h4>Returns:</h4>

6413

6414

6415

6416

6417

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

6418

6419

A subscription handle capable of detaching the

6420

subscription

6421

6422

</div>

6423

</div>

6424

6425

6426

6427

</div>

6428

6429

6430

6431

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

6432

6433

6434

6435

6436

6437

6438

6439

6440

6441

</li>

6442

6443

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

6444

</div>

6445

6446

6447

6448

6449

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

6450

</span>

6451

6452

6453

6454

6455

6456

6457

6458

6459

6460

6461

6462

6463

6464

6465

6466

<p>Inherited from

6467

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

6468

6469

6470

6471

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

6472

6473

</p>

6474

6475

6476

6477

6478

6479

</div>

6480

6481

6482

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

6483

</div>

6484

6485

6486

6487

<h4>Parameters:</h4>

6488

6489

6490

6491

6492

6493

6494

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

6495

6496

6497

6498

6499

6500

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

6501

</div>

6502

6503

6504

</li>

6505

6506

</ul>

6507

</div>

6508

6509

6510

6511

6512

<h4>Returns:</h4>

6513

6514

6515

6516

6517

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

6518

6519

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.

6520

6521

</div>

6522

</div>

6523

6524

6525

6526

</div>

6527

6528

6529

6530

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

6531

6532

6533

6534

6535

6536

6537

6538

6539

</span>

6540

6541

6542

6543

6544

6545

6546

6547

6548

6549

6550

6551

6552

6553

6554

6555

<p>Inherited from

6556

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

6557

6558

6559

6560

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

6561

6562

</p>

6563

6564

6565

6566

6567

6568

</div>

6569

6570

6571

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

6572

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

6573

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

6574

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

6575

6576

<p>For DOM and custom events:

6577

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

6578

6579

<p>For methods:

6580

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

6581

</div>

6582

6583

6584

6585

6586

6587

<h4>Returns:</h4>

6588

6589

6590

6591

6592

detach handle

6593

6594

</div>

6595

</div>

6596

6597

6598

6599

</div>

6600

6601

6602

6603

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

6604

6605

6606

6607

6608

6609

6610

6611

6612

6613

</li>

6614

6615

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

6616

</div>

6617

6618

6619

6620

6621

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

6622

</span>

6623

6624

6625

6626

6627

6628

6629

6630

6631

6632

6633

6634

6635

6636

6637

6638

<p>Inherited from

6639

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

6640

6641

6642

6643

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

6644

6645

</p>

6646

6647

6648

6649

6650

6651

</div>

6652

6653

6654

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

6655

</div>

6656

6657

6658

6659

<h4>Parameters:</h4>

6660

6661

6662

6663

6664

6665

6666

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

6667

6668

6669

6670

6671

6672

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

6673

</div>

6674

6675

6676

</li>

6677

6678

</ul>

6679

</div>

6680

6681

6682

6683

6684

<h4>Returns:</h4>

6685

6686

6687

6688

6689

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

6690

6691

the aggregated return value from Event.Custom.fire

6692

6693

</div>

6694

</div>

6695

6696

6697

6698

</div>

6699

6700

6701

6702

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

6703

6704

6705

6706

6707

6708

6709

6710

6711

</span>

6712

6713

6714

6715

6716

6717

6718

6719

6720

6721

6722

6723

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

6724

6725

6726

6727

6728

<p>Inherited from

6729

6730

BaseCore

6731

</a>

6732

6733

but overwritten in

6734

6735

6736

6737

6738

6739

</p>

6740

6741

6742

6743

6744

6745

</div>

6746

6747

6748

<p>

6749

Destroy lifecycle method. Fires the destroy

6750

event, prior to invoking destructors for the

6751

class hierarchy.

6752

</p>

6753

6754

<p>

6755

Subscribers to the destroy

6756

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

6757

from proceeding.

6758

</p>

6759

</div>

6760

6761

6762

6763

6764

6765

<h4>Returns:</h4>

6766

6767

6768

6769

6770

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

6771

6772

A reference to this object

6773

6774

</div>

6775

</div>

6776

6777

6778

6779

</div>

6780

6781

6782

6783

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

6784

6785

6786

6787

6788

6789

6790

6791

6792

6793

</li>

6794

6795

6796

6797

6798

6799

</li>

6800

6801

6802

6803

<code>context</code>

6804

6805

</li>

6806

6807

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

6808

</div>

6809

6810

6811

6812

6813

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

6814

</span>

6815

6816

6817

6818

6819

6820

6821

6822

6823

6824

6825

6826

6827

6828

6829

6830

<p>Inherited from

6831

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

6832

6833

6834

6835

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

6836

6837

</p>

6838

6839

6840

6841

6842

6843

</div>

6844

6845

6846

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

6847

</div>

6848

6849

6850

6851

<h4>Parameters:</h4>

6852

6853

6854

6855

6856

6857

6858

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

6859

6860

6861

6862

6863

6864

<p>Either the handle to the subscriber or the

6865

type of event. If the type

6866

is not specified, it will attempt to remove

6867

the listener from all hosted events.</p>

6868

</div>

6869

6870

6871

</li>

6872

6873

6874

6875

6876

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

6877

6878

6879

6880

6881

6882

<p>The subscribed function to unsubscribe, if not

6883

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

6884

</div>

6885

6886

6887

</li>

6888

6889

6890

6891

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

6892

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

6893

6894

6895

6896

6897

6898

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

6899

optional, but if supplied will be used to

6900

disambiguate multiple listeners that are the same

6901

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

6902

that lives on the prototype)</p>

6903

</div>

6904

6905

6906

</li>

6907

6908

</ul>

6909

</div>

6910

6911

6912

6913

6914

<h4>Returns:</h4>

6915

6916

6917

6918

6919

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

6920

6921

the host

6922

6923

</div>

6924

</div>

6925

6926

6927

6928

</div>

6929

6930

6931

6932

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

6933

6934

6935

6936

6937

6938

6939

6940

6941

6942

</li>

6943

6944

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

6945

</div>

6946

6947

6948

6949

6950

6951

6952

6953

6954

6955

6956

6957

6958

6959

6960

6961

6962

6963

<p>Inherited from

6964

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

6965

6966

6967

6968

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

6969

6970

</p>

6971

6972

6973

6974

6975

6976

</div>

6977

6978

6979

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

6980

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

6981

be removed.</p>

6982

</div>

6983

6984

6985

6986

<h4>Parameters:</h4>

6987

6988

6989

6990

6991

6992

6993

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

6994

6995

6996

6997

6998

6999

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

7000

</div>

7001

7002

7003

</li>

7004

7005

</ul>

7006

</div>

7007

7008

7009

7010

7011

7012

</div>

7013

7014

7015

7016

7017

7018

7019

7020

7021

7022

7023

7024

7025

7026

</li>

7027

7028

7029

7030

<code>arguments</code>

7031

7032

</li>

7033

7034

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

7035

</div>

7036

7037

7038

7039

7040

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

7041

</span>

7042

7043

7044

7045

7046

7047

7048

7049

7050

7051

7052

7053

7054

7055

7056

7057

<p>Inherited from

7058

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

7059

7060

7061

7062

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

7063

7064

</p>

7065

7066

7067

7068

7069

7070

</div>

7071

7072

7073

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

7074

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

7075

following parameters.</p>

7076

7077

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

7078

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

7079

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

7080

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

7081

be published on this object first.</p>

7082

7083

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

7084

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

7085

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

7086

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

7087

in place of the original object.</p>

7088

</div>

7089

7090

7091

7092

<h4>Parameters:</h4>

7093

7094

7095

7096

7097

7098

7099

7100

7101

7102

7103

7104

7105

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

7106

a 'type' property.</p>

7107

</div>

7108

7109

7110

</li>

7111

7112

7113

7114

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

7115

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

7116

7117

7118

7119

7120

7121

<p>an arbitrary set of parameters to pass to

7122

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

7123

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

7124

parameter after the properties the object literal contains are copied to

7125

the event facade.</p>

7126

</div>

7127

7128

7129

</li>

7130

7131

</ul>

7132

</div>

7133

7134

7135

7136

7137

<h4>Returns:</h4>

7138

7139

7140

7141

7142

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

7143

7144

the event host

7145

7146

</div>

7147

</div>

7148

7149

7150

7151

</div>

7152

7153

7154

7155

7156

7157

7158

7159

7160

7161

7162

7163

7164

7165

</li>

7166

7167

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

7168

</div>

7169

7170

7171

7172

7173

7174

</span>

7175

7176

7177

7178

7179

7180

7181

7182

7183

7184

7185

7186

7187

7188

7189

7190

<p>Inherited from

7191

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

7192

7193

7194

7195

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

7196

7197

</p>

7198

7199

7200

7201

7202

7203

</div>

7204

7205

7206

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

7207

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

7208

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

7209

</div>

7210

7211

7212

7213

<h4>Parameters:</h4>

7214

7215

7216

7217

7218

7219

7220

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

7221

7222

7223

7224

7225

7226

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

7227

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

7228

</div>

7229

7230

7231

</li>

7232

7233

</ul>

7234

</div>

7235

7236

7237

7238

7239

<h4>Returns:</h4>

7240

7241

7242

7243

7244

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

7245

7246

The value of the attribute

7247

7248

</div>

7249

</div>

7250

7251

7252

7253

</div>

7254

7255

7256

7257

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

7258

7259

7260

7261

7262

7263

7264

7265

<code>attrs</code>

7266

7267

</li>

7268

7269

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

7270

</div>

7271

7272

7273

7274

7275

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

7276

</span>

7277

7278

7279

7280

7281

7282

7283

7284

7285

7286

7287

7288

7289

7290

7291

7292

<p>Inherited from

7293

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

7294

7295

7296

7297

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

7298

7299

</p>

7300

7301

7302

7303

7304

7305

</div>

7306

7307

7308

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

7309

</div>

7310

7311

7312

7313

<h4>Parameters:</h4>

7314

7315

7316

7317

7318

7319

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

7320

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

7321

7322

7323

7324

7325

7326

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

7327

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

7328

</div>

7329

7330

7331

</li>

7332

7333

</ul>

7334

</div>

7335

7336

7337

7338

7339

<h4>Returns:</h4>

7340

7341

7342

7343

7344

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

7345

7346

An object with attribute name/value pairs.

7347

7348

</div>

7349

</div>

7350

7351

7352

7353

</div>

7354

7355

7356

7357

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

7358

7359

7360

7361

7362

7363

7364

7365

7366

7367

</li>

7368

7369

7370

7371

<code>prefixed</code>

7372

7373

</li>

7374

7375

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

7376

</div>

7377

7378

7379

7380

7381

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

7382

</span>

7383

7384

7385

7386

7387

7388

7389

7390

7391

7392

7393

7394

7395

7396

7397

7398

<p>Inherited from

7399

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

7400

7401

7402

7403

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

7404

7405

</p>

7406

7407

7408

7409

7410

7411

</div>

7412

7413

7414

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

7415

falsy value otherwise</p>

7416

</div>

7417

7418

7419

7420

<h4>Parameters:</h4>

7421

7422

7423

7424

7425

7426

7427

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

7428

7429

7430

7431

7432

7433

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

7434

</div>

7435

7436

7437

</li>

7438

7439

7440

7441

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

7442

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

7443

7444

7445

7446

7447

7448

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

7449

</div>

7450

7451

7452

</li>

7453

7454

</ul>

7455

</div>

7456

7457

7458

7459

7460

<h4>Returns:</h4>

7461

7462

7463

7464

7465

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

7466

7467

the custom event or null

7468

7469

</div>

7470

</div>

7471

7472

7473

7474

</div>

7475

7476

7477

7478

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

7479

7480

7481

7482

7483

7484

7485

7486

7487

</span>

7488

7489

7490

7491

7492

7493

7494

7495

7496

7497

7498

7499

7500

7501

7502

7503

<p>Inherited from

7504

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

7505

7506

7507

7508

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

7509

7510

</p>

7511

7512

7513

7514

7515

7516

</div>

7517

7518

7519

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

7520

</div>

7521

7522

7523

7524

7525

7526

<h4>Returns:</h4>

7527

7528

7529

7530

7531

EventTarget[]

7532

7533

</div>

7534

</div>

7535

7536

7537

7538

</div>

7539

7540

7541

7542

7543

7544

7545

7546

7547

7548

7549

7550

<code>config</code>

7551

7552

</li>

7553

7554

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

7555

</div>

7556

7557

7558

7559

7560

7561

</span>

7562

7563

7564

7565

7566

7567

7568

7569

7570

7571

7572

7573

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

7574

7575

7576

7577

7578

<p>Inherited from

7579

7580

BaseCore

7581

</a>

7582

7583

but overwritten in

7584

7585

7586

7587

7588

7589

</p>

7590

7591

7592

7593

7594

7595

</div>

7596

7597

7598

<p>Init lifecycle method, invoked during construction.

7599

Fires the init event prior to setting up attributes and

7600

invoking initializers for the class hierarchy.</p>

7601

</div>

7602

7603

7604

7605

<h4>Parameters:</h4>

7606

7607

7608

7609

7610

7611

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

7612

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

7613

7614

7615

7616

7617

7618

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

7619

</div>

7620

7621

7622

</li>

7623

7624

</ul>

7625

</div>

7626

7627

7628

7629

7630

<h4>Returns:</h4>

7631

7632

7633

7634

7635

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

7636

7637

A reference to this object

7638

7639

</div>

7640

</div>

7641

7642

7643

7644

</div>

7645

7646

7647

7648

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

7649

7650

7651

7652

7653

7654

7655

7656

7657

7658

</li>

7659

7660

7661

7662

<code>config</code>

7663

7664

</li>

7665

7666

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

7667

</div>

7668

7669

7670

7671

7672

7673

7674

7675

7676

7677

7678

7679

7680

7681

7682

7683

7684

7685

<p>Inherited from

7686

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

7687

7688

7689

7690

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

7691

7692

</p>

7693

7694

7695

7696

7697

7698

</div>

7699

7700

7701

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

7702

7703

<p>

7704

The properties which can be modified through this interface are limited

7705

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

7706

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

7707

broadcast and getter.

7708

</p>

7709

</div>

7710

7711

7712

7713

<h4>Parameters:</h4>

7714

7715

7716

7717

7718

7719

7720

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

7721

7722

7723

7724

7725

7726

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

7727

</div>

7728

7729

7730

</li>

7731

7732

7733

7734

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

7735

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

7736

7737

7738

7739

7740

7741

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

7742

</div>

7743

7744

7745

</li>

7746

7747

</ul>

7748

</div>

7749

7750

7751

7752

7753

7754

</div>

7755

7756

7757

7758

7759

7760

7761

7762

7763

7764

7765

7766

7767

7768

</li>

7769

7770

7771

7772

7773

7774

</li>

7775

7776

7777

7778

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

7779

7780

</li>

7781

7782

7783

7784

7785

7786

</li>

7787

7788

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

7789

</div>

7790

7791

7792

7793

7794

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

7795

</span>

7796

7797

7798

7799

7800

7801

7802

7803

7804

7805

7806

7807

7808

7809

7810

7811

<p>Inherited from

7812

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

7813

7814

7815

7816

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

7817

7818

</p>

7819

7820

7821

7822

7823

7824

</div>

7825

7826

7827

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

7828

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

7829

7830

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

7831

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

7832

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

7833

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

7834

API for all available properties and methods. Subscribers to

7835

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

7836

after the event name.</p>

7837

7838

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

7839

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

7840

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

7841

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

7842

7843

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

7844

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

7845

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

7846

</div>

7847

7848

7849

7850

<h4>Parameters:</h4>

7851

7852

7853

7854

7855

7856

7857

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

7858

7859

7860

7861

7862

7863

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

7864

</div>

7865

7866

7867

</li>

7868

7869

7870

7871

7872

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

7873

7874

7875

7876

7877

7878

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

7879

</div>

7880

7881

7882

</li>

7883

7884

7885

7886

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

7887

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

7888

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

7889

7890

7891

7892

7893

7894

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

7895

</div>

7896

7897

7898

</li>

7899

7900

7901

7902

7903

7904

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

7905

7906

7907

7908

7909

7910

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

7911

</div>

7912

7913

7914

</li>

7915

7916

</ul>

7917

</div>

7918

7919

7920

7921

7922

<h4>Returns:</h4>

7923

7924

7925

7926

7927

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

7928

7929

A subscription handle capable of detaching that

7930

subscription

7931

7932

</div>

7933

</div>

7934

7935

7936

7937

</div>

7938

7939

7940

7941

7942

7943

7944

7945

7946

7947

7948

7949

7950

7951

</li>

7952

7953

7954

7955

7956

7957

</li>

7958

7959

7960

7961

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

7962

7963

</li>

7964

7965

7966

7967

7968

7969

</li>

7970

7971

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

7972

</div>

7973

7974

7975

7976

7977

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

7978

</span>

7979

7980

7981

7982

7983

7984

7985

7986

7987

7988

7989

7990

7991

7992

7993

7994

<p>Inherited from

7995

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

7996

7997

7998

7999

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

8000

8001

</p>

8002

8003

8004

8005

8006

8007

</div>

8008

8009

8010

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

8011

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

8012

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

8013

</div>

8014

8015

8016

8017

<h4>Parameters:</h4>

8018

8019

8020

8021

8022

8023

8024

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

8025

8026

8027

8028

8029

8030

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

8031

</div>

8032

8033

8034

</li>

8035

8036

8037

8038

8039

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

8040

8041

8042

8043

8044

8045

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

8046

</div>

8047

8048

8049

</li>

8050

8051

8052

8053

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

8054

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

8055

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

8056

8057

8058

8059

8060

8061

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

8062

</div>

8063

8064

8065

</li>

8066

8067

8068

8069

8070

8071

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

8072

8073

8074

8075

8076

8077

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

8078

</div>

8079

8080

8081

</li>

8082

8083

</ul>

8084

</div>

8085

8086

8087

8088

8089

<h4>Returns:</h4>

8090

8091

8092

8093

8094

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

8095

8096

A subscription handle capable of detaching the

8097

subscription

8098

8099

</div>

8100

</div>

8101

8102

8103

8104

</div>

8105

8106

8107

8108

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

8109

8110

8111

8112

8113

8114

8115

8116

8117

8118

</li>

8119

8120

8121

8122

8123

8124

</li>

8125

8126

8127

8128

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

8129

8130

</li>

8131

8132

8133

8134

8135

8136

</li>

8137

8138

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

8139

</div>

8140

8141

8142

8143

8144

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

8145

</span>

8146

8147

8148

8149

8150

8151

8152

8153

8154

8155

8156

8157

8158

8159

8160

8161

<p>Inherited from

8162

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

8163

8164

8165

8166

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

8167

8168

</p>

8169

8170

8171

8172

8173

8174

</div>

8175

8176

8177

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

8178

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

8179

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

8180

</div>

8181

8182

8183

8184

<h4>Parameters:</h4>

8185

8186

8187

8188

8189

8190

8191

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

8192

8193

8194

8195

8196

8197

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

8198

</div>

8199

8200

8201

</li>

8202

8203

8204

8205

8206

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

8207

8208

8209

8210

8211

8212

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

8213

</div>

8214

8215

8216

</li>

8217

8218

8219

8220

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

8221

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

8222

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

8223

8224

8225

8226

8227

8228

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

8229

</div>

8230

8231

8232

</li>

8233

8234

8235

8236

8237

8238

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

8239

8240

8241

8242

8243

8244

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

8245

</div>

8246

8247

8248

</li>

8249

8250

</ul>

8251

</div>

8252

8253

8254

8255

8256

<h4>Returns:</h4>

8257

8258

8259

8260

8261

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

8262

8263

A subscription handle capable of detaching that

8264

subscription

8265

8266

</div>

8267

</div>

8268

8269

8270

8271

</div>

8272

8273

8274

8275

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

8276

8277

8278

8279

8280

8281

8282

8283

8284

8285

</li>

8286

8287

8288

8289

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

8290

8291

</li>

8292

8293

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

8294

</div>

8295

8296

8297

8298

8299

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

8300

</span>

8301

8302

8303

8304

8305

8306

8307

8308

8309

8310

8311

8312

8313

8314

8315

8316

<p>Inherited from

8317

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

8318

8319

8320

8321

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

8322

8323

</p>

8324

8325

8326

8327

8328

8329

<p>Available since 3.3.0</p>

8330

8331

</div>

8332

8333

8334

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

8335

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

8336

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

8337

to include the prefix one is supplied or the event target

8338

is configured with a default prefix.</p>

8339

</div>

8340

8341

8342

8343

<h4>Parameters:</h4>

8344

8345

8346

8347

8348

8349

8350

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

8351

8352

8353

8354

8355

8356

8357

</div>

8358

8359

8360

</li>

8361

8362

8363

8364

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

8365

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

8366

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

8367

8368

8369

8370

8371

8372

<p>the prefix</p>

8373

</div>

8374

8375

8376

</li>

8377

8378

</ul>

8379

</div>

8380

8381

8382

8383

8384

<h4>Returns:</h4>

8385

8386

8387

8388

8389

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

8390

8391

an array containing:

8392

* the detach category, if supplied,

8393

* the prefixed event type,

8394

* whether or not this is an after listener,

8395

* the supplied event type

8396

8397

</div>

8398

</div>

8399

8400

8401

8402

</div>

8403

8404

8405

8406

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

8407

8408

8409

8410

8411

8412

8413

8414

8415

8416

</li>

8417

8418

8419

8420

8421

8422

</li>

8423

8424

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

8425

</div>

8426

8427

8428

8429

8430

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

8431

</span>

8432

8433

8434

8435

8436

8437

8438

8439

8440

8441

8442

8443

8444

8445

8446

8447

<p>Inherited from

8448

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

8449

8450

8451

8452

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

8453

8454

</p>

8455

8456

8457

8458

8459

8460

</div>

8461

8462

8463

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

8464

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

8465

case the custom event is returned.</p>

8466

</div>

8467

8468

8469

8470

<h4>Parameters:</h4>

8471

8472

8473

8474

8475

8476

8477

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

8478

8479

8480

8481

8482

8483

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

8484

</div>

8485

8486

8487

</li>

8488

8489

8490

8491

8492

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

8493

8494

8495

8496

8497

8498

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

8499

8500

<p><ul>

8501

<li>

8502

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

8503

</li>

8504

<li>

8505

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

8506

Events can only bubble if emitFacade is true.

8507

</li>

8508

<li>

8509

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

8510

</li>

8511

<li>

8512

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

8513

</li>

8514

<li>

8515

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

8516

</li>

8517

<li>

8518

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

8519

</li>

8520

<li>

8521

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

8522

the fire will be notified immediately.

8523

</li>

8524

<li>

8525

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

8526

fired unless async is true.

8527

</li>

8528

<li>

8529

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

8530

</li>

8531

<li>

8532

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

8533

</li>

8534

<li>

8535

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

8536

</li>

8537

<li>

8538

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

8539

</li>

8540

<li>

8541

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

8542

</li></p>

8543

8544

<p><li>

8545

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

8546

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

8547

</li>

8548

<li>

8549

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

8550

</li>

8551

</ul></p>

8552

</div>

8553

8554

8555

</li>

8556

8557

</ul>

8558

</div>

8559

8560

8561

8562

8563

<h4>Returns:</h4>

8564

8565

8566

8567

8568

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

8569

8570

the custom event

8571

8572

</div>

8573

</div>

8574

8575

8576

8577

</div>

8578

8579

8580

8581

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

8582

8583

8584

8585

8586

8587

8588

8589

8590

8591

</li>

8592

8593

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

8594

</div>

8595

8596

8597

8598

8599

8600

8601

8602

8603

8604

8605

8606

8607

8608

8609

8610

8611

8612

<p>Inherited from

8613

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

8614

8615

8616

8617

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

8618

8619

</p>

8620

8621

8622

8623

8624

8625

</div>

8626

8627

8628

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

8629

</div>

8630

8631

8632

8633

<h4>Parameters:</h4>

8634

8635

8636

8637

8638

8639

8640

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

8641

8642

8643

8644

8645

8646

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

8647

</div>

8648

8649

8650

</li>

8651

8652

</ul>

8653

</div>

8654

8655

8656

8657

8658

8659

</div>

8660

8661

8662

8663

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

8664

8665

8666

8667

8668

8669

8670

8671

8672

8673

</li>

8674

8675

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

8676

</div>

8677

8678

8679

8680

8681

8682

8683

8684

8685

8686

8687

8688

8689

8690

8691

8692

8693

8694

<p>Inherited from

8695

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

8696

8697

8698

8699

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

8700

8701

</p>

8702

8703

8704

8705

8706

8707

</div>

8708

8709

8710

<p>Removes a bubble target</p>

8711

</div>

8712

8713

8714

8715

<h4>Parameters:</h4>

8716

8717

8718

8719

8720

8721

8722

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

8723

8724

8725

8726

8727

8728

<p>the target to remove</p>

8729

</div>

8730

8731

8732

</li>

8733

8734

</ul>

8735

</div>

8736

8737

8738

8739

8740

8741

</div>

8742

8743

8744

8745

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

8746

8747

8748

8749

8750

8751

8752

8753

8754

8755

</li>

8756

8757

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

8758

</div>

8759

8760

8761

8762

8763

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

8764

</span>

8765

8766

8767

8768

8769

8770

8771

8772

8773

8774

8775

8776

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

8777

8778

8779

8780

8781

8782

<p>Inherited from

8783

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

8784

8785

8786

8787

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

8788

8789

</p>

8790

8791

8792

8793

8794

8795

</div>

8796

8797

8798

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

8799

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

8800

</div>

8801

8802

8803

8804

<h4>Parameters:</h4>

8805

8806

8807

8808

8809

8810

8811

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

8812

8813

8814

8815

8816

8817

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

8818

</div>

8819

8820

8821

</li>

8822

8823

</ul>

8824

</div>

8825

8826

8827

8828

8829

<h4>Returns:</h4>

8830

8831

8832

8833

8834

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

8835

8836

A reference to the host object.

8837

8838

</div>

8839

</div>

8840

8841

8842

8843

</div>

8844

8845

8846

8847

8848

8849

8850

8851

8852

8853

8854

8855

8856

8857

</li>

8858

8859

8860

8861

<code>value</code>

8862

8863

</li>

8864

8865

8866

8867

8868

8869

</li>

8870

8871

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

8872

</div>

8873

8874

8875

8876

8877

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

8878

</span>

8879

8880

8881

8882

8883

8884

8885

8886

8887

8888

8889

8890

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

8891

8892

8893

8894

8895

<p>Inherited from

8896

8897

AttributeCore

8898

</a>

8899

8900

but overwritten in

8901

8902

8903

8904

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

8905

8906

</p>

8907

8908

8909

8910

8911

8912

</div>

8913

8914

8915

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

8916

</div>

8917

8918

8919

8920

<h4>Parameters:</h4>

8921

8922

8923

8924

8925

8926

8927

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

8928

8929

8930

8931

8932

8933

<p>The name of the attribute. If the

8934

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

8935

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

8936

</div>

8937

8938

8939

</li>

8940

8941

8942

8943

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

8944

8945

8946

8947

8948

8949

8950

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

8951

</div>

8952

8953

8954

</li>

8955

8956

8957

8958

8959

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

8960

8961

8962

8963

8964

8965

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

8966

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

8967

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

8968

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

8969

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

8970

</div>

8971

8972

8973

</li>

8974

8975

</ul>

8976

</div>

8977

8978

8979

8980

8981

<h4>Returns:</h4>

8982

8983

8984

8985

8986

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

8987

8988

A reference to the host object.

8989

8990

</div>

8991

</div>

8992

8993

8994

8995

</div>

8996

8997

8998

8999

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

9000

9001

9002

9003

9004

9005

9006

9007

<code>attrs</code>

9008

9009

</li>

9010

9011

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

9012

</div>

9013

9014

9015

9016

9017

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

9018

</span>

9019

9020

9021

9022

9023

9024

9025

9026

9027

9028

9029

9030

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

9031

9032

9033

9034

9035

<p>Inherited from

9036

9037

AttributeCore

9038

</a>

9039

9040

but overwritten in

9041

9042

9043

9044

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

9045

9046

</p>

9047

9048

9049

9050

9051

9052

</div>

9053

9054

9055

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

9056

</div>

9057

9058

9059

9060

<h4>Parameters:</h4>

9061

9062

9063

9064

9065

9066

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

9067

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

9068

9069

9070

9071

9072

9073

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

9074

</div>

9075

9076

9077

</li>

9078

9079

</ul>

9080

</div>

9081

9082

9083

9084

9085

<h4>Returns:</h4>

9086

9087

9088

9089

9090

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

9091

9092

A reference to the host object.

9093

9094

</div>

9095

</div>

9096

9097

9098

9099

</div>

9100

9101

9102

9103

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

9104

9105

9106

9107

9108

9109

9110

9111

9112

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

9113

9114

9115

9116

9117

9118

9119

9120

9121

9122

9123

9124

9125

9126

<p>Inherited from

9127

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

9128

9129

9130

9131

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

9132

9133

</p>

9134

9135

9136

9137

<p>Deprecated: use on</p>

9138

9139

9140

9141

</div>

9142

9143

9144

<p>subscribe to an event</p>

9145

</div>

9146

9147

9148

9149

9150

9151

9152

</div>

9153

9154

9155

9156

<h3 class="name"><code>toString</code></h3>

9157

9158

9159

9160

9161

9162

9163

9164

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

9165

</span>

9166

9167

9168

9169

9170

9171

9172

9173

9174

9175

9176

9177

9178

9179

9180

9181

<p>Inherited from

9182

<a href="../classes/BaseCore.html#method_toString">BaseCore</a>:

9183

9184

9185

9186

<a href="../files/base_js_BaseCore.js.html#l592"><code>base/js/BaseCore.js:592</code></a>

9187

9188

</p>

9189

9190

9191

9192

9193

9194

</div>

9195

9196

9197

<p>Default toString implementation. Provides the constructor NAME

9198

and the instance guid, if set.</p>

9199

</div>

9200

9201

9202

9203

9204

9205

<h4>Returns:</h4>

9206

9207

9208

9209

9210

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>:

9211

9212

String representation for this object

9213

9214

</div>

9215

</div>

9216

9217

9218

9219

</div>

9220

9221

9222

9223

<h3 class="name"><code>unsubscribe</code></h3>

9224

9225

9226

9227

9228

9229

9230

9231

9232

<span class="flag deprecated" title="use detach">deprecated</span>

9233

9234

9235

9236

9237

9238

9239

9240

9241

9242

9243

9244

9245

9246

<p>Inherited from

9247

<a href="../classes/EventTarget.html#method_unsubscribe">EventTarget</a>:

9248

9249

9250

9251

<a href="../files/event-custom_js_event-target.js.html#l455"><code>event-custom/js/event-target.js:455</code></a>

9252

9253

</p>

9254

9255

9256

9257

<p>Deprecated: use detach</p>

9258

9259

9260

9261

</div>

9262

9263

9264

<p>detach a listener</p>

9265

</div>

9266

9267

9268

9269

9270

9271

9272

</div>

9273

9274

9275

9276

<h3 class="name"><code>unsubscribeAll</code></h3>

9277

9278

9279

9280

9281

9282

9283

9284

9285

9286

</li>

9287

9288

</ul><span class="paren">)</span>

9289

</div>

9290

9291

9292

9293

9294

9295

<span class="flag deprecated" title="use detachAll">deprecated</span>

9296

9297

9298

9299

9300

9301

9302

9303

9304

9305

9306

9307

9308

9309

<p>Inherited from

9310

<a href="../classes/EventTarget.html#method_unsubscribeAll">EventTarget</a>:

9311

9312

9313

9314

<a href="../files/event-custom_js_event-target.js.html#l476"><code>event-custom/js/event-target.js:476</code></a>

9315

9316

</p>

9317

9318

9319

9320

<p>Deprecated: use detachAll</p>

9321

9322

9323

9324

</div>

9325

9326

9327

<p>Removes all listeners from the specified event. If the event type

9328

is not specified, all listeners from all hosted custom events will

9329

be removed.</p>

9330

</div>

9331

9332

9333

9334

<h4>Parameters:</h4>

9335

9336

9337

9338

9339

9340

9341

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

9342

9343

9344

9345

9346

9347

<p>The type, or name of the event</p>

9348

</div>

9349

9350

9351

</li>

9352

9353

</ul>

9354

</div>

9355

9356

9357

9358

9359

9360

</div>

9361

9362

9363

</div>

9364

9365

9366

9367

9368

<h2 class="off-left">Properties</h2>

9369

9370

9371

9372

<h3 class="name"><code>_allowAdHocAttrs</code></h3>

9373

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>

9374

9375

9376

9377

9378

<span class="flag protected">protected</span>

9379

9380

9381

9382

9383

9384

9385

9386

9387

9388

<p>Inherited from

9389

<a href="../classes/BaseCore.html#property__allowAdHocAttrs">BaseCore</a>:

9390

9391

9392

9393

<a href="../files/base_js_BaseCore.js.html#l100"><code>base/js/BaseCore.js:100</code></a>

9394

9395

</p>

9396

9397

9398

9399

9400

</div>

9401

9402

9403

<p>This property controls whether or not instances of this class should

9404

allow users to add ad-hoc attributes through the constructor configuration

9405

hash.</p>

9406

9407

<p>AdHoc attributes are attributes which are not defined by the class, and are

9408

not handled by the MyClass.<em>NON</em>ATTRS_CFG</p>

9409

</div>

9410

9411

9412

<p><strong>Default:</strong> undefined (false)</p>

9413

9414

9415

9416

9417

9418

</div>

9419

9420

9421

9422

9423

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

9424

9425

9426

<span class="flag deprecated" title="Use this.constructor.NAME">deprecated</span>

9427

9428

9429

9430

9431

9432

9433

9434

9435

9436

9437

9438

<p>Inherited from

9439

<a href="../classes/BaseCore.html#property_name">BaseCore</a>:

9440

9441

9442

9443

<a href="../files/base_js_BaseCore.js.html#l196"><code>base/js/BaseCore.js:196</code></a>

9444

9445

</p>

9446

9447

9448

<p>Deprecated: Use this.constructor.NAME</p>

9449

9450

9451

9452

</div>

9453

9454

9455

<p>The string used to identify the class of this object.</p>

9456

</div>

9457

9458

9459

9460

9461

9462

9463

</div>

9464

9465

9466

</div>

9467

9468

9469

9470

9471

<h2 class="off-left">Attributes</h2>

9472

9473

9474

9475

9476

<h3 class="name"><code>destroyed</code></h3>

9477

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>

9478

9479

9480

9481

9482

9483

9484

9485

9486

9487

9488

9489

9490

<p>Inherited from

9491

<a href="../classes/BaseCore.html#attr_destroyed">BaseCore</a>:

9492

9493

9494

9495

<a href="../files/base_js_BaseCore.js.html#l157"><code>base/js/BaseCore.js:157</code></a>

9496

9497

</p>

9498

9499

9500

9501

9502

</div>

9503

9504

9505

<p>Flag indicating whether or not this object

9506

has been through the destroy lifecycle phase.</p>

9507

</div>

9508

9509

9510

<p><strong>Default:</strong> false</p>

9511

9512

9513

9514

9515

<h4>Fires event <code>destroyedChange</code></h4>

9516

9517

<p>

9518

Fires when the value for the configuration attribute <code>destroyed</code> is

9519

changed. You can listen for the event using the <code>on</code> method if you

9520

wish to be notified before the attribute's value has changed, or

9521

using the <code>after</code> method if you wish to be notified after the

9522

attribute's value has changed.

9523

</p>

9524

9525

9526

<h4>Parameters:</h4>

9527

9528

9529

9530

9531

<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>

9532

9533

9534

An Event Facade object with the following

9535

attribute-specific properties added:

9536

</div>

9537

9538

9539

9540

<code class="param-name">prevVal</code>

9541

9542

<div class="param-description">The value of the attribute, prior to it being set.</div>

9543

</li>

9544

9545

<code class="param-name">newVal</code>

9546

9547

<div class="param-description">The value the attribute is to be set to.</div>

9548

</li>

9549

9550

<code class="param-name">attrName</code>

9551

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

9552

<div class="param-description">The name of the attribute being set.</div>

9553

</li>

9554

9555

<code class="param-name">subAttrName</code>

9556

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

9557

<div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div>

9558

</li>

9559

</ul>

9560

</li>

9561

</ul>

9562

</div>

9563

</div>

9564

9565

9566

9567

</div>

9568

9569

9570

9571

9572

<h3 class="name"><code>initialized</code></h3>

9573

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>

9574

9575

9576

9577

9578

9579

9580

9581

9582

9583

9584

9585

9586

<p>Inherited from

9587

<a href="../classes/BaseCore.html#attr_initialized">BaseCore</a>:

9588

9589

9590

9591

<a href="../files/base_js_BaseCore.js.html#l143"><code>base/js/BaseCore.js:143</code></a>

9592

9593

</p>

9594

9595

9596

9597

9598

</div>

9599

9600

9601

<p>Flag indicating whether or not this object

9602

has been through the init lifecycle phase.</p>

9603

</div>

9604

9605

9606

<p><strong>Default:</strong> false</p>

9607

9608

9609

9610

9611

<h4>Fires event <code>initializedChange</code></h4>

9612

9613

<p>

9614

Fires when the value for the configuration attribute <code>initialized</code> is

9615

changed. You can listen for the event using the <code>on</code> method if you

9616

wish to be notified before the attribute's value has changed, or

9617

using the <code>after</code> method if you wish to be notified after the

9618

attribute's value has changed.

9619

</p>

9620

9621

9622

<h4>Parameters:</h4>

9623

9624

9625

9626

9627

<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>

9628

9629

9630

An Event Facade object with the following

9631

attribute-specific properties added:

9632

</div>

9633

9634

9635

9636

<code class="param-name">prevVal</code>

9637

9638

<div class="param-description">The value of the attribute, prior to it being set.</div>

9639

</li>

9640

9641

<code class="param-name">newVal</code>

9642

9643

<div class="param-description">The value the attribute is to be set to.</div>

9644

</li>

9645

9646

<code class="param-name">attrName</code>

9647

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

9648

<div class="param-description">The name of the attribute being set.</div>

9649

</li>

9650

9651

<code class="param-name">subAttrName</code>

9652

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

9653

<div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div>

9654

</li>

9655

</ul>

9656

</li>

9657

</ul>

9658

</div>

9659

</div>

9660

9661

9662

9663

</div>

9664

9665

9666

</div>

9667

9668

9669

9670

9671

<h2 class="off-left">Events</h2>

9672

9673

9674

9675

<h3 class="name"><code>destroy</code></h3>

9676

9677

9678

9679

9680

9681

9682

9683

9684

9685

9686

9687

9688

9689

<p>Inherited from

9690

<a href="../classes/Base.html#event_destroy">Base</a>:

9691

9692

9693

9694

9695

9696

</p>

9697

9698

9699

9700

9701

</div>

9702

9703

9704

<p>

9705

Lifecycle event for the destroy phase,

9706

fired prior to destruction. Invoking the preventDefault

9707

method on the event object provided to subscribers will

9708

prevent destruction from proceeding.

9709

</p>

9710

9711

<p>

9712

Subscribers to the "after" moment of this event, will be notified

9713

after destruction is complete (and as a result cannot prevent

9714

destruction).

9715

</p>

9716

</div>

9717

9718

9719

9720

<h4>Event Payload:</h4>

9721

9722

9723

9724

9725

9726

9727

<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>

9728

9729

9730

9731

9732

9733

<p>Event object</p>

9734

</div>

9735

9736

9737

</li>

9738

9739

</ul>

9740

</div>

9741

9742

9743

9744

9745

</div>

9746

9747

9748

9749

9750

9751

9752

9753

9754

9755

9756

9757

9758

9759

9760

9761

9762

9763

<p>Inherited from

9764

<a href="../classes/Base.html#event_init">Base</a>:

9765

9766

9767

9768

9769

9770

</p>

9771

9772

9773

9774

9775

</div>

9776

9777

9778

<p>

9779

Lifecycle event for the init phase, fired prior to initialization.

9780

Invoking the preventDefault() method on the event object provided

9781

to subscribers will prevent initialization from occuring.

9782

</p>

9783

9784

<p>

9785

Subscribers to the "after" momemt of this event, will be notified

9786

after initialization of the object is complete (and therefore

9787

cannot prevent initialization).

9788

</p>

9789

</div>

9790

9791

9792

9793

<h4>Event Payload:</h4>

9794

9795

9796

9797

9798

9799

9800

<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>

9801

9802

9803

9804

9805

9806

<p>Event object, with a cfg property which

9807

refers to the configuration object passed to the constructor.</p>

9808

</div>

9809

9810

9811

</li>

9812

9813

</ul>

9814

</div>

9815

9816

9817

9818

9819

</div>

9820

9821

9822

</div>

9823

9824

</div>

9825

</div>

9826

9827

</div>

9828

</div>

9829

</div>

9830

</div>

9831

</div>

9832

</div>

9833

9834

9835

9836

9837

9838

9839

9840

9841

</body>

9842

</html>

Older »