~bcsaller/juju-gui/update-reductions

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

2171

2172

2173

2174

2175

2176

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

2177

</div>

2178

2179

2180

</li>

2181

2182

2183

2184

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

2185

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

2186

2187

2188

2189

2190

2191

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

2192

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

2193

</div>

2194

2195

2196

</li>

2197

2198

2199

2200

2201

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

2202

2203

2204

2205

2206

2207

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

2208

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

2209

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

2210

</div>

2211

2212

2213

</li>

2214

2215

</ul>

2216

</div>

2217

2218

2219

2220

2221

2222

</div>

2223

2224

2225

2226

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

2227

2228

2229

2230

2231

2232

2233

2234

2235

2236

</li>

2237

2238

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

2239

</div>

2240

2241

2242

2243

2244

2245

2246

2247

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

2248

2249

2250

2251

2252

2253

2254

2255

2256

2257

2258

2259

<p>Inherited from

2260

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

2261

2262

2263

2264

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

2265

2266

</p>

2267

2268

2269

2270

2271

2272

</div>

2273

2274

2275

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

2276

</div>

2277

2278

2279

2280

<h4>Parameters:</h4>

2281

2282

2283

2284

2285

2286

2287

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

2288

2289

2290

2291

2292

2293

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

2294

</div>

2295

2296

2297

</li>

2298

2299

</ul>

2300

</div>

2301

2302

2303

2304

2305

2306

</div>

2307

2308

2309

2310

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

2311

2312

2313

2314

2315

2316

2317

2318

<code>allAttrs</code>

2319

2320

</li>

2321

2322

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

2323

</div>

2324

2325

2326

2327

2328

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

2329

</span>

2330

2331

2332

2333

2334

2335

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

2336

2337

2338

2339

2340

2341

2342

2343

2344

2345

2346

2347

<p>Inherited from

2348

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

2349

2350

2351

2352

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

2353

2354

</p>

2355

2356

2357

2358

2359

2360

</div>

2361

2362

2363

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

2364

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

2365

2366

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

2367

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

2368

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

2369

</div>

2370

2371

2372

2373

<h4>Parameters:</h4>

2374

2375

2376

2377

2378

2379

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

2380

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

2381

2382

2383

2384

2385

2386

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

2387

(subclass first, Base last)</p>

2388

</div>

2389

2390

2391

</li>

2392

2393

</ul>

2394

</div>

2395

2396

2397

2398

2399

<h4>Returns:</h4>

2400

2401

2402

2403

2404

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

2405

2406

The aggregate set of ATTRS definitions for the instance

2407

2408

</div>

2409

</div>

2410

2411

2412

2413

</div>

2414

2415

2416

2417

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

2418

2419

2420

2421

2422

2423

2424

2425

2426

2427

2428

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

2429

2430

2431

2432

2433

2434

2435

2436

2437

2438

2439

<p>Inherited from

2440

2441

BaseCore

2442

</a>

2443

2444

but overwritten in

2445

2446

2447

2448

2449

2450

</p>

2451

2452

2453

2454

2455

2456

</div>

2457

2458

2459

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

2460

this class.</p>

2461

</div>

2462

2463

2464

2465

2466

2467

2468

</div>

2469

2470

2471

2472

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

2473

2474

2475

2476

2477

2478

2479

2480

2481

2482

2483

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

2484

2485

2486

2487

2488

2489

2490

2491

2492

2493

2494

2495

<p>Inherited from

2496

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

2497

2498

2499

2500

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

2501

2502

</p>

2503

2504

2505

2506

2507

2508

</div>

2509

2510

2511

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

2512

</div>

2513

2514

2515

2516

2517

2518

2519

</div>

2520

2521

2522

2523

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

2524

2525

2526

2527

2528

2529

2530

2531

2532

2533

2534

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

2535

2536

2537

2538

2539

2540

2541

2542

2543

2544

2545

2546

<p>Inherited from

2547

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

2548

2549

2550

2551

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

2552

2553

</p>

2554

2555

2556

2557

2558

2559

</div>

2560

2561

2562

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

2563

</div>

2564

2565

2566

2567

2568

2569

2570

</div>

2571

2572

2573

2574

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

2575

2576

2577

2578

2579

2580

2581

2582

2583

2584

</li>

2585

2586

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

2587

</div>

2588

2589

2590

2591

2592

2593

2594

2595

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

2596

2597

2598

2599

2600

2601

2602

2603

2604

2605

2606

2607

<p>Inherited from

2608

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

2609

2610

2611

2612

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

2613

2614

</p>

2615

2616

2617

2618

2619

2620

</div>

2621

2622

2623

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

2624

</div>

2625

2626

2627

2628

<h4>Parameters:</h4>

2629

2630

2631

2632

2633

2634

2635

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

2636

2637

2638

2639

2640

2641

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

2642

</div>

2643

2644

2645

</li>

2646

2647

</ul>

2648

</div>

2649

2650

2651

2652

2653

2654

</div>

2655

2656

2657

2658

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

2659

2660

2661

2662

2663

2664

2665

2666

2667

2668

</li>

2669

2670

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

2671

</div>

2672

2673

2674

2675

2676

2677

2678

2679

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

2680

2681

2682

2683

2684

2685

2686

2687

2688

2689

2690

2691

<p>Inherited from

2692

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

2693

2694

2695

2696

2697

2698

</p>

2699

2700

2701

2702

2703

2704

</div>

2705

2706

2707

<p>Default destroy event handler</p>

2708

</div>

2709

2710

2711

2712

<h4>Parameters:</h4>

2713

2714

2715

2716

2717

2718

2719

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

2720

2721

2722

2723

2724

2725

<p>Event object</p>

2726

</div>

2727

2728

2729

</li>

2730

2731

</ul>

2732

</div>

2733

2734

2735

2736

2737

2738

</div>

2739

2740

2741

2742

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

2743

2744

2745

2746

2747

2748

2749

2750

2751

2752

</li>

2753

2754

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

2755

</div>

2756

2757

2758

2759

2760

2761

2762

2763

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

2764

2765

2766

2767

2768

2769

2770

2771

2772

2773

2774

2775

<p>Inherited from

2776

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

2777

2778

2779

2780

2781

2782

</p>

2783

2784

2785

2786

2787

2788

</div>

2789

2790

2791

<p>Default init event handler</p>

2792

</div>

2793

2794

2795

2796

<h4>Parameters:</h4>

2797

2798

2799

2800

2801

2802

2803

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

2804

2805

2806

2807

2808

2809

<p>Event object, with a cfg property which

2810

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

2811

</div>

2812

2813

2814

</li>

2815

2816

</ul>

2817

</div>

2818

2819

2820

2821

2822

2823

</div>

2824

2825

2826

2827

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

2828

2829

2830

2831

2832

2833

2834

2835

2836

2837

2838

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

2839

2840

2841

2842

2843

2844

2845

2846

2847

2848

2849

2850

<p>Inherited from

2851

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

2852

2853

2854

2855

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

2856

2857

</p>

2858

2859

2860

2861

2862

2863

</div>

2864

2865

2866

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

2867

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

2868

</div>

2869

2870

2871

2872

2873

2874

2875

</div>

2876

2877

2878

2879

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

2880

2881

2882

2883

2884

2885

2886

2887

<code>allAttrs</code>

2888

2889

</li>

2890

2891

2892

2893

<code>userVals</code>

2894

2895

</li>

2896

2897

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

2898

</div>

2899

2900

2901

2902

2903

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

2904

</span>

2905

2906

2907

2908

2909

2910

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

2911

2912

2913

2914

2915

2916

2917

2918

2919

2920

2921

2922

<p>Inherited from

2923

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

2924

2925

2926

2927

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

2928

2929

</p>

2930

2931

2932

2933

2934

2935

</div>

2936

2937

2938

2939

</div>

2940

2941

2942

2943

<h4>Parameters:</h4>

2944

2945

2946

2947

2948

2949

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

2950

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

2951

2952

2953

2954

2955

2956

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

2957

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

2958

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

2959

</div>

2960

2961

2962

</li>

2963

2964

2965

2966

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

2967

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

2968

2969

2970

2971

2972

2973

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

2974

</div>

2975

2976

2977

</li>

2978

2979

</ul>

2980

</div>

2981

2982

2983

2984

2985

<h4>Returns:</h4>

2986

2987

2988

2989

2990

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

2991

2992

The set of adhoc attributes passed in, in the form

2993

of an object with attribute name/configuration pairs.

2994

2995

</div>

2996

</div>

2997

2998

2999

3000

</div>

3001

3002

3003

3004

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

3005

3006

3007

3008

3009

3010

3011

3012

<code>clazz</code>

3013

3014

</li>

3015

3016

3017

3018

<code>allCfgs</code>

3019

3020

</li>

3021

3022

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

3023

</div>

3024

3025

3026

3027

3028

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

3029

</span>

3030

3031

3032

3033

3034

3035

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

3036

3037

3038

3039

3040

3041

3042

3043

3044

3045

3046

3047

<p>Inherited from

3048

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

3049

3050

3051

3052

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

3053

3054

</p>

3055

3056

3057

3058

3059

3060

</div>

3061

3062

3063

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

3064

initialization. Returns a disposable object with the attributes defined for

3065

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

3066

</div>

3067

3068

3069

3070

<h4>Parameters:</h4>

3071

3072

3073

3074

3075

3076

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

3077

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

3078

3079

3080

3081

3082

3083

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

3084

</div>

3085

3086

3087

</li>

3088

3089

3090

3091

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

3092

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

3093

3094

3095

3096

3097

3098

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

3099

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

3100

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

3101

</div>

3102

3103

3104

</li>

3105

3106

</ul>

3107

</div>

3108

3109

3110

3111

3112

<h4>Returns:</h4>

3113

3114

3115

3116

3117

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

3118

3119

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

3120

of an object with attribute name/configuration pairs.

3121

3122

</div>

3123

</div>

3124

3125

3126

3127

</div>

3128

3129

3130

3131

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

3132

3133

3134

3135

3136

3137

3138

3139

<code>attrName</code>

3140

3141

</li>

3142

3143

3144

3145

<code>subAttrName</code>

3146

3147

</li>

3148

3149

3150

3151

<code>currVal</code>

3152

3153

</li>

3154

3155

3156

3157

<code>newVal</code>

3158

3159

</li>

3160

3161

3162

3163

3164

3165

</li>

3166

3167

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

3168

</div>

3169

3170

3171

3172

3173

3174

3175

3176

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

3177

3178

3179

3180

3181

3182

3183

3184

3185

3186

3187

3188

<p>Inherited from

3189

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

3190

3191

3192

3193

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

3194

3195

</p>

3196

3197

3198

3199

3200

3201

</div>

3202

3203

3204

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

3205

</div>

3206

3207

3208

3209

<h4>Parameters:</h4>

3210

3211

3212

3213

3214

3215

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

3216

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

3217

3218

3219

3220

3221

3222

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

3223

</div>

3224

3225

3226

</li>

3227

3228

3229

3230

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

3231

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

3232

3233

3234

3235

3236

3237

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

3238

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

3239

</div>

3240

3241

3242

</li>

3243

3244

3245

3246

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

3247

3248

3249

3250

3251

3252

3253

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

3254

</div>

3255

3256

3257

</li>

3258

3259

3260

3261

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

3262

3263

3264

3265

3266

3267

3268

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

3269

</div>

3270

3271

3272

</li>

3273

3274

3275

3276

3277

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

3278

3279

3280

3281

3282

3283

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

3284

</div>

3285

3286

3287

</li>

3288

3289

</ul>

3290

</div>

3291

3292

3293

3294

3295

3296

</div>

3297

3298

3299

3300

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

3301

3302

3303

3304

3305

3306

3307

3308

3309

3310

</li>

3311

3312

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

3313

</div>

3314

3315

3316

3317

3318

3319

</span>

3320

3321

3322

3323

3324

3325

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

3326

3327

3328

3329

3330

3331

3332

3333

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

3334

3335

3336

3337

3338

3339

<p>Inherited from

3340

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

3341

3342

3343

3344

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

3345

3346

</p>

3347

3348

3349

3350

3351

3352

</div>

3353

3354

3355

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

3356

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

3357

3358

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

3359

</div>

3360

3361

3362

3363

<h4>Parameters:</h4>

3364

3365

3366

3367

3368

3369

3370

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

3371

3372

3373

3374

3375

3376

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

3377

</div>

3378

3379

3380

</li>

3381

3382

</ul>

3383

</div>

3384

3385

3386

3387

3388

<h4>Returns:</h4>

3389

3390

3391

3392

3393

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

3394

3395

The value of the attribute.

3396

3397

</div>

3398

</div>

3399

3400

3401

3402

</div>

3403

3404

3405

3406

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

3407

3408

3409

3410

3411

3412

3413

3414

3415

3416

</li>

3417

3418

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

3419

</div>

3420

3421

3422

3423

3424

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

3425

</span>

3426

3427

3428

3429

3430

3431

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

3432

3433

3434

3435

3436

3437

3438

3439

3440

3441

3442

3443

<p>Inherited from

3444

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

3445

3446

3447

3448

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

3449

3450

</p>

3451

3452

3453

3454

3455

3456

</div>

3457

3458

3459

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

3460

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

3461

configuration properties for all attributes.</p>

3462

</div>

3463

3464

3465

3466

<h4>Parameters:</h4>

3467

3468

3469

3470

3471

3472

3473

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

3474

3475

3476

3477

3478

3479

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

3480

</div>

3481

3482

3483

</li>

3484

3485

</ul>

3486

</div>

3487

3488

3489

3490

3491

<h4>Returns:</h4>

3492

3493

3494

3495

3496

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

3497

3498

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

3499

3500

</div>

3501

</div>

3502

3503

3504

3505

</div>

3506

3507

3508

3509

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

3510

3511

3512

3513

3514

3515

3516

3517

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

3518

</span>

3519

3520

3521

3522

3523

3524

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

3525

3526

3527

3528

3529

3530

3531

3532

3533

3534

3535

3536

<p>Inherited from

3537

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

3538

3539

3540

3541

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

3542

3543

</p>

3544

3545

3546

3547

3548

3549

</div>

3550

3551

3552

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

3553

the class hierarchy.</p>

3554

</div>

3555

3556

3557

3558

3559

3560

<h4>Returns:</h4>

3561

3562

3563

3564

3565

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

3566

3567

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

3568

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

3569

the cached value.

3570

3571

</div>

3572

</div>

3573

3574

3575

3576

</div>

3577

3578

3579

3580

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

3581

3582

3583

3584

3585

3586

3587

3588

3589

3590

</li>

3591

3592

3593

3594

3595

3596

</li>

3597

3598

3599

3600

<code>initValues</code>

3601

3602

</li>

3603

3604

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

3605

</div>

3606

3607

3608

3609

3610

3611

</span>

3612

3613

3614

3615

3616

3617

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

3618

3619

3620

3621

3622

3623

3624

3625

3626

3627

3628

<p>Inherited from

3629

3630

Attribute

3631

</a>

3632

3633

but overwritten in

3634

3635

3636

3637

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

3638

3639

</p>

3640

3641

3642

3643

3644

3645

</div>

3646

3647

3648

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

3649

either the default configuration provided, or the

3650

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

3651

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

3652

</div>

3653

3654

3655

3656

<h4>Parameters:</h4>

3657

3658

3659

3660

3661

3662

3663

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

3664

3665

3666

3667

3668

3669

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

3670

</div>

3671

3672

3673

</li>

3674

3675

3676

3677

3678

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

3679

3680

3681

3682

3683

3684

<p>The attribute configuration object</p>

3685

</div>

3686

3687

3688

</li>

3689

3690

3691

3692

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

3693

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

3694

3695

3696

3697

3698

3699

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

3700

</div>

3701

3702

3703

</li>

3704

3705

</ul>

3706

</div>

3707

3708

3709

3710

3711

<h4>Returns:</h4>

3712

3713

3714

3715

3716

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

3717

3718

The initial value of the attribute.

3719

3720

</div>

3721

</div>

3722

3723

3724

3725

</div>

3726

3727

3728

3729

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

3730

3731

3732

3733

3734

3735

3736

3737

<code>attrs</code>

3738

3739

</li>

3740

3741

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

3742

</div>

3743

