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

2770

2771

2772

2773

2774

2775

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

2776

</div>

2777

2778

2779

</li>

2780

2781

2782

2783

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

2784

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

2785

2786

2787

2788

2789

2790

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

2791

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

2792

</div>

2793

2794

2795

</li>

2796

2797

2798

2799

2800

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

2801

2802

2803

2804

2805

2806

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

2807

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

2808

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

2809

</div>

2810

2811

2812

</li>

2813

2814

</ul>

2815

</div>

2816

2817

2818

2819

2820

2821

</div>

2822

2823

2824

2825

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

2826

2827

2828

2829

2830

2831

2832

2833

2834

2835

</li>

2836

2837

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

2838

</div>

2839

2840

2841

2842

2843

2844

2845

2846

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

2847

2848

2849

2850

2851

2852

2853

2854

2855

2856

2857

2858

<p>Inherited from

2859

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

2860

2861

2862

2863

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

2864

2865

</p>

2866

2867

2868

2869

2870

2871

</div>

2872

2873

2874

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

2875

</div>

2876

2877

2878

2879

<h4>Parameters:</h4>

2880

2881

2882

2883

2884

2885

2886

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

2887

2888

2889

2890

2891

2892

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

2893

</div>

2894

2895

2896

</li>

2897

2898

</ul>

2899

</div>

2900

2901

2902

2903

2904

2905

</div>

2906

2907

2908

2909

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

2910

2911

2912

2913

2914

2915

2916

2917

<code>event</code>

2918

2919

</li>

2920

2921

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

2922

</div>

2923

2924

2925

2926

2927

2928

2929

2930

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

2931

2932

2933

2934

2935

2936

2937

2938

2939

2940

2941

2942

<p>Inherited from

2943

<a href="../classes/Widget.html#method__afterChildSelectedChange">Widget</a>:

2944

2945

2946

2947

<a href="../files/widget-child_js_Widget-Child.js.html#l327"><code>widget-child/js/Widget-Child.js:327</code></a>

2948

2949

</p>

2950

2951

2952

2953

2954

2955

</div>

2956

2957

2958

<p>Default attribute change listener for the <code>selected</code>

2959

attribute, responsible for updating the UI, in response to

2960

attribute changes.</p>

2961

</div>

2962

2963

2964

2965

<h4>Parameters:</h4>

2966

2967

2968

2969

2970

2971

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

2972

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

2973

2974

2975

2976

2977

2978

<p>The event facade for the attribute change.</p>

2979

</div>

2980

2981

2982

</li>

2983

2984

</ul>

2985

</div>

2986

2987

2988

2989

2990

2991

</div>

2992

2993

2994

2995

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

2996

2997

2998

2999

3000

3001

3002

3003

<code>allAttrs</code>

3004

3005

</li>

3006

3007

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

3008

</div>

3009

3010

3011

3012

3013

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

3014

</span>

3015

3016

3017

3018

3019

3020

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

3021

3022

3023

3024

3025

3026

3027

3028

3029

3030

3031

3032

<p>Inherited from

3033

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

3034

3035

3036

3037

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

3038

3039

</p>

3040

3041

3042

3043

3044

3045

</div>

3046

3047

3048

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

3049

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

3050

3051

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

3052

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

3053

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

3054

</div>

3055

3056

3057

3058

<h4>Parameters:</h4>

3059

3060

3061

3062

3063

3064

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

3065

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

3066

3067

3068

3069

3070

3071

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

3072

(subclass first, Base last)</p>

3073

</div>

3074

3075

3076

</li>

3077

3078

</ul>

3079

</div>

3080

3081

3082

3083

3084

<h4>Returns:</h4>

3085

3086

3087

3088

3089

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

3090

3091

The aggregate set of ATTRS definitions for the instance

3092

3093

</div>

3094

</div>

3095

3096

3097

3098

</div>

3099

3100

3101

3102

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

3103

3104

3105

3106

3107

3108

3109

3110

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

3111

</span>

3112

3113

3114

3115

3116

3117

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

3118

3119

3120

3121

3122

3123

3124

3125

3126

3127

3128

3129

<p>Inherited from

3130

<a href="../classes/Widget.html#method__applyParsedConfig">Widget</a>:

3131

3132

3133

3134

<a href="../files/widget_js_WidgetHTMLParser.js.html#l84"><code>widget/js/WidgetHTMLParser.js:84</code></a>

3135

3136

</p>

3137

3138

3139

3140

3141

3142

</div>

3143

3144

3145

3146

</div>

3147

3148

3149

3150

3151

3152

<h4>Returns:</h4>

3153

3154

3155

3156

3157

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

3158

3159

The merged configuration literal

3160

3161

</div>

3162

</div>

3163

3164

3165

3166

</div>

3167

3168

3169

3170

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

3171

3172

3173

3174

3175

3176

3177

3178

<code>config</code>

3179

3180

</li>

3181

3182

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

3183

</div>

3184

3185

3186

3187

3188

3189

3190

3191

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

3192

3193

3194

3195

3196

3197

3198

3199

3200

3201

3202

3203

<p>Inherited from

3204

<a href="../classes/Widget.html#method__applyParser">Widget</a>:

3205

3206

3207

3208

<a href="../files/widget_js_WidgetHTMLParser.js.html#l93"><code>widget/js/WidgetHTMLParser.js:93</code></a>

3209

3210

</p>

3211

3212

3213

3214

3215

3216

</div>

3217

3218

3219

<p>Utilitity method used to apply the <code>HTML_PARSER</code> configuration for the

3220

instance, to retrieve config data values.</p>

3221

</div>

3222

3223

3224

3225

<h4>Parameters:</h4>

3226

3227

3228

3229

3230

3231

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

3232

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

3233

3234

3235

3236

3237

3238

<p>User configuration object (will be populated with values from Node)</p>

3239

</div>

3240

3241

3242

</li>

3243

3244

</ul>

3245

</div>

3246

3247

3248

3249

3250

3251

</div>

3252

3253

3254

3255

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

3256

3257

3258

3259

3260

3261

3262

3263

3264

3265

3266

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

3267

3268

3269

3270

3271

3272

3273

3274

3275

3276

3277

<p>Inherited from

3278

3279

BaseCore

3280

</a>

3281

3282

but overwritten in

3283

3284

3285

3286

3287

3288

</p>

3289

3290

3291

3292

3293

3294

</div>

3295

3296

3297

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

3298

this class.</p>

3299

</div>

3300

3301

3302

3303

3304

3305

3306

</div>

3307

3308

3309

3310

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

3311

3312

3313

3314

3315

3316

3317

3318

3319

3320

3321

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

3322

3323

3324

3325

3326

3327

3328

3329

3330

3331

3332

3333

<p>Inherited from

3334

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

3335

3336

3337

3338

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

3339

3340

</p>

3341

3342

3343

3344

3345

3346

</div>

3347

3348

3349

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

3350

</div>

3351

3352

3353

3354

3355

3356

3357

</div>

3358

3359

3360

3361

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

3362

3363

3364

3365

3366

3367

3368

3369

3370

3371

3372

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

3373

3374

3375

3376

3377

3378

3379

3380

3381

3382

3383

3384

<p>Inherited from

3385

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

3386

3387

3388

3389

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

3390

3391

</p>

3392

3393

3394

3395

3396

3397

</div>

3398

3399

3400

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

3401

</div>

3402

3403

3404

3405

3406

3407

3408

</div>

3409

3410

3411

3412

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

3413

3414

3415

3416

3417

3418

3419

3420

<code>attrs</code>

3421

3422

</li>

3423

3424

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

3425

</div>

3426

3427

3428

3429

3430

3431

3432

3433

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

3434

3435

3436

3437

3438

3439

3440

3441

3442

3443

3444

3445

<p>Inherited from

3446

<a href="../classes/Widget.html#method__bindAttrUI">Widget</a>:

3447

3448

3449

3450

<a href="../files/widget_js_Widget.js.html#l1157"><code>widget/js/Widget.js:1157</code></a>

3451

3452

</p>

3453

3454

3455

3456

3457

3458

</div>

3459

3460

3461

<p>Binds after listeners for the list of attributes provided</p>

3462

</div>

3463

3464

3465

3466

<h4>Parameters:</h4>

3467

3468

3469

3470

3471

3472

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

3473

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

3474

3475

3476

3477

3478

3479

3480

</div>

3481

3482

3483

</li>

3484

3485

</ul>

3486

</div>

3487

3488

3489

3490

3491

3492

</div>

3493

3494

3495

3496

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

3497

3498

3499

3500

3501

3502

3503

3504

3505

3506

3507

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

3508

3509

3510

3511

3512

3513

3514

3515

3516

3517

3518

3519

<p>Inherited from

3520

<a href="../classes/Widget.html#method__bindDOM">Widget</a>:

3521

3522

3523

3524

<a href="../files/widget_js_Widget.js.html#l889"><code>widget/js/Widget.js:889</code></a>

3525

3526

</p>

3527

3528

3529

3530

3531

3532

</div>

3533

3534

3535

<p>Sets up DOM listeners, on elements rendered by the widget.</p>

3536

</div>

3537

3538

3539

3540

3541

3542

3543

</div>

3544

3545

3546

3547

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

3548

3549

3550

3551

3552

3553

3554

3555

3556

3557

3558

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

3559

3560

3561

3562

3563

3564

3565

3566

3567

3568

3569

3570

3571

<p>

3572

3573

Defined in

3574

3575

3576

3577

3578

<a href="../files/uploader_js_uploader-html5.js.html#l275"><code>uploader/js/uploader-html5.js:275</code></a>

3579

3580

</p>

3581

3582

3583

3584

3585

3586

</div>

3587

3588

3589

<p>Binds the specified drop area's drag and drop events to the

3590

uploader's custom handler.</p>

3591

</div>

3592

3593

3594

3595

3596

3597

3598

</div>

3599

3600

3601

3602

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

3603

3604

3605

3606

3607

3608

3609

3610

3611

3612

3613

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

3614

3615

3616

3617

3618

3619

3620

3621

3622

3623

3624

3625

3626

<p>

3627

3628

Defined in

3629

3630

3631

3632

3633

<a href="../files/uploader_js_uploader-html5.js.html#l302"><code>uploader/js/uploader-html5.js:302</code></a>

3634

3635

</p>

3636

3637

3638

3639

3640

3641

</div>

3642

3643

3644

<p>Binds the instantiation of the file select dialog to the current file select

3645

control.</p>

3646

</div>

3647

3648

3649

3650

3651

3652

3653

</div>

3654

3655

3656

3657

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

3658

3659

3660

3661

3662

3663

3664

3665

3666

3667

3668

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

3669

3670

3671

3672

3673

3674

3675

3676

3677

3678

3679

3680

<p>Inherited from

3681

<a href="../classes/Widget.html#method__bindUI">Widget</a>:

3682

3683

3684

3685

<a href="../files/widget_js_Widget.js.html#l870"><code>widget/js/Widget.js:870</code></a>

3686

3687

</p>

3688

3689

3690

3691

3692

3693

</div>

3694

3695

3696

<p>Sets up DOM and CustomEvent listeners for the widget.</p>

3697

</div>

3698

3699

3700

3701

3702

3703

3704

</div>

3705

3706

3707

3708

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

3709

3710

3711

3712

3713

3714

3715

3716

3717

3718

3719

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

3720

3721

3722

3723

3724

3725

3726

3727

3728

3729

3730

3731

<p>Inherited from

3732

<a href="../classes/Widget.html#method__bindUIChild">Widget</a>:

3733

3734

3735

3736

<a href="../files/widget-child_js_Widget-Child.js.html#l356"><code>widget-child/js/Widget-Child.js:356</code></a>

3737

3738

</p>

3739

3740

3741

3742

3743

3744

</div>

3745

3746

3747

<p>Binds event listeners responsible for updating the UI state in response

3748

to WidgetChild related state changes.</p>

3749

3750

<p>

3751

This method is invoked after bindUI is invoked for the Widget class

3752

using YUI's aop infrastructure.

3753

</p>

3754

</div>

3755

3756

3757

3758

3759

3760

3761

</div>

3762

3763

3764

3765

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

3766

3767

3768

3769

3770

3771

3772

3773

3774

3775

</li>

3776

3777

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

3778

</div>

3779

3780

3781

3782

3783

3784

3785

3786

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

3787

3788

3789

3790

3791

3792

3793

3794

3795

3796

3797

3798

<p>Inherited from

3799

<a href="../classes/Widget.html#method__createUIEvent">Widget</a>:

3800

3801

3802

3803

<a href="../files/widget_js_WidgetUIEvents.js.html#l73"><code>widget/js/WidgetUIEvents.js:73</code></a>

3804

3805

</p>

3806

3807

3808

3809

3810

3811

</div>

3812

3813

3814

<p>Binds a delegated DOM event listener of the specified type to the

3815

Widget's outtermost DOM element to facilitate the firing of a Custom

3816

Event of the same type for the Widget instance.</p>

3817

</div>

3818

3819

3820

3821

<h4>Parameters:</h4>

3822

3823

3824

3825

3826

3827

3828

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

3829

3830

3831

3832

3833

3834

<p>String representing the name of the event</p>

3835

</div>

3836

3837

3838

</li>

3839

3840

</ul>

3841

</div>

3842

3843

3844

3845

3846

3847

</div>

3848

3849

3850

3851

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

3852

3853

3854

3855

3856

3857

3858

3859

3860

3861

3862

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

3863

3864

3865

3866

3867

3868

3869

3870

3871

3872

3873

3874

3875

<p>

3876

3877

Defined in

3878

3879

3880

3881

3882

<a href="../files/uploader_js_uploader-html5.js.html#l313"><code>uploader/js/uploader-html5.js:313</code></a>

3883

3884

</p>

3885

3886

3887

3888

3889

3890

</div>

3891

3892

3893

<p>Handles the drag and drop events from the uploader's specified drop

3894

area.</p>

3895

</div>

3896

3897

3898

3899

3900

3901

3902

</div>

3903

3904

3905

3906

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

3907

3908

3909

3910

3911

3912

3913

3914

3915

3916

</li>

3917

3918

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

3919

</div>

3920

3921

3922

3923

3924

3925

3926

3927

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

3928

3929

3930

3931

3932

3933

3934

3935

3936

3937

3938

3939

<p>Inherited from

3940

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

3941

3942

3943

3944

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

3945

3946

</p>

3947

3948

3949

3950

3951

3952

</div>

3953

3954

3955

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

3956

</div>

3957

3958

3959

3960

<h4>Parameters:</h4>

3961

3962

3963

3964

3965

3966

3967

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

3968

3969

3970

3971

3972

3973

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

3974

</div>

3975

3976

3977

</li>

3978

3979

</ul>

3980

</div>

3981

3982

3983

3984

3985

3986

</div>

3987

3988

3989

3990

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

3991

3992

3993

3994

3995

3996

3997

3998

3999

4000

4001

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

4002

4003

4004

4005

4006

4007

4008

4009

4010

4011

4012

4013

<p>Inherited from

4014

<a href="../classes/Widget.html#method__defaultCB">Widget</a>:

4015

4016

4017

4018

<a href="../files/widget_js_Widget.js.html#l781"><code>widget/js/Widget.js:781</code></a>

4019

4020

</p>

4021

4022

4023

4024

4025

4026

</div>

4027

4028

4029

<p>Returns the default value for the contentBox attribute. </p>

4030

4031

<p>For the Widget class, this will be the srcNode if provided, otherwise null (resulting in

4032

a new contentBox node instance being created)</p>

4033

</div>

4034

4035

4036

4037

4038

4039

4040

</div>

4041

4042

4043

4044

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

4045

4046

4047

4048

4049

4050

4051

4052

4053

4054

</li>

4055

4056

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

4057

</div>

4058

4059

4060

4061

4062

4063

4064

4065

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

4066

4067

4068

4069

4070

4071

4072

4073

4074

4075

4076

4077

<p>Inherited from

4078

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

4079

4080

4081

4082

4083

4084

</p>

4085

4086

4087

4088

4089

4090

</div>

4091

4092

4093

<p>Default destroy event handler</p>

4094

</div>

4095

4096

4097

4098

<h4>Parameters:</h4>

4099

4100

4101

4102

4103

4104

4105

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

4106

4107

4108

4109

4110

4111

<p>Event object</p>

4112

</div>

4113

4114

4115

</li>

4116

4117

</ul>

4118

</div>

4119

4120

4121

4122

4123

4124

</div>

4125

4126

4127

4128

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

4129

4130

4131

4132

4133

4134

4135

4136

4137

4138

</li>

4139

4140

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

4141

</div>

4142

4143

4144

4145

4146

4147

4148

4149

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

4150

4151

4152

4153

4154

4155

4156

4157

4158

4159

4160

4161

<p>Inherited from

4162

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

4163

4164

4165

4166

4167

4168

</p>

4169

4170

4171

4172

4173

4174

</div>

4175

4176

4177

<p>Default init event handler</p>

4178

</div>

4179

4180

4181

4182

<h4>Parameters:</h4>

4183

4184

4185

4186

4187

4188

4189

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

4190

4191

4192

4193

4194

4195

<p>Event object, with a cfg property which

4196

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

4197

</div>

4198

4199

4200

</li>

4201

4202

</ul>

4203

</div>

4204

4205

4206

4207

4208

4209

</div>

4210

4211

4212

4213

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

4214

4215

4216

4217

4218

4219

4220

4221

4222

4223

</li>

4224

4225

4226

4227

<code>parentNode</code>

4228

4229

</li>

4230

4231

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

4232

</div>

4233

4234

4235

4236

4237

4238

4239

4240

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

4241

4242

4243

4244

4245

4246

4247

4248

4249

4250

4251

4252

<p>Inherited from

4253

<a href="../classes/Widget.html#method__defRenderFn">Widget</a>:

4254

4255

4256

4257

<a href="../files/widget_js_Widget.js.html#l572"><code>widget/js/Widget.js:572</code></a>

4258

4259

</p>

4260

4261

4262

4263

4264

4265

</div>

4266

4267

4268

<p>Default render handler</p>

4269

</div>

4270

4271

4272

4273

<h4>Parameters:</h4>

4274

4275

4276

4277

4278

4279

4280

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

4281

4282

4283

4284

4285

4286

<p>The Event object</p>

4287

</div>

4288

4289

4290

</li>

4291

4292

4293

4294

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

4295

4296

4297

4298

4299

4300

4301

<p>The parent node to render to, if passed in to the <code>render</code> method</p>

4302

</div>

4303

4304

4305

</li>

4306

4307

</ul>

4308

</div>

4309

4310

4311

4312

4313

4314

</div>

4315

4316

4317

4318

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

4319

4320

4321

4322

4323

4324

4325

4326

4327

4328

4329

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

4330

4331

4332

4333

4334

4335

4336

4337

4338

4339

4340

4341

<p>Inherited from

4342

<a href="../classes/Widget.html#method__destroyBox">Widget</a>:

4343

4344

4345

4346

<a href="../files/widget_js_Widget.js.html#l478"><code>widget/js/Widget.js:478</code></a>

4347

4348

</p>

4349

4350

4351

4352

4353

4354

</div>

4355

4356

4357

<p>Removes and destroys the widgets rendered boundingBox, contentBox,

4358

and detaches bound UI events.</p>

4359

</div>

4360

4361

4362

4363

4364

4365

4366

</div>

4367

4368

4369

4370

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

4371

4372

4373

4374

4375

4376

4377

4378

4379

4380

4381

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

4382

4383

4384

4385

4386

4387

4388

4389

4390

4391

4392

4393

<p>Inherited from

4394

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

4395

4396

4397

4398

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

4399

4400

</p>

4401

4402

4403

4404

4405

4406

</div>

4407

4408

4409

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

4410

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

4411

</div>

4412

4413

4414

4415

4416

4417

4418

</div>

4419

4420

4421

4422

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

4423

4424

4425

4426

4427

4428

4429

4430

4431

4432

4433

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

4434

4435

4436

4437

4438

4439

4440

4441

4442

4443

4444

4445

<p>Inherited from

4446

<a href="../classes/Widget.html#method__destroyUIEvents">Widget</a>:

4447

4448

4449

4450

<a href="../files/widget_js_WidgetUIEvents.js.html#l20"><code>widget/js/WidgetUIEvents.js:20</code></a>

4451

4452

</p>

4453

4454

4455

4456

4457

4458

</div>

4459

4460

4461

<p>Destructor logic for UI event infrastructure,

4462

invoked during Widget destruction.</p>

4463

</div>

4464

4465

4466

4467

4468

4469

4470

</div>

4471

4472

4473

4474

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

4475

4476

4477

4478

4479

4480

4481

4482

<code>allAttrs</code>

4483

4484

</li>

4485

4486

4487

4488

<code>userVals</code>

4489

4490

</li>

4491

4492

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

4493

</div>

4494

4495

4496

4497

4498

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

4499

</span>

4500

4501

4502

4503

4504

4505

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

4506

4507

4508

4509

4510

4511

4512

4513

4514

4515

4516

4517

<p>Inherited from

4518

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

4519

4520

4521

4522

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

4523

4524

</p>

4525

4526

4527

4528

4529

4530

</div>

4531

4532

4533

4534

</div>

4535

4536

4537

4538

<h4>Parameters:</h4>

4539

4540

4541

4542

4543

4544

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

4545

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

4546

4547

4548

4549

4550

4551

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

4552

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

4553

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

4554

</div>

4555

4556

4557

</li>

4558

4559

4560

4561

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

4562

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

4563

4564

4565

4566

4567

4568

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

4569

</div>

4570

4571

4572

</li>

4573

4574

</ul>

4575

</div>

4576

4577

4578

4579

4580

<h4>Returns:</h4>

4581

4582

4583

4584

4585

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

4586

4587

The set of adhoc attributes passed in, in the form

4588

of an object with attribute name/configuration pairs.

4589

4590

</div>

4591

</div>

4592

4593

4594

4595

</div>

4596

4597

4598

4599

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

4600

4601

4602

4603

4604

4605

4606

4607

<code>clazz</code>

4608

4609

</li>

4610

4611

4612

4613

<code>allCfgs</code>

4614

4615

</li>

4616

4617

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

4618

</div>

4619

4620

4621

4622

4623

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

4624

</span>

4625

4626

4627

4628

4629

4630

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

4631

4632

4633

4634

4635

4636

4637

4638

4639

4640

4641

4642

<p>Inherited from

4643

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

4644

4645

4646

4647

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

4648

4649

</p>

4650

4651

4652

4653

4654

4655

</div>

4656

4657

4658

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

4659

initialization. Returns a disposable object with the attributes defined for

4660

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

4661

</div>

4662

4663

4664

4665

<h4>Parameters:</h4>

4666

4667

4668

4669

4670

4671

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

4672

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

4673

4674

4675

4676

4677

4678

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

4679

</div>

4680

4681

4682

</li>

4683

4684

4685

4686

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

4687

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

4688

4689

4690

4691

4692

4693

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

4694

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

4695

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

4696

</div>

4697

4698

4699

</li>

4700

4701

</ul>

4702

</div>

4703

4704

4705

4706

4707

<h4>Returns:</h4>

4708

4709

4710

4711

4712

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

4713

4714

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

4715

of an object with attribute name/configuration pairs.

4716

4717

</div>

4718

</div>

4719

4720

4721

4722

</div>

4723

4724

4725

4726

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

4727

4728

4729

4730

4731

4732

4733

4734

4735

4736

</li>

4737

4738

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

4739

</div>

4740

4741

4742

4743

4744

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

4745

</span>

4746

4747

4748

4749

4750

4751

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

4752

4753

4754

4755

4756

4757

4758

4759

4760

4761

4762

4763

<p>Inherited from

4764

<a href="../classes/Widget.html#method__filterUIEvent">Widget</a>:

4765

4766

4767

4768

<a href="../files/widget_js_WidgetUIEvents.js.html#l117"><code>widget/js/WidgetUIEvents.js:117</code></a>

4769

4770

</p>

4771

4772

4773

4774

4775

4776

</div>

4777

4778

4779

<p>This method is used to determine if we should fire

4780

the UI Event or not. The default implementation makes sure

4781

that for nested delegates (nested unrelated widgets), we don't

4782

fire the UI event listener more than once at each level.</p>

4783

4784

<p>For example, without the additional filter, if you have nested

4785

widgets, each widget will have a delegate listener. If you

4786

click on the inner widget, the inner delegate listener's

4787

filter will match once, but the outer will match twice

4788

