~bac/juju-gui/trunkcopy

<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

Attribute

3472

</a>

3473

3474

but overwritten in

3475

3476

3477

3478

<a href="../files/attribute_js_AttributeCore.js.html#l823"><code>attribute/js/AttributeCore.js:823</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

4237

<p>Inherited from

4238

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

4239

4240

4241

4242

4243

4244

</p>

4245

4246

4247

4248

4249

4250

</div>

4251

4252

4253

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

4254

</div>

4255

4256

4257

4258

<h4>Parameters:</h4>

4259

4260

4261

4262

4263

4264

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

4265

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

4266

4267

4268

4269

4270

4271

<p>The constructor configuration object</p>

4272

</div>

4273

4274

4275

</li>

4276

4277

</ul>

4278

</div>

4279

4280

4281

4282

4283

4284

</div>

4285

4286

4287

4288

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

4289

4290

4291

4292

4293

4294

4295

4296

<code>config</code>

4297

4298

</li>

4299

4300

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

4301

</div>

4302

4303

4304

4305

4306

4307

4308

4309

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

4310

4311

4312

4313

4314

4315

4316

4317

4318

4319

4320

4321

<p>Inherited from

4322

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

4323

4324

4325

4326

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

4327

4328

</p>

4329

4330

4331

4332

4333

4334

</div>

4335

4336

4337

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

4338

</div>

4339

4340

4341

4342

<h4>Parameters:</h4>

4343

4344

4345

4346

4347

4348

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

4349

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

4350

4351

4352

4353

4354

4355

<p>The constructor configuration object</p>

4356

</div>

4357

4358

4359

</li>

4360

4361

</ul>

4362

</div>

4363

4364

4365

4366

4367

4368

</div>

4369

4370

4371

4372

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

4373

4374

4375

4376

4377

4378

4379

4380

<code>userVals</code>

4381

4382

</li>

4383

4384

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

4385

</div>

4386

4387

4388

4389

4390

4391

4392

4393

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

4394

4395

4396

4397

4398

4399

4400

4401

4402

4403

4404

4405

<p>Inherited from

4406

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

4407

4408

4409

4410

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

4411

4412

</p>

4413

4414

4415

4416

4417

4418

</div>

4419

4420

4421

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

4422

initializing attributes for each class defined in the class's

4423

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

4424

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

4425

</div>

4426

4427

4428

4429

<h4>Parameters:</h4>

4430

4431

4432

4433

4434

4435

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

4436

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

4437

4438

4439

4440

4441

4442

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

4443

</div>

4444

4445

4446

</li>

4447

4448

</ul>

4449

</div>

4450

4451

4452

4453

4454

4455

</div>

4456

4457

4458

4459

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

4460

4461

4462

4463

4464

4465

4466

4467

4468

4469

4470

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

4471

4472

4473

4474

4475

4476

4477

4478

4479

4480

4481

4482

<p>Inherited from

4483

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

4484

4485

4486

4487

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

4488

4489

</p>

4490

4491

4492

4493

4494

4495

</div>

4496

4497

4498

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

4499

the array of classes and aggregate set of attribute configurations

4500

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

4501

</div>

4502

4503

4504

4505

4506

4507

4508

</div>

4509

4510

4511

4512

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

4513

4514

4515

4516

4517

4518

4519

4520

4521

4522

</li>

4523

4524

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

4525

</div>

4526

4527

4528

4529

4530

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

4531

</span>

4532

4533

4534

4535

4536

4537

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

4538

4539

4540

4541

4542

4543

4544

4545

4546

4547

4548

4549

<p>Inherited from

4550

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

4551

4552

4553

4554

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

4555

4556

</p>

4557

4558

4559

4560

4561

4562

</div>

4563

4564

4565

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

4566

added lazily and still requires initialization.</p>

4567

</div>

4568

4569

4570

4571

<h4>Parameters:</h4>

4572

4573

4574

4575

4576

4577

4578

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

4579

4580

4581

4582

4583

4584

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

4585

</div>

4586

4587

4588

</li>

4589

4590

</ul>

4591

</div>

4592

4593

4594

4595

4596

<h4>Returns:</h4>

4597

4598

4599

4600

4601

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

4602

4603

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

4604

4605

</div>

4606

</div>

4607

4608

4609

4610

</div>

4611

4612

4613

4614

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

4615

4616

4617

4618

4619

4620

4621

4622

4623

4624

</li>

4625

4626

4627

4628

4629

4630

</li>

4631

4632

4633

4634

4635

4636

</li>

4637

4638

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

4639

</div>

4640

4641

4642

4643

4644

4645

4646

4647

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

4648

4649

4650

4651

4652

4653

4654

4655

4656

4657

4658

4659

<p>Inherited from

4660

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

4661

4662

4663

4664

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

4665

4666

</p>

4667

4668

4669

4670

4671

4672

</div>

4673

4674

4675

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

4676

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

4677

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

4678

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

4679

be subscribed to like other events to monitor the event

4680

system. Inividual published events can have monitoring

4681

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

4682

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

4683

</div>

4684

4685

4686

4687

<h4>Parameters:</h4>

4688

4689

4690

4691

4692

4693

4694

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

4695

4696

4697

4698

4699

4700

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

4701

</div>

4702

4703

4704

</li>

4705

4706

4707

4708

4709

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

4710

4711

4712

4713

4714

4715

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

4716

</div>

4717

4718

4719

</li>

4720

4721

4722

4723

4724

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

4725

4726

4727

4728

4729

4730

<p>Information about the event interaction, such as

4731

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

4732

</div>

4733

4734

4735

</li>

4736

4737

</ul>

4738

</div>

4739

4740

4741

4742

4743

4744

</div>

4745

4746

4747

4748

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

4749

4750

4751

4752

4753

4754

4755

4756

<code>valueHash</code>

4757

4758

</li>

4759

4760

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

4761

</div>

4762

4763

4764

4765

4766

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

4767

</span>

4768

4769

4770

4771

4772

4773

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

4774

4775

4776

4777

4778

4779

4780

4781

4782

4783

4784

<p>Inherited from

4785

4786

Attribute

4787

</a>

4788

4789

but overwritten in

4790

4791

4792

4793

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

4794

4795

</p>

4796

4797

4798

4799

4800

4801

</div>

4802

4803

4804

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

4805

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

4806

</div>

4807

4808

4809

4810

<h4>Parameters:</h4>

4811

4812

4813

4814

4815

4816

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

4817

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

4818

4819

4820

4821

4822

4823

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

4824

</div>

4825

4826

4827

</li>

4828

4829

</ul>

4830

</div>

4831

4832

4833

4834

4835

<h4>Returns:</h4>

4836

4837

4838

4839

4840

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

4841

4842

4843

</div>

4844

</div>

4845

4846

4847

4848

</div>

4849

4850

4851

4852

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

4853

4854

4855

4856

4857

4858

4859

4860

4861

4862

4863

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

4864

4865

4866

4867

4868

4869

4870

4871

4872

4873

4874

4875

<p>Inherited from

4876

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

4877

4878

4879

4880

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

4881

4882

</p>

4883

4884

4885

4886

4887

4888

</div>

4889

4890

4891

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

4892

and the prefixed event name from _getType

4893

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

4894

</div>

4895

4896

4897

4898

4899

4900

4901

</div>

4902

4903

4904

4905

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

4906

4907

4908

4909

4910

4911

4912

4913

<code>config</code>

4914

4915

</li>

4916

4917

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

4918

</div>

4919

4920

4921

4922

4923

4924

4925

4926

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

4927

4928

4929

4930

4931

4932

4933

4934

4935

4936

4937

4938

<p>Inherited from

4939

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

4940

4941

4942

4943

4944

4945

</p>

4946

4947

4948

4949

4950

4951

</div>

4952

4953

4954

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

4955

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

4956

construction, prior to init.</p>