3744

3745

3746

3747

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

3748

</span>

3749

3750

3751

3752

3753

3754

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

3755

3756

3757

3758

3759

3760

3761

3762

3763

3764

3765

3766

<p>Inherited from

3767

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

3768

3769

3770

3771

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

3772

3773

</p>

3774

3775

3776

3777

3778

3779

</div>

3780

3781

3782

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

3783

</div>

3784

3785

3786

3787

<h4>Parameters:</h4>

3788

3789

3790

3791

3792

3793

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

3794

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

3795

3796

3797

3798

3799

3800

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

3801

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

3802

</div>

3803

3804

3805

</li>

3806

3807

</ul>

3808

</div>

3809

3810

3811

3812

3813

<h4>Returns:</h4>

3814

3815

3816

3817

3818

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

3819

3820

An object with attribute name/value pairs.

3821

3822

</div>

3823

</div>

3824

3825

3826

3827

</div>

3828

3829

3830

3831

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

3832

3833

3834

3835

3836

3837

3838

3839

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

3840

</span>

3841

3842

3843

3844

3845

3846

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

3847

3848

3849

3850

3851

3852

3853

3854

3855

3856

3857

3858

<p>Inherited from

3859

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

3860

3861

3862

3863

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

3864

3865

</p>

3866

3867

3868

3869

3870

3871

</div>

3872

3873

3874

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

3875

</div>

3876

3877

3878

3879

3880

3881

<h4>Returns:</h4>

3882

3883

3884

3885

3886

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

3887

3888

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

3889

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

3890

cached value.

3891

3892

</div>

3893

</div>

3894

3895

3896

3897

</div>

3898

3899

3900

3901

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

3902

3903

3904

3905

3906

3907

3908

3909

3910

3911

</li>

3912

3913

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

3914

</div>

3915

3916

3917

3918

3919

3920

</span>

3921

3922

3923

3924

3925

3926

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

3927

3928

3929

3930

3931

3932

3933

3934

3935

3936

3937

3938

<p>Inherited from

3939

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

3940

3941

3942

3943

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

3944

3945

</p>

3946

3947

3948

3949

3950

3951

</div>

3952

3953

3954

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

3955

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

3956

</div>

3957

3958

3959

3960

<h4>Parameters:</h4>

3961

3962

3963

3964

3965

3966

3967

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

3968

3969

3970

3971

3972

3973

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

3974

</div>

3975

3976

3977

</li>

3978

3979

</ul>

3980

</div>

3981

3982

3983

3984

3985

<h4>Returns:</h4>

3986

3987

3988

3989

3990

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

3991

3992

The stored value of the attribute

3993

3994

</div>

3995

</div>

3996

3997

3998

3999

</div>

4000

4001

4002

4003

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

4004

4005

4006

4007

4008

4009

4010

4011

4012

4013

4014

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

4015

4016

4017

4018

4019

4020

4021

4022

4023

4024

4025

4026

<p>Inherited from

4027

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

4028

4029

4030

4031

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

4032

4033

</p>

4034

4035

4036

4037

4038

4039

</div>

4040

4041

4042

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

4043

event type is not prefixed, the instance prefix is

4044

applied to the supplied type.</p>

4045

</div>

4046

4047

4048

4049

4050

4051

4052

</div>

4053

4054

4055

4056

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

4057

4058

4059

4060

4061

4062

4063

4064

<code>attrs</code>

4065

4066

</li>

4067

4068

4069

4070

<code>values</code>

4071

4072

</li>

4073

4074

4075

4076

4077

4078

</li>

4079

4080

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

4081

</div>

4082

4083

4084

4085

4086

4087

4088

4089

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

4090

4091

4092

4093

4094

4095

4096

4097

4098

4099

4100

4101

<p>Inherited from

4102

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

4103

4104

4105

4106

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

4107

4108

</p>

4109

4110

4111

4112

4113

4114

</div>

4115

4116

4117

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

4118

constructor.</p>

4119

</div>

4120

4121

4122

4123

<h4>Parameters:</h4>

4124

4125

4126

4127

4128

4129

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

4130

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

4131

4132

4133

4134

4135

4136

<p>The attributes to add during construction (passed through to <a href="#method_addAttrs">addAttrs</a>). These can also be defined on the constructor being augmented with Attribute by defining the ATTRS property on the constructor.</p>

4137

</div>

4138

4139

4140

</li>

4141

4142

4143

4144

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

4145

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

4146

4147

4148

4149

4150

4151

<p>The initial attribute values to apply (passed through to <a href="#method_addAttrs">addAttrs</a>). These are not merged/cloned. The caller is responsible for isolating user provided values if required.</p>

4152

</div>

4153

4154

4155

</li>

4156

4157

4158

4159

4160

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

4161

4162

4163

4164

4165

4166

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

4167

</div>

4168

4169

4170

</li>

4171

4172

</ul>

4173

</div>

4174

4175

4176

4177

4178

4179

</div>

4180

4181

4182

4183

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

4184

4185

4186

4187

4188

4189

4190

4191

4192

4193

4194

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

4195

4196

4197

4198

4199

4200

4201

4202

4203

4204

4205

<p>Inherited from

4206

4207

BaseCore

4208

</a>

4209

4210

but overwritten in

4211

4212

4213

4214

4215

4216

</p>

4217

4218

4219

4220

4221

4222

</div>

4223

4224

4225

<p>Initializes Attribute</p>

4226

</div>

4227

4228

4229

4230

4231

4232

4233

</div>

4234

4235

4236

4237

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

4238

4239

4240

4241

4242

4243

4244

4245

<code>attrs</code>

4246

4247

</li>

4248

4249

4250

4251

<code>values</code>

4252

4253

</li>

4254

4255

4256

4257

4258

4259

</li>

4260

4261

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

4262

</div>

4263

4264

4265

4266

4267

4268

4269

4270

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

4271

4272

4273

4274

4275

4276

4277

4278

4279

4280

4281

4282

<p>Inherited from

4283

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

4284

4285

4286

4287

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

4288

4289

</p>

4290

4291

4292

4293

4294

4295

</div>

4296

4297

4298

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

4299

</div>

4300

4301

4302

4303

<h4>Parameters:</h4>

4304

4305

4306

4307

4308

4309

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

4310

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

4311

4312

4313

4314

4315

4316

4317

</div>

4318

4319

4320

</li>

4321

4322

4323

4324

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

4325

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

4326

4327

4328

4329

4330

4331

4332

</div>

4333

4334

4335

</li>

4336

4337

4338

4339

4340

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

4341

4342

4343

4344

4345

4346

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

4347

</div>

4348

4349

4350

</li>

4351

4352

</ul>

4353

</div>

4354

4355

4356

4357

4358

4359

</div>

4360

4361

4362

4363

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

4364

4365

4366

4367

4368

4369

4370

4371

<code>config</code>

4372

4373

</li>

4374

4375

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

4376

</div>

4377

4378

4379

4380

4381

4382

4383

4384

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

4385

4386

4387

4388

4389

4390

4391

4392

4393

4394

4395

<p>Inherited from

4396

4397

BaseCore

4398

</a>

4399

4400

but overwritten in

4401

4402

4403

4404

4405

4406

</p>

4407

4408

4409

4410

4411

4412

</div>

4413

4414

4415

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

4416

</div>

4417

4418

4419

4420

<h4>Parameters:</h4>

4421

4422

4423

4424

4425

4426

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

4427

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

4428

4429

4430

4431

4432

4433

<p>The constructor configuration object</p>

4434

</div>

4435

4436

4437

</li>

4438

4439

</ul>

4440

</div>

4441

4442

4443

4444

4445

4446

</div>

4447

4448

4449

4450

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

4451

4452

4453

4454

4455

4456

4457

4458

<code>userVals</code>

4459

4460

</li>

4461

4462

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

4463

</div>

4464

4465

4466

4467

4468

4469

4470

4471

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

4472

4473

4474

4475

4476

4477

4478

4479

4480

4481

4482

4483

<p>Inherited from

4484

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

4485

4486

4487

4488

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

4489

4490

</p>

4491

4492

4493

4494

4495

4496

</div>

4497

4498

4499

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

4500

initializing attributes for each class defined in the class's

4501

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

4502

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

4503

</div>

4504

4505

4506

4507

<h4>Parameters:</h4>

4508

4509

4510

4511

4512

4513

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

4514

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

4515

4516

4517

4518

4519

4520

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

4521

</div>

4522

4523

4524

</li>

4525

4526

</ul>

4527

</div>

4528

4529

4530

4531

4532

4533

</div>

4534

4535

4536

4537

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

4538

4539

4540

4541

4542

4543

4544

4545

4546

4547

4548

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

4549

4550

4551

4552

4553

4554

4555

4556

4557

4558

4559

4560

<p>Inherited from

4561

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

4562

4563

4564

4565

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

4566

4567

</p>

4568

4569

4570

4571

4572

4573

</div>

4574

4575

4576

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

4577

the array of classes and aggregate set of attribute configurations

4578

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

4579

</div>

4580

4581

4582

4583

4584

4585

4586

</div>

4587

4588

4589

4590

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

4591

4592

4593

4594

4595

4596

4597

4598

4599

4600

</li>

4601

4602

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

4603

</div>

4604

4605

4606

4607

4608

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

4609

</span>

4610

4611

4612

4613

4614

4615

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

4616

4617

4618

4619

4620

4621

4622

4623

4624

4625

4626

4627

<p>Inherited from

4628

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

4629

4630

4631

4632

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

4633

4634

</p>

4635

4636

4637

4638

4639

4640

</div>

4641

4642

4643

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

4644

added lazily and still requires initialization.</p>

4645

</div>

4646

4647

4648

4649

<h4>Parameters:</h4>

4650

4651

4652

4653

4654

4655

4656

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

4657

4658

4659

4660

4661

4662

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

4663

</div>

4664

4665

4666

</li>

4667

4668

</ul>

4669

</div>

4670

4671

4672

4673

4674

<h4>Returns:</h4>

4675

4676

4677

4678

4679

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

4680

4681

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

4682

4683

</div>

4684

</div>

4685

4686

4687

4688

</div>

4689

4690

4691

4692

4693

4694

4695

4696

4697

4698

4699

4700

<code>Sortable</code>

4701

4702

</li>

4703

4704

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

4705

</div>

4706

4707

4708

4709

4710

4711

4712

4713

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

4714

4715

4716

4717

4718

4719

4720

4721

4722

4723

4724

4725

4726

<p>

4727

4728

Defined in

4729

4730

4731

4732

4733

<a href="../files/sortable_js_sortable.js.html#l269"><code>sortable/js/sortable.js:269</code></a>

4734

4735

</p>

4736

4737

4738

4739

4740

4741

</div>

4742

4743

4744

<p>Joins both of the Sortables together.</p>

4745

</div>

4746

4747

4748

4749

<h4>Parameters:</h4>

4750

4751

4752

4753

4754

4755

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

4756

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

4757

4758

4759

4760

4761

4762

<p>sel The Sortable list to join with</p>

4763

</div>

4764

4765

4766

</li>

4767

4768

</ul>

4769

</div>

4770

4771

4772

4773

4774

4775

</div>

4776

4777

4778

4779

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

4780

4781

4782

4783

4784

4785

4786

4787

<code>Sortable</code>

4788

4789

</li>

4790

4791

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

4792

</div>

4793

4794

4795

4796

4797

4798

4799

4800

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

4801

4802

4803

4804

4805

4806

4807

4808

4809

4810

4811

4812

4813

<p>

4814

4815

Defined in

4816

4817

4818

4819

4820

<a href="../files/sortable_js_sortable.js.html#l288"><code>sortable/js/sortable.js:288</code></a>

4821

4822

</p>

4823

4824

4825

4826

4827

4828

</div>

4829

4830

4831

<p>Allows this Sortable to give items to the passed Sortable.</p>

4832

</div>

4833

4834

4835

4836

<h4>Parameters:</h4>

4837

4838

4839

4840

4841

4842

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

4843

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

4844

4845

4846

4847

4848

4849

<p>sel The Sortable list to join with</p>

4850

</div>

4851

4852

4853

</li>

4854

4855

</ul>

4856

</div>

4857

4858

4859

4860

4861

4862

</div>

4863

4864

4865

4866

4867

4868

4869

4870

4871

4872

4873

4874

<code>Sortable</code>

4875

4876

</li>

4877

4878

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

4879

</div>

4880

4881

4882

4883

4884

4885

4886

4887

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

4888

4889

4890

4891

4892

4893

4894

4895

4896

4897

4898

4899

4900

<p>

4901

4902

Defined in

4903

4904

4905

4906

4907

<a href="../files/sortable_js_sortable.js.html#l259"><code>sortable/js/sortable.js:259</code></a>

4908

4909

</p>

4910

4911

4912

4913

4914

4915

</div>

4916

4917

4918

<p>Removes the join with the passed Sortable.</p>

4919

</div>

4920

4921

4922

4923

<h4>Parameters:</h4>

4924

4925

4926

4927

4928

4929

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

4930

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

4931

4932

4933

4934

4935

4936

<p>sel The Sortable to remove the join from</p>

4937

</div>

4938

4939

4940

</li>

4941

4942

</ul>

4943

</div>

4944

4945

4946

4947

4948

4949

</div>

4950

4951

4952

4953

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

4954

4955

4956

4957

4958

4959

4960

4961

<code>Sortable</code>

4962

4963

</li>

4964

4965

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

4966

</div>

4967

4968

4969

4970

4971

4972

4973

4974

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

4975

4976

4977

4978

4979

4980

4981

4982

4983

4984

4985

4986

4987

<p>

4988

4989

Defined in

4990

4991

4992

4993

4994

<a href="../files/sortable_js_sortable.js.html#l279"><code>sortable/js/sortable.js:279</code></a>

4995

4996

</p>

4997

4998

4999

5000

5001

5002

</div>

5003

5004

5005

<p>Allows this Sortable to accept items from the passed Sortable.</p>

5006

</div>

5007

5008

5009

5010

<h4>Parameters:</h4>

5011

5012

5013

5014

5015

5016

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

5017

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

5018

5019

5020

5021

5022

5023

<p>sel The Sortable list to join with</p>

5024

</div>

5025

5026

5027

</li>

5028

5029

</ul>

5030

</div>

5031

5032

5033

5034

5035

5036

</div>

5037

5038

5039

5040

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

5041

5042

5043

5044

5045

5046

5047

5048

5049

5050

</li>

5051

5052

5053

5054

5055

5056

</li>

5057

5058

5059

5060

5061

5062

</li>

5063

5064

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

5065

</div>

5066

5067

5068

5069

5070

5071

5072

5073

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

5074

5075

5076

5077

5078

5079

5080

5081

5082

5083

5084

5085

<p>Inherited from

5086

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

5087

5088

5089

5090

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

5091

5092

</p>

5093

5094

5095

5096

5097

5098

</div>

5099

5100

5101

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

5102

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

5103

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

5104

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

5105

be subscribed to like other events to monitor the event

5106

system. Inividual published events can have monitoring

5107

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

5108

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

5109

</div>

5110

5111

5112

5113

<h4>Parameters:</h4>

5114

5115

5116

5117

5118

5119

5120

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

5121

5122

5123

5124

5125

5126

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

5127

</div>

5128

5129

5130

</li>

5131

5132

5133

5134

5135

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

5136

5137

5138

5139

5140

5141

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

5142

</div>

5143

5144

5145

</li>

5146

5147

5148

5149

5150

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

5151

5152

5153

5154

5155

5156

<p>Information about the event interaction, such as

5157

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

5158

</div>

5159

5160

5161

</li>

5162

5163

</ul>

5164

</div>

5165

5166

5167

5168

5169

5170

</div>

5171

5172

5173

5174

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

5175

5176

5177

5178

5179

5180

5181

5182

<code>valueHash</code>

5183

5184

</li>

5185

5186

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

5187

</div>

5188

5189

5190

5191

5192

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

5193

</span>

5194

5195

5196

5197

5198

5199

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

5200

5201

5202

5203

5204

5205

5206

5207

5208

5209

5210

<p>Inherited from

5211

5212

Attribute

5213

</a>

5214

5215

but overwritten in

5216

5217

5218

5219

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

5220

5221

</p>

5222

5223