(based on delegate's design) - once for the inner widget,

4789

and once for the outer.</p>

4790

</div>

4791

4792

4793

4794

<h4>Parameters:</h4>

4795

4796

4797

4798

4799

4800

4801

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

4802

4803

4804

4805

4806

4807

4808

</div>

4809

4810

4811

</li>

4812

4813

</ul>

4814

</div>

4815

4816

4817

4818

4819

<h4>Returns:</h4>

4820

4821

4822

4823

4824

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

4825

4826

true if it's OK to fire the custom UI event, false if not.

4827

4828

</div>

4829

</div>

4830

4831

4832

4833

</div>

4834

4835

4836

4837

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

4838

4839

4840

4841

4842

4843

4844

4845

<code>attrName</code>

4846

4847

</li>

4848

4849

4850

4851

<code>subAttrName</code>

4852

4853

</li>

4854

4855

4856

4857

<code>currVal</code>

4858

4859

</li>

4860

4861

4862

4863

<code>newVal</code>

4864

4865

</li>

4866

4867

4868

4869

4870

4871

</li>

4872

4873

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

4874

</div>

4875

4876

4877

4878

4879

4880

4881

4882

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

4883

4884

4885

4886

4887

4888

4889

4890

4891

4892

4893

4894

<p>Inherited from

4895

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

4896

4897

4898

4899

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

4900

4901

</p>

4902

4903

4904

4905

4906

4907

</div>

4908

4909

4910

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

4911

</div>

4912

4913

4914

4915

<h4>Parameters:</h4>

4916

4917

4918

4919

4920

4921

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

4922

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

4923

4924

4925

4926

4927

4928

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

4929

</div>

4930

4931

4932

</li>

4933

4934

4935

4936

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

4937

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

4938

4939

4940

4941

4942

4943

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

4944

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

4945

</div>

4946

4947

4948

</li>

4949

4950

4951

4952

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

4953

4954

4955

4956

4957

4958

4959

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

4960

</div>

4961

4962

4963

</li>

4964

4965

4966

4967

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

4968

4969

4970

4971

4972

4973

4974

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

4975

</div>

4976

4977

4978

</li>

4979

4980

4981

4982

4983

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

4984

4985

4986

4987

4988

4989

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

4990

</div>

4991

4992

4993

</li>

4994

4995

</ul>

4996

</div>

4997

4998

4999

5000

5001

5002

</div>

5003

5004

5005

5006

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

5007

5008

5009

5010

5011

5012

5013

5014

5015

5016

</li>

5017

5018

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

5019

</div>

5020

5021

5022

5023

5024

5025

</span>

5026

5027

5028

5029

5030

5031

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

5032

5033

5034

5035

5036

5037

5038

5039

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

5040

5041

5042

5043

5044

5045

<p>Inherited from

5046

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

5047

5048

5049

5050

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

5051

5052

</p>

5053

5054

5055

5056

5057

5058

</div>

5059

5060

5061

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

5062

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

5063

5064

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

5065

</div>

5066

5067

5068

5069

<h4>Parameters:</h4>

5070

5071

5072

5073

5074

5075

5076

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

5077

5078

5079

5080

5081

5082

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

5083

</div>

5084

5085

5086

</li>

5087

5088

</ul>

5089

</div>

5090

5091

5092

5093

5094

<h4>Returns:</h4>

5095

5096

5097

5098

5099

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

5100

5101

The value of the attribute.

5102

5103

</div>

5104

</div>

5105

5106

5107

5108

</div>

5109

5110

5111

5112

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

5113

5114

5115

5116

5117

5118

5119

5120

5121

5122

</li>

5123

5124

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

5125

</div>

5126

5127

5128

5129

5130

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

5131

</span>

5132

5133

5134

5135

5136

5137

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

5138

5139

5140

5141

5142

5143

5144

5145

5146

5147

5148

5149

<p>Inherited from

5150

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

5151

5152

5153

5154

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

5155

5156

</p>

5157

5158

5159

5160

5161

5162

</div>

5163

5164

5165

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

5166

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

5167

configuration properties for all attributes.</p>

5168

</div>

5169

5170

5171

5172

<h4>Parameters:</h4>

5173

5174

5175

5176

5177

5178

5179

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

5180

5181

5182

5183

5184

5185

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

5186

</div>

5187

5188

5189

</li>

5190

5191

</ul>

5192

</div>

5193

5194

5195

5196

5197

<h4>Returns:</h4>

5198

5199

5200

5201

5202

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

5203

5204

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

5205

5206

</div>

5207

</div>

5208

5209

5210

5211

</div>

5212

5213

5214

5215

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

5216

5217

5218

5219

5220

5221

5222

5223

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

5224

</span>

5225

5226

5227

5228

5229

5230

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

5231

5232

5233

5234

5235

5236

5237

5238

5239

5240

5241

5242

<p>Inherited from

5243

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

5244

5245

5246

5247

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

5248

5249

</p>

5250

5251

5252

5253

5254

5255

</div>

5256

5257

5258

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

5259

the class hierarchy.</p>

5260

</div>

5261

5262

5263

5264

5265

5266

<h4>Returns:</h4>

5267

5268

5269

5270

5271

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

5272

5273

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

5274

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

5275

the cached value.

5276

5277

</div>

5278

</div>

5279

5280

5281

5282

</div>

5283

5284

5285

5286

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

5287

5288

5289

5290

5291

5292

5293

5294

5295

5296

</li>

5297

5298

5299

5300

5301

5302

</li>

5303

5304

5305

5306

<code>initValues</code>

5307

5308

</li>

5309

5310

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

5311

</div>

5312

5313

5314

5315

5316

5317

</span>

5318

5319

5320

5321

5322

5323

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

5324

5325

5326

5327

5328

5329

5330

5331

5332

5333

5334

<p>Inherited from

5335

5336

Attribute

5337

</a>

5338

5339

but overwritten in

5340

5341

5342

5343

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

5344

5345

</p>

5346

5347

5348

5349

5350

5351

</div>

5352

5353

5354

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

5355

either the default configuration provided, or the

5356

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

5357

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

5358

</div>

5359

5360

5361

5362

<h4>Parameters:</h4>

5363

5364

5365

5366

5367

5368

5369

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

5370

5371

5372

5373

5374

5375

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

5376

</div>

5377

5378

5379

</li>

5380

5381

5382

5383

5384

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

5385

5386

5387

5388

5389

5390

<p>The attribute configuration object</p>

5391

</div>

5392

5393

5394

</li>

5395

5396

5397

5398

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

5399

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

5400

5401

5402

5403

5404

5405

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

5406

</div>

5407

5408

5409

</li>

5410

5411

</ul>

5412

</div>

5413

5414

5415

5416

5417

<h4>Returns:</h4>

5418

5419

5420

5421

5422

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

5423

5424

The initial value of the attribute.

5425

5426

</div>

5427

</div>

5428

5429

5430

5431

</div>

5432

5433

5434

5435

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

5436

5437

5438

5439

5440

5441

5442

5443

<code>attrs</code>

5444

5445

</li>

5446

5447

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

5448

</div>

5449

5450

5451

5452

5453

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

5454

</span>

5455

5456

5457

5458

5459

5460

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

5461

5462

5463

5464

5465

5466

5467

5468

5469

5470

5471

5472

<p>Inherited from

5473

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

5474

5475

5476

5477

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

5478

5479

</p>

5480

5481

5482

5483

5484

5485

</div>

5486

5487

5488

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

5489

</div>

5490

5491

5492

5493

<h4>Parameters:</h4>

5494

5495

5496

5497

5498

5499

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

5500

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

5501

5502

5503

5504

5505

5506

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

5507

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

5508

</div>

5509

5510

5511

</li>

5512

5513

</ul>

5514

</div>

5515

5516

5517

5518

5519

<h4>Returns:</h4>

5520

5521

5522

5523

5524

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

5525

5526

An object with attribute name/value pairs.

5527

5528

</div>

5529

</div>

5530

5531

5532

5533

</div>

5534

5535

5536

5537

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

5538

5539

5540

5541

5542

5543

5544

5545

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

5546

</span>

5547

5548

5549

5550

5551

5552

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

5553

5554

5555

5556

5557

5558

5559

5560

5561

5562

5563

5564

<p>Inherited from

5565

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

5566

5567

5568

5569

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

5570

5571

</p>

5572

5573

5574

5575

5576

5577

</div>

5578

5579

5580

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

5581

</div>

5582

5583

5584

5585

5586

5587

<h4>Returns:</h4>

5588

5589

5590

5591

5592

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

5593

5594

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

5595

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

5596

cached value.

5597

5598

</div>

5599

</div>

5600

5601

5602

5603

</div>

5604

5605

5606

5607

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

5608

5609

5610

5611

5612

5613

5614

5615

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

5616

</span>

5617

5618

5619

5620

5621

5622

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

5623

5624

5625

5626

5627

5628

5629

5630

5631

5632

5633

5634

<p>Inherited from

5635

<a href="../classes/Widget.html#method__getHtmlParser">Widget</a>:

5636

5637

5638

5639

<a href="../files/widget_js_WidgetHTMLParser.js.html#l135"><code>widget/js/WidgetHTMLParser.js:135</code></a>

5640

5641

</p>

5642

5643

5644

5645

5646

5647

</div>

5648

5649

5650

<p>Gets the HTML<em>PARSER definition for this instance, by merging HTML</em>PARSER

5651

definitions across the class hierarchy.</p>

5652

</div>

5653

5654

5655

5656

5657

5658

<h4>Returns:</h4>

5659

5660

5661

5662

5663

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

5664

5665

HTML_PARSER definition for this instance

5666

5667

</div>

5668

</div>

5669

5670

5671

5672

</div>

5673

5674

5675

5676

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

5677

5678

5679

5680

5681

5682

5683

5684

5685

</span>

5686

5687

5688

5689

5690

5691

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

5692

5693

5694

5695

5696

5697

5698

5699

5700

5701

5702

5703

<p>Inherited from

5704

<a href="../classes/Widget.html#method__getSrcNode">Widget</a>:

5705

5706

5707

5708

<a href="../files/widget_js_WidgetHTMLParser.js.html#l75"><code>widget/js/WidgetHTMLParser.js:75</code></a>

5709

5710

</p>

5711

5712

5713

5714

5715

5716

</div>

5717

5718

5719

5720

</div>

5721

5722

5723

5724

5725

5726

<h4>Returns:</h4>

5727

5728

5729

5730

5731

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

5732

5733

The Node to apply HTML_PARSER to

5734

5735

</div>

5736

</div>

5737

5738

5739

5740

</div>

5741

5742

5743

5744

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

5745

5746

5747

5748

5749

5750

5751

5752

5753

5754

</li>

5755

5756

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

5757

</div>

5758

5759

5760

5761

5762

5763

</span>

5764

5765

5766

5767

5768

5769

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

5770

5771

5772

5773

5774

5775

5776

5777

5778

5779

5780

5781

<p>Inherited from

5782

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

5783

5784

5785

5786

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

5787

5788

</p>

5789

5790

5791

5792

5793

5794

</div>

5795

5796

5797

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

5798

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

5799

</div>

5800

5801

5802

5803

<h4>Parameters:</h4>

5804

5805

5806

5807

5808

5809

5810

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

5811

5812

5813

5814

5815

5816

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

5817

</div>

5818

5819

5820

</li>

5821

5822

</ul>

5823

</div>

5824

5825

5826

5827

5828

<h4>Returns:</h4>

5829

5830

5831

5832

5833

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

5834

5835

The stored value of the attribute

5836

5837

</div>

5838

</div>

5839

5840

5841

5842

</div>

5843

5844

5845

5846

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

5847

5848

5849

5850

5851

5852

5853

5854

<code>locale</code>

5855

5856

</li>

5857

5858

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

5859

</div>

5860

5861

5862

5863

5864

5865

5866

5867

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

5868

5869

5870

5871

5872

5873

5874

5875

5876

5877

5878

5879

<p>Inherited from

5880

<a href="../classes/Widget.html#method__getStrings">Widget</a>:

5881

5882

5883

5884

<a href="../files/widget_js_WidgetLocale.js.html#l53"><code>widget/js/WidgetLocale.js:53</code></a>

5885

5886

</p>

5887

5888

5889

5890

5891

5892

</div>

5893

5894

5895

<p>Returns the strings key/value hash for a paricular locale, without locale lookup applied.</p>

5896

</div>

5897

5898

5899

5900

<h4>Parameters:</h4>

5901

5902

5903

5904

5905

5906

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

5907

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

5908

5909

5910

5911

5912

5913

5914

</div>

5915

5916

5917

</li>

5918

5919

</ul>

5920

</div>

5921

5922

5923

5924

5925

5926

</div>

5927

5928

5929

5930

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

5931

5932

5933

5934

5935

5936

5937

5938

5939

5940

5941

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

5942

5943

5944

5945

5946

5947

5948

5949

5950

5951

5952

5953

<p>Inherited from

5954

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

5955

5956

5957

5958

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

5959

5960

</p>

5961

5962

5963

5964

5965

5966

</div>

5967

5968

5969

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

5970

event type is not prefixed, the instance prefix is

5971

applied to the supplied type.</p>

5972

</div>

5973

5974

5975

5976

5977

5978

5979

</div>

5980

5981

5982

5983

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

5984

5985

5986

5987

5988

5989

5990

5991

5992

5993

5994

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

5995

5996

5997

5998

5999

6000

6001

6002

6003

6004

6005

<p>Inherited from

6006

6007

Widget

6008

</a>

6009

6010

but overwritten in

6011

6012

6013

6014

<a href="../files/widget-child_js_Widget-Child.js.html#l167"><code>widget-child/js/Widget-Child.js:167</code></a>

6015

6016

</p>

6017

6018

6019

6020

6021

6022

</div>

6023

6024

6025

<p>Returns the node on which to bind delegate listeners.</p>

6026

6027

<p>Override of Widget's implementation of _getUIEventNode() to ensure that

6028

all event listeners are bound to the Widget's topmost DOM element.

6029

This ensures that the firing of each type of Widget UI event (click,

6030

mousedown, etc.) is facilitated by a single, top-level, delegated DOM

6031

event listener.</p>

6032

</div>

6033

6034

6035

6036

6037

6038

6039

</div>

6040

6041

6042

6043

6044

6045

6046

6047

6048

6049

6050

6051

6052

6053

6054

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

6055

6056

6057

6058

6059

6060

6061

6062

6063

6064

6065

6066

<p>Inherited from

6067

<a href="../classes/Widget.html#method__guid">Widget</a>:

6068

6069

6070

6071

<a href="../files/widget_js_Widget.js.html#l1140"><code>widget/js/Widget.js:1140</code></a>

6072

6073

</p>

6074

6075

6076

6077

6078

6079

</div>

6080

6081

6082

6083

</div>

6084

6085

6086

6087

6088

6089

6090

</div>

6091

6092

6093

6094

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

6095

6096

6097

6098

6099

6100

6101

6102

<code>attrs</code>

6103

6104

</li>

6105

6106

6107

6108

<code>values</code>

6109

6110

</li>

6111

6112

6113

6114

6115

6116

</li>

6117

6118

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

6119

</div>

6120

6121

6122

6123

6124

6125

6126

6127

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

6128

6129

6130

6131

6132

6133

6134

6135

6136

6137

6138

6139

<p>Inherited from

6140

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

6141

6142

6143

6144

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

6145

6146

</p>

6147

6148

6149

6150

6151

6152

</div>

6153

6154

6155

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

6156

constructor.</p>

6157

</div>

6158

6159

6160

6161

<h4>Parameters:</h4>

6162

6163

6164

6165

6166

6167

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

6168

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

6169

6170

6171

6172

6173

6174

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

6175

</div>

6176

6177

6178

</li>

6179

6180

6181

6182

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

6183

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

6184

6185

6186

6187

6188

6189

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

6190

</div>

6191

6192

6193

</li>

6194

6195

6196

6197

6198

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

6199

6200

6201

6202

6203

6204

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

6205

</div>

6206

6207

6208

</li>

6209

6210

</ul>

6211

</div>

6212

6213

6214

6215

6216

6217

</div>

6218

6219

6220

6221

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

6222

6223

6224

6225

6226

6227

6228

6229

6230

6231

6232

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

6233

6234

6235

6236

6237

6238

6239

6240

6241

6242

6243

<p>Inherited from

6244

6245

BaseCore

6246

</a>

6247

6248

but overwritten in

6249

6250

6251

6252

6253

6254

</p>

6255

6256

6257

6258

6259

6260

</div>

6261

6262

6263

<p>Initializes Attribute</p>

6264

</div>

6265

6266

6267

6268

6269

6270

6271

</div>

6272

6273

6274

6275

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

6276

6277

6278

6279

6280

6281

6282

6283

<code>attrs</code>

6284

6285

</li>

6286

6287

6288

6289

<code>values</code>

6290

6291

</li>

6292

6293

6294

6295

6296

6297

</li>

6298

6299

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

6300

</div>

6301

6302

6303

6304

6305

6306

6307

6308

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

6309

6310

6311

6312

6313

6314

6315

6316

6317

6318

6319

6320

<p>Inherited from

6321

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

6322

6323

6324

6325

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

6326

6327

</p>

6328

6329

6330

6331

6332

6333

</div>

6334

6335

6336

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

6337

</div>

6338

6339

6340

6341

<h4>Parameters:</h4>

6342

6343

6344

6345

6346

6347

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

6348

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

6349

6350

6351

6352

6353

6354

6355

</div>

6356

6357

6358

</li>

6359

6360

6361

6362

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

6363

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

6364

6365

6366

6367

6368

6369

6370

</div>

6371

6372

6373

</li>

6374

6375

6376

6377

6378

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

6379

6380

6381

6382

6383

6384

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

6385

</div>

6386

6387

6388

</li>

6389

6390

</ul>

6391

</div>

6392

6393

6394

6395

6396

6397

</div>

6398

6399

6400

6401

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

6402

6403

6404

6405

6406

6407

6408

6409

<code>config</code>

6410

6411

</li>

6412

6413

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

6414

</div>

6415

6416

6417

6418

6419

6420

6421

6422

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

6423

6424

6425

6426

6427

6428

6429

6430

6431

6432

6433

<p>Inherited from

6434

6435

BaseCore

6436

</a>

6437

6438

but overwritten in

6439

6440

6441

6442

6443

6444

</p>

6445

6446

6447

6448

6449

6450

</div>

6451

6452

6453

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

6454

</div>

6455

6456

6457

6458

<h4>Parameters:</h4>

6459

6460

6461

6462

6463

6464

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

6465

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

6466

6467

6468

6469

6470

6471

<p>The constructor configuration object</p>

6472

</div>

6473

6474

6475

</li>

6476

6477

</ul>

6478

</div>

6479

6480

6481

6482

6483

6484

</div>

6485

6486

6487

6488

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

6489

6490

6491

6492

6493

6494

6495

6496

<code>userVals</code>

6497

6498

</li>

6499

6500

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

6501

</div>

6502

6503

6504

6505

6506

6507

6508

6509

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

6510

6511

6512

6513

6514

6515

6516

6517

6518

6519

6520

6521

<p>Inherited from

6522

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

6523

6524

6525

6526

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

6527

6528

</p>

6529

6530

6531

6532

6533

6534

</div>

6535

6536

6537

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

6538

initializing attributes for each class defined in the class's

6539

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

6540

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

6541

</div>

6542

6543

6544

6545

<h4>Parameters:</h4>

6546

6547

6548

6549

6550

6551

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

6552

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

6553

6554

6555

6556

6557

6558

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

6559

</div>

6560

6561

6562

</li>

6563

6564

</ul>

6565

</div>

6566

6567

6568

6569

6570

6571

</div>

6572

6573

6574

6575

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

6576

6577

6578

6579

6580

6581

6582

6583

6584

6585

6586

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

6587

6588

6589

6590

6591

6592

6593

6594

6595

6596

6597

6598

<p>Inherited from

6599

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

6600

6601

6602

6603

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

6604

6605

</p>

6606

6607

6608

6609

6610

6611

</div>

6612

6613

6614

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

6615

the array of classes and aggregate set of attribute configurations

6616

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

6617

</div>

6618

6619

6620

6621

6622

6623

6624

</div>

6625

6626

6627

6628

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

6629

6630

6631

6632

6633

6634

6635

6636

6637

6638

</li>

6639

6640

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

6641

</div>

6642

6643

6644

6645

6646

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

6647

</span>

6648

6649

6650

6651

6652

6653

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

6654

6655

6656

6657

6658

6659

6660

6661

6662

6663

6664

6665

<p>Inherited from

6666

<a href="../classes/Widget.html#method__initUIEvent">Widget</a>:

6667

6668

6669

6670

<a href="../files/widget_js_WidgetUIEvents.js.html#l176"><code>widget/js/WidgetUIEvents.js:176</code></a>

6671

6672

</p>

6673

6674

6675

6676

6677

6678

</div>

6679

6680

6681

<p>Sets up infrastructure required to fire a UI event.</p>

6682

</div>

6683

6684

6685

6686

<h4>Parameters:</h4>

6687

6688

6689

6690

6691

6692

6693

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

6694

6695

6696

6697

6698

6699

<p>String representing the name of the event</p>

6700

</div>

6701

6702

6703

</li>

6704

6705

</ul>

6706

</div>

6707

6708

6709

6710

6711

<h4>Returns:</h4>

6712

6713

6714

6715

6716

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

6717

6718

6719

</div>

6720

</div>

6721

6722

6723

6724

</div>

6725

6726

6727

6728

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

6729

6730

6731

6732

6733

6734

6735

6736

6737

6738

</li>

6739

6740

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

6741

</div>

6742

6743

6744

6745

6746

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

6747

</span>

6748

6749

6750

6751

6752

6753

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

6754

6755

6756

6757

6758

6759

6760

6761

6762

6763

6764

6765

<p>Inherited from

6766

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

6767

6768

6769

6770

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

6771

6772

</p>

6773

6774

6775

6776

6777

6778

</div>

6779

6780

6781

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

6782

added lazily and still requires initialization.</p>

6783

</div>

6784

6785

6786

6787

<h4>Parameters:</h4>

6788

6789

6790

6791

6792

6793

6794

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

6795

6796

6797

6798

6799

6800

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

6801

</div>

6802

6803

6804

</li>

6805

6806

</ul>

6807

</div>

6808

6809

6810

6811

6812

<h4>Returns:</h4>

6813

6814

6815

6816

6817

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

6818

6819

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

6820

6821

</div>

6822

</div>

6823

6824

6825

6826

</div>

6827

6828

6829

6830

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

6831

6832

6833

6834

6835

6836

6837

6838

6839

6840

</li>

6841

6842

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

6843

</div>

6844

6845

6846

6847

6848

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

6849

</span>

6850

6851

6852

6853

6854

6855

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

6856

6857

6858

6859

6860

6861

6862

6863

6864

6865

6866

6867

<p>Inherited from

6868

<a href="../classes/Widget.html#method__isUIEvent">Widget</a>:

6869

6870

6871

6872

<a href="../files/widget_js_WidgetUIEvents.js.html#l143"><code>widget/js/WidgetUIEvents.js:143</code></a>

6873

6874

</p>

6875

6876

6877

6878

6879

6880

</div>

6881

6882

6883

<p>Determines if the specified event is a UI event.</p>

6884

</div>

6885

6886

6887

6888

<h4>Parameters:</h4>

6889

6890

6891

6892

6893

6894

6895

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

6896

6897

6898

6899

6900

6901

<p>String representing the name of the event</p>

6902

</div>

6903

6904

6905

</li>

6906

6907

</ul>

6908

</div>

6909

6910

6911

6912

6913

<h4>Returns:</h4>

6914

6915

6916

6917

6918

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

6919

6920

Event Returns the name of the UI Event, otherwise

6921

undefined.

6922

6923

</div>

6924

</div>

6925

6926

6927

6928

</div>

6929

6930

6931

6932

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

6933

6934

6935

6936

6937

6938

6939

6940

6941

6942

</li>

6943

6944

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

6945

</div>

6946

6947

6948

6949

6950

6951

6952

6953

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

6954

6955

6956

6957

6958

6959

6960

6961

6962

6963

6964

6965

<p>Inherited from

6966

<a href="../classes/Widget.html#method__mapInstance">Widget</a>:

6967

6968

6969

6970

<a href="../files/widget_js_Widget.js.html#l415"><code>widget/js/Widget.js:415</code></a>

6971

6972

</p>

6973

6974

6975

6976

6977

6978

</div>

6979

6980

6981

<p>Utility method used to add an entry to the boundingBox id to instance map. </p>

6982

6983

<p>This method can be used to populate the instance with lazily created boundingBox Node references.</p>

6984

</div>

6985

6986

6987

6988

<h4>Parameters:</h4>

6989

6990

6991

6992

6993

6994

6995

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

6996

6997

6998

6999

7000

7001

<p>boundingBox id</p>

7002

</div>

7003

7004

7005

</li>

7006

7007

</ul>

7008

</div>

7009

7010

7011

7012

7013

7014

</div>

7015

7016

7017

7018

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

7019

7020

7021

7022

7023

7024

7025

7026

7027

7028

</li>

7029

7030

7031

7032

7033

7034

</li>

7035

7036

7037

7038

7039

7040

</li>

7041

7042

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

7043

</div>

7044

7045

7046

7047

7048

7049

7050

7051

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

7052

7053

7054

7055

7056

7057

7058

7059

7060

7061

7062

7063

<p>Inherited from

7064

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

7065

7066

7067

7068

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

7069

7070

</p>

7071

7072

7073

7074

7075

7076

</div>

7077

7078

7079

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

7080

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

7081

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

7082

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

7083

be subscribed to like other events to monitor the event

7084

system. Inividual published events can have monitoring

7085

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

7086

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

7087

</div>

7088

7089

7090

7091

<h4>Parameters:</h4>

7092

7093

7094

7095

7096

7097

7098

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

7099

7100

7101

7102

7103

7104

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

7105

</div>

7106

7107

7108

</li>

7109

7110

7111

7112

7113

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

7114

7115

7116

7117

7118

7119

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

7120

</div>

7121

7122

7123

</li>

7124

7125

7126

7127

7128

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

7129

7130

7131

7132

7133

7134

<p>Information about the event interaction, such as

7135

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

7136

</div>

7137

7138

7139

</li>

7140

7141

</ul>

7142

</div>

7143

7144

7145

7146

7147

7148

</div>

7149

7150

7151

7152

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

7153

7154

7155

7156

7157

7158

7159

7160

<code>valueHash</code>

7161

7162

</li>

7163

7164

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

7165

</div>

7166

7167

7168

7169

7170

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

7171

</span>

7172

7173

7174

7175

7176

7177

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

7178

7179

7180

7181

7182

7183

7184

7185

7186

7187

7188

<p>Inherited from

7189

7190

Attribute

7191

</a>

7192

7193

but overwritten in

7194

7195

7196

7197

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

7198

7199

</p>

7200

7201

7202

7203

7204

7205

</div>

7206

7207

7208

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

7209

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

7210

</div>

7211

7212

7213

7214

<h4>Parameters:</h4>

7215

7216

7217

7218

7219

7220

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

7221

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

7222

7223

7224

7225

7226

7227

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

7228

</div>

7229

7230

7231

</li>

7232

7233

</ul>

7234

</div>

7235

7236

7237

7238

7239

<h4>Returns:</h4>

7240

7241

7242

7243

7244

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

7245

7246

7247

</div>

7248

</div>

7249

7250

7251

7252

</div>

7253

7254

7255

7256

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

7257

7258

7259

7260

7261

7262

7263

7264

7265

7266

</li>

7267

7268

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

7269

</div>

7270

7271

7272

7273

7274

7275

7276

7277

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

7278

7279

7280

7281

7282

7283

7284

7285

7286

7287

7288

7289

<p>Inherited from

7290

<a href="../classes/Widget.html#method__onDocFocus">Widget</a>:

7291

7292

7293

7294

<a href="../files/widget_js_Widget.js.html#l1068"><code>widget/js/Widget.js:1068</code></a>

7295

7296

</p>

7297

7298

7299

7300

7301

7302

</div>

7303

7304

7305

<p>DOM focus event handler, used to sync the state of the Widget with the DOM</p>

7306

</div>

7307

7308

7309

7310

<h4>Parameters:</h4>

7311

7312

7313

7314

7315

7316

7317

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

7318

7319

7320

7321

7322

7323

<p>The event facade for the DOM focus event</p>

7324

</div>

7325

7326

7327

</li>

7328

7329

</ul>

7330

</div>

7331

7332

7333

7334

7335

7336

</div>

7337

7338

7339

7340

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

7341

7342

7343

7344

7345

7346

7347

7348

7349

7350

</li>

7351

7352

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

7353

</div>

7354

7355

7356

7357

7358

7359

7360

7361

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

7362

7363

7364

7365

7366

7367

7368

7369

7370

7371

7372

7373

<p>Inherited from

7374

<a href="../classes/Widget.html#method__onDocMouseDown">Widget</a>:

7375

7376

7377

7378

<a href="../files/widget_js_Widget.js.html#l1055"><code>widget/js/Widget.js:1055</code></a>

7379

7380

</p>

7381

7382

7383

7384

7385

7386

</div>

7387

7388

7389

<p>"mousedown" event handler for the owner document of the

7390

widget's bounding box.</p>

7391

</div>

7392

7393

7394

7395

<h4>Parameters:</h4>

7396

7397

7398

7399

7400

7401

7402

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

7403

7404

7405

7406

7407

7408

<p>The event facade for the DOM focus event</p>

7409

</div>

7410

7411

7412

</li>

7413

7414

</ul>

7415

</div>

7416

7417

7418

7419

7420

7421

</div>

7422

7423

7424

7425

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

7426

7427

7428

7429

7430

7431

7432

7433

7434

7435

7436

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

7437

7438

7439

7440

7441

7442

7443

7444

7445

7446

7447

7448

<p>Inherited from

7449

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

7450

7451

7452

7453

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

7454

7455

</p>

7456

7457

7458

7459

7460

7461

</div>

7462

7463

7464

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

7465

and the prefixed event name from _getType

7466

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

7467

</div>

7468

7469

7470

7471

7472

7473

7474

</div>

7475

7476

7477

7478

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

7479

7480

7481

7482

7483

7484

7485

7486

<code>config</code>

7487

7488

</li>

7489

7490

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

7491

</div>

7492

7493

7494

7495

7496

7497

7498

7499

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

7500

7501

7502

7503

7504

7505

7506

7507

7508

7509

7510

7511

<p>Inherited from

7512

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

7513

7514

7515

7516

7517

7518

</p>

7519

7520

7521

7522

7523

7524

</div>

7525

7526

7527

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

7528

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

7529

construction, prior to init.</p>

7530

</div>

7531

7532

7533

7534

<h4>Parameters:</h4>

7535

7536

7537

7538

7539

7540

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

7541

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

7542

7543

7544

7545

7546

7547

<p>The user configuration object</p>

7548

</div>

7549

7550

7551

</li>

7552

7553

</ul>

7554

</div>

7555

7556

7557

7558

7559

7560

</div>

7561

7562

7563

7564

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

7565

7566

7567

7568

7569

7570

7571

7572

<code>attrs</code>

7573

7574

</li>

7575

7576

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

7577

</div>

7578

7579

7580

7581

7582

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

7583

</span>

7584

7585

7586

7587

7588

7589

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

7590

7591

7592

7593

7594

7595

7596

7597

7598

7599

7600

7601

<p>Inherited from

7602

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

7603

7604

7605

7606

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

7607

7608

</p>

7609

7610

7611

7612

7613

7614

</div>

7615

7616

7617

<p>Utility method to protect an attribute configuration

7618

hash, by merging the entire object and the individual

7619

attr config objects.</p>

7620

</div>

7621

7622

7623

7624

<h4>Parameters:</h4>

7625

7626

7627

7628

7629

7630

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

7631

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

7632

7633

7634

7635

7636

7637

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

7638

</div>

7639

7640

7641

</li>

7642

7643

</ul>

7644

</div>

7645

7646

7647

7648

7649

<h4>Returns:</h4>

7650

7651

7652

7653

7654

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

7655

7656

A protected version of the attrs argument.

7657

7658

</div>

7659

</div>

7660

7661

7662

7663

</div>

7664

7665

7666

7667

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

7668

7669

7670

7671

7672

7673

7674

7675

7676

7677

7678

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

7679

7680

7681

7682

7683

7684

7685

7686

7687

7688

7689

7690

<p>Inherited from

7691

<a href="../classes/Widget.html#method__removeLoadingClassNames">Widget</a>:

7692

7693

7694

7695

<a href="../files/widget_js_Widget.js.html#l849"><code>widget/js/Widget.js:849</code></a>

7696

7697

</p>

7698

7699

7700

7701

7702

7703

</div>

7704

7705

7706

<p>Removes class names representative of the widget's loading state from

7707

the boundingBox.</p>

7708

</div>

7709

7710

7711

7712

7713

7714

7715

</div>

7716

7717

7718

7719

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

7720

7721

7722

7723

7724

7725

7726

7727

<code>parentNode</code>

7728

7729

</li>

7730

7731

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

7732

</div>

7733

7734

7735

7736

7737

7738

7739

7740

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

7741

7742

7743

7744

7745

7746

7747

7748

7749

7750

7751

7752

<p>Inherited from

7753

<a href="../classes/Widget.html#method__renderBox">Widget</a>:

7754

7755

7756

7757

<a href="../files/widget_js_Widget.js.html#l711"><code>widget/js/Widget.js:711</code></a>

7758

7759

</p>

7760

7761

7762

7763

7764

7765

</div>

7766

7767

7768

<p>Helper method to collect the boundingBox and contentBox and append to the provided parentNode, if not

7769

already a child. The owner document of the boundingBox, or the owner document of the contentBox will be used

7770

as the document into which the Widget is rendered if a parentNode is node is not provided. If both the boundingBox and

7771

the contentBox are not currently in the document, and no parentNode is provided, the widget will be rendered

7772

to the current document's body.</p>

7773

</div>

7774

7775

7776

7777

<h4>Parameters:</h4>

7778

7779

7780

7781

7782

7783

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

7784

7785

7786

7787

7788

7789

7790

<p>The parentNode to render the widget to. If not provided, and both the boundingBox and

7791

the contentBox are not currently in the document, the widget will be rendered to the current document's body.</p>

7792

</div>

7793

7794

7795

</li>

7796

7797

</ul>

7798

</div>

7799

7800

7801

7802

7803

7804

</div>

7805

7806

7807

7808

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

7809

7810

7811

7812

7813

7814

7815

7816

7817

7818

7819

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

7820

7821

7822

7823

7824

7825

7826

7827

7828

7829

7830

7831

<p>Inherited from

7832

<a href="../classes/Widget.html#method__renderBoxClassNames">Widget</a>:

7833

7834

7835

7836

<a href="../files/widget_js_Widget.js.html#l825"><code>widget/js/Widget.js:825</code></a>

7837

7838

</p>

7839

7840

7841

7842

7843

7844

</div>

7845

7846

7847

<p>Applies standard class names to the boundingBox and contentBox</p>

7848

</div>

7849

7850

7851

7852

7853

7854

7855

</div>

7856

7857

7858

7859

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

7860

7861

7862

7863

7864

7865

7866

7867

7868

7869

7870

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

7871

7872

7873

7874

7875

7876

7877

7878

7879

7880

7881

7882

<p>Inherited from

7883

<a href="../classes/Widget.html#method__renderUI">Widget</a>:

7884

7885

7886

7887

<a href="../files/widget_js_Widget.js.html#l814"><code>widget/js/Widget.js:814</code></a>

7888

7889

</p>

7890

7891

7892

7893

7894

7895

</div>

7896

7897

7898

<p>Initializes the UI state for the Widget's bounding/content boxes.</p>

7899

</div>

7900

7901

7902

7903

7904

7905

7906

</div>

7907

7908

7909

7910

7911

7912

7913

7914

7915

7916

7917

7918

7919

7920

</li>

7921

7922

7923

7924

7925

7926

</li>

7927

7928

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

7929

</div>

7930

7931

7932

7933

7934

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

7935

</span>

7936

7937

7938

7939

7940

7941

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

7942

7943

7944

7945

7946

7947

7948

7949

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

7950

7951

7952

7953

7954

<p>Inherited from

7955

7956

AttributeEvents

7957

</a>

7958

7959

but overwritten in

7960

7961

7962

7963

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

7964

7965

</p>

7966

7967

7968

7969

7970

7971

</div>

7972

7973

7974

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

7975

</div>

7976

7977

7978

7979

<h4>Parameters:</h4>

7980

7981

7982

7983

7984

7985

7986

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

7987

7988

7989

7990

7991

7992

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

7993

</div>

7994

7995

7996

</li>

7997

7998

7999

8000

8001

8002

8003

8004

8005

8006

8007

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

8008

</div>

8009

8010

8011

</li>

8012

8013

</ul>

8014

</div>

8015

8016

8017

8018

8019

<h4>Returns:</h4>

8020

8021

8022

8023

8024

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

8025

8026

A reference to the host object.

8027

8028

</div>

8029

</div>

8030

8031

8032

8033

</div>

8034

8035

8036

8037

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

8038

8039

8040

8041

8042

8043

8044

8045

8046

8047

</li>

8048

8049

8050

8051

<code>value</code>

8052

8053

</li>

8054

8055

8056

8057

8058

8059

</li>

8060

8061

8062

8063

<code>force</code>

8064

8065

</li>

8066

8067

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

8068

</div>

8069

8070

8071

8072

8073

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

8074

</span>

8075

8076

8077

8078

8079

8080

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

8081

8082

8083

8084

8085

8086

8087

8088

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

8089

8090

8091

8092

8093

8094

<p>Inherited from

8095

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

8096

8097

8098

8099

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

8100

8101

</p>

8102

8103

8104

8105

8106

8107

</div>

8108

8109

8110

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

8111

8112

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

8113

</div>

8114

8115

8116

8117

<h4>Parameters:</h4>

8118

8119

8120

8121

8122

8123

8124

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

8125

8126

8127

8128

8129

8130

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

8131

</div>

8132

8133

8134

</li>

8135

8136

8137

8138

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

8139

8140

8141

8142

8143

8144

8145

<p>The value to set the attribute to.</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/Object" class="crosslink external" target="_blank">Object</a></span>

8155

8156

8157

8158

8159

8160

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

8161

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

8162

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

8163

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

8164

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

8165

</div>

8166

8167

8168

</li>

8169

8170

8171

8172

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

8173

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

8174

8175

8176

8177

8178

8179

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

8180

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

8181

</div>

8182

8183

8184

</li>

8185

8186

</ul>

8187

</div>

8188

8189

8190

8191

8192

<h4>Returns:</h4>

8193

8194

8195

8196

8197

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

8198

8199

A reference to the host object.

8200

8201

</div>

8202

</div>

8203

8204

8205

8206

</div>

8207

8208

8209

8210

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

8211

8212

8213

8214

8215

8216

8217

8218

<code>attrs</code>

8219

8220

</li>

8221

8222

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

8223

</div>

8224

8225

8226

8227

8228

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

8229

</span>

8230

8231

8232

8233

8234

8235

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

8236

8237

8238

8239

8240

8241

8242

8243

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

8244

8245

8246

8247

8248

8249

<p>Inherited from

8250

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

8251

8252

8253

8254

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

8255

8256

</p>

8257

8258

8259

8260

8261

8262

</div>

8263

8264

8265

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

8266

</div>

8267

8268

8269

8270

<h4>Parameters:</h4>

8271

8272

8273

8274

8275

8276

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

8277

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

8278

8279

8280

8281

8282

8283

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

8284

</div>

8285

8286

8287

</li>

8288

8289

</ul>

8290

</div>

8291

8292

8293

8294

8295

<h4>Returns:</h4>

8296

8297

8298

8299

8300

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

8301

8302

A reference to the host object.

8303

8304

</div>

8305

</div>

8306

8307

8308

8309

</div>

8310

8311

8312

8313

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

8314

8315

8316

8317

8318

8319

8320

8321

8322

8323

</li>

8324

8325

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

8326

</div>

8327

8328

8329

8330

8331

8332

8333

8334

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

8335

8336

8337

8338

8339

8340

8341

8342

8343

8344

8345

8346

<p>Inherited from

8347

<a href="../classes/Widget.html#method__setAttrUI">Widget</a>:

8348

8349

8350

8351

<a href="../files/widget_js_Widget.js.html#l1188"><code>widget/js/Widget.js:1188</code></a>

8352

8353

</p>

8354

8355

8356

8357

8358

8359

</div>

8360

8361

8362

8363

</div>

8364

8365

8366

8367

<h4>Parameters:</h4>

8368

8369

8370

8371

8372

8373

8374

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

8375

8376

8377

8378

8379

8380

8381

</div>

8382

8383

8384

</li>

8385

8386

</ul>

8387

</div>

8388

8389

8390

8391

8392

8393

</div>

8394

8395

8396

8397

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

8398

8399

8400

8401

8402

8403

8404

8405

<code>attrName</code>

8406

8407

</li>

8408

8409

8410

8411

<code>subAttrName</code>

8412

8413

</li>

8414

8415

8416

8417

<code>prevVal</code>

8418

8419

</li>

8420

8421

8422

8423

<code>newVal</code>

8424

8425

</li>

8426

8427

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

8428

</div>

8429

8430

8431

8432

8433

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

8434

</span>

8435

8436

8437

8438

8439

8440

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

8441

8442

8443

8444

8445

8446

8447

8448

8449

8450

8451

8452

<p>Inherited from

8453

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

8454

8455

8456

8457

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

8458

8459

</p>

8460

8461

8462

8463

8464

8465

</div>

8466

8467

8468

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

8469

if validation and setter passes.</p>

8470

</div>

8471

8472

8473

8474

<h4>Parameters:</h4>

8475

8476

8477

8478

8479

8480

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

8481

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

8482

8483

8484

8485

8486

8487

<p>The attribute name.</p>

8488

</div>

8489

8490

8491

</li>

8492

8493

8494

8495

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

8496

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

8497

8498

8499

8500

8501

8502

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

8503

</div>

8504

8505

8506

</li>

8507

8508

8509

8510

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

8511

8512

8513

8514

8515

8516

8517

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

8518

</div>

8519

8520

8521

</li>

8522

8523

8524

8525

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

8526

8527

8528

8529

8530

8531

8532

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

8533

</div>

8534

8535

8536

</li>

8537

8538

</ul>

8539

</div>

8540

8541

8542

8543

8544

<h4>Returns:</h4>

8545

8546

8547

8548

8549

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

8550

8551

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

8552

8553

</div>

8554

</div>

8555

8556

8557

8558

</div>

8559

8560

8561

8562

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

8563

8564

8565

8566

8567

8568

8569

8570

<code>Node/String</code>

8571

8572

</li>

8573

8574

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

8575

</div>

8576

8577

8578

8579

8580

8581

</span>

8582

8583

8584

8585

8586

8587

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

8588

8589

8590

8591

8592

8593

8594

8595

8596

8597

8598

8599

<p>Inherited from

8600

<a href="../classes/Widget.html#method__setBB">Widget</a>:

8601

8602

8603

8604

<a href="../files/widget_js_Widget.js.html#l757"><code>widget/js/Widget.js:757</code></a>

8605

8606

</p>

8607

8608

8609

8610

8611

8612

</div>

8613

8614

8615

<p>Setter for the boundingBox attribute</p>

8616

</div>

8617

8618

8619

8620

<h4>Parameters:</h4>

8621

8622

8623

8624

8625

8626

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

8627

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

8628

8629

8630

8631

8632

8633

8634

</div>

8635

8636

8637

</li>

8638

8639

</ul>

8640

</div>

8641

8642

8643

8644

8645

<h4>Returns:</h4>

8646

8647

8648

8649

8650

Node

8651

8652

</div>

8653

</div>

8654

8655

8656

8657

</div>

8658

8659

8660

8661

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

8662

8663

8664

8665

8666

8667

8668

8669

8670

8671

</li>

8672

8673

8674

8675

8676

8677

</li>

8678

8679

8680

8681

<code>template</code>

8682

8683

</li>

8684

8685

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

8686

</div>

8687

8688

8689

8690

8691

8692

</span>

8693

8694

8695

8696

8697

8698

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

8699

8700

8701

8702

8703

8704

8705

8706

8707

8708

8709

8710

<p>Inherited from

8711

<a href="../classes/Widget.html#method__setBox">Widget</a>:

8712

8713

8714

8715

<a href="../files/widget_js_Widget.js.html#l794"><code>widget/js/Widget.js:794</code></a>

8716

8717

</p>

8718

8719

8720

8721

8722

8723

</div>

8724

8725

8726

<p>Helper method to set the bounding/content box, or create it from

8727

the provided template if not found.</p>

8728

</div>

8729

8730

8731

8732

<h4>Parameters:</h4>

8733

8734

8735

8736

8737

8738

8739

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

8740

8741

8742

8743

8744

8745

<p>The node's id attribute</p>

8746

</div>

8747

8748

8749

</li>

8750

8751

8752

8753

8754

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

8755

8756

8757

8758

8759

8760

<p>The node reference</p>

8761

</div>

8762

8763

8764

</li>

8765

8766

8767

8768

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

8769

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

8770

8771

8772

8773

8774

8775

<p>HTML string template for the node</p>

8776

</div>

8777

8778

8779

</li>

8780

8781

</ul>

8782

</div>

8783

8784

8785

8786

8787

<h4>Returns:</h4>

8788

8789

8790

8791

8792

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

8793

8794

The node

8795

8796

</div>

8797

</div>

8798

8799

8800

8801

</div>

8802

8803

8804

8805

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

8806

8807

8808

8809

8810

8811

8812

8813

<code>state</code>

8814

8815

</li>

8816

8817

8818

8819

8820

8821

</li>

8822

8823

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

8824

</div>

8825

8826

8827

8828

8829

8830

8831

8832

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

8833

8834

8835

8836

8837

8838

8839

8840

8841

8842

8843

8844

8845

<p>

8846

8847

Defined in

8848

8849

8850

8851

8852

<a href="../files/uploader_js_uploader-html5.js.html#l355"><code>uploader/js/uploader-html5.js:355</code></a>

8853

8854

</p>

8855

8856

8857

8858

8859

8860

</div>

8861

8862

8863

<p>Adds or removes a specified state CSS class to the underlying uploader button.</p>

8864

</div>

8865

8866

8867

8868

<h4>Parameters:</h4>

8869

8870

8871

8872

8873

8874

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

8875

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

8876

8877

8878

8879

8880

8881

<p>The name of the state enumerated in <code>buttonClassNames</code> attribute

8882

from which to derive the needed class name.</p>

8883

</div>

8884

8885

8886

</li>

8887

8888

8889

8890

8891

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

8892

8893

8894

8895

8896

8897

<p>A Boolean indicating whether to add or remove the class.</p>

8898

</div>

8899

8900

8901

</li>

8902

8903

</ul>

8904

</div>

8905

8906

8907

8908

8909

8910

</div>

8911

8912

8913

8914

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

8915

8916

8917

8918

8919

8920

8921

8922

8923

8924

</li>

8925

8926

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

8927

</div>

8928

8929

8930

8931

8932

8933

</span>

8934

8935

8936

8937

8938

8939

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

8940

8941

8942

8943

8944

8945

8946

8947

8948

8949

8950

8951

<p>Inherited from

8952

<a href="../classes/Widget.html#method__setCB">Widget</a>:

8953

8954

8955

8956

<a href="../files/widget_js_Widget.js.html#l769"><code>widget/js/Widget.js:769</code></a>

8957

8958

</p>

8959

8960

8961

8962

8963

8964

</div>

8965

8966

8967

<p>Setter for the contentBox attribute</p>

8968

</div>

8969

8970

8971

8972

<h4>Parameters:</h4>

8973

8974

8975

8976

8977

8978

8979

8980

8981

8982

8983

8984

8985

8986

</div>

8987

8988

8989

</li>

8990

8991

</ul>

8992

</div>

8993

8994

8995

8996

8997

<h4>Returns:</h4>

8998

8999

9000

9001

9002

Node

9003

9004

</div>

9005

</div>

9006

9007

9008

9009

</div>

9010

9011

9012

9013

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

9014

9015

9016

9017

9018

9019

9020

9021

9022

9023

9024

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

9025

9026

9027

9028

9029

9030

9031

9032

9033

9034

9035

9036

9037

<p>

9038

9039

Defined in

9040

9041

9042

9043

9044

<a href="../files/uploader_js_uploader-html5.js.html#l373"><code>uploader/js/uploader-html5.js:373</code></a>

9045

9046

</p>

9047

9048

9049

9050

9051

9052

</div>

9053

9054

9055

<p>Syncs the state of the <code>multipleFiles</code> attribute between this class

9056

and the file input field.</p>

9057

</div>

9058

9059

9060

9061

9062

9063

9064

</div>

9065

9066

9067

9068

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

9069

9070

9071

9072

9073

9074

9075

9076

9077

9078

</li>

9079

9080

9081

9082

<code>value</code>

9083

9084

</li>

9085

9086

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

9087

</div>

9088

9089

9090

9091

9092

9093

9094

9095

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

9096

9097

9098

9099

9100

9101

9102

9103

9104

9105

9106

9107

<p>Inherited from

9108

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

9109

9110

9111

9112

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

9113

9114

</p>

9115

9116

9117

9118

9119

9120

</div>

9121

9122

9123

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

9124

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

9125

</div>

9126

9127

9128

9129

<h4>Parameters:</h4>

9130

9131

9132

9133

9134

9135

9136

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

9137

9138

9139

9140

9141

9142

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

9143

</div>

9144

9145

9146

</li>

9147

9148

9149

9150

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

9151

9152

9153

9154

9155

9156

9157

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

9158

</div>

9159

9160

9161

</li>

9162

9163

</ul>

9164

</div>

9165

9166

9167

9168

9169

9170

</div>

9171

9172

9173

9174

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

9175

9176

9177

9178

9179

9180

9181

9182

<code>strings</code>

9183

9184

</li>

9185

9186

9187

9188

<code>locale</code>

9189

9190

</li>

9191

9192

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

9193

</div>

9194

9195

9196

9197

9198

9199

9200

9201

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

9202

9203

9204

9205

9206

9207

9208

9209

9210

9211

9212

9213

<p>Inherited from

9214

<a href="../classes/Widget.html#method__setStrings">Widget</a>:

9215

9216

9217

9218

<a href="../files/widget_js_WidgetLocale.js.html#l32"><code>widget/js/WidgetLocale.js:32</code></a>

9219

9220

</p>

9221

9222

9223

9224

9225

9226

</div>

9227

9228

9229

<p>Sets strings for a particular locale, merging with any existing

9230

strings which may already be defined for the locale.</p>

9231

</div>

9232

9233

9234

9235

<h4>Parameters:</h4>

9236

9237

9238

9239

9240

9241

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

9242

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

9243

9244

9245

9246

9247

9248

<p>The hash of string key/values to set</p>

9249

</div>

9250

9251

9252

</li>

9253

9254

9255

9256

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

9257

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

9258

9259

9260

9261

9262

9263

<p>The locale for the string values being set</p>

9264

</div>

9265

9266

9267

</li>

9268

9269

</ul>

9270

</div>

9271

9272

9273

9274

9275

9276

</div>

9277

9278

9279

9280

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

9281

9282

9283

9284

9285

9286

9287

9288

<code>strings</code>

9289

9290

</li>

9291

9292

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

9293

</div>

9294

9295

9296

9297

9298

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

9299

</span>

9300

9301

9302

9303

9304

9305

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

9306

9307

9308

9309

9310

9311

9312

9313

9314

9315

9316

9317

<p>Inherited from

9318

<a href="../classes/Widget.html#method__strSetter">Widget</a>:

9319

9320

9321

9322

<a href="../files/widget_js_Widget.js.html#l1199"><code>widget/js/Widget.js:1199</code></a>

9323

9324

</p>

9325

9326

9327

9328

9329

9330

</div>

9331

9332

9333

<p>The default setter for the strings attribute. Merges partial sets

9334

into the full string set, to allow users to partial sets of strings</p>

9335

</div>

9336

9337

9338

9339

<h4>Parameters:</h4>

9340

9341

9342

9343

9344

9345

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

9346

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

9347

9348

9349

9350

9351

9352

9353

</div>

9354

9355

9356

</li>

9357

9358

</ul>

9359

</div>

9360

9361

9362

9363

9364

<h4>Returns:</h4>

9365

9366

9367

9368

9369

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

9370

9371

The full set of strings to set

9372

9373

</div>

9374

</div>

9375

9376

9377

9378

</div>

9379

9380

9381

9382

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

9383

9384

9385

9386

9387

9388

9389

9390

<code>attrs</code>

9391

9392

</li>

9393

9394

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

9395

</div>

9396

9397

9398

9399

9400

9401

9402

9403

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

9404

9405

9406

9407

9408

9409

9410

9411

9412

9413

9414

9415

<p>Inherited from

9416

<a href="../classes/Widget.html#method__syncAttrUI">Widget</a>:

9417

9418

9419

9420

<a href="../files/widget_js_Widget.js.html#l1173"><code>widget/js/Widget.js:1173</code></a>

9421

9422

</p>

9423

9424

9425

9426

9427

9428

</div>

9429

9430

9431

<p>Invokes the _uiSet=ATTR NAME> method for the list of attributes provided</p>

9432

</div>

9433

9434

9435

9436

<h4>Parameters:</h4>

9437

9438

9439

9440

9441

9442

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

9443

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

9444

9445

9446

9447

9448

9449

9450

</div>

9451

9452

9453

</li>

9454

9455

</ul>

9456

</div>

9457

9458

9459

9460

9461

9462

</div>

9463

9464

9465

9466

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

9467

9468

9469

9470

9471

9472

9473

9474

9475

9476

9477

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

9478

9479

9480

9481

9482

9483

9484

9485

9486

9487

9488

9489

<p>Inherited from

9490

<a href="../classes/Widget.html#method__syncUI">Widget</a>:

9491

9492

9493

9494

<a href="../files/widget_js_Widget.js.html#l951"><code>widget/js/Widget.js:951</code></a>

9495

9496

</p>

9497

9498

9499

9500

9501

9502

</div>

9503

9504

9505

<p>Updates the widget UI to reflect the attribute state.</p>

9506

</div>

9507

9508

9509

9510

9511

9512

9513

</div>

9514

9515

9516

9517

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

9518

9519

9520

9521

9522

9523

9524

9525

9526

9527

9528

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

9529

9530

9531

9532

9533

9534

9535

9536

9537

9538

9539

9540

<p>Inherited from

9541

<a href="../classes/Widget.html#method__syncUIChild">Widget</a>:

9542

9543

9544

9545

<a href="../files/widget-child_js_Widget-Child.js.html#l341"><code>widget-child/js/Widget-Child.js:341</code></a>

9546

9547

</p>

9548

9549

9550

9551

9552

9553

</div>

9554

9555

9556

<p>Synchronizes the UI to match the WidgetChild state.</p>

9557

9558

<p>

9559

This method is invoked after bindUI is invoked for the Widget class

9560

using YUI's aop infrastructure.

9561

</p>

9562

</div>

9563

9564

9565

9566

9567

9568

9569

</div>

9570

9571

9572

9573

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

9574

9575

9576

9577

9578

9579

9580

9581

9582

9583

9584

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

9585

9586

9587

9588

9589

9590

9591

9592

9593

9594

9595

9596

9597

<p>

9598

9599

Defined in

9600

9601

9602

9603

9604

<a href="../files/uploader_js_uploader-html5.js.html#l389"><code>uploader/js/uploader-html5.js:389</code></a>

9605

9606

</p>

9607

9608

9609

9610

9611

9612

</div>

9613

9614

9615

<p>Syncs the state of the <code>enabled</code> attribute between this class

9616

and the underlying button.</p>

9617

</div>

9618

9619

9620

9621

9622

9623

9624

</div>

9625

9626

9627

9628

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

9629

9630

9631

9632

9633

9634

9635

9636

<code>selected</code>

9637

9638

</li>

9639

9640

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

9641

</div>

9642

9643

9644

9645

9646

9647

9648

9649

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

9650

9651

9652

9653

9654

9655

9656

9657

9658

9659

9660

9661

<p>Inherited from

9662

<a href="../classes/Widget.html#method__uiSetChildSelected">Widget</a>:

9663

9664

9665

9666

<a href="../files/widget-child_js_Widget-Child.js.html#l305"><code>widget-child/js/Widget-Child.js:305</code></a>

9667

9668

</p>

9669

9670

9671

9672

9673

9674

</div>

9675

9676

9677

<p>Updates the UI to reflect the <code>selected</code> attribute value.</p>

9678

</div>

9679

9680

9681

9682

<h4>Parameters:</h4>

9683

9684

9685

9686

9687

9688

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

9689

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

9690

9691

9692

9693

9694

9695

<p>The selected value to be reflected in the UI.</p>

9696

</div>

9697

9698

9699

</li>

9700

9701

</ul>

9702

</div>

9703

9704

9705

9706

9707

9708

</div>

9709

9710

9711

9712

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

9713

9714

9715

9716

9717

9718

9719

9720

9721

9722

</li>

9723

9724

9725

9726

9727

9728

</li>

9729

9730

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

9731

</div>

9732

9733

9734

9735

9736

9737

9738

9739

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

9740

9741

9742

9743

9744

9745

9746

9747

9748

9749

9750

9751

<p>Inherited from

9752

<a href="../classes/Widget.html#method__uiSetDim">Widget</a>:

9753

9754

9755

9756

<a href="../files/widget_js_Widget.js.html#l984"><code>widget/js/Widget.js:984</code></a>

9757

9758

</p>

9759

9760

9761

9762

9763

9764

</div>

9765

9766

9767

9768

</div>

9769

9770

9771

9772

<h4>Parameters:</h4>

9773

9774

9775

9776

9777

9778

9779

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

9780

9781

9782

9783

9784

9785

<p>The dimension - "width" or "height"</p>

9786

</div>

9787

9788

9789

</li>

9790

9791

9792

9793

9794

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

9795

9796

9797

9798

9799

9800

<p>The value to set</p>

9801

</div>

9802

9803

9804

</li>

9805

9806

</ul>

9807

</div>

9808

9809

9810

9811

9812

9813

</div>

9814

9815

9816

9817

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

9818

9819

9820

9821

9822

9823

9824

9825

9826

9827

</li>

9828

9829

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

9830

</div>

9831

9832

9833

9834

9835

9836

9837

9838

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

9839

9840

9841

9842

9843

9844

9845

9846

9847

9848

9849

9850

<p>Inherited from

9851

<a href="../classes/Widget.html#method__uiSetDisabled">Widget</a>:

9852

9853

9854

9855

<a href="../files/widget_js_Widget.js.html#l1005"><code>widget/js/Widget.js:1005</code></a>

9856

9857

</p>

9858

9859

9860

9861

9862

9863

</div>

9864

9865

9866

<p>Sets the disabled state for the UI</p>

9867

</div>

9868

9869

9870

9871

<h4>Parameters:</h4>

9872

9873

9874

9875

9876

9877

9878

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

9879

9880

9881

9882

9883

9884

9885

</div>

9886

9887

9888

</li>

9889

9890

</ul>

9891

</div>

9892

9893

9894

9895

9896

9897

</div>

9898

9899

9900

9901

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

9902

9903

9904

9905

9906

9907

9908

9909

9910

9911

</li>

9912

9913

9914

9915

9916

9917

</li>

9918

9919

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

9920

</div>

9921

9922

9923

9924

9925

9926

9927

9928

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

9929

9930

9931

9932

9933

9934

9935

9936

9937

9938

9939

9940

<p>Inherited from

9941

<a href="../classes/Widget.html#method__uiSetFocused">Widget</a>:

9942

9943

9944

9945

<a href="../files/widget_js_Widget.js.html#l1016"><code>widget/js/Widget.js:1016</code></a>

9946

9947

</p>

9948

9949

9950

9951

9952

9953

</div>

9954

9955

9956

<p>Sets the focused state for the UI</p>

9957

</div>

9958

9959

9960

9961

<h4>Parameters:</h4>

9962

9963

9964

9965

9966

9967

9968

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

9969

9970

9971

9972

9973

9974

9975

</div>

9976

9977

9978

</li>

9979

9980

9981

9982

9983

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

9984

9985

9986

9987

9988

9989

<p>String representing the source that triggered an update to

9990

the UI.</p>

9991

</div>

9992

9993

9994

</li>

9995

9996

</ul>

9997

</div>

9998

9999

10000

10001

10002

10003

</div>

10004

10005

10006

10007

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

10008

10009

10010

10011

10012

10013

10014

10015

10016

10017

</li>

10018

10019

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

10020

</div>

10021

10022

10023

10024

10025

10026

10027

10028

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

10029

10030

10031

10032

10033

10034

10035

10036

10037

10038

10039

10040

<p>Inherited from

10041

<a href="../classes/Widget.html#method__uiSetHeight">Widget</a>:

10042

10043

10044

10045

<a href="../files/widget_js_Widget.js.html#l961"><code>widget/js/Widget.js:961</code></a>

10046

10047

</p>

10048

10049

10050

10051

10052

10053

</div>

10054

10055

10056

<p>Sets the height on the widget's bounding box element</p>

10057

</div>

10058

10059

10060

10061

<h4>Parameters:</h4>

10062

10063

10064

10065

10066

10067

10068

<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/Number" class="crosslink external" target="_blank">Number</a></span>

10069

10070

10071

10072

10073

10074

10075

</div>

10076

10077

10078

</li>

10079

10080

</ul>

10081

</div>

10082

10083

10084

10085

10086

10087

</div>

10088

10089

10090

10091

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

10092

10093

10094

10095

10096

10097

10098

10099

<code>Number</code>

10100

10101

</li>

10102

10103

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

10104

</div>

10105

10106

10107

10108

10109

10110

10111

10112

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

10113

10114

10115

10116

10117

10118

10119

10120

10121

10122

10123

10124

<p>Inherited from

10125

<a href="../classes/Widget.html#method__uiSetTabIndex">Widget</a>:

10126

10127

10128

10129

<a href="../files/widget_js_Widget.js.html#l1038"><code>widget/js/Widget.js:1038</code></a>

10130

10131

</p>

10132

10133

10134

10135

10136

10137

</div>

10138

10139

10140

<p>Set the tabIndex on the widget's rendered UI</p>

10141

</div>

10142

10143

10144

10145

<h4>Parameters:</h4>

10146

10147

10148

10149

10150

10151

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

10152

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

10153

10154

10155

10156

10157

10158

10159

</div>

10160

10161

10162

</li>

10163

10164

</ul>

10165

</div>

10166

10167

10168

10169

10170

10171

</div>

10172

10173

10174

10175

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

10176

10177

10178

10179

10180

10181

10182

10183

10184

10185

</li>

10186

10187

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

10188

</div>

10189

10190

10191

10192

10193

10194

10195

10196

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

10197

10198

10199

10200

10201

10202

10203

10204

10205

10206

10207

10208

<p>Inherited from

10209

<a href="../classes/Widget.html#method__uiSetVisible">Widget</a>:

10210

10211

10212

10213

<a href="../files/widget_js_Widget.js.html#l994"><code>widget/js/Widget.js:994</code></a>

10214

10215

</p>

10216

10217

10218

10219

10220

10221

</div>

10222

10223

10224

<p>Sets the visible state for the UI</p>

10225

</div>

10226

10227

10228

10229

<h4>Parameters:</h4>

10230

10231

10232

10233

10234

10235

10236

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

10237

10238

10239

10240

10241

10242

10243

</div>

10244

10245

10246

</li>

10247

10248

</ul>

10249

</div>

10250

10251

10252

10253

10254

10255

</div>

10256

10257

10258

10259

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

10260

10261

10262

10263

10264

10265

10266

10267

10268

10269

</li>

10270

10271

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

10272

</div>

10273

10274

10275

10276

10277

10278

10279

10280

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

10281

10282

10283

10284

10285

10286

10287

10288

10289

10290

10291

10292

<p>Inherited from

10293

<a href="../classes/Widget.html#method__uiSetWidth">Widget</a>:

10294

10295

10296

10297

<a href="../files/widget_js_Widget.js.html#l973"><code>widget/js/Widget.js:973</code></a>

10298

10299

</p>

10300

10301

10302

10303

10304

10305

</div>

10306

10307

10308

<p>Sets the width on the widget's bounding box element</p>

10309

</div>

10310

10311

10312

10313

<h4>Parameters:</h4>

10314

10315

10316

10317

10318

10319

10320

10321

10322

10323

10324

10325

10326

10327

</div>

10328

10329

10330

</li>

10331

10332

</ul>

10333

</div>

10334

10335

10336

10337

10338

10339

</div>

10340

10341

10342

10343

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

10344

10345

10346

10347

10348

10349

10350

10351

<code>expand</code>

10352

10353

</li>

10354

10355

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

10356

</div>

10357

10358

10359

10360

10361

10362

10363

10364

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

10365

10366

10367

10368

10369

10370

10371

10372

10373

10374

10375

10376

<p>Inherited from

10377

<a href="../classes/Widget.html#method__uiSizeCB">Widget</a>:

10378

10379

10380

10381

<a href="../files/widget_js_Widget.js.html#l702"><code>widget/js/Widget.js:702</code></a>

10382

10383

</p>

10384

10385

10386

10387

10388

10389

</div>

10390

10391

10392

10393

</div>

10394

10395

10396

10397

<h4>Parameters:</h4>

10398

10399

10400

10401

10402

10403

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

10404

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

10405

10406

10407

10408

10409

10410

10411

</div>

10412

10413

10414

</li>

10415

10416

</ul>

10417

</div>

10418

10419

10420

10421

10422

10423

</div>

10424

10425

10426

10427

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

10428

10429

10430

10431

10432

10433

10434

10435

10436

10437

10438

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

10439

10440

10441

10442

10443

10444

10445

10446

10447

10448

10449

10450

<p>Inherited from

10451

<a href="../classes/Widget.html#method__unbindDOM">Widget</a>:

10452

10453

10454

10455

<a href="../files/widget_js_Widget.js.html#l920"><code>widget/js/Widget.js:920</code></a>

10456

10457

</p>

10458

10459

10460

10461

10462

10463

</div>

10464

10465

10466

10467

</div>

10468

10469

10470

10471

10472

10473

10474

</div>

10475

10476

10477

10478

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

10479

10480

10481

10482

10483

10484

10485

10486

10487

10488

10489

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

10490

10491

10492

10493

10494

10495

10496

10497

10498

10499

10500

10501

<p>Inherited from

10502

<a href="../classes/Widget.html#method__unbindUI">Widget</a>:

10503

10504

10505

10506

<a href="../files/widget_js_Widget.js.html#l881"><code>widget/js/Widget.js:881</code></a>

10507

10508

</p>

10509

10510

10511

10512

10513

10514

</div>

10515

10516

10517

10518

</div>

10519

10520

10521

10522

10523

10524

10525

</div>

10526

10527

10528

10529

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

10530

10531

10532

10533

10534

10535

10536

10537

10538

10539

</li>

10540

10541

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

10542

</div>

10543

10544

10545

10546

10547

10548

10549

10550

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

10551

10552

10553

10554

10555

10556

10557

10558

10559

10560

10561

10562

10563

<p>

10564

10565

Defined in

10566

10567

10568

10569

10570

<a href="../files/uploader_js_uploader-html5.js.html#l410"><code>uploader/js/uploader-html5.js:410</code></a>

10571

10572

</p>

10573

10574

10575

10576

10577

10578

</div>

10579

10580

10581

<p>Adjusts the content of the <code>fileList</code> based on the results of file selection

10582

and the <code>appendNewFiles</code> attribute. If the <code>appendNewFiles</code> attribute is true,

10583

then selected files are appended to the existing list; otherwise, the list is

10584

cleared and populated with the newly selected files.</p>

10585

</div>

10586

10587

10588

10589

<h4>Parameters:</h4>

10590

10591

10592

10593

10594

10595

10596

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

10597

10598

10599

10600

10601

10602

<p>The file selection event received from the uploader.</p>

10603

</div>

10604

10605

10606

</li>

10607

10608

</ul>

10609

</div>

10610

10611

10612

10613

10614

10615

</div>

10616

10617

10618

10619

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

10620

10621

10622

10623

10624

10625

10626

10627

<code>event</code>

10628

10629

</li>

10630

10631

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

10632

</div>

10633

10634

10635

10636

10637

10638

10639

10640

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

10641

10642

10643

10644

10645

10646

10647

10648

10649

10650

10651

10652

10653

<p>

10654

10655

Defined in

10656

10657

10658

10659

10660

<a href="../files/uploader_js_uploader-html5.js.html#l438"><code>uploader/js/uploader-html5.js:438</code></a>

10661

10662

</p>

10663

10664

10665

10666

10667

10668

</div>

10669

10670

10671

<p>Handles and retransmits events fired by <code>Y.File</code> and <code>Y.Uploader.Queue</code>.</p>

10672

</div>

10673

10674

10675

10676

<h4>Parameters:</h4>

10677

10678

10679

10680

10681

10682

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

10683

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

10684

10685

10686

10687

10688

10689

<p>The event dispatched during the upload process.</p>

10690

</div>

10691

10692

10693

</li>

10694

10695

</ul>

10696

</div>

10697

10698

10699

10700

10701

10702

</div>

10703

10704

10705

10706

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

10707

10708

10709

10710

10711

10712

10713

10714

<code>tabIndex</code>

10715

10716

</li>

10717

10718

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

10719

</div>

10720

10721

10722

10723

10724

10725

10726

10727

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

10728

10729

10730

10731

10732

10733

10734

10735

10736

10737

10738

10739

<p>Inherited from

10740

<a href="../classes/Widget.html#method__validTabIndex">Widget</a>:

10741

10742

10743

10744

<a href="../files/widget_js_Widget.js.html#l1148"><code>widget/js/Widget.js:1148</code></a>

10745

10746

</p>

10747

10748

10749

10750

10751

10752

</div>

10753

10754

10755

10756

</div>

10757

10758

10759

10760

<h4>Parameters:</h4>

10761

10762

10763

10764

10765

10766

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

10767

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

10768

10769

10770

10771

10772

10773

10774

</div>

10775

10776

10777

</li>

10778

10779

</ul>

10780

</div>

10781

10782

10783

10784

10785

10786

</div>

10787

10788

10789

10790

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

10791

10792

10793

10794

10795

10796

10797

10798

10799

10800

</li>

10801

10802

10803

10804

<code>config</code>

10805

10806

</li>

10807

10808

10809

10810

10811

10812

</li>

10813

10814

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

10815

</div>

10816

10817

10818

10819

10820

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

10821

</span>

10822

10823

10824

10825

10826

10827

10828

10829

10830

10831

10832

10833

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

10834

10835

10836

10837

10838

10839

<p>Inherited from

10840

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

10841

10842

10843

10844

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

10845

10846

</p>

10847

10848

10849

10850

10851

10852

</div>

10853

10854

10855

<p>

10856

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

10857

</p>

10858

10859

<p>

10860

The config argument object supports the following properties:

10861

</p>

10862

10863

<dl>

10864

<dt>value <Any></dt>

10865

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

10866

10867

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

10868

<dd>

10869

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

10870

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

10871

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

10872

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

10873

case the value property is used.</p>

10874

10875

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

10876

</dd>

10877

10878

<dt>readOnly <boolean></dt>

10879

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

10880

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

10881

10882

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

10883

<dd>

10884

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

10885

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

10886

constructor configuration arguments, or by invoking set.

10887

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

10888

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

10889

</dd>

10890

10891

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

10892

<dd>

10893

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

10894

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

10895

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

10896

the value from being stored.

10897

</p>

10898

10899

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

10900

</dd>

10901

10902

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

10903

<dd>

10904

<p>

10905

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

10906

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

10907

invoke get.

10908

</p>

10909

10910

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

10911

</dd>

10912

10913

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

10914

<dd>

10915

<p>

10916

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

10917

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

10918

</p>

10919

10920

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

10921

</dd>

10922

10923

<dt>lazyAdd <boolean></dt>

10924

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

10925

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

10926

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

10927

10928

</dl>

10929

10930

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

10931

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

10932

10933

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

10934

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

10935

</div>

10936

10937

10938

10939

<h4>Parameters:</h4>

10940

10941

10942

10943

10944

10945

10946

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

10947

10948

10949

10950

10951

10952

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

10953

</div>

10954

10955

10956

</li>

10957

10958

10959

10960

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

10961

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

10962

10963

10964

10965

10966

10967

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

10968

10969

<p>

10970

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

10971

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

10972

</p>

10973

</div>

10974

10975

10976

</li>

10977

10978

10979

10980

10981

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

10982

10983

10984

10985

10986

10987

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

10988

</div>

10989

10990

10991

</li>

10992

10993

</ul>

10994

</div>

10995

10996

10997

10998

10999

<h4>Returns:</h4>

11000

11001

11002

11003

11004

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

11005

11006

A reference to the host object.

11007

11008

</div>

11009

</div>

11010

11011

11012

11013

</div>

11014

11015

11016

11017

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

11018

11019

11020

11021

11022

11023

11024

11025

11026

11027

</li>

11028

11029

11030

11031

<code>values</code>

11032

11033

</li>

11034

11035

11036

11037

11038

11039

</li>

11040

11041

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

11042

</div>

11043

11044

11045

11046

11047

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

11048

</span>

11049

11050

11051

11052

11053

11054

11055

11056

11057

11058

11059

11060

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

11061

11062

11063

11064

11065

11066

<p>Inherited from

11067

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

11068

11069

11070

11071

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

11072

11073

</p>

11074

11075

11076

11077

11078

11079

</div>

11080

11081

11082

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

11083

11084

<p>

11085

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

11086

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

11087

</p>

11088

</div>

11089

11090

11091

11092

<h4>Parameters:</h4>

11093

11094

11095

11096

11097

11098

11099

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

11100

11101

11102

11103

11104

11105

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

11106

</div>

11107

11108

11109

</li>

11110

11111

11112

11113

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

11114

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

11115

11116

11117

11118

11119

11120

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

11121

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

11122

</div>

11123

11124

11125

</li>

11126

11127

11128

11129

11130

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

11131

11132

11133

11134

11135

11136

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

11137

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

11138

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

11139

</div>

11140

11141

11142

</li>

11143

11144

</ul>

11145

</div>

11146

11147

11148

11149

11150

<h4>Returns:</h4>

11151

11152

11153

11154

11155

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

11156

11157

A reference to the host object.

11158

11159

</div>

11160

</div>

11161

11162

11163

11164

</div>

11165

11166

11167

11168

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

11169

11170

11171

11172

11173

11174

11175

11176

11177

11178

</li>

11179

11180

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

11181

</div>

11182

11183

11184

11185

11186

11187

11188

11189

11190

11191

11192

11193

11194

11195

11196

11197

11198

11199

<p>Inherited from

11200

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

11201

11202

11203

11204

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

11205

11206

</p>

11207

11208

11209

11210

11211

11212

</div>

11213

11214

11215

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

11216

is determined by the order registered. Multiple targets can

11217

be specified.</p>

11218

11219

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

11220

11221

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

11222

</div>

11223

11224

11225

11226

<h4>Parameters:</h4>

11227

11228

11229

11230

11231

11232

11233

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

11234

11235

11236

11237

11238

11239

<p>the target to add</p>

11240

</div>

11241

11242

11243

</li>

11244

11245

</ul>

11246

</div>

11247

11248

11249

11250

11251

11252

</div>

11253

11254

11255

11256

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

11257

11258

11259

11260

11261

11262

11263

11264

11265

11266

</li>

11267

11268

11269

11270

11271

11272

</li>

11273

11274

11275

11276

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

11277

11278

</li>

11279

11280

11281

11282

11283

11284

</li>

11285

11286

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

11287

</div>

11288

11289

11290

11291

11292

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

11293

</span>

11294

11295

11296

11297

11298

11299

11300

11301

11302

11303

11304

11305

11306

11307

11308

11309

<p>Inherited from

11310

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

11311

11312

11313

11314

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

11315

11316

</p>

11317

11318

11319

11320

11321

11322

</div>

11323

11324

11325

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

11326

supplied callback will execute after any listeners add

11327

via the subscribe method, and after the default function,

11328

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

11329

</div>

11330

11331

11332

11333

<h4>Parameters:</h4>

11334

11335

11336

11337

11338

11339

11340

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

11341

11342

11343

11344

11345

11346

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

11347

</div>

11348

11349

11350

</li>

11351

11352

11353

11354

11355

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

11356

11357

11358

11359

11360

11361

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

11362

</div>

11363

11364

11365

</li>

11366

11367

11368

11369

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

11370

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

11371

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

11372

11373

11374

11375

11376

11377

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

11378

</div>

11379

11380

11381

</li>

11382

11383

11384

11385

11386

11387

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

11388

11389

11390

11391

11392

11393

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

11394

</div>

11395

11396

11397

</li>

11398

11399

</ul>

11400

</div>

11401

11402

11403

11404

11405

<h4>Returns:</h4>

11406

11407

11408

11409

11410

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

11411

11412

A subscription handle capable of detaching the

11413

subscription

11414

11415

</div>

11416

</div>

11417

11418

11419

11420

</div>

11421

11422

11423

11424

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

11425

11426

11427

11428

11429

11430

11431

11432

<code>depth</code>

11433

11434

</li>

11435

11436

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

11437

</div>

11438

11439

11440

11441

11442

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

11443

</span>

11444

11445

11446

11447

11448

11449

11450

11451

11452

11453

11454

11455

11456

11457

11458

11459

<p>Inherited from

11460

<a href="../classes/Widget.html#method_ancestor">Widget</a>:

11461

11462

11463

11464

<a href="../files/widget-child_js_Widget-Child.js.html#l279"><code>widget-child/js/Widget-Child.js:279</code></a>

11465

11466

</p>

11467

11468

11469

11470

11471

11472

</div>

11473

11474

11475

<p>Returns the Widget instance at the specified depth.</p>

11476

</div>

11477

11478

11479

11480

<h4>Parameters:</h4>

11481

11482

11483

11484

11485

11486

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

11487

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

11488

11489

11490

11491

11492

11493

<p>Number representing the depth of the ancestor.</p>

11494

</div>

11495

11496

11497

</li>

11498

11499

</ul>

11500

</div>

11501

11502

11503

11504

11505

<h4>Returns:</h4>

11506

11507

11508

11509

11510

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

11511

11512

Widget instance.

11513

11514

</div>

11515

</div>

11516

11517

11518

11519

</div>

11520

11521

11522

11523

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

11524

11525

11526

11527

11528

11529

11530

11531

11532

11533

</li>

11534

11535

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

11536

</div>

11537

11538

11539

11540

11541

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

11542

</span>

11543

11544

11545

11546

11547

11548

11549

11550

11551

11552

11553

11554

11555

11556

11557

11558

<p>Inherited from

11559

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

11560

11561

11562

11563

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

11564

11565

</p>

11566

11567

11568

11569

11570

11571

</div>

11572

11573

11574

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

11575

</div>

11576

11577

11578

11579

<h4>Parameters:</h4>

11580

11581

11582

11583

11584

11585

11586

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

11587

11588

11589

11590

11591

11592

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

11593

</div>

11594

11595

11596

</li>

11597

11598

</ul>

11599

</div>

11600

11601

11602

11603

11604

<h4>Returns:</h4>

11605

11606

11607

11608

11609

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

11610

11611

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.

11612

11613

</div>

11614

</div>

11615

11616

11617

11618

</div>

11619

11620

11621

11622

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

11623

11624

11625

11626

11627

11628

11629

11630

11631

</span>

11632

11633

11634

11635

11636

11637

11638

11639

11640

11641

11642

11643

11644

11645

11646

11647

<p>Inherited from

11648

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

11649

11650

11651

11652

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

11653

11654

</p>

11655

11656

11657

11658

11659

11660

</div>

11661

11662

11663

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

11664

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

11665

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

11666

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

11667

11668

<p>For DOM and custom events:

11669

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

11670

11671

<p>For methods:

11672

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

11673

</div>

11674

11675

11676

11677

11678

11679

<h4>Returns:</h4>

11680

11681

11682

11683

11684

detach handle

11685

11686

</div>

11687

</div>

11688

11689

11690

11691

</div>

11692

11693

11694

11695

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

11696

11697

11698

11699

11700

11701

11702

11703

11704

11705

11706

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

11707

11708

11709

11710

11711

11712

11713

11714

11715

11716

11717

<p>Inherited from

11718

11719

Widget

11720

</a>

11721

11722

but overwritten in

11723

11724

11725

11726

<a href="../files/uploader_js_uploader-html5.js.html#l251"><code>uploader/js/uploader-html5.js:251</code></a>

11727

11728

</p>

11729

11730

11731

11732

11733

11734

</div>

11735

11736

11737

<p>Binds to the UploaderHTML5 UI and subscribes to the necessary events.</p>

11738

</div>

11739

11740

11741

11742

11743

11744

11745

</div>

11746

11747

11748

11749

11750

11751

11752

11753

11754

11755

11756

11757

11758

11759

11760

11761

11762

11763

11764

11765

11766

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

11767

11768

11769

11770

11771

11772

<p>Inherited from

11773

<a href="../classes/Widget.html#method_blur">Widget</a>:

11774

11775

11776

11777

<a href="../files/widget_js_Widget.js.html#l674"><code>widget/js/Widget.js:674</code></a>

11778

11779

</p>

11780

11781

11782

11783

11784

11785

</div>

11786

11787

11788

<p>Causes the Widget to lose focus by setting the "focused" attribute

11789

to "false"</p>

11790

</div>

11791

11792

11793

11794

11795

11796

11797

</div>

11798

11799

11800

11801

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

11802

11803

11804

11805

11806

11807

11808

11809

11810

11811

</li>

11812

11813

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

11814

</div>

11815

11816

11817

11818

11819

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

11820

</span>

11821

11822

11823

11824

11825

11826

11827

11828

11829

11830

11831

11832

11833

11834

11835

11836

<p>Inherited from

11837

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

11838

11839

11840

11841

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

11842

11843

</p>

11844

11845

11846

11847

11848

11849

</div>

11850

11851

11852

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

11853

</div>

11854

11855

11856

11857

<h4>Parameters:</h4>

11858

11859

11860

11861

11862

11863

11864

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

11865

11866

11867

11868

11869

11870

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

11871

</div>

11872

11873

11874

</li>

11875

11876

</ul>

11877

</div>

11878

11879

11880

11881

11882

<h4>Returns:</h4>

11883

11884

11885

11886

11887

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

11888

11889

the aggregated return value from Event.Custom.fire

11890

11891

</div>

11892

</div>

11893

11894

11895

11896

</div>

11897

11898

11899

11900

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

11901

11902

11903

11904

11905

11906

11907

11908

<code>destroyAllNodes</code>

11909

11910

</li>

11911

11912

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

11913

</div>

11914

11915

11916

11917

11918

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

11919

</span>

11920

11921

11922

11923

11924

11925

11926

11927

11928

11929

11930

11931

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

11932

11933

11934

11935

11936

<p>Inherited from

11937

11938

BaseCore

11939

</a>

11940

11941

but overwritten in

11942

11943

11944

11945

<a href="../files/widget_js_Widget.js.html#l455"><code>widget/js/Widget.js:455</code></a>

11946

11947

</p>

11948

11949

11950

11951

11952

11953

</div>

11954

11955

11956

<p>

11957

Destroy lifecycle method. Fires the destroy

11958

event, prior to invoking destructors for the

11959

class hierarchy.

11960

11961

Overrides Base's implementation, to support arguments to destroy

11962

</p>

11963

11964

<p>

11965

Subscribers to the destroy

11966

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

11967

from proceeding.

11968

</p>

11969

</div>

11970

11971

11972

11973

<h4>Parameters:</h4>

11974

11975

11976

11977

11978

11979

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

11980

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

11981

11982

11983

11984

11985

11986

<p>If true, all nodes contained within the Widget are removed and destroyed. Defaults to false due to potentially high run-time cost.</p>

11987

</div>

11988

11989

11990

</li>

11991

11992

</ul>

11993

</div>

11994

11995

11996

11997

11998

<h4>Returns:</h4>

11999

12000

12001

12002

12003

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

12004

12005

A reference to this object

12006

12007

</div>

12008

</div>

12009

12010

12011

12012

</div>

12013

12014

12015

12016

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

12017

12018

12019

12020

12021

12022

12023

12024

12025

12026

12027

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

12028

12029

12030

12031

12032

12033

12034

12035

12036

12037

12038

12039

<p>Inherited from

12040

<a href="../classes/Widget.html#method_destructor">Widget</a>:

12041

12042

12043

12044

<a href="../files/widget_js_Widget.js.html#l430"><code>widget/js/Widget.js:430</code></a>

12045

12046

</p>

12047

12048

12049

12050

12051

12052

</div>

12053

12054

12055

<p>Destructor lifecycle implementation for the Widget class. Purges events attached

12056

to the bounding box and content box, removes them from the DOM and removes

12057

the Widget from the list of registered widgets.</p>

12058

</div>

12059

12060

12061

12062

12063

12064

12065

</div>

12066

12067

12068

12069

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

12070

12071

12072

12073

12074

12075

12076

12077

12078

12079

</li>

12080

12081

12082

12083

12084

12085

</li>

12086

12087

12088

12089

<code>context</code>

12090

12091

</li>

12092

12093

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

12094

</div>

12095

12096

12097

12098

12099

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

12100

</span>

12101

12102

12103

12104

12105

12106

12107

12108

12109

12110

12111

12112

12113

12114

12115

12116

<p>Inherited from

12117

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

12118

12119

12120

12121

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

12122

12123

</p>

12124

12125

12126

12127

12128

12129

</div>

12130

12131

12132

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

12133

</div>

12134

12135

12136

12137

<h4>Parameters:</h4>

12138

12139

12140

12141

12142

12143

12144

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

12145

12146

12147

12148

12149

12150

<p>Either the handle to the subscriber or the

12151

type of event. If the type

12152

is not specified, it will attempt to remove

12153

the listener from all hosted events.</p>

12154

</div>

12155

12156

12157

</li>

12158

12159

12160

12161

12162

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

12163

12164

12165

12166

12167

12168

<p>The subscribed function to unsubscribe, if not

12169

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

12170

</div>

12171

12172

12173

</li>

12174

12175

12176

12177

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

12178

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

12179

12180

12181

12182

12183

12184

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

12185

optional, but if supplied will be used to

12186

disambiguate multiple listeners that are the same

12187

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

12188

that lives on the prototype)</p>

