~bcsaller/juju-gui/charmFind

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

2287

2288

2289

2290

2291

2292

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

2293

</div>

2294

2295

2296

</li>

2297

2298

2299

2300

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

2301

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

2302

2303

2304

2305

2306

2307

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

2308

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

2309

</div>

2310

2311

2312

</li>

2313

2314

2315

2316

2317

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

2318

2319

2320

2321

2322

2323

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

2324

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

2325

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

2326

</div>

2327

2328

2329

</li>

2330

2331

</ul>

2332

</div>

2333

2334

2335

2336

2337

2338

</div>

2339

2340

2341

2342

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

2343

2344

2345

2346

2347

2348

2349

2350

2351

2352

</li>

2353

2354

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

2355

</div>

2356

2357

2358

2359

2360

2361

2362

2363

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

2364

2365

2366

2367

2368

2369

2370

2371

2372

2373

2374

2375

<p>Inherited from

2376

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

2377

2378

2379

2380

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

2381

2382

</p>

2383

2384

2385

2386

2387

2388

</div>

2389

2390

2391

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

2392

</div>

2393

2394

2395

2396

<h4>Parameters:</h4>

2397

2398

2399

2400

2401

2402

2403

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

2404

2405

2406

2407

2408

2409

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

2410

</div>

2411

2412

2413

</li>

2414

2415

</ul>

2416

</div>

2417

2418

2419

2420

2421

2422

</div>

2423

2424

2425

2426

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

2427

2428

2429

2430

2431

2432

2433

2434

<code>allAttrs</code>

2435

2436

</li>

2437

2438

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

2439

</div>

2440

2441

2442

2443

2444

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

2445

</span>

2446

2447

2448

2449

2450

2451

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

2452

2453

2454

2455

2456

2457

2458

2459

2460

2461

2462

2463

<p>Inherited from

2464

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

2465

2466

2467

2468

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

2469

2470

</p>

2471

2472

2473

2474

2475

2476

</div>

2477

2478

2479

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

2480

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

2481

2482

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

2483

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

2484

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

2485

</div>

2486

2487

2488

2489

<h4>Parameters:</h4>

2490

2491

2492

2493

2494

2495

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

2496

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

2497

2498

2499

2500

2501

2502

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

2503

(subclass first, Base last)</p>

2504

</div>

2505

2506

2507

</li>

2508

2509

</ul>

2510

</div>

2511

2512

2513

2514

2515

<h4>Returns:</h4>

2516

2517

2518

2519

2520

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

2521

2522

The aggregate set of ATTRS definitions for the instance

2523

2524

</div>

2525

</div>

2526

2527

2528

2529

</div>

2530

2531

2532

2533

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

2534

2535

2536

2537

2538

2539

2540

2541

2542

2543

2544

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

2545

2546

2547

2548

2549

2550

2551

2552

2553

2554

2555

<p>Inherited from

2556

2557

BaseCore

2558

</a>

2559

2560

but overwritten in

2561

2562

2563

2564

2565

2566

</p>

2567

2568

2569

2570

2571

2572

</div>

2573

2574

2575

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

2576

this class.</p>

2577

</div>

2578

2579

2580

2581

2582

2583

2584

</div>

2585

2586

2587

2588

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

2589

2590

2591

2592

2593

2594

2595

2596

2597

2598

2599

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

2600

2601

2602

2603

2604

2605

2606

2607

2608

2609

2610

2611

<p>Inherited from

2612

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

2613

2614

2615

2616

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

2617

2618

</p>

2619

2620

2621

2622

2623

2624

</div>

2625

2626

2627

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

2628

</div>

2629

2630

2631

2632

2633

2634

2635

</div>

2636

2637

2638

2639

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

2640

2641

2642

2643

2644

2645

2646

2647

2648

2649

2650

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

2651

2652

2653

2654

2655

2656

2657

2658

2659

2660

2661

2662

<p>Inherited from

2663

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

2664

2665

2666

2667

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

2668

2669

</p>

2670

2671

2672

2673

2674

2675

</div>

2676

2677

2678

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

2679

</div>

2680

2681

2682

2683

2684

2685

2686

</div>

2687

2688

2689

2690

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

2691

2692

2693

2694

2695

2696

2697

2698

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

2699

</span>

2700

2701

2702

2703

2704

2705

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

2706

2707

2708

2709

2710

2711

2712

2713

2714

2715

2716

2717

2718

<p>

2719

2720

Defined in

2721

2722

2723

2724

2725

<a href="../files/editor_js_frame.js.html#l47"><code>editor/js/frame.js:47</code></a>

2726

2727

</p>

2728

2729

2730

2731

2732

2733

</div>

2734

2735

2736

<p>Create the iframe or Window and get references to the Document & Window</p>

2737

</div>

2738

2739

2740

2741

2742

2743

<h4>Returns:</h4>

2744

2745

2746

2747

2748

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

2749

2750

Hash table containing references to the new Document & Window

2751

2752

</div>

2753

</div>

2754

2755

2756

2757

</div>

2758

2759

2760

2761

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

2762

2763

2764

2765

2766

2767

2768

2769

2770

2771

</li>

2772

2773

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

2774

</div>

2775

2776

2777

2778

2779

2780

2781

2782

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

2783

2784

2785

2786

2787

2788

2789

2790

2791

2792

2793

2794

<p>Inherited from

2795

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

2796

2797

2798

2799

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

2800

2801

</p>

2802

2803

2804

2805

2806

2807

</div>

2808

2809

2810

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

2811

</div>

2812

2813

2814

2815

<h4>Parameters:</h4>

2816

2817

2818

2819

2820

2821

2822

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

2823

2824

2825

2826

2827

2828

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

2829

</div>

2830

2831

2832

</li>

2833

2834

</ul>

2835

</div>

2836

2837

2838

2839

2840

2841

</div>

2842

2843

2844

2845

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

2846

2847

2848

2849

2850

2851

2852

2853

2854

2855

</li>

2856

2857

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

2858

</div>

2859

2860

2861

2862

2863

2864

2865

2866

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

2867

2868

2869

2870

2871

2872

2873

2874

2875

2876

2877

2878

<p>Inherited from

2879

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

2880

2881

2882

2883

2884

2885

</p>

2886

2887

2888

2889

2890

2891

</div>

2892

2893

2894

<p>Default destroy event handler</p>

2895

</div>

2896

2897

2898

2899

<h4>Parameters:</h4>

2900

2901

2902

2903

2904

2905

2906

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

2907

2908

2909

2910

2911

2912

<p>Event object</p>

2913

</div>

2914

2915

2916

</li>

2917

2918

</ul>

2919

</div>

2920

2921

2922

2923

2924

2925

</div>

2926

2927

2928

2929

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

2930

2931

2932

2933

2934

2935

2936

2937

2938

2939

</li>

2940

2941

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

2942

</div>

2943

2944

2945

2946

2947

2948

2949

2950

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

2951

2952

2953

2954

2955

2956

2957

2958

2959

2960

2961

2962

<p>Inherited from

2963

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

2964

2965

2966

2967

2968

2969

</p>

2970

2971

2972

2973

2974

2975

</div>

2976

2977

2978

<p>Default init event handler</p>

2979

</div>

2980

2981

2982

2983

<h4>Parameters:</h4>

2984

2985

2986

2987

2988

2989

2990

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

2991

2992

2993

2994

2995

2996

<p>Event object, with a cfg property which

2997

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

2998

</div>

2999

3000

3001

</li>

3002

3003

</ul>

3004

</div>

3005

3006

3007

3008

3009

3010

</div>

3011

3012

3013

3014

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

3015

3016

3017

3018

3019

3020

3021

3022

3023

3024

3025

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

3026

3027

3028

3029

3030

3031

3032

3033

3034

3035

3036

3037

3038

<p>

3039

3040

Defined in

3041

3042

3043

3044

3045

<a href="../files/editor_js_frame.js.html#l229"><code>editor/js/frame.js:229</code></a>

3046

3047

</p>

3048

3049

3050

3051

3052

3053

</div>

3054

3055

3056

<p>Binds DOM events, sets the iframe to visible and fires the ready event</p>

3057

</div>

3058

3059

3060

3061

3062

3063

3064

</div>

3065

3066

3067

3068

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

3069

3070

3071

3072

3073

3074

3075

3076

3077

3078

3079

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

3080

3081

3082

3083

3084

3085

3086

3087

3088

3089

3090

3091

<p>Inherited from

3092

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

3093

3094

3095

3096

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

3097

3098

</p>

3099

3100

3101

3102

3103

3104

</div>

3105

3106

3107

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

3108

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

3109

</div>

3110

3111

3112

3113

3114

3115

3116

</div>

3117

3118

3119

3120

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

3121

3122

3123

3124

3125

3126

3127

3128

3129

3130

</li>

3131

3132

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

3133

</div>

3134

3135

3136

3137

3138

3139

3140

3141

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

3142

3143

3144

3145

3146

3147

3148

3149

3150

3151

3152

3153

3154

<p>

3155

3156

Defined in

3157

3158

3159

3160

3161

<a href="../files/editor_js_frame.js.html#l183"><code>editor/js/frame.js:183</code></a>

3162

3163

</p>

3164

3165

3166

3167

3168

3169

</div>

3170

3171

3172

<p>Simple pass thru handler for the paste event so we can do content cleanup</p>

3173

</div>

3174

3175

3176

3177

<h4>Parameters:</h4>

3178

3179

3180

3181

3182

3183

3184

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

3185

3186

3187

3188

3189

3190

3191

</div>

3192

3193

3194

</li>

3195

3196

</ul>

3197

</div>

3198

3199

3200

3201

3202

3203

</div>

3204

3205

3206

3207

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

3208

3209

3210

3211

3212

3213

3214

3215

<code>allAttrs</code>

3216

3217

</li>

3218

3219

3220

3221

<code>userVals</code>

3222

3223

</li>

3224

3225

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

3226

</div>

3227

3228

3229

3230

3231

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

3232

</span>

3233

3234

3235

3236

3237

3238

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

3239

3240

3241

3242

3243

3244

3245

3246

3247

3248

3249

3250

<p>Inherited from

3251

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

3252

3253

3254

3255

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

3256

3257

</p>

3258

3259

3260

3261

3262

3263

</div>

3264

3265

3266

3267

</div>

3268

3269

3270

3271

<h4>Parameters:</h4>

3272

3273

3274

3275

3276

3277

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

3278

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

3279

3280

3281

3282

3283

3284

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

3285

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

3286

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

3287

</div>

3288

3289

3290

</li>

3291

3292

3293

3294

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

3295

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

3296

3297

3298

3299

3300

3301

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

3302

</div>

3303

3304

3305

</li>

3306

3307

</ul>

3308

</div>

3309

3310

3311

3312

3313

<h4>Returns:</h4>

3314

3315

3316

3317

3318

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

3319

3320

The set of adhoc attributes passed in, in the form

3321

of an object with attribute name/configuration pairs.

3322

3323

</div>

3324

</div>

3325

3326

3327

3328

</div>

3329

3330

3331

3332

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

3333

3334

3335

3336

3337

3338

3339

3340

<code>clazz</code>

3341

3342

</li>

3343

3344

3345

3346

<code>allCfgs</code>

3347

3348

</li>

3349

3350

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

3351

</div>

3352

3353

3354

3355

3356

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

3357

</span>

3358

3359

3360

3361

3362

3363

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

3364

3365

3366

3367

3368

3369

3370

3371

3372

3373

3374

3375

<p>Inherited from

3376

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

3377

3378

3379

3380

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

3381

3382

</p>

3383

3384

3385

3386

3387

3388

</div>

3389

3390

3391

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

3392

initialization. Returns a disposable object with the attributes defined for

3393

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

3394

</div>

3395

3396

3397

3398

<h4>Parameters:</h4>

3399

3400

3401

3402

3403

3404

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

3405

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

3406

3407

3408

3409

3410

3411

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

3412

</div>

3413

3414

3415

</li>

3416

3417

3418

3419

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

3420

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

3421

3422

3423

3424

3425

3426

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

3427

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

3428

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

3429

</div>

3430

3431

3432

</li>

3433

3434

</ul>

3435

</div>

3436

3437

3438

3439

3440

<h4>Returns:</h4>

3441

3442

3443

3444

3445

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

3446

3447

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

3448

of an object with attribute name/configuration pairs.

3449

3450

</div>

3451

</div>

3452

3453

3454

3455

</div>

3456

3457

3458

3459

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

3460

3461

3462

3463

3464

3465

3466

3467

<code>attrName</code>

3468

3469

</li>

3470

3471

3472

3473

<code>subAttrName</code>

3474

3475

</li>

3476

3477

3478

3479

<code>currVal</code>

3480

3481

</li>

3482

3483

3484

3485

<code>newVal</code>

3486

3487

</li>

3488

3489

3490

3491

3492

3493

</li>

3494

3495

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

3496

</div>

3497

3498

3499

3500

3501

3502

3503

3504

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

3505

3506

3507

3508

3509

3510

3511

3512

3513

3514

3515

3516

<p>Inherited from

3517

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

3518

3519

3520

3521

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

3522

3523

</p>

3524

3525

3526

3527

3528

3529

</div>

3530

3531

3532

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

3533

</div>

3534

3535

3536

3537

<h4>Parameters:</h4>

3538

3539

3540

3541

3542

3543

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

3544

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

3545

3546

3547

3548

3549

3550

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

3551

</div>

3552

3553

3554

</li>

3555

3556

3557

3558

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

3559

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

3560

3561

3562

3563

3564

3565

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

3566

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

3567

</div>

3568

3569

3570

</li>

3571

3572

3573

3574

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

3575

3576

3577

3578

3579

3580

3581

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

3582

</div>

3583

3584

3585

</li>

3586

3587

3588

3589

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

3590

3591

3592

3593

3594

3595

3596

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

3597

</div>

3598

3599

3600

</li>

3601

3602

3603

3604

3605

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

3606

3607

3608

3609

3610

3611

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

3612

</div>

3613

3614

3615

</li>

3616

3617

</ul>

3618

</div>

3619

3620

3621

3622

3623

3624

</div>

3625

3626

3627

3628

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

3629

3630

3631

3632

3633

3634

3635

3636

3637

3638

3639

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

3640

3641

3642

3643

3644

3645

3646

3647

3648

3649

3650

3651

3652

<p>

3653

3654

Defined in

3655

3656

3657

3658

3659

<a href="../files/editor_js_frame.js.html#l275"><code>editor/js/frame.js:275</code></a>

3660

3661

</p>

3662

3663

3664

3665

3666

3667

</div>

3668

3669

3670

<p>It appears that having a BR tag anywhere in the source "below" a table with a percentage width (in IE 7 & 8)

3671

if there is any TEXTINPUT's outside the iframe, the cursor will rapidly flickr and the CPU would occasionally

3672

spike. This method finds all 's below the sourceIndex of the first table. Does some checks to see if they

3673

can be modified and replaces then with a so the layout will remain in tact, but the flickering will

3674

no longer happen.</p>

3675

</div>

3676

3677

3678

3679

3680

3681

3682

</div>

3683

3684

3685

3686

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

3687

3688

3689

3690

3691

3692

3693

3694

3695

3696

</li>

3697

3698

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

3699

</div>

3700

3701

3702

3703

3704

3705

</span>

3706

3707

3708

3709

3710

3711

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

3712

3713

3714

3715

3716

3717

3718

3719

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

3720

3721

3722

3723

3724

3725

<p>Inherited from

3726

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

3727

3728

3729

3730

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

3731

3732

</p>

3733

3734

3735

3736

3737

3738

</div>

3739

3740

3741

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

3742

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

3743

3744

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

3745

</div>

3746

3747

3748

3749

<h4>Parameters:</h4>

3750

3751

3752

3753

3754

3755

3756

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

3757

3758

3759

3760

3761

3762

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

3763

</div>

3764

3765

3766

</li>

3767

3768

</ul>

3769

</div>

3770

3771

3772

3773

3774

<h4>Returns:</h4>

3775

3776

3777

3778

3779

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

3780

3781

The value of the attribute.

3782

3783

</div>

3784

</div>

3785

3786

3787

3788

</div>

3789

3790

3791

3792

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

3793

3794

3795

3796

3797

3798

3799

3800

3801

3802

</li>

3803

3804

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

3805

</div>

3806

3807

3808

3809

3810

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

3811

</span>

3812

3813

3814

3815

3816

3817

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

3818

3819

3820

3821

3822

3823

3824

3825

3826

3827

3828

3829

<p>Inherited from

3830

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

3831

3832

3833

3834

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

3835

3836

</p>

3837

3838

3839

3840

3841

3842

</div>

3843

3844

3845

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

3846

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

3847

configuration properties for all attributes.</p>

3848

</div>

3849

3850

3851

3852

<h4>Parameters:</h4>

3853

3854

3855

3856

3857

3858

3859

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

3860

3861

3862

3863

3864

3865

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

3866

</div>

3867

3868

3869

</li>

3870

3871

</ul>

3872

</div>

3873

3874

3875

3876

3877

<h4>Returns:</h4>

3878

3879

3880

3881

3882

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

3883

3884

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

3885

3886

</div>

3887

</div>

3888

3889

3890

3891

</div>

3892

3893

3894

3895

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

3896

3897

3898

3899

3900

3901

3902

3903

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

3904

</span>

3905

3906

3907

3908

3909

3910

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

3911

3912

3913

3914

3915

3916

3917

3918

3919

3920

3921

3922

<p>Inherited from

3923

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

3924

3925

3926

3927

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

3928

3929

</p>

3930

3931

3932

3933

3934

3935

</div>

3936

3937

3938

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

3939

the class hierarchy.</p>

3940

</div>

3941

3942

3943

3944

3945

3946

<h4>Returns:</h4>

3947

3948

3949

3950

3951

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

3952

3953

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

3954

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

3955

the cached value.

3956

3957

</div>

3958

</div>

3959

3960

3961

3962

</div>

3963

3964

3965

3966

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

3967

3968

3969

3970

3971

3972

3973

3974

3975

3976

</li>

3977

3978

3979

3980

3981

3982

</li>

3983

3984

3985

3986

<code>initValues</code>

3987

3988

</li>

3989

3990

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

3991

</div>

3992

3993

3994

3995

3996

3997

</span>

3998

3999

4000

4001

4002

4003

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

4004

4005

4006

4007

4008

4009

4010

4011

4012

4013

4014

<p>Inherited from

4015

4016

Attribute

4017