5224

5225

5226

5227

</div>

5228

5229

5230

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

5231

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

5232

</div>

5233

5234

5235

5236

<h4>Parameters:</h4>

5237

5238

5239

5240

5241

5242

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

5243

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

5244

5245

5246

5247

5248

5249

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

5250

</div>

5251

5252

5253

</li>

5254

5255

</ul>

5256

</div>

5257

5258

5259

5260

5261

<h4>Returns:</h4>

5262

5263

5264

5265

5266

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

5267

5268

5269

</div>

5270

</div>

5271

5272

5273

5274

</div>

5275

5276

5277

5278

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

5279

5280

5281

5282

5283

5284

5285

5286

<code>Event</code>

5287

5288

</li>

5289

5290

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

5291

</div>

5292

5293

5294

5295

5296

5297

5298

5299

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

5300

5301

5302

5303

5304

5305

5306

5307

5308

5309

5310

5311

5312

<p>

5313

5314

Defined in

5315

5316

5317

5318

5319

<a href="../files/sortable_js_sortable.js.html#l186"><code>sortable/js/sortable.js:186</code></a>

5320

5321

</p>

5322

5323

5324

5325

5326

5327

</div>

5328

5329

5330

<p>Handles the DragEnd event that cleans up the settings in the drag:start event.</p>

5331

</div>

5332

5333

5334

5335

<h4>Parameters:</h4>

5336

5337

5338

5339

5340

5341

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

5342

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

5343

5344

5345

5346

5347

5348

<p>e The Event Object</p>

5349

</div>

5350

5351

5352

</li>

5353

5354

</ul>

5355

</div>

5356

5357

5358

5359

5360

5361

</div>

5362

5363

5364

5365

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

5366

5367

5368

5369

5370

5371

5372

5373

<code>Event</code>

5374

5375

</li>

5376

5377

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

5378

</div>

5379

5380

5381

5382

5383

5384

5385

5386

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

5387

5388

5389

5390

5391

5392

5393

5394

5395

5396

5397

5398

5399

<p>

5400

5401

Defined in

5402

5403

5404

5405

5406

<a href="../files/sortable_js_sortable.js.html#l100"><code>sortable/js/sortable.js:100</code></a>

5407

5408

</p>

5409

5410

5411

5412

5413

5414

</div>

5415

5416

5417

<p>Handles the DragOver event that moves the object in the list or to another list.</p>

5418

</div>

5419

5420

5421

5422

<h4>Parameters:</h4>

5423

5424

5425

5426

5427

5428

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

5429

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

5430

5431

5432

5433

5434

5435

<p>e The Event Object</p>

5436

</div>

5437

5438

5439

</li>

5440

5441

</ul>

5442

</div>

5443

5444

5445

5446

5447

5448

</div>

5449

5450

5451

5452

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

5453

5454

5455

5456

5457

5458

5459

5460

<code>Event</code>

5461

5462

</li>

5463

5464

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

5465

</div>

5466

5467

5468

5469

5470

5471

5472

5473

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

5474

5475

5476

5477

5478

5479

5480

5481

5482

5483

5484

5485

5486

<p>

5487

5488

Defined in

5489

5490

5491

5492

5493

<a href="../files/sortable_js_sortable.js.html#l175"><code>sortable/js/sortable.js:175</code></a>

5494

5495

</p>

5496

5497

5498

5499

5500

5501

</div>

5502

5503

5504

<p>Handles the DragStart event and initializes some settings.</p>

5505

</div>

5506

5507

5508

5509

<h4>Parameters:</h4>

5510

5511

5512

5513

5514

5515

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

5516

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

5517

5518

5519

5520

5521

5522

<p>e The Event Object</p>

5523

</div>

5524

5525

5526

</li>

5527

5528

</ul>

5529

</div>

5530

5531

5532

5533

5534

5535

</div>

5536

5537

5538

5539

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

5540

5541

5542

5543

5544

5545

5546

5547

<code>Event</code>

5548

5549

</li>

5550

5551

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

5552

</div>

5553

5554

5555

5556

5557

5558

5559

5560

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

5561

5562

5563

5564

5565

5566

5567

5568

5569

5570

5571

5572

5573

<p>

5574

5575

Defined in

5576

5577

5578

5579

5580

<a href="../files/sortable_js_sortable.js.html#l86"><code>sortable/js/sortable.js:86</code></a>

5581

5582

</p>

5583

5584

5585

5586

5587

5588

</div>

5589

5590

5591

<p>Handles the DropOver event to append a drop node to an empty target</p>

5592

</div>

5593

5594

5595

5596

<h4>Parameters:</h4>

5597

5598

5599

5600

5601

5602

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

5603

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

5604

5605

5606

5607

5608

5609

<p>e The Event Object</p>

5610

</div>

5611

5612

5613

</li>

5614

5615

</ul>

5616

</div>

5617

5618

5619

5620

5621

5622

</div>

5623

5624

5625

5626

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

5627

5628

5629

5630

5631

5632

5633

5634

5635

5636

5637

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

5638

5639

5640

5641

5642

5643

5644

5645

5646

5647

5648

5649

<p>Inherited from

5650

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

5651

5652

5653

5654

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

5655

5656

</p>

5657

5658

5659

5660

5661

5662

</div>

5663

5664

5665

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

5666

and the prefixed event name from _getType

5667

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

5668

</div>

5669

5670

5671

5672

5673

5674

5675

</div>

5676

5677

5678

5679

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

5680

5681

5682

5683

5684

5685

5686

5687

<code>config</code>

5688

5689

</li>

5690

5691

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

5692

</div>

5693

5694

5695

5696

5697

5698

5699

5700

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

5701

5702

5703

5704

5705

5706

5707

5708

5709

5710

5711

5712

<p>Inherited from

5713

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

5714

5715

5716

5717

5718

5719

</p>

5720

5721

5722

5723

5724

5725

</div>

5726

5727

5728

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

5729

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

5730

construction, prior to init.</p>

5731

</div>

5732

5733

5734

5735

<h4>Parameters:</h4>

5736

5737

5738

5739

5740

5741

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

5742

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

5743

5744

5745

5746

5747

5748

<p>The user configuration object</p>

5749

</div>

5750

5751

5752

</li>

5753

5754

</ul>

5755

</div>

5756

5757

5758

5759

5760

5761

</div>

5762

5763

5764

5765

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

5766

5767

5768

5769

5770

5771

5772

5773

<code>attrs</code>

5774

5775

</li>

5776

5777

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

5778

</div>

5779

5780

5781

5782

5783

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

5784

</span>

5785

5786

5787

5788

5789

5790

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

5791

5792

5793

5794

5795

5796

5797

5798

5799

5800

5801

5802

<p>Inherited from

5803

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

5804

5805

5806

5807

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

5808

5809

</p>

5810

5811

5812

5813

5814

5815

</div>

5816

5817

5818

<p>Utility method to protect an attribute configuration

5819

hash, by merging the entire object and the individual

5820

attr config objects.</p>

5821

</div>

5822

5823

5824

5825

<h4>Parameters:</h4>

5826

5827

5828

5829

5830

5831

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

5832

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

5833

5834

5835

5836

5837

5838

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

5839

</div>

5840

5841

5842

</li>

5843

5844

</ul>

5845

</div>

5846

5847

5848

5849

5850

<h4>Returns:</h4>

5851

5852

5853

5854

5855

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

5856

5857

A protected version of the attrs argument.

5858

5859

</div>

5860

</div>

5861

5862

5863

5864

</div>

5865

5866

5867

5868

5869

5870

5871

5872

5873

5874

5875

5876

5877

5878

</li>

5879

5880

5881

5882

5883

5884

</li>

5885

5886

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

5887

</div>

5888

5889

5890

5891

5892

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

5893

</span>

5894

5895

5896

5897

5898

5899

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

5900

5901

5902

5903

5904

5905

5906

5907

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

5908

5909

5910

5911

5912

<p>Inherited from

5913

5914

AttributeEvents

5915

</a>

5916

5917

but overwritten in

5918

5919

5920

5921

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

5922

5923

</p>

5924

5925

5926

5927

5928

5929

</div>

5930

5931

5932

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

5933

</div>

5934

5935

5936

5937

<h4>Parameters:</h4>

5938

5939

5940

5941

5942

5943

5944

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

5945

5946

5947

5948

5949

5950

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

5951

</div>

5952

5953

5954

</li>

5955

5956

5957

5958

5959

5960

5961

5962

5963

5964

5965

<p>The value to set the attribute to.</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>_setAttr</code></h3>

5996

5997

5998

5999

6000

6001

6002

6003

6004

6005

</li>

6006

6007

6008

6009

<code>value</code>

6010

6011

</li>

6012

6013

6014

6015

6016

6017

</li>

6018

6019

6020

6021

<code>force</code>

6022

6023

</li>

6024

6025

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

6026

</div>

6027

6028

6029

6030

6031

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

6032

</span>

6033

6034

6035

6036

6037

6038

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

6039

6040

6041

6042

6043

6044

6045

6046

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

6047

6048

6049

6050

6051

6052

<p>Inherited from

6053

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

6054

6055

6056

6057

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

6058

6059

</p>

6060

6061

6062

6063

6064

6065

</div>

6066

6067

6068

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

6069

6070

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

6071

</div>

6072

6073

6074

6075

<h4>Parameters:</h4>

6076

6077

6078

6079

6080

6081

6082

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

6083

6084

6085

6086

6087

6088

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

6089

</div>

6090

6091

6092

</li>

6093

6094

6095

6096

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

6097

6098

6099

6100

6101

6102

6103

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

6104

</div>

6105

6106

6107

</li>

6108

6109

6110

6111

6112

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

6113

6114

6115

6116

6117

6118

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

6119

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

6120

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

6121

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

6122

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

6123

</div>

6124

6125

6126

</li>

6127

6128

6129

6130

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

6131

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

6132

6133

6134

6135

6136

6137

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

6138

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

6139

</div>

6140

6141

6142

</li>

6143

6144

</ul>

6145

</div>

6146

6147

6148

6149

6150

<h4>Returns:</h4>

6151

6152

6153

6154

6155

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

6156

6157

A reference to the host object.

6158

6159

</div>

6160

</div>

6161

6162

6163

6164

</div>

6165

6166

6167

6168

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

6169

6170

6171

6172

6173

6174

6175

6176

<code>attrs</code>

6177

6178

</li>

6179

6180

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

6181

</div>

6182

6183

6184

6185

6186

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

6187

</span>

6188

6189

6190

6191

6192

6193

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

6194

6195

6196

6197

6198

6199

6200

6201

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

6202

6203

6204

6205

6206

6207

<p>Inherited from

6208

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

6209

6210

6211

6212

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

6213

6214

</p>

6215

6216

6217

6218

6219

6220

</div>

6221

6222

6223

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

6224

</div>

6225

6226

6227

6228

<h4>Parameters:</h4>

6229

6230

6231

6232

6233

6234

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

6235

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

6236

6237

6238

6239

6240

6241

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

6242

</div>

6243

6244

6245

</li>

6246

6247

</ul>

6248

</div>

6249

6250

6251

6252

6253

<h4>Returns:</h4>

6254

6255

6256

6257

6258

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

6259

6260

A reference to the host object.

6261

6262

</div>

6263

</div>

6264

6265

6266

6267

</div>

6268

6269

6270

6271

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

6272

6273

6274

6275

6276

6277

6278

6279

<code>attrName</code>

6280

6281

</li>

6282

6283

6284

6285

<code>subAttrName</code>

6286

6287

</li>

6288

6289

6290

6291

<code>prevVal</code>

6292

6293

</li>

6294

6295

6296

6297

<code>newVal</code>

6298

6299

</li>

6300

6301

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

6302

</div>

6303

6304

6305

6306

6307

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

6308

</span>

6309

6310

6311

6312

6313

6314

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

6315

6316

6317

6318

6319

6320

6321

6322

6323

6324

6325

6326

<p>Inherited from

6327

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

6328

6329

6330

6331

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

6332

6333

</p>

6334

6335

6336

6337

6338

6339

</div>

6340

6341

6342

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

6343

if validation and setter passes.</p>

6344

</div>

6345

6346

6347

6348

<h4>Parameters:</h4>

6349

6350

6351

6352

6353

6354

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

6355

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

6356

6357

6358

6359

6360

6361

<p>The attribute name.</p>

6362

</div>

6363

6364

6365

</li>

6366

6367

6368

6369

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

6370

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

6371

6372

6373

6374

6375

6376

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

6377

</div>

6378

6379

6380

</li>

6381

6382

6383

6384

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

6385

6386

6387

6388

6389

6390

6391

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

6392

</div>

6393

6394

6395

</li>

6396

6397

6398

6399

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

6400

6401

6402

6403

6404

6405

6406

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

6407

</div>

6408

6409

6410

</li>

6411

6412

</ul>

6413

</div>

6414

6415

6416

6417

6418

<h4>Returns:</h4>

6419

6420

6421

6422

6423

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

6424

6425

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

6426

6427

</div>

6428

</div>

6429

6430

6431

6432

</div>

6433

6434

6435

6436

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

6437

6438

6439

6440

6441

6442

6443

6444

6445

6446

</li>

6447

6448

6449

6450

<code>value</code>

6451

6452

</li>

6453

6454

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

6455

</div>

6456

6457

6458

6459

6460

6461

6462

6463

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

6464

6465

6466

6467

6468

6469

6470

6471

6472

6473

6474

6475

<p>Inherited from

6476

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

6477

6478

6479

6480

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

6481

6482

</p>

6483

6484

6485

6486

6487

6488

</div>

6489

6490

6491

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

6492

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

6493

</div>

6494

6495

6496

6497

<h4>Parameters:</h4>

6498

6499

6500

6501

6502

6503

6504

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

6505

6506

6507

6508

6509

6510

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

6511

</div>

6512

6513

6514

</li>

6515

6516

6517

6518

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

6519

6520

6521

6522

6523

6524

6525

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

6526

</div>

6527

6528

6529

</li>

6530

6531

</ul>

6532

</div>

6533

6534

6535

6536

6537

6538

</div>

6539

6540

6541

6542

6543

6544

6545

6546

6547

6548

6549

6550

6551

6552

</li>

6553

6554

6555

6556

6557

6558

</li>

6559

6560

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

6561

</div>

6562

6563

6564

6565

6566

6567

6568

6569

6570

6571

6572

6573

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

6574

6575

6576

6577

6578

6579

6580

6581

6582

<p>

6583

6584

Defined in

6585

6586

6587

6588

6589

<a href="../files/sortable_js_sortable.js.html#l393"><code>sortable/js/sortable.js:393</code></a>

6590

6591

</p>

6592

6593

6594

6595

6596

6597

</div>

6598

6599

6600

<p>Test a Node or a selector for the container</p>

6601

</div>

6602

6603

6604

6605

<h4>Parameters:</h4>

6606

6607

6608

6609

6610

6611

6612

6613

6614

6615

6616

6617

6618

<p>The node instance to test.</p>

6619

</div>

6620

6621

6622

</li>

6623

6624

6625

6626

6627

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

6628

6629

6630

6631

6632

6633

<p>The node instance or selector string to test against.</p>

6634

</div>

6635

6636

6637

</li>

6638

6639

</ul>

6640

</div>

6641

6642

6643

6644

6645

6646

</div>

6647

6648

6649

6650

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

6651

6652

6653

6654

6655

6656

6657

6658

6659

6660

</li>

6661

6662

6663

6664

<code>config</code>

6665

6666

</li>

6667

6668

6669

6670

6671

6672

</li>

6673

6674

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

6675

</div>

6676

6677

6678

6679

6680

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

6681

</span>

6682

6683

6684

6685

6686

6687

6688

6689

6690

6691

6692

6693

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

6694

6695

6696

6697

6698

6699

<p>Inherited from

6700

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

6701

6702

6703

6704

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

6705

6706

</p>

6707

6708

6709

6710

6711

6712

</div>

6713

6714

6715

<p>

6716

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

6717

</p>

6718

6719

<p>

6720

The config argument object supports the following properties:

6721

</p>

6722

6723

<dl>

6724

<dt>value <Any></dt>

6725

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

6726

6727

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

6728

<dd>

6729

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

6730

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

6731

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

6732

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

6733