12189

</div>

12190

12191

12192

</li>

12193

12194

</ul>

12195

</div>

12196

12197

12198

12199

12200

<h4>Returns:</h4>

12201

12202

12203

12204

12205

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

12206

12207

the host

12208

12209

</div>

12210

</div>

12211

12212

12213

12214

</div>

12215

12216

12217

12218

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

12219

12220

12221

12222

12223

12224

12225

12226

12227

12228

</li>

12229

12230

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

12231

</div>

12232

12233

12234

12235

12236

12237

12238

12239

12240

12241

12242

12243

12244

12245

12246

12247

12248

12249

<p>Inherited from

12250

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

12251

12252

12253

12254

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

12255

12256

</p>

12257

12258

12259

12260

12261

12262

</div>

12263

12264

12265

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

12266

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

12267

be removed.</p>

12268

</div>

12269

12270

12271

12272

<h4>Parameters:</h4>

12273

12274

12275

12276

12277

12278

12279

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

12280

12281

12282

12283

12284

12285

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

12286

</div>

12287

12288

12289

</li>

12290

12291

</ul>

12292

</div>

12293

12294

12295

12296

12297

12298

</div>

12299

12300

12301

12302

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

12303

12304

12305

12306

12307

12308

12309

12310

12311

12312

12313