</a>

4018

4019

but overwritten in

4020

4021

4022

4023

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

4024

4025

</p>

4026

4027

4028

4029

4030

4031

</div>

4032

4033

4034

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

4035

either the default configuration provided, or the

4036

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

4037

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

4038

</div>

4039

4040

4041

4042

<h4>Parameters:</h4>

4043

4044

4045

4046

4047

4048

4049

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

4050

4051

4052

4053

4054

4055

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

4056

</div>

4057

4058

4059

</li>

4060

4061

4062

4063

4064

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

4065

4066

4067

4068

4069

4070

<p>The attribute configuration object</p>

4071

</div>

4072

4073

4074

</li>

4075

4076

4077

4078

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

4079

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

4080

4081

4082

4083

4084

4085

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

4086

</div>

4087

4088

4089

</li>

4090

4091

</ul>

4092

</div>

4093

4094

4095

4096

4097

<h4>Returns:</h4>

4098

4099

4100

4101

4102

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

4103

4104

The initial value of the attribute.

4105

4106

</div>

4107

</div>

4108

4109

4110

4111

</div>

4112

4113

4114

4115

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

4116

4117

4118

4119

4120

4121

4122

4123

<code>attrs</code>

4124

4125

</li>

4126

4127

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

4128

</div>

4129

4130

4131

4132

4133

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

4134

</span>

4135

4136

4137

4138

4139

4140

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

4141

4142

4143

4144

4145

4146

4147

4148

4149

4150

4151

4152

<p>Inherited from

4153

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

4154

4155

4156

4157

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

4158

4159

</p>

4160

4161

4162

4163

4164

4165

</div>

4166

4167

4168

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

4169

</div>

4170

4171

4172

4173

<h4>Parameters:</h4>

4174

4175

4176

4177

4178

4179

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

4180

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

4181

4182

4183

4184

4185

4186

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

4187

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

4188

</div>

4189

4190

4191

</li>

4192

4193

</ul>

4194

</div>

4195

4196

4197

4198

4199

<h4>Returns:</h4>

4200

4201

4202

4203

4204

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

4205

4206

An object with attribute name/value pairs.

4207

4208

</div>

4209

</div>

4210

4211

4212

4213

</div>

4214

4215

4216

4217

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

4218

4219

4220

4221

4222

4223

4224

4225

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

4226

</span>

4227

4228

4229

4230

4231

4232

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

4233

4234

4235

4236

4237

4238

4239

4240

4241

4242

4243

4244

<p>Inherited from

4245

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

4246

4247

4248

4249

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

4250

4251

</p>

4252

4253

4254

4255

4256

4257

</div>

4258

4259

4260

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

4261

</div>

4262

4263

4264

4265

4266

4267

<h4>Returns:</h4>

4268

4269

4270

4271

4272

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

4273

4274

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

4275

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

4276

cached value.

4277

4278

</div>

4279

</div>

4280

4281

4282

4283

</div>

4284

4285

4286

4287

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

4288

4289

4290

4291

4292

4293

4294

4295

4296

4297

</li>

4298

4299

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

4300

</div>

4301

4302

4303

4304

4305

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

4306

</span>

4307

4308

4309

4310

4311

4312

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

4313

4314

4315

4316

4317

4318

4319

4320

4321

4322

4323

4324

4325

<p>

4326

4327

Defined in

4328

4329

4330

4331

4332

<a href="../files/editor_js_frame.js.html#l422"><code>editor/js/frame.js:422</code></a>

4333

4334

</p>

4335

4336

4337

4338

4339

4340

</div>

4341

4342

4343

<p>Get the content from the iframe</p>

4344

</div>

4345

4346

4347

4348

<h4>Parameters:</h4>

4349

4350

4351

4352

4353

4354

4355

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

4356

4357

4358

4359

4360

4361

<p>The raw HTML from the body of the iframe.</p>

4362

</div>

4363

4364

4365

</li>

4366

4367

</ul>

4368

</div>

4369

4370

4371

4372

4373

<h4>Returns:</h4>

4374

4375

4376

4377

4378

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

4379

4380

4381

</div>

4382

</div>

4383

4384

4385

4386

</div>

4387

4388

4389

4390

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

4391

4392

4393

4394

4395

4396

4397

4398

4399

4400

</li>

4401

4402

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

4403

</div>

4404

4405

4406

4407

4408

4409

</span>

4410

4411

4412

4413

4414

4415

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

4416

4417

4418

4419

4420

4421

4422

4423

4424

4425

4426

4427

<p>Inherited from

4428

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

4429

4430

4431

4432

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

4433

4434

</p>

4435

4436

4437

4438

4439

4440

</div>

4441

4442

4443

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

4444

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

4445

</div>

4446

4447

4448

4449

<h4>Parameters:</h4>

4450

4451

4452

4453

4454

4455

4456

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

4457

4458

4459

4460

4461

4462

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

4463

</div>

4464

4465

4466

</li>

4467

4468

</ul>

4469

</div>

4470

4471

4472

4473

4474

<h4>Returns:</h4>

4475

4476

4477

4478

4479

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

4480

4481

The stored value of the attribute

4482

4483

</div>

4484

</div>

4485

4486

4487

4488

</div>

4489

4490

4491

4492

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

4493

4494

4495

4496

4497

4498

4499

4500

4501

4502

4503

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

4504

4505

4506

4507

4508

4509

4510

4511

4512

4513

4514

4515

<p>Inherited from

4516

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

4517

4518

4519

4520

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

4521

4522

</p>

4523

4524

4525

4526

4527

4528

</div>

4529

4530

4531

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

4532

event type is not prefixed, the instance prefix is

4533

applied to the supplied type.</p>

4534

</div>

4535

4536

4537

4538

4539

4540

4541

</div>

4542

4543

4544

4545

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

4546

4547

4548

4549

4550

4551

4552

4553

4554

4555

4556

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

4557

4558

4559

4560

4561

4562

4563

4564

4565

4566

4567

4568

4569

<p>

4570

4571

Defined in

4572

4573

4574

4575

4576

<a href="../files/editor_js_frame.js.html#l641"><code>editor/js/frame.js:641</code></a>

4577

4578

</p>

4579

4580

4581

4582

4583

4584

</div>

4585

4586

4587

<p>Does some tricks on focus to set the proper cursor position.</p>

4588

</div>

4589

4590

4591

4592

4593

4594

4595

</div>

4596

4597

4598

4599

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

4600

4601

4602

4603

4604

4605

4606

4607

4608

4609

4610

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

4611

4612

4613

4614

4615

4616

4617

4618

4619

4620

4621

4622

4623

<p>

4624

4625

Defined in

4626

4627

4628

4629

4630

<a href="../files/editor_js_frame.js.html#l358"><code>editor/js/frame.js:358</code></a>

4631

4632

</p>

4633

4634

4635

4636

4637

4638

</div>

4639

4640

4641

<p>Internal method to set the height of the body to the height of the document in IE.

4642

With contenteditable being set, the document becomes unresponsive to clicks, this

4643

method expands the body to be the height of the document so that doesn't happen.</p>

4644

</div>

4645

4646

4647

4648

4649

4650

4651

</div>

4652

4653

4654

4655

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

4656

4657

4658

4659

4660

4661

4662

4663

<code>attrs</code>

4664

4665

</li>

4666

4667

4668

4669

<code>values</code>

4670

4671

</li>

4672

4673

4674

4675

4676

4677

</li>

4678

4679

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

4680

</div>

4681

4682

4683

4684

4685

4686

4687

4688

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

4689

4690

4691

4692

4693

4694

4695

4696

4697

4698

4699

4700

<p>Inherited from

4701

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

4702

4703

4704

4705

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

4706

4707

</p>

4708

4709

4710

4711

4712

4713

</div>

4714

4715

4716

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

4717

constructor.</p>

4718

</div>

4719

4720

4721

4722

<h4>Parameters:</h4>

4723

4724

4725

4726

4727

4728

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

4729

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

4730

4731

4732

4733

4734

4735

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

4736

</div>

4737

4738

4739

</li>

4740

4741

4742

4743

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

4744

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

4745

4746

4747

4748

4749

4750

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

4751

</div>

4752

4753

4754

</li>

4755

4756

4757

4758

4759

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

4760

4761

4762

4763

4764

4765

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

4766

</div>

4767

4768

4769

</li>

4770

4771

</ul>

4772

</div>

4773

4774

4775

4776

4777

4778

</div>

4779

4780

4781

4782

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

4783

4784

4785

4786

4787

4788

4789

4790

4791

4792

4793

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

4794

4795

4796

4797

4798

4799

4800

4801

4802

4803

4804

<p>Inherited from

4805

4806

BaseCore

4807

</a>

4808

4809

but overwritten in

4810

4811

4812

4813

4814

4815

</p>

4816

4817

4818

4819

4820

4821

</div>

4822

4823

4824

<p>Initializes Attribute</p>

4825

</div>

4826

4827

4828

4829

4830

4831

4832

</div>

4833

4834

4835

4836

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

4837

4838

4839

4840

4841

4842

4843

4844

<code>attrs</code>

4845

4846

</li>

4847

4848

4849

4850

<code>values</code>

4851

4852

</li>

4853

4854

4855

4856

4857

4858

</li>

4859

4860

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

4861

</div>

4862

4863

4864

4865

4866

4867

4868

4869

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

4870

4871

4872

4873

4874

4875

4876

4877

4878

4879

4880

4881

<p>Inherited from

4882

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

4883

4884

4885

4886

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

4887

4888

</p>

4889

4890

4891

4892

4893

4894

</div>

4895

4896

4897

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

4898

</div>

4899

4900

4901

4902

<h4>Parameters:</h4>

4903

4904

4905

4906

4907

4908

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

4909

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

4910

4911

4912

4913

4914

4915

4916

</div>

4917

4918

4919

</li>

4920

4921

4922

4923

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

4924

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

4925

4926

4927

4928

4929

4930

4931

</div>

4932

4933

4934

</li>

4935

4936

4937

4938

4939

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

4940

4941

4942

4943

4944

4945

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

4946

</div>

4947

4948

4949

</li>

4950

4951

</ul>

4952

</div>

4953

4954

4955

4956

4957

4958

</div>

4959

4960

4961

4962

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

4963

4964

4965

4966

4967

4968

4969

4970

<code>config</code>

4971

4972

</li>

4973

4974

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

4975

</div>

4976

4977

4978

4979

4980

4981

4982

4983

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

4984

4985

4986

4987

4988

4989

4990

4991

4992

4993

4994

<p>Inherited from

4995

4996

BaseCore

4997

</a>

4998

4999

but overwritten in

5000

5001

5002

5003

5004

5005

</p>

5006

5007

5008

5009

5010

5011

</div>

5012

5013

5014

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

5015

</div>

5016

5017

5018

5019

<h4>Parameters:</h4>

5020

5021

5022

5023

5024

5025

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

5026

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

5027

5028

5029

5030

5031

5032

<p>The constructor configuration object</p>

5033

</div>

5034

5035

5036

</li>

5037

5038

</ul>

5039

</div>

5040

5041

5042

5043

5044

5045

</div>

5046

5047

5048

5049

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

5050

5051

5052

5053

5054

5055

5056

5057

<code>userVals</code>

5058

5059

</li>

5060

5061

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

5062

</div>

5063

5064

5065

5066

5067

5068

5069

5070

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

5071

5072

5073

5074

5075

5076

5077

5078

5079

5080

5081

5082

<p>Inherited from

5083

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

5084

5085

5086

5087

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

5088

5089

</p>

5090

5091

5092

5093

5094

5095

</div>

5096

5097

5098

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

5099

initializing attributes for each class defined in the class's

5100

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

5101

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

5102

</div>

5103

5104

5105

5106

<h4>Parameters:</h4>

5107

5108

5109

5110

5111

5112

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

5113

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

5114

5115

5116

5117

5118

5119

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

5120

</div>

5121

5122

5123

</li>

5124

5125

</ul>

5126

</div>

5127

5128

5129

5130

5131

5132

</div>

5133

5134

5135

5136

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

5137

5138

5139

5140

5141

5142

5143

5144

5145

5146

5147

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

5148

5149

5150

5151

5152

5153

5154

5155

5156

5157

5158

5159

<p>Inherited from

5160

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

5161

5162

5163

5164

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

5165

5166

</p>

5167

5168

5169

5170

5171

5172

</div>

5173

5174

5175

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

5176

the array of classes and aggregate set of attribute configurations

5177

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

5178

</div>

5179

5180

5181

5182

5183

5184

5185

</div>

5186

5187

5188

5189

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

5190

5191

5192

5193

5194

5195

5196

5197

5198

5199

</li>

5200

5201

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

5202

</div>

5203

5204

5205

5206

5207

5208

5209

5210

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

5211

5212

5213

5214

5215

5216

5217

5218

5219

5220

5221

5222

5223

<p>

5224

5225

Defined in

5226

5227

5228

5229

5230

<a href="../files/editor_js_frame.js.html#l504"><code>editor/js/frame.js:504</code></a>

5231

5232

</p>

5233

5234

5235

5236

5237

5238

</div>

5239

5240

5241

<p>Called from the first YUI instance that sets up the internal instance.

5242

This loads the content into the window/frame and attaches the contentready event.</p>

5243

</div>

5244

5245

5246

5247

<h4>Parameters:</h4>

5248

5249

5250

5251

5252

5253

5254

5255

5256

5257

5258

5259

5260

<p>The internal YUI instance bound to the frame/window</p>

5261

</div>

5262

5263

5264

</li>

5265

5266

</ul>

5267

</div>

5268

5269

5270

5271

5272

5273

</div>

5274

5275

5276

5277

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

5278

5279

5280

5281

5282

5283

5284

5285

5286

5287

</li>

5288

5289

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

5290

</div>

5291

5292

5293

5294

5295

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

5296

</span>

5297

5298

5299

5300

5301

5302

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

5303

5304

5305

5306

5307

5308

5309

5310

5311

5312

5313

5314

<p>Inherited from

5315

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

5316

5317

5318

5319

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

5320

5321

</p>

5322

5323

5324

5325

5326

5327

</div>

5328

5329

5330

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

5331

added lazily and still requires initialization.</p>

5332

</div>

5333

5334

5335

5336

<h4>Parameters:</h4>

5337

5338

5339

5340

5341

5342

5343

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

5344

5345

5346

5347

5348

5349

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

5350

</div>

5351

5352

5353

</li>

5354

5355

</ul>

5356

</div>

5357

5358

5359

5360

5361

<h4>Returns:</h4>

5362

5363

5364

5365

5366

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

5367

5368

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

5369

5370

</div>

5371

</div>

5372

5373

5374

5375

</div>

5376

5377

5378

5379

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

5380

5381

5382

5383

5384

5385

5386

5387

5388

5389

</li>

5390

5391

5392

5393

5394

5395

</li>

5396

5397

5398

5399

5400

5401

</li>

5402

5403

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

5404

</div>

5405

5406

5407

5408

5409

5410

5411

5412

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

5413

5414

5415

5416

5417

5418

5419

5420

5421

5422

5423

5424

<p>Inherited from

5425

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

5426

5427

5428

5429

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

5430

5431

</p>

5432

5433

5434

5435

5436

5437

</div>

5438

5439

5440

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

5441

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

5442

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

5443

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

5444

be subscribed to like other events to monitor the event

5445

system. Inividual published events can have monitoring

5446

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

5447

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

5448

</div>

5449

5450

5451

5452

<h4>Parameters:</h4>

5453

5454

5455

5456

5457

5458

5459

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

5460

5461

5462

5463

5464

5465

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

5466

</div>

5467

5468

5469

</li>

5470

5471

5472

5473

5474

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

5475

5476

5477

5478

5479

5480

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

5481

</div>

5482

5483

5484

</li>

5485

5486

5487

5488

5489

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

5490

5491

5492

5493

5494

5495

<p>Information about the event interaction, such as

5496

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

5497

</div>

5498

5499

5500

</li>

5501

5502

</ul>

5503

</div>

5504

5505

5506

5507

5508

5509

</div>

5510

5511

5512

5513

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

5514

5515

5516

5517

5518

5519

5520

5521

<code>valueHash</code>

5522

5523

</li>

5524

5525

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

5526

</div>

5527

5528

5529

5530

5531

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

5532

</span>

5533

5534

5535

5536

5537

5538

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

5539

5540

5541

5542

5543

5544

5545

5546

5547

5548

5549

<p>Inherited from

5550

5551

Attribute

5552

</a>

5553

5554

but overwritten in

5555

5556

5557

5558

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

5559

5560

</p>

5561

5562

5563

5564

5565

5566

</div>

5567

5568

5569

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

5570

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

5571

</div>

5572

5573

5574

5575

<h4>Parameters:</h4>

5576

5577

5578

5579

5580

5581

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

5582

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

5583

5584

5585

5586

5587

5588

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

5589

</div>

5590

5591

5592

</li>

5593

5594

</ul>

5595

</div>

5596

5597

5598

5599

5600

<h4>Returns:</h4>

5601

5602

5603

5604

5605

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

5606

5607

5608

</div>

5609

</div>

5610

5611

5612

5613

</div>

5614

5615

5616

5617

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

5618

5619

5620

5621

5622

5623

5624

5625

5626

5627

5628

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

5629

5630

5631

5632

5633

5634

5635

5636

5637

5638

5639

5640

5641

<p>

5642

5643

Defined in

5644

5645

5646

5647

5648

<a href="../files/editor_js_frame.js.html#l315"><code>editor/js/frame.js:315</code></a>

5649

5650

</p>

5651

5652

5653

5654

5655

5656

</div>

5657

5658

5659

<p>Called once the content is available in the frame/window and calls the final use call

5660

on the internal instance so that the modules are loaded properly.</p>

5661

</div>

5662

5663

5664

5665

5666

5667

5668

</div>

5669

5670

5671

5672

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

5673

5674

5675

5676

5677

5678

5679

5680

5681

5682

</li>

5683

5684

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

5685

</div>

5686

5687

5688

5689

5690

5691

5692

5693

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

5694

5695

5696

5697

5698

5699

5700

5701

5702

5703

5704

5705

5706

<p>

5707

5708

Defined in

5709

5710

5711

5712

5713

<a href="../files/editor_js_frame.js.html#l135"><code>editor/js/frame.js:135</code></a>

5714

5715

</p>

5716

5717

5718

5719

5720

5721

</div>

5722

5723

5724

<p>Generic handler for all DOM events fired by the iframe or window. This handler