4957

</div>

4958

4959

4960

4961

<h4>Parameters:</h4>

4962

4963

4964

4965

4966

4967

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

4968

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

4969

4970

4971

4972

4973

4974

<p>The user configuration object</p>

4975

</div>

4976

4977

4978

</li>

4979

4980

</ul>

4981

</div>

4982

4983

4984

4985

4986

4987

</div>

4988

4989

4990

4991

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

4992

4993

4994

4995

4996

4997

4998

4999

<code>attrs</code>

5000

5001

</li>

5002

5003

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

5004

</div>

5005

5006

5007

5008

5009

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

5010

</span>

5011

5012

5013

5014

5015

5016

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

5017

5018

5019

5020

5021

5022

5023

5024

5025

5026

5027

5028

<p>Inherited from

5029

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

5030

5031

5032

5033

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

5034

5035

</p>

5036

5037

5038

5039

5040

5041

</div>

5042

5043

5044

<p>Utility method to protect an attribute configuration

5045

hash, by merging the entire object and the individual

5046

attr config objects.</p>

5047

</div>

5048

5049

5050

5051

<h4>Parameters:</h4>

5052

5053

5054

5055

5056

5057

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

5058

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

5059

5060

5061

5062

5063

5064

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

5065

</div>

5066

5067

5068

</li>

5069

5070

</ul>

5071

</div>

5072

5073

5074

5075

5076

<h4>Returns:</h4>

5077

5078

5079

5080

5081

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

5082

5083

A protected version of the attrs argument.

5084

5085

</div>

5086

</div>

5087

5088

5089

5090

</div>

5091

5092

5093

5094

5095

5096

5097

5098

5099

5100

5101

5102

5103

5104

</li>

5105

5106

5107

5108

5109

5110

</li>

5111

5112

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

5113

</div>

5114

5115

5116

5117

5118

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

5119

</span>

5120

5121

5122

5123

5124

5125

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

5126

5127

5128

5129

5130

5131

5132

5133

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

5134

5135

5136

5137

5138

<p>Inherited from

5139

5140

AttributeEvents

5141

</a>

5142

5143

but overwritten in

5144

5145

5146

5147

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

5148

5149

</p>

5150

5151

5152

5153

5154

5155

</div>

5156

5157

5158

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

5159

</div>

5160

5161

5162

5163

<h4>Parameters:</h4>

5164

5165

5166

5167

5168

5169

5170

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

5171

5172

5173

5174

5175

5176

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

5177

</div>

5178

5179

5180

</li>

5181

5182

5183

5184

5185

5186

5187

5188

5189

5190

5191

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

5192

</div>

5193

5194

5195

</li>

5196

5197

</ul>

5198

</div>

5199

5200

5201

5202

5203

<h4>Returns:</h4>

5204

5205

5206

5207

5208

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

5209

5210

A reference to the host object.

5211

5212

</div>

5213

</div>

5214

5215

5216

5217

</div>

5218

5219

5220

5221

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

5222

5223

5224

5225

5226

5227

5228

5229

5230

5231

</li>

5232

5233

5234

5235

<code>value</code>

5236

5237

</li>

5238

5239

5240

5241

5242

5243

</li>

5244

5245

5246

5247

<code>force</code>

5248

5249

</li>

5250

5251

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

5252

</div>

5253

5254

5255

5256

5257

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

5258

</span>

5259

5260

5261

5262

5263

5264

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

5265

5266

5267

5268

5269

5270

5271

5272

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

5273

5274

5275

5276

5277

5278

<p>Inherited from

5279

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

5280

5281

5282

5283

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

5284

5285

</p>

5286

5287

5288

5289

5290

5291

</div>

5292

5293

5294

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

5295

5296

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

5297

</div>

5298

5299

5300

5301

<h4>Parameters:</h4>

5302

5303

5304

5305

5306

5307

5308

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

5309

5310

5311

5312

5313

5314

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

5315

</div>

5316

5317

5318

</li>

5319

5320

5321

5322

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

5323

5324

5325

5326

5327

5328

5329

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

5330

</div>

5331

5332

5333

</li>

5334

5335

5336

5337

5338

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

5339

5340

5341

5342

5343

5344

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

5345

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

5346

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

5347

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

5348

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

5349

</div>

5350

5351

5352

</li>

5353

5354

5355

5356

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

5357

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

5358

5359

5360

5361

5362

5363

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

5364

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

5365

</div>

5366

5367

5368

</li>

5369

5370

</ul>

5371

</div>

5372

5373

5374

5375

5376

<h4>Returns:</h4>

5377

5378

5379

5380

5381

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

5382

5383

A reference to the host object.

5384

5385

</div>

5386

</div>

5387

5388

5389

5390

</div>

5391

5392

5393

5394

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

5395

5396

5397

5398

5399

5400

5401

5402

<code>attrs</code>

5403

5404

</li>

5405

5406

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

5407

</div>

5408

5409

5410

5411

5412

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

5413

</span>

5414

5415

5416

5417

5418

5419

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

5420

5421

5422

5423

5424

5425

5426

5427

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

5428

5429

5430

5431

5432

5433

<p>Inherited from

5434

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

5435

5436

5437

5438

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

5439

5440

</p>

5441

5442

5443

5444

5445

5446

</div>

5447

5448

5449

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

5450

</div>

5451

5452

5453

5454

<h4>Parameters:</h4>

5455

5456

5457

5458

5459

5460

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

5461

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

5462

5463

5464

5465

5466

5467

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

5468

</div>

5469

5470

5471

</li>

5472

5473

</ul>

5474

</div>

5475

5476

5477

5478

5479

<h4>Returns:</h4>

5480

5481

5482

5483

5484

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

5485

5486

A reference to the host object.

5487

5488

</div>

5489

</div>

5490

5491

5492

5493

</div>

5494

5495

5496

5497

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

5498

5499

5500

5501

5502

5503

5504

5505

<code>attrName</code>

5506

5507

</li>

5508

5509

5510

5511

<code>subAttrName</code>

5512

5513

</li>

5514

5515

5516

5517

<code>prevVal</code>

5518

5519

</li>

5520

5521

5522

5523

<code>newVal</code>

5524

5525

</li>

5526

5527

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

5528

</div>

5529

5530

5531

5532

5533

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

5534

</span>

5535

5536

5537

5538

5539

5540

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

5541

5542

5543

5544

5545

5546

5547

5548

5549

5550

5551

5552

<p>Inherited from

5553

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

5554

5555

5556

5557

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

5558

5559

</p>

5560

5561

5562

5563

5564

5565

</div>

5566

5567

5568

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

5569

if validation and setter passes.</p>

5570

</div>

5571

5572

5573

5574

<h4>Parameters:</h4>

5575

5576

5577

5578

5579

5580

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

5581

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

5582

5583

5584

5585

5586

5587

<p>The attribute name.</p>

5588

</div>

5589

5590

5591

</li>

5592

5593

5594

5595

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

5596

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

5597

5598

5599

5600

5601

5602

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

5603

</div>

5604

5605

5606

</li>

5607

5608

5609

5610

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

5611

5612

5613

5614

5615

5616

5617

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

5618

</div>

5619

5620

5621

</li>

5622

5623

5624

5625

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

5626

5627

5628

5629

5630

5631

5632

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

5633

</div>

5634

5635

5636

</li>

5637

5638

</ul>

5639

</div>

5640

5641

5642

5643

5644

<h4>Returns:</h4>

5645

5646

5647

5648

5649

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

5650

5651

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

5652

5653

</div>

5654

</div>

5655

5656

5657

5658

</div>

5659

5660

5661

5662

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

5663

5664

5665

5666

5667

5668

5669

5670

5671

5672

</li>

5673

5674

5675

5676

<code>value</code>

5677

5678

</li>

5679

5680

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

5681

</div>

5682

5683

5684