12314

12315

12316

12317

12318

12319

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

12320

12321

12322

12323

12324

12325

<p>Inherited from

12326

<a href="../classes/Widget.html#method_disable">Widget</a>:

12327

12328

12329

12330

<a href="../files/widget_js_Widget.js.html#l693"><code>widget/js/Widget.js:693</code></a>

12331

12332

</p>

12333

12334

12335

12336

12337

12338

</div>

12339

12340

12341

<p>Set the Widget's "disabled" attribute to "true".</p>

12342

</div>

12343

12344

12345

12346

12347

12348

12349

</div>

12350

12351

12352

12353

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

12354

12355

12356

12357

12358

12359

12360

12361

12362

12363

12364

12365

12366

12367

12368

12369

12370

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

12371

12372

12373

12374

12375

12376

<p>Inherited from

12377

<a href="../classes/Widget.html#method_enable">Widget</a>:

12378

12379

12380

12381

<a href="../files/widget_js_Widget.js.html#l684"><code>widget/js/Widget.js:684</code></a>

12382

12383

</p>

12384

12385

12386

12387

12388

12389

</div>

12390

12391

12392

<p>Set the Widget's "disabled" attribute to "false".</p>

12393

</div>

12394

12395

12396

12397

12398

12399

12400

</div>

12401

12402

12403

12404

12405

12406

12407

12408

12409

12410

12411

12412

12413

12414

</li>

12415

12416

12417

12418

<code>arguments</code>

12419

12420

</li>

12421

12422

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

12423

</div>

12424

12425

12426

12427

12428

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

12429

</span>

12430

12431

12432

12433

12434

12435

12436

12437

12438

12439

12440

12441

12442

12443

12444

12445

<p>Inherited from

12446

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

12447

12448

12449

12450

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

12451

12452

</p>

12453

12454

12455

12456

12457

12458

</div>

12459

12460

12461

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

12462

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

12463

following parameters.</p>

12464

12465

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

12466

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

12467

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

12468

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

12469

be published on this object first.</p>

12470

12471

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

12472

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

12473

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

12474

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

12475

in place of the original object.</p>

12476

</div>

12477

12478

12479

12480

<h4>Parameters:</h4>

12481

12482

12483

12484

12485

12486

12487

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

12488

12489

12490

12491

12492

12493

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

12494

a 'type' property.</p>

12495

</div>

12496

12497

12498

</li>

12499

12500

12501

12502

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

12503

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

12504

12505

12506

12507

12508

12509

<p>an arbitrary set of parameters to pass to

12510

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

12511

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

12512

parameter after the properties the object literal contains are copied to

12513

the event facade.</p>

12514

</div>

12515

12516

12517

</li>

12518

12519

</ul>

12520

</div>

12521

12522

12523

12524

12525

<h4>Returns:</h4>

12526

12527

12528

12529

12530

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

12531

12532

the event host

12533

12534

</div>

12535

</div>

12536

12537

12538

12539

</div>

12540

12541

12542

12543

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

12544

12545

12546

12547

12548

12549

12550

12551

12552

12553

12554

12555

12556

12557

12558

12559

12560

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

12561

12562

12563

12564

12565

12566

<p>Inherited from

12567

<a href="../classes/Widget.html#method_focus">Widget</a>:

12568

12569

12570

12571

<a href="../files/widget_js_Widget.js.html#l664"><code>widget/js/Widget.js:664</code></a>

12572

12573

</p>

12574

12575

12576

12577

12578

12579

</div>

12580

12581

12582

<p>Causes the Widget to receive the focus by setting the "focused"

12583

attribute to "true".</p>

12584

</div>

12585

12586

12587

12588

12589

12590

12591

</div>

12592

12593

12594

12595

12596

12597

12598

12599

12600

12601

12602

12603

12604

12605

</li>

12606

12607

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

12608

</div>

12609

12610

12611

12612

12613

12614

</span>

12615

12616

12617

12618

12619

12620

12621

12622

12623

12624

12625

12626

12627

12628

12629

12630

<p>Inherited from

12631

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

12632

12633

12634

12635

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

12636

12637

</p>

12638

12639

12640

12641

12642

12643

</div>

12644

12645

12646

<p>Returns the current value of the attribute. If the attribute

12647

has been configured with a 'getter' function, this method will delegate

12648

to the 'getter' to obtain the value of the attribute.</p>

12649

</div>

12650

12651

12652

12653

<h4>Parameters:</h4>

12654

12655

12656

12657

12658

12659

12660

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

12661

12662

12663

12664

12665

12666

<p>The name of the attribute. If the value of the attribute is an Object,

12667

dot notation can be used to obtain the value of a property of the object (e.g. <code>get("x.y.z")</code>)</p>

12668

</div>

12669

12670

12671

</li>

12672

12673

</ul>

12674

</div>

12675

12676

12677

12678

12679

<h4>Returns:</h4>

12680

12681

12682

12683

12684

<span class="type">Any</span>:

12685

12686

The value of the attribute

12687

12688

</div>

12689

</div>

12690

12691

12692

12693

</div>

12694

12695

12696

12697

<h3 class="name"><code>getAttrs</code></h3>

12698

12699

12700

12701

12702

12703

12704

12705

<code>attrs</code>

12706

12707

</li>

12708

12709

</ul><span class="paren">)</span>

12710

</div>

12711

12712

12713

12714

12715

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>

12716

</span>

12717

12718

12719

12720

12721

12722

12723

12724

12725

12726

12727

12728

12729

12730

12731

12732

<p>Inherited from

12733

<a href="../classes/AttributeCore.html#method_getAttrs">AttributeCore</a>:

12734

12735

12736

12737

<a href="../files/attribute_js_AttributeCore.js.html#l665"><code>attribute/js/AttributeCore.js:665</code></a>

12738

12739

</p>

12740

12741

12742

12743

12744

12745

</div>

12746

12747

12748

<p>Gets multiple attribute values.</p>

12749

</div>

12750

12751

12752

12753

<h4>Parameters:</h4>

12754

12755

12756

12757

12758

12759

<code class="param-name">attrs</code>

12760

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Array" class="crosslink external" target="_blank">Array</a> | boolean</span>

12761

12762

12763

12764

12765

12766

<p>Optional. An array of attribute names. If omitted, all attribute values are

12767

returned. If set to true, all attributes modified from their initial values are returned.</p>

12768

</div>

12769

12770

12771

</li>

12772

12773

</ul>

12774

</div>

12775

12776

12777

12778

12779

<h4>Returns:</h4>

12780

12781

12782

12783

12784

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>:

12785

12786

An object with attribute name/value pairs.

12787

12788

</div>

12789

</div>

12790

12791

12792

12793

</div>

12794

12795

12796

12797

<h3 class="name"><code>getClassName</code></h3>

12798

12799

12800

12801

12802

12803

12804

12805

12806

12807

</li>

12808

12809

</ul><span class="paren">)</span>

12810

</div>

12811

12812

12813

12814

12815

12816

12817

12818

12819

12820

12821

12822

12823

12824

12825

12826

12827

<p>Inherited from

12828

12829

Widget

12830

</a>

12831

12832

but overwritten in

12833

12834

12835

12836

<a href="../files/widget_js_Widget.js.html#l309"><code>widget/js/Widget.js:309</code></a>

12837

12838

</p>

12839

12840

12841

12842

12843

12844

</div>

12845

12846

12847

<p>Generate a standard prefixed classname for the Widget, prefixed by the default prefix defined

12848

by the <code>Y.config.classNamePrefix</code> attribute used by <code>ClassNameManager</code> and

12849

<code>Widget.NAME.toLowerCase()</code> (e.g. "yui-widget-xxxxx-yyyyy", based on default values for

12850

the prefix and widget class name).</p>

12851

12852

<p>

12853

The instance based version of this method can be used to generate standard prefixed classnames,

12854

based on the instances NAME, as opposed to Widget.NAME. This method should be used when you

12855

need to use a constant class name across different types instances.

12856

</p>

12857

</div>

12858

12859

12860

12861

<h4>Parameters:</h4>

12862

12863

12864

12865

12866

12867

12868

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String*</a></span>

12869

12870

12871

12872

<span class="flag multiple" title="This argument may occur one or more times.">multiple</span>

12873

12874

12875

12876

<p>0..n strings which should be concatenated, using the default separator defined by ClassNameManager, to create the class name</p>

12877

</div>

12878

12879

12880

</li>

12881

12882

</ul>

12883

</div>

12884

12885

12886

12887

12888

12889

</div>

12890

12891

12892

12893

<h3 class="name"><code>getDefaultLocale</code></h3>

12894

12895

12896

12897

12898

12899

12900

12901

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

12902

</span>

12903

12904

12905

12906

12907

12908

12909

12910

12911

12912

12913

12914

12915

12916

12917

12918

<p>Inherited from

12919

<a href="../classes/Widget.html#method_getDefaultLocale">Widget</a>:

12920

12921

12922

12923

<a href="../files/widget_js_WidgetLocale.js.html#l150"><code>widget/js/WidgetLocale.js:150</code></a>

12924

12925

</p>

12926

12927

12928

12929

12930

12931

</div>

12932

12933

12934

<p>Returns the default locale for the widget (the locale value defined by the

12935

widget class, or provided by the user during construction).</p>

12936

</div>

12937

12938

12939

12940

12941

12942

<h4>Returns:</h4>

12943

12944

12945

12946

12947

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>:

12948

12949

The default locale for the widget

12950

12951

</div>

12952

</div>

12953

12954

12955

12956

</div>

12957

12958

12959

12960

<h3 class="name"><code>getEvent</code></h3>

12961

12962

12963

12964

12965

12966

12967

12968

12969

12970

</li>

12971

12972

12973

12974

<code>prefixed</code>

12975

12976

</li>

12977

12978

</ul><span class="paren">)</span>

12979

</div>

12980

12981

12982

12983

12984

<span class="type"><a href="../classes/CustomEvent.html" class="crosslink">CustomEvent</a></span>

12985

</span>

12986

12987

12988

12989

12990

12991

12992

12993

12994

12995

12996

12997

12998

12999

13000

13001

<p>Inherited from

13002

<a href="../classes/EventTarget.html#method_getEvent">EventTarget</a>:

13003

13004

13005

13006

<a href="../files/event-custom_js_event-target.js.html#l712"><code>event-custom/js/event-target.js:712</code></a>

13007

13008

</p>

13009

13010

13011

13012

13013

13014

</div>

13015

13016

13017

<p>Returns the custom event of the provided type has been created, a

13018

falsy value otherwise</p>

13019

</div>

13020

13021

13022

13023

<h4>Parameters:</h4>

13024

13025

13026

13027

13028

13029

13030

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

13031

13032

13033

13034

13035

13036

<p>the type, or name of the event</p>

13037

</div>

13038

13039

13040

</li>

13041

13042

13043

13044

<code class="param-name">prefixed</code>

13045

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

13046

13047

13048

13049

13050

13051

<p>if true, the type is prefixed already</p>

13052

</div>

13053

13054

13055

</li>

13056

13057

</ul>

13058

</div>

13059

13060

13061

13062

13063

<h4>Returns:</h4>

13064

13065

13066

13067

13068

<span class="type"><a href="../classes/CustomEvent.html" class="crosslink">CustomEvent</a></span>:

13069

13070

the custom event or null

13071

13072

</div>

13073

</div>

13074

13075

13076

13077

</div>

13078

13079

13080

13081

<h3 class="name"><code>getSkinName</code></h3>

13082

13083

13084

13085

13086

13087

13088

13089

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

13090

</span>

13091

13092

13093

13094

13095

13096

13097

13098

13099

13100

13101

13102

13103

13104

13105

13106

<p>Inherited from

13107

<a href="../classes/Widget.html#method_getSkinName">Widget</a>:

13108

13109

13110

13111

<a href="../files/widget_js_WidgetSkin.js.html#l13"><code>widget/js/WidgetSkin.js:13</code></a>

13112

13113

</p>

13114

13115

13116

13117

13118

13119

</div>

13120

13121

13122

<p>Returns the name of the skin that's currently applied to the widget.

13123

This is only really useful after the widget's DOM structure is in the

13124

document, either by render or by progressive enhancement. Searches up

13125

the Widget's ancestor axis for a class yui3-skin-(name), and returns the

13126

(name) portion. Otherwise, returns null.</p>

13127

</div>

13128

13129

13130

13131

13132

13133

<h4>Returns:</h4>

13134

13135

13136

13137

13138

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>:

13139

13140

the name of the skin, or null (yui3-skin-sam => sam)

13141

13142

</div>

13143

</div>

13144

13145

13146

13147

</div>

13148

13149

13150

13151

<h3 class="name"><code>getString</code></h3>

13152

13153

13154

13155

13156

13157

13158

13159

13160

13161

</li>

13162

13163

</ul><span class="paren">)</span>

13164

</div>

13165

13166

13167

13168

13169

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

13170

</span>

13171

13172

13173

13174

<span class="flag deprecated" title="Used by deprecated WidgetLocale implementations.">deprecated</span>

13175

13176

13177

13178

13179

13180

13181

13182

13183

13184

13185

13186

13187

<p>Inherited from

13188

13189

Widget

13190

</a>

13191

13192

but overwritten in

13193

13194

13195

13196

<a href="../files/widget_js_Widget.js.html#l1212"><code>widget/js/Widget.js:1212</code></a>

13197

13198

</p>

13199

13200

13201

13202

<p>Deprecated: Used by deprecated WidgetLocale implementations.</p>

13203

13204

13205

13206

</div>

13207

13208

13209

<p>Helper method to get a specific string value</p>

13210

</div>

13211

13212

13213

13214

<h4>Parameters:</h4>

13215

13216

13217

13218

13219

13220

13221

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

13222

13223

13224

13225

13226

13227

13228

</div>

13229

13230

13231

</li>

13232

13233

</ul>

13234

</div>

13235

13236

13237

13238

13239

<h4>Returns:</h4>

13240

13241

13242

13243

13244

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>:

13245

13246

The string

13247

13248

</div>

13249

</div>

13250

13251

13252

13253

</div>

13254

13255

13256

13257

<h3 class="name"><code>getStrings</code></h3>

13258

13259

13260

13261

13262

13263

13264

13265

13266

13267

</li>

13268

13269

</ul><span class="paren">)</span>

13270

</div>

13271

13272

13273

13274

13275

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

13276

</span>

13277

13278

13279

13280

<span class="flag deprecated" title="Used by deprecated WidgetLocale implementations.">deprecated</span>

13281

13282

13283

13284

13285

13286

13287

13288

13289

13290

13291

13292

13293

<p>Inherited from

13294

13295

Widget

13296

</a>

13297

13298

but overwritten in

13299

13300

13301

13302

<a href="../files/widget_js_Widget.js.html#l1224"><code>widget/js/Widget.js:1224</code></a>

13303

13304

</p>

13305

13306

13307

13308

<p>Deprecated: Used by deprecated WidgetLocale implementations.</p>

13309

13310

13311

13312

</div>

13313

13314

13315

<p>Helper method to get the complete set of strings for the widget</p>

13316

</div>

13317

13318

13319

13320

<h4>Parameters:</h4>

13321

13322

13323

13324

13325

13326

13327

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

13328

13329

13330

13331

13332

13333

13334

</div>

13335

13336

13337

</li>

13338

13339

</ul>

13340

</div>

13341

13342

13343

13344

13345

<h4>Returns:</h4>

13346

13347

13348

13349

13350

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>:

13351

13352

The strings

13353

13354

</div>

13355

</div>

13356

13357

13358

13359

</div>

13360

13361

13362

13363

<h3 class="name"><code>getTargets</code></h3>

13364

13365

13366

13367

13368

13369

13370

13371

13372

</span>

13373

13374

13375

13376

13377

13378

13379

13380

13381

13382

13383

13384

13385

13386

13387

13388

<p>Inherited from

13389

<a href="../classes/EventTarget.html#method_getTargets">EventTarget</a>:

13390

13391

13392

13393

<a href="../files/event-custom_js_event-facade.js.html#l400"><code>event-custom/js/event-facade.js:400</code></a>

13394

13395

</p>

13396

13397

13398

13399

13400

13401

</div>

13402

13403

13404

<p>Returns an array of bubble targets for this object.</p>

13405

</div>

13406

13407

13408

13409

13410

13411

<h4>Returns:</h4>

13412

13413

13414

13415

13416

EventTarget[]

13417

13418

</div>

13419

</div>

13420

13421

13422

13423

</div>

13424

13425

13426

13427

13428

13429

13430

13431

13432

13433

13434

13435

13436

13437

13438

13439

13440

13441

13442

13443

13444

<span class="flag chainable">chainable</span>

13445

13446

13447

13448

13449

13450

<p>Inherited from

13451

<a href="../classes/Widget.html#method_hide">Widget</a>:

13452

13453

13454

13455

<a href="../files/widget_js_Widget.js.html#l646"><code>widget/js/Widget.js:646</code></a>

13456

13457

</p>

13458

13459

13460

13461

13462

13463

</div>

13464

13465

13466

<p>Hides the Widget by setting the "visible" attribute to "false".</p>

13467

</div>

13468

13469

13470

13471

13472

13473

13474

</div>

13475

13476

13477

13478

13479

13480

13481

13482

13483

13484

13485

13486

<code>config</code>

13487

13488

</li>

13489

13490

</ul><span class="paren">)</span>

13491

</div>

13492

13493

13494

13495

13496

13497

</span>

13498

13499

13500

13501

13502

13503

13504

13505

13506

13507

13508

13509

<span class="flag chainable">chainable</span>

13510

13511

13512

13513

13514

<p>Inherited from

13515

13516

BaseCore

13517

</a>

13518

13519

but overwritten in

13520

13521

13522

13523

13524

13525

</p>

13526

13527

13528

13529

13530

13531

</div>

13532

13533

13534

<p>Init lifecycle method, invoked during construction.

13535

Fires the init event prior to setting up attributes and

13536

invoking initializers for the class hierarchy.</p>

13537

</div>

13538

13539

13540

13541

<h4>Parameters:</h4>

13542

13543

13544

13545

13546

13547

<code class="param-name">config</code>

13548

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>

13549

13550

13551

13552

13553

13554

<p>Object with configuration property name/value pairs</p>

13555

</div>

13556

13557

13558

</li>

13559

13560

</ul>

13561

</div>

13562

13563

13564

13565

13566

<h4>Returns:</h4>

13567

13568

13569

13570

13571

<span class="type"><a href="../classes/Base.html" class="crosslink">Base</a></span>:

13572

13573

A reference to this object

13574

13575

</div>

13576

</div>

13577

13578

13579

13580

</div>

13581

13582

13583

13584

<h3 class="name"><code>initializer</code></h3>

13585

13586

13587

13588

13589

13590

13591

13592

13593

13594

13595

<span class="flag protected">protected</span>

13596

13597

13598

13599

13600

13601

13602

13603

13604

13605

13606

<p>Inherited from

13607

13608

Widget

13609

</a>

13610

13611

but overwritten in

13612

13613

13614

13615

<a href="../files/uploader_js_uploader-html5.js.html#l65"><code>uploader/js/uploader-html5.js:65</code></a>

13616

13617

</p>

13618

13619

13620

13621

13622

13623

</div>

13624

13625

13626

<p>Construction logic executed during UploaderHTML5 instantiation.</p>

13627

</div>

13628

13629

13630

13631

13632

13633

13634

</div>

13635

13636

13637

13638

<h3 class="name"><code>isRoot</code></h3>

13639

13640

13641

13642

13643

13644

13645

13646

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>

13647

</span>

13648

13649

13650

13651

13652

13653

13654

13655

13656

13657

13658

13659

13660

13661

13662

13663

<p>Inherited from

13664

<a href="../classes/Widget.html#method_isRoot">Widget</a>:

13665

13666

13667

13668

<a href="../files/widget-child_js_Widget-Child.js.html#l267"><code>widget-child/js/Widget-Child.js:267</code></a>

13669

13670

</p>

13671

13672

13673

13674

13675

13676

</div>

13677

13678

13679

<p>Determines if the Widget is the root Widget in the

13680

object hierarchy.</p>

13681

</div>

13682

13683

13684

13685

13686

13687

<h4>Returns:</h4>

13688

13689

13690

13691

13692

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>:

13693

13694

Boolean indicating if Widget is the root Widget in the

13695

object hierarchy.

13696

13697

</div>

13698

</div>

13699

13700

13701

13702

</div>

13703

13704

13705

13706

<h3 class="name"><code>modifyAttr</code></h3>

13707

13708

13709

13710

13711

13712

13713

13714

13715

13716

</li>

13717

13718

13719

13720

<code>config</code>

13721

13722

</li>

13723

13724

</ul><span class="paren">)</span>

13725

</div>

13726

13727

13728

13729

13730

13731

13732

13733

13734

13735

13736

13737

13738

13739

13740

13741

13742

13743

<p>Inherited from

13744

<a href="../classes/AttributeExtras.html#method_modifyAttr">AttributeExtras</a>:

13745

13746

13747

13748

<a href="../files/attribute_js_AttributeExtras.js.html#l39"><code>attribute/js/AttributeExtras.js:39</code></a>

13749

13750

</p>

13751

13752

13753

13754

13755

13756

</div>

13757

13758