case the value property is used.</p>

6734

6735

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

6736

</dd>

6737

6738

<dt>readOnly <boolean></dt>

6739

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

6740

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

6741

6742

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

6743

<dd>

6744

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

6745

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

6746

constructor configuration arguments, or by invoking set.

6747

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

6748

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

6749

</dd>

6750

6751

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

6752

<dd>

6753

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

6754

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

6755

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

6756

the value from being stored.

6757

</p>

6758

6759

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

6760

</dd>

6761

6762

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

6763

<dd>

6764

<p>

6765

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

6766

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

6767

invoke get.

6768

</p>

6769

6770

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

6771

</dd>

6772

6773

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

6774

<dd>

6775

<p>

6776

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

6777

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

6778

</p>

6779

6780

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

6781

</dd>

6782

6783

<dt>lazyAdd <boolean></dt>

6784

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

6785

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

6786

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

6787

6788

</dl>

6789

6790

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

6791

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

6792

6793

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

6794

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

6795

</div>

6796

6797

6798

6799

<h4>Parameters:</h4>

6800

6801

6802

6803

6804

6805

6806

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

6807

6808

6809

6810

6811

6812

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

6813

</div>

6814

6815

6816

</li>

6817

6818

6819

6820

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

6821

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

6822

6823

6824

6825

6826

6827

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

6828

6829

<p>

6830

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

6831

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

6832

</p>

6833

</div>

6834

6835

6836

</li>

6837

6838

6839

6840

6841

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

6842

6843

6844

6845

6846

6847

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

6848

</div>

6849

6850

6851

</li>

6852

6853

</ul>

6854

</div>

6855

6856

6857

6858

6859

<h4>Returns:</h4>

6860

6861

6862

6863

6864

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

6865

6866

A reference to the host object.

6867

6868

</div>

6869

</div>

6870

6871

6872

6873

</div>

6874

6875

6876

6877

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

6878

6879

6880

6881

6882

6883

6884

6885

6886

6887

</li>

6888

6889

6890

6891

<code>values</code>

6892

6893

</li>

6894

6895

6896

6897

6898

6899

</li>

6900

6901

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

6902

</div>

6903

6904

6905

6906

6907

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

6908

</span>

6909

6910

6911

6912

6913

6914

6915

6916

6917

6918

6919

6920

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

6921

6922

6923

6924

6925

6926

<p>Inherited from

6927

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

6928

6929

6930

6931

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

6932

6933

</p>

6934

6935

6936

6937

6938

6939

</div>

6940

6941

6942

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

6943

6944

<p>

6945

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

6946

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

6947

</p>

6948

</div>

6949

6950

6951

6952

<h4>Parameters:</h4>

6953

6954

6955

6956

6957

6958

6959

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

6960

6961

6962

6963

6964

6965

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

6966

</div>

6967

6968

6969

</li>

6970

6971

6972

6973

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

6974

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

6975

6976

6977

6978

6979

6980

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

6981

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

6982

</div>

6983

6984

6985

</li>

6986

6987

6988

6989

6990

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

6991

6992

6993

6994

6995

6996

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

6997

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

6998

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

6999

</div>

7000

7001

7002

</li>

7003

7004

</ul>

7005

</div>

7006

7007

7008

7009

7010

<h4>Returns:</h4>

7011

7012

7013

7014

7015

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

7016

7017

A reference to the host object.

7018

7019

</div>

7020

</div>

7021

7022

7023

7024

</div>

7025

7026

7027

7028

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

7029

7030

7031

7032

7033

7034

7035

7036

7037

7038

</li>

7039

7040

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

7041

</div>

7042

7043

7044

7045

7046

7047

7048

7049

7050

7051

7052

7053

7054

7055

7056

7057

7058

7059

<p>Inherited from

7060

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

7061

7062

7063

7064

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

7065

7066

</p>

7067

7068

7069

7070

7071

7072

</div>

7073

7074

7075

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

7076

is determined by the order registered. Multiple targets can

7077

be specified.</p>

7078

7079

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

7080

7081

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

7082

</div>

7083

7084

7085

7086

<h4>Parameters:</h4>

7087

7088

7089

7090

7091

7092

7093

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

7094

7095

7096

7097

7098

7099

<p>the target to add</p>

7100

</div>

7101

7102

7103

</li>

7104

7105

</ul>

7106

</div>

7107

7108

7109

7110

7111

7112

</div>

7113

7114

7115

7116

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

7117

7118

7119

7120

7121

7122

7123

7124

7125

7126

</li>

7127

7128

7129

7130

7131

7132

</li>

7133

7134

7135

7136

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

7137

7138

</li>

7139

7140

7141

7142

7143

7144

</li>

7145

7146

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

7147

</div>

7148

7149

7150

7151

7152

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

7153

</span>

7154

7155

7156

7157

7158

7159

7160

7161

7162

7163

7164

7165

7166

7167

7168

7169

<p>Inherited from

7170

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

7171

7172

7173

7174

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

7175

7176

</p>

7177

7178

7179

7180

7181

7182

</div>

7183

7184

7185

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

7186

supplied callback will execute after any listeners add

7187

via the subscribe method, and after the default function,

7188

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

7189

</div>

7190

7191

7192

7193

<h4>Parameters:</h4>

7194

7195

7196

7197

7198

7199

7200

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

7201

7202

7203

7204

7205

7206

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

7207

</div>

7208

7209

7210

</li>

7211

7212

7213

7214

7215

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

7216

7217

7218

7219

7220

7221

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

7222

</div>

7223

7224

7225

</li>

7226

7227

7228

7229

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

7230

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

7231

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

7232

7233

7234

7235

7236

7237

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

7238

</div>

7239

7240

7241

</li>

7242

7243

7244

7245

7246

7247

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

7248

7249

7250

7251

7252

7253

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

7254

</div>

7255

7256

7257

</li>

7258

7259

</ul>

7260

</div>

7261

7262

7263

7264

7265

<h4>Returns:</h4>

7266

7267

7268

7269

7270

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

7271

7272

A subscription handle capable of detaching the

7273

subscription

7274

7275

</div>

7276

</div>

7277

7278

7279

7280

</div>

7281

7282

7283

7284

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

7285

7286

7287

7288

7289

7290

7291

7292

7293

7294

</li>

7295

7296

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

7297

</div>

7298

7299

7300

7301

7302

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

7303

</span>

7304

7305

7306

7307

7308

7309

7310

7311

7312

7313

7314

7315

7316

7317

7318

7319

<p>Inherited from

7320

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

7321

7322

7323

7324

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

7325

7326

</p>

7327

7328

7329

7330

7331

7332

</div>

7333

7334

7335

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

7336

</div>

7337

7338

7339

7340

<h4>Parameters:</h4>

7341

7342

7343

7344

7345

7346

7347

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

7348

7349

7350

7351

7352

7353

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

7354

</div>

7355

7356

7357

</li>

7358

7359

</ul>

7360

</div>

7361

7362

7363

7364

7365

<h4>Returns:</h4>

7366

7367

7368

7369

7370

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

7371

7372

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.

7373

7374

</div>

7375

</div>

7376

7377

7378

7379

</div>

7380

7381

7382

7383

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

7384

7385

7386

7387

7388

7389

7390

7391

7392

</span>

7393

7394

7395

7396

7397

7398

7399

7400

7401

7402

7403

7404

7405

7406

7407

7408

<p>Inherited from

7409

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

7410

7411

7412

7413

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

7414

7415

</p>

7416

7417

7418

7419

7420

7421

</div>

7422

7423

7424

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

7425

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

7426

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

7427

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

7428

7429

<p>For DOM and custom events:

7430

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

7431

7432

<p>For methods:

7433

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

7434

</div>

7435

7436

7437

7438

7439

7440

<h4>Returns:</h4>

7441

7442

7443

7444

7445

detach handle

7446

7447

</div>

7448

</div>

7449

7450

7451

7452

</div>

7453

7454

7455

7456

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

7457

7458

7459

7460

7461

7462

7463

7464

7465

7466

</li>

7467

7468

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

7469

</div>

7470

7471

7472

7473

7474

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

7475

</span>

7476

7477

7478

7479

7480

7481

7482

7483

7484

7485

7486

7487

7488

7489

7490

7491

<p>Inherited from

7492

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

7493

7494

7495

7496

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

7497

7498

</p>

7499

7500

7501

7502

7503

7504

</div>

7505

7506

7507

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

7508

</div>

7509

7510

7511

7512

<h4>Parameters:</h4>

7513

7514

7515

7516

7517

7518

7519

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

7520

7521

7522

7523

7524

7525

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

7526

</div>

7527

7528

7529

</li>

7530

7531

</ul>

7532

</div>

7533

7534

7535

7536

7537

<h4>Returns:</h4>

7538

7539

7540

7541

7542

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

7543

7544

the aggregated return value from Event.Custom.fire

7545

7546

</div>

7547

</div>

7548

7549

7550

7551

</div>

7552

7553

7554

7555

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

7556

7557

7558

7559

7560

7561

7562

7563

7564

</span>

7565

7566

7567

7568

7569

7570

7571

7572

7573

7574

7575

7576

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

7577

7578

7579

7580

7581

<p>Inherited from

7582

7583

BaseCore

7584

</a>

7585

7586

but overwritten in

7587

7588

7589

7590

7591

7592

</p>

7593

7594

7595

7596

7597

7598

</div>

7599

7600

7601

<p>

7602

Destroy lifecycle method. Fires the destroy

7603

event, prior to invoking destructors for the

7604

class hierarchy.

7605

</p>

7606

7607

<p>

7608

Subscribers to the destroy

7609

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

7610

from proceeding.

7611

</p>

7612

</div>

7613

7614

7615

7616

7617

7618

<h4>Returns:</h4>

7619

7620

7621

7622

7623

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

7624

7625

A reference to this object

7626

7627

</div>

7628

</div>

7629

7630

7631

7632

</div>

7633

7634

7635

7636

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

7637

7638

7639

7640

7641

7642

7643

7644

7645

7646

</li>

7647

7648

7649

7650

7651

7652

</li>

7653

7654

7655

7656

<code>context</code>

7657

7658

</li>

7659

7660

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

7661

</div>

7662

7663

7664

7665

7666

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

7667

</span>

7668

7669

7670

7671

7672

7673

7674

7675

7676

7677

7678

7679

7680

7681

7682

7683

<p>Inherited from

7684

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

7685

7686

7687

7688

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

7689

7690

</p>

7691

7692

7693

7694

7695

7696

</div>

7697

7698

7699

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

7700

</div>

7701

7702

7703

7704

<h4>Parameters:</h4>

7705

7706

7707

7708

7709

7710

7711

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

7712

7713

7714

7715

7716

7717

<p>Either the handle to the subscriber or the

7718

type of event. If the type

7719

is not specified, it will attempt to remove

7720

the listener from all hosted events.</p>

7721

</div>

7722

7723

7724

</li>

7725

7726

7727

7728

7729

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

7730

7731

7732

7733

7734

7735

<p>The subscribed function to unsubscribe, if not

7736

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

7737

</div>

7738

7739

7740

</li>

7741

7742

7743

7744

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

7745

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

7746

7747

7748

7749

7750

7751

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

7752

optional, but if supplied will be used to

7753

disambiguate multiple listeners that are the same

7754

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

7755

that lives on the prototype)</p>

7756

</div>

7757

7758

7759

</li>

7760

7761

</ul>

7762

</div>

7763

7764

7765

7766

7767

<h4>Returns:</h4>

7768

7769

7770

7771

7772

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

7773

7774

the host

7775

7776

</div>

7777

</div>

7778

7779

7780

7781

</div>

7782

7783

7784

7785

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

7786

7787

7788

7789

7790

7791

7792

7793

7794

7795

</li>

7796

7797

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

7798

</div>

7799

7800

7801

7802

7803

7804

7805

7806

7807

7808

7809

7810

7811

7812

7813

7814

7815

7816

<p>Inherited from

7817

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

7818

7819

7820

7821

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

7822

7823

</p>

7824

7825

7826

7827

7828

7829

</div>

7830

7831

7832

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

7833

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

7834

be removed.</p>

7835

</div>

7836

7837

7838

7839

<h4>Parameters:</h4>

7840

7841

7842

7843

7844

7845

7846

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

7847

7848

7849

7850

7851

7852

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

7853

</div>

7854

7855

7856

</li>

7857

7858

</ul>

7859

</div>

7860

7861

7862

7863

7864

7865

</div>

7866

7867

7868

7869

7870

7871

7872

7873

7874

7875

7876

7877

7878

7879

</li>

7880

7881

7882

7883

<code>arguments</code>

7884

7885

</li>

7886

7887

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

7888

</div>

7889

7890

7891

7892

7893

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

7894

</span>

7895

7896

7897

7898

7899

7900

7901

7902

7903

7904

7905

7906

7907

7908

7909

7910

<p>Inherited from

7911

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

7912

7913

7914

7915

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

7916

7917

</p>

7918

7919

7920

7921

7922

7923

</div>

7924

7925

7926

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

7927

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

7928

following parameters.</p>

7929

7930

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

7931

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

7932

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

7933

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

7934

be published on this object first.</p>

7935

7936

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

7937

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

7938

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

7939

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

7940

in place of the original object.</p>

7941

</div>

7942

7943

7944

7945

<h4>Parameters:</h4>

7946

7947

7948

7949

7950

7951

7952

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

7953

7954

7955

7956

7957

7958

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

7959

a 'type' property.</p>

7960

</div>

7961

7962

7963

</li>

7964

7965

7966

7967

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

7968

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

7969

7970

7971

7972

7973

7974

<p>an arbitrary set of parameters to pass to

7975

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

7976

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

7977

parameter after the properties the object literal contains are copied to

7978

the event facade.</p>

7979

</div>

7980

7981

7982

</li>

7983

7984

</ul>

7985

</div>

7986

7987

7988

7989

7990

<h4>Returns:</h4>

7991

7992

7993

7994

7995

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

7996

7997

the event host

7998

7999

</div>

8000

</div>

8001

8002

8003

8004

</div>

8005

8006

8007

8008

8009

8010

8011

8012

8013

8014

8015

8016

8017

8018

</li>

8019

8020

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

8021

</div>

8022

8023

8024

8025

8026

8027

</span>

8028

8029

8030

8031

8032

8033

8034

8035

8036

8037

8038

8039

8040

8041

8042

8043

<p>Inherited from

8044

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

8045

8046

8047

8048

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

8049

8050

</p>

8051

8052

8053

8054

8055

8056

</div>

8057

8058

8059

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

8060

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

8061

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

8062

</div>

8063

8064

8065

8066

<h4>Parameters:</h4>

8067

8068

8069

8070

8071

8072

8073

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

8074

8075

8076

8077

8078

8079

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

8080

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

8081

</div>

8082

8083

8084

</li>

8085

8086

</ul>

8087

</div>

8088

8089

8090

8091

8092

<h4>Returns:</h4>

8093

8094

8095

8096

8097

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

8098

8099

The value of the attribute

8100

8101

</div>

8102

</div>

8103

8104

8105

8106

</div>

8107

8108

8109

8110

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

8111

8112

8113

8114

8115

8116

8117

8118

<code>attrs</code>

8119

8120

</li>

8121

8122

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

8123

</div>

8124

8125

8126

8127

8128

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

8129

</span>

8130

8131

8132

8133

8134

8135

8136

8137

8138

8139

8140

8141

8142

8143

8144

8145

<p>Inherited from

8146

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

8147

8148

8149

8150

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

8151

8152

</p>

8153

8154

8155

8156

8157

8158

</div>

8159

8160

8161

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

8162

</div>

8163

8164

8165

8166

<h4>Parameters:</h4>

8167

8168

8169

8170

8171

8172

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

8173

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

8174

8175

8176

8177

8178

8179

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

8180

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

8181

</div>

8182

8183

8184

</li>

8185

8186

</ul>

8187

</div>

8188

8189

8190

8191

8192

<h4>Returns:</h4>

8193

8194

8195

8196

8197

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

8198

8199

An object with attribute name/value pairs.

8200

8201

</div>

8202

</div>

8203

8204

8205

8206

</div>

8207

8208

8209

8210

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

8211

8212

8213

8214

8215

8216

8217

8218

8219

8220