5685

5686

5687

5688

5689

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

5690

5691

5692

5693

5694

5695

5696

5697

5698

5699

5700

5701

<p>Inherited from

5702

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

5703

5704

5705

5706

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

5707

5708

</p>

5709

5710

5711

5712

5713

5714

</div>

5715

5716

5717

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

5718

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

5719

</div>

5720

5721

5722

5723

<h4>Parameters:</h4>

5724

5725

5726

5727

5728

5729

5730

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

5731

5732

5733

5734

5735

5736

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

5737

</div>

5738

5739

5740

</li>

5741

5742

5743

5744

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

5745

5746

5747

5748

5749

5750

5751

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

5752

</div>

5753

5754

5755

</li>

5756

5757

</ul>

5758

</div>

5759

5760

5761

5762

5763

5764

</div>

5765

5766

5767

5768

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

5769

5770

5771

5772

5773

5774

5775

5776

5777

5778

</li>

5779

5780

5781

5782

<code>config</code>

5783

5784

</li>

5785

5786

5787

5788

5789

5790

</li>

5791

5792

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

5793

</div>

5794

5795

5796

5797

5798

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

5799

</span>

5800

5801

5802

5803

5804

5805

5806

5807

5808

5809

5810

5811

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

5812

5813

5814

5815

5816

5817

<p>Inherited from

5818

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

5819

5820

5821

5822

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

5823

5824

</p>

5825

5826

5827

5828

5829

5830

</div>

5831

5832

5833

<p>

5834

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

5835

</p>

5836

5837

<p>

5838

The config argument object supports the following properties:

5839

</p>

5840

5841

<dl>

5842

<dt>value <Any></dt>

5843

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

5844

5845

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

5846

<dd>

5847

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

5848

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

5849

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

5850

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

5851

case the value property is used.</p>

5852

5853

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

5854

</dd>

5855

5856

<dt>readOnly <boolean></dt>

5857

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

5858

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

5859

5860

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

5861

<dd>

5862

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

5863

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

5864

constructor configuration arguments, or by invoking set.

5865

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

5866

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

5867

</dd>

5868

5869

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

5870

<dd>

5871

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

5872

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

5873

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

5874

the value from being stored.

5875

</p>

5876

5877

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

5878

</dd>

5879

5880

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

5881

<dd>

5882

<p>

5883

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

5884

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

5885

invoke get.

5886

</p>

5887

5888

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

5889

</dd>

5890

5891

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

5892

<dd>

5893

<p>

5894

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

5895

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

5896

</p>

5897

5898

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

5899

</dd>

5900

5901

<dt>lazyAdd <boolean></dt>

5902

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

5903

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

5904

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

5905

5906

</dl>

5907

5908

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

5909

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

5910

5911

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

5912

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

5913

</div>

5914

5915

5916

5917

<h4>Parameters:</h4>

5918

5919

5920

5921

5922

5923

5924

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

5925

5926

5927

5928

5929

5930

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

5931

</div>

5932

5933

5934

</li>

5935

5936

5937

5938

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

5939

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

5940

5941

5942

5943

5944

5945

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

5946

5947

<p>

5948

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

5949

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

5950

</p>

5951

</div>

5952

5953

5954

</li>

5955

5956

5957

5958

5959

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

5960

5961

5962

5963

5964

5965

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

5966

</div>

5967

5968

5969

</li>

5970

5971

</ul>

5972

</div>

5973

5974

5975

5976

5977

<h4>Returns:</h4>

5978

5979

5980

5981

5982

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

5983

5984

A reference to the host object.

5985

5986

</div>

5987

</div>

5988

5989

5990

5991

</div>

5992

5993

5994

5995

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

5996

5997

5998

5999

6000

6001

6002

6003

6004

6005

</li>

6006

6007

6008

6009

<code>values</code>

6010

6011

</li>

6012

6013

6014

6015

6016

6017

</li>

6018

6019

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

6020

</div>

6021

6022

6023

6024

6025

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

6026

</span>

6027

6028

6029

6030

6031

6032

6033

6034

6035

6036

6037

6038

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

6039

6040

6041

6042

6043

6044

<p>Inherited from

6045

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

6046

6047

6048

6049

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

6050

6051

</p>

6052

6053

6054

6055

6056

6057

</div>

6058

6059

6060

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

6061

6062

<p>

6063

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

6064

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

6065

</p>

6066

</div>

6067

6068

6069

6070

<h4>Parameters:</h4>

6071

6072

6073

6074

6075

6076

6077

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

6078

6079

6080

6081

6082

6083

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

6084

</div>

6085

6086

6087

</li>

6088

6089

6090

6091

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

6092

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

6093

6094

6095

6096

6097

6098

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

6099

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

6100

</div>

6101

6102

6103

</li>

6104

6105

6106

6107

6108

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

6109

6110

6111

6112

6113

6114

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

6115

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

6116

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

6117

</div>

6118

6119

6120

</li>

6121

6122

</ul>

6123

</div>

6124

6125

6126

6127

6128

<h4>Returns:</h4>

6129

6130

6131

6132

6133

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

6134

6135

A reference to the host object.

6136

6137

</div>

6138

</div>

6139

6140

6141

6142

</div>

6143

6144

6145

6146

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

6147

6148

6149

6150

6151

6152

6153

6154

6155

6156

</li>

6157

6158

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

6159

</div>

6160

6161

6162

6163

6164

6165

6166

6167

6168

6169

6170

6171

6172

6173

6174

6175

6176

6177

<p>Inherited from

6178

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

6179

6180

6181

6182

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

6183

6184

</p>

6185

6186

6187

6188

6189

6190

</div>

6191

6192

6193

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

6194

is determined by the order registered. Multiple targets can

6195

be specified.</p>

6196

6197

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

6198

6199

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

6200

</div>

6201

6202

6203

6204

<h4>Parameters:</h4>

6205

6206

6207

6208

6209

6210

6211

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

6212

6213

6214

6215

6216

6217

<p>the target to add</p>

6218

</div>

6219

6220

6221

</li>

6222

6223

</ul>

6224

</div>

6225

6226

6227

6228

6229

6230

</div>

6231

6232

6233

6234

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

6235

6236

6237

6238

6239

6240

6241

6242

6243

6244

</li>

6245

6246

6247

6248

6249

6250

</li>

6251

6252

6253

6254

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

6255

6256

</li>

6257

6258

6259

6260

6261

6262

</li>

6263

6264

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

6265

</div>

6266

6267

6268

6269

6270

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

6271

</span>

6272

6273

6274

6275

6276

6277

6278

6279

6280

6281

6282

6283

6284

6285

6286

6287

<p>Inherited from

6288

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

6289

6290

6291

6292

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

6293

6294

</p>

6295

6296

6297

6298

6299

6300

</div>

6301

6302

6303

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

6304

supplied callback will execute after any listeners add

6305

via the subscribe method, and after the default function,

6306

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

6307

</div>

6308

6309

6310

6311

<h4>Parameters:</h4>

6312

6313

6314

6315

6316

6317

6318

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

6319

6320

6321

6322

6323

6324

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

6325

</div>

6326

6327

6328

</li>

6329

6330

6331

6332

6333

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

6334

6335

6336

6337

6338

6339

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

6340

</div>

6341

6342

6343

</li>

6344

6345

6346

6347

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

6348

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

6349

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

6350

6351

6352

6353

6354

6355

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

6356

</div>

6357

6358

6359

</li>

6360

6361

6362

6363

6364

6365

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

6366

6367

6368

6369

6370

6371

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

6372

</div>

6373

6374

6375

</li>

6376

6377

</ul>

6378

</div>

6379

6380

6381

6382

6383

<h4>Returns:</h4>

6384

6385

6386

6387

6388

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

6389

6390

A subscription handle capable of detaching the

6391

subscription

6392

6393

</div>

6394

</div>