13759

<p>Updates the configuration of an attribute which has already been added.</p>

13760

13761

<p>

13762

The properties which can be modified through this interface are limited

13763

to the following subset of attributes, which can be safely modified

13764

after a value has already been set on the attribute: readOnly, writeOnce,

13765

broadcast and getter.

13766

</p>

13767

</div>

13768

13769

13770

13771

<h4>Parameters:</h4>

13772

13773

13774

13775

13776

13777

13778

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

13779

13780

13781

13782

13783

13784

<p>The name of the attribute whose configuration is to be updated.</p>

13785

</div>

13786

13787

13788

</li>

13789

13790

13791

13792

<code class="param-name">config</code>

13793

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>

13794

13795

13796

13797

13798

13799

<p>An object with configuration property/value pairs, specifying the configuration properties to modify.</p>

13800

</div>

13801

13802

13803

</li>

13804

13805

</ul>

13806

</div>

13807

13808

13809

13810

13811

13812

</div>

13813

13814

13815

13816

13817

13818

13819

13820

13821

13822

13823

13824

<code>circular</code>

13825

13826

</li>

13827

13828

</ul><span class="paren">)</span>

13829

</div>

13830

13831

13832

13833

13834

<span class="type"><a href="../classes/Widget.html" class="crosslink">Widget</a></span>

13835

</span>

13836

13837

13838

13839

13840

13841

13842

13843

13844

13845

13846

13847

13848

13849

13850

13851

<p>Inherited from

13852

<a href="../classes/Widget.html#method_next">Widget</a>:

13853

13854

13855

13856

<a href="../files/widget-child_js_Widget-Child.js.html#l191"><code>widget-child/js/Widget-Child.js:191</code></a>

13857

13858

</p>

13859

13860

13861

13862

13863

13864

</div>

13865

13866

13867

<p>Returns the Widget's next sibling.</p>

13868

</div>

13869

13870

13871

13872

<h4>Parameters:</h4>

13873

13874

13875

13876

13877

13878

<code class="param-name">circular</code>

13879

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>

13880

13881

13882

13883

13884

13885

<p>Boolean indicating if the parent's first child

13886

should be returned if the child has no next sibling.</p>

13887

</div>

13888

13889

13890

</li>

13891

13892

</ul>

13893

</div>

13894

13895

13896

13897

13898

<h4>Returns:</h4>

13899

13900

13901

13902

13903

<span class="type"><a href="../classes/Widget.html" class="crosslink">Widget</a></span>:

13904

13905

Widget instance.

13906

13907

</div>

13908

</div>

13909

13910

13911

13912

</div>

13913

13914

13915

13916

13917

13918

13919

13920

13921

13922

13923

13924

13925

13926

</li>

13927

13928

13929

13930

13931

13932

</li>

13933

13934

13935

13936

<code class="optional">[context]</code>

13937

13938

</li>

13939

13940

13941

13942

13943

13944

</li>

13945

13946

</ul><span class="paren">)</span>

13947

</div>

13948

13949

13950

13951

13952

<span class="type"><a href="../classes/EventHandle.html" class="crosslink">EventHandle</a></span>

13953

</span>

13954

13955

13956

13957

13958

13959

13960

13961

13962

13963

13964

13965

13966

13967

13968

13969

<p>Inherited from

13970

<a href="../classes/EventTarget.html#method_on">EventTarget</a>:

13971

13972

13973

13974

<a href="../files/event-custom_js_event-target.js.html#l192"><code>event-custom/js/event-target.js:192</code></a>

13975

13976

</p>

13977

13978

13979

13980

13981

13982

</div>

13983

13984

13985

<p>Subscribe a callback function to a custom event fired by this object or

13986

from an object that bubbles its events to this object.</p>

13987

13988

<p>Callback functions for events published with <code>emitFacade = true</code> will

13989

receive an <code>EventFacade</code> as the first argument (typically named "e").

13990

These callbacks can then call <code>e.preventDefault()</code> to disable the

13991

behavior published to that event's <code>defaultFn</code>. See the <code>EventFacade</code>

13992

API for all available properties and methods. Subscribers to

13993

non-<code>emitFacade</code> events will receive the arguments passed to <code>fire()</code>

13994

after the event name.</p>

13995

13996

<p>To subscribe to multiple events at once, pass an object as the first

13997

argument, where the key:value pairs correspond to the eventName:callback,

13998

or pass an array of event names as the first argument to subscribe to

13999

all listed events with the same callback.</p>

14000

14001

<p>Returning <code>false</code> from a callback is supported as an alternative to

14002

calling <code>e.preventDefault(); e.stopPropagation();</code>. However, it is

14003

recommended to use the event methods whenever possible.</p>

14004

</div>

14005

14006

14007

14008

<h4>Parameters:</h4>

14009

14010

14011

14012

14013

14014

14015

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

14016

14017

14018

14019

14020

14021

<p>The name of the event</p>

14022

</div>

14023

14024

14025

</li>

14026

14027

14028

14029

14030

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function</a></span>

14031

14032

14033

14034

14035

14036

<p>The callback to execute in response to the event</p>

14037

</div>

14038

14039

14040

</li>

14041

14042

14043

14044

<code class="param-name optional">[context]</code>

14045

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>

14046

<span class="flag optional" title="This parameter is optional.">optional</span>

14047

14048

14049

14050

14051

14052

<p>Override <code>this</code> object in callback</p>

14053

</div>

14054

14055

14056

</li>

14057

14058

14059

14060

14061

14062

<span class="flag optional" title="This parameter is optional.">optional</span>

14063

14064

14065

14066

14067

14068

<p>0..n additional arguments to supply to the subscriber</p>

14069

</div>

14070

14071

14072

</li>

14073

14074

</ul>

14075

</div>

14076

14077

14078

14079

14080

<h4>Returns:</h4>

14081

14082

14083

14084

14085

<span class="type"><a href="../classes/EventHandle.html" class="crosslink">EventHandle</a></span>:

14086

14087

A subscription handle capable of detaching that

14088

subscription

14089

14090

</div>

14091

</div>

14092

14093

14094

14095

</div>

14096

14097

14098

14099

14100

14101

14102

14103

14104

14105

14106

14107

14108

14109

</li>

14110

14111

14112

14113

14114

14115

</li>

14116

14117

14118

14119

<code class="optional">[context]</code>

14120

14121

</li>

14122

14123

14124

14125

14126

14127

</li>

14128

14129

</ul><span class="paren">)</span>

14130

</div>

14131

14132

14133

14134

14135

<span class="type"><a href="../classes/EventHandle.html" class="crosslink">EventHandle</a></span>

14136

</span>

14137

14138

14139

14140

14141

14142

14143

14144

14145

14146

14147

14148

14149

14150

14151

14152

<p>Inherited from

14153

<a href="../classes/EventTarget.html#method_once">EventTarget</a>:

14154

14155

14156

14157

<a href="../files/event-custom_js_event-target.js.html#l128"><code>event-custom/js/event-target.js:128</code></a>

14158

14159

</p>

14160

14161

14162

14163

14164

14165

</div>

14166

14167

14168

<p>Listen to a custom event hosted by this object one time.

14169

This is the equivalent to <code>on</code> except the

14170

listener is immediatelly detached when it is executed.</p>

14171

</div>

14172

14173

14174

14175

<h4>Parameters:</h4>

14176

14177

14178

14179

14180

14181

14182

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

14183

14184

14185

14186

14187

14188

<p>The name of the event</p>

14189

</div>

14190

14191

14192

</li>

14193

14194

14195

14196

14197

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function</a></span>

14198

14199

14200

14201

14202

14203

<p>The callback to execute in response to the event</p>

14204

</div>

14205

14206

14207

</li>

14208

14209

14210

14211

<code class="param-name optional">[context]</code>

14212

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>

14213

<span class="flag optional" title="This parameter is optional.">optional</span>

14214

14215

14216

14217

14218

14219

<p>Override <code>this</code> object in callback</p>

14220

</div>

14221

14222

14223

</li>

14224

14225

14226

14227

14228

14229

<span class="flag optional" title="This parameter is optional.">optional</span>

14230

14231

14232

14233

14234

14235

<p>0..n additional arguments to supply to the subscriber</p>

14236

</div>

14237

14238

14239

</li>

14240

14241

</ul>

14242

</div>

14243

14244

14245

14246

14247

<h4>Returns:</h4>

14248

14249

14250

14251

14252

<span class="type"><a href="../classes/EventHandle.html" class="crosslink">EventHandle</a></span>:

14253

14254

A subscription handle capable of detaching the

14255

subscription

14256

14257

</div>

14258

</div>

14259

14260

14261

14262

</div>

14263

14264

14265

14266

<h3 class="name"><code>onceAfter</code></h3>

14267

14268

14269

14270

14271

14272

14273

14274

14275

14276

</li>

14277

14278

14279

14280

14281

14282

</li>

14283

14284

14285

14286

<code class="optional">[context]</code>

14287

14288

</li>

14289

14290

14291

14292

14293

14294

</li>

14295

14296

</ul><span class="paren">)</span>

14297

</div>

14298

14299

14300

14301

14302

<span class="type"><a href="../classes/EventHandle.html" class="crosslink">EventHandle</a></span>

14303

</span>

14304

14305

14306

14307

14308

14309

14310

14311

14312

14313

14314

14315

14316

14317

14318

14319

<p>Inherited from

14320

<a href="../classes/EventTarget.html#method_onceAfter">EventTarget</a>:

14321

14322

14323

14324

<a href="../files/event-custom_js_event-target.js.html#l150"><code>event-custom/js/event-target.js:150</code></a>

14325

14326

</p>

14327

14328

14329

14330

14331

14332

</div>

14333

14334

14335

<p>Listen to a custom event hosted by this object one time.

14336

This is the equivalent to <code>after</code> except the

14337

listener is immediatelly detached when it is executed.</p>

14338

</div>

14339

14340

14341

14342

<h4>Parameters:</h4>

14343

14344

14345

14346

14347

14348

14349

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

14350

14351

14352

14353

14354

14355

<p>The name of the event</p>

14356

</div>

14357

14358

14359

</li>

14360

14361

14362

14363

14364

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function</a></span>

14365

14366

14367

14368

14369

14370

<p>The callback to execute in response to the event</p>

14371

</div>

14372

14373

14374

</li>

14375

14376

14377

14378

<code class="param-name optional">[context]</code>

14379

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>

14380

<span class="flag optional" title="This parameter is optional.">optional</span>

14381

14382

14383

14384

14385

14386

<p>Override <code>this</code> object in callback</p>

14387

</div>

14388

14389

14390

</li>

14391

14392

14393

14394

14395

14396

<span class="flag optional" title="This parameter is optional.">optional</span>

14397

14398

14399

14400

14401

14402

<p>0..n additional arguments to supply to the subscriber</p>

14403

</div>

14404

14405

14406

</li>

14407

14408

</ul>

14409

</div>

14410

14411

14412

14413

14414

<h4>Returns:</h4>

14415

14416

14417

14418

14419

<span class="type"><a href="../classes/EventHandle.html" class="crosslink">EventHandle</a></span>:

14420

14421

A subscription handle capable of detaching that

14422

subscription

14423

14424

</div>

14425

</div>

14426

14427

14428

14429

</div>

14430

14431

14432

14433

<h3 class="name"><code>openFileSelectDialog</code></h3>

14434

14435

14436

14437

14438

14439

14440

14441

14442

14443

14444

14445

14446

14447

14448

14449

14450

14451

14452

14453

14454

14455

<p>

14456

14457

Defined in

14458

14459

14460

14461

14462

<a href="../files/uploader_js_uploader-html5.js.html#l471"><code>uploader/js/uploader-html5.js:471</code></a>

14463

14464

</p>

14465

14466

14467

14468

14469

14470

</div>

14471

14472

14473

<p>Opens the File Selection dialog by simulating a click on the file input field.</p>

14474

</div>

14475

14476

14477

14478

14479

14480

14481

</div>

14482

14483

14484

14485

<h3 class="name"><code>parseType</code></h3>

14486

14487

14488

14489

14490

14491

14492

14493

14494

14495

</li>

14496

14497

14498

14499

<code class="optional">[pre=this._yuievt.config.prefix]</code>

14500

14501

</li>

14502

14503

</ul><span class="paren">)</span>

14504

</div>

14505

14506

14507

14508

14509

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Array" class="crosslink external" target="_blank">Array</a></span>

14510

</span>

14511

14512

14513

14514

14515

14516

14517

14518

14519

14520

14521

14522

14523

14524

14525

14526

<p>Inherited from

14527

<a href="../classes/EventTarget.html#method_parseType">EventTarget</a>:

14528

14529

14530

14531

<a href="../files/event-custom_js_event-target.js.html#l172"><code>event-custom/js/event-target.js:172</code></a>

14532

14533

</p>

14534

14535

14536

14537

14538

14539

<p>Available since 3.3.0</p>

14540

14541

</div>

14542

14543

14544

<p>Takes the type parameter passed to 'on' and parses out the

14545

various pieces that could be included in the type. If the

14546

event type is passed without a prefix, it will be expanded

14547

to include the prefix one is supplied or the event target

14548

is configured with a default prefix.</p>

14549

</div>

14550

14551

14552

14553

<h4>Parameters:</h4>

14554

14555

14556

14557

14558

14559

14560

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

14561

14562

14563

14564

14565

14566

14567

</div>

14568

14569

14570

</li>

14571

14572

14573

14574

<code class="param-name optional">[pre=this._yuievt.config.prefix]</code>

14575

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

14576

<span class="flag optional" title="This parameter is optional.">optional</span>

14577

14578

14579

14580

14581

14582

<p>the prefix</p>

14583

</div>

14584

14585

14586

</li>

14587

14588

</ul>

14589

</div>

14590

14591

14592

14593

14594

<h4>Returns:</h4>

14595

14596

14597

14598

14599

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Array" class="crosslink external" target="_blank">Array</a></span>:

14600

14601

an array containing:

14602

* the detach category, if supplied,

14603

* the prefixed event type,

14604

* whether or not this is an after listener,

14605

* the supplied event type

14606

14607

</div>

14608

</div>

14609

14610

14611

14612

</div>

14613

14614

14615

14616

<h3 class="name"><code>previous</code></h3>

14617

14618

14619

14620

14621

14622

14623

14624

<code>circular</code>

14625

14626

</li>

14627

14628

</ul><span class="paren">)</span>

14629

</div>

14630

14631

14632

14633

14634

<span class="type"><a href="../classes/Widget.html" class="crosslink">Widget</a></span>

14635

</span>

14636

14637

14638

14639

14640

14641

14642

14643

14644

14645

14646

14647

14648

14649

14650

14651

<p>Inherited from

14652

<a href="../classes/Widget.html#method_previous">Widget</a>:

14653

14654

14655

14656

<a href="../files/widget-child_js_Widget-Child.js.html#l216"><code>widget-child/js/Widget-Child.js:216</code></a>

14657

14658

</p>

14659

14660

14661

14662

14663

14664

</div>

14665

14666

14667

<p>Returns the Widget's previous sibling.</p>

14668

</div>

14669

14670

14671

14672

<h4>Parameters:</h4>

14673

14674

14675

14676

14677

14678

<code class="param-name">circular</code>

14679

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>

14680

14681

14682

14683

14684

14685

<p>Boolean indicating if the parent's last child

14686

should be returned if the child has no previous sibling.</p>

14687

</div>

14688

14689

14690

</li>

14691

14692

</ul>

14693

</div>

14694

14695

14696

14697

14698

<h4>Returns:</h4>

14699

14700

14701

14702

14703

<span class="type"><a href="../classes/Widget.html" class="crosslink">Widget</a></span>:

14704

14705

Widget instance.

14706

14707

</div>

14708

</div>

14709

14710

14711

14712

</div>

14713

14714

14715

14716

<h3 class="name"><code>publish</code></h3>

14717

14718

14719

14720

14721

14722

14723

14724

14725

14726

</li>

14727

14728

14729

14730

14731

14732

</li>

14733

14734

</ul><span class="paren">)</span>

14735

</div>

14736

14737

14738

14739

14740

<span class="type"><a href="../classes/CustomEvent.html" class="crosslink">CustomEvent</a></span>

14741

</span>

14742

14743

14744

14745

14746

14747

14748

14749

14750

14751

14752

14753

14754

14755

14756

14757

<p>Inherited from

14758

<a href="../classes/EventTarget.html#method_publish">EventTarget</a>:

14759

14760

14761

14762

<a href="../files/event-custom_js_event-target.js.html#l489"><code>event-custom/js/event-target.js:489</code></a>

14763

14764

</p>

14765

14766

14767

14768

14769

14770

</div>

14771

14772

14773

<p>Creates a new custom event of the specified type. If a custom event

14774

by that name already exists, it will not be re-created. In either

14775

case the custom event is returned.</p>

14776

</div>

14777

14778

14779

14780

<h4>Parameters:</h4>

14781

14782

14783

14784

14785

14786

14787

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

14788

14789

14790

14791

14792

14793

<p>the type, or name of the event</p>

14794

</div>

14795

14796

14797

</li>

14798

14799

14800

14801

14802

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>

14803

14804

14805

14806

14807

14808

<p>optional config params. Valid properties are:</p>

14809

14810

<p><ul>

14811

<li>

14812

'broadcast': whether or not the YUI instance and YUI global are notified when the event is fired (false)

14813

</li>

14814

<li>

14815

'bubbles': whether or not this event bubbles (true)

14816

Events can only bubble if emitFacade is true.

14817

</li>

14818

<li>

14819

'context': the default execution context for the listeners (this)

14820

</li>

14821

<li>

14822

'defaultFn': the default function to execute when this event fires if preventDefault was not called

14823

</li>

14824

<li>

14825

'emitFacade': whether or not this event emits a facade (false)

14826

</li>

14827

<li>

14828

'prefix': the prefix for this targets events, e.g., 'menu' in 'menu:click'

14829

</li>

14830

<li>

14831

'fireOnce': if an event is configured to fire once, new subscribers after

14832

the fire will be notified immediately.

14833

</li>

14834

<li>

14835

'async': fireOnce event listeners will fire synchronously if the event has already

14836

fired unless async is true.

14837

</li>

14838

<li>

14839

'preventable': whether or not preventDefault() has an effect (true)

14840

</li>

14841

<li>

14842

'preventedFn': a function that is executed when preventDefault is called

14843

</li>

14844

<li>

14845

'queuable': whether or not this event can be queued during bubbling (false)

14846

</li>

14847

<li>

14848

'silent': if silent is true, debug messages are not provided for this event.

14849

</li>

14850

<li>

14851

'stoppedFn': a function that is executed when stopPropagation is called

14852

</li></p>

14853

14854

<p><li>

14855

'monitored': specifies whether or not this event should send notifications about

14856

when the event has been attached, detached, or published.

14857

</li>

14858

<li>

14859

'type': the event type (valid option if not provided as the first parameter to publish)

14860

</li>

14861

</ul></p>

14862

</div>

14863

14864

14865

</li>

14866

14867

</ul>

14868

</div>

14869

14870

14871

14872

14873

<h4>Returns:</h4>

14874

14875

14876

14877

14878

<span class="type"><a href="../classes/CustomEvent.html" class="crosslink">CustomEvent</a></span>:

14879

14880

the custom event

14881

14882

</div>

14883

</div>

14884

14885

14886

14887

</div>

14888

14889

14890

14891

<h3 class="name"><code>removeAttr</code></h3>

14892

14893

14894

14895

14896

14897

14898

14899

14900

14901

</li>

14902

14903

</ul><span class="paren">)</span>

14904

</div>

14905

14906

14907

14908

14909

14910

14911

14912

14913

14914

14915

14916

14917

14918

14919

14920

14921

14922

<p>Inherited from

14923

<a href="../classes/AttributeExtras.html#method_removeAttr">AttributeExtras</a>:

14924

14925

14926

14927

<a href="../files/attribute_js_AttributeExtras.js.html#l77"><code>attribute/js/AttributeExtras.js:77</code></a>

14928

14929

</p>

14930

14931

14932

14933

14934

14935

</div>

14936

14937

14938

<p>Removes an attribute from the host object</p>

14939

</div>

14940

14941

14942

14943

<h4>Parameters:</h4>

14944

14945

14946

14947

14948

14949

14950

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

14951

14952

14953

14954

14955

14956

<p>The name of the attribute to be removed.</p>

14957

</div>

14958

14959

14960

</li>

14961

14962

</ul>

14963

</div>

14964

14965

14966

14967

14968

14969

</div>

14970

14971

14972

14973

<h3 class="name"><code>removeTarget</code></h3>

14974

14975

14976

14977

14978

14979

14980

14981

14982

14983

</li>

14984

14985

</ul><span class="paren">)</span>

14986

</div>

14987

14988

14989

14990

14991

14992

14993

14994

14995

14996

14997

14998

14999

15000

15001

15002

15003

15004

<p>Inherited from

15005

<a href="../classes/EventTarget.html#method_removeTarget">EventTarget</a>:

15006

15007

15008

15009

<a href="../files/event-custom_js_event-facade.js.html#l409"><code>event-custom/js/event-facade.js:409</code></a>

15010

15011

</p>

15012

15013

15014

15015

15016

15017

</div>

15018

15019

15020

<p>Removes a bubble target</p>

15021

</div>

15022

15023

15024

15025

<h4>Parameters:</h4>

15026

15027

15028

15029

15030

15031

15032

<span class="type"><a href="../classes/EventTarget.html" class="crosslink">EventTarget</a></span>

15033

15034

15035

15036

15037

15038

<p>the target to remove</p>

15039

</div>

15040

15041

15042

</li>

15043

15044

</ul>

15045

</div>

15046

15047

15048

15049

15050

15051

</div>

15052

15053

15054

15055

<h3 class="name"><code>render</code></h3>

15056

15057

15058

15059

15060

15061

15062

15063

<code>parentNode</code>

15064

15065

</li>

15066

15067

</ul><span class="paren">)</span>

15068

</div>

15069

15070

15071

15072

15073

15074

15075

15076

15077

15078

<span class="flag final">final</span>

15079

15080

15081

15082

15083

15084

<span class="flag chainable">chainable</span>

15085

15086

15087

15088

15089

15090

<p>Inherited from

15091

<a href="../classes/Widget.html#method_render">Widget</a>:

15092

15093

15094

15095

<a href="../files/widget_js_Widget.js.html#l514"><code>widget/js/Widget.js:514</code></a>

15096

15097

</p>

15098

15099

15100

15101

15102

15103

</div>

15104

15105

15106

<p>Establishes the initial DOM for the widget. Invoking this

15107

method will lead to the creating of all DOM elements for

15108

the widget (or the manipulation of existing DOM elements

15109

for the progressive enhancement use case).</p>

15110

15111

<p>

15112

This method should only be invoked once for an initialized

15113

widget.

15114

</p>

15115

15116

<p>

15117

It delegates to the widget specific renderer method to do

15118

the actual work.

15119

</p>

15120

</div>

15121

15122

15123

15124

<h4>Parameters:</h4>

15125

15126

15127

15128

15129

15130

<code class="param-name">parentNode</code>

15131

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a> | <a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

15132

15133

15134

15135

15136

15137

<p>Optional. The Node under which the

15138

Widget is to be rendered. This can be a Node instance or a CSS selector string. </p>

15139

15140

<p>

15141

If the selector string returns more than one Node, the first node will be used

15142

as the parentNode. NOTE: This argument is required if both the boundingBox and contentBox

15143

are not currently in the document. If it's not provided, the Widget will be rendered

15144

to the body of the current document in this case.

15145

</p>

15146

</div>

15147

15148

15149

</li>

15150

15151

</ul>

15152

</div>

15153

15154

15155

15156

15157

15158

</div>

15159

15160

15161

15162

<h3 class="name"><code>renderer</code></h3>

15163

15164

15165

15166

15167

15168

15169

15170

15171

15172

15173

<span class="flag protected">protected</span>

15174

15175

15176

15177

15178

15179

15180

15181

15182

15183

15184

15185

<p>Inherited from

15186

<a href="../classes/Widget.html#method_renderer">Widget</a>:

15187

15188

15189

15190

<a href="../files/widget_js_Widget.js.html#l589"><code>widget/js/Widget.js:589</code></a>

15191

15192

</p>

15193

15194

15195

15196

15197

15198

</div>

15199

15200

15201

<p>Creates DOM (or manipulates DOM for progressive enhancement)

15202

This method is invoked by render() and is not chained

15203

automatically for the class hierarchy (unlike initializer, destructor)

15204

so it should be chained manually for subclasses if required.</p>

15205

</div>

15206

15207

15208

15209

15210

15211

15212

</div>

15213

15214

15215

15216

<h3 class="name"><code>renderUI</code></h3>

15217

15218

15219

15220

15221

15222

15223

15224

15225

15226

15227

<span class="flag protected">protected</span>

15228

15229

15230

15231

15232

15233

15234

15235

15236

15237

15238

<p>Inherited from

15239

15240

Widget

15241

</a>

15242

15243

but overwritten in

15244

15245

15246

15247

<a href="../files/uploader_js_uploader-html5.js.html#l231"><code>uploader/js/uploader-html5.js:231</code></a>

15248

15249

</p>

15250

15251

15252

15253

15254

15255

</div>

15256

15257

15258

<p>Create the DOM structure for the UploaderHTML5.

15259

UploaderHTML5's DOM structure consists of a "Select Files" button that can

15260

be replaced by the developer's widget of choice; and a hidden file input field

15261

that is used to instantiate the File Select dialog.</p>

15262

</div>

15263

15264

15265

15266

15267

15268

15269

</div>

15270

15271

15272

15273

<h3 class="name"><code>reset</code></h3>

15274

15275

15276

15277

15278

15279

15280

15281

15282

15283

</li>

15284

15285

</ul><span class="paren">)</span>

15286

</div>

15287

15288

15289

15290

15291

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>

15292

</span>

15293

15294

15295

15296

15297

15298

15299

15300

15301

15302

15303

15304

<span class="flag chainable">chainable</span>

15305

15306

15307

15308

15309

15310

<p>Inherited from

15311

<a href="../classes/AttributeExtras.html#method_reset">AttributeExtras</a>:

15312

15313

15314

15315

<a href="../files/attribute_js_AttributeExtras.js.html#l87"><code>attribute/js/AttributeExtras.js:87</code></a>

15316

15317

</p>

15318

15319

15320

15321

15322

15323

</div>

15324

15325

15326

<p>Resets the attribute (or all attributes) to its initial value, as long as

15327

the attribute is not readOnly, or writeOnce.</p>

15328

</div>

15329

15330

15331

15332

<h4>Parameters:</h4>

15333

15334

15335

15336

15337

15338

15339

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

15340

15341

15342

15343

15344

15345

<p>Optional. The name of the attribute to reset. If omitted, all attributes are reset.</p>

15346

</div>

15347

15348

15349

</li>

15350

15351

</ul>

15352

</div>

15353

15354

15355

15356

15357

<h4>Returns:</h4>

15358

15359

15360

15361

15362

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>:

15363

15364

A reference to the host object.

15365

15366

</div>

15367

</div>

15368

15369

15370

15371

</div>

15372

15373

15374

15375

15376

15377

15378

15379

15380

15381

15382

15383

15384

15385

</li>

15386

15387

15388

15389

<code>value</code>

15390

15391

</li>

15392

15393

</ul><span class="paren">)</span>

15394

</div>

15395

15396

15397

15398

15399

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>

15400

</span>

15401

15402

15403

15404

15405

15406

15407

15408

15409

15410

15411

15412

<span class="flag chainable">chainable</span>

15413

15414

15415

15416

15417

<p>Inherited from

15418

15419

AttributeEvents

15420

</a>

15421

15422

but overwritten in

15423

15424

15425

15426

<a href="../files/attribute_js_AttributeCore.js.html#l328"><code>attribute/js/AttributeCore.js:328</code></a>

15427

15428

</p>

15429

15430

15431

15432

15433

15434

</div>

15435

15436

15437

<p>Sets the value of an attribute.</p>

15438

</div>

15439

15440

15441

15442

<h4>Parameters:</h4>

15443

15444

15445

15446

15447

15448

15449

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

15450

15451

15452

15453

15454

15455

<p>The name of the attribute. If the

15456

current value of the attribute is an Object, dot notation can be used

15457

to set the value of a property within the object (e.g. <code>set("x.y.z", 5)</code>).</p>

15458

</div>

15459

15460

15461

</li>

15462

15463

15464

15465

<code class="param-name">value</code>

15466

15467

15468

15469

15470

15471

15472

<p>The value to set the attribute to.</p>

15473

</div>

15474

15475

15476

</li>

15477

15478

</ul>

15479

</div>

15480

15481

15482

15483

15484

<h4>Returns:</h4>

15485

15486

15487

15488

15489

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>:

15490

15491

A reference to the host object.

15492

15493

</div>

15494

</div>

15495

15496

15497

15498

</div>

15499

15500

15501

15502

<h3 class="name"><code>setAttrs</code></h3>

15503

15504

15505

15506

15507

15508

15509

15510

<code>attrs</code>

15511

15512

</li>

15513

15514

</ul><span class="paren">)</span>

15515

</div>

15516

15517

15518

15519

15520

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>

15521

</span>

15522

15523

15524

15525

15526

15527

15528

15529

15530

15531

15532

15533

<span class="flag chainable">chainable</span>

15534

15535

15536

15537

15538

<p>Inherited from

15539

15540

AttributeEvents

15541

</a>

15542

15543

but overwritten in

15544

15545

15546

15547

<a href="../files/attribute_js_AttributeCore.js.html#l635"><code>attribute/js/AttributeCore.js:635</code></a>

15548

15549

</p>

15550

15551

15552

15553

15554

15555

</div>

15556

15557

15558

<p>Sets multiple attribute values.</p>

15559

</div>

15560

15561

15562

15563

<h4>Parameters:</h4>

15564

15565

15566

15567

15568

15569

<code class="param-name">attrs</code>

15570

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>

15571

15572

15573

15574

15575

15576

<p>An object with attributes name/value pairs.</p>

15577

</div>

15578

15579

15580

</li>

15581

15582

</ul>

15583

</div>

15584

15585

15586

15587

15588

<h4>Returns:</h4>

15589

15590

15591

15592

15593

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>:

15594

15595

A reference to the host object.

15596

15597

</div>

15598

</div>

15599

15600

15601

15602

</div>

15603

15604

15605

15606

15607

15608

15609

15610

15611

15612

15613

15614

15615

15616

15617

15618

15619

15620

15621

15622

15623

<span class="flag chainable">chainable</span>

15624

15625

15626

15627

15628

15629

<p>Inherited from

15630

<a href="../classes/Widget.html#method_show">Widget</a>:

15631

15632

15633

15634

<a href="../files/widget_js_Widget.js.html#l655"><code>widget/js/Widget.js:655</code></a>

15635

15636

</p>

15637

15638

15639

15640

15641

15642

</div>

15643

15644

15645

<p>Shows the Widget by setting the "visible" attribute to "true".</p>

15646

</div>

15647

15648

15649

15650

15651

15652

15653

</div>

15654

15655

15656

15657

<h3 class="name"><code>subscribe</code></h3>

15658

15659

15660

15661

15662

15663

15664

15665

15666

<span class="flag deprecated" title="use on">deprecated</span>

15667

15668

15669

15670

15671

15672

15673

15674

15675

15676

15677

15678

15679

15680

<p>Inherited from

15681

<a href="../classes/EventTarget.html#method_subscribe">EventTarget</a>:

15682

15683

15684

15685

<a href="../files/event-custom_js_event-target.js.html#l335"><code>event-custom/js/event-target.js:335</code></a>

15686

15687

</p>

15688

15689

15690

15691

<p>Deprecated: use on</p>

15692

15693

15694

15695

</div>

15696

15697

15698

<p>subscribe to an event</p>

15699

</div>

15700

15701

15702

15703

15704

15705

15706

</div>

15707

15708

15709

15710

<h3 class="name"><code>syncUI</code></h3>

15711

15712

15713

15714

15715

15716

15717

15718

15719

15720

15721

<span class="flag protected">protected</span>

15722

15723

15724

15725

15726

15727

15728

15729

15730

15731

15732

15733

<p>Inherited from

15734

<a href="../classes/Widget.html#method_syncUI">Widget</a>:

15735

15736

15737

15738

<a href="../files/widget_js_Widget.js.html#l634"><code>widget/js/Widget.js:634</code></a>

15739

15740

</p>

15741

15742

15743

15744

15745

15746

</div>

15747

15748

15749

<p>Refreshes the rendered UI, based on Widget State</p>

15750

15751

<p>This method is not called by framework and is not chained

15752

automatically for the class hierarchy.</p>

15753

</div>

15754

15755

15756

15757

15758

15759

15760

</div>

15761

15762

15763

15764

<h3 class="name"><code>toString</code></h3>

15765

15766

15767

15768

15769

15770

15771

15772

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

15773

</span>

15774

15775

15776

15777

15778

15779

15780

15781

15782

15783

15784

15785

15786

15787

15788

<p>Inherited from

15789

15790

BaseCore

15791

</a>

15792

15793

but overwritten in

15794

15795

15796

15797

<a href="../files/widget_js_Widget.js.html#l1094"><code>widget/js/Widget.js:1094</code></a>

15798

15799

</p>

15800

15801

15802

15803

15804

15805

</div>

15806

15807

15808

<p>Generic toString implementation for all widgets.</p>

15809

</div>