5725

takes the current EventFacade and augments it to fire on the Frame host. It adds two new properties

5726

to the EventFacade called frameX and frameY which adds the scroll and xy position of the iframe

5727

to the original pageX and pageY of the event so external nodes can be positioned over the frame.</p>

5728

</div>

5729

5730

5731

5732

<h4>Parameters:</h4>

5733

5734

5735

5736

5737

5738

5739

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

5740

5741

5742

5743

5744

5745

5746

</div>

5747

5748

5749

</li>

5750

5751

</ul>

5752

</div>

5753

5754

5755

5756

5757

5758

</div>

5759

5760

5761

5762

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

5763

5764

5765

5766

5767

5768

5769

5770

5771

5772

5773

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

5774

5775

5776

5777

5778

5779

5780

5781

5782

5783

5784

5785

<p>Inherited from

5786

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

5787

5788

5789

5790

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

5791

5792

</p>

5793

5794

5795

5796

5797

5798

</div>

5799

5800

5801

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

5802

and the prefixed event name from _getType

5803

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

5804

</div>

5805

5806

5807

5808

5809

5810

5811

</div>

5812

5813

5814

5815

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

5816

5817

5818

5819

5820

5821

5822

5823

<code>config</code>

5824

5825

</li>

5826

5827

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

5828

</div>

5829

5830

5831

5832

5833

5834

5835

5836

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

5837

5838

5839

5840

5841

5842

5843

5844

5845

5846

5847

5848

<p>Inherited from

5849

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

5850

5851

5852

5853

5854

5855

</p>

5856

5857

5858

5859

5860

5861

</div>

5862

5863

5864

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

5865

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

5866

construction, prior to init.</p>

5867

</div>

5868

5869

5870

5871

<h4>Parameters:</h4>

5872

5873

5874

5875

5876

5877

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

5878

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

5879

5880

5881

5882

5883

5884

<p>The user configuration object</p>

5885

</div>

5886

5887

5888

</li>

5889

5890

</ul>

5891

</div>

5892

5893

5894

5895

5896

5897

</div>

5898

5899

5900

5901

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

5902

5903

5904

5905

5906

5907

5908

5909

<code>attrs</code>

5910

5911

</li>

5912

5913

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

5914

</div>

5915

5916

5917

5918

5919

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

5920

</span>

5921

5922

5923

5924

5925

5926

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

5927

5928

5929

5930

5931

5932

5933

5934

5935

5936

5937

5938

<p>Inherited from

5939

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

5940

5941

5942

5943

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

5944

5945

</p>

5946

5947

5948

5949

5950

5951

</div>

5952

5953

5954

<p>Utility method to protect an attribute configuration

5955

hash, by merging the entire object and the individual

5956

attr config objects.</p>

5957

</div>

5958

5959

5960

5961

<h4>Parameters:</h4>

5962

5963

5964

5965

5966

5967

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

5968

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

5969

5970

5971

5972

5973

5974

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

5975

</div>

5976

5977

5978

</li>

5979

5980

</ul>

5981

</div>

5982

5983

5984

5985

5986

<h4>Returns:</h4>

5987

5988

5989

5990

5991

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

5992

5993

A protected version of the attrs argument.

5994

5995

</div>

5996

</div>

5997

5998

5999

6000

</div>

6001

6002

6003

6004

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

6005

6006

6007

6008

6009

6010

6011

6012

6013

6014

</li>

6015

6016

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

6017

</div>

6018

6019

6020

6021

6022

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

6023

</span>

6024

6025

6026

6027

6028

6029

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

6030

6031

6032

6033

6034

6035

6036

6037

6038

6039

6040

6041

6042

<p>

6043

6044

Defined in

6045

6046

6047

6048

6049

<a href="../files/editor_js_frame.js.html#l405"><code>editor/js/frame.js:405</code></a>

6050

6051

</p>

6052

6053

6054

6055

6056

6057

</div>

6058

6059

6060

<p>Resolves the basehref of the page the frame is created on. Only applies to dynamic content.</p>

6061

</div>

6062

6063

6064

6065

<h4>Parameters:</h4>

6066

6067

6068

6069

6070

6071

6072

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

6073

6074

6075

6076

6077

6078

<p>The new value to use, if empty it will be resolved from the current url.</p>

6079

</div>

6080

6081

6082

</li>

6083

6084

</ul>

6085

</div>

6086

6087

6088

6089

6090

<h4>Returns:</h4>

6091

6092

6093

6094

6095

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

6096

6097

6098

</div>

6099

</div>

6100

6101

6102

6103

</div>

6104

6105

6106

6107

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

6108

6109

6110

6111

6112

6113

6114

6115

6116

6117

</li>

6118

6119

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

6120

</div>

6121

6122

6123

6124

6125

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

6126

</span>

6127

6128

6129

6130

6131

6132

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

6133

6134

6135

6136

6137

6138

6139

6140

6141

6142

6143

6144

6145

<p>

6146

6147

Defined in

6148

6149

6150

6151

6152

<a href="../files/editor_js_frame.js.html#l116"><code>editor/js/frame.js:116</code></a>

6153

6154

</p>

6155

6156

6157

6158

6159

6160

</div>

6161

6162

6163

<p>Resolves the document and window from an iframe or window instance</p>

6164

</div>

6165

6166

6167

6168

<h4>Parameters:</h4>

6169

6170

6171

6172

6173

6174

6175

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

6176

6177

6178

6179

6180

6181

<p>The YUI Config to add the window and document to</p>

6182

</div>

6183

6184

6185

</li>

6186

6187

</ul>

6188

</div>

6189

6190

6191

6192

6193

<h4>Returns:</h4>

6194

6195

6196

6197

6198

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

6199

6200

Object hash of window and document references, if a YUI config was passed, it is returned.

6201

6202

</div>

6203

</div>

6204

6205

6206

6207

</div>

6208

6209

6210

6211

6212

6213

6214

6215

6216

6217

6218

6219

6220

6221

</li>

6222

6223

6224

6225

6226

6227

</li>

6228

6229

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

6230

</div>

6231

6232

6233

6234

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

</span>

6237

6238

6239

6240

6241

6242

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

6243

6244

6245

6246

6247

6248

6249

6250

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

6251

6252

6253

6254

6255

<p>Inherited from

6256

6257

AttributeEvents

6258

</a>

6259

6260

but overwritten in

6261

6262

6263

6264

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

6265

6266

</p>

6267

6268

6269

6270

6271

6272

</div>

6273

6274

6275

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

6276

</div>

6277

6278

6279

6280

<h4>Parameters:</h4>

6281

6282

6283

6284

6285

6286

6287

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

6288

6289

6290

6291

6292

6293

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

6294

</div>

6295

6296

6297

</li>

6298

6299

6300

6301

6302

6303

6304

6305

6306

6307

6308

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

6309

</div>

6310

6311

6312

</li>

6313

6314

</ul>

6315

</div>

6316

6317

6318

6319

6320

<h4>Returns:</h4>

6321

6322

6323

6324

6325

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

6326

6327

A reference to the host object.

6328

6329

</div>

6330

</div>

6331

6332

6333

6334

</div>

6335

6336

6337

6338

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

6339

6340

6341

6342

6343

6344

6345

6346

6347

6348

</li>

6349

6350

6351

6352

<code>value</code>

6353

6354

</li>

6355

6356

6357

6358

6359

6360

</li>

6361

6362

6363

6364

<code>force</code>

6365

6366

</li>

6367

6368

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

6369

</div>

6370

6371

6372

6373

6374

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

6375

</span>

6376

6377

6378

6379

6380

6381

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

6382

6383

6384

6385

6386

6387

6388

6389

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

6390

6391

6392

6393

6394

6395

<p>Inherited from

6396

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

6397

6398

6399

6400

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

6401

6402

</p>

6403

6404

6405

6406

6407

6408

</div>

6409

6410

6411

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

6412

6413

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

6414

</div>

6415

6416

6417

6418

<h4>Parameters:</h4>

6419

6420

6421

6422

6423

6424

6425

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

6426

6427

6428

6429

6430

6431

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

6432

</div>

6433

6434

6435

</li>

6436

6437

6438

6439

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

6440

6441

6442

6443

6444

6445

6446

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

6447

</div>

6448

6449

6450

</li>

6451

6452

6453

6454

6455

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

6456

6457

6458

6459

6460

6461

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

6462

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

6463

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

6464

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

6465

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

6466

</div>

6467

6468

6469

</li>

6470

6471

6472

6473

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

6474

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

6475

6476

6477

6478

6479

6480

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

6481

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

6482

</div>

6483

6484

6485

</li>

6486

6487

</ul>

6488

</div>

6489

6490

6491

6492

6493

<h4>Returns:</h4>

6494

6495

6496

6497

6498

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

6499

6500

A reference to the host object.

6501

6502

</div>

6503

</div>

6504

6505

6506

6507

</div>

6508

6509

6510

6511

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

6512

6513

6514

6515

6516

6517

6518

6519

<code>attrs</code>

6520

6521

</li>

6522

6523

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

6524

</div>

6525

6526

6527

6528

6529

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

6530

</span>

6531

6532

6533

6534

6535

6536

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

6537

6538

6539

6540

6541

6542

6543

6544

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

6545

6546

6547

6548

6549

6550

<p>Inherited from

6551

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

6552

6553

6554

6555

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

6556

6557

</p>

6558

6559

6560

6561

6562

6563

</div>

6564

6565

6566

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

6567

</div>

6568

6569

6570

6571

<h4>Parameters:</h4>

6572

6573

6574

6575

6576

6577

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

6578

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

6579

6580

6581

6582

6583

6584

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

6585

</div>

6586

6587

6588

</li>

6589

6590

</ul>

6591

</div>

6592

6593

6594

6595

6596

<h4>Returns:</h4>

6597

6598

6599

6600

6601

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

6602

6603

A reference to the host object.

6604

6605

</div>

6606

</div>

6607

6608

6609

6610

</div>

6611

6612

6613

6614

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

6615

6616

6617

6618

6619

6620

6621

6622

<code>attrName</code>

6623

6624

</li>

6625

6626

6627

6628

<code>subAttrName</code>

6629

6630

</li>

6631

6632

6633

6634

<code>prevVal</code>

6635

6636

</li>

6637

6638

6639

6640

<code>newVal</code>

6641

6642

</li>

6643

6644

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

6645

</div>

6646

6647

6648

6649

6650

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

6651

</span>

6652

6653

6654

6655

6656

6657

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

6658

6659

6660

6661

6662

6663

6664

6665

6666

6667

6668

6669

<p>Inherited from

6670

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

6671

6672

6673

6674

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

6675

6676

</p>

6677

6678

6679

6680

6681

6682

</div>

6683

6684

6685

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

6686

if validation and setter passes.</p>

6687

</div>

6688

6689

6690

6691

<h4>Parameters:</h4>

6692

6693

6694

6695

6696

6697

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

6698

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

6699

6700

6701

6702

6703

6704

<p>The attribute name.</p>

6705

</div>

6706

6707

6708

</li>

6709

6710

6711

6712

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

6713

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

6714

6715

6716

6717

6718

6719

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

6720

</div>

6721

6722

6723

</li>

6724

6725

6726

6727

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

6728

6729

6730

6731

6732

6733

6734

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

6735

</div>

6736

6737

6738

</li>

6739

6740

6741

6742

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

6743

6744

6745

6746

6747

6748

6749

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

6750

</div>

6751

6752

6753

</li>

6754

6755

</ul>

6756

</div>

6757

6758

6759

6760

6761

<h4>Returns:</h4>

6762

6763

6764

6765

6766

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

6767

6768

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

6769

6770

</div>

6771

</div>

6772

6773

6774

6775

</div>

6776

6777

6778

6779

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

6780

6781

6782

6783

6784

6785

6786

6787

6788

6789

6790

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

6791

6792

6793

6794

6795

6796

6797

6798

6799

6800

6801

6802

6803

<p>

6804

6805

Defined in

6806

6807

6808

6809

6810

<a href="../files/editor_js_frame.js.html#l489"><code>editor/js/frame.js:489</code></a>

6811

6812

</p>

6813

6814

6815

6816

6817

6818

</div>

6819

6820

6821

<p>Set's the extra CSS on the instance..</p>

6822

</div>

6823

6824

6825

6826

6827

6828

6829

</div>

6830

6831

6832

6833

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

6834

6835

6836

6837

6838

6839

6840

6841

6842

6843

</li>

6844

6845

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

6846

</div>

6847

6848

6849

6850

6851

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

6852

</span>

6853

6854

6855

6856

6857

6858

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

6859

6860

6861

6862

6863

6864

6865

6866

6867

6868

6869

6870

6871

<p>

6872

6873

Defined in

6874

6875

6876

6877

6878

<a href="../files/editor_js_frame.js.html#l436"><code>editor/js/frame.js:436</code></a>

6879

6880

</p>

6881

6882

6883

6884

6885

6886

</div>

6887

6888

6889

<p>Set the content of the iframe</p>

6890

</div>

6891

6892

6893

6894

<h4>Parameters:</h4>

6895

6896

6897

6898

6899

6900

6901

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

6902

6903

6904

6905

6906

6907

<p>The raw HTML to set the body of the iframe to.</p>

6908

</div>

6909

6910

6911

</li>

6912

6913

</ul>

6914

</div>

6915

6916

6917

6918

6919

<h4>Returns:</h4>

6920

6921

6922

6923

6924

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

6925

6926

6927

</div>

6928

</div>

6929

6930

6931

6932

</div>

6933

6934

6935

6936

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

6937

6938

6939

6940

6941

6942

6943

6944

6945

6946

6947

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

6948

6949

6950

6951

6952

6953

6954

6955

6956

6957

6958

6959

6960

<p>

6961

6962

Defined in

6963

6964

6965

6966

6967

<a href="../files/editor_js_frame.js.html#l477"><code>editor/js/frame.js:477</code></a>

6968

6969

</p>

6970

6971

6972

6973

6974

6975

</div>

6976

6977

6978

<p>Set's the linked CSS on the instance..</p>

6979

</div>

6980

6981

6982

6983

6984

6985

6986

</div>

6987

6988

6989

6990

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

6991

6992

6993

6994

6995

6996

6997

6998

6999

7000

7001

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

7002

7003

7004

7005

7006

7007

7008

7009

7010

7011

7012

7013

7014

<p>

7015

7016

Defined in

7017

7018

7019

7020

7021

<a href="../files/editor_js_frame.js.html#l456"><code>editor/js/frame.js:456</code></a>

7022

7023

</p>

7024

7025

7026

7027

7028

7029

</div>

7030

7031

7032

<p>Set's the linked CSS on the instance..</p>

7033

</div>

7034

7035

7036

7037

7038

7039

7040

</div>

7041

7042

7043

7044

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

7045

7046

7047

7048

7049

7050

7051

7052

7053

7054

</li>

7055

7056

7057

7058

<code>value</code>

7059

7060

</li>

7061

7062

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

7063

</div>

7064

7065

7066

7067

7068

7069

7070

7071

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

7072

7073

7074

7075

7076

7077

7078

7079

7080

7081

7082

7083

<p>Inherited from

7084

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

7085

7086

7087

7088

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

7089

7090

</p>

7091

7092

7093

7094

7095

7096

</div>

7097

7098

7099

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

7100

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

7101

</div>

7102

7103

7104

7105

<h4>Parameters:</h4>

7106

7107

7108

7109

7110

7111

7112

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

7113

7114

7115

7116

7117

7118

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

7119

</div>

7120

7121

7122

</li>

7123

7124

7125

7126

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

7127

7128

7129

7130

7131

7132

7133

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

7134

</div>

7135

7136

7137

</li>

7138

7139

</ul>

7140

</div>

7141

7142

7143

7144

7145

7146

</div>

7147

7148

7149

7150

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

7151

7152

7153

7154

7155

7156

7157

7158

7159

7160

</li>

7161

7162

7163

7164

<code>config</code>

7165

7166

</li>

7167

7168

7169

7170

7171

7172

</li>

7173

7174

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

7175

</div>

7176

7177

7178

7179

7180

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

7181

</span>

7182

7183

7184

7185

7186

7187

7188

7189

7190

7191

7192

7193

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

7194

7195

7196

7197

7198

7199

<p>Inherited from

7200

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

7201

7202

7203

7204

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

7205

7206

</p>

7207

7208

7209

7210

7211

7212

</div>

7213

7214

7215

<p>

7216

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

7217

</p>

7218

7219

<p>

7220

The config argument object supports the following properties:

7221

</p>

7222

7223

<dl>

7224

<dt>value <Any></dt>

7225

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

7226

7227

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

7228

<dd>

7229

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

7230

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

7231

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

7232

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

7233

case the value property is used.</p>

7234

7235

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

7236

</dd>

7237

7238

<dt>readOnly <boolean></dt>

7239

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

7240

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

7241

7242

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

7243

<dd>

7244

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

7245

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

7246

constructor configuration arguments, or by invoking set.

7247

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

7248

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

7249

</dd>

7250

7251

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

7252

<dd>

7253

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

7254

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

7255

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

7256

the value from being stored.

7257

</p>

7258

7259

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

7260

</dd>

7261

7262

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

7263

<dd>

7264

<p>

7265

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

7266

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

7267

invoke get.

7268

</p>

7269

7270

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

7271

</dd>

7272

7273

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

7274

<dd>

7275

<p>

7276

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

7277

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

7278

</p>

7279

7280

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

7281

</dd>

7282

7283

<dt>lazyAdd <boolean></dt>

7284

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

7285

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

7286

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

7287

7288

</dl>

7289

7290

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

7291

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

7292

7293

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

7294

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

7295

</div>

7296

7297

7298

7299

<h4>Parameters:</h4>

7300

7301

7302

7303

7304

7305

7306

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

7307

7308

7309

7310

7311

7312

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

7313

</div>

7314

7315

7316

</li>

7317

7318

7319

7320

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

7321

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

7322

7323

7324

7325

7326

7327

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

7328

7329

<p>

7330

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

7331

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

7332

</p>

7333

</div>

7334

7335

7336

</li>

7337

7338

7339

7340

7341

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

7342

7343

7344

7345

7346

7347

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

7348

</div>

7349

7350

7351

</li>

7352

7353

</ul>

7354

</div>

7355

7356

7357

7358

7359

<h4>Returns:</h4>

7360

7361

7362

7363

7364

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

7365

7366

A reference to the host object.

7367

7368

</div>