6395

6396

6397

6398

</div>

6399

6400

6401

6402

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

6403

6404

6405

6406

6407

6408

6409

6410

6411

6412

</li>

6413

6414

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

6415

</div>

6416

6417

6418

6419

6420

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

6421

</span>

6422

6423

6424

6425

6426

6427

6428

6429

6430

6431

6432

6433

6434

6435

6436

6437

<p>Inherited from

6438

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

6439

6440

6441

6442

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

6443

6444

</p>

6445

6446

6447

6448

6449

6450

</div>

6451

6452

6453

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

6454

</div>

6455

6456

6457

6458

<h4>Parameters:</h4>

6459

6460

6461

6462

6463

6464

6465

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

6466

6467

6468

6469

6470

6471

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

6472

</div>

6473

6474

6475

</li>

6476

6477

</ul>

6478

</div>

6479

6480

6481

6482

6483

<h4>Returns:</h4>

6484

6485

6486

6487

6488

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

6489

6490

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.

6491

6492

</div>

6493

</div>

6494

6495

6496

6497

</div>

6498

6499

6500

6501

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

6502

6503

6504

6505

6506

6507

6508

6509

6510

</span>

6511

6512

6513

6514

6515

6516

6517

6518

6519

6520

6521

6522

6523

6524

6525

6526

<p>Inherited from

6527

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

6528

6529

6530

6531

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

6532

6533

</p>

6534

6535

6536

6537

6538

6539

</div>

6540

6541

6542

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

6543

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

6544

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

6545

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

6546

6547

<p>For DOM and custom events:

6548

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

6549

6550

<p>For methods:

6551

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

6552

</div>

6553

6554

6555

6556

6557

6558

<h4>Returns:</h4>

6559

6560

6561

6562

6563

detach handle

6564

6565

</div>

6566

</div>

6567

6568

6569

6570

</div>

6571

6572

6573

6574

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

6575

6576

6577

6578

6579

6580

6581

6582

6583

6584

</li>

6585

6586

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

6587

</div>

6588

6589

6590

6591

6592

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

6593

</span>

6594

6595

6596

6597

6598

6599

6600

6601

6602

6603

6604

6605

6606

6607

6608

6609

<p>Inherited from

6610

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

6611

6612

6613

6614

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

6615

6616

</p>

6617

6618

6619

6620

6621

6622

</div>

6623

6624

6625

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

6626

</div>

6627

6628

6629

6630

<h4>Parameters:</h4>

6631

6632

6633

6634

6635

6636

6637

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

6638

6639

6640

6641

6642

6643

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

6644

</div>

6645

6646

6647

</li>

6648

6649

</ul>

6650

</div>

6651

6652

6653

6654

6655

<h4>Returns:</h4>

6656

6657

6658

6659

6660

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

6661

6662

the aggregated return value from Event.Custom.fire

6663

6664

</div>

6665

</div>

6666

6667

6668

6669

</div>

6670

6671

6672

6673

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

6674

6675

6676

6677

6678

6679

6680

6681

6682

</span>

6683

6684

6685

6686

6687

6688

6689

6690

6691

6692

6693

6694

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

6695

6696

6697

6698

6699

<p>Inherited from

6700

6701

BaseCore

6702

</a>

6703

6704

but overwritten in

6705

6706

6707

6708

6709

6710

</p>

6711

6712

6713

6714

6715

6716

</div>

6717

6718

6719

<p>

6720

Destroy lifecycle method. Fires the destroy

6721

event, prior to invoking destructors for the

6722

class hierarchy.

6723

</p>

6724

6725

<p>

6726

Subscribers to the destroy

6727

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

6728

from proceeding.

6729

</p>

6730

</div>

6731

6732

6733

6734

6735

6736

<h4>Returns:</h4>

6737

6738

6739

6740

6741

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

6742

6743

A reference to this object

6744

6745

</div>

6746

</div>

6747

6748

6749

6750

</div>

6751

6752

6753

6754

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

6755

6756

6757

6758

6759

6760

6761

6762

6763

6764

</li>

6765

6766

6767

6768

6769

6770

</li>

6771

6772

6773

6774

<code>context</code>

6775

6776

</li>

6777

6778

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

6779

</div>

6780

6781

6782

6783

6784

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

6785

</span>

6786

6787

6788

6789

6790

6791

6792

6793

6794

6795

6796

6797

6798

6799

6800

6801

<p>Inherited from

6802

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

6803

6804

6805

6806

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

6807

6808

</p>

6809

6810

6811

6812

6813

6814

</div>

6815

6816

6817

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

6818

</div>

6819

6820

6821

6822

<h4>Parameters:</h4>

6823

6824

6825

6826

6827

6828

6829

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

6830

6831

6832

6833

6834

6835

<p>Either the handle to the subscriber or the

6836

type of event. If the type

6837

is not specified, it will attempt to remove

6838

the listener from all hosted events.</p>

6839

</div>

6840

6841

6842

</li>

6843

6844

6845

6846

6847

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

6848

6849

6850

6851

6852

6853

<p>The subscribed function to unsubscribe, if not

6854

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

6855

</div>

6856

6857

6858

</li>

6859

6860

6861

6862

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

6863

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

6864

6865

6866

6867

6868

6869

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

6870

optional, but if supplied will be used to

6871

disambiguate multiple listeners that are the same

6872

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

6873

that lives on the prototype)</p>

6874

</div>

6875

6876

6877

</li>

6878

6879

</ul>

6880

</div>

6881

6882

6883

6884

6885

<h4>Returns:</h4>

6886

6887

6888

6889

6890

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

6891

6892

the host

6893

6894

</div>

6895

</div>

6896

6897

6898

6899

</div>

6900

6901

6902

6903

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

6904

6905

6906

6907

6908

6909

6910

6911

6912

6913

</li>

6914

6915

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

6916

</div>

6917

6918

6919

6920

6921

6922

6923

6924

6925

6926

6927

6928

6929

6930

6931

6932

6933

6934

<p>Inherited from

6935

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

6936

6937

6938

6939

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

6940

6941

</p>

6942

6943

6944

6945

6946

6947

</div>

6948

6949

6950

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

6951

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

6952

be removed.</p>

6953

</div>

6954

6955

6956

6957

<h4>Parameters:</h4>

6958

6959

6960

6961

6962

6963

6964

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

6965

6966

6967

6968

6969

6970

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

6971

</div>

6972

6973

6974

</li>

6975

6976

</ul>

6977

</div>

6978

6979

6980

6981

6982

6983

</div>

6984

6985

6986

6987

6988

6989

6990

6991

6992

6993

6994

6995

6996

6997

</li>

6998

6999

7000

7001

<code>arguments</code>

7002

7003

</li>

7004

7005

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

7006

</div>

7007

7008

7009

7010

7011

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

7012

</span>

7013

7014

7015

7016

7017

7018

7019

7020

7021

7022

7023

7024

7025

7026

7027

7028

<p>Inherited from

7029

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

7030

7031

7032

7033

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

7034

7035

</p>

7036

7037

7038

7039

7040

7041

</div>

7042

7043

7044

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

7045

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

7046

following parameters.</p>

7047

7048

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

7049

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

7050

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

7051

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

7052

be published on this object first.</p>

7053

7054

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

7055

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

7056

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

7057

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

7058

in place of the original object.</p>

7059

</div>

7060

7061

7062

7063

<h4>Parameters:</h4>

7064

7065

7066

7067

7068

7069

7070

7071

7072

7073

7074

7075

7076

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

7077

a 'type' property.</p>

7078

</div>

7079

7080

7081

</li>

7082

7083

7084

7085

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

7086

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

7087

7088

7089

7090

7091

7092

<p>an arbitrary set of parameters to pass to

7093

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

7094

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

7095

parameter after the properties the object literal contains are copied to

7096

the event facade.</p>

7097

</div>