15810

15811

15812

15813

15814

15815

<h4>Returns:</h4>

15816

15817

15818

15819

15820

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>:

15821

15822

The default string value for the widget [ displays the NAME of the instance, and the unique id ]

15823

15824

</div>

15825

</div>

15826

15827

15828

15829

</div>

15830

15831

15832

15833

<h3 class="name"><code>unsubscribe</code></h3>

15834

15835

15836

15837

15838

15839

15840

15841

15842

<span class="flag deprecated" title="use detach">deprecated</span>

15843

15844

15845

15846

15847

15848

15849

15850

15851

15852

15853

15854

15855

15856

<p>Inherited from

15857

<a href="../classes/EventTarget.html#method_unsubscribe">EventTarget</a>:

15858

15859

15860

15861

<a href="../files/event-custom_js_event-target.js.html#l455"><code>event-custom/js/event-target.js:455</code></a>

15862

15863

</p>

15864

15865

15866

15867

<p>Deprecated: use detach</p>

15868

15869

15870

15871

</div>

15872

15873

15874

<p>detach a listener</p>

15875

</div>

15876

15877

15878

15879

15880

15881

15882

</div>

15883

15884

15885

15886

<h3 class="name"><code>unsubscribeAll</code></h3>

15887

15888

15889

15890

15891

15892

15893

15894

15895

15896

</li>

15897

15898

</ul><span class="paren">)</span>

15899

</div>

15900

15901

15902

15903

15904

15905

<span class="flag deprecated" title="use detachAll">deprecated</span>

15906

15907

15908

15909

15910

15911

15912

15913

15914

15915

15916

15917

15918

15919

<p>Inherited from

15920

<a href="../classes/EventTarget.html#method_unsubscribeAll">EventTarget</a>:

15921

15922

15923

15924

<a href="../files/event-custom_js_event-target.js.html#l476"><code>event-custom/js/event-target.js:476</code></a>

15925

15926

</p>

15927

15928

15929

15930

<p>Deprecated: use detachAll</p>

15931

15932

15933

15934

</div>

15935

15936

15937

<p>Removes all listeners from the specified event. If the event type

15938

is not specified, all listeners from all hosted custom events will

15939

be removed.</p>

15940

</div>

15941

15942

15943

15944

<h4>Parameters:</h4>

15945

15946

15947

15948

15949

15950

15951

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

15952

15953

15954

15955

15956

15957

<p>The type, or name of the event</p>

15958

</div>

15959

15960

15961

</li>

15962

15963

</ul>

15964

</div>

15965

15966

15967

15968

15969

15970

</div>

15971

15972

15973

15974

<h3 class="name"><code>upload</code></h3>

15975

15976

15977

15978

15979

15980

15981

15982

15983

15984

</li>

15985

15986

15987

15988

15989

15990

</li>

15991

15992

15993

15994

<code>postVars</code>

15995

15996

</li>

15997

15998

</ul><span class="paren">)</span>

15999

</div>

16000

16001

16002

16003

16004

16005

16006

16007

16008

16009

16010

16011

16012

16013

16014

16015

16016

16017

16018

<p>

16019

16020

Defined in

16021

16022

16023

16024

16025

<a href="../files/uploader_js_uploader-html5.js.html#l483"><code>uploader/js/uploader-html5.js:483</code></a>

16026

16027

</p>

16028

16029

16030

16031

16032

16033

</div>

16034

16035

16036

<p>Starts the upload of a specific file.</p>

16037

</div>

16038

16039

16040

16041

<h4>Parameters:</h4>

16042

16043

16044

16045

16046

16047

16048

16049

16050

16051

16052

16053

16054

<p>Reference to the instance of the file to be uploaded.</p>

16055

</div>

16056

16057

16058

</li>

16059

16060

16061

16062

16063

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

16064

16065

16066

16067

16068

16069

<p>The URL to upload the file to.</p>

16070

</div>

16071

16072

16073

</li>

16074

16075

16076

16077

<code class="param-name">postVars</code>

16078

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>

16079

16080

16081

16082

16083

16084

<p>(optional) A set of key-value pairs to send as variables along with the file upload HTTP request.

16085

If not specified, the values from the attribute <code>postVarsPerFile</code> are used instead.</p>

16086

</div>

16087

16088

16089

</li>

16090

16091

</ul>

16092

</div>

16093

16094

16095

16096

16097

16098

</div>

16099

16100

16101

16102

<h3 class="name"><code>uploadAll</code></h3>

16103

16104

16105

16106

16107

16108

16109

16110

16111

16112

</li>

16113

16114

16115

16116

<code>postVars</code>

16117

16118

</li>

16119

16120

</ul><span class="paren">)</span>

16121

</div>

16122

16123

16124

16125

16126

16127

16128

16129

16130

16131

16132

16133

16134

16135

16136

16137

16138

16139

16140

<p>

16141

16142

Defined in

16143

16144

16145

16146

16147

<a href="../files/uploader_js_uploader-html5.js.html#l511"><code>uploader/js/uploader-html5.js:511</code></a>

16148

16149

</p>

16150

16151

16152

16153

16154

16155

</div>

16156

16157

16158

<p>Starts the upload of all files on the file list, using an automated queue.</p>

16159

</div>

16160

16161

16162

16163

<h4>Parameters:</h4>

16164

16165

16166

16167

16168

16169

16170

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

16171

16172

16173

16174

16175

16176

<p>The URL to upload the files to.</p>

16177

</div>

16178

16179

16180

</li>

16181

16182

16183

16184

<code class="param-name">postVars</code>

16185

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>

16186

16187

16188

16189

16190

16191

<p>(optional) A set of key-value pairs to send as variables along with the file upload HTTP request.

16192

If not specified, the values from the attribute <code>postVarsPerFile</code> are used instead.</p>

16193

</div>

16194

16195

16196

</li>

16197

16198

</ul>

16199

</div>

16200

16201

16202

16203

16204

16205

</div>

16206

16207

16208

16209

<h3 class="name"><code>uploadThese</code></h3>

16210

16211

16212

16213

16214

16215

16216

16217

<code>files</code>

16218

16219

</li>

16220

16221

16222

16223

16224

16225

</li>

16226

16227

16228

16229

<code>postVars</code>

16230

16231

</li>

16232

16233

</ul><span class="paren">)</span>

16234

</div>

16235

16236

16237

16238

16239

16240

16241

16242

16243

16244

16245

16246

16247

16248

16249

16250

16251

16252

16253

<p>

16254

16255

Defined in

16256

16257

16258

16259

16260

<a href="../files/uploader_js_uploader-html5.js.html#l523"><code>uploader/js/uploader-html5.js:523</code></a>

16261

16262

</p>

16263

16264

16265

16266

16267

16268

</div>

16269

16270

16271

<p>Starts the upload of the files specified in the first argument, using an automated queue.</p>

16272

</div>

16273

16274

16275

16276

<h4>Parameters:</h4>

16277

16278

16279

16280

16281

16282

<code class="param-name">files</code>

16283

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Array" class="crosslink external" target="_blank">Array</a></span>

16284

16285

16286

16287

16288

16289

<p>The list of files to upload.</p>

16290

</div>

16291

16292

16293

</li>

16294

16295

16296

16297

16298

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

16299

16300

16301

16302

16303

16304

<p>The URL to upload the files to.</p>

16305

</div>

16306

16307

16308

</li>

16309

16310

16311

16312

<code class="param-name">postVars</code>

16313

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>

16314

16315

16316

16317

16318

16319

<p>(optional) A set of key-value pairs to send as variables along with the file upload HTTP request.

16320

If not specified, the values from the attribute <code>postVarsPerFile</code> are used instead.</p>

16321

</div>

16322

16323

16324

</li>

16325

16326

</ul>

16327

</div>

16328

16329

16330

16331

16332

16333

</div>

16334

16335

16336

</div>

16337

16338

16339

16340

16341

<h2 class="off-left">Properties</h2>

16342

16343

16344

16345

<h3 class="name"><code>_allowAdHocAttrs</code></h3>

16346

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>

16347

16348

16349

16350

16351

<span class="flag protected">protected</span>

16352

16353

16354

16355

16356

16357

16358

16359

16360

16361

<p>Inherited from

16362

<a href="../classes/BaseCore.html#property__allowAdHocAttrs">BaseCore</a>:

16363

16364

16365

16366

<a href="../files/base_js_BaseCore.js.html#l100"><code>base/js/BaseCore.js:100</code></a>

16367

16368

</p>

16369

16370

16371

16372

16373

</div>

16374

16375

16376

<p>This property controls whether or not instances of this class should

16377

allow users to add ad-hoc attributes through the constructor configuration

16378

hash.</p>

16379

16380

<p>AdHoc attributes are attributes which are not defined by the class, and are

16381

not handled by the MyClass.<em>NON</em>ATTRS_CFG</p>

16382

</div>

16383

16384

16385

<p><strong>Default:</strong> undefined (false)</p>

16386

16387

16388

16389

16390

16391

</div>

16392

16393

16394

16395

<h3 class="name"><code>_buttonBinding</code></h3>

16396

<span class="type"><a href="../classes/EventHandle.html" class="crosslink">EventHandle</a></span>

16397

16398

16399

16400

16401

<span class="flag protected">protected</span>

16402

16403

16404

16405

16406

16407

16408

16409

16410

16411

16412

<p>

16413

16414

Defined in

16415

16416

16417

16418

16419

<a href="../files/uploader_js_uploader-html5.js.html#l41"><code>uploader/js/uploader-html5.js:41</code></a>

16420

16421

</p>

16422

16423

16424

16425

16426

</div>

16427

16428

16429

<p>Stored reference to the click event binding of the <code>Select Files</code>

16430

button.</p>

16431

</div>

16432

16433

16434

16435

16436

16437

16438

</div>

16439

16440

16441

16442

<h3 class="name"><code>_fileInputField</code></h3>

16443

16444

16445

16446

16447

16448

<span class="flag protected">protected</span>

16449

16450

16451

16452

16453

16454

16455

16456

16457

16458

16459

<p>

16460

16461

Defined in

16462

16463

16464

16465

16466

<a href="../files/uploader_js_uploader-html5.js.html#l31"><code>uploader/js/uploader-html5.js:31</code></a>

16467

16468

</p>

16469

16470

16471

16472

16473

</div>

16474

16475

16476

<p>Stored reference to the instance of the file input field used to

16477

initiate the file selection dialog.</p>

16478

</div>

16479

16480

16481

16482

16483

16484

16485

</div>

16486

16487

16488

16489

<h3 class="name"><code>_UI_ATTRS</code></h3>

16490

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>

16491

16492

16493

16494

16495

<span class="flag private">private</span>

16496

16497

16498

16499

16500

16501

16502

16503

16504

16505

<p>Inherited from

16506

<a href="../classes/Widget.html#property__UI_ATTRS">Widget</a>:

16507

16508

16509

16510

<a href="../files/widget_js_Widget.js.html#l1236"><code>widget/js/Widget.js:1236</code></a>

16511

16512

</p>

16513

16514

16515

16516

16517

</div>

16518

16519

16520

<p>The lists of UI attributes to bind and sync for widget's _bindUI and _syncUI implementations</p>

16521

</div>

16522

16523

16524

16525

16526

16527

16528

</div>

16529

16530

16531

16532

<h3 class="name"><code>ATTRS</code></h3>

16533

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>

16534

16535

16536

16537

16538

<span class="flag protected">protected</span>

16539

16540

16541

16542

16543

16544

<span class="flag static">static</span>

16545

16546

16547

16548

16549

16550

16551

<p>

16552

16553

Defined in

16554

16555

16556

16557

16558

<a href="../files/uploader_js_uploader-html5.js.html#l601"><code>uploader/js/uploader-html5.js:601</code></a>

16559

16560

</p>

16561

16562

16563

16564

16565

</div>

16566

16567

16568

<p>Static property used to define the default attribute configuration of

16569

the Widget.</p>

16570

</div>

16571

16572

16573

16574

16575

16576

16577

</div>

16578

16579

16580

16581

<h3 class="name"><code>BOUNDING_TEMPLATE</code></h3>

16582

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

16583

16584

16585

16586

16587

16588

16589

16590

16591

16592

16593

16594

16595

<p>Inherited from

16596

<a href="../classes/Widget.html#property_BOUNDING_TEMPLATE">Widget</a>:

16597

16598

16599

16600

<a href="../files/widget_js_Widget.js.html#l1132"><code>widget/js/Widget.js:1132</code></a>

16601

16602

</p>

16603

16604

16605

16606

16607

</div>

16608

16609

16610

<p>Property defining the markup template for bounding box.</p>

16611

</div>

16612

16613

16614

16615

16616

16617

16618

</div>

16619

16620

16621

16622

<h3 class="name"><code>CONTENT_TEMPLATE</code></h3>

16623

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

16624

16625

16626

16627

16628

16629

16630

16631

16632

16633

16634

16635

16636

<p>Inherited from

16637

<a href="../classes/Widget.html#property_CONTENT_TEMPLATE">Widget</a>:

16638

16639

16640

16641

<a href="../files/widget_js_Widget.js.html#l1122"><code>widget/js/Widget.js:1122</code></a>

16642

16643

</p>

16644

16645

16646

16647

16648

</div>

16649

16650

16651

<p>Property defining the markup template for content box. If your Widget doesn't

16652

need the dual boundingBox/contentBox structure, set CONTENT_TEMPLATE to null,

16653

and contentBox and boundingBox will both point to the same Node.</p>

16654

</div>

16655

16656

16657

16658

16659

16660

16661

</div>

16662

16663

16664

16665

<h3 class="name"><code>DEF_PARENT_NODE</code></h3>

16666

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a> | <a href="../classes/Node.html" class="crosslink">Node</a></span>

16667

16668

16669

16670

16671

16672

16673

16674

16675

16676

16677

16678

16679

<p>Inherited from

16680

<a href="../classes/Widget.html#property_DEF_PARENT_NODE">Widget</a>:

16681

16682

16683

16684

<a href="../files/widget_js_Widget.js.html#l1113"><code>widget/js/Widget.js:1113</code></a>

16685

16686

</p>

16687

16688

16689

16690

16691

</div>

16692

16693

16694

<p>Default node to render the bounding box to. If not set,

16695

will default to the current document body.</p>

16696

</div>

16697

16698

16699

16700

16701

16702

16703

</div>

16704

16705

16706

16707

16708

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

16709

16710

16711

16712

16713

16714

16715

16716

16717

16718

16719

16720

16721

<p>Inherited from

16722

<a href="../classes/Widget.html#property_DEF_UNIT">Widget</a>:

16723

16724

16725

16726

<a href="../files/widget_js_Widget.js.html#l1105"><code>widget/js/Widget.js:1105</code></a>

16727

16728

</p>

16729

16730

16731

16732

16733

</div>

16734

16735

16736

<p>Default unit to use for dimension values</p>

16737

</div>

16738

16739

16740

16741

16742

16743

16744

</div>

16745

16746

16747

16748

<h3 class="name"><code>HTML5FILEFIELD_TEMPLATE</code></h3>

16749

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

16750

16751

16752

16753

16754

16755

16756

16757

16758

<span class="flag static">static</span>

16759

16760

16761

16762

16763

16764

16765

<p>

16766

16767

Defined in

16768

16769

16770

16771

16772

<a href="../files/uploader_js_uploader-html5.js.html#l558"><code>uploader/js/uploader-html5.js:558</code></a>

16773

16774

</p>

16775

16776

16777

16778

16779

</div>

16780

16781

16782

<p>The template for the hidden file input field container. The file input field will only

16783

accept clicks if its visibility is set to hidden (and will not if it's <code>display</code> value

16784

is set to <code>none</code>)</p>

16785

</div>

16786

16787

16788

16789

16790

16791

16792

</div>

16793

16794

16795

16796

16797

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

16798

16799

16800

16801

16802

<span class="flag protected">protected</span>

16803

16804

16805

16806

16807

16808

<span class="flag static">static</span>

16809

16810

16811

16812

16813

16814

16815

<p>

16816

16817

Defined in

16818

16819

16820

16821

16822

<a href="../files/uploader_js_uploader-html5.js.html#l589"><code>uploader/js/uploader-html5.js:589</code></a>

16823

16824

</p>

16825

16826

16827

16828

16829

</div>

16830

16831

16832

<p>The identity of the widget.</p>

16833

</div>

16834

16835

16836

<p><strong>Default:</strong> 'uploader'</p>

16837

16838

16839

16840

16841

16842

</div>

16843

16844

16845

16846

16847

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

16848

16849

16850

<span class="flag deprecated" title="Use this.constructor.NAME">deprecated</span>

16851

16852

16853

16854

16855

16856

16857

16858

16859

16860

16861

16862

<p>Inherited from

16863

<a href="../classes/BaseCore.html#property_name">BaseCore</a>:

16864

16865

16866

16867

<a href="../files/base_js_BaseCore.js.html#l196"><code>base/js/BaseCore.js:196</code></a>

16868

16869

</p>

16870

16871

16872

<p>Deprecated: Use this.constructor.NAME</p>

16873

16874

16875

16876

</div>

16877

16878

16879

<p>The string used to identify the class of this object.</p>

16880

</div>

16881

16882

16883

16884

16885

16886

16887

</div>

16888

16889

16890

16891

<h3 class="name"><code>queue</code></h3>

16892

<span class="type">Y.Uploader.Queue</span>

16893

16894

16895

16896

16897

16898

16899

16900

16901

16902

16903

16904

16905

16906

<p>

16907

16908

Defined in

16909

16910

16911

16912

16913

<a href="../files/uploader_js_uploader-html5.js.html#l51"><code>uploader/js/uploader-html5.js:51</code></a>

16914

16915

</p>

16916

16917

16918

16919

16920

</div>

16921

16922

16923

<p>Stored reference to the instance of Uploader.Queue used to manage

16924

the upload process. This is a read-only property that only exists

16925

during an active upload process. Only one queue can be active at

16926

a time; if an upload start is attempted while a queue is active,

16927

it will be ignored.</p>

16928

</div>

16929

16930

16931

16932

16933

16934

16935

</div>

16936

16937

16938

16939

<h3 class="name"><code>SELECT_FILES_BUTTON</code></h3>

16940

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

16941

16942

16943

16944

16945

16946

16947

16948

16949

<span class="flag static">static</span>

16950

16951

16952

16953

16954

16955

16956

<p>

16957

16958

Defined in

16959

16960

16961

16962

16963

<a href="../files/uploader_js_uploader-html5.js.html#l569"><code>uploader/js/uploader-html5.js:569</code></a>

16964

16965

</p>

16966

16967

16968

16969

16970

</div>

16971

16972

16973

<p>The template for the "Select Files" button.</p>

16974

</div>

16975

16976

16977

<p><strong>Default:</strong> "<button type='button' class='yui3-button' role='button' aria-label='{selectButtonLabel}' tabindex='{tabIndex}'>{selectButtonLabel}</button>"</p>

16978

16979

16980

16981

16982

16983

</div>

16984

16985

16986

16987

16988

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

16989

16990

16991

16992

16993

16994

16995

16996

16997

<span class="flag static">static</span>

16998

16999

17000

17001

17002

17003

17004

<p>

17005

17006

Defined in

17007

17008

17009

17010

17011

<a href="../files/uploader_js_uploader-html5.js.html#l579"><code>uploader/js/uploader-html5.js:579</code></a>

17012

17013

</p>

17014

17015

17016

17017

17018

</div>

17019

17020

17021

<p>The static property reflecting the type of uploader that <code>Y.Uploader</code>

17022

aliases. The UploaderHTML5 value is <code>"html5"</code>.</p>

17023

</div>

17024

17025

17026

17027

17028

17029

17030

</div>

17031

17032

17033

17034

<h3 class="name"><code>UI_EVENTS</code></h3>

17035

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>

17036

17037

17038

17039

17040

17041

17042

17043

17044

17045

17046

17047

17048

<p>Inherited from

17049

<a href="../classes/Widget.html#property_UI_EVENTS">Widget</a>:

17050

17051

17052

17053

<a href="../files/widget_js_WidgetUIEvents.js.html#l52"><code>widget/js/WidgetUIEvents.js:52</code></a>

17054

17055

</p>

17056

17057

17058

17059

17060

</div>

17061

17062

17063

<p>Map of DOM events that should be fired as Custom Events by the

17064

Widget instance.</p>

17065

</div>

17066

17067

17068

17069

17070

17071

17072

</div>

17073

17074

17075

</div>

17076

17077

17078

17079

17080

<h2 class="off-left">Attributes</h2>

17081

17082

17083

17084

17085

<h3 class="name"><code>appendNewFiles</code></h3>

17086

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>

17087

17088

17089

17090

17091

17092

17093

17094

17095

17096

17097

17098

17099

17100

<p>

17101

17102

Defined in

17103

17104

17105

17106

17107

<a href="../files/uploader_js_uploader-html5.js.html#l612"><code>uploader/js/uploader-html5.js:612</code></a>

17108

17109

</p>

17110

17111

17112

17113

17114

</div>

17115

17116

17117

<p>A Boolean indicating whether newly selected files should be appended

17118

to the existing file list, or whether they should replace it.</p>

17119

</div>

17120

17121

17122

<p><strong>Default:</strong> true</p>

17123

17124

17125

17126

17127

<h4>Fires event <code>appendNewFilesChange</code></h4>

17128

17129

<p>

17130

Fires when the value for the configuration attribute <code>appendNewFiles</code> is

17131

changed. You can listen for the event using the <code>on</code> method if you

17132

wish to be notified before the attribute's value has changed, or

17133

using the <code>after</code> method if you wish to be notified after the

17134

attribute's value has changed.

17135

</p>

17136

17137

17138

<h4>Parameters:</h4>

17139

17140

17141

17142

17143

<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>

17144

17145

17146

An Event Facade object with the following

17147

attribute-specific properties added:

17148

</div>

17149

17150

17151

17152

<code class="param-name">prevVal</code>

17153

17154

<div class="param-description">The value of the attribute, prior to it being set.</div>

17155

</li>

17156

17157

<code class="param-name">newVal</code>

17158

17159

<div class="param-description">The value the attribute is to be set to.</div>

17160

</li>

17161

17162

<code class="param-name">attrName</code>

17163

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

17164

<div class="param-description">The name of the attribute being set.</div>

17165

</li>

17166

17167

<code class="param-name">subAttrName</code>

17168

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

17169

<div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div>

17170

</li>

17171

</ul>

17172

</li>

17173

</ul>

17174

</div>

17175

</div>

17176

17177

17178

17179

</div>

17180

17181

17182

17183

17184

<h3 class="name"><code>boundingBox</code></h3>

17185

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a> | <a href="../classes/Node.html" class="crosslink">Node</a></span>

17186

17187

17188

17189

17190

17191

17192

17193

17194

17195

17196

17197

17198

<p>Inherited from

17199

<a href="../classes/Widget.html#attr_boundingBox">Widget</a>:

17200

17201

17202

17203

<a href="../files/widget_js_Widget.js.html#l175"><code>widget/js/Widget.js:175</code></a>

17204

17205

</p>

17206

17207

17208

17209

17210

</div>

17211

17212

17213

<p>The outermost DOM node for the Widget, used for sizing and positioning

17214

of a Widget as well as a containing element for any decorator elements used

17215

for skinning.</p>

17216

</div>

17217

17218

17219

17220

17221

17222

<h4>Fires event <code>boundingBoxChange</code></h4>

17223

17224

<p>

17225

Fires when the value for the configuration attribute <code>boundingBox</code> is

17226

changed. You can listen for the event using the <code>on</code> method if you

17227

wish to be notified before the attribute's value has changed, or

17228

using the <code>after</code> method if you wish to be notified after the

17229

attribute's value has changed.

17230

</p>

17231

17232

17233

<h4>Parameters:</h4>

17234

17235

17236

17237

17238

<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>

17239

17240

17241

An Event Facade object with the following

17242

attribute-specific properties added:

17243

</div>

17244

17245

17246

17247

<code class="param-name">prevVal</code>

17248

17249

<div class="param-description">The value of the attribute, prior to it being set.</div>

17250

</li>

17251

17252

<code class="param-name">newVal</code>

17253

17254

<div class="param-description">The value the attribute is to be set to.</div>

17255

</li>

17256

17257

<code class="param-name">attrName</code>

17258

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

17259

<div class="param-description">The name of the attribute being set.</div>

17260

</li>

17261

17262

<code class="param-name">subAttrName</code>

17263

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

17264

<div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div>

17265

</li>

17266

</ul>

17267

</li>

17268

</ul>

17269

</div>

17270

</div>

17271

17272

17273

17274

</div>

17275

17276

17277

17278

17279

<h3 class="name"><code>buttonClassNames</code></h3>

17280

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>

17281

17282

17283

17284

17285

17286

17287

17288

17289

17290

17291

17292

17293

17294

<p>

17295

17296

Defined in

17297

17298

17299

17300

17301

<a href="../files/uploader_js_uploader-html5.js.html#l624"><code>uploader/js/uploader-html5.js:624</code></a>

17302

17303

</p>

17304

17305

17306

17307

17308

</div>

17309

17310

17311

<p>The names of CSS classes that correspond to different button states

17312

of the "Select Files" control. These classes are assigned to the

17313

"Select Files" control based on the configuration of the uploader.

17314

Currently, the only class name used is that corresponding to the

17315

<code>disabled</code> state of the uploader. Other button states should be managed

17316

directly via CSS selectors.</p>

17317

17318

<ul>

17319

<li> <strong><code>disabled</code></strong>: the class corresponding to the disabled state

17320

of the "Select Files" button.</li>

17321

</ul>

17322

</div>

17323

17324

17325

<p><strong>Default:</strong> {

17326

disabled: "yui3-button-disabled"

17327

}</p>

17328

17329

17330

17331

17332

<h4>Fires event <code>buttonClassNamesChange</code></h4>

17333

17334

<p>

17335

Fires when the value for the configuration attribute <code>buttonClassNames</code> is

17336

changed. You can listen for the event using the <code>on</code> method if you

17337

wish to be notified before the attribute's value has changed, or

17338

using the <code>after</code> method if you wish to be notified after the

17339

attribute's value has changed.

17340

</p>

17341

17342

17343

<h4>Parameters:</h4>

17344

17345

17346

17347

17348

<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>

17349

17350

17351

An Event Facade object with the following

17352

attribute-specific properties added:

17353

</div>

17354

17355

17356

17357

<code class="param-name">prevVal</code>

17358

17359

<div class="param-description">The value of the attribute, prior to it being set.</div>

17360

</li>

17361

17362

<code class="param-name">newVal</code>

17363

17364

<div class="param-description">The value the attribute is to be set to.</div>

17365

</li>

17366

17367

<code class="param-name">attrName</code>

17368

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

17369

<div class="param-description">The name of the attribute being set.</div>

17370

</li>

17371

17372

<code class="param-name">subAttrName</code>

17373

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

17374

<div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div>

17375

</li>

17376

</ul>

17377

</li>

17378

</ul>

17379

</div>

17380

</div>

17381

17382

17383

17384

</div>

17385

17386

17387

17388

17389

<h3 class="name"><code>contentBox</code></h3>

17390

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a> | <a href="../classes/Node.html" class="crosslink">Node</a></span>

17391

17392

17393

17394

17395

17396

17397

17398

17399

17400

17401

17402

17403

<p>Inherited from

17404

<a href="../classes/Widget.html#attr_contentBox">Widget</a>:

17405

17406

17407

17408

<a href="../files/widget_js_Widget.js.html#l189"><code>widget/js/Widget.js:189</code></a>

17409

17410

</p>

17411

17412

17413

17414

17415

</div>

17416

17417

17418

<p>A DOM node that is a direct descendant of a Widget's bounding box that

17419

houses its content.</p>

17420

</div>

17421

17422

17423

17424

17425

17426

<h4>Fires event <code>contentBoxChange</code></h4>

17427

17428

<p>

17429

Fires when the value for the configuration attribute <code>contentBox</code> is

17430

changed. You can listen for the event using the <code>on</code> method if you

17431

wish to be notified before the attribute's value has changed, or

17432

using the <code>after</code> method if you wish to be notified after the

17433

attribute's value has changed.

17434

</p>

17435

17436

17437

<h4>Parameters:</h4>

17438

17439

17440

17441

17442

<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>

17443

17444

17445

An Event Facade object with the following

17446

attribute-specific properties added:

17447

</div>

17448

17449

17450

17451

<code class="param-name">prevVal</code>

17452

17453

<div class="param-description">The value of the attribute, prior to it being set.</div>

17454

</li>

17455

17456

<code class="param-name">newVal</code>

17457

17458

<div class="param-description">The value the attribute is to be set to.</div>

17459

</li>

17460

17461

<code class="param-name">attrName</code>

17462

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

17463

<div class="param-description">The name of the attribute being set.</div>

17464

</li>

17465

17466

<code class="param-name">subAttrName</code>

17467

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

17468

<div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div>

17469

</li>

17470

</ul>

17471

</li>

17472

</ul>

17473

</div>

17474

</div>

17475

17476

17477

17478

</div>

17479

17480

17481

17482

17483

<h3 class="name"><code>destroyed</code></h3>

17484

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>

17485

17486

17487

17488

17489

17490

17491

17492

17493

17494

17495

17496

17497

<p>Inherited from

17498

<a href="../classes/BaseCore.html#attr_destroyed">BaseCore</a>:

17499

17500

17501

17502

<a href="../files/base_js_BaseCore.js.html#l157"><code>base/js/BaseCore.js:157</code></a>

17503

17504

</p>

17505

17506

17507

17508

17509

</div>

17510

17511

17512

<p>Flag indicating whether or not this object

17513

has been through the destroy lifecycle phase.</p>

17514

</div>

17515

17516

17517

<p><strong>Default:</strong> false</p>

17518

17519

17520

17521

17522

<h4>Fires event <code>destroyedChange</code></h4>

17523

17524

<p>

17525

Fires when the value for the configuration attribute <code>destroyed</code> is

17526

changed. You can listen for the event using the <code>on</code> method if you

17527

wish to be notified before the attribute's value has changed, or

17528

using the <code>after</code> method if you wish to be notified after the

17529

attribute's value has changed.

17530

</p>

17531

17532

17533

<h4>Parameters:</h4>

17534

17535

17536

17537

17538

<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>

17539

17540

17541

An Event Facade object with the following

17542

attribute-specific properties added:

17543

</div>

17544

17545

17546

17547

<code class="param-name">prevVal</code>

17548

17549

<div class="param-description">The value of the attribute, prior to it being set.</div>

17550

</li>

17551

17552

<code class="param-name">newVal</code>

17553

17554

<div class="param-description">The value the attribute is to be set to.</div>

17555

</li>

17556

17557

<code class="param-name">attrName</code>

17558

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

17559

<div class="param-description">The name of the attribute being set.</div>

17560

</li>

17561

17562

<code class="param-name">subAttrName</code>

17563

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

17564

<div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div>

17565

</li>

17566

</ul>

17567

</li>

17568

</ul>

17569

</div>

17570

</div>

17571

17572

17573

17574

</div>

17575

17576

17577

17578

17579

<h3 class="name"><code>disabled</code></h3>

17580

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>

17581

17582

17583

17584

17585

17586

17587

17588

17589

17590

17591

17592

17593

<p>Inherited from

17594

<a href="../classes/Widget.html#attr_disabled">Widget</a>:

17595

17596

17597

17598

<a href="../files/widget_js_Widget.js.html#l231"><code>widget/js/Widget.js:231</code></a>

17599

17600

</p>

17601

17602

17603

17604

17605

</div>

17606

17607

17608

<p>Boolean indicating if the Widget should be disabled. The disabled implementation

17609

is left to the specific classes extending widget.</p>

17610

</div>

17611

17612

17613

<p><strong>Default:</strong> false</p>

17614

17615

17616

17617

17618

<h4>Fires event <code>disabledChange</code></h4>

17619

17620

<p>

17621

Fires when the value for the configuration attribute <code>disabled</code> is

17622

changed. You can listen for the event using the <code>on</code> method if you

17623

wish to be notified before the attribute's value has changed, or

17624

using the <code>after</code> method if you wish to be notified after the

17625

attribute's value has changed.

17626

</p>

17627

17628

17629

<h4>Parameters:</h4>

17630

17631

17632

17633

17634

<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>

17635

17636

17637

An Event Facade object with the following

17638

attribute-specific properties added:

17639

</div>

17640

17641

17642

17643

<code class="param-name">prevVal</code>

17644

17645

<div class="param-description">The value of the attribute, prior to it being set.</div>

17646

</li>

17647

17648

<code class="param-name">newVal</code>

17649

17650

<div class="param-description">The value the attribute is to be set to.</div>

17651

</li>

17652

17653

<code class="param-name">attrName</code>

17654

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

17655

<div class="param-description">The name of the attribute being set.</div>

17656

</li>

17657

17658

<code class="param-name">subAttrName</code>

17659

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

17660

<div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div>

17661

</li>

17662

</ul>

17663

</li>

17664

</ul>

17665

</div>

17666

</div>

17667

17668

17669

17670

</div>

17671

17672

17673

17674

17675

<h3 class="name"><code>dragAndDropArea</code></h3>

17676

17677

17678

17679

17680

17681

17682

17683

17684

17685

17686

17687

17688

17689

17690

<p>

17691

17692

Defined in

17693

17694

17695

17696

17697

<a href="../files/uploader_js_uploader-html5.js.html#l650"><code>uploader/js/uploader-html5.js:650</code></a>