</li>

8221

8222

8223

8224

<code>prefixed</code>

8225

8226

</li>

8227

8228

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

8229

</div>

8230

8231

8232

8233

8234

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

8235

</span>

8236

8237

8238

8239

8240

8241

8242

8243

8244

8245

8246

8247

8248

8249

8250

8251

<p>Inherited from

8252

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

8253

8254

8255

8256

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

8257

8258

</p>

8259

8260

8261

8262

8263

8264

</div>

8265

8266

8267

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

8268

falsy value otherwise</p>

8269

</div>

8270

8271

8272

8273

<h4>Parameters:</h4>

8274

8275

8276

8277

8278

8279

8280

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

8281

8282

8283

8284

8285

8286

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

8287

</div>

8288

8289

8290

</li>

8291

8292

8293

8294

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

8295

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

8296

8297

8298

8299

8300

8301

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

8302

</div>

8303

8304

8305

</li>

8306

8307

</ul>

8308

</div>

8309

8310

8311

8312

8313

<h4>Returns:</h4>

8314

8315

8316

8317

8318

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

8319

8320

the custom event or null

8321

8322

</div>

8323

</div>

8324

8325

8326

8327

</div>

8328

8329

8330

8331

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

8332

8333

8334

8335

8336

8337

8338

8339

<code>Function</code>

8340

8341

</li>

8342

8343

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

8344

</div>

8345

8346

8347

8348

8349

8350

</span>

8351

8352

8353

8354

8355

8356

8357

8358

8359

8360

8361

8362

8363

8364

8365

8366

8367

<p>

8368

8369

Defined in

8370

8371

8372

8373

8374

<a href="../files/sortable_js_sortable.js.html#l297"><code>sortable/js/sortable.js:297</code></a>

8375

8376

</p>

8377

8378

8379

8380

8381

8382

</div>

8383

8384

8385

<p>A custom callback to allow a user to extract some sort of id or any other data from the node to use in the "ordering list" and then that data should be returned from the callback.</p>

8386

</div>

8387

8388

8389

8390

<h4>Parameters:</h4>

8391

8392

8393

8394

8395

8396

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

8397

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

8398

8399

8400

8401

8402

8403

<p>callback</p>

8404

</div>

8405

8406

8407

</li>

8408

8409

</ul>

8410

</div>

8411

8412

8413

8414

8415

<h4>Returns:</h4>

8416

8417

8418

8419

8420

Array

8421

8422

</div>

8423

</div>

8424

8425

8426

8427

</div>

8428

8429

8430

8431

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

8432

8433

8434

8435

8436

8437

8438

8439

8440

8441

</li>

8442

8443

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

8444

</div>

8445

8446

8447

8448

8449

8450

8451

8452

8453

8454

8455

8456

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

8457

8458

8459

8460

8461

8462

8463

8464

8465

<p>

8466

8467

Defined in

8468

8469

8470

8471

8472

<a href="../files/sortable_js_sortable.js.html#l407"><code>sortable/js/sortable.js:407</code></a>

8473

8474

</p>

8475

8476

8477

8478

8479

8480

</div>

8481

8482

8483

<p>Get a Sortable instance back from a node reference or a selector string.</p>

8484

</div>

8485

8486

8487

8488

<h4>Parameters:</h4>

8489

8490

8491

8492

8493

8494

8495

8496

8497

8498

8499

8500

8501

<p>The node instance or selector string to use to find a Sortable instance.</p>

8502

</div>

8503

8504

8505

</li>

8506

8507

</ul>

8508

</div>

8509

8510

8511

8512

8513

8514

</div>

8515

8516

8517

8518

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

8519

8520

8521

8522

8523

8524

8525

8526

8527

</span>

8528

8529

8530

8531

8532

8533

8534

8535

8536

8537

8538

8539

8540

8541

8542

8543

<p>Inherited from

8544

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

8545

8546

8547

8548

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

8549

8550

</p>

8551

8552

8553

8554

8555

8556

</div>

8557

8558

8559

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

8560

</div>

8561

8562

8563

8564

8565

8566

<h4>Returns:</h4>

8567

8568

8569

8570

8571

EventTarget[]

8572

8573

</div>

8574

</div>

8575

8576

8577

8578

</div>

8579

8580

8581

8582

8583

8584

8585

8586

8587

8588

8589

8590

<code>config</code>

8591

8592

</li>

8593

8594

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

8595

</div>

8596

8597

8598

8599

8600

8601

</span>

8602

8603

8604

8605

8606

8607

8608

8609

8610

8611

8612

8613

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

8614

8615

8616

8617

8618

<p>Inherited from

8619

8620

BaseCore

8621

</a>

8622

8623

but overwritten in

8624

8625

8626

8627

8628

8629

</p>

8630

8631

8632

8633

8634

8635

</div>

8636

8637

8638

<p>Init lifecycle method, invoked during construction.

8639

Fires the init event prior to setting up attributes and

8640

invoking initializers for the class hierarchy.</p>

8641

</div>

8642

8643

8644

8645

<h4>Parameters:</h4>

8646

8647

8648

8649

8650

8651

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

8652

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

8653

8654

8655

8656

8657

8658

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

8659

</div>

8660

8661

8662

</li>

8663

8664

</ul>

8665

</div>

8666

8667

8668

8669

8670

<h4>Returns:</h4>

8671

8672

8673

8674

8675

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

8676

8677

A reference to this object

8678

8679

</div>

8680

</div>

8681

8682

8683

8684

</div>

8685

8686

8687

8688

8689

8690

8691

8692

8693

8694

8695

8696

<code>Sortable</code>

8697

8698

</li>

8699

8700

8701

8702

<code>String</code>

8703

8704

</li>

8705

8706

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

8707

</div>

8708

8709

8710

8711

8712

8713

8714

8715

8716

8717

8718

8719

8720

8721

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

8722

8723

8724

8725

8726

8727

8728

<p>

8729

8730

Defined in

8731

8732

8733

8734

8735

<a href="../files/sortable_js_sortable.js.html#l229"><code>sortable/js/sortable.js:229</code></a>

8736

8737

</p>

8738

8739

8740

8741

8742

8743

</div>

8744

8745

8746

<p>Join this Sortable with another Sortable instance.</p>

8747

8748

<ul>

8749

<li>full: Exchange nodes with both lists.</li>

8750

<li>inner: Items can go into this list from the joined list.</li>

8751

<li>outer: Items can go out of the joined list into this list.</li>

8752

<li>none: Removes the join.</li>

8753

</ul>

8754

</div>

8755

8756

8757

8758

<h4>Parameters:</h4>

8759

8760

8761

8762

8763

8764

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

8765

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

8766

8767

8768

8769

8770

8771

<p>sel The Sortable list to join with</p>

8772

</div>

8773

8774

8775

</li>

8776

8777

8778

8779

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

8780

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

8781

8782

8783

8784

8785

8786

<p>type The type of join to do: full, inner, outer, none. Default: full</p>

8787

</div>

8788

8789

8790

</li>

8791

8792

</ul>

8793

</div>

8794

8795

8796

8797

8798

8799

</div>

8800

8801

8802

8803

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

8804

8805

8806

8807

8808

8809

8810

8811

8812

8813

</li>

8814

8815

8816

8817

<code>config</code>

8818

8819

</li>

8820

8821

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

8822

</div>

8823

8824

8825

8826

8827

8828

8829

8830

8831

8832

8833

8834

8835

8836

8837

8838

8839

8840

<p>Inherited from

8841

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

8842

8843

8844

8845

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

8846

8847

</p>

8848

8849

8850

8851

8852

8853

</div>

8854

8855

8856

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

8857

8858

<p>

8859

The properties which can be modified through this interface are limited

8860

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

8861

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

8862

broadcast and getter.

8863

</p>

8864

</div>

8865

8866

8867

8868

<h4>Parameters:</h4>

8869

8870

8871

8872

8873

8874

8875

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

8876

8877

8878

8879

8880

8881

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

8882

</div>

8883

8884

8885

</li>

8886

8887

8888

8889

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

8890

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

8891

8892

8893

8894

8895

8896

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

8897

</div>

8898

8899

8900

</li>

8901

8902

</ul>

8903

</div>

8904

8905

8906

8907

8908

8909

</div>

8910

8911

8912

8913

8914

8915

8916

8917

8918

8919

8920

8921

8922

8923

</li>

8924

8925

8926

8927

8928

8929

</li>

8930

8931

8932

8933

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

8934

8935

</li>

8936

8937

8938

8939

8940

8941

</li>

8942

8943

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

8944

</div>

8945

8946

8947

8948

8949

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

8950

</span>

8951

8952

8953

8954

8955

8956

8957

8958

8959

8960

8961

8962

8963

8964

8965

8966

<p>Inherited from

8967

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

8968

8969

8970

8971

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

8972

8973

</p>

8974

8975

8976

8977

8978

8979

</div>

8980

8981

8982

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

8983

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

8984

8985

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

8986

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

8987

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

8988

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

8989

API for all available properties and methods. Subscribers to

8990

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

8991

after the event name.</p>

8992

8993

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

8994

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

8995

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

8996

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

8997

8998

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

8999

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

9000

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

9001

</div>

9002

9003

9004

9005

<h4>Parameters:</h4>

9006

9007

9008

9009

9010

9011

9012

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

9013

9014

9015

9016

9017

9018

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

9019

</div>

9020

9021

9022

</li>

9023

9024

9025

9026

9027

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

9028

9029

9030

9031

9032

9033

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

9034

</div>

9035

9036

9037

</li>

9038

9039

9040

9041

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

9042

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

9043

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

9044

9045

9046

9047

9048

9049

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

9050

</div>

9051

9052

9053

</li>

9054

9055

9056

9057

9058

9059

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

9060

9061

9062

9063

9064

9065

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

9066

</div>

9067

9068

9069

</li>

9070

9071

</ul>

9072

</div>

9073

9074

9075

9076

9077

<h4>Returns:</h4>

9078

9079

9080

9081

9082

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

9083

9084

A subscription handle capable of detaching that

9085

subscription

9086

9087

</div>

9088

</div>

9089

9090

9091

9092

</div>

9093

9094

9095

9096

9097

9098

9099

9100

9101

9102

9103

9104

9105

9106

</li>

9107

9108

9109

9110

9111

9112

</li>

9113

9114

9115

9116

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

9117

9118

</li>

9119

9120

9121

9122

9123

9124

</li>

9125

9126

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

9127

</div>

9128

9129

9130

9131

9132

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

9133

</span>

9134

9135

9136

9137

9138

9139

9140

9141

9142

9143

9144

9145

9146

9147

9148

9149

<p>Inherited from

9150

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

9151

9152

9153

9154

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

9155

9156

</p>

9157

9158

9159

9160

9161

9162

</div>

9163

9164

9165

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

9166

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

9167

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

9168

</div>

9169

9170

9171

9172

<h4>Parameters:</h4>

9173

9174

9175

9176

9177

9178

9179

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

9180

9181

9182

9183

9184

9185

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

9186

</div>

9187

9188

9189

</li>

9190

9191

9192

9193

9194

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

9195

9196

9197

9198

9199

9200

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

9201

</div>

9202

9203

9204

</li>

9205

9206

9207

9208

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

9209

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

9210

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

9211

9212

9213

9214

9215

9216

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

9217

</div>

9218

9219

9220

</li>

9221

9222

9223

9224

9225

9226

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

9227

9228

9229

9230

9231

9232

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

9233

</div>

9234

9235

9236

</li>

9237

9238

</ul>

9239

</div>

9240

9241

9242

9243

9244

<h4>Returns:</h4>

9245

9246

9247

9248

9249

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

9250

9251

A subscription handle capable of detaching the

9252

subscription

9253

9254

</div>

9255

</div>

9256

9257

9258

9259

</div>

9260

9261

9262

9263

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

9264

9265

9266

9267

9268

9269

9270

9271

9272

9273

</li>

9274

9275

9276

9277

9278

9279

</li>

9280

9281

9282

9283

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

9284

9285

</li>

9286

9287

9288

9289

9290

9291

</li>

9292

9293

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

9294

</div>

9295

9296

9297

9298

9299

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

9300

</span>

9301

9302

9303

9304

9305

9306

9307

9308

9309

9310

9311

9312

9313

9314

9315

9316

<p>Inherited from

9317

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

9318

9319

9320

9321

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

9322

9323

</p>

9324

9325

9326

9327

9328

9329

</div>

9330

9331

9332

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

9333

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

9334

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

9335

</div>

9336

9337

9338

9339

<h4>Parameters:</h4>

9340

9341

9342

9343

9344

9345

9346

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

9347

9348

9349

9350

9351

9352

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

9353

</div>

9354

9355

9356

</li>

9357

9358

9359

9360

9361

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

9362

9363

9364

9365

9366

9367

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

9368

</div>

9369

9370

9371

</li>

9372

9373

9374

9375

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

9376

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

9377

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

9378

9379

9380

9381

9382

9383

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

9384

</div>

9385

9386

9387

</li>

9388

9389

9390

9391

9392

9393

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

9394

9395

9396

9397

9398

9399

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

9400

</div>

9401

9402

9403

</li>

9404

9405

</ul>

9406

</div>

9407

9408

9409

9410

9411

<h4>Returns:</h4>

9412

9413

9414

9415

9416

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

9417

9418

A subscription handle capable of detaching that

9419

subscription

9420

9421

</div>

9422

</div>

9423

9424

9425

9426

</div>

9427

9428

9429

9430

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

9431

9432

9433

9434

9435

9436

9437

9438

9439

9440

</li>

9441

9442

9443

9444

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

9445

9446

</li>

9447

9448

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

9449

</div>

9450

9451

9452

9453

9454

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

9455

</span>

9456

9457

9458

9459

9460

9461

9462

9463

9464

9465

9466

9467

9468

9469

9470

9471

<p>Inherited from

9472

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

9473

9474

9475

9476

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

9477

9478

</p>

9479

9480

9481

9482

9483

9484

<p>Available since 3.3.0</p>

9485

9486

</div>

9487

9488

9489

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

9490

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

9491

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

9492

to include the prefix one is supplied or the event target

9493

is configured with a default prefix.</p>

9494

</div>

9495

9496

9497

9498

<h4>Parameters:</h4>

9499

9500

9501

9502

9503

9504

9505

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

9506

9507

9508

9509

9510

9511

9512

</div>

9513

9514

9515

</li>

9516

9517

9518

9519

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

9520

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

9521

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

9522

9523

9524

9525

9526

9527

<p>the prefix</p>

9528

</div>

9529

9530

9531

</li>

9532

9533

</ul>

9534

</div>

9535

9536

9537

9538

9539

<h4>Returns:</h4>

9540

9541

9542

9543

9544

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

9545

9546

an array containing:

9547

* the detach category, if supplied,

9548

* the prefixed event type,

9549

* whether or not this is an after listener,

9550

* the supplied event type

9551

9552

</div>

9553

</div>

9554

9555

9556

9557

</div>

9558

9559

9560

9561

9562

9563

9564

9565

9566

9567

9568

9569

<code>Class</code>

9570

9571

</li>

9572

9573

9574

9575

<code>Object</code>

9576

9577

</li>

9578

9579

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

9580

</div>

9581

9582

9583

9584

9585

9586

9587

9588

9589

9590

9591

9592

9593

9594

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

9595

9596

9597

9598

9599

9600

9601

<p>

9602

9603

Defined in

9604

9605

9606

9607

9608

<a href="../files/sortable_js_sortable.js.html#l200"><code>sortable/js/sortable.js:200</code></a>

9609

9610

</p>

9611

9612

9613

9614

9615

9616

</div>

9617

9618

9619

<p>Passthrough to the DD.Delegate.ddplug method</p>

9620

</div>

9621

9622

9623

9624

<h4>Parameters:</h4>

9625

9626

9627

9628

9629

9630

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

9631

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

9632

9633

9634

9635

9636

9637

<p>cls The class to plug</p>

9638

</div>

9639

9640

9641

</li>

9642

9643

9644

9645

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

9646

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

9647

9648

9649

9650

9651

9652

<p>config The class config</p>

9653

</div>

9654

9655

9656

</li>

9657

9658

</ul>

9659

</div>

9660

9661

9662

9663

9664

9665

</div>

9666

