UploaderFlash Class

Extends Widget

Defined in: uploader/js/uploader-flash.js:15

Module: uploader-flash

This module provides a UI for file selection and multiple file upload capability using Flash as a transport engine.

Constructor

`UploaderFlash`

(

config

)

Defined in uploader/js/uploader-flash.js:15

Parameters:

config Object

Configuration object.

Index
Methods
Properties
Attributes
Events

Item Index

Methods

`_addAttrs`

(

cfgs
values
lazy

)

private

Inherited from AttributeCore: attribute/js/AttributeCore.js:769

Implementation behind the public addAttrs method.

This method is invoked directly by get if it encounters a scenario in which an attribute's valueFn attempts to obtain the value an attribute in the same group of attributes, which has not yet been added (on demand initialization).

Parameters:

cfgs Object

An object with attribute name/configuration pairs.
values Object

An object with attribute name/value pairs, defining the initial values to apply. Values defined in the cfgs argument will be over-written by values in this argument unless defined as read only.
lazy Boolean

Whether or not to delay the intialization of these attributes until the first call to get/set. Individual attributes can over-ride this behavior by defining a lazyAdd configuration property in their configuration. See addAttr.

`_addLazyAttr`

(

name

)

private

Inherited from AttributeCore: attribute/js/AttributeCore.js:340

Finishes initializing an attribute which has been lazily added.

Parameters:

name Object

The name of the attribute

`_afterChildSelectedChange`

(

event

)

protected

Inherited from Widget: widget-child/js/Widget-Child.js:327

Default attribute change listener for the selected attribute, responsible for updating the UI, in response to attribute changes.

Parameters:

event EventFacade

The event facade for the attribute change.

`_aggregateAttrs`

(

allAttrs

)

Object private

Inherited from BaseCore: base/js/BaseCore.js:451

A helper method, used by _initHierarchyData to aggregate attribute configuration across the instances class hierarchy.

The method will protect the attribute configuration value to protect the statically defined default value in ATTRS if required (if the value is an object literal, array or the attribute configuration has cloneDefaultValue set to shallow or deep).

Parameters:

allAttrs Array

An array of ATTRS definitions across classes in the hierarchy (subclass first, Base last)

Returns:

Object: The aggregate set of ATTRS definitions for the instance

`_applyParsedConfig`

() Object protected

Inherited from Widget: widget/js/WidgetHTMLParser.js:83

Returns:

Object: The merged configuration literal

`_applyParser`

(

config

)

protected

Inherited from Widget: widget/js/WidgetHTMLParser.js:92

Utility method used to apply the HTML_PARSER configuration for the instance, to retrieve config data values.

Parameters:

config Object

User configuration object (will be populated with values from Node)

`_attachTabElements`

(

ev

)

protected

Defined in uploader/js/uploader-flash.js:371

Attaches keyboard bindings to enabling tabbing to and from the instance of the Flash player in the Uploader widget. If the previous and next elements are specified, the keyboard bindings enable the user to tab from the tabElements["from"] node to the Flash-powered "Select Files" button, and to the tabElements["to"] node.

Parameters:

ev Event

Optional event payload if called as a tabElementsChange handler.

`_attrCfgHash`

() private

Inherited from BaseCore: base/js/BaseCore.js:440

Utility method to define the attribute hash used to filter/whitelist property mixes for this class.

`_baseDestroy`

() private

Inherited from BaseCore: base/js/BaseCore.js:264

Internal destroy implementation for BaseCore

`_baseInit`

() private

Inherited from BaseCore: base/js/BaseCore.js:236

Internal initialization implementation for BaseCore

`_bindAttrUI`

(

attrs

)

private

Inherited from Widget: widget/js/Widget.js:1168

Binds after listeners for the list of attributes provided

Parameters:

attrs Array

`_bindDOM`

() protected

Inherited from Widget: widget/js/Widget.js:900

Sets up DOM listeners, on elements rendered by the widget.

`_bindUI`

() protected

Inherited from Widget: widget/js/Widget.js:881

Sets up DOM and CustomEvent listeners for the widget.

`_bindUIChild`

() protected

Inherited from Widget: widget-child/js/Widget-Child.js:356

Binds event listeners responsible for updating the UI state in response to WidgetChild related state changes.

This method is invoked after bindUI is invoked for the Widget class using YUI's aop infrastructure.

`_createUIEvent`

(

type

)

private

Inherited from Widget: widget/js/WidgetUIEvents.js:73

Binds a delegated DOM event listener of the specified type to the Widget's outtermost DOM element to facilitate the firing of a Custom Event of the same type for the Widget instance.

Parameters:

type String

String representing the name of the event

`_defAttrChangeFn`

(

)

private

Inherited from AttributeObservable: attribute/js/AttributeObservable.js:171

Default function for attribute change events.

Parameters:

e EventFacade

The event object for attribute change events.

`_defaultCB`

() protected

Inherited from Widget: widget/js/Widget.js:778

Returns the default value for the contentBox attribute.

For the Widget class, this will be the srcNode if provided, otherwise null (resulting in a new contentBox node instance being created)

`_defDestroyFn`

(

)

protected

Inherited from BaseObservable: base/js/BaseObservable.js:184

Default destroy event handler

Parameters:

e EventFacade

Event object

`_defInitFn`

(

)

protected

Inherited from BaseObservable: base/js/BaseObservable.js:172

Default init event handler

Parameters:

e EventFacade

Event object, with a cfg property which refers to the configuration object passed to the constructor.

`_defRenderFn`

(

e
parentNode

)

protected

Inherited from Widget: widget/js/Widget.js:569

Default render handler

Parameters:

e EventFacade

The Event object
parentNode Node

The parent node to render to, if passed in to the render method

`_destroyBox`

() protected

Inherited from Widget: widget/js/Widget.js:475

Removes and destroys the widgets rendered boundingBox, contentBox, and detaches bound UI events.

`_destroyHierarchy`

() private

Inherited from BaseCore: base/js/BaseCore.js:587

Destroys the class hierarchy for this instance by invoking the destructor method on the prototype of each class in the hierarchy.

`_destroyUIEvents`

() private

Inherited from Widget: widget/js/WidgetUIEvents.js:20

Destructor logic for UI event infrastructure, invoked during Widget destruction.

`_filterAdHocAttrs`

(

allAttrs
userVals

)

Object private

Inherited from BaseCore: base/js/BaseCore.js:343

Parameters:

allAttrs Object

The set of all attribute configurations for this instance. Attributes will be removed from this set, if they belong to the filtered class, so that by the time all classes are processed, allCfgs will be empty.
userVals Object

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

Returns:

Object: The set of adhoc attributes passed in, in the form of an object with attribute name/configuration pairs.

`_filterAttrCfs`

(

clazz
allCfgs

)

Object private

Inherited from BaseCore: base/js/BaseCore.js:311

A helper method used when processing ATTRS across the class hierarchy during initialization. Returns a disposable object with the attributes defined for the provided class, extracted from the set of all attributes passed in.

Parameters:

clazz Function

The class for which the desired attributes are required.
allCfgs Object

The set of all attribute configurations for this instance. Attributes will be removed from this set, if they belong to the filtered class, so that by the time all classes are processed, allCfgs will be empty.

Returns:

Object: The set of attributes belonging to the class passed in, in the form of an object with attribute name/configuration pairs.

`_filterUIEvent`

(

evt

)

Boolean private

Inherited from Widget: widget/js/WidgetUIEvents.js:117

This method is used to determine if we should fire the UI Event or not. The default implementation makes sure that for nested delegates (nested unrelated widgets), we don't fire the UI event listener more than once at each level.

For example, without the additional filter, if you have nested widgets, each widget will have a delegate listener. If you click on the inner widget, the inner delegate listener's filter will match once, but the outer will match twice (based on delegate's design) - once for the inner widget, and once for the outer.

Parameters:

evt DOMEventFacade

Returns:

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

`_fireAttrChange`

(

attrName
subAttrName
currVal
newVal
opts

)

private

Inherited from AttributeObservable: attribute/js/AttributeObservable.js:117

Utility method to help setup the event payload and fire the attribute change event.

Parameters:

attrName String

The name of the attribute
subAttrName String

The full path of the property being changed, if this is a sub-attribute value being change. Otherwise null.
currVal Any

The current value of the attribute
newVal Any

The new value of the attribute
opts Object

Any additional event data to mix into the attribute change event's event facade.

`_getAttr`

(

name

)

Any protected chainable

Inherited from AttributeCore: attribute/js/AttributeCore.js:496

Provides the common implementation for the public get method, allowing Attribute hosts to over-ride either method.

See get for argument details.

Parameters:

name String

The name of the attribute.

Returns:

Any: The value of the attribute.

`_getAttrCfg`

(

name

)

Object protected

Inherited from AttributeExtras: attribute/js/AttributeExtras.js:113

Returns an object with the configuration properties (and value) for the given attribute. If attrName is not provided, returns the configuration properties for all attributes.

Parameters:

name String

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

Returns:

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

`_getAttrCfgs`

() Object protected

Inherited from BaseCore: base/js/BaseCore.js:294

Returns an aggregated set of attribute configurations, by traversing the class hierarchy.

Returns:

Object: The hash of attribute configurations, aggregated across classes in the hierarchy This value is cached the first time the method, or _getClasses, is invoked. Subsequent invocations return the cached value.

`_getAttrInitVal`

(

attr
cfg
initValues

)

Any private

Inherited from AttributeCore: attribute/js/AttributeCore.js:872

Returns the initial value of the given attribute from either the default configuration provided, or the over-ridden value if it exists in the set of initValues provided and the attribute is not read-only.

Parameters:

attr String

The name of the attribute
cfg Object

The attribute configuration object
initValues Object

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

Returns:

Any: The initial value of the attribute.

`_getAttrs`

(

attrs

)

Object protected

Inherited from AttributeCore: attribute/js/AttributeCore.js:706

Implementation behind the public getAttrs method, to get multiple attribute values.

Parameters:

attrs Array | boolean

Optional. An array of attribute names. If omitted, all attribute values are returned. If set to true, all attributes modified from their initial values are returned.

Returns:

Object: An object with attribute name/value pairs.

`_getClasses`

() Function[] protected

Inherited from BaseCore: base/js/BaseCore.js:278

Returns the class hierarchy for this object, with BaseCore being the last class in the array.

Returns:

Function[]: An array of classes (constructor functions), making up the class hierarchy for this object. This value is cached the first time the method, or _getAttrCfgs, is invoked. Subsequent invocations return the cached value.

`_getFileList`

() private

Defined in uploader/js/uploader-flash.js:522

Getter for the fileList attribute

`_getHtmlParser`

() Object private

Inherited from Widget: widget/js/WidgetHTMLParser.js:149

Gets the HTMLPARSER definition for this instance, by merging HTMLPARSER definitions across the class hierarchy.

Returns:

Object: HTML_PARSER definition for this instance

`_getNodeToParse`

() Node private

Inherited from Widget: widget/js/WidgetHTMLParser.js:134

Determines whether we have a node reference which we should try and parse.

The current implementation does not parse nodes generated from CONTENT_TEMPLATE, only explicitly set srcNode, or contentBox attributes.

Returns:

Node: The node reference to apply HTML_PARSER to.

`_getSrcNode`

() Node protected

Inherited from Widget: widget/js/WidgetHTMLParser.js:74

Returns:

Node: The Node to apply HTML_PARSER to

`_getStateVal`

(

name

)

Any private

Inherited from AttributeCore: attribute/js/AttributeCore.js:550

Gets the stored value for the attribute, from either the internal state object, or the state proxy if it exits

Parameters:

name String

The name of the attribute

Returns:

Any: The stored value of the attribute

`_getStrings`

(

locale

)

protected

Inherited from Widget: widget/js/WidgetLocale.js:53

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

Parameters:

locale Object

`_getType`

() private

Inherited from EventTarget: event-custom/js/event-target.js:36

If the instance has a prefix attribute and the event type is not prefixed, the instance prefix is applied to the supplied type.

`_getUIEventNode`

() protected

Inherited from Widget but overwritten in widget-child/js/Widget-Child.js:167

Returns the node on which to bind delegate listeners.

Override of Widget's implementation of _getUIEventNode() to ensure that all event listeners are bound to the Widget's topmost DOM element. This ensures that the firing of each type of Widget UI event (click, mousedown, etc.) is facilitated by a single, top-level, delegated DOM event listener.

`_guid`

() protected

Inherited from Widget: widget/js/Widget.js:1151

`_initAttrHost`

(

attrs
values
lazy

)

private

Inherited from AttributeCore: attribute/js/AttributeCore.js:137

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

Parameters:

attrs Object

The attributes to add during construction (passed through to addAttrs). These can also be defined on the constructor being augmented with Attribute by defining the ATTRS property on the constructor.
values Object

The initial attribute values to apply (passed through to addAttrs). These are not merged/cloned. The caller is responsible for isolating user provided values if required.
lazy Boolean

Whether or not to add attributes lazily (passed through to addAttrs).

`_initAttribute`

() private

Inherited from BaseObservable but overwritten in base/js/BaseCore.js:209

Initializes AttributeCore

`_initAttrs`

(

attrs
values
lazy

)

protected

Inherited from AttributeCore: attribute/js/AttributeCore.js:938

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

Parameters:

attrs Object

The attributes to add during construction (passed through to addAttrs). These can also be defined on the constructor being augmented with Attribute by defining the ATTRS property on the constructor.
values Object

The initial attribute values to apply (passed through to addAttrs). These are not merged/cloned. The caller is responsible for isolating user provided values if required.
lazy Boolean

Whether or not to add attributes lazily (passed through to addAttrs).

`_initBase`

(

config

)

private

Inherited from BaseCore: base/js/BaseCore.js:174

Internal construction logic for BaseCore.

Parameters:

config Object

The constructor configuration object

`_initHierarchy`

(

userVals

)

private

Inherited from BaseCore: base/js/BaseCore.js:529

Initializes the class hierarchy for the instance, which includes initializing attributes for each class defined in the class's static ATTRS property and invoking the initializer method on the prototype of each class in the hierarchy.

Parameters:

userVals Object

Object with configuration property name/value pairs

`_initHierarchyData`

() private

Inherited from BaseCore: base/js/BaseCore.js:373

A helper method used by _getClasses and _getAttrCfgs, which determines both the array of classes and aggregate set of attribute configurations across the class hierarchy for the instance.

`_initUIEvent`

(

type

)

String private

Inherited from Widget: widget/js/WidgetUIEvents.js:176

Sets up infrastructure required to fire a UI event.

Parameters:

type String

String representing the name of the event

Returns:

String:

`_isLazyAttr`

(

name

)

Boolean private

Inherited from AttributeCore: attribute/js/AttributeCore.js:327

Checks whether or not the attribute is one which has been added lazily and still requires initialization.

Parameters:

name String

The name of the attribute

Returns:

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

`_isUIEvent`

(

type

)

String private

Inherited from Widget: widget/js/WidgetUIEvents.js:143

Determines if the specified event is a UI event.

Parameters:

type String

String representing the name of the event

Returns:

String: Event Returns the name of the UI Event, otherwise undefined.

`_mapInstance`

(

The

)

protected

Inherited from Widget: widget/js/Widget.js:414

Utility method used to add an entry to the boundingBox id to instance map.

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

Parameters:

The String

boundingBox id

`_monitor`

(

what
eventType
o

)

private

Inherited from EventTarget: event-custom/js/event-target.js:604