7369

</div>

7370

7371

7372

7373

</div>

7374

7375

7376

7377

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

7378

7379

7380

7381

7382

7383

7384

7385

7386

7387

</li>

7388

7389

7390

7391

<code>values</code>

7392

7393

</li>

7394

7395

7396

7397

7398

7399

</li>

7400

7401

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

7402

</div>

7403

7404

7405

7406

7407

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

7408

</span>

7409

7410

7411

7412

7413

7414

7415

7416

7417

7418

7419

7420

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

7421

7422

7423

7424

7425

7426

<p>Inherited from

7427

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

7428

7429

7430

7431

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

7432

7433

</p>

7434

7435

7436

7437

7438

7439

</div>

7440

7441

7442

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

7443

7444

<p>

7445

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

7446

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

7447

</p>

7448

</div>

7449

7450

7451

7452

<h4>Parameters:</h4>

7453

7454

7455

7456

7457

7458

7459

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

7460

7461

7462

7463

7464

7465

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

7466

</div>

7467

7468

7469

</li>

7470

7471

7472

7473

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

7474

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

7475

7476

7477

7478

7479

7480

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

7481

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

7482

</div>

7483

7484

7485

</li>

7486

7487

7488

7489

7490

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

7491

7492

7493

7494

7495

7496

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

7497

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

7498

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

7499

</div>

7500

7501

7502

</li>

7503

7504

</ul>

7505

</div>

7506

7507

7508

7509

7510

<h4>Returns:</h4>

7511

7512

7513

7514

7515

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

7516

7517

A reference to the host object.

7518

7519

</div>

7520

</div>

7521

7522

7523

7524

</div>

7525

7526

7527

7528

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

7529

7530

7531

7532

7533

7534

7535

7536

7537

7538

</li>

7539

7540

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

7541

</div>

7542

7543

7544

7545

7546

7547

7548

7549

7550

7551

7552

7553

7554

7555

7556

7557

7558

7559

<p>Inherited from

7560

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

7561

7562

7563

7564

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

7565

7566

</p>

7567

7568

7569

7570

7571

7572

</div>

7573

7574

7575

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

7576

is determined by the order registered. Multiple targets can

7577

be specified.</p>

7578

7579

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

7580

7581

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

7582

</div>

7583

7584

7585

7586

<h4>Parameters:</h4>

7587

7588

7589

7590

7591

7592

7593

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

7594

7595

7596

7597

7598

7599

<p>the target to add</p>

7600

</div>

7601

7602

7603

</li>

7604

7605

</ul>

7606

</div>

7607

7608

7609

7610

7611

7612

</div>

7613

7614

7615

7616

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

7617

7618

7619

7620

7621

7622

7623

7624

7625

7626

</li>

7627

7628

7629

7630

7631

7632

</li>

7633

7634

7635

7636

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

7637

7638

</li>

7639

7640

7641

7642

7643

7644

</li>

7645

7646

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

7647

</div>

7648

7649

7650

7651

7652

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

7653

</span>

7654

7655

7656

7657

7658

7659

7660

7661

7662

7663

7664

7665

7666

7667

7668

7669

<p>Inherited from

7670

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

7671

7672

7673

7674

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

7675

7676

</p>

7677

7678

7679

7680

7681

7682

</div>

7683

7684

7685

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

7686

supplied callback will execute after any listeners add

7687

via the subscribe method, and after the default function,

7688

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

7689

</div>

7690

7691

7692

7693

<h4>Parameters:</h4>

7694

7695

7696

7697

7698

7699

7700

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

7701

7702

7703

7704

7705

7706

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

7707

</div>

7708

7709

7710

</li>

7711

7712

7713

7714

7715

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

7716

7717

7718

7719

7720

7721

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

7722

</div>

7723

7724

7725

</li>

7726

7727

7728

7729

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

7730

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

7731

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

7732

7733

7734

7735

7736

7737

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

7738

</div>

7739

7740

7741

</li>

7742

7743

7744

7745

7746

7747

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

7748

7749

7750

7751

7752

7753

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

7754

</div>

7755

7756

7757

</li>

7758

7759

</ul>

7760

</div>

7761

7762

7763

7764

7765

<h4>Returns:</h4>

7766

7767

7768

7769

7770

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

7771

7772

A subscription handle capable of detaching the

7773

subscription

7774

7775

</div>

7776

</div>

7777

7778

7779

7780

</div>

7781

7782

7783

7784

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

7785

7786

7787

7788

7789

7790

7791

7792

7793

7794

</li>

7795

7796

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

7797

</div>

7798

7799

7800

7801

7802

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

7803

</span>

7804

7805

7806

7807

7808

7809

7810

7811

7812

7813

7814

7815

7816

7817

7818

7819

<p>Inherited from

7820

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

7821

7822

7823

7824

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

7825

7826

</p>

7827

7828

7829

7830

7831

7832

</div>

7833

7834

7835

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

7836

</div>

7837

7838

7839

7840

<h4>Parameters:</h4>

7841

7842

7843

7844

7845

7846

7847

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

7848

7849

7850

7851

7852

7853

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

7854

</div>

7855

7856

7857

</li>

7858

7859

</ul>

7860

</div>

7861

7862

7863

7864

7865

<h4>Returns:</h4>

7866

7867

7868

7869

7870

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

7871

7872

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.

7873

7874

</div>

7875

</div>

7876

7877

7878

7879

</div>

7880

7881

7882

7883

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

7884

7885

7886

7887

7888

7889

7890

7891

7892

</span>

7893

7894

7895

7896

7897

7898

7899

7900

7901

7902

7903

7904

7905

7906

7907

7908

<p>Inherited from

7909

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

7910

7911

7912

7913

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

7914

7915

</p>

7916

7917

7918

7919

7920

7921

</div>

7922

7923

7924

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

7925

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

7926

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

7927

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

7928

7929

<p>For DOM and custom events:

7930

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

7931

7932

<p>For methods:

7933

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

7934

</div>

7935

7936

7937

7938

7939

7940

<h4>Returns:</h4>

7941

7942

7943

7944

7945

detach handle

7946

7947

</div>

7948

</div>

7949

7950

7951

7952

</div>

7953

7954

7955

7956

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

7957

7958

7959

7960

7961

7962

7963

7964

7965

7966

</li>

7967

7968

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

7969

</div>

7970

7971

7972

7973

7974

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

7975

</span>

7976

7977

7978

7979

7980

7981

7982

7983

7984

7985

7986

7987

7988

7989

7990

7991

<p>Inherited from

7992

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

7993

7994

7995

7996

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

7997

7998

</p>

7999

8000

8001

8002

8003

8004

</div>

8005

8006

8007

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

8008

</div>

8009

8010

8011

8012

<h4>Parameters:</h4>

8013

8014

8015

8016

8017

8018

8019

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

8020

8021

8022

8023

8024

8025

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

8026

</div>

8027

8028

8029

</li>

8030

8031

</ul>

8032

</div>

8033

8034

8035

8036

8037

<h4>Returns:</h4>

8038

8039

8040

8041

8042

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

8043

8044

the aggregated return value from Event.Custom.fire

8045

8046

</div>

8047

</div>

8048

8049

8050

8051

</div>

8052

8053

8054

8055

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

8056

8057

8058

8059

8060

8061

8062

8063

8064

8065

</li>

8066

8067

8068

8069

8070

8071

</li>

8072

8073

8074

8075

8076

8077

</li>

8078

8079

8080

8081

8082

8083

</li>

8084

8085

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

8086

</div>

8087

8088

8089

8090

8091

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

8092

</span>

8093

8094

8095

8096

8097

8098

8099

8100

8101

8102

8103

8104

8105

8106

8107

8108

8109

<p>

8110

8111

Defined in

8112

8113

8114

8115

8116

<a href="../files/editor_js_frame.js.html#l551"><code>editor/js/frame.js:551</code></a>

8117

8118

</p>

8119

8120

8121

8122

8123

8124

</div>

8125

8126

8127

<p>A delegate method passed to the instance's delegate method</p>

8128

</div>

8129

8130

8131

8132

<h4>Parameters:</h4>

8133

8134

8135

8136

8137

8138

8139

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

8140

8141

8142

8143

8144

8145

<p>The type of event to listen for</p>

8146

</div>

8147

8148

8149

</li>

8150

8151

8152

8153

8154

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

8155

8156

8157

8158

8159

8160

<p>The method to attach</p>

8161

</div>

8162

8163

8164

</li>

8165

8166

8167

8168

8169

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

8170

8171

8172

8173

8174

8175

<p>The container to act as a delegate, if no "sel" passed, the body is assumed as the container.</p>

8176

</div>

8177

8178

8179

</li>

8180

8181

8182

8183

8184

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

8185

8186

8187

8188

8189

8190

<p>The selector to match in the event (optional)</p>

8191

</div>

8192

8193

8194

</li>

8195

8196

</ul>

8197

</div>

8198

8199

8200

8201

8202

<h4>Returns:</h4>

8203

8204

8205

8206

8207

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

8208

8209

The Event handle returned from Y.delegate

8210

8211

</div>

8212

</div>

8213

8214

8215

8216

</div>

8217

8218

8219

8220

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

8221

8222

8223

8224

8225

8226

8227

8228

8229

</span>

8230

8231

8232

8233

8234

8235

8236

8237

8238

8239

8240

8241

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

8242

8243

8244

8245

8246

<p>Inherited from

8247

8248

BaseCore

8249

</a>

8250

8251

but overwritten in

8252

8253

8254

8255

8256

8257

</p>

8258

8259

8260

8261

8262

8263

</div>

8264

8265

8266

<p>

8267

Destroy lifecycle method. Fires the destroy

8268

event, prior to invoking destructors for the

8269

class hierarchy.

8270

</p>

8271

8272

<p>

8273

Subscribers to the destroy

8274

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

8275

from proceeding.

8276

</p>

8277

</div>

8278

8279

8280

8281

8282

8283

<h4>Returns:</h4>

8284

8285

8286

8287

8288

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

8289

8290

A reference to this object

8291

8292

</div>

8293

</div>

8294

8295

8296

8297

</div>

8298

8299

8300

8301

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

8302

8303

8304

8305

8306

8307

8308

8309

8310

8311

</li>

8312

8313

8314

8315

8316

8317

</li>

8318

8319

8320

8321

<code>context</code>

8322

8323

</li>

8324

8325

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

8326

</div>

8327

8328

8329

8330

8331

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

8332

</span>

8333

8334

8335

8336

8337

8338

8339

8340

8341

8342

8343

8344

8345

8346

8347

8348

<p>Inherited from

8349

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

8350

8351

8352

8353

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

8354

8355

</p>

8356

8357

8358

8359

8360

8361

</div>

8362

8363

8364

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

8365

</div>

8366

8367

8368

8369

<h4>Parameters:</h4>

8370

8371

8372

8373

8374

8375

8376

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

8377

8378

8379

8380

8381

8382

<p>Either the handle to the subscriber or the

8383

type of event. If the type

8384

is not specified, it will attempt to remove

8385

the listener from all hosted events.</p>

8386

</div>

8387

8388

8389

</li>

8390

8391

8392

8393

8394

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

8395

8396

8397

8398

8399

8400

<p>The subscribed function to unsubscribe, if not

8401

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

8402

</div>

8403

8404

8405

</li>

8406

8407

8408

8409

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

8410

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

8411

8412

8413

8414

8415

8416

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

8417

optional, but if supplied will be used to

8418

disambiguate multiple listeners that are the same

8419

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

8420

that lives on the prototype)</p>

8421

</div>

8422

8423

8424

</li>

8425

8426

</ul>

8427

</div>

8428

8429

8430

8431

8432

<h4>Returns:</h4>

8433

8434

8435

8436

8437

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

8438

8439

the host

8440

8441

</div>

8442

</div>

8443

8444

8445

8446

</div>

8447

8448

8449

8450

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

8451

8452

8453

8454

8455

8456

8457

8458

8459

8460

</li>

8461

8462

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

8463

</div>

8464

8465

8466

8467

8468

8469

8470

8471

8472

8473

8474

8475

8476

8477

8478

8479

8480

8481

<p>Inherited from

8482

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

8483

8484

8485

8486

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

8487

8488

</p>

8489

8490

8491

8492

8493

8494

</div>

8495

8496

8497

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

8498

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

8499

be removed.</p>

8500

</div>

8501

8502

8503

8504

<h4>Parameters:</h4>

8505

8506

8507

8508

8509

8510

8511

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

8512

8513

8514

8515

8516

8517

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

8518

</div>

8519

8520

8521

</li>

8522

8523

</ul>

8524

</div>

8525

8526

8527

8528

8529

8530

</div>

8531

8532

8533

8534

8535

8536

8537

8538

8539

8540

8541

8542

8543

8544

</li>

8545

8546

8547

8548

<code>arguments</code>

8549

8550

</li>

8551

8552

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

8553

</div>

8554

8555

8556

8557

8558

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

8559

</span>

8560

8561

8562

8563

8564

8565

8566

8567

8568

8569

8570

8571

8572

8573

8574

8575

<p>Inherited from

8576

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

8577

8578

8579

8580

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

8581

8582

</p>

8583

8584

8585

8586

8587

8588

</div>

8589

8590

8591

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

8592

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

8593

following parameters.</p>

8594

8595

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

8596

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

8597

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

8598

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

8599

be published on this object first.</p>

8600

8601

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

8602

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

8603

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

8604

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

8605

in place of the original object.</p>

8606

</div>

8607

8608

8609

8610

<h4>Parameters:</h4>

8611

8612

8613

8614

8615

8616

8617

8618

8619

8620

8621

8622

8623

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

8624

a 'type' property.</p>

8625

</div>

8626

8627

8628

</li>

8629

8630

8631

8632

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

8633

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

8634

8635

8636

8637

8638

8639

<p>an arbitrary set of parameters to pass to

8640

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

8641

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

8642

parameter after the properties the object literal contains are copied to

8643

the event facade.</p>

8644

</div>

8645

8646

8647

</li>

8648

8649

</ul>

8650

</div>

8651

8652

8653

8654

8655

<h4>Returns:</h4>

8656

8657

8658

8659

8660

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

8661

8662

the event host

8663

8664

</div>

8665

</div>

8666

8667

8668

8669

</div>

8670

8671

8672

8673

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

8674

8675

8676

8677

8678

8679

8680

8681

8682

8683

</li>

8684

8685

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

8686

</div>

8687

8688

8689

8690

8691

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

8692

</span>

8693

8694

8695

8696

8697

8698

8699

8700

8701

8702

8703

8704

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

8705

8706

8707

8708

8709

8710

8711

<p>

8712

8713

Defined in

8714

8715

8716

8717

8718

<a href="../files/editor_js_frame.js.html#l688"><code>editor/js/frame.js:688</code></a>

8719

8720

</p>

8721

8722

8723

8724

8725

8726

</div>

8727

8728

8729

<p>Set the focus to the iframe</p>

8730

</div>

8731

8732

8733

8734

<h4>Parameters:</h4>

8735

8736

8737

8738

8739

8740

8741

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

8742

8743

8744

8745

8746

8747

<p>Callback function to execute after focus happens</p>

8748

</div>

8749

8750

8751

</li>

8752

8753

</ul>

8754

</div>

8755

8756

8757

8758

8759

<h4>Returns:</h4>

8760

8761

8762

8763

8764

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

8765

8766

8767

</div>

8768

</div>

8769

8770

8771

8772

</div>

8773

8774

8775

8776

8777

8778

8779

8780

8781

8782

8783

8784

8785

8786

</li>

8787

8788

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

8789

</div>

8790

8791

8792

8793

8794

8795

</span>

8796

8797

8798

8799

8800

8801

8802

8803

8804

8805

8806

8807

8808

8809

8810

8811

<p>Inherited from

8812

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

8813

8814

8815

8816

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

8817

8818

</p>

8819

8820

8821

8822

8823

8824

</div>

8825

8826

8827

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

8828

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

8829

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

8830

</div>

8831

8832

8833

8834

<h4>Parameters:</h4>

8835

8836

8837

8838

8839

8840

8841

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

8842

8843

8844

8845

8846

8847

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

8848

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

8849

</div>

8850

8851

8852

</li>

8853

8854

</ul>

8855

</div>

8856

8857

8858

8859

8860

<h4>Returns:</h4>

8861

8862

8863

8864

8865

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

8866

8867

The value of the attribute

8868

8869

</div>

8870

</div>

8871

8872

8873

8874

</div>

8875

8876

8877

8878

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

8879

8880

8881

8882

8883

8884

8885

8886

<code>attrs</code>

8887

8888

</li>

8889

8890

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

8891

</div>

8892

8893

8894

8895

8896

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

8897

</span>

8898

8899

8900

8901

8902

8903

8904

8905

8906

8907

8908

8909

8910

8911

8912

8913

<p>Inherited from

8914

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

8915

8916

8917

8918

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

8919

8920

</p>

8921

8922

8923

8924

8925

8926

</div>

8927

8928

8929

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

8930

</div>

8931

8932

8933

8934

<h4>Parameters:</h4>

8935

8936

8937

8938

8939

8940

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

8941

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

8942

8943

8944

8945

8946

8947

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

8948

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

8949

</div>

8950

8951

8952

</li>

8953

8954

</ul>

8955

</div>

8956

8957

8958

8959

8960

<h4>Returns:</h4>

8961

8962

8963

8964

8965

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

8966

8967

An object with attribute name/value pairs.

8968

8969

</div>

8970

</div>

8971

8972

8973

8974

</div>

8975

8976

8977

8978

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

8979

8980

8981

8982

8983

8984

8985

8986

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

8987

</span>

8988

8989

8990

8991

8992

8993

8994

8995

8996

8997

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

8998

8999

9000

9001

9002

9003

9004

9005

9006

<p>

9007

9008

Defined in

9009

9010

9011

9012

9013

<a href="../files/editor_js_frame.js.html#l824"><code>editor/js/frame.js:824</code></a>

9014

9015

</p>

9016

9017

9018

9019

9020

9021

</div>

9022

9023

9024

<p>Parses document.doctype and generates a DocType to match the parent page, if supported.

9025

For IE8, it grabs document.all[0].nodeValue and uses that. For IE < 8, it falls back to Frame.DOC_TYPE.</p>

9026

</div>

9027

9028

9029

9030

9031

9032

<h4>Returns:</h4>

9033

9034

9035

9036

9037

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

9038

9039

The normalized DocType to apply to the iframe

9040

9041