9667

9668

9669

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

9670

9671

9672

9673

9674

9675

9676

9677

9678

9679

</li>

9680

9681

9682

9683

9684

9685

</li>

9686

9687

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

9688

</div>

9689

9690

9691

9692

9693

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

9694

</span>

9695

9696

9697

9698

9699

9700

9701

9702

9703

9704

9705

9706

9707

9708

9709

9710

<p>Inherited from

9711

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

9712

9713

9714

9715

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

9716

9717

</p>

9718

9719

9720

9721

9722

9723

</div>

9724

9725

9726

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

9727

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

9728

case the custom event is returned.</p>

9729

</div>

9730

9731

9732

9733

<h4>Parameters:</h4>

9734

9735

9736

9737

9738

9739

9740

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

9741

9742

9743

9744

9745

9746

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

9747

</div>

9748

9749

9750

</li>

9751

9752

9753

9754

9755

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

9756

9757

9758

9759

9760

9761

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

9762

9763

<p><ul>

9764

<li>

9765

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

9766

</li>

9767

<li>

9768

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

9769

Events can only bubble if emitFacade is true.

9770

</li>

9771

<li>

9772

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

9773

</li>

9774

<li>

9775

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

9776

</li>

9777

<li>

9778

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

9779

</li>

9780

<li>

9781

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

9782

</li>

9783

<li>

9784

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

9785

the fire will be notified immediately.

9786

</li>

9787

<li>

9788

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

9789

fired unless async is true.

9790

</li>

9791

<li>

9792

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

9793

</li>

9794

<li>

9795

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

9796

</li>

9797

<li>

9798

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

9799

</li>

9800

<li>

9801

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

9802

</li>

9803

<li>

9804

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

9805

</li></p>

9806

9807

<p><li>

9808

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

9809

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

9810

</li>

9811

<li>

9812

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

9813

</li>

9814

</ul></p>

9815

</div>

9816

9817

9818

</li>

9819

9820

</ul>

9821

</div>

9822

9823

9824

9825

9826

<h4>Returns:</h4>

9827

9828

9829

9830

9831

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

9832

9833

the custom event

9834

9835

</div>

9836

</div>

9837

9838

9839

9840

</div>

9841

9842

9843

9844

9845

9846

9847

9848

9849

9850

9851

9852

<code>Sortable</code>

9853

9854

</li>

9855

9856

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

9857

</div>

9858

9859

9860

9861

9862

9863

9864

9865

9866

9867

9868

9869

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

9870

9871

9872

9873

9874

9875

9876

9877

9878

<p>

9879

9880

Defined in

9881

9882

9883

9884

9885

<a href="../files/sortable_js_sortable.js.html#l423"><code>sortable/js/sortable.js:423</code></a>

9886

9887

</p>

9888

9889

9890

9891

9892

9893

</div>

9894

9895

9896

<p>Register a Sortable instance with the singleton to allow lookups later.</p>

9897

</div>

9898

9899

9900

9901

<h4>Parameters:</h4>

9902

9903

9904

9905

9906

9907

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

9908

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

9909

9910

9911

9912

9913

9914

<p>s A Sortable instance.</p>

9915

</div>

9916

9917

9918

</li>

9919

9920

</ul>

9921

</div>

9922

9923

9924

9925

9926

9927

</div>

9928

9929

9930

9931

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

9932

9933

9934

9935

9936

9937

9938

9939

9940

9941

</li>

9942

9943

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

9944

</div>

9945

9946

9947

9948

9949

9950

9951

9952

9953

9954

9955

9956

9957

9958

9959

9960

9961

9962

<p>Inherited from

9963

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

9964

9965

9966

9967

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

9968

9969

</p>

9970

9971

9972

9973

9974

9975

</div>

9976

9977

9978

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

9979

</div>

9980

9981

9982

9983

<h4>Parameters:</h4>

9984

9985

9986

9987

9988

9989

9990

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

9991

9992

9993

9994

9995

9996

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

9997

</div>

9998

9999

10000

</li>

10001

10002

</ul>

10003

</div>

10004

10005

10006

10007

10008

10009

</div>

10010

10011

10012

10013

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

10014

10015

10016

10017

10018

10019

10020

10021

10022

10023

</li>

10024

10025

</ul><span class="paren">)</span>

10026

</div>

10027

10028

10029

10030

10031

10032

10033

10034

10035

10036

10037

10038

10039

10040

10041

10042

10043

10044

<p>Inherited from

10045

<a href="../classes/EventTarget.html#method_removeTarget">EventTarget</a>:

10046

10047

10048

10049

<a href="../files/event-custom_js_event-facade.js.html#l409"><code>event-custom/js/event-facade.js:409</code></a>

10050

10051

</p>

10052

10053

10054

10055

10056

10057

</div>

10058

10059

10060

<p>Removes a bubble target</p>

10061

</div>

10062

10063

10064

10065

<h4>Parameters:</h4>

10066

10067

10068

10069

10070

10071

10072

<span class="type"><a href="../classes/EventTarget.html" class="crosslink">EventTarget</a></span>

10073

10074

10075

10076

10077

10078

<p>the target to remove</p>

10079

</div>

10080

10081

10082

</li>

10083

10084

</ul>

10085

</div>

10086

10087

10088

10089

10090

10091

</div>

10092

10093

10094

10095

<h3 class="name"><code>reset</code></h3>

10096

10097

10098

10099

10100

10101

10102

10103

10104

10105

</li>

10106

10107

</ul><span class="paren">)</span>

10108

</div>

10109

10110

10111

10112

10113

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>

10114

</span>

10115

10116

10117

10118

10119

10120

10121

10122

10123

10124

10125

10126

<span class="flag chainable">chainable</span>

10127

10128

10129

10130

10131

10132

<p>Inherited from

10133

<a href="../classes/AttributeExtras.html#method_reset">AttributeExtras</a>:

10134

10135

10136

10137

<a href="../files/attribute_js_AttributeExtras.js.html#l87"><code>attribute/js/AttributeExtras.js:87</code></a>

10138

10139

</p>

10140

10141

10142

10143

10144

10145

</div>

10146

10147

10148

<p>Resets the attribute (or all attributes) to its initial value, as long as

10149

the attribute is not readOnly, or writeOnce.</p>

10150

</div>

10151

10152

10153

10154

<h4>Parameters:</h4>

10155

10156

10157

10158

10159

10160

10161

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

10162

10163

10164

10165

10166

10167

<p>Optional. The name of the attribute to reset. If omitted, all attributes are reset.</p>

10168

</div>

10169

10170

10171

</li>

10172

10173

</ul>

10174

</div>

10175

10176

10177

10178

10179

<h4>Returns:</h4>

10180

10181

10182

10183

10184

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>:

10185

10186

A reference to the host object.

10187

10188

</div>

10189

</div>

10190

10191

10192

10193

</div>

10194

10195

10196

10197

10198

10199

10200

10201

10202

10203

10204

10205

10206

10207

</li>

10208

10209

10210

10211

<code>value</code>

10212

10213

</li>

10214

10215

</ul><span class="paren">)</span>

10216

</div>

10217

10218

10219

10220

10221

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>

10222

</span>

10223

10224

10225

10226

10227

10228

10229

10230

10231

10232

10233

10234

<span class="flag chainable">chainable</span>

10235

10236

10237

10238

10239

<p>Inherited from

10240

10241

AttributeEvents

10242

</a>

10243

10244

but overwritten in

10245

10246

10247

10248

<a href="../files/attribute_js_AttributeCore.js.html#l328"><code>attribute/js/AttributeCore.js:328</code></a>

10249

10250

</p>

10251

10252

10253

10254

10255

10256

</div>

10257

10258

10259

<p>Sets the value of an attribute.</p>

10260

</div>

10261

10262

10263

10264

<h4>Parameters:</h4>

10265

10266

10267

10268

10269

10270

10271

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

10272

10273

10274

10275

10276

10277

<p>The name of the attribute. If the

10278

current value of the attribute is an Object, dot notation can be used

10279

to set the value of a property within the object (e.g. <code>set("x.y.z", 5)</code>).</p>

10280

</div>

10281

10282

10283

</li>

10284

10285

10286

10287

<code class="param-name">value</code>

10288

10289

10290

10291

10292

10293

10294

<p>The value to set the attribute to.</p>

10295

</div>

10296

10297

10298

</li>

10299

10300

</ul>

10301

</div>

10302

10303

10304

10305

10306

<h4>Returns:</h4>

10307

10308

10309

10310

10311

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>:

10312

10313

A reference to the host object.

10314

10315

</div>

10316

</div>

10317

10318

10319

10320

</div>

10321

10322

10323

10324

<h3 class="name"><code>setAttrs</code></h3>

10325

10326

10327

10328

10329

10330

10331

10332

<code>attrs</code>

10333

10334

</li>

10335

10336

</ul><span class="paren">)</span>

10337

</div>

10338

10339

10340

10341

10342

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>

10343

</span>

10344

10345

10346

10347

10348

10349

10350

10351

10352

10353

10354

10355

<span class="flag chainable">chainable</span>

10356

10357

10358

10359

10360

<p>Inherited from

10361

10362

AttributeEvents

10363

</a>

10364

10365

but overwritten in

10366

10367

10368

10369

<a href="../files/attribute_js_AttributeCore.js.html#l635"><code>attribute/js/AttributeCore.js:635</code></a>

10370

10371

</p>

10372

10373

10374

10375

10376

10377

</div>

10378

10379

10380

<p>Sets multiple attribute values.</p>

10381

</div>

10382

10383

10384

10385

<h4>Parameters:</h4>

10386

10387

10388

10389

10390

10391

<code class="param-name">attrs</code>

10392

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>

10393

10394

10395

10396

10397

10398

<p>An object with attributes name/value pairs.</p>

10399

</div>

10400

10401

10402

</li>

10403

10404

</ul>

10405

</div>

10406

10407

10408

10409

10410

<h4>Returns:</h4>

10411

10412

10413

10414

10415

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>:

10416

10417

A reference to the host object.

10418

10419

</div>

10420

</div>

10421

10422

10423

10424

</div>

10425

10426

10427

10428

<h3 class="name"><code>subscribe</code></h3>

10429

10430

10431

10432

10433

10434

10435

10436

10437

<span class="flag deprecated" title="use on">deprecated</span>

10438

10439

10440

10441

10442

10443

10444

10445

10446

10447

10448

10449

10450

10451

<p>Inherited from

10452

<a href="../classes/EventTarget.html#method_subscribe">EventTarget</a>:

10453

10454

10455

10456

<a href="../files/event-custom_js_event-target.js.html#l335"><code>event-custom/js/event-target.js:335</code></a>

10457

10458

</p>

10459

10460

10461

10462

<p>Deprecated: use on</p>

10463

10464

10465

10466

</div>

10467

10468

10469

<p>subscribe to an event</p>

10470

</div>

10471

10472

10473

10474

10475

10476

10477

</div>

10478

10479

10480

10481

10482

10483

10484

10485

10486

10487

10488

10489

10490

10491

10492

10493

10494

10495

10496

10497

10498

<span class="flag chainable">chainable</span>

10499

10500

10501

10502

10503

10504

10505

<p>

10506

10507

Defined in

10508

10509

10510

10511

10512

<a href="../files/sortable_js_sortable.js.html#l216"><code>sortable/js/sortable.js:216</code></a>

10513

10514

</p>

10515

10516

10517

10518

10519

10520

</div>

10521

10522

10523

<p>Passthrough to the DD.Delegate syncTargets method.</p>

10524

</div>

10525

10526

10527

10528

10529

10530

10531

</div>

10532

10533

10534

10535

<h3 class="name"><code>toString</code></h3>

10536

10537

10538

10539

10540

10541

10542

10543

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

10544

</span>

10545

10546

10547

10548

10549

10550

10551

10552

10553

10554

10555

10556

10557

10558

10559

10560

<p>Inherited from

10561

<a href="../classes/BaseCore.html#method_toString">BaseCore</a>:

10562

10563

10564

10565

<a href="../files/base_js_BaseCore.js.html#l592"><code>base/js/BaseCore.js:592</code></a>

10566

10567

</p>

10568

10569

10570

10571

10572

10573

</div>

10574

10575

10576

<p>Default toString implementation. Provides the constructor NAME

10577

and the instance guid, if set.</p>

10578

</div>

10579

10580

10581

10582

10583

10584

<h4>Returns:</h4>

10585

10586

10587

10588

10589

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>:

10590

10591

String representation for this object

10592

10593

</div>

10594

</div>

10595

10596

10597

10598

</div>

10599

10600

10601

10602

<h3 class="name"><code>unreg</code></h3>

10603

10604

10605

10606

10607

10608

10609

10610

<code>Sortable</code>

10611

10612

</li>

10613

10614

</ul><span class="paren">)</span>

10615

</div>

10616

10617

10618

10619

10620

10621

10622

10623

10624

10625

10626

10627

<span class="flag static">static</span>

10628

10629

10630

10631

10632

10633

10634

10635

10636

<p>

10637

10638

Defined in

10639

10640

10641

10642

10643

<a href="../files/sortable_js_sortable.js.html#l432"><code>sortable/js/sortable.js:432</code></a>

10644

10645

</p>

10646

10647

10648

10649

10650

10651

</div>

10652

10653

10654

<p>Unregister a Sortable instance with the singleton.</p>

10655

</div>

10656

10657

10658

10659

<h4>Parameters:</h4>

10660

10661

10662

10663

10664

10665

<code class="param-name">Sortable</code>

10666

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>

10667

10668

10669

10670

10671

10672

<p>s A Sortable instance.</p>

10673

</div>

10674

10675

10676

</li>

10677

10678

</ul>

10679

</div>

10680

10681

10682

10683

10684

10685

</div>

10686

10687

10688

10689

<h3 class="name"><code>unsubscribe</code></h3>

10690

10691

10692

10693

10694

10695

10696

10697

10698

<span class="flag deprecated" title="use detach">deprecated</span>

10699

10700

10701

10702

10703

10704

10705

10706

10707

10708

10709

10710

10711

10712

<p>Inherited from

10713

<a href="../classes/EventTarget.html#method_unsubscribe">EventTarget</a>:

10714

10715

10716

10717

<a href="../files/event-custom_js_event-target.js.html#l455"><code>event-custom/js/event-target.js:455</code></a>

10718

10719

</p>

10720

10721

10722

10723

<p>Deprecated: use detach</p>

10724

10725

10726

10727

</div>

10728

10729

10730

<p>detach a listener</p>

10731

</div>

10732

10733

10734

10735

10736

10737

10738

</div>

10739

10740

10741

10742

<h3 class="name"><code>unsubscribeAll</code></h3>

10743

10744

10745

10746

10747

10748

10749

10750

10751

10752

</li>

10753

10754

</ul><span class="paren">)</span>

10755

</div>

10756

10757

10758

10759

10760

10761

<span class="flag deprecated" title="use detachAll">deprecated</span>

10762

10763

10764

10765

10766

10767

10768

10769

10770

10771

10772

10773

10774

10775

<p>Inherited from

10776

<a href="../classes/EventTarget.html#method_unsubscribeAll">EventTarget</a>:

10777

10778

10779

10780

<a href="../files/event-custom_js_event-target.js.html#l476"><code>event-custom/js/event-target.js:476</code></a>

10781

10782

</p>

10783

10784

10785

10786

<p>Deprecated: use detachAll</p>

10787

10788

10789

10790

</div>

10791

10792

10793

<p>Removes all listeners from the specified event. If the event type

10794

is not specified, all listeners from all hosted custom events will

10795

be removed.</p>

10796

</div>

10797

10798

10799

10800

<h4>Parameters:</h4>

10801

10802

10803

10804

10805

10806

10807

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

10808

10809

10810

10811

10812

10813

<p>The type, or name of the event</p>

10814

</div>

10815

10816

10817

</li>

10818

10819

</ul>

10820

</div>

10821

10822

10823

10824

10825

10826

</div>

10827

10828

10829

</div>

10830

10831

10832

10833

10834

<h2 class="off-left">Properties</h2>

10835

10836

10837

10838

<h3 class="name"><code>_allowAdHocAttrs</code></h3>

10839

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>

10840

10841

10842

10843

10844

<span class="flag protected">protected</span>