7098

7099

7100

</li>

7101

7102

</ul>

7103

</div>

7104

7105

7106

7107

7108

<h4>Returns:</h4>

7109

7110

7111

7112

7113

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

7114

7115

the event host

7116

7117

</div>

7118

</div>

7119

7120

7121

7122

</div>

7123

7124

7125

7126

7127

7128

7129

7130

7131

7132

7133

7134

7135

7136

</li>

7137

7138

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

7139

</div>

7140

7141

7142

7143

7144

7145

</span>

7146

7147

7148

7149

7150

7151

7152

7153

7154

7155

7156

7157

7158

7159

7160

7161

<p>Inherited from

7162

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

7163

7164

7165

7166

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

7167

7168

</p>

7169

7170

7171

7172

7173

7174

</div>

7175

7176

7177

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

7178

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

7179

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

7180

</div>

7181

7182

7183

7184

<h4>Parameters:</h4>

7185

7186

7187

7188

7189

7190

7191

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

7192

7193

7194

7195

7196

7197

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

7198

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

7199

</div>

7200

7201

7202

</li>

7203

7204

</ul>

7205

</div>

7206

7207

7208

7209

7210

<h4>Returns:</h4>

7211

7212

7213

7214

7215

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

7216

7217

The value of the attribute

7218

7219

</div>

7220

</div>

7221

7222

7223

7224

</div>

7225

7226

7227

7228

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

7229

7230

7231

7232

7233

7234

7235

7236

<code>attrs</code>

7237

7238

</li>

7239

7240

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

7241

</div>

7242

7243

7244

7245

7246

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

7247

</span>

7248

7249

7250

7251

7252

7253

7254

7255

7256

7257

7258

7259

7260

7261

7262

7263

<p>Inherited from

7264

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

7265

7266

7267

7268

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

7269

7270

</p>

7271

7272

7273

7274

7275

7276

</div>

7277

7278

7279

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

7280

</div>

7281

7282

7283

7284

<h4>Parameters:</h4>

7285

7286

7287

7288

7289

7290

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

7291

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

7292

7293

7294

7295

7296

7297

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

7298

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

7299

</div>

7300

7301

7302

</li>

7303

7304

</ul>

7305

</div>

7306

7307

7308

7309

7310

<h4>Returns:</h4>

7311

7312

7313

7314

7315

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

7316

7317

An object with attribute name/value pairs.

7318

7319

</div>

7320

</div>

7321

7322

7323

7324

</div>

7325

7326

7327

7328

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

7329

7330

7331

7332

7333

7334

7335

7336

7337

7338

</li>

7339

7340

7341

7342

<code>prefixed</code>

7343

7344

</li>

7345

7346

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

7347

</div>

7348

7349

7350

7351

7352

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

7353

</span>

7354

7355

7356

7357

7358

7359

7360

7361

7362

7363

7364

7365

7366

7367

7368

7369

<p>Inherited from

7370

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

7371

7372

7373

7374

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

7375

7376

</p>

7377

7378

7379

7380

7381

7382

</div>

7383

7384

7385

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

7386

falsy value otherwise</p>

7387

</div>

7388

7389

7390

7391

<h4>Parameters:</h4>

7392

7393

7394

7395

7396

7397

7398

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

7399

7400

7401

7402

7403

7404

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

7405

</div>

7406

7407

7408

</li>

7409

7410

7411

7412

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

7413

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

7414

7415

7416

7417

7418

7419

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

7420

</div>

7421

7422

7423

</li>

7424

7425

</ul>

7426

</div>

7427

7428

7429

7430

7431

<h4>Returns:</h4>

7432

7433

7434

7435

7436

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

7437

7438

the custom event or null

7439

7440

</div>

7441

</div>

7442

7443

7444

7445

</div>

7446

7447

7448

7449

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

7450

7451

7452

7453

7454

7455

7456

7457

7458

</span>

7459

7460

7461

7462

7463

7464

7465

7466

7467

7468

7469

7470

7471

7472

7473

7474

<p>Inherited from

7475

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

7476

7477

7478

7479

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

7480

7481

</p>

7482

7483

7484

7485

7486

7487

</div>

7488

7489

7490

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

7491

</div>

7492

7493

7494

7495

7496

7497

<h4>Returns:</h4>

7498

7499

7500

7501

7502

EventTarget[]

7503

7504

</div>

7505

</div>

7506

7507

7508

7509

</div>

7510

7511

7512

7513

7514

7515

7516

7517

7518

7519

7520

7521

<code>config</code>

7522

7523

</li>

7524

7525

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

7526

</div>

7527

7528

7529

7530

7531

7532

</span>

7533

7534

7535

7536

7537

7538

7539

7540

7541

7542

7543

7544

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

7545

7546

7547

7548

7549

<p>Inherited from

7550

7551

BaseCore

7552

</a>

7553

7554

but overwritten in

7555

7556

7557

7558

7559

7560

</p>

7561

7562

7563

7564

7565

7566

</div>

7567

7568

7569

<p>Init lifecycle method, invoked during construction.

7570

Fires the init event prior to setting up attributes and

7571

invoking initializers for the class hierarchy.</p>

7572

</div>

7573

7574

7575

7576

<h4>Parameters:</h4>

7577

7578

7579

7580

7581

7582

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

7583

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

7584

7585

7586

7587

7588

7589

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

7590

</div>

7591

7592

7593

</li>

7594

7595

</ul>

7596

</div>

7597

7598

7599

7600

7601

<h4>Returns:</h4>

7602

7603

7604

7605

7606

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

7607

7608

A reference to this object

7609

7610

</div>

7611

</div>

7612

7613

7614

7615

</div>

7616

7617

7618

7619

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

7620

7621

7622

7623

7624

7625

7626

7627

7628

7629

</li>

7630

7631

7632

7633

<code>config</code>

7634

7635

</li>

7636

7637

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

7638

</div>

7639

7640

7641

7642

7643

7644

7645

7646

7647

7648

7649

7650

7651

7652

7653

7654

7655

7656

<p>Inherited from

7657

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

7658

7659

7660

7661

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

7662

7663

</p>

7664

7665

7666

7667

7668

7669

</div>

7670

7671

7672

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

7673

7674

<p>

7675

The properties which can be modified through this interface are limited

7676

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

7677

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

7678

broadcast and getter.

7679

</p>

7680

</div>

7681

7682

7683

7684

<h4>Parameters:</h4>

7685

7686

7687

7688

7689

7690

7691

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

7692

7693

7694

7695

7696

7697

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

7698

</div>

7699

7700

7701

</li>

7702

7703

7704

7705

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

7706

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

7707

7708

7709

7710

7711

7712

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

7713

</div>

7714

7715

7716

</li>

7717

7718

</ul>

7719

</div>

7720

7721

7722

7723

7724

7725

</div>

7726

7727

7728

7729

7730

7731

7732

7733

7734

7735

7736

7737

7738

7739

</li>

7740

7741

7742

7743

7744

7745

</li>

7746

7747

7748

7749

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

7750

7751

</li>

7752

7753

7754

7755

7756

7757

</li>

7758

7759

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

7760

</div>

7761

7762

7763

7764

7765

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

7766

</span>

7767

7768

7769

7770

7771

7772

7773

7774

7775

7776

7777

7778

7779

7780

7781

7782

<p>Inherited from

7783

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

7784

7785

7786

7787

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

7788

7789

</p>

7790

7791

7792

7793

7794

7795

</div>

7796

7797

7798

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

7799

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

7800

7801

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

7802

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

7803

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

7804

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

7805

API for all available properties and methods. Subscribers to

7806

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

7807

after the event name.</p>

7808

7809

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

7810

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

7811

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

7812

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

7813

7814

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

7815

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

7816

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

7817

</div>

7818

7819

7820

7821

<h4>Parameters:</h4>

7822

7823

7824