</div>

9042

</div>

9043

9044

9045

9046

</div>

9047

9048

9049

9050

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

9051

9052

9053

9054

9055

9056

9057

9058

9059

9060

</li>

9061

9062

9063

9064

<code>prefixed</code>

9065

9066

</li>

9067

9068

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

9069

</div>

9070

9071

9072

9073

9074

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

9075

</span>

9076

9077

9078

9079

9080

9081

9082

9083

9084

9085

9086

9087

9088

9089

9090

9091

<p>Inherited from

9092

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

9093

9094

9095

9096

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

9097

9098

</p>

9099

9100

9101

9102

9103

9104

</div>

9105

9106

9107

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

9108

falsy value otherwise</p>

9109

</div>

9110

9111

9112

9113

<h4>Parameters:</h4>

9114

9115

9116

9117

9118

9119

9120

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

9121

9122

9123

9124

9125

9126

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

9127

</div>

9128

9129

9130

</li>

9131

9132

9133

9134

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

9135

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

9136

9137

9138

9139

9140

9141

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

9142

</div>

9143

9144

9145

</li>

9146

9147

</ul>

9148

</div>

9149

9150

9151

9152

9153

<h4>Returns:</h4>

9154

9155

9156

9157

9158

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

9159

9160

the custom event or null

9161

9162

</div>

9163

</div>

9164

9165

9166

9167

</div>

9168

9169

9170

9171

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

9172

9173

9174

9175

9176

9177

9178

9179

9180

</span>

9181

9182

9183

9184

9185

9186

9187

9188

9189

9190

9191

9192

9193

9194

9195

9196

9197

<p>

9198

9199

Defined in

9200

9201

9202

9203

9204

<a href="../files/editor_js_frame.js.html#l572"><code>editor/js/frame.js:572</code></a>

9205

9206

</p>

9207

9208

9209

9210

9211

9212

</div>

9213

9214

9215

<p>Get a reference to the internal YUI instance.</p>

9216

</div>

9217

9218

9219

9220

9221

9222

<h4>Returns:</h4>

9223

9224

9225

9226

9227

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

9228

9229

The internal YUI instance

9230

9231

</div>

9232

</div>

9233

9234

9235

9236

</div>

9237

9238

9239

9240

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

9241

9242

9243

9244

9245

9246

9247

9248

9249

</span>

9250

9251

9252

9253

9254

9255

9256

9257

9258

9259

9260

9261

9262

9263

9264

9265

<p>Inherited from

9266

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

9267

9268

9269

9270

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

9271

9272

</p>

9273

9274

9275

9276

9277

9278

</div>

9279

9280

9281

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

9282

</div>

9283

9284

9285

9286

9287

9288

<h4>Returns:</h4>

9289

9290

9291

9292

9293

EventTarget[]

9294

9295

</div>

9296

</div>

9297

9298

9299

9300

</div>

9301

9302

9303

9304

9305

9306

9307

9308

9309

9310

9311

9312

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

9313

</span>

9314

9315

9316

9317

9318

9319

9320

9321

9322

9323

9324

9325

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

9326

9327

9328

9329

9330

9331

9332

<p>

9333

9334

Defined in

9335

9336

9337

9338

9339

<a href="../files/editor_js_frame.js.html#l756"><code>editor/js/frame.js:756</code></a>

9340

9341

</p>

9342

9343

9344

9345

9346

9347

</div>

9348

9349

9350

<p>Hide the iframe instance</p>

9351

</div>

9352

9353

9354

9355

9356

9357

<h4>Returns:</h4>

9358

9359

9360

9361

9362

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

9363

9364

9365

</div>

9366

</div>

9367

9368

9369

9370

</div>

9371

9372

9373

9374

9375

9376

9377

9378

9379

9380

9381

9382

<code>config</code>

9383

9384

</li>

9385

9386

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

9387

</div>

9388

9389

9390

9391

9392

9393

</span>

9394

9395

9396

9397

9398

9399

9400

9401

9402

9403

9404

9405

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

9406

9407

9408

9409

9410

<p>Inherited from

9411

9412

BaseCore

9413

</a>

9414

9415

but overwritten in

9416

9417

9418

9419

9420

9421

</p>

9422

9423

9424

9425

9426

9427

</div>

9428

9429

9430

<p>Init lifecycle method, invoked during construction.

9431

Fires the init event prior to setting up attributes and

9432

invoking initializers for the class hierarchy.</p>

9433

</div>

9434

9435

9436

9437

<h4>Parameters:</h4>

9438

9439

9440

9441

9442

9443

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

9444

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

9445

9446

9447

9448

9449

9450

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

9451

</div>

9452

9453

9454

</li>

9455

9456

</ul>

9457

</div>

9458

9459

9460

9461

9462

<h4>Returns:</h4>

9463

9464

9465

9466

9467

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

9468

9469

A reference to this object

9470

9471

</div>

9472

</div>

9473

9474

9475

9476

</div>

9477

9478

9479

9480

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

9481

9482

9483

9484

9485

9486

9487

9488

9489

9490

</li>

9491

9492

9493

9494

<code>config</code>

9495

9496

</li>

9497

9498

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

9499

</div>

9500

9501

9502

9503

9504

9505

9506

9507

9508

9509

9510

9511

9512

9513

9514

9515

9516

9517

<p>Inherited from

9518

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

9519

9520

9521

9522

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

9523

9524

</p>

9525

9526

9527

9528

9529

9530

</div>

9531

9532

9533

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

9534

9535

<p>

9536

The properties which can be modified through this interface are limited

9537

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

9538

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

9539

broadcast and getter.

9540

</p>

9541

</div>

9542

9543

9544

9545

<h4>Parameters:</h4>

9546

9547

9548

9549

9550

9551

9552

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

9553

9554

9555

9556

9557

9558

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

9559

</div>

9560

9561

9562

</li>

9563

9564

9565

9566

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

9567

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

9568

9569

9570

9571

9572

9573

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

9574

</div>

9575

9576

9577

</li>

9578

9579

</ul>

9580

</div>

9581

9582

9583

9584

9585

9586

</div>

9587

9588

9589

9590

9591

9592

9593

9594

9595

9596

9597

9598

9599

9600

</li>

9601

9602

9603

9604

9605

9606

</li>

9607

9608

9609

9610

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

9611

9612

</li>

9613

9614

9615

9616

9617

9618

</li>

9619

9620

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

9621

</div>

9622

9623

9624

9625

9626

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

9627

</span>

9628

9629

9630

9631

9632

9633

9634

9635

9636

9637

9638

9639

9640

9641

9642

9643

<p>Inherited from

9644

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

9645

9646

9647

9648

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

9649

9650

</p>

9651

9652

9653

9654

9655

9656

</div>

9657

9658

9659

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

9660

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

9661

9662

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

9663

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

9664

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

9665

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

9666

API for all available properties and methods. Subscribers to

9667

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

9668

after the event name.</p>

9669

9670

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

9671

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

9672

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

9673

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

9674

9675

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

9676

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

9677

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

9678

</div>

9679

9680

9681

9682

<h4>Parameters:</h4>

9683

9684

9685

9686

9687

9688

9689

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

9690

9691

9692

9693

9694

9695

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

9696

</div>

9697

9698

9699

</li>

9700

9701

9702

9703

9704

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

9705

9706

9707

9708

9709

9710

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

9711

</div>

9712

9713

9714

</li>

9715

9716

9717

9718

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

9719

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

9720

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

9721

9722

9723

9724

9725

9726

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

9727

</div>

9728

9729

9730

</li>

9731

9732

9733

9734

9735

9736

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

9737

9738

9739

9740

9741

9742

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

9743

</div>

9744

9745

9746

</li>

9747

9748

</ul>

9749

</div>

9750

9751

9752

9753

9754

<h4>Returns:</h4>

9755

9756

9757

9758

9759

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

9760

9761

A subscription handle capable of detaching that

9762

subscription

9763

9764

</div>

9765

</div>

9766

9767

9768

9769

</div>

9770

9771

9772

9773

9774

9775

9776

9777

9778

9779

9780

9781

9782

9783

</li>

9784

9785

9786

9787

9788

9789

</li>

9790

9791

9792

9793

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

9794

9795

</li>

9796

9797

9798

9799

9800

9801

</li>

9802

9803

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

9804

</div>

9805

9806

9807

9808

9809

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

9810

</span>

9811

9812

9813

9814

9815

9816

9817

9818

9819

9820

9821

9822

9823

9824

9825

9826

<p>Inherited from

9827

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

9828

9829

9830

9831

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

9832

9833

</p>

9834

9835

9836

9837

9838

9839

</div>

9840

9841

9842

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

9843

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

9844

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

9845

</div>

9846

9847

9848

9849

<h4>Parameters:</h4>

9850

9851

9852

9853

9854

9855

9856

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

9857

9858

9859

9860

9861

9862

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

9863

</div>

9864

9865

9866

</li>

9867

9868

9869

9870

9871

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

9872

9873

9874

9875

9876

9877

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

9878

</div>

9879

9880

9881

</li>

9882

9883

9884

9885

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

9886

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

9887

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

9888

9889

9890

9891

9892

9893

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

9894

</div>

9895

9896

9897

</li>

9898

9899

9900

9901

9902

9903

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

9904

9905

9906

9907

9908

9909

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

9910

</div>

9911

9912

9913

</li>

9914

9915

</ul>

9916

</div>

9917

9918

9919

9920

9921

<h4>Returns:</h4>

9922

9923

9924

9925

9926

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

9927

9928

A subscription handle capable of detaching the

9929

subscription

9930

9931

</div>

9932

</div>

9933

9934

9935

9936

</div>

9937

9938

9939

9940

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

9941

9942

9943

9944

9945

9946

9947

9948

9949

9950

</li>

9951

9952

9953

9954

9955

9956

</li>

9957

9958

9959

9960

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

9961

9962

</li>

9963

9964

9965

9966

9967

9968

</li>

9969

9970

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

9971

</div>

9972

9973

9974

9975

9976

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

9977

</span>

9978

9979

9980

9981

9982

9983

9984

9985

9986

9987

9988

9989

9990

9991

9992

9993

<p>Inherited from

9994

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

9995

9996

9997

9998

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

9999

10000

</p>

10001

10002

10003

10004

10005

10006

</div>

10007

10008

10009

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

10010

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

10011

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

10012

</div>

10013

10014

10015

10016

<h4>Parameters:</h4>

10017

10018

10019

10020

10021

10022

10023

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

10024

10025

10026

10027

10028

10029

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

10030

</div>

10031

10032

10033

</li>

10034

10035

10036

10037

10038

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

10039

10040

10041

10042

10043

10044

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

10045

</div>

10046

10047

10048

</li>

10049

10050

10051

10052

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

10053

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

10054

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

10055

10056

10057

10058

10059

10060

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

10061

</div>

10062

10063

10064

</li>

10065

10066

10067

10068

10069

10070

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

10071

10072

10073

10074

10075

10076

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

10077

</div>

10078

10079

10080

</li>

10081

10082

</ul>

10083

</div>

10084

10085

10086

10087

10088

<h4>Returns:</h4>

10089

10090

10091

10092

10093

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

10094

10095

A subscription handle capable of detaching that

10096

subscription

10097

10098

</div>

10099

</div>

10100

10101

10102

10103

</div>

10104

10105

10106

10107

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

10108

10109

10110

10111

10112

10113

10114

10115

10116

10117

</li>

10118

10119

10120

10121

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

10122

10123

</li>

10124

10125

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

10126

</div>

10127

10128

10129

10130

10131

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

10132

</span>

10133

10134

10135

10136

10137

10138

10139

10140

10141

10142

10143

10144

10145

10146

10147

10148

<p>Inherited from

10149

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

10150

10151

10152

10153

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

10154

10155

</p>

10156

10157

10158

10159

10160

10161

<p>Available since 3.3.0</p>

10162

10163

</div>

10164

10165

10166

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

10167

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

10168

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

10169

to include the prefix one is supplied or the event target

10170

is configured with a default prefix.</p>

10171

</div>

10172

10173

10174

10175

<h4>Parameters:</h4>

10176

10177

10178

10179

10180

10181

10182

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

10183

10184

10185

10186

10187

10188

10189

</div>

10190

10191

10192

</li>

10193

10194

10195

10196

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

10197

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

10198

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

10199

10200

10201

10202

10203

10204

<p>the prefix</p>

10205

</div>

10206

10207

10208

</li>

10209

10210

</ul>

10211

</div>

10212

10213

10214

10215

10216

<h4>Returns:</h4>

10217

10218

10219

10220

10221

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

10222

10223

an array containing:

10224

* the detach category, if supplied,

10225

* the prefixed event type,

10226

* whether or not this is an after listener,

10227

* the supplied event type

10228

10229

</div>

10230

</div>

10231

10232

10233

10234

</div>

10235

10236

10237

10238

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

10239

10240

10241

10242

10243

10244

10245

10246

10247

10248

</li>

10249

10250

10251

10252

10253

10254

</li>

10255

10256

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

10257

</div>

10258

10259

10260

10261

10262

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

10263

</span>

10264

10265

10266

10267

10268

10269

10270

10271

10272

10273

10274

10275

10276

10277

10278

10279

<p>Inherited from

10280

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

10281

10282

10283

10284

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

10285

10286

</p>

10287

10288

10289

10290

10291

10292

</div>

10293

10294

10295

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

10296

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

10297

case the custom event is returned.</p>

10298

</div>

10299

10300

10301

10302

<h4>Parameters:</h4>

10303

10304

10305

10306

10307

10308

10309

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

10310

10311

10312

10313

10314

10315

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

10316

</div>

10317

10318

10319

</li>

10320

10321

10322

10323

10324

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

10325

10326

10327

10328

10329

10330

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

10331

10332

<p><ul>

10333

<li>

10334

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

10335

</li>

10336

<li>

10337

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

10338

Events can only bubble if emitFacade is true.

10339

</li>

10340

<li>

10341

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

10342

</li>

10343

<li>

10344

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

10345

</li>

10346

<li>

10347

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

10348

</li>

10349

<li>

10350

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

10351

</li>

10352

<li>

10353

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

10354

the fire will be notified immediately.

10355

</li>

10356

<li>

10357

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

10358

fired unless async is true.

10359

</li>

10360

<li>

10361

'preventable': whether or not preventDefault() has an effect (true)

10362

</li>

10363

<li>

10364

'preventedFn': a function that is executed when preventDefault is called

10365

</li>

10366

<li>

10367

'queuable': whether or not this event can be queued during bubbling (false)

10368

</li>

10369

<li>

10370

'silent': if silent is true, debug messages are not provided for this event.

10371

</li>

10372

<li>

10373

'stoppedFn': a function that is executed when stopPropagation is called

10374

</li></p>

10375

10376

<p><li>

10377

'monitored': specifies whether or not this event should send notifications about

10378

when the event has been attached, detached, or published.

10379

</li>

10380

<li>

10381

'type': the event type (valid option if not provided as the first parameter to publish)

10382

</li>

10383

</ul></p>

10384

</div>

10385

10386

10387

</li>

10388

10389

</ul>

10390

</div>

10391

10392

10393

10394

10395

<h4>Returns:</h4>

10396

10397

10398

10399

10400

<span class="type"><a href="../classes/CustomEvent.html" class="crosslink">CustomEvent</a></span>:

10401

10402

the custom event

10403

10404

</div>

10405

</div>

10406

10407

10408

10409

</div>

10410

10411

10412

10413

<h3 class="name"><code>removeAttr</code></h3>

10414

10415

10416

10417

10418

10419

10420

10421

10422

10423

</li>

10424

10425

</ul><span class="paren">)</span>

10426

</div>

10427

10428

10429

10430

10431

10432

10433

10434

10435

10436

10437

10438

10439

10440

10441

10442

10443

10444

<p>Inherited from

10445

<a href="../classes/AttributeExtras.html#method_removeAttr">AttributeExtras</a>:

10446

10447

10448

10449

<a href="../files/attribute_js_AttributeExtras.js.html#l77"><code>attribute/js/AttributeExtras.js:77</code></a>

10450

10451

</p>

10452

10453

10454

10455

10456

10457

</div>

10458

10459

10460

<p>Removes an attribute from the host object</p>

10461

</div>

10462

10463

10464

10465

<h4>Parameters:</h4>

10466

10467

10468

10469

10470

10471

10472

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

10473

10474

10475

10476

10477

10478

<p>The name of the attribute to be removed.</p>

10479

</div>

10480

10481

10482

</li>

10483

10484

</ul>

10485

</div>

10486

10487

10488

10489

10490

10491

</div>

10492

10493

10494

10495

<h3 class="name"><code>removeTarget</code></h3>

10496

10497

10498

10499

10500

10501

10502

10503

10504

10505

</li>

10506

10507

</ul><span class="paren">)</span>

10508

</div>

10509

10510

10511

10512

10513

10514

10515

10516

10517

10518

10519

10520

10521

10522

10523

10524

10525

10526

<p>Inherited from

10527

<a href="../classes/EventTarget.html#method_removeTarget">EventTarget</a>:

10528

10529

10530

10531

<a href="../files/event-custom_js_event-facade.js.html#l409"><code>event-custom/js/event-facade.js:409</code></a>

10532

10533

</p>

10534

10535

10536

10537

10538

10539

</div>

10540

10541

10542

<p>Removes a bubble target</p>

10543

</div>

10544

10545

10546

10547

<h4>Parameters:</h4>

10548

10549

10550

10551

10552

10553

10554

<span class="type"><a href="../classes/EventTarget.html" class="crosslink">EventTarget</a></span>

10555

10556

10557

10558

10559

10560

<p>the target to remove</p>

10561

</div>

10562

10563

10564

</li>

10565

10566

</ul>

10567

</div>

10568

10569

10570

10571

10572

10573

</div>

10574

10575

10576

10577

<h3 class="name"><code>render</code></h3>

10578

10579

10580

10581

10582

10583

10584

10585

10586

10587

</li>

10588

10589

</ul><span class="paren">)</span>

10590

</div>

10591

10592

10593

10594

10595

<span class="type"><a href="../classes/Frame.html" class="crosslink">Frame</a></span>

10596

</span>

10597

10598

10599

10600

10601

10602

10603

10604

10605

10606

10607

10608

<span class="flag chainable">chainable</span>

10609

10610

10611

10612

10613

10614

10615

<p>

10616

10617

Defined in

10618

10619

10620

10621

10622