17698

17699

</p>

17700

17701

17702

17703

17704

</div>

17705

17706

17707

<p>The node that serves as the drop target for files.</p>

17708

</div>

17709

17710

17711

<p><strong>Default:</strong> null</p>

17712

17713

17714

17715

17716

<h4>Fires event <code>dragAndDropAreaChange</code></h4>

17717

17718

<p>

17719

Fires when the value for the configuration attribute <code>dragAndDropArea</code> is

17720

changed. You can listen for the event using the <code>on</code> method if you

17721

wish to be notified before the attribute's value has changed, or

17722

using the <code>after</code> method if you wish to be notified after the

17723

attribute's value has changed.

17724

</p>

17725

17726

17727

<h4>Parameters:</h4>

17728

17729

17730

17731

17732

<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>

17733

17734

17735

An Event Facade object with the following

17736

attribute-specific properties added:

17737

</div>

17738

17739

17740

17741

<code class="param-name">prevVal</code>

17742

17743

<div class="param-description">The value of the attribute, prior to it being set.</div>

17744

</li>

17745

17746

<code class="param-name">newVal</code>

17747

17748

<div class="param-description">The value the attribute is to be set to.</div>

17749

</li>

17750

17751

<code class="param-name">attrName</code>

17752

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

17753

<div class="param-description">The name of the attribute being set.</div>

17754

</li>

17755

17756

<code class="param-name">subAttrName</code>

17757

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

17758

<div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div>

17759

</li>

17760

</ul>

17761

</li>

17762

</ul>

17763

</div>

17764

</div>

17765

17766

17767

17768

</div>

17769

17770

17771

17772

17773

<h3 class="name"><code>enabled</code></h3>

17774

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>

17775

17776

17777

17778

17779

17780

17781

17782

17783

17784

17785

17786

17787

17788

<p>

17789

17790

Defined in

17791

17792

17793

17794

17795

<a href="../files/uploader_js_uploader-html5.js.html#l664"><code>uploader/js/uploader-html5.js:664</code></a>

17796

17797

</p>

17798

17799

17800

17801

17802

</div>

17803

17804

17805

<p>A Boolean indicating whether the uploader is enabled or disabled for user input.</p>

17806

</div>

17807

17808

17809

<p><strong>Default:</strong> true</p>

17810

17811

17812

17813

17814

<h4>Fires event <code>enabledChange</code></h4>

17815

17816

<p>

17817

Fires when the value for the configuration attribute <code>enabled</code> is

17818

changed. You can listen for the event using the <code>on</code> method if you

17819

wish to be notified before the attribute's value has changed, or

17820

using the <code>after</code> method if you wish to be notified after the

17821

attribute's value has changed.

17822

</p>

17823

17824

17825

<h4>Parameters:</h4>

17826

17827

17828

17829

17830

<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>

17831

17832

17833

An Event Facade object with the following

17834

attribute-specific properties added:

17835

</div>

17836

17837

17838

17839

<code class="param-name">prevVal</code>

17840

17841

<div class="param-description">The value of the attribute, prior to it being set.</div>

17842

</li>

17843

17844

<code class="param-name">newVal</code>

17845

17846

<div class="param-description">The value the attribute is to be set to.</div>

17847

</li>

17848

17849

<code class="param-name">attrName</code>

17850

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

17851

<div class="param-description">The name of the attribute being set.</div>

17852

</li>

17853

17854

<code class="param-name">subAttrName</code>

17855

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

17856

<div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div>

17857

</li>

17858

</ul>

17859

</li>

17860

</ul>

17861

</div>

17862

</div>

17863

17864

17865

17866

</div>

17867

17868

17869

17870

17871

<h3 class="name"><code>errorAction</code></h3>

17872

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

17873

17874

17875

17876

17877

17878

17879

17880

17881

17882

17883

17884

17885

17886

<p>

17887

17888

Defined in

17889

17890

17891

17892

17893

<a href="../files/uploader_js_uploader-html5.js.html#l675"><code>uploader/js/uploader-html5.js:675</code></a>

17894

17895

</p>

17896

17897

17898

17899

17900

</div>

17901

17902

17903

<p>The action performed when an upload error occurs for a specific file being uploaded.

17904

The possible values are: </p>

17905

17906

<ul>

17907

<li> <strong><code>UploaderQueue.CONTINUE</code></strong>: the error is ignored and the upload process is continued.</li>

17908

<li> <strong><code>UploaderQueue.STOP</code></strong>: the upload process is stopped as soon as any other parallel file

17909

uploads are finished.</li>

17910

<li> <strong><code>UploaderQueue.RESTART_ASAP</code></strong>: the file is added back to the front of the queue.</li>

17911

<li> <strong><code>UploaderQueue.RESTART_AFTER</code></strong>: the file is added to the back of the queue.</li>

17912

</ul>

17913

</div>

17914

17915

17916

<p><strong>Default:</strong> UploaderQueue.CONTINUE</p>

17917

17918

17919

17920

17921

<h4>Fires event <code>errorActionChange</code></h4>

17922

17923

<p>

17924

Fires when the value for the configuration attribute <code>errorAction</code> is

17925

changed. You can listen for the event using the <code>on</code> method if you

17926

wish to be notified before the attribute's value has changed, or

17927

using the <code>after</code> method if you wish to be notified after the

17928

attribute's value has changed.

17929

</p>

17930

17931

17932

<h4>Parameters:</h4>

17933

17934

17935

17936

17937

<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>

17938

17939

17940

An Event Facade object with the following

17941

attribute-specific properties added:

17942

</div>

17943

17944

17945

17946

<code class="param-name">prevVal</code>

17947

17948

<div class="param-description">The value of the attribute, prior to it being set.</div>

17949

</li>

17950

17951

<code class="param-name">newVal</code>

17952

17953

<div class="param-description">The value the attribute is to be set to.</div>

17954

</li>

17955

17956

<code class="param-name">attrName</code>

17957

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

17958

<div class="param-description">The name of the attribute being set.</div>

17959

</li>

17960

17961

<code class="param-name">subAttrName</code>

17962

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

17963

<div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div>

17964

</li>

17965

</ul>

17966

</li>

17967

</ul>

17968

</div>

17969

</div>

17970

17971

17972

17973

</div>

17974

17975

17976

17977

17978

<h3 class="name"><code>fileFieldName</code></h3>

17979

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

17980

17981

17982

17983

17984

17985

17986

17987

17988

17989

17990

17991

17992

17993

<p>

17994

17995

Defined in

17996

17997

17998

17999

18000

<a href="../files/uploader_js_uploader-html5.js.html#l695"><code>uploader/js/uploader-html5.js:695</code></a>

18001

18002

</p>

18003

18004

18005

18006

18007

</div>

18008

18009

18010

<p>A String specifying what should be the POST field name for the file

18011

content in the upload request.</p>

18012

</div>

18013

18014

18015

<p><strong>Default:</strong> Filedata</p>

18016

18017

18018

18019

18020

<h4>Fires event <code>fileFieldNameChange</code></h4>

18021

18022

<p>

18023

Fires when the value for the configuration attribute <code>fileFieldName</code> is

18024

changed. You can listen for the event using the <code>on</code> method if you

18025

wish to be notified before the attribute's value has changed, or

18026

using the <code>after</code> method if you wish to be notified after the

18027

attribute's value has changed.

18028

</p>

18029

18030

18031

<h4>Parameters:</h4>

18032

18033

18034

18035

18036

<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>

18037

18038

18039

An Event Facade object with the following

18040

attribute-specific properties added:

18041

</div>

18042

18043

18044

18045

<code class="param-name">prevVal</code>

18046

18047

<div class="param-description">The value of the attribute, prior to it being set.</div>

18048

</li>

18049

18050

<code class="param-name">newVal</code>

18051

18052

<div class="param-description">The value the attribute is to be set to.</div>

18053

</li>

18054

18055

<code class="param-name">attrName</code>

18056

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

18057

<div class="param-description">The name of the attribute being set.</div>

18058

</li>

18059

18060

<code class="param-name">subAttrName</code>

18061

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

18062

<div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div>

18063

</li>

18064

</ul>

18065

</li>

18066

</ul>

18067

</div>

18068

</div>

18069

18070

18071

18072

</div>

18073

18074

18075

18076

18077

<h3 class="name"><code>fileList</code></h3>

18078

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Array" class="crosslink external" target="_blank">Array</a></span>

18079

18080

18081

18082

18083

18084

18085

18086

18087

18088

18089

18090

18091

18092

<p>

18093

18094

Defined in

18095

18096

18097

18098

18099

<a href="../files/uploader_js_uploader-html5.js.html#l707"><code>uploader/js/uploader-html5.js:707</code></a>

18100

18101

</p>

18102

18103

18104

18105

18106

</div>

18107

18108

18109

<p>The array of files to be uploaded. All elements in the array

18110

must be instances of <code>Y.File</code> and be instantiated with an instance

18111

of native JavaScript File() class.</p>

18112

</div>

18113

18114

18115

<p><strong>Default:</strong> []</p>

18116

18117

18118

18119

18120

<h4>Fires event <code>fileListChange</code></h4>

18121

18122

<p>

18123

Fires when the value for the configuration attribute <code>fileList</code> is

18124

changed. You can listen for the event using the <code>on</code> method if you

18125

wish to be notified before the attribute's value has changed, or

18126

using the <code>after</code> method if you wish to be notified after the

18127

attribute's value has changed.

18128

</p>

18129

18130

18131

<h4>Parameters:</h4>

18132

18133

18134

18135

18136

<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>

18137

18138

18139

An Event Facade object with the following

18140

attribute-specific properties added:

18141

</div>

18142

18143

18144

18145

<code class="param-name">prevVal</code>

18146

18147

<div class="param-description">The value of the attribute, prior to it being set.</div>

18148

</li>

18149

18150

<code class="param-name">newVal</code>

18151

18152

<div class="param-description">The value the attribute is to be set to.</div>

18153

</li>

18154

18155

<code class="param-name">attrName</code>

18156

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

18157

<div class="param-description">The name of the attribute being set.</div>

18158

</li>

18159

18160

<code class="param-name">subAttrName</code>

18161

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

18162

<div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div>

18163

</li>

18164

</ul>

18165

</li>

18166

</ul>

18167

</div>

18168

</div>

18169

18170

18171

18172

</div>

18173

18174

18175

18176

18177

<h3 class="name"><code>focused</code></h3>

18178

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>

18179

18180

18181

18182

18183

18184

18185

18186

18187

18188

18189

18190

18191

<p>Inherited from

18192

<a href="../classes/Widget.html#attr_focused">Widget</a>:

18193

18194

18195

18196

<a href="../files/widget_js_Widget.js.html#l218"><code>widget/js/Widget.js:218</code></a>

18197

18198

</p>

18199

18200

18201

18202

18203

</div>

18204

18205

18206

<p>Boolean indicating if the Widget, or one of its descendants,

18207

has focus.</p>

18208

</div>

18209

18210

18211

<p><strong>Default:</strong> false</p>

18212

18213

18214

18215

18216

<h4>Fires event <code>focusedChange</code></h4>

18217

18218

<p>

18219

Fires when the value for the configuration attribute <code>focused</code> is

18220

changed. You can listen for the event using the <code>on</code> method if you

18221

wish to be notified before the attribute's value has changed, or

18222

using the <code>after</code> method if you wish to be notified after the

18223

attribute's value has changed.

18224

</p>

18225

18226

18227

<h4>Parameters:</h4>

18228

18229

18230

18231

18232

<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>

18233

18234

18235

An Event Facade object with the following

18236

attribute-specific properties added:

18237

</div>

18238

18239

18240

18241

<code class="param-name">prevVal</code>

18242

18243

<div class="param-description">The value of the attribute, prior to it being set.</div>

18244

</li>

18245

18246

<code class="param-name">newVal</code>

18247

18248

<div class="param-description">The value the attribute is to be set to.</div>

18249

</li>

18250

18251

<code class="param-name">attrName</code>

18252

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

18253

<div class="param-description">The name of the attribute being set.</div>

18254

</li>

18255

18256

<code class="param-name">subAttrName</code>

18257

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

18258

<div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div>

18259

</li>

18260

</ul>

18261

</li>

18262

</ul>

18263

</div>

18264

</div>

18265

18266

18267

18268

</div>

18269

18270

18271

18272

18273

<h3 class="name"><code>height</code></h3>

18274

18275

18276

18277

18278

18279

18280

18281

18282

18283

18284

18285

18286

18287

<p>Inherited from

18288

<a href="../classes/Widget.html#attr_height">Widget</a>:

18289

18290

18291

18292

<a href="../files/widget_js_Widget.js.html#l252"><code>widget/js/Widget.js:252</code></a>

18293

18294

</p>

18295

18296

18297

18298

18299

</div>

18300

18301

18302

<p>String with units, or number, representing the height of the Widget. If a number is provided,

18303

the default unit, defined by the Widgets DEF_UNIT, property is used.</p>

18304

</div>

18305

18306

18307

<p><strong>Default:</strong> EMPTY_STR</p>

18308

18309

18310

18311

18312

<h4>Fires event <code>heightChange</code></h4>

18313

18314

<p>

18315

Fires when the value for the configuration attribute <code>height</code> is

18316

changed. You can listen for the event using the <code>on</code> method if you

18317

wish to be notified before the attribute's value has changed, or

18318

using the <code>after</code> method if you wish to be notified after the

18319

attribute's value has changed.

18320

</p>

18321

18322

18323

<h4>Parameters:</h4>

18324

18325

18326

18327

18328

<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>

18329

18330

18331

An Event Facade object with the following

18332

attribute-specific properties added:

18333

</div>

18334

18335

18336

18337

<code class="param-name">prevVal</code>

18338

18339

<div class="param-description">The value of the attribute, prior to it being set.</div>

18340

</li>

18341

18342

<code class="param-name">newVal</code>

18343

18344

<div class="param-description">The value the attribute is to be set to.</div>

18345

</li>

18346

18347

<code class="param-name">attrName</code>

18348

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

18349

<div class="param-description">The name of the attribute being set.</div>

18350

</li>

18351

18352

<code class="param-name">subAttrName</code>

18353

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

18354

<div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div>

18355

</li>

18356

</ul>

18357

</li>

18358

</ul>

18359

</div>

18360

</div>

18361

18362

18363

18364

</div>

18365

18366

18367

18368

18369

18370

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

18371

18372

18373

18374

18375

18376

18377

18378

18379

18380

18381

18382

18383

<p>Inherited from

18384

<a href="../classes/Widget.html#attr_id">Widget</a>:

18385

18386

18387

18388

<a href="../files/widget_js_Widget.js.html#l149"><code>widget/js/Widget.js:149</code></a>

18389

18390

</p>

18391

18392

18393

18394

18395

</div>

18396

18397

18398

18399

</div>

18400

18401

18402

<p><strong>Default:</strong> Generated using guid()</p>

18403

18404

18405

18406

18407

<h4>Fires event <code>idChange</code></h4>

18408

18409

<p>

18410

Fires when the value for the configuration attribute <code>id</code> is

18411

changed. You can listen for the event using the <code>on</code> method if you

18412

wish to be notified before the attribute's value has changed, or

18413

using the <code>after</code> method if you wish to be notified after the

18414

attribute's value has changed.

18415

</p>

18416

18417

18418

<h4>Parameters:</h4>

18419

18420

18421

18422

18423

<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>

18424

18425

18426

An Event Facade object with the following

18427

attribute-specific properties added:

18428

</div>

18429

18430

18431

18432

<code class="param-name">prevVal</code>

18433

18434

<div class="param-description">The value of the attribute, prior to it being set.</div>

18435

</li>

18436

18437

<code class="param-name">newVal</code>

18438

18439

<div class="param-description">The value the attribute is to be set to.</div>

18440

</li>

18441

18442

<code class="param-name">attrName</code>

18443

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

18444

<div class="param-description">The name of the attribute being set.</div>

18445

</li>

18446

18447

<code class="param-name">subAttrName</code>

18448

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

18449

<div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div>

18450

</li>

18451

</ul>

18452

</li>

18453

</ul>

18454

</div>

18455

</div>

18456

18457

18458

18459

</div>

18460

18461

18462

18463

18464

<h3 class="name"><code>initialized</code></h3>

18465

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>

18466

18467

18468

18469

18470

18471

18472

18473

18474

18475

18476

18477

18478

<p>Inherited from

18479

<a href="../classes/BaseCore.html#attr_initialized">BaseCore</a>:

18480

18481

18482

18483

<a href="../files/base_js_BaseCore.js.html#l143"><code>base/js/BaseCore.js:143</code></a>

18484

18485

</p>

18486

18487

18488

18489

18490

</div>

18491

18492

18493

<p>Flag indicating whether or not this object

18494

has been through the init lifecycle phase.</p>

18495

</div>

18496

18497

18498

<p><strong>Default:</strong> false</p>

18499

18500

18501

18502

18503

<h4>Fires event <code>initializedChange</code></h4>

18504

18505

<p>

18506

Fires when the value for the configuration attribute <code>initialized</code> is

18507

changed. You can listen for the event using the <code>on</code> method if you

18508

wish to be notified before the attribute's value has changed, or

18509

using the <code>after</code> method if you wish to be notified after the

18510

attribute's value has changed.

18511

</p>

18512

18513

18514

<h4>Parameters:</h4>

18515

18516

18517

18518

18519

<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>

18520

18521

18522

An Event Facade object with the following

18523

attribute-specific properties added:

18524

</div>

18525

18526

18527

18528

<code class="param-name">prevVal</code>

18529

18530

<div class="param-description">The value of the attribute, prior to it being set.</div>

18531

</li>

18532

18533

<code class="param-name">newVal</code>

18534

18535

<div class="param-description">The value the attribute is to be set to.</div>

18536

</li>

18537

18538

<code class="param-name">attrName</code>

18539

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

18540

<div class="param-description">The name of the attribute being set.</div>

18541

</li>

18542

18543

<code class="param-name">subAttrName</code>

18544

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

18545

<div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div>

18546

</li>

18547

</ul>

18548

</li>

18549

</ul>

18550

</div>

18551

</div>

18552

18553

18554

18555

</div>

18556

18557

18558

18559

18560

<h3 class="name"><code>locale</code></h3>

18561

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

18562

18563

18564

<span class="flag deprecated" title="Use Y.config.lang and Y.Intl externalization support">deprecated</span>

18565

18566

18567

18568

18569

18570

18571

18572

18573

18574

18575

18576

<p>Inherited from

18577

<a href="../classes/Widget.html#attr_locale">Widget</a>:

18578

18579

18580

18581

<a href="../files/widget_js_WidgetLocale.js.html#l14"><code>widget/js/WidgetLocale.js:14</code></a>

18582

18583

</p>

18584

18585

18586

<p>Deprecated: Use Y.config.lang and Y.Intl externalization support</p>

18587

18588

18589

18590

</div>

18591

18592

18593

<p>The default locale for the widget. NOTE: Using get/set on the "strings" attribute will

18594

return/set strings for this locale.</p>

18595

</div>

18596

18597

18598

<p><strong>Default:</strong> "en"</p>

18599

18600

18601

18602

18603

<h4>Fires event <code>localeChange</code></h4>

18604

18605

<p>

18606

Fires when the value for the configuration attribute <code>locale</code> is

18607

changed. You can listen for the event using the <code>on</code> method if you

18608

wish to be notified before the attribute's value has changed, or

18609

using the <code>after</code> method if you wish to be notified after the

18610

attribute's value has changed.

18611

</p>

18612

18613

18614

<h4>Parameters:</h4>

18615

18616

18617

18618

18619

<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>

18620

18621

18622

An Event Facade object with the following

18623

attribute-specific properties added:

18624

</div>

18625

18626

18627

18628

<code class="param-name">prevVal</code>

18629

18630

<div class="param-description">The value of the attribute, prior to it being set.</div>

18631

</li>

18632

18633

<code class="param-name">newVal</code>

18634

18635

<div class="param-description">The value the attribute is to be set to.</div>

18636

</li>

18637

18638

<code class="param-name">attrName</code>

18639

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

18640

<div class="param-description">The name of the attribute being set.</div>

18641

</li>

18642

18643

<code class="param-name">subAttrName</code>

18644

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

18645

<div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div>

18646

</li>

18647

</ul>

18648

</li>

18649

</ul>

18650

</div>

18651

</div>

18652

18653

18654

18655

</div>

18656

18657

18658

18659

18660

<h3 class="name"><code>multipleFiles</code></h3>

18661

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>

18662

18663

18664

18665

18666

18667

18668

18669

18670

18671

18672

18673

18674

18675

<p>

18676

18677

Defined in

18678

18679

18680

18681

18682

<a href="../files/uploader_js_uploader-html5.js.html#l720"><code>uploader/js/uploader-html5.js:720</code></a>

18683

18684

</p>

18685

18686

18687

18688

18689

</div>

18690

18691

18692

<p>A Boolean indicating whether multiple file selection is enabled.</p>

18693

</div>

18694

18695

18696

<p><strong>Default:</strong> false</p>

18697

18698

18699

18700

18701

<h4>Fires event <code>multipleFilesChange</code></h4>

18702

18703

<p>

18704

Fires when the value for the configuration attribute <code>multipleFiles</code> is

18705

changed. You can listen for the event using the <code>on</code> method if you

18706

wish to be notified before the attribute's value has changed, or

18707

using the <code>after</code> method if you wish to be notified after the

18708

attribute's value has changed.

18709

</p>

18710

18711

18712

<h4>Parameters:</h4>

18713

18714

18715

18716

18717

<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>

18718

18719

18720

An Event Facade object with the following

18721

attribute-specific properties added:

18722

</div>

18723

18724

18725

18726

<code class="param-name">prevVal</code>

18727

18728

<div class="param-description">The value of the attribute, prior to it being set.</div>

18729

</li>

18730

18731

<code class="param-name">newVal</code>

18732

18733

<div class="param-description">The value the attribute is to be set to.</div>

18734

</li>

18735

18736

<code class="param-name">attrName</code>

18737

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

18738

<div class="param-description">The name of the attribute being set.</div>

18739

</li>

18740

18741

<code class="param-name">subAttrName</code>

18742

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

18743

<div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div>

18744

</li>

18745

</ul>

18746

</li>

18747

</ul>

18748

</div>

18749

</div>

18750

18751

18752

18753

</div>

18754

18755

18756

18757

18758

<h3 class="name"><code>postVarsPerFile</code></h3>

18759

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>

18760

18761

18762

18763

18764

18765

18766

18767

18768

18769

18770

18771

18772

18773

<p>

18774

18775

Defined in

18776

18777

18778

18779

18780

<a href="../files/uploader_js_uploader-html5.js.html#l731"><code>uploader/js/uploader-html5.js:731</code></a>

18781

18782

</p>

18783

18784

18785

18786

18787

</div>

18788

18789

18790

<p>An object, keyed by <code>fileId</code>, containing sets of key-value pairs

18791

that should be passed as POST variables along with each corresponding

18792

file. This attribute is only used if no POST variables are specifed

18793

in the upload method call.</p>

18794

</div>

18795

18796

18797

<p><strong>Default:</strong> {}</p>

18798

18799

18800

18801

18802

<h4>Fires event <code>postVarsPerFileChange</code></h4>

18803

18804

<p>

18805

Fires when the value for the configuration attribute <code>postVarsPerFile</code> is

18806

changed. You can listen for the event using the <code>on</code> method if you

18807

wish to be notified before the attribute's value has changed, or

18808

using the <code>after</code> method if you wish to be notified after the

18809

attribute's value has changed.

18810

</p>

18811

18812

18813

<h4>Parameters:</h4>

18814

18815

18816

18817

18818

<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>

18819

18820

18821

An Event Facade object with the following

18822

attribute-specific properties added:

18823

</div>

18824

18825

18826

18827

<code class="param-name">prevVal</code>

18828

18829

<div class="param-description">The value of the attribute, prior to it being set.</div>

18830

</li>

18831

18832

<code class="param-name">newVal</code>

18833

18834

<div class="param-description">The value the attribute is to be set to.</div>

18835

</li>

18836

18837

<code class="param-name">attrName</code>

18838

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

18839

<div class="param-description">The name of the attribute being set.</div>

18840

</li>

18841

18842

<code class="param-name">subAttrName</code>

18843

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

18844

<div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div>

18845

</li>

18846

</ul>

18847

</li>

18848

</ul>

18849

</div>

18850

</div>

18851

18852

18853

18854

</div>

18855

18856

18857

18858

18859

<h3 class="name"><code>render</code></h3>

18860

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a> | <a href="../classes/Node.html" class="crosslink">Node</a></span>

18861

18862

18863

18864

18865

18866

18867

18868

18869

18870

18871

18872

18873

<p>Inherited from

18874

<a href="../classes/Widget.html#attr_render">Widget</a>:

18875

18876

18877

18878

<a href="../files/widget_js_Widget.js.html#l286"><code>widget/js/Widget.js:286</code></a>

18879

18880

</p>

18881

18882

18883

18884

18885

</div>

18886

18887

18888

<p>Whether or not to render the widget automatically after init, and optionally, to which parent node.</p>

18889

</div>

18890

18891

18892

18893

18894

18895

<h4>Fires event <code>renderChange</code></h4>

18896

18897

<p>

18898

Fires when the value for the configuration attribute <code>render</code> is

18899

changed. You can listen for the event using the <code>on</code> method if you

18900

wish to be notified before the attribute's value has changed, or

18901

using the <code>after</code> method if you wish to be notified after the

18902

attribute's value has changed.

18903

</p>

18904

18905

18906

<h4>Parameters:</h4>

18907

18908

18909

18910

18911

<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>

18912

18913

18914

An Event Facade object with the following

18915

attribute-specific properties added:

18916

</div>

18917

18918

18919

18920

<code class="param-name">prevVal</code>

18921

18922

<div class="param-description">The value of the attribute, prior to it being set.</div>

18923

</li>

18924

18925

<code class="param-name">newVal</code>

18926

18927

<div class="param-description">The value the attribute is to be set to.</div>

18928

</li>

18929

18930

<code class="param-name">attrName</code>

18931

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

18932

<div class="param-description">The name of the attribute being set.</div>

18933

</li>

18934

18935

<code class="param-name">subAttrName</code>

18936

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

18937

<div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div>

18938

</li>

18939

</ul>

18940

</li>

18941

</ul>

18942

</div>

18943

</div>

18944

18945

18946

18947

</div>

18948

18949

18950

18951

18952

<h3 class="name"><code>rendered</code></h3>

18953

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>

18954

18955

18956

18957

18958

18959

18960

18961

18962

18963

18964

18965

18966

<p>Inherited from

18967

<a href="../classes/Widget.html#attr_rendered">Widget</a>:

18968

18969

18970

18971

<a href="../files/widget_js_Widget.js.html#l161"><code>widget/js/Widget.js:161</code></a>

18972

18973

</p>

18974

18975

18976

18977

18978

</div>

18979

18980

18981

<p>Flag indicating whether or not this Widget

18982

has been through the render lifecycle phase.</p>

18983

</div>

18984

18985

18986

<p><strong>Default:</strong> false</p>

18987

18988

18989

18990

18991

<h4>Fires event <code>renderedChange</code></h4>

18992

18993

<p>

18994

Fires when the value for the configuration attribute <code>rendered</code> is

18995

changed. You can listen for the event using the <code>on</code> method if you

18996

wish to be notified before the attribute's value has changed, or

18997

using the <code>after</code> method if you wish to be notified after the

18998

attribute's value has changed.

18999

</p>

19000

19001

19002

<h4>Parameters:</h4>

19003

19004

19005

19006

19007

<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>

19008

19009

19010

An Event Facade object with the following

19011

attribute-specific properties added:

19012

</div>

19013

19014

19015

19016

<code class="param-name">prevVal</code>

19017

19018

<div class="param-description">The value of the attribute, prior to it being set.</div>

19019

</li>

19020

19021

<code class="param-name">newVal</code>

19022

19023

<div class="param-description">The value the attribute is to be set to.</div>

19024

</li>

19025

19026

<code class="param-name">attrName</code>

19027

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

19028

<div class="param-description">The name of the attribute being set.</div>

19029

</li>

19030

19031

<code class="param-name">subAttrName</code>

19032

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

19033

<div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div>

19034

</li>

19035

</ul>

19036

</li>

19037

</ul>

19038

</div>

19039

</div>

19040

19041

19042

19043

</div>

19044

19045

19046

19047

19048

<h3 class="name"><code>selectButtonLabel</code></h3>

19049

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

19050

19051

19052

19053

19054

19055

19056

19057

19058

19059

19060

19061

19062

19063

<p>

19064

19065

Defined in

19066

19067

19068

19069

19070

<a href="../files/uploader_js_uploader-html5.js.html#l745"><code>uploader/js/uploader-html5.js:745</code></a>

19071

19072

</p>

19073

19074

19075

19076

19077

</div>

19078

19079

19080

<p>The label for the "Select Files" widget. This is the value that replaces the

19081

<code>{selectButtonLabel}</code> token in the <code>SELECT_FILES_BUTTON</code> template.</p>

19082

</div>

19083

19084

19085

<p><strong>Default:</strong> "Select Files"</p>

19086

19087

19088

19089

19090

<h4>Fires event <code>selectButtonLabelChange</code></h4>

19091

19092

<p>

19093

Fires when the value for the configuration attribute <code>selectButtonLabel</code> is

19094

changed. You can listen for the event using the <code>on</code> method if you

19095

wish to be notified before the attribute's value has changed, or

19096

using the <code>after</code> method if you wish to be notified after the

19097

attribute's value has changed.

19098

</p>

19099

19100

19101

<h4>Parameters:</h4>

19102

19103

19104

19105

19106

<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>

19107

19108

19109

An Event Facade object with the following

19110

attribute-specific properties added:

19111

</div>

19112

19113

19114

19115

<code class="param-name">prevVal</code>

19116

19117

<div class="param-description">The value of the attribute, prior to it being set.</div>

19118

</li>

19119

19120

<code class="param-name">newVal</code>

19121

19122

<div class="param-description">The value the attribute is to be set to.</div>

19123

</li>

19124

19125

<code class="param-name">attrName</code>

19126

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

19127

<div class="param-description">The name of the attribute being set.</div>

19128

</li>

19129

19130

<code class="param-name">subAttrName</code>

19131

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

19132

<div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div>

19133

</li>

19134

</ul>

19135

</li>

19136

</ul>

19137

</div>

19138

</div>

19139

19140

19141

19142

</div>

19143

19144

19145

19146

19147

<h3 class="name"><code>selectFilesButton</code></h3>

19148

<span class="type"><a href="../classes/Node.html" class="crosslink">Node</a> | <a href="../classes/Widget.html" class="crosslink">Widget</a></span>

19149

19150

19151

19152

19153

19154

19155

19156

19157

19158

19159

19160

19161

19162

<p>

19163

19164

Defined in

19165

19166

19167

19168

19169

<a href="../files/uploader_js_uploader-html5.js.html#l757"><code>uploader/js/uploader-html5.js:757</code></a>

19170

19171

</p>

19172

19173

19174

19175

19176

</div>

19177

19178

19179

<p>The widget that serves as the "Select Files control for the file uploader</p>

19180

</div>

19181

19182

19183

<p><strong>Default:</strong> A standard HTML button with YUI CSS Button skin.</p>

19184

19185

19186

19187

19188

<h4>Fires event <code>selectFilesButtonChange</code></h4>

19189

19190

<p>

19191

Fires when the value for the configuration attribute <code>selectFilesButton</code> is

19192

changed. You can listen for the event using the <code>on</code> method if you

19193

wish to be notified before the attribute's value has changed, or

19194

using the <code>after</code> method if you wish to be notified after the

19195

attribute's value has changed.

19196

</p>

19197

19198

19199

<h4>Parameters:</h4>

19200

19201

19202

19203

19204

<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>

19205

19206

19207

An Event Facade object with the following

19208

attribute-specific properties added:

19209

</div>

19210

19211

19212

19213

<code class="param-name">prevVal</code>

19214

19215

<div class="param-description">The value of the attribute, prior to it being set.</div>

19216

</li>

19217

19218

<code class="param-name">newVal</code>

19219

19220

<div class="param-description">The value the attribute is to be set to.</div>

19221

</li>

19222

19223

<code class="param-name">attrName</code>

19224

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

19225

<div class="param-description">The name of the attribute being set.</div>

19226

</li>

19227

19228

<code class="param-name">subAttrName</code>

19229

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

19230

<div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div>

19231

</li>

19232

</ul>

19233

</li>

19234

</ul>

19235

</div>

19236

</div>

19237

19238

19239

19240

</div>

19241

19242

19243

19244

19245

<h3 class="name"><code>simLimit</code></h3>

19246

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Number" class="crosslink external" target="_blank">Number</a></span>

19247

19248

19249

19250

19251

19252

19253

19254

19255

19256

19257

19258

19259

19260

<p>

19261

19262

Defined in

19263

19264

19265

19266

19267

<a href="../files/uploader_js_uploader-html5.js.html#l772"><code>uploader/js/uploader-html5.js:772</code></a>

19268

19269

</p>

19270

19271

19272

19273

19274

</div>

19275

19276

19277

<p>The number of files that can be uploaded

19278

simultaneously if the automatic queue management

19279

is used. This value can be in the range between 2

19280

and 5.</p>

19281

</div>

19282

19283

19284

<p><strong>Default:</strong> 2</p>