7825

7826

7827

7828

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

7829

7830

7831

7832

7833

7834

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

7835

</div>

7836

7837

7838

</li>

7839

7840

7841

7842

7843

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

7844

7845

7846

7847

7848

7849

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

7850

</div>

7851

7852

7853

</li>

7854

7855

7856

7857

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

7858

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

7859

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

7860

7861

7862

7863

7864

7865

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

7866

</div>

7867

7868

7869

</li>

7870

7871

7872

7873

7874

7875

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

7876

7877

7878

7879

7880

7881

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

7882

</div>

7883

7884

7885

</li>

7886

7887

</ul>

7888

</div>

7889

7890

7891

7892

7893

<h4>Returns:</h4>

7894

7895

7896

7897

7898

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

7899

7900

A subscription handle capable of detaching that

7901

subscription

7902

7903

</div>

7904

</div>

7905

7906

7907

7908

</div>

7909

7910

7911

7912

7913

7914

7915

7916

7917

7918

7919

7920

7921

7922

</li>

7923

7924

7925

7926

7927

7928

</li>

7929

7930

7931

7932

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

7933

7934

</li>

7935

7936

7937

7938

7939

7940

</li>

7941

7942

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

7943

</div>

7944

7945

7946

7947

7948

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

7949

</span>

7950

7951

7952

7953

7954

7955

7956

7957

7958

7959

7960

7961

7962

7963

7964

7965

<p>Inherited from

7966

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

7967

7968

7969

7970

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

7971

7972

</p>

7973

7974

7975

7976

7977

7978

</div>

7979

7980

7981

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

7982

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

7983

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

7984

</div>

7985

7986

7987

7988

<h4>Parameters:</h4>

7989

7990

7991

7992

7993

7994

7995

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

7996

7997

7998

7999

8000

8001

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

8002

</div>

8003

8004

8005

</li>

8006

8007

8008

8009

8010

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

8011

8012

8013

8014

8015

8016

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

8017

</div>

8018

8019

8020

</li>

8021

8022

8023

8024

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

8025

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

8026

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

8027

8028

8029

8030

8031

8032

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

8033

</div>

8034

8035

8036

</li>

8037

8038

8039

8040

8041

8042

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

8043

8044

8045

8046

8047

8048

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

8049

</div>

8050

8051

8052

</li>

8053

8054

</ul>

8055

</div>

8056

8057

8058

8059

8060

<h4>Returns:</h4>

8061

8062

8063

8064

8065

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

8066

8067

A subscription handle capable of detaching the

8068

subscription

8069

8070

</div>

8071

</div>

8072

8073

8074

8075

</div>

8076

8077

8078

8079

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

8080

8081

8082

8083

8084

8085

8086

8087

8088

8089

</li>

8090

8091

8092

8093

8094

8095

</li>

8096

8097

8098

8099

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

8100

8101

</li>

8102

8103

8104

8105

8106

8107

</li>

8108

8109

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

8110

</div>

8111

8112

8113

8114

8115

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

8116

</span>

8117

8118

8119

8120

8121

8122

8123

8124

8125

8126

8127

8128

8129

8130

8131

8132

<p>Inherited from

8133

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

8134

8135

8136

8137

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

8138

8139

</p>

8140

8141

8142

8143

8144

8145

</div>

8146

8147

8148

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

8149

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

8150

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

8151

</div>

8152

8153

8154

8155

<h4>Parameters:</h4>

8156

8157

8158

8159

8160

8161

8162

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

8163

8164

8165

8166

8167

8168

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

8169

</div>

8170

8171

8172

</li>

8173

8174

8175

8176

8177

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

8178

8179

8180

8181

8182

8183

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

8184

</div>

8185

8186

8187

</li>

8188

8189

8190

8191

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

8192

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

8193

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

8194

8195

8196

8197

8198

8199

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

8200

</div>

8201

8202

8203

</li>

8204

8205

8206

8207

8208

8209

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

8210

8211

8212

8213

8214

8215

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

8216

</div>

8217

8218

8219

</li>

8220

8221

</ul>

8222

</div>

8223

8224

8225

8226

8227

<h4>Returns:</h4>

8228

8229

8230

8231

8232

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

8233

8234

A subscription handle capable of detaching that

8235

subscription

8236

8237

</div>

8238

</div>

8239

8240

8241

8242

</div>

8243

8244

8245

8246

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

8247

8248

8249

8250

8251

8252

8253

8254

8255

8256

</li>

8257

8258

8259

8260

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

8261

8262

</li>

8263

8264

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

8265

</div>

8266

8267

8268

8269

8270

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

8271

</span>

8272

8273

8274

8275

8276

8277

8278

8279

8280

8281

8282

8283

8284

8285

8286

8287

<p>Inherited from

8288

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

8289

8290

8291

8292

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

8293

8294

</p>

8295

8296

8297

8298

8299

8300

<p>Available since 3.3.0</p>

8301

8302

</div>

8303

8304

8305

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

8306

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

8307

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

8308

to include the prefix one is supplied or the event target

8309

is configured with a default prefix.</p>

8310

</div>

8311

8312

8313

8314

<h4>Parameters:</h4>

8315

8316

8317

8318

8319

8320

8321

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

8322

8323

8324

8325

8326

8327

8328

</div>

8329

8330

8331

</li>

8332

8333

8334

8335

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

8336

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

8337

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

8338

8339

8340

8341

8342

8343

<p>the prefix</p>

8344

</div>

8345

8346

8347

</li>

8348

8349

</ul>

8350

</div>

8351

8352

8353

8354

8355

<h4>Returns:</h4>

8356

8357

8358

8359

8360

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

8361

8362

an array containing:

8363

* the detach category, if supplied,

8364

* the prefixed event type,

8365

* whether or not this is an after listener,

8366

* the supplied event type

8367

8368

</div>

8369

</div>

8370

8371

8372

8373

</div>

8374

8375

8376

8377

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

8378

8379

8380

8381

8382

8383

8384

8385

8386

8387

</li>

8388

8389

8390

8391

8392

8393

</li>

8394

8395

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

8396

</div>

8397

8398

8399

8400

8401

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

8402

</span>

8403

8404

8405

8406

8407

8408

8409

8410

8411

8412

8413

8414

8415

8416

8417

8418

<p>Inherited from

8419

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

8420

8421

8422

8423

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

8424

8425

</p>

8426

8427

8428

8429

8430

8431

</div>

8432

8433

8434

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

8435

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

8436

case the custom event is returned.</p>

8437

</div>

8438

8439

8440

8441

<h4>Parameters:</h4>

8442

8443

8444

8445

8446

8447

8448

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

8449

8450

8451

8452

8453

8454

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

8455

</div>

8456

8457

8458

</li>

8459

8460

8461

8462

8463

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

8464

8465

8466

8467

8468

8469

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

8470

8471

<p><ul>

8472

<li>

8473

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

8474

</li>

8475

<li>

8476

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

8477

Events can only bubble if emitFacade is true.

8478

</li>

8479

<li>

8480

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

8481

</li>

8482

<li>

8483

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

8484

</li>

8485

<li>

8486

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

8487

</li>

8488

<li>

8489

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

8490

</li>

8491

<li>

8492

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

8493

the fire will be notified immediately.

8494

</li>

8495

<li>

8496

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

8497

fired unless async is true.

8498

</li>

8499

<li>

8500

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

8501

</li>

8502

<li>

8503

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

8504

</li>

8505

<li>

8506

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

8507

</li>

8508

<li>

8509

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

8510

</li>

8511

<li>

8512

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

8513

</li></p>

8514

8515

<p><li>

8516

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

8517

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

8518

</li>

8519

<li>

8520

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

8521

</li>

8522

</ul></p>

8523

</div>

8524

8525

8526

</li>

8527

8528

</ul>

8529

</div>

8530

8531

8532

8533