<a href="../files/editor_js_frame.js.html#l580"><code>editor/js/frame.js:580</code></a>

10623

10624

</p>

10625

10626

10627

10628

10629

10630

</div>

10631

10632

10633

<p>Render the iframe into the container config option or open the window.</p>

10634

</div>

10635

10636

10637

10638

<h4>Parameters:</h4>

10639

10640

10641

10642

10643

10644

10645

<span class="type">String/HTMLElement/Node</span>

10646

10647

10648

10649

10650

10651

<p>The node to render to</p>

10652

</div>

10653

10654

10655

</li>

10656

10657

</ul>

10658

</div>

10659

10660

10661

10662

10663

<h4>Returns:</h4>

10664

10665

10666

10667

10668

<span class="type"><a href="../classes/Frame.html" class="crosslink">Frame</a></span>:

10669

10670

10671

</div>

10672

</div>

10673

10674

10675

10676

</div>

10677

10678

10679

10680

<h3 class="name"><code>reset</code></h3>

10681

10682

10683

10684

10685

10686

10687

10688

10689

10690

</li>

10691

10692

</ul><span class="paren">)</span>

10693

</div>

10694

10695

10696

10697

10698

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>

10699

</span>

10700

10701

10702

10703

10704

10705

10706

10707

10708

10709

10710

10711

<span class="flag chainable">chainable</span>

10712

10713

10714

10715

10716

10717

<p>Inherited from

10718

<a href="../classes/AttributeExtras.html#method_reset">AttributeExtras</a>:

10719

10720

10721

10722

<a href="../files/attribute_js_AttributeExtras.js.html#l87"><code>attribute/js/AttributeExtras.js:87</code></a>

10723

10724

</p>

10725

10726

10727

10728

10729

10730

</div>

10731

10732

10733

<p>Resets the attribute (or all attributes) to its initial value, as long as

10734

the attribute is not readOnly, or writeOnce.</p>

10735

</div>

10736

10737

10738

10739

<h4>Parameters:</h4>

10740

10741

10742

10743

10744

10745

10746

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

10747

10748

10749

10750

10751

10752

<p>Optional. The name of the attribute to reset. If omitted, all attributes are reset.</p>

10753

</div>

10754

10755

10756

</li>

10757

10758

</ul>

10759

</div>

10760

10761

10762

10763

10764

<h4>Returns:</h4>

10765

10766

10767

10768

10769

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>:

10770

10771

A reference to the host object.

10772

10773

</div>

10774

</div>

10775

10776

10777

10778

</div>

10779

10780

10781

10782

10783

10784

10785

10786

10787

10788

10789

10790

10791

10792

</li>

10793

10794

10795

10796

<code>value</code>

10797

10798

</li>

10799

10800

</ul><span class="paren">)</span>

10801

</div>

10802

10803

10804

10805

10806

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>

10807

</span>

10808

10809

10810

10811

10812

10813

10814

10815

10816

10817

10818

10819

<span class="flag chainable">chainable</span>

10820

10821

10822

10823

10824

<p>Inherited from

10825

10826

AttributeEvents

10827

</a>

10828

10829

but overwritten in

10830

10831

10832

10833

<a href="../files/attribute_js_AttributeCore.js.html#l328"><code>attribute/js/AttributeCore.js:328</code></a>

10834

10835

</p>

10836

10837

10838

10839

10840

10841

</div>

10842

10843

10844

<p>Sets the value of an attribute.</p>

10845

</div>

10846

10847

10848

10849

<h4>Parameters:</h4>

10850

10851

10852

10853

10854

10855

10856

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

10857

10858

10859

10860

10861

10862

<p>The name of the attribute. If the

10863

current value of the attribute is an Object, dot notation can be used

10864

to set the value of a property within the object (e.g. <code>set("x.y.z", 5)</code>).</p>

10865

</div>

10866

10867

10868

</li>

10869

10870

10871

10872

<code class="param-name">value</code>

10873

10874

10875

10876

10877

10878

10879

<p>The value to set the attribute to.</p>

10880

</div>

10881

10882

10883

</li>

10884

10885

</ul>

10886

</div>

10887

10888

10889

10890

10891

<h4>Returns:</h4>

10892

10893

10894

10895

10896

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>:

10897

10898

A reference to the host object.

10899

10900

</div>

10901

</div>

10902

10903

10904

10905

</div>

10906

10907

10908

10909

<h3 class="name"><code>setAttrs</code></h3>

10910

10911

10912

10913

10914

10915

10916

10917

<code>attrs</code>

10918

10919

</li>

10920

10921

</ul><span class="paren">)</span>

10922

</div>

10923

10924

10925

10926

10927

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>

10928

</span>

10929

10930

10931

10932

10933

10934

10935

10936

10937

10938

10939

10940

<span class="flag chainable">chainable</span>

10941

10942

10943

10944

10945

<p>Inherited from

10946

10947

AttributeEvents

10948

</a>

10949

10950

but overwritten in

10951

10952

10953

10954

<a href="../files/attribute_js_AttributeCore.js.html#l635"><code>attribute/js/AttributeCore.js:635</code></a>

10955

10956

</p>

10957

10958

10959

10960

10961

10962

</div>

10963

10964

10965

<p>Sets multiple attribute values.</p>

10966

</div>

10967

10968

10969

10970

<h4>Parameters:</h4>

10971

10972

10973

10974

10975

10976

<code class="param-name">attrs</code>

10977

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>

10978

10979

10980

10981

10982

10983

<p>An object with attributes name/value pairs.</p>

10984

</div>

10985

10986

10987

</li>

10988

10989

</ul>

10990

</div>

10991

10992

10993

10994

10995

<h4>Returns:</h4>

10996

10997

10998

10999

11000

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>:

11001

11002

A reference to the host object.

11003

11004

</div>

11005

</div>

11006

11007

11008

11009

</div>

11010

11011

11012

11013

11014

11015

11016

11017

11018

11019

11020

11021

<span class="type"><a href="../classes/Frame.html" class="crosslink">Frame</a></span>

11022

</span>

11023

11024

11025

11026

11027

11028

11029

11030

11031

11032

11033

11034

<span class="flag chainable">chainable</span>

11035

11036

11037

11038

11039

11040

11041

<p>

11042

11043

Defined in

11044

11045

11046

11047

11048

<a href="../files/editor_js_frame.js.html#l735"><code>editor/js/frame.js:735</code></a>

11049

11050

</p>

11051

11052

11053

11054

11055

11056

</div>

11057

11058

11059

<p>Show the iframe instance</p>

11060

</div>

11061

11062

11063

11064

11065

11066

<h4>Returns:</h4>

11067

11068

11069

11070

11071

<span class="type"><a href="../classes/Frame.html" class="crosslink">Frame</a></span>:

11072

11073

11074

</div>

11075

</div>

11076

11077

11078

11079

</div>

11080

11081

11082

11083

<h3 class="name"><code>subscribe</code></h3>

11084

11085

11086

11087

11088

11089

11090

11091

11092

<span class="flag deprecated" title="use on">deprecated</span>

11093

11094

11095

11096

11097

11098

11099

11100

11101

11102

11103

11104

11105

11106

<p>Inherited from

11107

<a href="../classes/EventTarget.html#method_subscribe">EventTarget</a>:

11108

11109

11110

11111

<a href="../files/event-custom_js_event-target.js.html#l335"><code>event-custom/js/event-target.js:335</code></a>

11112

11113

</p>

11114

11115

11116

11117

<p>Deprecated: use on</p>

11118

11119

11120

11121

</div>

11122

11123

11124

<p>subscribe to an event</p>

11125

</div>

11126

11127

11128

11129

11130

11131

11132

</div>

11133

11134

11135

11136

<h3 class="name"><code>toString</code></h3>

11137

11138

11139

11140

11141

11142

11143

11144

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

11145

</span>

11146

11147

11148

11149

11150

11151

11152

11153

11154

11155

11156

11157

11158

11159

11160

11161

<p>Inherited from

11162

<a href="../classes/BaseCore.html#method_toString">BaseCore</a>:

11163

11164

11165

11166

<a href="../files/base_js_BaseCore.js.html#l592"><code>base/js/BaseCore.js:592</code></a>

11167

11168

</p>

11169

11170

11171

11172

11173

11174

</div>

11175

11176

11177

<p>Default toString implementation. Provides the constructor NAME

11178

and the instance guid, if set.</p>

11179

</div>

11180

11181

11182

11183

11184

11185

<h4>Returns:</h4>

11186

11187

11188

11189

11190

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>:

11191

11192

String representation for this object

11193

11194

</div>

11195

</div>

11196

11197

11198

11199

</div>

11200

11201

11202

11203

<h3 class="name"><code>unsubscribe</code></h3>

11204

11205

11206

11207

11208

11209

11210

11211

11212

<span class="flag deprecated" title="use detach">deprecated</span>

11213

11214

11215

11216

11217

11218

11219

11220

11221

11222

11223

11224

11225

11226

<p>Inherited from

11227

<a href="../classes/EventTarget.html#method_unsubscribe">EventTarget</a>:

11228

11229

11230

11231

<a href="../files/event-custom_js_event-target.js.html#l455"><code>event-custom/js/event-target.js:455</code></a>

11232

11233

</p>

11234

11235

11236

11237

<p>Deprecated: use detach</p>

11238

11239

11240

11241

</div>

11242

11243

11244

<p>detach a listener</p>

11245

</div>

11246

11247

11248

11249

11250

11251

11252

</div>

11253

11254

11255

11256

<h3 class="name"><code>unsubscribeAll</code></h3>

11257

11258

11259

11260

11261

11262

11263

11264

11265

11266

</li>

11267

11268

</ul><span class="paren">)</span>

11269

</div>

11270

11271

11272

11273

11274

11275

<span class="flag deprecated" title="use detachAll">deprecated</span>

11276

11277

11278

11279

11280

11281

11282

11283

11284

11285

11286

11287

11288

11289

<p>Inherited from

11290

<a href="../classes/EventTarget.html#method_unsubscribeAll">EventTarget</a>:

11291

11292

11293

11294

<a href="../files/event-custom_js_event-target.js.html#l476"><code>event-custom/js/event-target.js:476</code></a>

11295

11296

</p>

11297

11298

11299

11300

<p>Deprecated: use detachAll</p>

11301

11302

11303

11304

</div>

11305

11306

11307

<p>Removes all listeners from the specified event. If the event type

11308

is not specified, all listeners from all hosted custom events will

11309

be removed.</p>

11310

</div>

11311

11312

11313

11314

<h4>Parameters:</h4>

11315

11316

11317

11318

11319

11320

11321

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

11322

11323

11324

11325

11326

11327

<p>The type, or name of the event</p>

11328

</div>

11329

11330

11331

</li>

11332

11333

</ul>

11334

</div>

11335

11336

11337

11338

11339

11340

</div>

11341

11342

11343

11344

11345

11346

11347

11348

11349

11350

11351

11352

11353

11354

11355

11356

11357

11358

11359

11360

11361

11362

11363

11364

11365

11366

<p>

11367

11368

Defined in

11369

11370

11371

11372

11373

<a href="../files/editor_js_frame.js.html#l528"><code>editor/js/frame.js:528</code></a>

11374

11375

</p>

11376

11377

11378

11379

11380

11381

</div>

11382

11383

11384

<p>This is a scoped version of the normal YUI.use method & is bound to this frame/window.

11385

At setup, the inst.use method is mapped to this method.</p>

11386

</div>

11387

11388

11389

11390

11391

11392

11393

</div>

11394

11395

11396

</div>

11397

11398

11399

11400

11401

<h2 class="off-left">Properties</h2>

11402

11403

11404

11405

<h3 class="name"><code>_allowAdHocAttrs</code></h3>

11406

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>

11407

11408

11409

11410

11411

<span class="flag protected">protected</span>

11412

11413

11414

11415

11416

11417

11418

11419

11420

11421

<p>Inherited from

11422

<a href="../classes/BaseCore.html#property__allowAdHocAttrs">BaseCore</a>:

11423

11424

11425

11426

<a href="../files/base_js_BaseCore.js.html#l100"><code>base/js/BaseCore.js:100</code></a>

11427

11428

</p>

11429

11430

11431

11432

11433

</div>

11434

11435

11436

<p>This property controls whether or not instances of this class should

11437

allow users to add ad-hoc attributes through the constructor configuration

11438

hash.</p>

11439

11440

<p>AdHoc attributes are attributes which are not defined by the class, and are

11441

not handled by the MyClass.<em>NON</em>ATTRS_CFG</p>

11442

</div>

11443

11444

11445

<p><strong>Default:</strong> undefined (false)</p>

11446

11447

11448

11449

11450

11451

</div>

11452

11453

11454

11455

<h3 class="name"><code>_iframe</code></h3>

11456

11457

11458

11459

11460

11461

<span class="flag private">private</span>

11462

11463

11464

11465

11466

11467

11468

11469

11470

11471

11472

<p>

11473

11474

Defined in

11475

11476

11477

11478

11479

<a href="../files/editor_js_frame.js.html#l33"><code>editor/js/frame.js:33</code></a>

11480

11481

</p>

11482

11483

11484

11485

11486

</div>

11487

11488

11489

<p>Internal Node reference to the iFrame or the window</p>

11490

</div>

11491

11492

11493

11494

11495

11496

11497

</div>

11498

11499

11500

11501

<h3 class="name"><code>_instance</code></h3>

11502

11503

11504

11505

11506

11507

<span class="flag private">private</span>

11508

11509

11510

11511

11512

11513

11514

11515

11516

11517

11518

<p>

11519

11520

Defined in

11521

11522

11523

11524

11525

<a href="../files/editor_js_frame.js.html#l40"><code>editor/js/frame.js:40</code></a>

11526

11527

</p>

11528

11529

11530

11531

11532

</div>

11533

11534

11535

<p>Internal reference to the YUI instance bound to the iFrame or window</p>

11536

</div>

11537

11538

11539

11540

11541

11542

11543

</div>

11544

11545

11546

11547

<h3 class="name"><code>_ready</code></h3>

11548

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>

11549

11550

11551

11552

11553

<span class="flag private">private</span>

11554

11555

11556

11557

11558

11559

11560

11561

11562

11563

11564

<p>

11565

11566

Defined in

11567

11568

11569

11570

11571

<a href="../files/editor_js_frame.js.html#l19"><code>editor/js/frame.js:19</code></a>

11572

11573

</p>

11574

11575

11576

11577

11578

</div>

11579

11580

11581

<p>Internal reference set when the content is ready.</p>

11582

</div>

11583

11584

11585

11586

11587

11588

11589

</div>

11590

11591

11592

11593

<h3 class="name"><code>_rendered</code></h3>

11594

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>

11595

11596

11597

11598

11599

<span class="flag private">private</span>

11600

11601

11602

11603

11604

11605

11606

11607

11608

11609

11610

<p>

11611

11612

Defined in

11613

11614

11615

11616

11617

<a href="../files/editor_js_frame.js.html#l26"><code>editor/js/frame.js:26</code></a>

11618

11619

</p>

11620

11621

11622

11623

11624

</div>

11625

11626

11627

<p>Internal reference set when render is called.</p>

11628

</div>

11629

11630

11631

11632

11633

11634

11635

</div>

11636

11637

11638

11639

<h3 class="name"><code>DEFAULT_CSS</code></h3>

11640

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

11641

11642

11643

11644

11645

11646

11647

11648

11649

<span class="flag static">static</span>

11650

11651

11652

11653

11654

11655

11656

<p>

11657

11658

Defined in

11659

11660

11661

11662

11663

<a href="../files/editor_js_frame.js.html#l800"><code>editor/js/frame.js:800</code></a>

11664

11665

</p>

11666

11667

11668

11669

11670

</div>

11671

11672

11673

<p>The default css used when creating the document.</p>

11674

</div>

11675

11676

11677

11678

11679

11680

11681

</div>

11682

11683

11684

11685

11686

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

11687

11688

11689

11690

11691

11692

11693

11694

11695

<span class="flag static">static</span>

11696

11697

11698

11699

11700

11701

11702

<p>

11703

11704

Defined in

11705

11706

11707

11708

11709

<a href="../files/editor_js_frame.js.html#l853"><code>editor/js/frame.js:853</code></a>

11710

11711

</p>

11712

11713

11714

11715

11716

</div>

11717

11718

11719

<p>The DOCTYPE to prepend to the new document when created. Should match the one on the page being served.</p>

11720

</div>

11721

11722

11723

11724

11725

11726

11727

</div>

11728

11729

11730

11731

<h3 class="name"><code>DOM_EVENTS</code></h3>

11732

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>

11733

11734

11735

11736

11737

11738

11739

11740

11741

<span class="flag static">static</span>

11742

11743

11744

11745

11746

11747

11748

<p>

11749

11750

Defined in

11751

11752

11753

11754

11755

<a href="../files/editor_js_frame.js.html#l778"><code>editor/js/frame.js:778</code></a>

11756

11757

</p>

11758

11759

11760

11761

11762

</div>

11763

11764

11765

<p>The DomEvents that the frame automatically attaches and bubbles</p>

11766

</div>

11767

11768

11769

11770

11771

11772

11773

</div>

11774

11775

11776

11777

11778

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

11779

11780

11781

11782

11783

11784

11785

11786

11787

<span class="flag static">static</span>

11788

11789

11790

11791

11792

11793

11794

<p>

11795

11796

Defined in

11797

11798

11799

11800

11801

<a href="../files/editor_js_frame.js.html#l808"><code>editor/js/frame.js:808</code></a>

11802

11803

</p>

11804

11805

11806

11807

11808

</div>

11809

11810

11811

<p>The template string used to create the iframe</p>

11812

</div>

11813

11814

11815

11816

11817

11818

11819

</div>

11820

11821

11822

11823

11824

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

11825

11826

11827

11828

11829

11830

11831

11832

11833

<span class="flag static">static</span>

11834

11835

11836

11837

11838

11839

11840

<p>

11841

11842

Defined in

11843

11844

11845

11846

11847

<a href="../files/editor_js_frame.js.html#l860"><code>editor/js/frame.js:860</code></a>

11848

11849

</p>

11850

11851

11852

11853

11854

</div>

11855

11856

11857

<p>The meta-tag for Content-Type to add to the dynamic document</p>

11858

</div>

11859

11860

11861

11862

11863

11864

11865

</div>

11866

11867

11868

11869

11870

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

11871

11872

11873

11874

11875

11876

11877

11878

11879

<span class="flag static">static</span>

11880