This is the entry point for the event monitoring system. You can monitor 'attach', 'detach', 'fire', and 'publish'. When configured, these events generate an event. click -> clickattach, clickdetach, click_publish -- these can be subscribed to like other events to monitor the event system. Inividual published events can have monitoring turned on or off (publish can't be turned off before it it published) by setting the events 'monitor' config.

Parameters:

what String

'attach', 'detach', 'fire', or 'publish'
eventType String | CustomEvent

The prefixed name of the event being monitored, or the CustomEvent object.
o Object

Information about the event interaction, such as fire() args, subscription category, publish config

`_normAttrVals`

(

valueHash

)

Object private

Inherited from AttributeCore: attribute/js/AttributeCore.js:829

Utility method to split out simple attribute name/value pairs ("x") from complex attribute name/value pairs ("x.y.z"), so that complex attributes can be keyed by the top level attribute name.

Parameters:

valueHash Object

An object with attribute name/value pairs

Returns:

Object: An object literal with 2 properties - "simple" and "complex", containing simple and complex attribute values respectively keyed by the top level attribute name, or null, if valueHash is falsey.

`_onDocFocus`

(

evt

)

protected

Inherited from Widget: widget/js/Widget.js:1079

DOM focus event handler, used to sync the state of the Widget with the DOM

Parameters:

evt EventFacade

The event facade for the DOM focus event

`_onDocMouseDown`

(

evt

)

protected

Inherited from Widget: widget/js/Widget.js:1066

"mousedown" event handler for the owner document of the widget's bounding box.

Parameters:

evt EventFacade

The event facade for the DOM focus event

`_parseType`

() private

Inherited from EventTarget: event-custom/js/event-target.js:52

Returns an array with the detach key (if provided), and the prefixed event name from _getType Y.on('detachcategory| menu:click', fn)

`_preInitEventCfg`

(

config

)

private

Inherited from BaseObservable: base/js/BaseObservable.js:92

Handles the special on, after and target properties which allow the user to easily configure on and after listeners as well as bubble targets during construction, prior to init.

Parameters:

config Object

The user configuration object

`_protectAttrs`

(

attrs

)

Object deprecated protected

Inherited from AttributeCore: attribute/js/AttributeCore.js:815

Deprecated: Use `AttributeCore.protectAttrs()` or `Attribute.protectAttrs()` which are the same static utility method.

Utility method to protect an attribute configuration hash, by merging the entire object and the individual attr config objects.

Parameters:

attrs Object

A hash of attribute to configuration object pairs.

Returns:

Object: A protected version of the attrs argument.

`_removeLoadingClassNames`

() protected

Inherited from Widget: widget/js/Widget.js:860

Removes class names representative of the widget's loading state from the boundingBox.

`_renderBox`

(

parentNode

)

private

Inherited from Widget: widget/js/Widget.js:708

Helper method to collect the boundingBox and contentBox and append to the provided parentNode, if not already a child. The owner document of the boundingBox, or the owner document of the contentBox will be used as the document into which the Widget is rendered if a parentNode is node is not provided. If both the boundingBox and the contentBox are not currently in the document, and no parentNode is provided, the widget will be rendered to the current document's body.

Parameters:

parentNode Node

The parentNode to render the widget to. If not provided, and both the boundingBox and the contentBox are not currently in the document, the widget will be rendered to the current document's body.

`_renderBoxClassNames`

() protected

Inherited from Widget: widget/js/Widget.js:836

Applies standard class names to the boundingBox and contentBox

`_renderUI`

() protected

Inherited from Widget: widget/js/Widget.js:825

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

`_set`

(

name
val

)

Object protected chainable

Inherited from AttributeObservable but overwritten in attribute/js/AttributeCore.js:374

Allows setting of readOnly/writeOnce attributes. See set for argument details.

Parameters:

name String

The name of the attribute.
val Any

The value to set the attribute to.

Returns:

Object: A reference to the host object.

`_setAttr`

(

name
value
opts
force

)

Object protected chainable

Inherited from AttributeCore: attribute/js/AttributeCore.js:389

Provides the common implementation for the public set and protected _set methods.

See set for argument details.

Parameters:

name String

The name of the attribute.
value Any

The value to set the attribute to.
opts Object

(Optional) Optional event data to be mixed into the event facade passed to subscribers of the attribute's change event. This is currently a hack. There's no real need for the AttributeCore implementation to support this parameter, but breaking it out into AttributeObservable, results in additional function hops for the critical path.
force Boolean

If true, allows the caller to set values for readOnly or writeOnce attributes which have already been set.

Returns:

Object: A reference to the host object.

`_setAttrs`

(

attrs

)

Object protected chainable

Inherited from AttributeObservable but overwritten in attribute/js/AttributeCore.js:675

Implementation behind the public setAttrs method, to set multiple attribute values.

Parameters:

attrs Object

An object with attributes name/value pairs.

Returns:

Object: A reference to the host object.

`_setAttrUI`

(

)

private

Inherited from Widget: widget/js/Widget.js:1199

Parameters:

e EventFacade

`_setAttrVal`

(

attrName
subAttrName
prevVal
newVal

)

Booolean private

Inherited from AttributeCore: attribute/js/AttributeCore.js:582

Updates the stored value of the attribute in the privately held State object, if validation and setter passes.

Parameters:

attrName String

The attribute name.
subAttrName String

The sub-attribute name, if setting a sub-attribute property ("x.y.z").
prevVal Any

The currently stored value of the attribute.
newVal Any

The value which is going to be stored.

Returns:

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

`_setBB`

(

Node/String

)

private

Inherited from Widget: widget/js/Widget.js:754

Setter for the boundingBox attribute

Parameters:

Node/String Object

Returns:

Node

`_setBox`

(

id
node
template
true

)

Node private

Inherited from Widget: widget/js/Widget.js:791

Helper method to set the bounding/content box, or create it from the provided template if not found.

Parameters:

id String

The node's id attribute
node Node | String

The node reference
template String

HTML string template for the node
true Boolean

if this is the boundingBox, false if it's the contentBox

Returns:

Node: The node

`_setButtonClass`

(

state
add

)

protected

Defined in uploader/js/uploader-flash.js:455

Adds or removes a specified state CSS class to the underlying uploader button.

Parameters:

state String

The name of the state enumerated in buttonClassNames attribute from which to derive the needed class name.
add Boolean

A Boolean indicating whether to add or remove the class.

`_setCB`

(

node

)

private

Inherited from Widget: widget/js/Widget.js:766

Setter for the contentBox attribute

Parameters:

node Node | String

Returns:

Node

`_setFileFilters`

() private

Defined in uploader/js/uploader-flash.js:474

Syncs the state of the fileFilters attribute between the instance of UploaderFlash and the Flash player.

`_setFileList`

() private

Defined in uploader/js/uploader-flash.js:532

Setter for the fileList attribute

`_setMultipleFiles`

() private

Defined in uploader/js/uploader-flash.js:489

Syncs the state of the multipleFiles attribute between this class and the Flash uploader.

`_setStateVal`

(

name
value

)

private

Inherited from AttributeCore: attribute/js/AttributeCore.js:564

Sets the stored value for the attribute, in either the internal state object, or the state proxy if it exits

Parameters:

name String

The name of the attribute
value Any

The value of the attribute

`_setStrings`

(

strings
locale

)

protected

Inherited from Widget: widget/js/WidgetLocale.js:32

Sets strings for a particular locale, merging with any existing strings which may already be defined for the locale.

Parameters:

strings Object

The hash of string key/values to set
locale Object

The locale for the string values being set

`_strSetter`

(

strings

)

String protected

Inherited from Widget: widget/js/Widget.js:1210

The default setter for the strings attribute. Merges partial sets into the full string set, to allow users to partial sets of strings

Parameters:

strings Object

Returns:

String: The full set of strings to set

`_syncAttrUI`

(

attrs

)

private

Inherited from Widget: widget/js/Widget.js:1184

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

Parameters:

attrs Array

`_syncUI`

() protected

Inherited from Widget: widget/js/Widget.js:962

Updates the widget UI to reflect the attribute state.

`_syncUIChild`

() protected

Inherited from Widget: widget-child/js/Widget-Child.js:341

Synchronizes the UI to match the WidgetChild state.

This method is invoked after bindUI is invoked for the Widget class using YUI's aop infrastructure.

`_triggerEnabled`

() private

Defined in uploader/js/uploader-flash.js:502

Syncs the state of the enabled attribute between this class and the Flash uploader.

`_uiSetChildSelected`

(

selected

)

protected

Inherited from Widget: widget-child/js/Widget-Child.js:305

Updates the UI to reflect the selected attribute value.

Parameters:

selected Number

The selected value to be reflected in the UI.

`_uiSetDim`

(

dim
val

)

private

Inherited from Widget: widget/js/Widget.js:995

Parameters:

dim String

The dimension - "width" or "height"
val Number | String

The value to set

`_uiSetDisabled`

(

val

)

protected

Inherited from Widget: widget/js/Widget.js:1016

Sets the disabled state for the UI

Parameters:

val Boolean

`_uiSetFocused`

(

val
src

)

protected

Inherited from Widget: widget/js/Widget.js:1027

Sets the focused state for the UI

Parameters:

val Boolean
src String

String representing the source that triggered an update to the UI.

`_uiSetHeight`

(

val

)

protected

Inherited from Widget: widget/js/Widget.js:972

Sets the height on the widget's bounding box element

Parameters:

val String | Number

`_uiSetTabIndex`

(

Number

)

protected

Inherited from Widget: widget/js/Widget.js:1049

Set the tabIndex on the widget's rendered UI

Parameters:

Number Object

`_uiSetVisible`

(

val

)

protected

Inherited from Widget: widget/js/Widget.js:1005

Sets the visible state for the UI

Parameters:

val Boolean

`_uiSetWidth`

(

val

)

protected

Inherited from Widget: widget/js/Widget.js:984

Sets the width on the widget's bounding box element

Parameters:

val String | Number

`_uiSizeCB`

(

expand

)

protected

Inherited from Widget: widget/js/Widget.js:699

Parameters:

expand Boolean

`_unbindDOM`

() protected

Inherited from Widget: widget/js/Widget.js:931

`_unbindUI`

() protected

Inherited from Widget: widget/js/Widget.js:892

`_updateFileList`

(

ev

)

private

Defined in uploader/js/uploader-flash.js:543

Adjusts the content of the fileList based on the results of file selection and the appendNewFiles attribute. If the appendNewFiles attribute is true, then selected files are appended to the existing list; otherwise, the list is cleared and populated with the newly selected files.

Parameters:

ev Event

The file selection event received from the uploader.

`_uploadEventHandler`

(

event

)

private

Defined in uploader/js/uploader-flash.js:606

Handles and retransmits events fired by Y.FileFlash and Y.Uploader.Queue.

Parameters:

event Object

The event dispatched during the upload process.

`_validTabIndex`

(

tabIndex

)

protected

Inherited from Widget: widget/js/Widget.js:1159

Parameters:

tabIndex Number

`addAttr`

(

name
config
lazy

)

Object chainable

Inherited from AttributeCore: attribute/js/AttributeCore.js:152

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

The config argument object supports the following properties:

value <Any>

The initial value to set on the attribute

valueFn <Function | String>

A function, which will return the initial value to set on the attribute. This is useful for cases where the attribute configuration is defined statically, but needs to reference the host instance ("this") to obtain an initial value. If both the value and valueFn properties are defined, the value returned by the valueFn has precedence over the value property, unless it returns undefined, in which case the value property is used.

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

readOnly <boolean>

Whether or not the attribute is read only. Attributes having readOnly set to true cannot be modified by invoking the set method.

writeOnce <boolean> or <string>

Whether or not the attribute is "write once". Attributes having writeOnce set to true, can only have their values set once, be it through the default configuration, constructor configuration arguments, or by invoking set.

The writeOnce attribute can also be set to the string "initOnly", in which case the attribute can only be set during initialization (when used with Base, this means it can only be set during construction)

setter <Function | String>

The setter function used to massage or normalize the value passed to the set method for the attribute. The value returned by the setter will be the final stored value. Returning Attribute.INVALID_VALUE, from the setter will prevent the value from being stored.

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

getter <Function | String>

The getter function used to massage or normalize the value returned by the get method for the attribute. The value returned by the getter function is the value which will be returned to the user when they invoke get.

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

validator <Function | String>

The validator function invoked prior to setting the stored value. Returning false from the validator function will prevent the value from being stored.

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

lazyAdd <boolean>

Whether or not to delay initialization of the attribute until the first call to get/set it. This flag can be used to over-ride lazy initialization on a per attribute basis, when adding multiple attributes through the addAttrs method.

The setter, getter and validator are invoked with the value and name passed in as the first and second arguments, and with the context ("this") set to the host object.

Configuration properties outside of the list mentioned above are considered private properties used internally by attribute, and are not intended for public use.

Parameters:

name String

The name of the attribute.
config Object

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

NOTE: The configuration object is modified when adding an attribute, so if you need to protect the original values, you will need to merge the object.
lazy Boolean

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

Returns:

Object: A reference to the host object.

`addAttrs`

(

cfgs
values
lazy

)

Object chainable

Inherited from AttributeCore: attribute/js/AttributeCore.js:737

Configures a group of attributes, and sets initial values.

NOTE: This method does not isolate the configuration object by merging/cloning. The caller is responsible for merging/cloning the configuration object if required.

Parameters:

cfgs Object

An object with attribute name/configuration pairs.
values Object

An object with attribute name/value pairs, defining the initial values to apply. Values defined in the cfgs argument will be over-written by values in this argument unless defined as read only.
lazy Boolean

Whether or not to delay the intialization of these attributes until the first call to get/set. Individual attributes can over-ride this behavior by defining a lazyAdd configuration property in their configuration. See addAttr.

Returns:

Object: A reference to the host object.

`addTarget`

(

)

Inherited from EventTarget: event-custom/js/event-facade.js:387

Registers another EventTarget as a bubble target. Bubble order is determined by the order registered. Multiple targets can be specified.

Events can only bubble if emitFacade is true.

Included in the event-custom-complex submodule.

Parameters:

o EventTarget

the target to add

`after`

(

type
fn
[context]
[arg*]

)

EventHandle

Inherited from EventTarget: event-custom/js/event-target.js:744

Subscribe to a custom event hosted by this object. The supplied callback will execute after any listeners add via the subscribe method, and after the default function, if configured for the event, has executed.

Parameters:

type String

The name of the event
fn Function

The callback to execute in response to the event
[context] Object optional

Override this object in callback
[arg*] Any optional

0..n additional arguments to supply to the subscriber

Returns:

EventHandle: A subscription handle capable of detaching the subscription

`ancestor`

(

depth

)

Widget

Inherited from Widget: widget-child/js/Widget-Child.js:279

Returns the Widget instance at the specified depth.

Parameters:

depth Number

Number representing the depth of the ancestor.

Returns:

Widget: Widget instance.

`attrAdded`

(

name

)

Boolean

Inherited from AttributeCore: attribute/js/AttributeCore.js:300

Checks if the given attribute has been added to the host

Parameters:

name String

The name of the attribute to check.

Returns:

Boolean: 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.

`before`

()

Inherited from EventTarget: event-custom/js/event-target.js:781

Executes the callback before a DOM event, custom event or method. If the first argument is a function, it is assumed the target is a method. For DOM and custom events, this is an alias for Y.on.

For DOM and custom events: type, callback, context, 0-n arguments

For methods: callback, object (method host), methodName, context, 0-n arguments

Returns:

detach handle

`bindUI`

() protected

Inherited from Widget but overwritten in uploader/js/uploader-flash.js:308

Binds handlers to the UploaderFlash UI events and propagates attribute values to the Flash player. The propagation of initial values is set to occur once the Flash player instance is ready (as indicated by the swfReady event.)

`blur`

() chainable

Inherited from Widget: widget/js/Widget.js:671

Causes the Widget to lose focus by setting the "focused" attribute to "false"

`bubble`

(

evt

)

Boolean

Inherited from EventTarget: event-custom/js/event-facade.js:424

Propagate an event. Requires the event-custom-complex module.

Parameters:

evt CustomEvent

the custom event to propagate

Returns:

Boolean: the aggregated return value from Event.Custom.fire

`destroy`

(

destroyAllNodes

)

Widget chainable

Inherited from BaseObservable but overwritten in widget/js/Widget.js:452

Destroy lifecycle method. Fires the destroy event, prior to invoking destructors for the class hierarchy. Overrides Base's implementation, to support arguments to destroy

Subscribers to the destroy event can invoke preventDefault on the event object, to prevent destruction from proceeding.

Parameters:

destroyAllNodes Boolean

If true, all nodes contained within the Widget are removed and destroyed. Defaults to false due to potentially high run-time cost.

Returns:

Widget: A reference to this object

`destructor`

() protected

Inherited from Widget: widget/js/Widget.js:427

Destructor lifecycle implementation for the Widget class. Purges events attached to the bounding box and content box, removes them from the DOM and removes the Widget from the list of registered widgets.

`detach`

(

type
fn
context

)

EventTarget

Inherited from EventTarget: event-custom/js/event-target.js:344

Detach one or more listeners the from the specified event

Parameters:

type String | Object

Either the handle to the subscriber or the type of event. If the type is not specified, it will attempt to remove the listener from all hosted events.
fn Function

The subscribed function to unsubscribe, if not supplied, all subscribers will be removed.
context Object

The custom object passed to subscribe. This is optional, but if supplied will be used to disambiguate multiple listeners that are the same (e.g., you subscribe many object using a function that lives on the prototype)

Returns:

EventTarget: the host

`detachAll`

(

type

)

Inherited from EventTarget: event-custom/js/event-target.js:464

Removes all listeners from the specified event. If the event type is not specified, all listeners from all hosted custom events will be removed.

Parameters:

type String

The type, or name of the event

`disable`

() chainable

Inherited from Widget: widget/js/Widget.js:690

Set the Widget's "disabled" attribute to "true".

`enable`

() chainable

Inherited from Widget: widget/js/Widget.js:681

Set the Widget's "disabled" attribute to "false".

`fire`

(

type
arguments

)

EventTarget

Inherited from EventTarget: event-custom/js/event-target.js:641

Fire a custom event by name. The callback functions will be executed from the context specified when the event was created, and with the following parameters.

If the custom event object hasn't been created, then the event hasn't been published and it has no subscribers. For performance sake, we immediate exit in this case. This means the event won't bubble, so if the intention is that a bubble target be notified, the event must be published on this object first.

The first argument is the event type, and any additional arguments are passed to the listeners as parameters. If the first of these is an object literal, and the event is configured to emit an event facade, that object is mixed into the event facade and the facade is provided in place of the original object.

Parameters:

type String | Object

The type of the event, or an object that contains a 'type' property.
arguments Object*

an arbitrary set of parameters to pass to the handler. If the first of these is an object literal and the event is configured to emit an event facade, the event facade will replace that parameter after the properties the object literal contains are copied to the event facade.

Returns:

EventTarget: the event host

`focus`

() chainable

Inherited from Widget: widget/js/Widget.js:661

Causes the Widget to receive the focus by setting the "focused" attribute to "true".

`get`

(

name

)

Any

Inherited from AttributeCore: attribute/js/AttributeCore.js:311

Returns the current value of the attribute. If the attribute has been configured with a 'getter' function, this method will delegate to the 'getter' to obtain the value of the attribute.

Parameters:

name String

The name of the attribute. If the value of the attribute is an Object, dot notation can be used to obtain the value of a property of the object (e.g. get("x.y.z"))

Returns:

Any: The value of the attribute

`getAttrs`

(

attrs

)

Object

Inherited from AttributeCore: attribute/js/AttributeCore.js:694

Gets multiple attribute values.

Parameters:

attrs Array | boolean

Optional. An array of attribute names. If omitted, all attribute values are returned. If set to true, all attributes modified from their initial values are returned.

Returns:

Object: An object with attribute name/value pairs.

`getClassName`

(

args

)

Inherited from Widget but overwritten in widget/js/Widget.js:309

Generate a standard prefixed classname for the Widget, prefixed by the default prefix defined by the Y.config.classNamePrefix attribute used by ClassNameManager and Widget.NAME.toLowerCase() (e.g. "yui-widget-xxxxx-yyyyy", based on default values for the prefix and widget class name).

The instance based version of this method can be used to generate standard prefixed classnames, based on the instances NAME, as opposed to Widget.NAME. This method should be used when you need to use a constant class name across different types instances.

Parameters:

args String* multiple

0..n strings which should be concatenated, using the default separator defined by ClassNameManager, to create the class name

`getDefaultLocale`

() String

Inherited from Widget: widget/js/WidgetLocale.js:150

Returns the default locale for the widget (the locale value defined by the widget class, or provided by the user during construction).

Returns:

String: The default locale for the widget

`getEvent`

(

type
prefixed

)

CustomEvent

Inherited from EventTarget: event-custom/js/event-target.js:726

Returns the custom event of the provided type has been created, a falsy value otherwise

Parameters:

type String

the type, or name of the event
prefixed String

if true, the type is prefixed already

Returns:

CustomEvent: the custom event or null

`getSkinName`

() String

Inherited from Widget: widget/js/WidgetSkin.js:13

Returns the name of the skin that's currently applied to the widget. This is only really useful after the widget's DOM structure is in the document, either by render or by progressive enhancement. Searches up the Widget's ancestor axis for a class yui3-skin-(name), and returns the (name) portion. Otherwise, returns null.

Returns:

String: the name of the skin, or null (yui3-skin-sam => sam)

`getString`

(

key

)

String deprecated

Inherited from Widget but overwritten in widget/js/Widget.js:1223

Deprecated: Used by deprecated WidgetLocale implementations.

Helper method to get a specific string value

Parameters:

key String

Returns:

String: The string

`getStrings`

(

key

)

String deprecated

Inherited from Widget but overwritten in widget/js/Widget.js:1235

Deprecated: Used by deprecated WidgetLocale implementations.

Helper method to get the complete set of strings for the widget

Parameters:

key String

Returns:

String: The strings

`getTargets`

()

Inherited from EventTarget: event-custom/js/event-facade.js:405

Returns an array of bubble targets for this object.

Returns:

EventTarget[]

`hide`

() chainable

Inherited from Widget: widget/js/Widget.js:643

Hides the Widget by setting the "visible" attribute to "false".

`init`

(

cfg

)

BaseCore chainable

Inherited from BaseObservable but overwritten in base/js/BaseCore.js:219

Init lifecycle method, invoked during construction. Sets up attributes and invokes initializers for the class hierarchy.

Parameters:

cfg Object

Object with configuration property name/value pairs

Returns:

BaseCore: A reference to this object

`initializer`

() protected

Inherited from Widget but overwritten in uploader/js/uploader-flash.js:92

Construction logic executed during UploaderFlash instantiation.

`isRoot`

() Boolean

Inherited from Widget: widget-child/js/Widget-Child.js:267

Determines if the Widget is the root Widget in the object hierarchy.

Returns:

Boolean: Boolean indicating if Widget is the root Widget in the object hierarchy.

`modifyAttr`

(

name
config

)

Inherited from AttributeExtras: attribute/js/AttributeExtras.js:40

Updates the configuration of an attribute which has already been added.

The properties which can be modified through this interface are limited to the following subset of attributes, which can be safely modified after a value has already been set on the attribute: readOnly, writeOnce, broadcast and getter.

Parameters:

name String

The name of the attribute whose configuration is to be updated.
config Object

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

`next`

(

circular

)

Widget

Inherited from Widget: widget-child/js/Widget-Child.js:191

Returns the Widget's next sibling.

Parameters:

circular Boolean

Boolean indicating if the parent's first child should be returned if the child has no next sibling.

Returns:

Widget: Widget instance.

`on`

(

type
fn
[context]
[arg*]

)

EventHandle

Inherited from EventTarget: event-custom/js/event-target.js:191

Subscribe a callback function to a custom event fired by this object or from an object that bubbles its events to this object.

Callback functions for events published with emitFacade = true will receive an EventFacade as the first argument (typically named "e"). These callbacks can then call e.preventDefault() to disable the behavior published to that event's defaultFn. See the EventFacade API for all available properties and methods. Subscribers to non-emitFacade events will receive the arguments passed to fire() after the event name.

To subscribe to multiple events at once, pass an object as the first argument, where the key:value pairs correspond to the eventName:callback, or pass an array of event names as the first argument to subscribe to all listed events with the same callback.

Returning false from a callback is supported as an alternative to calling e.preventDefault(); e.stopPropagation();. However, it is recommended to use the event methods whenever possible.

Parameters:

type String

The name of the event
fn Function

The callback to execute in response to the event
[context] Object optional

Override this object in callback
[arg*] Any optional

0..n additional arguments to supply to the subscriber

Returns:

EventHandle: A subscription handle capable of detaching that subscription

`once`

(

type
fn
[context]
[arg*]

)

EventHandle

Inherited from EventTarget: event-custom/js/event-target.js:127

Listen to a custom event hosted by this object one time. This is the equivalent to on except the listener is immediatelly detached when it is executed.

Parameters:

type String

The name of the event
fn Function

The callback to execute in response to the event
[context] Object optional

Override this object in callback
[arg*] Any optional

0..n additional arguments to supply to the subscriber

Returns:

EventHandle: A subscription handle capable of detaching the subscription

`onceAfter`

(

type
fn
[context]
[arg*]

)

EventHandle

Inherited from EventTarget: event-custom/js/event-target.js:149

Listen to a custom event hosted by this object one time. This is the equivalent to after except the listener is immediatelly detached when it is executed.

Parameters:

type String

The name of the event
fn Function

The callback to execute in response to the event
[context] Object optional

Override this object in callback
[arg*] Any optional

0..n additional arguments to supply to the subscriber

Returns:

EventHandle: A subscription handle capable of detaching that subscription

`parseType`

(

type
[pre=this._yuievt.config.prefix]

)

Array

Inherited from EventTarget: event-custom/js/event-target.js:171

Available since 3.3.0

Takes the type parameter passed to 'on' and parses out the various pieces that could be included in the type. If the event type is passed without a prefix, it will be expanded to include the prefix one is supplied or the event target is configured with a default prefix.

Parameters:

type String

the type
[pre=this._yuievt.config.prefix] String optional

the prefix

Returns:

Array: an array containing: * the detach category, if supplied, * the prefixed event type, * whether or not this is an after listener, * the supplied event type

`previous`

(

circular

)

Widget

Inherited from Widget: widget-child/js/Widget-Child.js:216

Returns the Widget's previous sibling.

Parameters:

circular Boolean

Boolean indicating if the parent's last child should be returned if the child has no previous sibling.

Returns:

Widget: Widget instance.

`publish`

(

type
opts

)

CustomEvent

Inherited from EventTarget: event-custom/js/event-target.js:488

Creates a new custom event of the specified type. If a custom event by that name already exists, it will not be re-created. In either case the custom event is returned.

Parameters:

type String

the type, or name of the event
opts Object
optional config params. Valid properties are:
- 'broadcast': whether or not the YUI instance and YUI global are notified when the event is fired (false)
- 'bubbles': whether or not this event bubbles (true) Events can only bubble if emitFacade is true.
- 'context': the default execution context for the listeners (this)
- 'defaultFn': the default function to execute when this event fires if preventDefault was not called
- 'emitFacade': whether or not this event emits a facade (false)
- 'prefix': the prefix for this targets events, e.g., 'menu' in 'menu:click'
- 'fireOnce': if an event is configured to fire once, new subscribers after the fire will be notified immediately.
- 'async': fireOnce event listeners will fire synchronously if the event has already fired unless async is true.
- 'preventable': whether or not preventDefault() has an effect (true)
- 'preventedFn': a function that is executed when preventDefault is called
- 'queuable': whether or not this event can be queued during bubbling (false)
- 'silent': if silent is true, debug messages are not provided for this event.
- 'stoppedFn': a function that is executed when stopPropagation is called
- 'monitored': specifies whether or not this event should send notifications about when the event has been attached, detached, or published.
- 'type': the event type (valid option if not provided as the first parameter to publish)

Returns:

CustomEvent: the custom event

`removeAttr`

(

name

)

Inherited from AttributeExtras: attribute/js/AttributeExtras.js:78

Removes an attribute from the host object

Parameters:

name String

The name of the attribute to be removed.

`removeTarget`

(

)

Inherited from EventTarget: event-custom/js/event-facade.js:414

Removes a bubble target

Parameters:

o EventTarget

the target to remove

`render`

(

parentNode

)

final chainable

Inherited from Widget: widget/js/Widget.js:511

Establishes the initial DOM for the widget. Invoking this method will lead to the creating of all DOM elements for the widget (or the manipulation of existing DOM elements for the progressive enhancement use case).

This method should only be invoked once for an initialized widget.

It delegates to the widget specific renderer method to do the actual work.

Parameters:

parentNode Object | String

Optional. The Node under which the Widget is to be rendered. This can be a Node instance or a CSS selector string.

If the selector string returns more than one Node, the first node will be used as the parentNode. NOTE: This argument is required if both the boundingBox and contentBox are not currently in the document. If it's not provided, the Widget will be rendered to the body of the current document in this case.

`renderer`

() protected

Inherited from Widget: widget/js/Widget.js:586

Creates DOM (or manipulates DOM for progressive enhancement) This method is invoked by render() and is not chained automatically for the class hierarchy (unlike initializer, destructor) so it should be chained manually for subclasses if required.

`renderUI`

() protected

Inherited from Widget but overwritten in uploader/js/uploader-flash.js:271

Creates the DOM structure for the UploaderFlash. UploaderFlash's DOM structure consists of two layers: the base "Select Files" button that can be replaced by the developer's widget of choice; and a transparent Flash overlay positoned above the button that captures all input events. The position style attribute of the boundingBox of the Uploader widget is forced to be relative, in order to accommodate the Flash player overlay (which is positioned absolutely).

`reset`

(

name

)

Object chainable

Inherited from AttributeExtras: attribute/js/AttributeExtras.js:88

Resets the attribute (or all attributes) to its initial value, as long as the attribute is not readOnly, or writeOnce.

Parameters:

name String

Optional. The name of the attribute to reset. If omitted, all attributes are reset.

Returns:

Object: A reference to the host object.

`set`

(

name
value

)

Object chainable

Inherited from AttributeObservable but overwritten in attribute/js/AttributeCore.js:356

Sets the value of an attribute.

Parameters:

name String

The name of the attribute. If the current value of the attribute is an Object, dot notation can be used to set the value of a property within the object (e.g. set("x.y.z", 5)).
value Any

The value to set the attribute to.

Returns:

Object: A reference to the host object.

`setAttrs`

(

attrs

)

Object chainable

Inherited from AttributeObservable but overwritten in attribute/js/AttributeCore.js:663

Sets multiple attribute values.

Parameters:

attrs Object

An object with attributes name/value pairs.

Returns:

Object: A reference to the host object.

`show`

() chainable

Inherited from Widget: widget/js/Widget.js:652

Shows the Widget by setting the "visible" attribute to "true".

`subscribe`

() deprecated

Inherited from EventTarget: event-custom/js/event-target.js:334

Deprecated: use on

subscribe to an event

`syncUI`

() protected

Inherited from Widget: widget/js/Widget.js:631

Refreshes the rendered UI, based on Widget State

This method is not called by framework and is not chained automatically for the class hierarchy.

`toString`

() String

Inherited from BaseCore but overwritten in widget/js/Widget.js:1105

Generic toString implementation for all widgets.

Returns:

String: The default string value for the widget [ displays the NAME of the instance, and the unique id ]

`unsubscribe`

() deprecated

Inherited from EventTarget: event-custom/js/event-target.js:454

Deprecated: use detach

detach a listener

`unsubscribeAll`

(

type

)

deprecated

Inherited from EventTarget: event-custom/js/event-target.js:475

Deprecated: use detachAll

Removes all listeners from the specified event. If the event type is not specified, all listeners from all hosted custom events will be removed.

Parameters:

type String

The type, or name of the event

`upload`

(

file
url
[postVars]

)

Defined in uploader/js/uploader-flash.js:646

Starts the upload of a specific file.

Parameters:

file Y.FileFlash

Reference to the instance of the file to be uploaded.
url String

The URL to upload the file to.
[postVars] Object optional

A set of key-value pairs to send as variables along with the file upload HTTP request. If not specified, the values from the attribute postVarsPerFile are used instead.

`uploadAll`

(

url
[postVars]

)

Defined in uploader/js/uploader-flash.js:675

Starts the upload of all files on the file list, using an automated queue.

Parameters:

url String

The URL to upload the files to.
[postVars] Object optional

A set of key-value pairs to send as variables along with the file upload HTTP request. If not specified, the values from the attribute postVarsPerFile are used instead.

`uploadThese`

(

files
url
[postVars]

)

Defined in uploader/js/uploader-flash.js:687

Starts the upload of the files specified in the first argument, using an automated queue.

Parameters:

files Array

The list of files to upload.
url String

The URL to upload the files to.
[postVars] Object optional

A set of key-value pairs to send as variables along with the file upload HTTP request. If not specified, the values from the attribute postVarsPerFile are used instead.

Properties

`_allowAdHocAttrs`

Boolean protected

Inherited from BaseCore: base/js/BaseCore.js:100

This property controls whether or not instances of this class should allow users to add ad-hoc attributes through the constructor configuration hash.

AdHoc attributes are attributes which are not defined by the class, and are not handled by the MyClass.NONATTRS_CFG

Default: undefined (false)

`_buttonFocus`

Boolean protected

Defined in uploader/js/uploader-flash.js:41

Stored value of the current button focus state (based on keyboard and mouse events).

`_buttonState`

String protected

Defined in uploader/js/uploader-flash.js:32

Stored value of the current button state (based on mouse events dispatched by the Flash player)

`_swfContainerId`

String protected

Defined in uploader/js/uploader-flash.js:50

Stored value of the unique id for the container that holds the Flash uploader.

`_swfReference`

SWF protected

Defined in uploader/js/uploader-flash.js:60

Stored reference to the instance of SWF used to host the Flash uploader.

`_tabElementBindings`

Object protected

Defined in uploader/js/uploader-flash.js:82

Stored event bindings for keyboard navigation to and from the uploader.

`_UI_ATTRS`

Object private

Inherited from Widget: widget/js/Widget.js:1247

The lists of UI attributes to bind and sync for widget's _bindUI and _syncUI implementations

`ATTRS`

Object protected static

Defined in uploader/js/uploader-flash.js:772

Static property used to define the default attribute configuration of the Widget.

`BOUNDING_TEMPLATE`

String

Inherited from Widget: widget/js/Widget.js:1143

Property defining the markup template for bounding box.

`CONTENT_TEMPLATE`

String

Inherited from Widget: widget/js/Widget.js:1133

Property defining the markup template for content box. If your Widget doesn't need the dual boundingBox/contentBox structure, set CONTENT_TEMPLATE to null, and contentBox and boundingBox will both point to the same Node.

`DEF_PARENT_NODE`

String | Node

Inherited from Widget: widget/js/Widget.js:1124

Default node to render the bounding box to. If not set, will default to the current document body.

`DEF_UNIT`

String

Inherited from Widget: widget/js/Widget.js:1116

Default unit to use for dimension values

`FLASH_CONTAINER`

HTML static

Defined in uploader/js/uploader-flash.js:726

The template for the Flash player container. Since the Flash player container needs to completely overlay the &lquot;Select Files&rqot; control, it's positioned absolutely, with width and height set to 100% of the parent.

Default: '<div id="{swfContainerId}" style="position:absolute; top:0px; left: 0px; margin: 0; padding: 0; border: 0; width:100%; height:100%"></div>'

`name`

String deprecated

Inherited from BaseCore: base/js/BaseCore.js:197

Deprecated: Use this.constructor.NAME

The string used to identify the class of this object.

`NAME`

String protected static

Defined in uploader/js/uploader-flash.js:760

The identity of the widget.

Default: 'uploader'

`queue`

Y.Uploader.Queue

Defined in uploader/js/uploader-flash.js:70

Stored reference to the instance of Uploader.Queue used to manage the upload process. This is a read-only property that only exists during an active upload process. Only one queue can be active at a time; if an upload start is attempted while a queue is active, it will be ignored.

`SELECT_FILES_BUTTON`

HTML static

Defined in uploader/js/uploader-flash.js:740

The template for the "Select Files" button.

Default: "<button type='button' class='yui3-button' tabindex='-1'>{selectButtonLabel}</button>"

`TYPE`

String static

Defined in uploader/js/uploader-flash.js:750

The static property reflecting the type of uploader that Y.Uploader aliases. The UploaderFlash value is "flash".

`UI_EVENTS`

Object

Inherited from Widget: widget/js/WidgetUIEvents.js:52

Map of DOM events that should be fired as Custom Events by the
Widget instance.

Attributes

`appendNewFiles`

Boolean

Defined in uploader/js/uploader-flash.js:783

A Boolean indicating whether newly selected files should be appended to the existing file list, or whether they should replace it.

Default: true

Fires event `appendNewFilesChange`

Fires when the value for the configuration attribute appendNewFiles is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed.

Parameters:

e EventFacade
An Event Facade object with the following attribute-specific properties added:
- prevVal Any
  The value of the attribute, prior to it being set.
- newVal Any
  The value the attribute is to be set to.
- attrName String
  The name of the attribute being set.
- subAttrName String
  If setting a property within the attribute's value, the name of the sub-attribute property being set.

`boundingBox`

String | Node

Inherited from Widget: widget/js/Widget.js:175

The outermost DOM node for the Widget, used for sizing and positioning of a Widget as well as a containing element for any decorator elements used for skinning.

Fires event `boundingBoxChange`

Fires when the value for the configuration attribute boundingBox is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed.

Parameters:

e EventFacade
An Event Facade object with the following attribute-specific properties added:
- prevVal Any
  The value of the attribute, prior to it being set.
- newVal Any
  The value the attribute is to be set to.
- attrName String
  The name of the attribute being set.
- subAttrName String
  If setting a property within the attribute's value, the name of the sub-attribute property being set.

`buttonClassNames`

Object

Defined in uploader/js/uploader-flash.js:795

The names of CSS classes that correspond to different button states of the "Select Files" control. These classes are assigned to the "Select Files" control based on the mouse states reported by the Flash player. The keys for the class names are:

hover: the class corresponding to mouse hovering over the "Select Files" button.
active: the class corresponding to mouse down state of the "Select Files" button.
disabled: the class corresponding to the disabled state of the "Select Files" button.
focus: the class corresponding to the focused state of the "Select Files" button.

Default: { hover: "yui3-button-hover", active: "yui3-button-active", disabled: "yui3-button-disabled", focus: "yui3-button-selected" }

Fires event `buttonClassNamesChange`

Fires when the value for the configuration attribute buttonClassNames is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed.

Parameters:

e EventFacade
An Event Facade object with the following attribute-specific properties added:
- prevVal Any
  The value of the attribute, prior to it being set.
- newVal Any
  The value the attribute is to be set to.
- attrName String
  The name of the attribute being set.
- subAttrName String
  If setting a property within the attribute's value, the name of the sub-attribute property being set.

`contentBox`

String | Node

Inherited from Widget: widget/js/Widget.js:189

A DOM node that is a direct descendant of a Widget's bounding box that houses its content.

Fires event `contentBoxChange`

Fires when the value for the configuration attribute contentBox is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed.

Parameters:

e EventFacade
An Event Facade object with the following attribute-specific properties added:
- prevVal Any
  The value of the attribute, prior to it being set.
- newVal Any
  The value the attribute is to be set to.
- attrName String
  The name of the attribute being set.
- subAttrName String
  If setting a property within the attribute's value, the name of the sub-attribute property being set.

`destroyed`

Boolean readonly

Inherited from BaseCore: base/js/BaseCore.js:157

Flag indicating whether or not this object has been through the destroy lifecycle phase.

Default: false

Fires event `destroyedChange`

Fires when the value for the configuration attribute destroyed is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed.

Parameters:

e EventFacade
An Event Facade object with the following attribute-specific properties added:
- prevVal Any
  The value of the attribute, prior to it being set.
- newVal Any
  The value the attribute is to be set to.
- attrName String
  The name of the attribute being set.
- subAttrName String
  If setting a property within the attribute's value, the name of the sub-attribute property being set.

`disabled`

Boolean

Inherited from Widget: widget/js/Widget.js:231

Boolean indicating if the Widget should be disabled. The disabled implementation is left to the specific classes extending widget.

Default: false

Fires event `disabledChange`

Fires when the value for the configuration attribute disabled is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed.

Parameters:

e EventFacade
An Event Facade object with the following attribute-specific properties added:
- prevVal Any
  The value of the attribute, prior to it being set.
- newVal Any
  The value the attribute is to be set to.
- attrName String
  The name of the attribute being set.
- subAttrName String
  If setting a property within the attribute's value, the name of the sub-attribute property being set.

`enabled`

Boolean

Defined in uploader/js/uploader-flash.js:827

A Boolean indicating whether the uploader is enabled or disabled for user input.

Default: true

Fires event `enabledChange`

Fires when the value for the configuration attribute enabled is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed.

Parameters:

e EventFacade
An Event Facade object with the following attribute-specific properties added:
- prevVal Any
  The value of the attribute, prior to it being set.
- newVal Any
  The value the attribute is to be set to.
- attrName String
  The name of the attribute being set.
- subAttrName String
  If setting a property within the attribute's value, the name of the sub-attribute property being set.

`errorAction`

String

Defined in uploader/js/uploader-flash.js:838

The action performed when an upload error occurs for a specific file being uploaded. The possible values are:

UploaderQueue.CONTINUE: the error is ignored and the upload process is continued.
UploaderQueue.STOP: the upload process is stopped as soon as any other parallel file uploads are finished.
UploaderQueue.RESTART_ASAP: the file is added back to the front of the queue.
UploaderQueue.RESTART_AFTER: the file is added to the back of the queue.

Default: UploaderQueue.CONTINUE

Fires event `errorActionChange`

Fires when the value for the configuration attribute errorAction is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed.

Parameters:

e EventFacade
An Event Facade object with the following attribute-specific properties added:
- prevVal Any
  The value of the attribute, prior to it being set.
- newVal Any
  The value the attribute is to be set to.
- attrName String
  The name of the attribute being set.
- subAttrName String
  If setting a property within the attribute's value, the name of the sub-attribute property being set.

`fileFieldName`

String

Defined in uploader/js/uploader-flash.js:897

A String specifying what should be the POST field name for the file content in the upload request.

Default: Filedata

Fires event `fileFieldNameChange`

Fires when the value for the configuration attribute fileFieldName is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed.

Parameters:

e EventFacade
An Event Facade object with the following attribute-specific properties added:
- prevVal Any
  The value of the attribute, prior to it being set.
- newVal Any
  The value the attribute is to be set to.
- attrName String
  The name of the attribute being set.
- subAttrName String
  If setting a property within the attribute's value, the name of the sub-attribute property being set.

`fileFilterFunction`

Function

Defined in uploader/js/uploader-flash.js:880

A filtering function that is applied to every file selected by the user. The function receives the Y.File object and must return a Boolean value. If a false value is returned, the file in question is not added to the list of files to be uploaded. Use this function to put limits on file sizes or check the file names for correct extension, but make sure that a server-side check is also performed, since any client-side restrictions are only advisory and can be circumvented.

Default: null

Fires event `fileFilterFunctionChange`

Fires when the value for the configuration attribute fileFilterFunction is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed.

Parameters:

e EventFacade
An Event Facade object with the following attribute-specific properties added:
- prevVal Any
  The value of the attribute, prior to it being set.
- newVal Any
  The value the attribute is to be set to.
- attrName String
  The name of the attribute being set.
- subAttrName String
  If setting a property within the attribute's value, the name of the sub-attribute property being set.

`fileFilters`

Array

Defined in uploader/js/uploader-flash.js:864

An array indicating what fileFilters should be applied to the file selection dialog. Each element in the array should be an object with the following key-value pairs: { description : String extensions: String of the form &lquot;.ext1;.ext2;*.ext3;...&rquot; }

Default: []

Fires event `fileFiltersChange`

Fires when the value for the configuration attribute fileFilters is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed.

Parameters:

e EventFacade
An Event Facade object with the following attribute-specific properties added:
- prevVal Any
  The value of the attribute, prior to it being set.
- newVal Any
  The value the attribute is to be set to.
- attrName String
  The name of the attribute being set.
- subAttrName String
  If setting a property within the attribute's value, the name of the sub-attribute property being set.

`fileList`

Array

Defined in uploader/js/uploader-flash.js:909

The array of files to be uploaded. All elements in the array must be instances of Y.FileFlash and be instantiated with a fileId retrieved from an instance of the uploader.

Default: []

Fires event `fileListChange`

Fires when the value for the configuration attribute fileList is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed.

Parameters:

e EventFacade
An Event Facade object with the following attribute-specific properties added:
- prevVal Any
  The value of the attribute, prior to it being set.
- newVal Any
  The value the attribute is to be set to.
- attrName String
  The name of the attribute being set.
- subAttrName String
  If setting a property within the attribute's value, the name of the sub-attribute property being set.

`focused`

Boolean readonly

Inherited from Widget: widget/js/Widget.js:218

Boolean indicating if the Widget, or one of its descendants, has focus.

Default: false

Fires event `focusedChange`

Fires when the value for the configuration attribute focused is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed.

Parameters:

e EventFacade
An Event Facade object with the following attribute-specific properties added:
- prevVal Any
  The value of the attribute, prior to it being set.
- newVal Any
  The value the attribute is to be set to.
- attrName String
  The name of the attribute being set.
- subAttrName String
  If setting a property within the attribute's value, the name of the sub-attribute property being set.

`height`

String | Number

Inherited from Widget: widget/js/Widget.js:252

String with units, or number, representing the height of the Widget. If a number is provided, the default unit, defined by the Widgets DEF_UNIT, property is used.

Default: EMPTY_STR

Fires event `heightChange`

Fires when the value for the configuration attribute height is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed.

Parameters:

e EventFacade
An Event Facade object with the following attribute-specific properties added:
- prevVal Any
  The value of the attribute, prior to it being set.
- newVal Any
  The value the attribute is to be set to.
- attrName String
  The name of the attribute being set.
- subAttrName String
  If setting a property within the attribute's value, the name of the sub-attribute property being set.

`id`

String

Inherited from Widget: widget/js/Widget.js:149

Default: Generated using guid()

Fires event `idChange`

Fires when the value for the configuration attribute id is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed.

Parameters:

e EventFacade
An Event Facade object with the following attribute-specific properties added:
- prevVal Any
  The value of the attribute, prior to it being set.
- newVal Any
  The value the attribute is to be set to.
- attrName String
  The name of the attribute being set.
- subAttrName String
  If setting a property within the attribute's value, the name of the sub-attribute property being set.

`initialized`

Boolean readonly

Inherited from BaseCore: base/js/BaseCore.js:143

Flag indicating whether or not this object has been through the init lifecycle phase.

Default: false

Fires event `initializedChange`

Fires when the value for the configuration attribute initialized is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed.

Parameters:

e EventFacade
An Event Facade object with the following attribute-specific properties added:
- prevVal Any
  The value of the attribute, prior to it being set.
- newVal Any
  The value the attribute is to be set to.
- attrName String
  The name of the attribute being set.
- subAttrName String
  If setting a property within the attribute's value, the name of the sub-attribute property being set.

`locale`

String deprecated

Inherited from Widget: widget/js/WidgetLocale.js:14

Deprecated: Use Y.config.lang and Y.Intl externalization support

The default locale for the widget. NOTE: Using get/set on the "strings" attribute will return/set strings for this locale.

Default: "en"

Fires event `localeChange`

Fires when the value for the configuration attribute locale is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed.

Parameters:

e EventFacade
An Event Facade object with the following attribute-specific properties added:
- prevVal Any
  The value of the attribute, prior to it being set.
- newVal Any
  The value the attribute is to be set to.
- attrName String
  The name of the attribute being set.
- subAttrName String
  If setting a property within the attribute's value, the name of the sub-attribute property being set.

`multipleFiles`

Boolean

Defined in uploader/js/uploader-flash.js:924

A Boolean indicating whether multiple file selection is enabled.

Default: false

Fires event `multipleFilesChange`

Fires when the value for the configuration attribute multipleFiles is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed.

Parameters:

e EventFacade
An Event Facade object with the following attribute-specific properties added:
- prevVal Any
  The value of the attribute, prior to it being set.
- newVal Any
  The value the attribute is to be set to.
- attrName String
  The name of the attribute being set.
- subAttrName String
  If setting a property within the attribute's value, the name of the sub-attribute property being set.

`postVarsPerFile`

Object

Defined in uploader/js/uploader-flash.js:935

An object, keyed by fileId, containing sets of key-value pairs that should be passed as POST variables along with each corresponding file. This attribute is only used if no POST variables are specifed in the upload method call.

Default: {}

Fires event `postVarsPerFileChange`

Fires when the value for the configuration attribute postVarsPerFile is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed.

Parameters:

e EventFacade
An Event Facade object with the following attribute-specific properties added:
- prevVal Any
  The value of the attribute, prior to it being set.
- newVal Any
  The value the attribute is to be set to.
- attrName String
  The name of the attribute being set.
- subAttrName String
  If setting a property within the attribute's value, the name of the sub-attribute property being set.

`render`

Boolean | Node

Inherited from Widget: widget/js/Widget.js:286

Whether or not to render the widget automatically after init, and optionally, to which parent node.

Fires event `renderChange`

Fires when the value for the configuration attribute render is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed.

Parameters:

e EventFacade
An Event Facade object with the following attribute-specific properties added:
- prevVal Any
  The value of the attribute, prior to it being set.
- newVal Any
  The value the attribute is to be set to.
- attrName String
  The name of the attribute being set.
- subAttrName String
  If setting a property within the attribute's value, the name of the sub-attribute property being set.

`rendered`

Boolean readonly

Inherited from Widget: widget/js/Widget.js:161

Flag indicating whether or not this Widget has been through the render lifecycle phase.

Default: false

Fires event `renderedChange`

Fires when the value for the configuration attribute rendered is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed.

Parameters:

e EventFacade
An Event Facade object with the following attribute-specific properties added:
- prevVal Any
  The value of the attribute, prior to it being set.
- newVal Any
  The value the attribute is to be set to.
- attrName String
  The name of the attribute being set.
- subAttrName String
  If setting a property within the attribute's value, the name of the sub-attribute property being set.

`retryCount`

Number

Defined in uploader/js/uploader-flash.js:1046

The number of times to try re-uploading a file that failed to upload before cancelling its upload.

Default: 3

Fires event `retryCountChange`

Fires when the value for the configuration attribute retryCount is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed.

Parameters:

e EventFacade
An Event Facade object with the following attribute-specific properties added:
- prevVal Any
  The value of the attribute, prior to it being set.
- newVal Any
  The value the attribute is to be set to.
- attrName String
  The name of the attribute being set.
- subAttrName String
  If setting a property within the attribute's value, the name of the sub-attribute property being set.

`selectButtonLabel`

String

Defined in uploader/js/uploader-flash.js:949

The label for the "Select Files" widget. This is the value that replaces the {selectButtonLabel} token in the SELECT_FILES_BUTTON template.

Default: "Select Files"

Fires event `selectButtonLabelChange`

Fires when the value for the configuration attribute selectButtonLabel is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed.

Parameters:

e EventFacade
An Event Facade object with the following attribute-specific properties added:
- prevVal Any
  The value of the attribute, prior to it being set.
- newVal Any
  The value the attribute is to be set to.
- attrName String
  The name of the attribute being set.
- subAttrName String
  If setting a property within the attribute's value, the name of the sub-attribute property being set.

`selectFilesButton`

Node | Widget

Defined in uploader/js/uploader-flash.js:961

The widget that serves as the "Select Files" control for the file uploader

Default: A standard HTML button with YUI CSS Button skin.

Fires event `selectFilesButtonChange`

Fires when the value for the configuration attribute selectFilesButton is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed.

Parameters:

e EventFacade
An Event Facade object with the following attribute-specific properties added:
- prevVal Any
  The value of the attribute, prior to it being set.
- newVal Any
  The value the attribute is to be set to.
- attrName String
  The name of the attribute being set.
- subAttrName String
  If setting a property within the attribute's value, the name of the sub-attribute property being set.

`simLimit`

Number

Defined in uploader/js/uploader-flash.js:975

The number of files that can be uploaded simultaneously if the automatic queue management is used. This value can be in the range between 2 and 5.

Default: 2

Fires event `simLimitChange`

Fires when the value for the configuration attribute simLimit is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed.

Parameters:

e EventFacade
An Event Facade object with the following attribute-specific properties added:
- prevVal Any
  The value of the attribute, prior to it being set.
- newVal Any
  The value the attribute is to be set to.
- attrName String
  The name of the attribute being set.
- subAttrName String
  If setting a property within the attribute's value, the name of the sub-attribute property being set.

`srcNode`

String | Node

Inherited from Widget: widget/js/WidgetHTMLParser.js:58

The DOM node to parse for configuration values, passed to the Widget's HTML_PARSER definition

Fires event `srcNodeChange`

Fires when the value for the configuration attribute srcNode is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed.

Parameters:

e EventFacade
An Event Facade object with the following attribute-specific properties added:
- prevVal Any
  The value of the attribute, prior to it being set.
- newVal Any
  The value the attribute is to be set to.
- attrName String
  The name of the attribute being set.
- subAttrName String
  If setting a property within the attribute's value, the name of the sub-attribute property being set.

`strings`

Object

Inherited from Widget: widget/js/Widget.js:274

Collection of strings used to label elements of the Widget's UI.

Default: null

Fires event `stringsChange`

Fires when the value for the configuration attribute strings is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed.

Parameters:

e EventFacade
An Event Facade object with the following attribute-specific properties added:
- prevVal Any
  The value of the attribute, prior to it being set.
- newVal Any
  The value the attribute is to be set to.
- attrName String
  The name of the attribute being set.
- subAttrName String
  If setting a property within the attribute's value, the name of the sub-attribute property being set.

`swfURL`

String

Defined in uploader/js/uploader-flash.js:992

The URL to the SWF file of the flash uploader. A copy local to the server that hosts the page on which the uploader appears is recommended.

Default: "CDN Prefix + uploader/assets/flashuploader.swf" with a random GET parameter for IE (to prevent buggy behavior when the SWF is cached).

Fires event `swfURLChange`

Fires when the value for the configuration attribute swfURL is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed.

Parameters:

e EventFacade
An Event Facade object with the following attribute-specific properties added:
- prevVal Any
  The value of the attribute, prior to it being set.
- newVal Any
  The value the attribute is to be set to.
- attrName String
  The name of the attribute being set.
- subAttrName String
  If setting a property within the attribute's value, the name of the sub-attribute property being set.

`tabElements`

Object

Defined in uploader/js/uploader-flash.js:1015

The id's or Node references of the DOM elements that precede and follow the Select Files button in the tab order. Specifying these allows keyboard navigation to and from the Flash player layer of the uploader. The two keys corresponding to the DOM elements are:

from: the id or the Node reference corresponding to the DOM element that precedes the Select Files button in the tab order.
to: the id or the Node reference corresponding to the DOM element that follows the Select Files button in the tab order.

Default: null

Fires event `tabElementsChange`

Fires when the value for the configuration attribute tabElements is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed.

Parameters:

e EventFacade
An Event Facade object with the following attribute-specific properties added:
- prevVal Any
  The value of the attribute, prior to it being set.
- newVal Any
  The value the attribute is to be set to.
- attrName String
  The name of the attribute being set.
- subAttrName String
  If setting a property within the attribute's value, the name of the sub-attribute property being set.

`tabIndex`

Number

Inherited from Widget: widget/js/Widget.js:202

Number (between -32767 to 32767) indicating the widget's position in the default tab flow. The value is used to set the "tabIndex" attribute on the widget's bounding box. Negative values allow the widget to receive DOM focus programmatically (by calling the focus method), while being removed from the default tab flow. A value of null removes the "tabIndex" attribute from the widget's bounding box.

Default: null

Fires event `tabIndexChange`

Fires when the value for the configuration attribute tabIndex is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed.

Parameters:

e EventFacade
An Event Facade object with the following attribute-specific properties added:
- prevVal Any
  The value of the attribute, prior to it being set.
- newVal Any
  The value the attribute is to be set to.
- attrName String
  The name of the attribute being set.
- subAttrName String
  If setting a property within the attribute's value, the name of the sub-attribute property being set.

`uploadURL`

String

Defined in uploader/js/uploader-flash.js:1035

The URL to which file upload requested are POSTed. Only used if a different url is not passed to the upload method call.

Default: ""

Fires event `uploadURLChange`

Fires when the value for the configuration attribute uploadURL is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed.

Parameters:

e EventFacade
An Event Facade object with the following attribute-specific properties added:
- prevVal Any
  The value of the attribute, prior to it being set.
- newVal Any
  The value the attribute is to be set to.
- attrName String
  The name of the attribute being set.
- subAttrName String
  If setting a property within the attribute's value, the name of the sub-attribute property being set.

`visible`

Boolean

Inherited from Widget: widget/js/Widget.js:242

Boolean indicating whether or not the Widget is visible.

Default: TRUE

Fires event `visibleChange`

Fires when the value for the configuration attribute visible is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed.

Parameters:

e EventFacade
An Event Facade object with the following attribute-specific properties added:
- prevVal Any
  The value of the attribute, prior to it being set.
- newVal Any
  The value the attribute is to be set to.
- attrName String
  The name of the attribute being set.
- subAttrName String
  If setting a property within the attribute's value, the name of the sub-attribute property being set.

`width`

String | Number

Inherited from Widget: widget/js/Widget.js:263

String with units, or number, representing the width of the Widget. If a number is provided, the default unit, defined by the Widgets DEF_UNIT, property is used.

Default: EMPTY_STR

Fires event `widthChange`

Fires when the value for the configuration attribute width is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed.

Parameters:

e EventFacade
An Event Facade object with the following attribute-specific properties added:
- prevVal Any
  The value of the attribute, prior to it being set.
- newVal Any
  The value the attribute is to be set to.
- attrName String
  The name of the attribute being set.
- subAttrName String
  If setting a property within the attribute's value, the name of the sub-attribute property being set.

Events

`alluploadscomplete`

Defined in uploader/js/uploader-flash.js:201

Signals that the upload process of the entire file list has been completed.

Event Payload:

event Event

The event object for the alluploadscomplete.

`click`

Defined in uploader/js/uploader-flash.js:262

Signals that a mouse has been clicked over the Select Files button.

Event Payload:

event Event

The event object for the click event.

`destroy`

Inherited from BaseObservable: base/js/BaseObservable.js:144

Lifecycle event for the destroy phase, fired prior to destruction. Invoking the preventDefault method on the event object provided to subscribers will prevent destruction from proceeding.

Subscribers to the "after" moment of this event, will be notified after destruction is complete (and as a result cannot prevent destruction).

Event Payload:

e EventFacade

Event object

`fileselect`

Defined in uploader/js/uploader-flash.js:111

Signals that files have been selected.

Event Payload:

event Event

The event object for the fileselect with the following payload:

fileList

An Array of files selected by the user, encapsulated in Y.FileFlash objects.

`fileuploadstart`

Defined in uploader/js/uploader-flash.js:133

Signals that an upload of a specific file has started.

Event Payload:

event Event

The event object for the fileuploadstart with the following payload:

file

A reference to the Y.File that dispatched the event.

originEvent

The original event dispatched by Y.File.

`init`

Inherited from BaseObservable: base/js/BaseObservable.js:61

Lifecycle event for the init phase, fired prior to initialization. Invoking the preventDefault() method on the event object provided to subscribers will prevent initialization from occuring.

Subscribers to the "after" momemt of this event, will be notified after initialization of the object is complete (and therefore cannot prevent initialization).

Event Payload:

e EventFacade

Event object, with a cfg property which refers to the configuration object passed to the constructor.

`mousedown`

Defined in uploader/js/uploader-flash.js:246

Signals that a mouse button has been pressed over the Select Files button.

Event Payload:

event Event

The event object for the mousedown event.

`mouseenter`

Defined in uploader/js/uploader-flash.js:230

Signals that a mouse has begun hovering over the Select Files button.

Event Payload:

event Event

The event object for the mouseenter event.

`mouseleave`

Defined in uploader/js/uploader-flash.js:238

Signals that a mouse has stopped hovering over the Select Files button.

Event Payload:

event Event

The event object for the mouseleave event.

`mouseup`

Defined in uploader/js/uploader-flash.js:254

Signals that a mouse button has been released over the Select Files button.

Event Payload:

event Event

The event object for the mouseup event.

`totaluploadprogress`

Defined in uploader/js/uploader-flash.js:167

Reports on the total upload progress of the file list.

Event Payload:

event Event

The event object for the totaluploadprogress with the following payload:

bytesLoaded

The number of bytes of the file list that has been uploaded

bytesTotal

The total number of bytes in the file list

percentLoaded

The fraction of the file list that has been uploaded, out of 100

`uploadcomplete`

Defined in uploader/js/uploader-flash.js:184

Signals that a single file upload has been completed.

Event Payload:

event Event

The event object for the uploadcomplete with the following payload:

file

The pointer to the instance of Y.File whose upload has been completed.

originEvent

The original event fired by the SWF Uploader

data

Data returned by the server.

`uploaderror`

Defined in uploader/js/uploader-flash.js:209

Signals that a error has occurred in a specific file's upload process.

Event Payload:

event Event

The event object for the uploaderror with the following payload:

originEvent

The original error event fired by the SWF Uploader.

file

The pointer at the instance of Y.FileFlash that returned the error.

source

The source of the upload error, either "io" or "http"

message

The message that accompanied the error. Corresponds to the text of the error in cases where source is "io", and to the HTTP status for cases where source is "http".

`uploadprogress`

Defined in uploader/js/uploader-flash.js:148

Reports on upload progress of a specific file.

Event Payload:

event Event

The event object for the uploadprogress with the following payload:

bytesLoaded

The number of bytes of the file that has been uploaded

bytesTotal

The total number of bytes in the file

percentLoaded

The fraction of the file that has been uploaded, out of 100

originEvent

The original event dispatched by the SWF uploader

`uploadstart`

Defined in uploader/js/uploader-flash.js:125

Signals that an upload of multiple files has been started.

Event Payload:

event Event

The event object for the uploadstart.

`widget:contentUpdate`

Inherited from Widget: widget/js/Widget.js:397

Notification event, which widget implementations can fire, when they change the content of the widget. This event has no default behavior and cannot be prevented, so the "on" or "after" moments are effectively equivalent (with on listeners being invoked before after listeners).

Event Payload:

e EventFacade

The Event Facade

`widget:render`

Inherited from Widget: widget/js/Widget.js:541

Lifecycle event for the render phase, fired prior to rendering the UI for the widget (prior to invoking the widget's renderer method).

Subscribers to the "on" moment of this event, will be notified before the widget is rendered.

Subscribers to the "after" moment of this event, will be notified after rendering is complete.

Event Payload:

e EventFacade

The Event Facade

APIs

UploaderFlash Class

Constructor

UploaderFlash

Parameters:

Item Index

Methods

Properties

Attributes

Events

Methods

_addAttrs

Parameters:

_addLazyAttr

Parameters:

_afterChildSelectedChange

Parameters:

_aggregateAttrs

Parameters:

Returns:

_applyParsedConfig

Returns:

_applyParser

Parameters:

_attachTabElements

Parameters:

_attrCfgHash

_baseDestroy

_baseInit

_bindAttrUI

Parameters:

_bindDOM

_bindUI

_bindUIChild

_createUIEvent

Parameters:

_defAttrChangeFn

Parameters:

_defaultCB

_defDestroyFn

Parameters:

_defInitFn

Parameters:

_defRenderFn

Parameters:

_destroyBox

_destroyHierarchy

_destroyUIEvents

_filterAdHocAttrs

Parameters:

Returns:

_filterAttrCfs

Parameters:

Returns:

_filterUIEvent

Parameters:

Returns:

_fireAttrChange

Parameters:

_getAttr

Parameters:

Returns:

_getAttrCfg

Parameters:

Returns:

_getAttrCfgs

Returns:

_getAttrInitVal

Parameters:

Returns:

_getAttrs

Parameters:

Returns:

_getClasses

Returns:

_getFileList

_getHtmlParser

Returns:

_getNodeToParse

Returns:

`UploaderFlash`

`_addAttrs`

`_addLazyAttr`

`_afterChildSelectedChange`

`_aggregateAttrs`

`_applyParsedConfig`

`_applyParser`

`_attachTabElements`

`_attrCfgHash`

`_baseDestroy`

`_baseInit`

`_bindAttrUI`

`_bindDOM`

`_bindUI`

`_bindUIChild`

`_createUIEvent`

`_defAttrChangeFn`

`_defaultCB`

`_defDestroyFn`

`_defInitFn`

`_defRenderFn`

`_destroyBox`

`_destroyHierarchy`

`_destroyUIEvents`

`_filterAdHocAttrs`

`_filterAttrCfs`

`_filterUIEvent`

`_fireAttrChange`

`_getAttr`

`_getAttrCfg`

`_getAttrCfgs`

`_getAttrInitVal`

`_getAttrs`

`_getClasses`

`_getFileList`

`_getHtmlParser`

`_getNodeToParse`

`_getSrcNode`

`_getStateVal`

`_getStrings`

`_getType`

`_getUIEventNode`

`_guid`

`_initAttrHost`

`_initAttribute`

`_initAttrs`

`_initBase`

`_initHierarchy`

`_initHierarchyData`

`_initUIEvent`

`_isLazyAttr`

`_isUIEvent`

`_mapInstance`

`_monitor`

`_normAttrVals`

`_onDocFocus`

`_onDocMouseDown`

`_parseType`

`_preInitEventCfg`

`_protectAttrs`

`_removeLoadingClassNames`

`_renderBox`

`_renderBoxClassNames`

`_renderUI`

`_set`

`_setAttr`

`_setAttrs`

`_setAttrUI`

`_setAttrVal`

`_setBB`

`_setBox`