8534

<h4>Returns:</h4>

8535

8536

8537

8538

8539

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

8540

8541

the custom event

8542

8543

</div>

8544

</div>

8545

8546

8547

8548

</div>

8549

8550

8551

8552

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

8553

8554

8555

8556

8557

8558

8559

8560

8561

8562

</li>

8563

8564

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

8565

</div>

8566

8567

8568

8569

8570

8571

8572

8573

8574

8575

8576

8577

8578

8579

8580

8581

8582

8583

<p>Inherited from

8584

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

8585

8586

8587

8588

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

8589

8590

</p>

8591

8592

8593

8594

8595

8596

</div>

8597

8598

8599

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

8600

</div>

8601

8602

8603

8604

<h4>Parameters:</h4>

8605

8606

8607

8608

8609

8610

8611

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

8612

8613

8614

8615

8616

8617

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

8618

</div>

8619

8620

8621

</li>

8622

8623

</ul>

8624

</div>

8625

8626

8627

8628

8629

8630

</div>

8631

8632

8633

8634

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

8635

8636

8637

8638

8639

8640

8641

8642

8643

8644

</li>

8645

8646

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

8647

</div>

8648

8649

8650

8651

8652

8653

8654

8655

8656

8657

8658

8659

8660

8661

8662

8663

8664

8665

<p>Inherited from

8666

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

8667

8668

8669

8670

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

8671

8672

</p>

8673

8674

8675

8676

8677

8678

</div>

8679

8680

8681

<p>Removes a bubble target</p>

8682

</div>

8683

8684

8685

8686

<h4>Parameters:</h4>

8687

8688

8689

8690

8691

8692

8693

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

8694

8695

8696

8697

8698

8699

<p>the target to remove</p>

8700

</div>

8701

8702

8703

</li>

8704

8705

</ul>

8706

</div>

8707

8708

8709

8710

8711

8712

</div>

8713

8714

8715

8716

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

8717

8718

8719

8720

8721

8722

8723

8724

8725

8726

</li>

8727

8728

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

8729

</div>

8730

8731

8732

8733

8734

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

8735

</span>

8736

8737

8738

8739

8740

8741

8742

8743

8744

8745

8746

8747

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

8748

8749

8750

8751

8752

8753

<p>Inherited from

8754

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

8755

8756

8757

8758

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

8759

8760

</p>

8761

8762

8763

8764

8765

8766

</div>

8767

8768

8769

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

8770

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

8771

</div>

8772

8773

8774

8775

<h4>Parameters:</h4>

8776

8777

8778

8779

8780

8781

8782

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

8783

8784

8785

8786

8787

8788

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

8789

</div>

8790

8791

8792

</li>

8793

8794

</ul>

8795

</div>

8796

8797

8798

8799

8800

<h4>Returns:</h4>

8801

8802

8803

8804

8805

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

8806

8807

A reference to the host object.

8808

8809

</div>

8810

</div>

8811

8812

8813

8814

</div>

8815

8816

8817

8818

8819

8820

8821

8822

8823

8824

8825

8826

8827

8828

</li>

8829

8830

8831

8832

<code>value</code>

8833

8834

</li>

8835

8836

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

8837

</div>

8838

8839

8840

8841

8842

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

8843

</span>

8844

8845

8846

8847

8848

8849

8850

8851

8852

8853

8854

8855

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

8856

8857

8858

8859

8860

<p>Inherited from

8861

8862

AttributeEvents

8863

</a>

8864

8865

but overwritten in

8866

8867

8868

8869

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

8870

8871

</p>

8872

8873

8874

8875

8876

8877

</div>

8878

8879

8880

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

8881

</div>

8882

8883

8884

8885

<h4>Parameters:</h4>

8886

8887

8888

8889

8890

8891

8892

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

8893

8894

8895

8896

8897

8898

<p>The name of the attribute. If the

8899

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

8900

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

8901

</div>

8902

8903

8904

</li>

8905

8906

8907

8908

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

8909

8910

8911

8912

8913

8914

8915

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

8916

</div>

8917

8918

8919

</li>

8920

8921

</ul>

8922

</div>

8923

8924

8925

8926

8927

<h4>Returns:</h4>

8928

8929

8930

8931

8932

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

8933

8934

A reference to the host object.

8935

8936

</div>

8937

</div>

8938

8939

8940

8941

</div>

8942

8943

8944

8945

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

8946

8947

8948

8949

8950

8951

8952

8953

<code>attrs</code>

8954

8955

</li>

8956

8957

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

8958

</div>

8959

8960

8961

8962

8963

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

8964

</span>

8965

8966

8967

8968

8969

8970

8971

8972

8973

8974

8975

8976

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

8977

8978

8979

8980

8981

<p>Inherited from

8982

8983

AttributeEvents

8984

</a>

8985

8986

but overwritten in

8987

8988

8989

8990

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

8991

8992

</p>

8993

8994

8995

8996

8997

8998

</div>

8999

9000

9001

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

9002

</div>

9003

9004

9005

9006

<h4>Parameters:</h4>

9007

9008

9009

9010

9011

9012

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

9013

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

9014

9015

9016

9017

9018

9019

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

9020

</div>

9021

9022

9023

</li>

9024

9025

</ul>

9026

</div>

9027

9028

9029

9030

9031

<h4>Returns:</h4>

9032

9033

9034

9035

9036

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

9037

9038

A reference to the host object.

9039

9040

</div>

9041

</div>

9042

9043

9044

9045

</div>

9046

9047

9048

9049

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

9050

9051

9052

9053

9054

9055

9056

9057

9058

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

9059

9060

9061

9062

9063

9064

9065

9066

9067

9068

9069

9070

9071

9072

<p>Inherited from

9073

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

9074

9075

9076

9077

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

9078

9079

</p>

9080

9081

9082

9083

<p>Deprecated: use on</p>

9084

9085

9086

9087

</div>

9088

9089

9090

<p>subscribe to an event</p>

9091

</div>

9092

9093

9094

9095

9096

9097

9098

</div>

9099

9100

9101

9102

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

9103

9104

9105

9106

9107

9108

9109

9110

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

9111

</span>

9112

9113

9114

9115

9116

9117

9118

9119

9120

9121

9122

9123

9124

9125

9126

9127

<p>Inherited from

9128

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

9129

9130

9131

9132

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

9133

9134

</p>

9135

9136

9137

9138

9139

9140

</div>

9141

9142

9143

<p>Default toString implementation. Provides the constructor NAME

9144

and the instance guid, if set.</p>

9145

</div>

9146

9147

9148

9149

9150

9151

<h4>Returns:</h4>

9152

9153

9154

9155

9156

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

9157

9158

String representation for this object

9159

9160

</div>

9161

</div>

9162

9163

9164

9165

</div>

9166

9167

9168

9169

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

9170

9171

9172

9173

9174

9175

9176

9177

9178

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

9179

9180

9181

9182

9183

9184

9185

9186

9187

9188

9189

9190

9191

9192

<p>Inherited from

9193

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

9194

9195

9196

9197

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

9198

9199

</p>

9200

9201

9202

9203

<p>Deprecated: use detach</p>

9204

9205

9206

9207

</div>

9208

9209

9210

<p>detach a listener</p>

9211

</div>

9212

9213

9214

9215

9216

9217

9218

</div>

9219

9220

9221

9222

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

9223

9224

9225

9226

9227

9228

9229

9230

9231

9232

</li>

9233

9234

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

9235

</div>

9236

9237

9238

9239

9240

9241

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

9242

9243

9244

9245

9246

9247

9248

9249

9250

9251

9252

9253

9254

9255

<p>Inherited from

9256

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

9257

9258

9259

9260

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

9261

9262

</p>

9263

9264

9265

9266

<p>Deprecated: use detachAll</p>

9267

9268

9269

9270

</div>

9271

9272

9273

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