11881

11882

11883

11884

11885

11886

<p>

11887

11888

Defined in

11889

11890

11891

11892

11893

<a href="../files/editor_js_frame.js.html#l868"><code>editor/js/frame.js:868</code></a>

11894

11895

</p>

11896

11897

11898

11899

11900

</div>

11901

11902

11903

<p>The name of the class (frame)</p>

11904

</div>

11905

11906

11907

11908

11909

11910

11911

</div>

11912

11913

11914

11915

11916

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

11917

11918

11919

<span class="flag deprecated" title="Use this.constructor.NAME">deprecated</span>

11920

11921

11922

11923

11924

11925

11926

11927

11928

11929

11930

11931

<p>Inherited from

11932

<a href="../classes/BaseCore.html#property_name">BaseCore</a>:

11933

11934

11935

11936

<a href="../files/base_js_BaseCore.js.html#l196"><code>base/js/BaseCore.js:196</code></a>

11937

11938

</p>

11939

11940

11941

<p>Deprecated: Use this.constructor.NAME</p>

11942

11943

11944

11945

</div>

11946

11947

11948

<p>The string used to identify the class of this object.</p>

11949

</div>

11950

11951

11952

11953

11954

11955

11956

</div>

11957

11958

11959

11960

11961

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

11962

11963

11964

11965

11966

11967

11968

11969

11970

<span class="flag static">static</span>

11971

11972

11973

11974

11975

11976

11977

<p>

11978

11979

Defined in

11980

11981

11982

11983

11984

<a href="../files/editor_js_frame.js.html#l816"><code>editor/js/frame.js:816</code></a>

11985

11986

</p>

11987

11988

11989

11990

11991

</div>

11992

11993

11994

<p>The template used to create the page when created dynamically.</p>

11995

</div>

11996

11997

11998

11999

12000

12001

12002

</div>

12003

12004

12005

12006

<h3 class="name"><code>THROTTLE_TIME</code></h3>

12007

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Number" class="crosslink external" target="_blank">Number</a></span>

12008

12009

12010

12011

12012

12013

12014

12015

12016

<span class="flag static">static</span>

12017

12018

12019

12020

12021

12022

12023

<p>

12024

12025

Defined in

12026

12027

12028

12029

12030

<a href="../files/editor_js_frame.js.html#l770"><code>editor/js/frame.js:770</code></a>

12031

12032

</p>

12033

12034

12035

12036

12037

</div>

12038

12039

12040

<p>The throttle time for key events in IE</p>

12041

</div>

12042

12043

12044

<p><strong>Default:</strong> 100</p>

12045

12046

12047

12048

12049

12050

</div>

12051

12052

12053

</div>

12054

12055

12056

12057

12058

<h2 class="off-left">Attributes</h2>

12059

12060

12061

12062

12063

<h3 class="name"><code>basehref</code></h3>

12064

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

12065

12066

12067

12068

12069

12070

12071

12072

12073

12074

12075

12076

12077

12078

<p>

12079

12080

Defined in

12081

12082

12083

12084

12085

<a href="../files/editor_js_frame.js.html#l929"><code>editor/js/frame.js:929</code></a>

12086

12087

</p>

12088

12089

12090

12091

12092

</div>

12093

12094

12095

<p>The base href to use in the iframe.</p>

12096

</div>

12097

12098

12099

12100

12101

12102

<h4>Fires event <code>basehrefChange</code></h4>

12103

12104

<p>

12105

Fires when the value for the configuration attribute <code>basehref</code> is

12106

changed. You can listen for the event using the <code>on</code> method if you

12107

wish to be notified before the attribute's value has changed, or

12108

using the <code>after</code> method if you wish to be notified after the

12109

attribute's value has changed.

12110

</p>

12111

12112

12113

<h4>Parameters:</h4>

12114

12115

12116

12117

12118

<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>

12119

12120

12121

An Event Facade object with the following

12122

attribute-specific properties added:

12123

</div>

12124

12125

12126

12127

<code class="param-name">prevVal</code>

12128

12129

<div class="param-description">The value of the attribute, prior to it being set.</div>

12130

</li>

12131

12132

<code class="param-name">newVal</code>

12133

12134

<div class="param-description">The value the attribute is to be set to.</div>

12135

</li>

12136

12137

<code class="param-name">attrName</code>

12138

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

12139

<div class="param-description">The name of the attribute being set.</div>

12140

</li>

12141

12142

<code class="param-name">subAttrName</code>

12143

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

12144

<div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div>

12145

</li>

12146

</ul>

12147

</li>

12148

</ul>

12149

</div>

12150

</div>

12151

12152

12153

12154

</div>

12155

12156

12157

12158

12159

<h3 class="name"><code>container</code></h3>

12160

<span class="type">String/HTMLElement/Node</span>

12161

12162

12163

12164

12165

12166

12167

12168

12169

12170

12171

12172

12173

12174

<p>

12175

12176

Defined in

12177

12178

12179

12180

12181

<a href="../files/editor_js_frame.js.html#l948"><code>editor/js/frame.js:948</code></a>

12182

12183

</p>

12184

12185

12186

12187

12188

</div>

12189

12190

12191

<p>The container to append the iFrame to on render.</p>

12192

</div>

12193

12194

12195

12196

12197

12198

<h4>Fires event <code>containerChange</code></h4>

12199

12200

<p>

12201

Fires when the value for the configuration attribute <code>container</code> is

12202

changed. You can listen for the event using the <code>on</code> method if you

12203

wish to be notified before the attribute's value has changed, or

12204

using the <code>after</code> method if you wish to be notified after the

12205

attribute's value has changed.

12206

</p>

12207

12208

12209

<h4>Parameters:</h4>

12210

12211

12212

12213

12214

<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>

12215

12216

12217

An Event Facade object with the following

12218

attribute-specific properties added:

12219

</div>

12220

12221

12222

12223

<code class="param-name">prevVal</code>

12224

12225

<div class="param-description">The value of the attribute, prior to it being set.</div>

12226

</li>

12227

12228

<code class="param-name">newVal</code>

12229

12230

<div class="param-description">The value the attribute is to be set to.</div>

12231

</li>

12232

12233

<code class="param-name">attrName</code>

12234

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

12235

<div class="param-description">The name of the attribute being set.</div>

12236

</li>

12237

12238

<code class="param-name">subAttrName</code>

12239

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

12240

<div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div>

12241

</li>

12242

</ul>

12243

</li>

12244

</ul>

12245

</div>

12246

</div>

12247

12248

12249

12250

</div>

12251

12252

12253

12254

12255

<h3 class="name"><code>content</code></h3>

12256

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

12257

12258

12259

12260

12261

12262

12263

12264

12265

12266

12267

12268

12269

12270

<p>

12271

12272

Defined in

12273

12274

12275

12276

12277

<a href="../files/editor_js_frame.js.html#l919"><code>editor/js/frame.js:919</code></a>

12278

12279

</p>

12280

12281

12282

12283

12284

</div>

12285

12286

12287

<p>The string to inject into the body of the new frame/window.</p>

12288

</div>

12289

12290

12291

12292

12293

12294

<h4>Fires event <code>contentChange</code></h4>

12295

12296

<p>

12297

Fires when the value for the configuration attribute <code>content</code> is

12298

changed. You can listen for the event using the <code>on</code> method if you

12299

wish to be notified before the attribute's value has changed, or

12300

using the <code>after</code> method if you wish to be notified after the

12301

attribute's value has changed.

12302

</p>

12303

12304

12305

<h4>Parameters:</h4>

12306

12307

12308

12309

12310

<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>

12311

12312

12313

An Event Facade object with the following

12314

attribute-specific properties added:

12315

</div>

12316

12317

12318

12319

<code class="param-name">prevVal</code>

12320

12321

<div class="param-description">The value of the attribute, prior to it being set.</div>

12322

</li>

12323

12324

<code class="param-name">newVal</code>

12325

12326

<div class="param-description">The value the attribute is to be set to.</div>

12327

</li>

12328

12329

<code class="param-name">attrName</code>

12330

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

12331

<div class="param-description">The name of the attribute being set.</div>

12332

</li>

12333

12334

<code class="param-name">subAttrName</code>

12335

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

12336

<div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div>

12337

</li>

12338

</ul>

12339

</li>

12340

</ul>

12341

</div>

12342

</div>

12343

12344

12345

12346

</div>

12347

12348

12349

12350

12351

<h3 class="name"><code>defaultblock</code></h3>

12352

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

12353

12354

12355

12356

12357

12358

12359

12360

12361

12362

12363

12364

12365

12366

<p>

12367

12368

Defined in

12369

12370

12371

12372

12373

<a href="../files/editor_js_frame.js.html#l1013"><code>editor/js/frame.js:1013</code></a>

12374

12375

</p>

12376

12377

12378

12379

12380

</div>

12381

12382

12383

<p>The default tag to use for block level items, defaults to: p</p>

12384

</div>

12385

12386

12387

12388

12389

12390

<h4>Fires event <code>defaultblockChange</code></h4>

12391

12392

<p>

12393

Fires when the value for the configuration attribute <code>defaultblock</code> is

12394

changed. You can listen for the event using the <code>on</code> method if you

12395

wish to be notified before the attribute's value has changed, or

12396

using the <code>after</code> method if you wish to be notified after the

12397

attribute's value has changed.

12398

</p>

12399

12400

12401

<h4>Parameters:</h4>

12402

12403

12404

12405

12406

<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>

12407

12408

12409

An Event Facade object with the following

12410

attribute-specific properties added:

12411

</div>

12412

12413

12414

12415

<code class="param-name">prevVal</code>

12416

12417

<div class="param-description">The value of the attribute, prior to it being set.</div>

12418

</li>

12419

12420

<code class="param-name">newVal</code>

12421

12422

<div class="param-description">The value the attribute is to be set to.</div>

12423

</li>

12424

12425

<code class="param-name">attrName</code>

12426

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

12427

<div class="param-description">The name of the attribute being set.</div>

12428

</li>

12429

12430

<code class="param-name">subAttrName</code>

12431

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

12432

<div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div>

12433

</li>

12434

</ul>

12435

</li>

12436

</ul>

12437

</div>

12438

</div>

12439

12440

12441

12442

</div>

12443

12444

12445

12446

12447

<h3 class="name"><code>designMode</code></h3>

12448

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>

12449

12450

12451

12452

12453

12454

12455

12456

12457

12458

12459

12460

12461

12462

<p>

12463

12464

Defined in

12465

12466

12467

12468

12469

<a href="../files/editor_js_frame.js.html#l909"><code>editor/js/frame.js:909</code></a>

12470

12471

</p>

12472

12473

12474

12475

12476

</div>

12477

12478

12479

<p>Should designMode be turned on after creation.</p>

12480

</div>

12481

12482

12483

12484

12485

12486

<h4>Fires event <code>designModeChange</code></h4>

12487

12488

<p>

12489

Fires when the value for the configuration attribute <code>designMode</code> is

12490

changed. You can listen for the event using the <code>on</code> method if you

12491

wish to be notified before the attribute's value has changed, or

12492

using the <code>after</code> method if you wish to be notified after the

12493

attribute's value has changed.

12494

</p>

12495

12496

12497

<h4>Parameters:</h4>

12498

12499

12500

12501

12502

<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>

12503

12504

12505

An Event Facade object with the following

12506

attribute-specific properties added:

12507

</div>

12508

12509

12510

12511

<code class="param-name">prevVal</code>

12512

12513

<div class="param-description">The value of the attribute, prior to it being set.</div>

12514

</li>

12515

12516

<code class="param-name">newVal</code>

12517

12518

<div class="param-description">The value the attribute is to be set to.</div>

12519

</li>

12520

12521

<code class="param-name">attrName</code>

12522

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

12523

<div class="param-description">The name of the attribute being set.</div>

12524

</li>

12525

12526

<code class="param-name">subAttrName</code>

12527

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

12528

<div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div>

12529

</li>

12530

</ul>

12531

</li>

12532

</ul>

12533

</div>

12534

</div>

12535

12536

12537

12538

</div>

12539

12540

12541

12542

12543

<h3 class="name"><code>destroyed</code></h3>

12544

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>

12545

12546

12547

12548

12549

12550

12551

12552

12553

12554

12555

12556

12557

<p>Inherited from

12558

<a href="../classes/BaseCore.html#attr_destroyed">BaseCore</a>:

12559

12560

12561

12562

<a href="../files/base_js_BaseCore.js.html#l157"><code>base/js/BaseCore.js:157</code></a>

12563

12564

</p>

12565

12566

12567

12568

12569

</div>

12570

12571

12572

<p>Flag indicating whether or not this object

12573

has been through the destroy lifecycle phase.</p>

12574

</div>

12575

12576

12577

<p><strong>Default:</strong> false</p>

12578

12579

12580

12581

12582

<h4>Fires event <code>destroyedChange</code></h4>

12583

12584

<p>

12585

Fires when the value for the configuration attribute <code>destroyed</code> is

12586

changed. You can listen for the event using the <code>on</code> method if you

12587

wish to be notified before the attribute's value has changed, or

12588

using the <code>after</code> method if you wish to be notified after the

12589

attribute's value has changed.

12590

</p>

12591

12592

12593

<h4>Parameters:</h4>

12594

12595

12596

12597

12598

<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>

12599

12600

12601

An Event Facade object with the following

12602

attribute-specific properties added:

12603

</div>

12604

12605

12606

12607

<code class="param-name">prevVal</code>

12608

12609

<div class="param-description">The value of the attribute, prior to it being set.</div>

12610

</li>

12611

12612

<code class="param-name">newVal</code>

12613

12614

<div class="param-description">The value the attribute is to be set to.</div>

12615

</li>

12616

12617

<code class="param-name">attrName</code>

12618

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

12619

<div class="param-description">The name of the attribute being set.</div>

12620

</li>

12621

12622

<code class="param-name">subAttrName</code>

12623

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

12624

<div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div>

12625

</li>

12626

</ul>

12627

</li>

12628

</ul>

12629

</div>

12630

</div>

12631

12632

12633

12634

</div>

12635

12636

12637

12638

12639

12640

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

12641

12642

12643

12644

12645

12646

12647

12648

12649

12650

12651

12652

12653

12654

<p>

12655

12656

Defined in

12657

12658

12659

12660

12661

<a href="../files/editor_js_frame.js.html#l884"><code>editor/js/frame.js:884</code></a>

12662

12663

</p>

12664

12665

12666

12667

12668

</div>

12669

12670

12671

<p>The default text direction for this new frame. Default: ltr</p>

12672

</div>

12673

12674

12675

12676

12677

12678

<h4>Fires event <code>dirChange</code></h4>

12679

12680

<p>

12681

Fires when the value for the configuration attribute <code>dir</code> is

12682

changed. You can listen for the event using the <code>on</code> method if you

12683

wish to be notified before the attribute's value has changed, or

12684

using the <code>after</code> method if you wish to be notified after the

12685

attribute's value has changed.

12686

</p>

12687

12688

12689

<h4>Parameters:</h4>

12690

12691

12692

12693

12694

<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>

12695

12696

12697

An Event Facade object with the following

12698

attribute-specific properties added:

12699

</div>

12700

12701

12702

12703

<code class="param-name">prevVal</code>

12704

12705

<div class="param-description">The value of the attribute, prior to it being set.</div>

12706

</li>

12707

12708

<code class="param-name">newVal</code>

12709

12710

<div class="param-description">The value the attribute is to be set to.</div>

12711

</li>

12712

12713

<code class="param-name">attrName</code>

12714

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

12715

<div class="param-description">The name of the attribute being set.</div>

12716

</li>

12717

12718

<code class="param-name">subAttrName</code>

12719

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

12720

<div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div>

12721

</li>

12722

</ul>

12723

</li>

12724

</ul>

12725

</div>

12726

</div>

12727

12728

12729

12730

</div>

12731

12732

12733

12734

12735

<h3 class="name"><code>extracss</code></h3>

12736

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

12737

12738

12739

12740

12741

12742

12743

12744

12745

12746

12747

12748

12749

12750

<p>

12751

12752

Defined in

12753

12754

12755

12756

12757

<a href="../files/editor_js_frame.js.html#l996"><code>editor/js/frame.js:996</code></a>

12758

12759

</p>

12760

12761

12762

12763

12764

</div>

12765

12766

12767

<p>A string of CSS to add to the Head of the Editor</p>

12768

</div>

12769

12770

12771

12772

12773

12774

<h4>Fires event <code>extracssChange</code></h4>

12775

12776

<p>

12777

Fires when the value for the configuration attribute <code>extracss</code> is

12778

changed. You can listen for the event using the <code>on</code> method if you

12779

wish to be notified before the attribute's value has changed, or

12780

using the <code>after</code> method if you wish to be notified after the

12781

attribute's value has changed.

12782

</p>

12783

12784

12785

<h4>Parameters:</h4>

12786

12787

12788

12789

12790

<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>

12791

12792

12793

An Event Facade object with the following

12794

attribute-specific properties added:

12795

</div>

12796

12797

12798

12799

<code class="param-name">prevVal</code>

12800

12801

<div class="param-description">The value of the attribute, prior to it being set.</div>

12802

</li>

12803

12804

<code class="param-name">newVal</code>

12805

12806

<div class="param-description">The value the attribute is to be set to.</div>

12807

</li>

12808

12809

<code class="param-name">attrName</code>

12810

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

12811

<div class="param-description">The name of the attribute being set.</div>

12812

</li>

12813

12814

<code class="param-name">subAttrName</code>

12815

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

12816

<div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div>

12817

</li>

12818

</ul>

12819

</li>

12820

</ul>

12821

</div>

12822

</div>

12823

12824

12825

12826

</div>

12827

12828

12829

12830

12831

12832

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>

12833

12834

12835

12836

12837

12838

12839

12840

12841

12842

12843

12844

12845

12846

<p>

12847

12848

Defined in

12849

12850

12851

12852

12853

<a href="../files/editor_js_frame.js.html#l1005"><code>editor/js/frame.js:1005</code></a>

12854

12855

</p>

12856

12857

12858

12859

12860

</div>

12861

12862

12863

<p>A reference to the Editor instance</p>

12864

</div>

12865

12866

12867

12868

12869

12870

<h4>Fires event <code>hostChange</code></h4>

12871

12872

<p>

12873

Fires when the value for the configuration attribute <code>host</code> is

12874

changed. You can listen for the event using the <code>on</code> method if you

12875

wish to be notified before the attribute's value has changed, or