10845

10846

10847

10848

10849

10850

10851

10852

10853

10854

<p>Inherited from

10855

<a href="../classes/BaseCore.html#property__allowAdHocAttrs">BaseCore</a>:

10856

10857

10858

10859

<a href="../files/base_js_BaseCore.js.html#l100"><code>base/js/BaseCore.js:100</code></a>

10860

10861

</p>

10862

10863

10864

10865

10866

</div>

10867

10868

10869

<p>This property controls whether or not instances of this class should

10870

allow users to add ad-hoc attributes through the constructor configuration

10871

hash.</p>

10872

10873

<p>AdHoc attributes are attributes which are not defined by the class, and are

10874

not handled by the MyClass.<em>NON</em>ATTRS_CFG</p>

10875

</div>

10876

10877

10878

<p><strong>Default:</strong> undefined (false)</p>

10879

10880

10881

10882

10883

10884

</div>

10885

10886

10887

10888

<h3 class="name"><code>_sortables</code></h3>

10889

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Array" class="crosslink external" target="_blank">Array</a></span>

10890

10891

10892

10893

10894

<span class="flag private">private</span>

10895

10896

10897

10898

10899

10900

<span class="flag static">static</span>

10901

10902

10903

10904

10905

10906

10907

<p>

10908

10909

Defined in

10910

10911

10912

10913

10914

<a href="../files/sortable_js_sortable.js.html#l385"><code>sortable/js/sortable.js:385</code></a>

10915

10916

</p>

10917

10918

10919

10920

10921

</div>

10922

10923

10924

<p>Hash map of all Sortables on the page.</p>

10925

</div>

10926

10927

10928

10929

10930

10931

10932

</div>

10933

10934

10935

10936

<h3 class="name"><code>delegate</code></h3>

10937

<span class="type"><a href="../classes/DD.Delegate.html" class="crosslink">DD.Delegate</a></span>

10938

10939

10940

10941

10942

10943

10944

10945

10946

10947

10948

10949

10950

10951

<p>

10952

10953

Defined in

10954

10955

10956

10957

10958

<a href="../files/sortable_js_sortable.js.html#l29"><code>sortable/js/sortable.js:29</code></a>

10959

10960

</p>

10961

10962

10963

10964

10965

</div>

10966

10967

10968

<p>A reference to the DD.Delegate instance.</p>

10969

</div>

10970

10971

10972

10973

10974

10975

10976

</div>

10977

10978

10979

10980

10981

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

10982

10983

10984

<span class="flag deprecated" title="Use this.constructor.NAME">deprecated</span>

10985

10986

10987

10988

10989

10990

10991

10992

10993

10994

10995

10996

<p>Inherited from

10997

<a href="../classes/BaseCore.html#property_name">BaseCore</a>:

10998

10999

11000

11001

<a href="../files/base_js_BaseCore.js.html#l196"><code>base/js/BaseCore.js:196</code></a>

11002

11003

</p>

11004

11005

11006

<p>Deprecated: Use this.constructor.NAME</p>

11007

11008

11009

11010

</div>

11011

11012

11013

<p>The string used to identify the class of this object.</p>

11014

</div>

11015

11016

11017

11018

11019

11020

11021

</div>

11022

11023

11024

</div>

11025

11026

11027

11028

11029

<h2 class="off-left">Attributes</h2>

11030

11031

11032

11033

11034

<h3 class="name"><code>container</code></h3>

11035

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

11036

11037

11038

11039

11040

11041

11042

11043

11044

11045

11046

11047

11048

11049

<p>

11050

11051

Defined in

11052

11053

11054

11055

11056

<a href="../files/sortable_js_sortable.js.html#l328"><code>sortable/js/sortable.js:328</code></a>

11057

11058

</p>

11059

11060

11061

11062

11063

</div>

11064

11065

11066

<p>A selector query to get the container to listen for mousedown events on. All "nodes" should be a child of this container.</p>

11067

</div>

11068

11069

11070

11071

11072

11073

<h4>Fires event <code>containerChange</code></h4>

11074

11075

<p>

11076

Fires when the value for the configuration attribute <code>container</code> is

11077

changed. You can listen for the event using the <code>on</code> method if you

11078

wish to be notified before the attribute's value has changed, or

11079

using the <code>after</code> method if you wish to be notified after the

11080

attribute's value has changed.

11081

</p>

11082

11083

11084

<h4>Parameters:</h4>

11085

11086

11087

11088

11089

<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>

11090

11091

11092

An Event Facade object with the following

11093

attribute-specific properties added:

11094

</div>

11095

11096

11097

11098

<code class="param-name">prevVal</code>

11099

11100

<div class="param-description">The value of the attribute, prior to it being set.</div>

11101

</li>

11102

11103

<code class="param-name">newVal</code>

11104

11105

<div class="param-description">The value the attribute is to be set to.</div>

11106

</li>

11107

11108

<code class="param-name">attrName</code>

11109

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

11110

<div class="param-description">The name of the attribute being set.</div>

11111

</li>

11112

11113

<code class="param-name">subAttrName</code>

11114

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

11115

<div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div>

11116

</li>

11117

</ul>

11118

</li>

11119

</ul>

11120

</div>

11121

</div>

11122

11123

11124

11125

</div>

11126

11127

11128

11129

11130

<h3 class="name"><code>destroyed</code></h3>

11131

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>

11132

11133

11134

11135

11136

11137

11138

11139

11140

11141

11142

11143

11144

<p>Inherited from

11145

<a href="../classes/BaseCore.html#attr_destroyed">BaseCore</a>:

11146

11147

11148

11149

<a href="../files/base_js_BaseCore.js.html#l157"><code>base/js/BaseCore.js:157</code></a>

11150

11151

</p>

11152

11153

11154

11155

11156

</div>

11157

11158

11159

<p>Flag indicating whether or not this object

11160

has been through the destroy lifecycle phase.</p>

11161

</div>

11162

11163

11164

<p><strong>Default:</strong> false</p>

11165

11166

11167

11168

11169

<h4>Fires event <code>destroyedChange</code></h4>

11170

11171

<p>

11172

Fires when the value for the configuration attribute <code>destroyed</code> is

11173

changed. You can listen for the event using the <code>on</code> method if you

11174

wish to be notified before the attribute's value has changed, or

11175

using the <code>after</code> method if you wish to be notified after the

11176

attribute's value has changed.

11177

</p>

11178

11179

11180

<h4>Parameters:</h4>

11181

11182

11183

11184

11185

<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>

11186

11187

11188

An Event Facade object with the following

11189

attribute-specific properties added:

11190

</div>

11191

11192

11193

11194

<code class="param-name">prevVal</code>

11195

11196

<div class="param-description">The value of the attribute, prior to it being set.</div>

11197

</li>

11198

11199

<code class="param-name">newVal</code>

11200

11201

<div class="param-description">The value the attribute is to be set to.</div>

11202

</li>

11203

11204

<code class="param-name">attrName</code>

11205

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

11206

<div class="param-description">The name of the attribute being set.</div>

11207

</li>

11208

11209

<code class="param-name">subAttrName</code>

11210

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

11211

<div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div>

11212

</li>

11213

</ul>

11214

</li>

11215

</ul>

11216

</div>

11217

</div>

11218

11219

11220

11221

</div>

11222

11223

11224

11225

11226

<h3 class="name"><code>handles</code></h3>

11227

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Array" class="crosslink external" target="_blank">Array</a></span>

11228

11229

11230

11231

11232

11233

11234

11235

11236

11237

11238

11239

11240

11241

<p>

11242

11243

Defined in

11244

11245

11246

11247

11248

<a href="../files/sortable_js_sortable.js.html#l320"><code>sortable/js/sortable.js:320</code></a>

11249

11250

</p>

11251

11252

11253

11254

11255

</div>

11256

11257

11258

<p>Drag handles to pass on to the internal DD.Delegate instance.</p>

11259

</div>

11260

11261

11262

11263

11264

11265

<h4>Fires event <code>handlesChange</code></h4>

11266

11267

<p>

11268

Fires when the value for the configuration attribute <code>handles</code> is

11269

changed. You can listen for the event using the <code>on</code> method if you

11270

wish to be notified before the attribute's value has changed, or

11271

using the <code>after</code> method if you wish to be notified after the

11272

attribute's value has changed.

11273

</p>

11274

11275

11276

<h4>Parameters:</h4>

11277

11278

11279

11280

11281

<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>

11282

11283

11284

An Event Facade object with the following

11285

attribute-specific properties added:

11286

</div>

11287

11288

11289

11290

<code class="param-name">prevVal</code>

11291

11292

<div class="param-description">The value of the attribute, prior to it being set.</div>

11293

</li>

11294

11295

<code class="param-name">newVal</code>

11296

11297

<div class="param-description">The value the attribute is to be set to.</div>

11298

</li>

11299

11300

<code class="param-name">attrName</code>

11301

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

11302

<div class="param-description">The name of the attribute being set.</div>

11303

</li>

11304

11305

<code class="param-name">subAttrName</code>

11306

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

11307

<div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div>

11308

</li>

11309

</ul>

11310

</li>

11311

</ul>

11312

</div>

11313

</div>

11314

11315

11316

11317

</div>

11318

11319

11320

11321

11322

11323

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

11324

11325

11326

11327

11328

11329

11330

11331

11332

11333

11334

11335

11336

11337

<p>

11338

11339

Defined in

11340

11341

11342

11343

11344

<a href="../files/sortable_js_sortable.js.html#l360"><code>sortable/js/sortable.js:360</code></a>

11345

11346

</p>

11347

11348

11349

11350

11351

</div>

11352

11353

11354

<p>The id of this Sortable, used to get a reference to this Sortable list from another list.</p>

11355

</div>

11356

11357

11358

11359

11360

11361

<h4>Fires event <code>idChange</code></h4>

11362

11363

<p>

11364

Fires when the value for the configuration attribute <code>id</code> is

11365

changed. You can listen for the event using the <code>on</code> method if you

11366

wish to be notified before the attribute's value has changed, or

11367

using the <code>after</code> method if you wish to be notified after the

11368

attribute's value has changed.

11369

</p>

11370

11371

11372

<h4>Parameters:</h4>

11373

11374

11375

11376

11377

<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>

11378

11379

11380

An Event Facade object with the following

11381

attribute-specific properties added:

11382

</div>

11383

11384

11385

11386

<code class="param-name">prevVal</code>

11387

11388

<div class="param-description">The value of the attribute, prior to it being set.</div>

11389

</li>

11390

11391

<code class="param-name">newVal</code>

11392

11393

<div class="param-description">The value the attribute is to be set to.</div>

11394

</li>

11395

11396

<code class="param-name">attrName</code>

11397

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

11398

<div class="param-description">The name of the attribute being set.</div>

11399

</li>

11400

11401

<code class="param-name">subAttrName</code>

11402

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

11403

<div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div>

11404

</li>

11405

</ul>

11406

</li>

11407

</ul>

11408

</div>

11409

</div>

11410

11411

11412

11413

</div>

11414

11415

11416

11417

11418

<h3 class="name"><code>initialized</code></h3>

11419

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>

11420

11421

11422

11423

11424

11425

11426

11427

11428

11429

11430

11431

11432

<p>Inherited from

11433

<a href="../classes/BaseCore.html#attr_initialized">BaseCore</a>:

11434

11435

11436

11437

<a href="../files/base_js_BaseCore.js.html#l143"><code>base/js/BaseCore.js:143</code></a>

11438

11439

</p>

11440

11441

11442

11443

11444

</div>

11445

11446

11447

<p>Flag indicating whether or not this object

11448

has been through the init lifecycle phase.</p>

11449

</div>

11450

11451

11452

<p><strong>Default:</strong> false</p>

11453

11454

11455

11456

11457

<h4>Fires event <code>initializedChange</code></h4>

11458

11459

<p>

11460

Fires when the value for the configuration attribute <code>initialized</code> is

11461

changed. You can listen for the event using the <code>on</code> method if you

11462

wish to be notified before the attribute's value has changed, or

11463

using the <code>after</code> method if you wish to be notified after the

11464

attribute's value has changed.

11465

</p>

11466

11467

11468

<h4>Parameters:</h4>

11469

11470

11471

11472

11473

<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>

11474

11475

11476

An Event Facade object with the following

11477

attribute-specific properties added:

11478

</div>

11479

11480

11481

11482

<code class="param-name">prevVal</code>

11483

11484

<div class="param-description">The value of the attribute, prior to it being set.</div>

11485

</li>

11486

11487

<code class="param-name">newVal</code>

11488

11489

<div class="param-description">The value the attribute is to be set to.</div>

11490

</li>

11491

11492

<code class="param-name">attrName</code>

11493

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

11494

<div class="param-description">The name of the attribute being set.</div>

11495

</li>

11496

11497

<code class="param-name">subAttrName</code>

11498

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

11499

<div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div>

11500

</li>

11501

</ul>

11502

</li>

11503

</ul>

11504

</div>

11505

</div>

11506

11507

11508

11509

</div>

11510

11511

11512

11513

11514

<h3 class="name"><code>invalid</code></h3>

11515

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

11516

11517

11518

11519

11520

11521

11522

11523

11524

11525

11526

11527

11528

11529

<p>

11530

11531

Defined in

11532

11533

11534

11535

11536

<a href="../files/sortable_js_sortable.js.html#l376"><code>sortable/js/sortable.js:376</code></a>

11537

11538

</p>

11539

11540

11541

11542

11543

</div>

11544

11545

11546

<p>A selector string to test if a list item is invalid and not sortable</p>

11547

</div>

11548

11549

11550

11551

11552

11553

<h4>Fires event <code>invalidChange</code></h4>

11554

11555

<p>

11556

Fires when the value for the configuration attribute <code>invalid</code> is

11557

changed. You can listen for the event using the <code>on</code> method if you

11558

wish to be notified before the attribute's value has changed, or

11559

using the <code>after</code> method if you wish to be notified after the

11560

attribute's value has changed.

11561

</p>

11562

11563

11564

<h4>Parameters:</h4>

11565

11566

11567

11568

11569

<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>

11570

11571

11572

An Event Facade object with the following

11573

attribute-specific properties added:

11574

</div>

11575

11576

11577

11578

<code class="param-name">prevVal</code>

11579

11580

<div class="param-description">The value of the attribute, prior to it being set.</div>

11581

</li>

11582

11583

<code class="param-name">newVal</code>

11584

11585

<div class="param-description">The value the attribute is to be set to.</div>

11586

</li>

11587

11588

<code class="param-name">attrName</code>

11589

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

11590

<div class="param-description">The name of the attribute being set.</div>

11591

</li>

11592

11593

<code class="param-name">subAttrName</code>

11594

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

11595

<div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div>

11596

</li>

11597

</ul>

11598

</li>

11599

</ul>

11600

</div>

11601

</div>

11602

11603

11604

11605

</div>

11606

11607

11608

11609

11610

<h3 class="name"><code>moveType</code></h3>

11611

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

11612

11613

11614

11615

11616

11617

11618

11619

11620

11621

11622

11623

11624

11625

<p>

11626

11627

Defined in

11628

11629

11630

11631

11632

<a href="../files/sortable_js_sortable.js.html#l368"><code>sortable/js/sortable.js:368</code></a>

11633

11634

</p>

11635

11636

11637

11638

11639

</div>

11640

11641

11642

<p>How should an item move to another list: insert, swap, move, copy. Default: insert</p>

11643

</div>

11644

11645

11646

11647

11648

11649

<h4>Fires event <code>moveTypeChange</code></h4>

11650

11651

<p>

11652

Fires when the value for the configuration attribute <code>moveType</code> is

11653

changed. You can listen for the event using the <code>on</code> method if you

11654

wish to be notified before the attribute's value has changed, or

11655

using the <code>after</code> method if you wish to be notified after the

11656

attribute's value has changed.

11657

</p>

11658

11659

11660

<h4>Parameters:</h4>

11661

11662

11663

11664

11665

<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>

11666

11667

11668

An Event Facade object with the following

11669

attribute-specific properties added:

11670

</div>

11671

11672

11673

11674

<code class="param-name">prevVal</code>

11675

11676

<div class="param-description">The value of the attribute, prior to it being set.</div>

11677

</li>

11678

11679