9274

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

9275

be removed.</p>

9276

</div>

9277

9278

9279

9280

<h4>Parameters:</h4>

9281

9282

9283

9284

9285

9286

9287

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

9288

9289

9290

9291

9292

9293

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

9294

</div>

9295

9296

9297

</li>

9298

9299

</ul>

9300

</div>

9301

9302

9303

9304

9305

9306

</div>

9307

9308

9309

</div>

9310

9311

9312

9313

9314

<h2 class="off-left">Properties</h2>

9315

9316

9317

9318

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

9319

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

9320

9321

9322

9323

9324

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

9325

9326

9327

9328

9329

9330

9331

9332

9333

9334

<p>Inherited from

9335

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

9336

9337

9338

9339

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

9340

9341

</p>

9342

9343

9344

9345

9346

</div>

9347

9348

9349

<p>This property controls whether or not instances of this class should

9350

allow users to add ad-hoc attributes through the constructor configuration

9351

hash.</p>

9352

9353

<p>AdHoc attributes are attributes which are not defined by the class, and are

9354

not handled by the MyClass.<em>NON</em>ATTRS_CFG</p>

9355

</div>

9356

9357

9358

<p><strong>Default:</strong> undefined (false)</p>

9359

9360

9361

9362

9363

9364

</div>

9365

9366

9367

9368

9369

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

9370

9371

9372

<span class="flag deprecated" title="Use this.constructor.NAME">deprecated</span>

9373

9374

9375

9376

9377

9378

9379

9380

9381

9382

9383

9384

<p>Inherited from

9385

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

9386

9387

9388

9389

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

9390

9391

</p>

9392

9393

9394

<p>Deprecated: Use this.constructor.NAME</p>

9395

9396

9397

9398

</div>

9399

9400

9401

<p>The string used to identify the class of this object.</p>

9402

</div>

9403

9404

9405

9406

9407

9408

9409

</div>

9410

9411

9412

</div>

9413

9414

9415

9416

9417

<h2 class="off-left">Attributes</h2>

9418

9419

9420

9421

9422

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

9423

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

9424

9425

9426

9427

9428

9429

9430

9431

9432

9433

9434

9435

9436

<p>Inherited from

9437

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

9438

9439

9440

9441

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

9442

9443

</p>

9444

9445

9446

9447

9448

</div>

9449

9450

9451

<p>Flag indicating whether or not this object

9452

has been through the destroy lifecycle phase.</p>

9453

</div>

9454

9455

9456

<p><strong>Default:</strong> false</p>

9457

9458

9459

9460

9461

<h4>Fires event <code>destroyedChange</code></h4>

9462

9463

<p>

9464

Fires when the value for the configuration attribute <code>destroyed</code> is

9465

changed. You can listen for the event using the <code>on</code> method if you

9466

wish to be notified before the attribute's value has changed, or

9467

using the <code>after</code> method if you wish to be notified after the

9468

attribute's value has changed.

9469

</p>

9470

9471

9472

<h4>Parameters:</h4>

9473

9474

9475

9476

9477

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

9478

9479

9480

An Event Facade object with the following

9481

attribute-specific properties added:

9482

</div>

9483

9484

9485

9486

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

9487

9488

<div class="param-description">The value of the attribute, prior to it being set.</div>

9489

</li>

9490

9491

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

9492

9493

<div class="param-description">The value the attribute is to be set to.</div>

9494

</li>

9495

9496

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

9497

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

9498

<div class="param-description">The name of the attribute being set.</div>

9499

</li>

9500

9501

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

9502

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

9503

<div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div>

9504

</li>

9505

</ul>

9506

</li>

9507

</ul>

9508

</div>

9509

</div>

9510

9511

9512

9513

</div>

9514

9515

9516

9517

9518

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

9519

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

9520

9521

9522

9523

9524

9525

9526

9527

9528

9529

9530

9531

9532

<p>Inherited from

9533

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

9534

9535

9536

9537

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

9538

9539

</p>

9540

9541

9542

9543

9544

</div>

9545

9546

9547

<p>Flag indicating whether or not this object

9548

has been through the init lifecycle phase.</p>

9549

</div>

9550

9551

9552

<p><strong>Default:</strong> false</p>

9553

9554

9555

9556

9557

<h4>Fires event <code>initializedChange</code></h4>

9558

9559

<p>

9560

Fires when the value for the configuration attribute <code>initialized</code> is

9561

changed. You can listen for the event using the <code>on</code> method if you

9562

wish to be notified before the attribute's value has changed, or

9563

using the <code>after</code> method if you wish to be notified after the

9564

attribute's value has changed.

9565

</p>

9566

9567

9568

<h4>Parameters:</h4>

9569

9570

9571

9572

9573

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

9574

9575

9576

An Event Facade object with the following

9577

attribute-specific properties added:

9578

</div>

9579

9580

9581

9582

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

9583

9584

<div class="param-description">The value of the attribute, prior to it being set.</div>

9585

</li>

9586

9587

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

9588

9589

<div class="param-description">The value the attribute is to be set to.</div>

9590

</li>

9591

9592

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

9593

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

9594

<div class="param-description">The name of the attribute being set.</div>

9595

</li>

9596

9597

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

9598

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

9599

<div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div>

9600

</li>

9601

</ul>

9602

</li>

9603

</ul>

9604

</div>

9605

</div>

9606

9607

9608

9609

</div>

9610

9611

9612

</div>

9613

9614

9615

9616

9617

<h2 class="off-left">Events</h2>

9618

9619

9620

9621

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

9622

9623

9624

9625

9626

9627

9628

9629

9630

9631

9632

9633

9634

9635

<p>Inherited from

9636

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

9637

9638

9639

9640

9641

9642

</p>

9643

9644

9645

9646

9647

</div>

9648

9649

9650

<p>

9651

Lifecycle event for the destroy phase,

9652

fired prior to destruction. Invoking the preventDefault

9653

method on the event object provided to subscribers will

9654

prevent destruction from proceeding.

9655

</p>

9656

9657

<p>

9658

Subscribers to the "after" moment of this event, will be notified

9659

after destruction is complete (and as a result cannot prevent

9660

destruction).

9661

</p>

9662

</div>

9663

9664

9665

9666

<h4>Event Payload:</h4>

9667

9668

9669

9670

9671

9672

9673

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

9674

9675

9676

9677

9678

9679

<p>Event object</p>

9680

</div>

9681

9682

9683

</li>

9684

9685

</ul>

9686

</div>

9687

9688

9689

9690

9691

</div>

9692

9693

9694

9695

9696

9697

9698

9699

9700

9701

9702

9703

9704

9705

9706

9707

9708

9709

<p>Inherited from

9710

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

9711

9712

9713

9714

9715

9716

</p>

9717

9718

9719

9720

9721

</div>

9722

9723

9724

<p>

9725

Lifecycle event for the init phase, fired prior to initialization.

9726

Invoking the preventDefault() method on the event object provided

9727

to subscribers will prevent initialization from occuring.

9728

</p>

9729

9730

<p>

9731

Subscribers to the "after" momemt of this event, will be notified

9732

after initialization of the object is complete (and therefore

9733

cannot prevent initialization).

9734

</p>

9735

</div>

9736

9737

9738

9739

<h4>Event Payload:</h4>

9740

9741

9742

9743

9744

9745

9746

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

9747

9748

9749

9750

9751

9752

<p>Event object, with a cfg property which

9753

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

9754

</div>

9755

9756

9757

</li>

9758

9759

</ul>

9760

</div>

9761

9762

9763

9764

9765

</div>

9766

9767

9768

</div>

9769

9770

</div>

9771

</div>

9772

9773

</div>

9774

</div>

9775

</div>

9776

</div>

9777

</div>

9778

</div>

9779

9780

9781

9782

9783

9784

9785

9786

9787

</body>

9788

</html>

Older »