19285

19286

19287

19288

19289

<h4>Fires event <code>simLimitChange</code></h4>

19290

19291

<p>

19292

Fires when the value for the configuration attribute <code>simLimit</code> is

19293

changed. You can listen for the event using the <code>on</code> method if you

19294

wish to be notified before the attribute's value has changed, or

19295

using the <code>after</code> method if you wish to be notified after the

19296

attribute's value has changed.

19297

</p>

19298

19299

19300

<h4>Parameters:</h4>

19301

19302

19303

19304

19305

<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>

19306

19307

19308

An Event Facade object with the following

19309

attribute-specific properties added:

19310

</div>

19311

19312

19313

19314

<code class="param-name">prevVal</code>

19315

19316

<div class="param-description">The value of the attribute, prior to it being set.</div>

19317

</li>

19318

19319

<code class="param-name">newVal</code>

19320

19321

<div class="param-description">The value the attribute is to be set to.</div>

19322

</li>

19323

19324

<code class="param-name">attrName</code>

19325

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

19326

<div class="param-description">The name of the attribute being set.</div>

19327

</li>

19328

19329

<code class="param-name">subAttrName</code>

19330

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

19331

<div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div>

19332

</li>

19333

</ul>

19334

</li>

19335

</ul>

19336

</div>

19337

</div>

19338

19339

19340

19341

</div>

19342

19343

19344

19345

19346

<h3 class="name"><code>srcNode</code></h3>

19347

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a> | <a href="../classes/Node.html" class="crosslink">Node</a></span>

19348

19349

19350

19351

19352

19353

19354

19355

19356

19357

19358

19359

19360

<p>Inherited from

19361

<a href="../classes/Widget.html#attr_srcNode">Widget</a>:

19362

19363

19364

19365

<a href="../files/widget_js_WidgetHTMLParser.js.html#l59"><code>widget/js/WidgetHTMLParser.js:59</code></a>

19366

19367

</p>

19368

19369

19370

19371

19372

</div>

19373

19374

19375

<p>The DOM node to parse for configuration values, passed to the Widget's HTML_PARSER definition</p>

19376

</div>

19377

19378

19379

19380

19381

19382

<h4>Fires event <code>srcNodeChange</code></h4>

19383

19384

<p>

19385

Fires when the value for the configuration attribute <code>srcNode</code> is

19386

changed. You can listen for the event using the <code>on</code> method if you

19387

wish to be notified before the attribute's value has changed, or

19388

using the <code>after</code> method if you wish to be notified after the

19389

attribute's value has changed.

19390

</p>

19391

19392

19393

<h4>Parameters:</h4>

19394

19395

19396

19397

19398

<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>

19399

19400

19401

An Event Facade object with the following

19402

attribute-specific properties added:

19403

</div>

19404

19405

19406

19407

<code class="param-name">prevVal</code>

19408

19409

<div class="param-description">The value of the attribute, prior to it being set.</div>

19410

</li>

19411

19412

<code class="param-name">newVal</code>

19413

19414

<div class="param-description">The value the attribute is to be set to.</div>

19415

</li>

19416

19417

<code class="param-name">attrName</code>

19418

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

19419

<div class="param-description">The name of the attribute being set.</div>

19420

</li>

19421

19422

<code class="param-name">subAttrName</code>

19423

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

19424

<div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div>

19425

</li>

19426

</ul>

19427

</li>

19428

</ul>

19429

</div>

19430

</div>

19431

19432

19433

19434

</div>

19435

19436

19437

19438

19439

<h3 class="name"><code>strings</code></h3>

19440

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>

19441

19442

19443

19444

19445

19446

19447

19448

19449

19450

19451

19452

19453

<p>Inherited from

19454

<a href="../classes/Widget.html#attr_strings">Widget</a>:

19455

19456

19457

19458

<a href="../files/widget_js_Widget.js.html#l274"><code>widget/js/Widget.js:274</code></a>

19459

19460

</p>

19461

19462

19463

19464

19465

</div>

19466

19467

19468

<p>Collection of strings used to label elements of the Widget's UI.</p>

19469

</div>

19470

19471

19472

<p><strong>Default:</strong> null</p>

19473

19474

19475

19476

19477

<h4>Fires event <code>stringsChange</code></h4>

19478

19479

<p>

19480

Fires when the value for the configuration attribute <code>strings</code> is

19481

changed. You can listen for the event using the <code>on</code> method if you

19482

wish to be notified before the attribute's value has changed, or

19483

using the <code>after</code> method if you wish to be notified after the

19484

attribute's value has changed.

19485

</p>

19486

19487

19488

<h4>Parameters:</h4>

19489

19490

19491

19492

19493

<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>

19494

19495

19496

An Event Facade object with the following

19497

attribute-specific properties added:

19498

</div>

19499

19500

19501

19502

<code class="param-name">prevVal</code>

19503

19504

<div class="param-description">The value of the attribute, prior to it being set.</div>

19505

</li>

19506

19507

<code class="param-name">newVal</code>

19508

19509

<div class="param-description">The value the attribute is to be set to.</div>

19510

</li>

19511

19512

<code class="param-name">attrName</code>

19513

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

19514

<div class="param-description">The name of the attribute being set.</div>

19515

</li>

19516

19517

<code class="param-name">subAttrName</code>

19518

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

19519

<div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div>

19520

</li>

19521

</ul>

19522

</li>

19523

</ul>

19524

</div>

19525

</div>

19526

19527

19528

19529

</div>

19530

19531

19532

19533

19534

<h3 class="name"><code>tabIndex</code></h3>

19535

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Number" class="crosslink external" target="_blank">Number</a></span>

19536

19537

19538

19539

19540

19541

19542

19543

19544

19545

19546

19547

19548

<p>Inherited from

19549

<a href="../classes/Widget.html#attr_tabIndex">Widget</a>:

19550

19551

19552

19553

<a href="../files/widget_js_Widget.js.html#l202"><code>widget/js/Widget.js:202</code></a>

19554

19555

</p>

19556

19557

19558

19559

19560

</div>

19561

19562

19563

<p>Number (between -32767 to 32767) indicating the widget's

19564

position in the default tab flow. The value is used to set the

19565

"tabIndex" attribute on the widget's bounding box. Negative values allow

19566

the widget to receive DOM focus programmatically (by calling the focus

19567

method), while being removed from the default tab flow. A value of

19568

null removes the "tabIndex" attribute from the widget's bounding box.</p>

19569

</div>

19570

19571

19572

<p><strong>Default:</strong> null</p>

19573

19574

19575

19576

19577

<h4>Fires event <code>tabIndexChange</code></h4>

19578

19579

<p>

19580

Fires when the value for the configuration attribute <code>tabIndex</code> is

19581

changed. You can listen for the event using the <code>on</code> method if you

19582

wish to be notified before the attribute's value has changed, or

19583

using the <code>after</code> method if you wish to be notified after the

19584

attribute's value has changed.

19585

</p>

19586

19587

19588

<h4>Parameters:</h4>

19589

19590

19591

19592

19593

<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>

19594

19595

19596

An Event Facade object with the following

19597

attribute-specific properties added:

19598

</div>

19599

19600

19601

19602

<code class="param-name">prevVal</code>

19603

19604

<div class="param-description">The value of the attribute, prior to it being set.</div>

19605

</li>

19606

19607

<code class="param-name">newVal</code>

19608

19609

<div class="param-description">The value the attribute is to be set to.</div>

19610

</li>

19611

19612

<code class="param-name">attrName</code>

19613

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

19614

<div class="param-description">The name of the attribute being set.</div>

19615

</li>

19616

19617

<code class="param-name">subAttrName</code>

19618

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

19619

<div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div>

19620

</li>

19621

</ul>

19622

</li>

19623

</ul>

19624

</div>

19625

</div>

19626

19627

19628

19629

</div>

19630

19631

19632

19633

19634

<h3 class="name"><code>uploadURL</code></h3>

19635

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

19636

19637

19638

19639

19640

19641

19642

19643

19644

19645

19646

19647

19648

19649

<p>

19650

19651

Defined in

19652

19653

19654

19655

19656

<a href="../files/uploader_js_uploader-html5.js.html#l789"><code>uploader/js/uploader-html5.js:789</code></a>

19657

19658

</p>

19659

19660

19661

19662

19663

</div>

19664

19665

19666

<p>The URL to which file upload requested are POSTed. Only used if a different url is not passed to the upload method call.</p>

19667

</div>

19668

19669

19670

<p><strong>Default:</strong> ""</p>

19671

19672

19673

19674

19675

<h4>Fires event <code>uploadURLChange</code></h4>

19676

19677

<p>

19678

Fires when the value for the configuration attribute <code>uploadURL</code> is

19679

changed. You can listen for the event using the <code>on</code> method if you

19680

wish to be notified before the attribute's value has changed, or

19681

using the <code>after</code> method if you wish to be notified after the

19682

attribute's value has changed.

19683

</p>

19684

19685

19686

<h4>Parameters:</h4>

19687

19688

19689

19690

19691

<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>

19692

19693

19694

An Event Facade object with the following

19695

attribute-specific properties added:

19696

</div>

19697

19698

19699

19700

<code class="param-name">prevVal</code>

19701

19702

<div class="param-description">The value of the attribute, prior to it being set.</div>

19703

</li>

19704

19705

<code class="param-name">newVal</code>

19706

19707

<div class="param-description">The value the attribute is to be set to.</div>

19708

</li>

19709

19710

<code class="param-name">attrName</code>

19711

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

19712

<div class="param-description">The name of the attribute being set.</div>

19713

</li>

19714

19715

<code class="param-name">subAttrName</code>

19716

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

19717

<div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div>

19718

</li>

19719

</ul>

19720

</li>

19721

</ul>

19722

</div>

19723

</div>

19724

19725

19726

19727

</div>

19728

19729

19730

19731

19732

<h3 class="name"><code>visible</code></h3>

19733

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>

19734

19735

19736

19737

19738

19739

19740

19741

19742

19743

19744

19745

19746

<p>Inherited from

19747

<a href="../classes/Widget.html#attr_visible">Widget</a>:

19748

19749

19750

19751

<a href="../files/widget_js_Widget.js.html#l242"><code>widget/js/Widget.js:242</code></a>

19752

19753

</p>

19754

19755

19756

19757

19758

</div>

19759

19760

19761

<p>Boolean indicating weather or not the Widget is visible.</p>

19762

</div>

19763

19764

19765

<p><strong>Default:</strong> TRUE</p>

19766

19767

19768

19769

19770

<h4>Fires event <code>visibleChange</code></h4>

19771

19772

<p>

19773

Fires when the value for the configuration attribute <code>visible</code> is

19774

changed. You can listen for the event using the <code>on</code> method if you

19775

wish to be notified before the attribute's value has changed, or

19776

using the <code>after</code> method if you wish to be notified after the

19777

attribute's value has changed.

19778

</p>

19779

19780

19781

<h4>Parameters:</h4>

19782

19783

19784

19785

19786

<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>

19787

19788

19789

An Event Facade object with the following

19790

attribute-specific properties added:

19791

</div>

19792

19793

19794

19795

<code class="param-name">prevVal</code>

19796

19797

<div class="param-description">The value of the attribute, prior to it being set.</div>

19798

</li>

19799

19800

<code class="param-name">newVal</code>

19801

19802

<div class="param-description">The value the attribute is to be set to.</div>

19803

</li>

19804

19805

<code class="param-name">attrName</code>

19806

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

19807

<div class="param-description">The name of the attribute being set.</div>

19808

</li>

19809

19810

<code class="param-name">subAttrName</code>

19811

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

19812

<div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div>

19813

</li>

19814

</ul>

19815

</li>

19816

</ul>

19817

</div>

19818

</div>

19819

19820

19821

19822

</div>

19823

19824

19825

19826

19827

<h3 class="name"><code>width</code></h3>

19828

19829

19830

19831

19832

19833

19834

19835

19836

19837

19838

19839

19840

19841

<p>Inherited from

19842

<a href="../classes/Widget.html#attr_width">Widget</a>:

19843

19844

19845

19846

<a href="../files/widget_js_Widget.js.html#l263"><code>widget/js/Widget.js:263</code></a>

19847

19848

</p>

19849

19850

19851

19852

19853

</div>

19854

19855

19856

<p>String with units, or number, representing the width of the Widget. If a number is provided,

19857

the default unit, defined by the Widgets DEF_UNIT, property is used.</p>

19858

</div>

19859

19860

19861

<p><strong>Default:</strong> EMPTY_STR</p>

19862

19863

19864

19865

19866

<h4>Fires event <code>widthChange</code></h4>

19867

19868

<p>

19869

Fires when the value for the configuration attribute <code>width</code> is

19870

changed. You can listen for the event using the <code>on</code> method if you

19871

wish to be notified before the attribute's value has changed, or

19872

using the <code>after</code> method if you wish to be notified after the

19873

attribute's value has changed.

19874

</p>

19875

19876

19877

<h4>Parameters:</h4>

19878

19879

19880

19881

19882

<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>

19883

19884

19885

An Event Facade object with the following

19886

attribute-specific properties added:

19887

</div>

19888

19889

19890

19891

<code class="param-name">prevVal</code>

19892

19893

<div class="param-description">The value of the attribute, prior to it being set.</div>

19894

</li>

19895

19896

<code class="param-name">newVal</code>

19897

19898

<div class="param-description">The value the attribute is to be set to.</div>

19899

</li>

19900

19901

<code class="param-name">attrName</code>

19902

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

19903

<div class="param-description">The name of the attribute being set.</div>

19904

</li>

19905

19906

<code class="param-name">subAttrName</code>

19907

<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

19908

<div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div>

19909

</li>

19910

</ul>

19911

</li>

19912

</ul>

19913

</div>

19914

</div>

19915

19916

19917

19918

</div>

19919

19920

19921

</div>

19922

19923

19924

19925

19926

<h2 class="off-left">Events</h2>

19927

19928

19929

19930

<h3 class="name"><code>alluploadscomplete</code></h3>

19931

19932

19933

19934

19935

19936

19937

19938

19939

19940

19941

19942

19943

19944

19945

<p>

19946

19947

Defined in

19948

19949

19950

19951

19952

<a href="../files/uploader_js_uploader-html5.js.html#l170"><code>uploader/js/uploader-html5.js:170</code></a>

19953

19954

</p>

19955

19956

19957

19958

19959

</div>

19960

19961

19962

<p>Signals that the upload process of the entire file list has been completed.</p>

19963

</div>

19964

19965

19966

19967

<h4>Event Payload:</h4>

19968

19969

19970

19971

19972

19973

<code class="param-name">event</code>

19974

<span class="type"><a href="../classes/Event.html" class="crosslink">Event</a></span>

19975

19976

19977

19978

19979

19980

<p>The event object for the <code>alluploadscomplete</code>.</p>

19981

</div>

19982

19983

19984

</li>

19985

19986

</ul>

19987

</div>

19988

19989

19990

19991

19992

</div>

19993

19994

19995

19996

<h3 class="name"><code>destroy</code></h3>

19997

19998

19999

20000

20001

20002

20003

20004

20005

20006

20007

20008

20009

20010

<p>Inherited from

20011

<a href="../classes/Base.html#event_destroy">Base</a>:

20012

20013

20014

20015

20016

20017

</p>

20018

20019

20020

20021

20022

</div>

20023

20024

20025

<p>

20026

Lifecycle event for the destroy phase,

20027

fired prior to destruction. Invoking the preventDefault

20028

method on the event object provided to subscribers will

20029

prevent destruction from proceeding.

20030

</p>

20031

20032

<p>

20033

Subscribers to the "after" moment of this event, will be notified

20034

after destruction is complete (and as a result cannot prevent

20035

destruction).

20036

</p>

20037

</div>

20038

20039

20040

20041

<h4>Event Payload:</h4>

20042

20043

20044

20045

20046

20047

20048

<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>

20049

20050

20051

20052

20053

20054

<p>Event object</p>

20055

</div>

20056

20057

20058

</li>

20059

20060

</ul>

20061

</div>

20062

20063

20064

20065

20066

</div>

20067

20068

20069

20070

<h3 class="name"><code>dragenter</code></h3>

20071

20072

20073

20074

20075

20076

20077

20078

20079

20080

20081

20082

20083

20084

20085

<p>

20086

20087

Defined in

20088

20089

20090

20091

20092

<a href="../files/uploader_js_uploader-html5.js.html#l197"><code>uploader/js/uploader-html5.js:197</code></a>

20093

20094

</p>

20095

20096

20097

20098

20099

</div>

20100

20101

20102

<p>Signals that a dragged object has entered into the uploader's associated drag-and-drop area.</p>

20103

</div>

20104

20105

20106

20107

<h4>Event Payload:</h4>

20108

20109

20110

20111

20112

20113

<code class="param-name">event</code>

20114

<span class="type"><a href="../classes/Event.html" class="crosslink">Event</a></span>

20115

20116

20117

20118

20119

20120

<p>The event object for the <code>dragenter</code>.</p>

20121

</div>

20122

20123

20124

</li>

20125

20126

</ul>

20127

</div>

20128

20129

20130

20131

20132

</div>

20133

20134

20135

20136

<h3 class="name"><code>dragleave</code></h3>

20137

20138

20139

20140

20141

20142

20143

20144

20145

20146

20147

20148

20149

20150

20151

<p>

20152

20153

Defined in

20154

20155

20156

20157

20158

<a href="../files/uploader_js_uploader-html5.js.html#l213"><code>uploader/js/uploader-html5.js:213</code></a>

20159

20160

</p>

20161

20162

20163

20164

20165

</div>

20166

20167

20168

<p>Signals that an object has been dragged off of the uploader's associated drag-and-drop area.</p>

20169

</div>

20170

20171

20172

20173

<h4>Event Payload:</h4>

20174

20175

20176

20177

20178

20179

<code class="param-name">event</code>

20180

<span class="type"><a href="../classes/Event.html" class="crosslink">Event</a></span>

20181

20182

20183

20184

20185

20186

<p>The event object for the <code>dragleave</code>.</p>

20187

</div>

20188

20189

20190

</li>

20191

20192

</ul>

20193

</div>

20194

20195

20196

20197

20198

</div>

20199

20200

20201

20202

<h3 class="name"><code>dragover</code></h3>

20203

20204

20205

20206

20207

20208

20209

20210

20211

20212

20213

20214

20215

20216

20217

<p>

20218

20219

Defined in

20220

20221

20222

20223

20224

<a href="../files/uploader_js_uploader-html5.js.html#l205"><code>uploader/js/uploader-html5.js:205</code></a>

20225

20226

</p>

20227

20228

20229

20230

20231

</div>

20232

20233

20234

<p>Signals that an object has been dragged over the uploader's associated drag-and-drop area.</p>

20235

</div>

20236

20237

20238

20239

<h4>Event Payload:</h4>

20240

20241

20242

20243

20244

20245

<code class="param-name">event</code>

20246

<span class="type"><a href="../classes/Event.html" class="crosslink">Event</a></span>

20247

20248

20249

20250

20251

20252

<p>The event object for the <code>dragover</code>.</p>

20253

</div>

20254

20255

20256

</li>

20257

20258

</ul>

20259

</div>

20260

20261

20262

20263

20264

</div>

20265

20266

20267

20268

20269

20270

20271

20272

20273

20274

20275

20276

20277

20278

20279

20280

20281

20282

20283

<p>

20284

20285

Defined in

20286

20287

20288

20289

20290

<a href="../files/uploader_js_uploader-html5.js.html#l221"><code>uploader/js/uploader-html5.js:221</code></a>

20291

20292

</p>

20293

20294

20295

20296

20297

</div>

20298

20299

20300

<p>Signals that an object has been dropped over the uploader's associated drag-and-drop area.</p>

20301

</div>

20302

20303

20304

20305

<h4>Event Payload:</h4>

20306

20307

20308

20309

20310

20311

<code class="param-name">event</code>

20312

<span class="type"><a href="../classes/Event.html" class="crosslink">Event</a></span>

20313

20314

20315

20316

20317

20318

<p>The event object for the <code>drop</code>.</p>

20319

</div>

20320

20321

20322

</li>

20323

20324

</ul>

20325

</div>

20326

20327

20328

20329

20330

</div>

20331

20332

20333

20334

<h3 class="name"><code>fileselect</code></h3>

20335

20336

20337

20338

20339

20340

20341

20342

20343

20344

20345

20346

20347

20348

20349

<p>

20350

20351

Defined in

20352

20353

20354

20355

20356

<a href="../files/uploader_js_uploader-html5.js.html#l78"><code>uploader/js/uploader-html5.js:78</code></a>

20357

20358

</p>

20359

20360

20361

20362

20363

</div>

20364

20365

20366

<p>Signals that files have been selected.</p>

20367

</div>

20368

20369

20370

20371

<h4>Event Payload:</h4>

20372

20373

20374

20375

20376

20377

<code class="param-name">event</code>

20378

<span class="type"><a href="../classes/Event.html" class="crosslink">Event</a></span>

20379

20380

20381

20382

20383

20384

<p>The event object for the <code>fileselect</code> with the

20385

following payload:

20386

<dl>

20387

<dt>fileList</dt>

20388

<dd>An <code>Array</code> of files selected by the user, encapsulated

20389

in Y.FileHTML5 objects.</dd>

20390

</dl></p>

20391

</div>

20392

20393

20394

</li>

20395

20396

</ul>

20397

</div>

20398

20399

20400

20401

20402

</div>

20403

20404

20405

20406

<h3 class="name"><code>fileuploadstart</code></h3>

20407

20408

20409

20410

20411

20412

20413

20414

20415

20416

20417

20418

20419

20420

20421

<p>

20422

20423

Defined in

20424

20425

20426

20427

20428

<a href="../files/uploader_js_uploader-html5.js.html#l100"><code>uploader/js/uploader-html5.js:100</code></a>

20429

20430

</p>

20431

20432

20433

20434

20435

</div>

20436

20437

20438

<p>Signals that an upload of a specific file has started.</p>

20439

</div>

20440

20441

20442

20443

<h4>Event Payload:</h4>

20444

20445

20446

20447

20448

20449

<code class="param-name">event</code>

20450

<span class="type"><a href="../classes/Event.html" class="crosslink">Event</a></span>

20451

20452

20453

20454

20455

20456

<p>The event object for the <code>fileuploadstart</code> with the

20457

following payload:

20458

<dl>

20459

20460

<dd>A reference to the Y.File that dispatched the event.</dd>

20461

<dt>originEvent</dt>

20462

<dd>The original event dispatched by Y.File.</dd>

20463

</dl></p>

20464

</div>

20465

20466

20467

</li>

20468

20469

</ul>

20470

</div>

20471

20472

20473

20474

20475

</div>

20476

20477

20478

20479

20480

20481

20482

20483

20484

20485

20486

20487

20488

20489

20490

20491

20492

20493

<p>Inherited from

20494

<a href="../classes/Base.html#event_init">Base</a>:

20495

20496

20497

20498

20499

20500

</p>

20501

20502

20503

20504

20505

</div>

20506

20507

20508

<p>

20509

Lifecycle event for the init phase, fired prior to initialization.

20510

Invoking the preventDefault() method on the event object provided

20511

to subscribers will prevent initialization from occuring.

20512

</p>

20513

20514

<p>

20515

Subscribers to the "after" momemt of this event, will be notified

20516

after initialization of the object is complete (and therefore

20517

cannot prevent initialization).

20518

</p>

20519

</div>

20520

20521

20522

20523

<h4>Event Payload:</h4>

20524

20525

20526

20527

20528

20529

20530

<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>

20531

20532

20533

20534

20535

20536

<p>Event object, with a cfg property which

20537

refers to the configuration object passed to the constructor.</p>

20538

</div>

20539

20540

20541

</li>

20542

20543

</ul>

20544

</div>

20545

20546

20547

20548

20549

</div>

20550

20551

20552

20553

<h3 class="name"><code>totaluploadprogress</code></h3>

20554

20555

20556

20557

20558

20559

20560

20561

20562

20563

20564

20565

20566

20567

20568

<p>

20569

20570

Defined in

20571

20572

20573

20574

20575

<a href="../files/uploader_js_uploader-html5.js.html#l136"><code>uploader/js/uploader-html5.js:136</code></a>

20576

20577

</p>

20578

20579

20580

20581

20582

</div>

20583

20584

20585

<p>Reports on the total upload progress of the file list.</p>

20586

</div>

20587

20588

20589

20590

<h4>Event Payload:</h4>

20591

20592

20593

20594

20595

20596

<code class="param-name">event</code>

20597

<span class="type"><a href="../classes/Event.html" class="crosslink">Event</a></span>

20598

20599

20600

20601

20602

20603

<p>The event object for the <code>totaluploadprogress</code> with the

20604

following payload:

20605

<dl>

20606

<dt>bytesLoaded</dt>

20607

<dd>The number of bytes of the file list that has been uploaded</dd>

20608

<dt>bytesTotal</dt>

20609

<dd>The total number of bytes in the file list</dd>

20610

<dt>percentLoaded</dt>

20611

<dd>The fraction of the file list that has been uploaded, out of 100</dd>

20612

</dl></p>

20613

</div>

20614

20615

20616

</li>

20617

20618

</ul>

20619

</div>

20620

20621

20622

20623

20624

</div>

20625

20626

20627

20628

<h3 class="name"><code>uploadcomplete</code></h3>

20629

20630

20631

20632

20633

20634

20635

20636

20637

20638

20639

20640

20641

20642

20643

<p>

20644

20645

Defined in

20646

20647

20648

20649

20650

<a href="../files/uploader_js_uploader-html5.js.html#l153"><code>uploader/js/uploader-html5.js:153</code></a>

20651

20652

</p>

20653

20654

20655

20656

20657

</div>

20658

20659

20660

<p>Signals that a single file upload has been completed.</p>

20661

</div>

20662

20663

20664

20665

<h4>Event Payload:</h4>

20666

20667

20668

20669

20670

20671

<code class="param-name">event</code>

20672

<span class="type"><a href="../classes/Event.html" class="crosslink">Event</a></span>

20673

20674

20675

20676

20677

20678

<p>The event object for the <code>uploadcomplete</code> with the

20679

following payload:

20680

<dl>

20681

20682

<dd>The pointer to the instance of <code>Y.File</code> whose upload has been completed.</dd>

20683

<dt>originEvent</dt>

20684

<dd>The original event fired by the SWF Uploader</dd>

20685

20686

<dd>Data returned by the server.</dd>

20687

</dl></p>

20688

</div>

20689

20690

20691

</li>

20692

20693

</ul>

20694

</div>

20695

20696

20697

20698

20699

</div>

20700

20701

20702

20703

<h3 class="name"><code>uploaderror</code></h3>

20704

20705

20706

20707

20708

20709

20710

20711

20712

20713

20714

20715

20716

20717

20718

<p>

20719

20720

Defined in

20721

20722

20723

20724

20725

<a href="../files/uploader_js_uploader-html5.js.html#l178"><code>uploader/js/uploader-html5.js:178</code></a>

20726

20727

</p>

20728

20729

20730

20731

20732

</div>

20733

20734

20735

<p>Signals that a error has occurred in a specific file's upload process.</p>

20736

</div>

20737

20738

20739

20740

<h4>Event Payload:</h4>

20741

20742

20743

20744

20745

20746

<code class="param-name">event</code>

20747

<span class="type"><a href="../classes/Event.html" class="crosslink">Event</a></span>

20748

20749

20750

20751

20752

20753

<p>The event object for the <code>uploaderror</code> with the

20754

following payload:

20755

<dl>

20756

<dt>originEvent</dt>

20757

<dd>The original error event fired by the HTML5 Uploader. </dd>

20758

20759

<dd>The pointer at the instance of Y.File that returned the error.</dd>

20760

<dt>status</dt>

20761

<dd>The status reported by the XMLHttpRequest object.</dd>

20762

<dt>statusText</dt>

20763

<dd>The statusText reported by the XMLHttpRequest object.</dd>

20764

</dl></p>

20765

</div>

20766

20767

20768

</li>

20769

20770

</ul>

20771

</div>

20772

20773

20774

20775

20776

</div>

20777

20778

20779

20780

<h3 class="name"><code>uploadprogress</code></h3>

20781

20782

20783

20784

20785

20786

20787

20788

20789

20790

20791

20792

20793

20794

20795

<p>

20796

20797

Defined in

20798

20799

20800

20801

20802

<a href="../files/uploader_js_uploader-html5.js.html#l115"><code>uploader/js/uploader-html5.js:115</code></a>

20803

20804

</p>

20805

20806

20807

20808

20809

</div>

20810

20811

20812

<p>Reports on upload progress of a specific file.</p>

20813

</div>

20814

20815

20816

20817

<h4>Event Payload:</h4>

20818

20819

20820

20821

20822

20823

<code class="param-name">event</code>

20824

<span class="type"><a href="../classes/Event.html" class="crosslink">Event</a></span>

20825

20826

20827

20828

20829

20830

<p>The event object for the <code>uploadprogress</code> with the

20831

following payload:

20832

<dl>

20833

20834

<dd>The pointer to the instance of <code>Y.File</code> that dispatched the event.</dd>

20835

<dt>bytesLoaded</dt>

20836

<dd>The number of bytes of the file that has been uploaded</dd>

20837

<dt>bytesTotal</dt>

20838

<dd>The total number of bytes in the file</dd>

20839

<dt>percentLoaded</dt>

20840

<dd>The fraction of the file that has been uploaded, out of 100</dd>

20841

<dt>originEvent</dt>

20842

<dd>The original event dispatched by the HTML5 uploader</dd>

20843

</dl></p>

20844

</div>

20845

20846

20847

</li>

20848

20849

</ul>

20850

</div>

20851

20852

20853

20854

20855

</div>

20856

20857

20858

20859

<h3 class="name"><code>uploadstart</code></h3>

20860

20861

20862

20863

20864

20865

20866

20867

20868

20869

20870

20871

20872

20873

20874

<p>

20875

20876

Defined in

20877

20878

20879

20880

20881

<a href="../files/uploader_js_uploader-html5.js.html#l92"><code>uploader/js/uploader-html5.js:92</code></a>

20882

20883

</p>

20884

20885

20886

20887

20888

</div>

20889

20890

20891

<p>Signals that an upload of multiple files has been started.</p>

20892

</div>

20893

20894

20895

20896

<h4>Event Payload:</h4>

20897

20898

20899

20900

20901

20902

<code class="param-name">event</code>

20903

<span class="type"><a href="../classes/Event.html" class="crosslink">Event</a></span>

20904

20905

20906

20907

20908

20909

<p>The event object for the <code>uploadstart</code>.</p>

20910

</div>

20911

20912

20913

</li>

20914

20915

</ul>

20916

</div>

20917

20918

20919

20920

20921

</div>

20922

20923

20924

20925

<h3 class="name"><code>widget:contentUpdate</code></h3>

20926

20927

20928

20929

20930

20931

20932

20933

20934

20935

20936

20937

20938

20939

<p>Inherited from

20940

<a href="../classes/Widget.html#event_widget:contentUpdate">Widget</a>:

20941

20942

20943

20944

<a href="../files/widget_js_Widget.js.html#l398"><code>widget/js/Widget.js:398</code></a>

20945

20946

</p>

20947

20948

20949

20950

20951

</div>

20952

20953

20954

<p>Notification event, which widget implementations can fire, when

20955

they change the content of the widget. This event has no default

20956

behavior and cannot be prevented, so the "on" or "after"

20957

moments are effectively equivalent (with on listeners being invoked before

20958

after listeners).</p>

20959

</div>

20960

20961

20962

20963

<h4>Event Payload:</h4>

20964

20965

20966

20967

20968

20969

20970

<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>

20971

20972

20973

20974

20975

20976

<p>The Event Facade</p>

20977

</div>

20978

20979

20980

</li>

20981

20982

</ul>

20983

</div>

20984

20985

20986

20987

20988

</div>

20989

20990

20991

20992

<h3 class="name"><code>widget:render</code></h3>

20993

20994

20995

20996

20997

20998

20999

21000

21001

21002

21003

21004

21005

21006

<p>Inherited from

21007

<a href="../classes/Widget.html#event_widget:render">Widget</a>:

21008

21009

21010

21011

<a href="../files/widget_js_Widget.js.html#l544"><code>widget/js/Widget.js:544</code></a>

21012

21013

</p>

21014

21015

21016

21017

21018

</div>

21019

21020

21021

<p>Lifecycle event for the render phase, fired prior to rendering the UI

21022

for the widget (prior to invoking the widget's renderer method).</p>

21023

21024

<p>

21025

Subscribers to the "on" moment of this event, will be notified

21026

before the widget is rendered.

21027

</p>

21028

21029

<p>

21030

Subscribers to the "after" moment of this event, will be notified

21031

after rendering is complete.

21032

</p>

21033

</div>

21034

21035

21036

21037

<h4>Event Payload:</h4>

21038

21039

21040

21041

21042

21043

21044

<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>

21045

21046

21047

21048

21049

21050

<p>The Event Facade</p>

21051

</div>

21052

21053

21054

</li>

21055

21056

</ul>

21057

</div>

21058

21059

21060

21061

21062

</div>

21063

21064

21065

</div>

21066

21067

</div>

21068

</div>

21069

21070

</div>

21071

</div>

21072

</div>

21073

</div>

21074

</div>

21075

</div>

21076

21077

21078

21079

21080

21081

21082

21083

21084

</body>

21085

</html>

Older »