12876

using the <code>after</code> method if you wish to be notified after the

12877

attribute's value has changed.

12878

</p>

12879

12880

12881

<h4>Parameters:</h4>

12882

12883

12884

12885

12886

<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>

12887

12888

12889

An Event Facade object with the following

12890

attribute-specific properties added:

12891

</div>

12892

12893

12894

12895

<code class="param-name">prevVal</code>

12896

12897

<div class="param-description">The value of the attribute, prior to it being set.</div>

12898

</li>

12899

12900

<code class="param-name">newVal</code>

12901

12902

<div class="param-description">The value the attribute is to be set to.</div>

12903

</li>

12904

12905

<code class="param-name">attrName</code>

12906

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

12907

<div class="param-description">The name of the attribute being set.</div>

12908

</li>

12909

12910

<code class="param-name">subAttrName</code>

12911

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

12912

<div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div>

12913

</li>

12914

</ul>

12915

</li>

12916

</ul>

12917

</div>

12918

</div>

12919

12920

12921

12922

</div>

12923

12924

12925

12926

12927

12928

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

12929

12930

12931

12932

12933

12934

12935

12936

12937

12938

12939

12940

12941

12942

<p>

12943

12944

Defined in

12945

12946

12947

12948

12949

<a href="../files/editor_js_frame.js.html#l971"><code>editor/js/frame.js:971</code></a>

12950

12951

</p>

12952

12953

12954

12955

12956

</div>

12957

12958

12959

<p>Set the id of the new Node. (optional)</p>

12960

</div>

12961

12962

12963

12964

12965

12966

<h4>Fires event <code>idChange</code></h4>

12967

12968

<p>

12969

Fires when the value for the configuration attribute <code>id</code> is

12970

changed. You can listen for the event using the <code>on</code> method if you

12971

wish to be notified before the attribute's value has changed, or

12972

using the <code>after</code> method if you wish to be notified after the

12973

attribute's value has changed.

12974

</p>

12975

12976

12977

<h4>Parameters:</h4>

12978

12979

12980

12981

12982

<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>

12983

12984

12985

An Event Facade object with the following

12986

attribute-specific properties added:

12987

</div>

12988

12989

12990

12991

<code class="param-name">prevVal</code>

12992

12993

<div class="param-description">The value of the attribute, prior to it being set.</div>

12994

</li>

12995

12996

<code class="param-name">newVal</code>

12997

12998

<div class="param-description">The value the attribute is to be set to.</div>

12999

</li>

13000

13001

<code class="param-name">attrName</code>

13002

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

13003

<div class="param-description">The name of the attribute being set.</div>

13004

</li>

13005

13006

<code class="param-name">subAttrName</code>

13007

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

13008

<div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div>

13009

</li>

13010

</ul>

13011

</li>

13012

</ul>

13013

</div>

13014

</div>

13015

13016

13017

13018

</div>

13019

13020

13021

13022

13023

<h3 class="name"><code>initialized</code></h3>

13024

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>

13025

13026

13027

13028

13029

13030

13031

13032

13033

13034

13035

13036

13037

<p>Inherited from

13038

<a href="../classes/BaseCore.html#attr_initialized">BaseCore</a>:

13039

13040

13041

13042

<a href="../files/base_js_BaseCore.js.html#l143"><code>base/js/BaseCore.js:143</code></a>

13043

13044

</p>

13045

13046

13047

13048

13049

</div>

13050

13051

13052

<p>Flag indicating whether or not this object

13053

has been through the init lifecycle phase.</p>

13054

</div>

13055

13056

13057

<p><strong>Default:</strong> false</p>

13058

13059

13060

13061

13062

<h4>Fires event <code>initializedChange</code></h4>

13063

13064

<p>

13065

Fires when the value for the configuration attribute <code>initialized</code> is

13066

changed. You can listen for the event using the <code>on</code> method if you

13067

wish to be notified before the attribute's value has changed, or

13068

using the <code>after</code> method if you wish to be notified after the

13069

attribute's value has changed.

13070

</p>

13071

13072

13073

<h4>Parameters:</h4>

13074

13075

13076

13077

13078

<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>

13079

13080

13081

An Event Facade object with the following

13082

attribute-specific properties added:

13083

</div>

13084

13085

13086

13087

<code class="param-name">prevVal</code>

13088

13089

<div class="param-description">The value of the attribute, prior to it being set.</div>

13090

</li>

13091

13092

<code class="param-name">newVal</code>

13093

13094

<div class="param-description">The value the attribute is to be set to.</div>

13095

</li>

13096

13097

<code class="param-name">attrName</code>

13098

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

13099

<div class="param-description">The name of the attribute being set.</div>

13100

</li>

13101

13102

<code class="param-name">subAttrName</code>

13103

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

13104

<div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div>

13105

</li>

13106

</ul>

13107

</li>

13108

</ul>

13109

</div>

13110

</div>

13111

13112

13113

13114

</div>

13115

13116

13117

13118

13119

13120

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

13121

13122

13123

13124

13125

13126

13127

13128

13129

13130

13131

13132

13133

13134

<p>

13135

13136

Defined in

13137

13138

13139

13140

13141

<a href="../files/editor_js_frame.js.html#l892"><code>editor/js/frame.js:892</code></a>

13142

13143

</p>

13144

13145

13146

13147

13148

</div>

13149

13150

13151

<p>The default language. Default: en-US</p>

13152

</div>

13153

13154

13155

13156

13157

13158

<h4>Fires event <code>langChange</code></h4>

13159

13160

<p>

13161

Fires when the value for the configuration attribute <code>lang</code> is

13162

changed. You can listen for the event using the <code>on</code> method if you

13163

wish to be notified before the attribute's value has changed, or

13164

using the <code>after</code> method if you wish to be notified after the

13165

attribute's value has changed.

13166

</p>

13167

13168

13169

<h4>Parameters:</h4>

13170

13171

13172

13173

13174

<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>

13175

13176

13177

An Event Facade object with the following

13178

attribute-specific properties added:

13179

</div>

13180

13181

13182

13183

<code class="param-name">prevVal</code>

13184

13185

<div class="param-description">The value of the attribute, prior to it being set.</div>

13186

</li>

13187

13188

<code class="param-name">newVal</code>

13189

13190

<div class="param-description">The value the attribute is to be set to.</div>

13191

</li>

13192

13193

<code class="param-name">attrName</code>

13194

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

13195

<div class="param-description">The name of the attribute being set.</div>

13196

</li>

13197

13198

<code class="param-name">subAttrName</code>

13199

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

13200

<div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div>

13201

</li>

13202

</ul>

13203

</li>

13204

</ul>

13205

</div>

13206

</div>

13207

13208

13209

13210

</div>

13211

13212

13213

13214

13215

<h3 class="name"><code>linkedcss</code></h3>

13216

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

13217

13218

13219

13220

13221

13222

13223

13224

13225

13226

13227

13228

13229

13230

<p>

13231

13232

Defined in

13233

13234

13235

13236

13237

<a href="../files/editor_js_frame.js.html#l986"><code>editor/js/frame.js:986</code></a>

13238

13239

</p>

13240

13241

13242

13243

13244

</div>

13245

13246

13247

<p>An array of url's to external linked style sheets</p>

13248

</div>

13249

13250

13251

13252

13253

13254

<h4>Fires event <code>linkedcssChange</code></h4>

13255

13256

<p>

13257

Fires when the value for the configuration attribute <code>linkedcss</code> is

13258

changed. You can listen for the event using the <code>on</code> method if you

13259

wish to be notified before the attribute's value has changed, or

13260

using the <code>after</code> method if you wish to be notified after the

13261

attribute's value has changed.

13262

</p>

13263

13264

13265

<h4>Parameters:</h4>

13266

13267

13268

13269

13270

<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>

13271

13272

13273

An Event Facade object with the following

13274

attribute-specific properties added:

13275

</div>

13276

13277

13278

13279

<code class="param-name">prevVal</code>

13280

13281

<div class="param-description">The value of the attribute, prior to it being set.</div>

13282

</li>

13283

13284

<code class="param-name">newVal</code>

13285

13286

<div class="param-description">The value the attribute is to be set to.</div>

13287

</li>

13288

13289

<code class="param-name">attrName</code>

13290

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

13291

<div class="param-description">The name of the attribute being set.</div>

13292

</li>

13293

13294

<code class="param-name">subAttrName</code>

13295

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

13296

<div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div>

13297

</li>

13298

</ul>

13299

</li>

13300

</ul>

13301

</div>

13302

</div>

13303

13304

13305

13306

</div>

13307

13308

13309

13310

13311

13312

13313

13314

13315

13316

13317

13318

13319

13320

13321

13322

13323

13324

13325

13326

<p>

13327

13328

Defined in

13329

13330

13331

13332

13333

<a href="../files/editor_js_frame.js.html#l959"><code>editor/js/frame.js:959</code></a>

13334

13335

</p>

13336

13337

13338

13339

13340

</div>

13341

13342

13343

<p>The Node instance of the iframe.</p>

13344

</div>

13345

13346

13347

13348

13349

13350

<h4>Fires event <code>nodeChange</code></h4>

13351

13352

<p>

13353

Fires when the value for the configuration attribute <code>node</code> is

13354

changed. You can listen for the event using the <code>on</code> method if you

13355

wish to be notified before the attribute's value has changed, or

13356

using the <code>after</code> method if you wish to be notified after the

13357

attribute's value has changed.

13358

</p>

13359

13360

13361

<h4>Parameters:</h4>

13362

13363

13364

13365

13366

<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>

13367

13368

13369

An Event Facade object with the following

13370

attribute-specific properties added:

13371

</div>

13372

13373

13374

13375

<code class="param-name">prevVal</code>

13376

13377

<div class="param-description">The value of the attribute, prior to it being set.</div>

13378

</li>

13379

13380

<code class="param-name">newVal</code>

13381

13382

<div class="param-description">The value the attribute is to be set to.</div>

13383

</li>

13384

13385

<code class="param-name">attrName</code>

13386

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

13387

<div class="param-description">The name of the attribute being set.</div>

13388

</li>

13389

13390

<code class="param-name">subAttrName</code>

13391

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

13392

<div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div>

13393

</li>

13394

</ul>

13395

</li>

13396

</ul>

13397

</div>

13398

</div>

13399

13400

13401

13402

</div>

13403

13404

13405

13406

13407

13408

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

13409

13410

13411

13412

13413

13414

13415

13416

13417

13418

13419

13420

13421

13422

<p>

13423

13424

Defined in

13425

13426

13427

13428

13429

<a href="../files/editor_js_frame.js.html#l900"><code>editor/js/frame.js:900</code></a>

13430

13431

</p>

13432

13433

13434

13435

13436

</div>

13437

13438

13439

<p>The src of the iframe/window. Defaults to javascript:;</p>

13440

</div>

13441

13442

13443

13444

13445

13446

<h4>Fires event <code>srcChange</code></h4>

13447

13448

<p>

13449

Fires when the value for the configuration attribute <code>src</code> is

13450

changed. You can listen for the event using the <code>on</code> method if you

13451

wish to be notified before the attribute's value has changed, or

13452

using the <code>after</code> method if you wish to be notified after the

13453

attribute's value has changed.

13454

</p>

13455

13456

13457

<h4>Parameters:</h4>

13458

13459

13460

13461

13462

<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>

13463

13464

13465

An Event Facade object with the following

13466

attribute-specific properties added:

13467

</div>

13468

13469

13470

13471

<code class="param-name">prevVal</code>

13472

13473

<div class="param-description">The value of the attribute, prior to it being set.</div>

13474

</li>

13475

13476

<code class="param-name">newVal</code>

13477

13478

<div class="param-description">The value the attribute is to be set to.</div>

13479

</li>

13480

13481

<code class="param-name">attrName</code>

13482

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

13483

<div class="param-description">The name of the attribute being set.</div>

13484

</li>

13485

13486

<code class="param-name">subAttrName</code>

13487

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

13488

<div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div>

13489

</li>

13490

</ul>

13491

</li>

13492

</ul>

13493

</div>

13494

</div>

13495

13496

13497

13498

</div>

13499

13500

13501

13502

13503

<h3 class="name"><code>title</code></h3>

13504

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

13505

13506

13507

13508

13509

13510

13511

13512

13513

13514

13515

13516

13517

13518

<p>

13519

13520

Defined in

13521

13522

13523

13524

13525

<a href="../files/editor_js_frame.js.html#l876"><code>editor/js/frame.js:876</code></a>

13526

13527

</p>

13528

13529

13530

13531

13532

</div>

13533

13534

13535

<p>The title to give the blank page.</p>

13536

</div>

13537

13538

13539

13540

13541

13542

<h4>Fires event <code>titleChange</code></h4>

13543

13544

<p>

13545

Fires when the value for the configuration attribute <code>title</code> is

13546

changed. You can listen for the event using the <code>on</code> method if you

13547

wish to be notified before the attribute's value has changed, or

13548

using the <code>after</code> method if you wish to be notified after the

13549

attribute's value has changed.

13550

</p>

13551

13552

13553

<h4>Parameters:</h4>

13554

13555

13556

13557

13558

<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>

13559

13560

13561

An Event Facade object with the following

13562

attribute-specific properties added:

13563

</div>

13564

13565

13566

13567

<code class="param-name">prevVal</code>

13568

13569

<div class="param-description">The value of the attribute, prior to it being set.</div>

13570

</li>

13571

13572

<code class="param-name">newVal</code>

13573

13574

<div class="param-description">The value the attribute is to be set to.</div>

13575

</li>

13576

13577

<code class="param-name">attrName</code>

13578

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

13579

<div class="param-description">The name of the attribute being set.</div>

13580

</li>

13581

13582

<code class="param-name">subAttrName</code>

13583

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

13584

<div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div>

13585

</li>

13586

</ul>

13587

</li>

13588

</ul>

13589

</div>

13590

</div>

13591

13592

13593

13594

</div>

13595

13596

13597

13598

13599

13600

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Array" class="crosslink external" target="_blank">Array</a></span>

13601

13602

13603

13604

13605

13606

13607

13608

13609

13610

13611

13612

13613

13614

<p>

13615

13616

Defined in

13617

13618

13619

13620

13621

<a href="../files/editor_js_frame.js.html#l938"><code>editor/js/frame.js:938</code></a>

13622

13623

</p>

13624

13625

13626

13627

13628

</div>

13629

13630

13631

<p>Array of modules to include in the scoped YUI instance at render time. Default: ['none', 'selector-css2']</p>

13632

</div>

13633

13634

13635

13636

13637

13638

<h4>Fires event <code>useChange</code></h4>

13639

13640

<p>

13641

Fires when the value for the configuration attribute <code>use</code> is

13642

changed. You can listen for the event using the <code>on</code> method if you

13643

wish to be notified before the attribute's value has changed, or

13644

using the <code>after</code> method if you wish to be notified after the

13645

attribute's value has changed.

13646

</p>

13647

13648

13649

<h4>Parameters:</h4>

13650

13651

13652

13653

13654

<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>

13655

13656

13657

An Event Facade object with the following

13658

attribute-specific properties added:

13659

</div>

13660

13661

13662

13663

<code class="param-name">prevVal</code>

13664

13665

<div class="param-description">The value of the attribute, prior to it being set.</div>

13666

</li>

13667

13668

<code class="param-name">newVal</code>

13669

13670

<div class="param-description">The value the attribute is to be set to.</div>

13671

</li>

13672

13673

<code class="param-name">attrName</code>

13674

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

13675

<div class="param-description">The name of the attribute being set.</div>

13676

</li>

13677

13678

<code class="param-name">subAttrName</code>

13679

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

13680

<div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div>

13681

</li>

13682

</ul>

13683

</li>

13684

</ul>

13685

</div>

13686

</div>

13687

13688

13689

13690

</div>

13691

13692

13693

</div>

13694

13695

13696

13697

13698

<h2 class="off-left">Events</h2>

13699

13700

13701

13702

<h3 class="name"><code>destroy</code></h3>

13703

13704

13705

13706

13707

13708

13709

13710

13711

13712

13713

13714

13715

13716

<p>Inherited from

13717

<a href="../classes/Base.html#event_destroy">Base</a>:

13718

13719

13720

13721

13722

13723

</p>

13724

13725

13726

13727

13728

</div>

13729

13730

13731

<p>

13732

Lifecycle event for the destroy phase,

13733

fired prior to destruction. Invoking the preventDefault

13734

method on the event object provided to subscribers will

13735

prevent destruction from proceeding.

13736

</p>

13737

13738

<p>

13739

Subscribers to the "after" moment of this event, will be notified

13740

after destruction is complete (and as a result cannot prevent

13741

destruction).

13742

</p>

13743

</div>

13744

13745

13746

13747

<h4>Event Payload:</h4>

13748

13749

13750

13751

13752

13753

13754

<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>

13755

13756

13757

13758

13759

13760

<p>Event object</p>

13761

</div>

13762

13763

13764

</li>

13765

13766

</ul>

13767

</div>

13768

13769

13770

13771

13772

</div>

13773

13774

13775

13776

13777

13778

13779

13780

13781

13782

13783

13784

13785

13786

13787

13788

13789

13790

<p>Inherited from

13791

<a href="../classes/Base.html#event_init">Base</a>:

13792

13793

13794

13795

13796

13797

</p>

13798

13799

13800

13801

13802

</div>

13803

13804

13805

<p>

13806

Lifecycle event for the init phase, fired prior to initialization.

13807

Invoking the preventDefault() method on the event object provided

13808

to subscribers will prevent initialization from occuring.

13809

</p>

13810

13811

<p>

13812

Subscribers to the "after" momemt of this event, will be notified

13813

after initialization of the object is complete (and therefore

13814

cannot prevent initialization).

13815

</p>

13816

</div>

13817

13818

13819

13820

<h4>Event Payload:</h4>

13821

13822

13823

13824

13825

13826

13827

<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>

13828

13829

13830

13831

13832

13833

<p>Event object, with a cfg property which

13834

refers to the configuration object passed to the constructor.</p>

13835

</div>

13836

13837

13838

</li>

13839

13840

</ul>

13841

</div>

13842

13843

13844

13845

13846

</div>

13847

13848

13849

</div>

13850

13851

</div>

13852

</div>

13853

13854

</div>

13855

</div>

13856

</div>

13857

</div>

13858

</div>

13859

</div>

13860

13861

13862

13863

13864

13865

13866

13867

13868

</body>

13869

</html>

Older »