<code class="param-name">newVal</code>

11680

11681

<div class="param-description">The value the attribute is to be set to.</div>

11682

</li>

11683

11684

<code class="param-name">attrName</code>

11685

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

11686

<div class="param-description">The name of the attribute being set.</div>

11687

</li>

11688

11689

<code class="param-name">subAttrName</code>

11690

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

11691

<div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div>

11692

</li>

11693

</ul>

11694

</li>

11695

</ul>

11696

</div>

11697

</div>

11698

11699

11700

11701

</div>

11702

11703

11704

11705

11706

<h3 class="name"><code>nodes</code></h3>

11707

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

11708

11709

11710

11711

11712

11713

11714

11715

11716

11717

11718

11719

11720

11721

<p>

11722

11723

Defined in

11724

11725

11726

11727

11728

<a href="../files/sortable_js_sortable.js.html#l336"><code>sortable/js/sortable.js:336</code></a>

11729

11730

</p>

11731

11732

11733

11734

11735

</div>

11736

11737

11738

<p>A selector query to get the children of the "container" to make draggable elements from.</p>

11739

</div>

11740

11741

11742

11743

11744

11745

<h4>Fires event <code>nodesChange</code></h4>

11746

11747

<p>

11748

Fires when the value for the configuration attribute <code>nodes</code> is

11749

changed. You can listen for the event using the <code>on</code> method if you

11750

wish to be notified before the attribute's value has changed, or

11751

using the <code>after</code> method if you wish to be notified after the

11752

attribute's value has changed.

11753

</p>

11754

11755

11756

<h4>Parameters:</h4>

11757

11758

11759

11760

11761

<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>

11762

11763

11764

An Event Facade object with the following

11765

attribute-specific properties added:

11766

</div>

11767

11768

11769

11770

<code class="param-name">prevVal</code>

11771

11772

<div class="param-description">The value of the attribute, prior to it being set.</div>

11773

</li>

11774

11775

<code class="param-name">newVal</code>

11776

11777

<div class="param-description">The value the attribute is to be set to.</div>

11778

</li>

11779

11780

<code class="param-name">attrName</code>

11781

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

11782

<div class="param-description">The name of the attribute being set.</div>

11783

</li>

11784

11785

<code class="param-name">subAttrName</code>

11786

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

11787

<div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div>

11788

</li>

11789

</ul>

11790

</li>

11791

</ul>

11792

</div>

11793

</div>

11794

11795

11796

11797

</div>

11798

11799

11800

11801

11802

<h3 class="name"><code>opacity</code></h3>

11803

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

11804

11805

11806

11807

11808

11809

11810

11811

11812

11813

11814

11815

11816

11817

<p>

11818

11819

Defined in

11820

11821

11822

11823

11824

<a href="../files/sortable_js_sortable.js.html#l344"><code>sortable/js/sortable.js:344</code></a>

11825

11826

</p>

11827

11828

11829

11830

11831

</div>

11832

11833

11834

<p>The opacity to change the proxy item to when dragging.</p>

11835

</div>

11836

11837

11838

11839

11840

11841

<h4>Fires event <code>opacityChange</code></h4>

11842

11843

<p>

11844

Fires when the value for the configuration attribute <code>opacity</code> is

11845

changed. You can listen for the event using the <code>on</code> method if you

11846

wish to be notified before the attribute's value has changed, or

11847

using the <code>after</code> method if you wish to be notified after the

11848

attribute's value has changed.

11849

</p>

11850

11851

11852

<h4>Parameters:</h4>

11853

11854

11855

11856

11857

<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>

11858

11859

11860

An Event Facade object with the following

11861

attribute-specific properties added:

11862

</div>

11863

11864

11865

11866

<code class="param-name">prevVal</code>

11867

11868

<div class="param-description">The value of the attribute, prior to it being set.</div>

11869

</li>

11870

11871

<code class="param-name">newVal</code>

11872

11873

<div class="param-description">The value the attribute is to be set to.</div>

11874

</li>

11875

11876

<code class="param-name">attrName</code>

11877

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

11878

<div class="param-description">The name of the attribute being set.</div>

11879

</li>

11880

11881

<code class="param-name">subAttrName</code>

11882

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

11883

<div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div>

11884

</li>

11885

</ul>

11886

</li>

11887

</ul>

11888

</div>

11889

</div>

11890

11891

11892

11893

</div>

11894

11895

11896

11897

11898

<h3 class="name"><code>opacityNode</code></h3>

11899

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

11900

11901

11902

11903

11904

11905

11906

11907

11908

11909

11910

11911

11912

11913

<p>

11914

11915

Defined in

11916

11917

11918

11919

11920

<a href="../files/sortable_js_sortable.js.html#l352"><code>sortable/js/sortable.js:352</code></a>

11921

11922

</p>

11923

11924

11925

11926

11927

</div>

11928

11929

11930

<p>The node to set opacity on when dragging (dragNode or currentNode). Default: currentNode.</p>

11931

</div>

11932

11933

11934

11935

11936

11937

<h4>Fires event <code>opacityNodeChange</code></h4>

11938

11939

<p>

11940

Fires when the value for the configuration attribute <code>opacityNode</code> is

11941

changed. You can listen for the event using the <code>on</code> method if you

11942

wish to be notified before the attribute's value has changed, or

11943

using the <code>after</code> method if you wish to be notified after the

11944

attribute's value has changed.

11945

</p>

11946

11947

11948

<h4>Parameters:</h4>

11949

11950

11951

11952

11953

<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>

11954

11955

11956

An Event Facade object with the following

11957

attribute-specific properties added:

11958

</div>

11959

11960

11961

11962

<code class="param-name">prevVal</code>

11963

11964

<div class="param-description">The value of the attribute, prior to it being set.</div>

11965

</li>

11966

11967

<code class="param-name">newVal</code>

11968

11969

<div class="param-description">The value the attribute is to be set to.</div>

11970

</li>

11971

11972

<code class="param-name">attrName</code>

11973

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

11974

<div class="param-description">The name of the attribute being set.</div>

11975

</li>

11976

11977

<code class="param-name">subAttrName</code>

11978

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

11979

<div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div>

11980

</li>

11981

</ul>

11982

</li>

11983

</ul>

11984

</div>

11985

</div>

11986

11987

11988

11989

</div>

11990

11991

11992

</div>

11993

11994

11995

11996

11997

<h2 class="off-left">Events</h2>

11998

11999

12000

12001

12002

<span class="type">Event.Custom</span>

12003

12004

12005

12006

12007

12008

12009

12010

12011

12012

12013

12014

12015

12016

<p>

12017

12018

Defined in

12019

12020

12021

12022

12023

<a href="../files/sortable_js_sortable.js.html#l450"><code>sortable/js/sortable.js:450</code></a>

12024

12025

</p>

12026

12027

12028

12029

12030

</div>

12031

12032

12033

<p>A Sortable node was moved with a copy.</p>

12034

</div>

12035

12036

12037

12038

<h4>Event Payload:</h4>

12039

12040

12041

12042

12043

12044

<code class="param-name">event</code>

12045

<span class="type"><a href="../classes/EventFacade.html" class="crosslink">Event.Facade</a></span>

12046

12047

12048

12049

12050

12051

<p>An Event Facade object</p>

12052

</div>

12053

12054

12055

12056

12057

12058

12059

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>

12060

12061

12062

<p>Moved to the same list.</p>

12063

</div>

12064

12065

12066

</li>

12067

12068

12069

12070

12071

12072

12073

<p>The drag instance.</p>

12074

</div>

12075

12076

12077

</li>

12078

12079

12080

12081

12082

12083

12084

<p>The drop instance.</p>

12085

</div>

12086

12087

12088

</li>

12089

12090

</ul>

12091

12092

</li>

12093

12094

</ul>

12095

</div>

12096

12097

12098

12099

12100

</div>

12101

12102

12103

12104

<h3 class="name"><code>destroy</code></h3>

12105

12106

12107

12108

12109

12110

12111

12112

12113

12114

12115

12116

12117

12118

<p>Inherited from

12119

<a href="../classes/Base.html#event_destroy">Base</a>:

12120

12121

12122

12123

12124

12125

</p>

12126

12127

12128

12129

12130

</div>

12131

12132

12133

<p>

12134

Lifecycle event for the destroy phase,

12135

fired prior to destruction. Invoking the preventDefault

12136

method on the event object provided to subscribers will

12137

prevent destruction from proceeding.

12138

</p>

12139

12140

<p>

12141

Subscribers to the "after" moment of this event, will be notified

12142

after destruction is complete (and as a result cannot prevent

12143

destruction).

12144

</p>

12145

</div>

12146

12147

12148

12149

<h4>Event Payload:</h4>

12150

12151

12152

12153

12154

12155

12156

<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>

12157

12158

12159

12160

12161

12162

<p>Event object</p>

12163

</div>

12164

12165

12166

</li>

12167

12168

</ul>

12169

</div>

12170

12171

12172

12173

12174

</div>

12175

12176

12177

12178

12179

12180

12181

12182

12183

12184

12185

12186

12187

12188

12189

12190

12191

12192

<p>Inherited from

12193

<a href="../classes/Base.html#event_init">Base</a>:

12194

12195

12196

12197

12198

12199

</p>

12200

12201

12202

12203

12204

</div>

12205

12206

12207

<p>

12208

Lifecycle event for the init phase, fired prior to initialization.

12209

Invoking the preventDefault() method on the event object provided

12210

to subscribers will prevent initialization from occuring.

12211

</p>

12212

12213

<p>

12214

Subscribers to the "after" momemt of this event, will be notified

12215

after initialization of the object is complete (and therefore

12216

cannot prevent initialization).

12217

</p>

12218

</div>

12219

12220

12221

12222

<h4>Event Payload:</h4>

12223

12224

12225

12226

12227

12228

12229

<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>

12230

12231

12232

12233

12234

12235

<p>Event object, with a cfg property which

12236

refers to the configuration object passed to the constructor.</p>

12237

</div>

12238

12239

12240

</li>

12241

12242

</ul>

12243

</div>

12244

12245

12246

12247

12248

</div>

12249

12250

12251

12252

<h3 class="name"><code>insert</code></h3>

12253

<span class="type">Event.Custom</span>

12254

12255

12256

12257

12258

12259

12260

12261

12262

12263

12264

12265

12266

12267

<p>

12268

12269

Defined in

12270

12271

12272

12273

12274

<a href="../files/sortable_js_sortable.js.html#l468"><code>sortable/js/sortable.js:468</code></a>

12275

12276

</p>

12277

12278

12279

12280

12281

</div>

12282

12283

12284

<p>A Sortable node was moved with an insert.</p>

12285

</div>

12286

12287

12288

12289

<h4>Event Payload:</h4>

12290

12291

12292

12293

12294

12295

<code class="param-name">event</code>

12296

<span class="type"><a href="../classes/EventFacade.html" class="crosslink">Event.Facade</a></span>

12297

12298

12299

12300

12301

12302

<p>An Event Facade object with the following specific property added:</p>

12303

</div>

12304

12305

12306

12307

12308

12309

12310

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>

12311

12312

12313

<p>Moved to the same list.</p>

12314

</div>

12315

12316

12317

</li>

12318

12319

12320

12321

12322

12323

12324

<p>The drag instance.</p>

12325

</div>

12326

12327

12328

</li>

12329

12330

12331

12332

12333

12334

12335

<p>The drop instance.</p>

12336

</div>

12337

12338

12339

</li>

12340

12341

</ul>

12342

12343

</li>

12344

12345

</ul>

12346

</div>

12347

12348

12349

12350

12351

</div>

12352

12353

12354

12355

12356

<span class="type">Event.Custom</span>

12357

12358

12359

12360

12361

12362

12363

12364

12365

12366

12367

12368

12369

12370

<p>

12371

12372

Defined in

12373

12374

12375

12376

12377

<a href="../files/sortable_js_sortable.js.html#l459"><code>sortable/js/sortable.js:459</code></a>

12378

12379

</p>

12380

12381

12382

12383

12384

</div>

12385

12386

12387

<p>A Sortable node was moved with a move.</p>

12388

</div>

12389

12390

12391

12392

<h4>Event Payload:</h4>

12393

12394

12395

12396

12397

12398

<code class="param-name">event</code>

12399

<span class="type"><a href="../classes/EventFacade.html" class="crosslink">Event.Facade</a></span>

12400

12401

12402

12403

12404

12405

<p>An Event Facade object with the following specific property added:</p>

12406

</div>

12407

12408

12409

12410

12411

12412

12413

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>

12414

12415

12416

<p>Moved to the same list.</p>

12417

</div>

12418

12419

12420

</li>

12421

12422

12423

12424

12425

12426

12427

<p>The drag instance.</p>

12428

</div>

12429

12430

12431

</li>

12432

12433

12434

12435

12436

12437

12438

<p>The drop instance.</p>

12439

</div>

12440

12441

12442

</li>

12443

12444

</ul>

12445

12446

</li>

12447

12448

</ul>

12449

</div>

12450

12451

12452

12453

12454

</div>

12455

12456

12457

12458

<h3 class="name"><code>moved</code></h3>

12459

<span class="type">Event.Custom</span>

12460

12461

12462

12463

12464

12465

12466

12467

12468

12469

12470

12471

12472

12473

<p>

12474

12475

Defined in

12476

12477

12478

12479

12480

<a href="../files/sortable_js_sortable.js.html#l486"><code>sortable/js/sortable.js:486</code></a>

12481

12482

</p>

12483

12484

12485

12486

12487

</div>

12488

12489

12490

<p>A Sortable node was moved.</p>

12491

</div>

12492

12493

12494

12495

<h4>Event Payload:</h4>

12496

12497

12498

12499

12500

12501

<code class="param-name">event</code>

12502

<span class="type"><a href="../classes/EventFacade.html" class="crosslink">Event.Facade</a></span>

12503

12504

12505

12506

12507

12508

<p>An Event Facade object with the following specific property added:</p>

12509

</div>

12510

12511

12512

12513

12514

12515

12516

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>

12517

12518

12519

<p>Moved to the same list.</p>

12520

</div>

12521

12522

12523

</li>

12524

12525

12526

12527

12528

12529

12530

<p>The drag instance.</p>

12531

</div>

12532

12533

12534

</li>

12535

12536

12537

12538

12539

12540

12541

<p>The drop instance.</p>

12542

</div>

12543

12544

12545

</li>

12546

12547

</ul>

12548

12549

</li>

12550

12551

</ul>

12552

</div>

12553

12554

12555

12556

12557

</div>

12558

12559

12560

12561

12562

<span class="type">Event.Custom</span>

12563

12564

12565

12566

12567

12568

12569

12570

12571

12572

12573

12574

12575

12576

<p>

12577

12578

Defined in

12579

12580

12581

12582

12583

<a href="../files/sortable_js_sortable.js.html#l477"><code>sortable/js/sortable.js:477</code></a>

12584

12585

</p>

12586

12587

12588

12589

12590

</div>

12591

12592

12593

<p>A Sortable node was moved with a swap.</p>

12594

</div>

12595

12596

12597

12598

<h4>Event Payload:</h4>

12599

12600

12601

12602

12603

12604

<code class="param-name">event</code>

12605

<span class="type"><a href="../classes/EventFacade.html" class="crosslink">Event.Facade</a></span>

12606

12607

12608

12609

12610

12611

<p>An Event Facade object with the following specific property added:</p>

12612

</div>

12613

12614

12615

12616

12617

12618

12619

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>

12620

12621

12622

<p>Moved to the same list.</p>

12623

</div>

12624

12625

12626

</li>

12627

12628

12629

12630

12631

12632

12633

<p>The drag instance.</p>

12634

</div>

12635

12636

12637

</li>

12638

12639

12640

12641

12642

12643

12644

<p>The drop instance.</p>

12645

</div>

12646

12647

12648

</li>

12649

12650

</ul>

12651

12652

</li>

12653

12654

</ul>

12655

</div>

12656

12657

12658

12659

12660

</div>

12661

12662

12663

</div>

12664

12665

</div>

12666

</div>

12667

12668

</div>

12669

</div>

12670

</div>

12671

</div>

12672

</div>

12673

</div>

12674

12675

12676

12677

12678

12679

12680

12681

12682

</body>

12683

</html>

Older »