DD.DDM Class

Extends Base

Defined in: dd/js/ddm-base.js:7

Module: dd-ddm-base
Parent Module: dd

Provides the base Drag Drop Manager required for making a Node draggable.

Constructor

`DD.DDM`

()

Defined in dd/js/ddm-base.js:7

Index
Methods
Properties
Attributes
Events

Item Index

Methods

`_activateTargets`

() private

Provided by the dd-ddm-drop module.

Defined in dd/js/ddm-drop.js:209

Clear the cache and activate the shims of all the targets

`_addActiveShim`

(

)

private

Provided by the dd-ddm-drop module.

Defined in dd/js/ddm-drop.js:39

Adds a Drop Target to the list of active shims

Parameters:

d Object

The Drop instance to add to the list.

`_addAttrs`

(

cfgs
values
lazy

)

private

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

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
[lazyCfg]

)

private

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

Finishes initializing an attribute which has been lazily added.

Parameters:

name Object

The name of the attribute
[lazyCfg] Object optional

Optional config hash for the attribute. This is added for performance along the critical path, where the calling method has already obtained lazy config from state.

`_addOutOfOrder`

(

name
cfg

)

private

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

Utility method used by get/set to add attributes encountered out of order when calling addAttrs().

For example, if:

this.addAttrs({
     foo: {
         setter: function() {
            // make sure this bar is available when foo is added
            this.get("bar");
         }
     },
     bar: {
         value: ...
     }
});

Parameters:

name String

attribute name
cfg Object

attribute configuration

`_addValid`

(

drop

)

private chainable

Provided by the dd-ddm-drop module.

Defined in dd/js/ddm-drop.js:136

Add a Drop Target to the list of Valid Targets. This list get's regenerated on each new drag operation.

Parameters:

drop Object

`_aggregateAttrs`

(

allAttrs

)

Object private

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

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

`_attrCfgHash`

() private

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

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

`_baseDestroy`

() private

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

Internal destroy implementation for BaseCore

`_baseInit`

() private

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

Internal initialization implementation for BaseCore

`_calcTickArray`

(

pos
ticks
off1
off2

)

private

Provided by the dd-constrain module.

Defined in dd/js/constrain.js:512

This method is used with the tickXArray and tickYArray config options

Parameters:

pos Number

The current X or Y position
ticks Number

The array containing our custom tick positions.
off1 Number

The min offset that we can't pass (region)
off2 Number

The max offset that we can't pass (region)

Returns:

The tick position

`_calcTicks`

(

pos
start
tick
off1
off2

)

Number private

Provided by the dd-constrain module.

Defined in dd/js/constrain.js:480

Helper method to calculate the tick offsets for a given position

Parameters:

pos Number

The current X or Y position
start Number

The start X or Y position
tick Number

The X or Y tick increment
off1 Number

The min offset that we can't pass (region)
off2 Number

The max offset that we can't pass (region)

Returns:

Number:

The new position based on the tick calculation

`_cloneDefaultValue`

(

cfg

)

private

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

This method assumes that the value has already been checked to be an object. Since it's on a critical path, we don't want to re-do the check.

Parameters:

cfg Object

`_createFrame`

() private

Provided by the dd-proxy module.

Defined in dd/js/proxy.js:171

Create the proxy element if it doesn't already exist and set the DD.DDM._proxy value

`_createPG`

() private

Provided by the dd-ddm module.

Defined in dd/js/ddm.js:89

Creates the shim and adds it's listeners to it.

`_deactivateTargets`

() private

Provided by the dd-ddm-drop module.

Defined in dd/js/ddm-drop.js:259

This method fires the drop:hit, drag:drophit, drag:dropmiss methods and deactivates the shims..

`_defAttrChangeFn`

(

e
eventFastPath

)

private

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

Default function for attribute change events.

Parameters:

e EventFacade

The event object for attribute change events.
eventFastPath Boolean

Whether or not we're using this as a fast path in the case of no listeners or not

`_defDestroyFn`

(

)

protected

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

Default destroy event handler

Parameters:

e EventFacade

Event object

`_defInitFn`

(

)

protected

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

Default init event handler

Parameters:

e EventFacade

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

`_destroyHierarchy`

() private

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

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

`_docMove`

(

ev

)

private

Defined in dd/js/ddm-base.js:226

Internal listener for the mousemove on Document. Checks if the shim is in place to only call _move once per mouse move

Parameters:

ev EventFacade

The Dom mousemove Event

`_dropMove`

() private

Provided by the dd-ddm-drop module.

Defined in dd/js/ddm-drop.js:296

This method is called when the move method is called on the Drag Object.

`_end`

() private

Defined in dd/js/ddm-base.js:193

Internal method used by Drag to signal the end of a drag operation

`_endDrag`

() private

Defined in dd/js/ddm-base.js:186

Factory method to be overwritten by other DDM's

`_filterAdHocAttrs`

(

allAttrs
userVals

)

Object private

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

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.

`_fireAttrChange`

(

attrName
subAttrName
currVal
newVal
opts
[cfg]

)

private

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

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.
[cfg] Object optional

The attribute config stored in State, if already available.

`_getAttr`

(

name

)

Any protected chainable

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

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

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

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

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

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

Parameters:

attrs String[] | 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:378

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.

`_getFullType`

(

type

)

String private

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

Returns the fully qualified type, given a short type string. That is, returns "foo:bar" when given "bar" if "foo" is the configured prefix.

NOTE: This method, unlike _getType, does no checking of the value passed in, and is designed to be used with the low level _publish() method, for critical path implementations which need to fast-track publish for performance reasons.

Parameters:

type String

The short type to prefix

Returns:

String:

The prefixed type, if a prefix is set, otherwise the type passed in

`_getInstanceAttrCfgs`

(

allCfgs

)

Object private

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

A helper method used to isolate the attrs config for this instance to pass to addAttrs, from the static cached ATTRS for the class.

Parameters:

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 to be added for this instance, suitable for passing through to addAttrs.

`_getStateVal`

(

name
[cfg]

)

Any private

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

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
[cfg] Object optional

Optional config hash for the attribute. This is added for performance along the critical path, where the calling method has already obtained the config from state.

Returns:

Any:

The stored value of the attribute

`_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.

`_handleTargetOver`

() private

Provided by the dd-ddm-drop module.

Defined in dd/js/ddm-drop.js:330

This method execs _handleTargetOver on all valid Drop Targets

`_hasActiveShim`

() Boolean private

Provided by the dd-ddm-drop module.

Defined in dd/js/ddm-drop.js:27

This method checks the _activeShims Object to see if there is a shim active.

Returns:

Boolean:

`_hasPotentialSubscribers`

(

fullType

)

Boolean private

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

Parameters:

fullType String

The fully prefixed type name

Returns:

Boolean:

Whether the event has potential subscribers or not

`_initAttrHost`

(

attrs
values
lazy

)

private

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

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

Initializes AttributeCore

`_initAttrs`

(

attrs
values
lazy

)

protected

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

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

Internal construction logic for BaseCore.

Parameters:

config Object

The constructor configuration object

`_initHierarchy`

(

userVals

)

private

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

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

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.

`_isLazyAttr`

(

name

)

Boolean private

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

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.

`_lookup`

() Array private

Provided by the dd-ddm-drop module.

Defined in dd/js/ddm-drop.js:310

Filters the list of Drops down to those in the viewport.

Returns:

Array:

The valid Drop Targets that are in the viewport.

`_monitor`

(

what
eventType
o

)

private

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

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 -> click_attach, click_detach, 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

`_move`

(

ev

)

private

Defined in dd/js/ddm-base.js:237

Internal listener for the mousemove DOM event to pass to the Drag's move method.

Parameters:

ev EventFacade

The Dom mousemove Event

`_normAttrVals`

(

valueHash

)

Object private

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

Utility method to normalize attribute values. The base implementation simply merges the hash to protect the original.

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.

`_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)

`_pg_activate`

() private

Provided by the dd-ddm module.

Defined in dd/js/ddm.js:47

Activates the shim

`_pg_deactivate`

() private

Provided by the dd-ddm module.

Defined in dd/js/ddm.js:39

Deactivates the shim

`_pg_size`

() private

Provided by the dd-ddm module.

Defined in dd/js/ddm.js:73

Sizes the shim on: activatation, window:scroll, window:resize

`_preInitEventCfg`

(

config

)

private

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

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

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.

`_publish`

(

fullType
etOpts
ceOpts

)

CustomEvent private

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

The low level event publish implementation. It expects all the massaging to have been done outside of this method. e.g. the type to fullType conversion. It's designed to be a fast path publish, which can be used by critical code paths to improve performance.

Parameters:

fullType String

The prefixed type of the event to publish.
etOpts Object

The EventTarget specific configuration to mix into the published event.
ceOpts Object

The publish specific configuration to mix into the published event.

Returns:

CustomEvent:

The published event. If called without etOpts or ceOpts, this will be the default CustomEvent instance, and can be configured independently.

`_regDrag`

(

)

private

Defined in dd/js/ddm-base.js:122

Adds a reference to the drag object to the DDM._drags array, called in the constructor of Drag.

Parameters:

d Drag

The Drag object

`_regTarget`

(

)

private

Provided by the dd-ddm-drop module.

Defined in dd/js/ddm-drop.js:341

Add the passed in Target to the targets collection

Parameters:

t Object

The Target to add to the targets collection

`_removeActiveShim`

(

)

private

Provided by the dd-ddm-drop module.

Defined in dd/js/ddm-drop.js:48

Removes a Drop Target to the list of active shims

Parameters:

d Object

The Drop instance to remove from the list.

`_removeValid`

(

drop

)

private chainable

Provided by the dd-ddm-drop module.

Defined in dd/js/ddm-drop.js:147

Removes a Drop Target from the list of Valid Targets. This list get's regenerated on each new drag operation.

Parameters:

drop Object

`_set`

(

name
val
[opts]

)

Object protected chainable

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

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.
[opts] Object optional

Optional data providing the circumstances for the change.

Returns:

Object:

A reference to the host object.

`_setAttr`

(

name
value
[opts]
force

)

Object protected chainable

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

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 data providing the circumstances for the change.
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
[opts]

)

Object protected chainable

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

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

Parameters:

attrs Object

An object with attributes name/value pairs.
[opts] Object optional

Optional data providing the circumstances for the change

Returns:

Object:

A reference to the host object.

`_setAttrVal`

(

attrName
subAttrName
prevVal
newVal
[opts]
[attrCfg]

)

Boolean private

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

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.
[opts] Object optional

Optional data providing the circumstances for the change.
[attrCfg] Object optional

Optional config hash for the attribute. This is added for performance along the critical path, where the calling method has already obtained the config from state.

Returns:

Boolean:

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

`_setDragMode`

(

mode

)

private

Defined in dd/js/ddm-base.js:78

Handler for dragMode attribute setter.

Parameters:

mode String | Number

The Number value or the String for the DragMode to default all future drag instances to.

Returns:

Number The Mode to be set

`_setFrame`

() private

Provided by the dd-proxy module.

Defined in dd/js/proxy.js:199

If resizeProxy is set to true (default) it will resize the proxy element to match the size of the Drag Element. If positionProxy is set to true (default) it will position the proxy element in the same location as the Drag Element.

`_setStateVal`

(

name
value

)

private

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

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

`_setupListeners`

() private

Defined in dd/js/ddm-base.js:154

Add the document listeners.

`_start`

() private

Defined in dd/js/ddm-base.js:167

Internal method used by Drag to signal the start of a drag operation

`_startDrag`

(

)

private

Defined in dd/js/ddm-base.js:176

Factory method to be overwritten by other DDM's

Parameters:

x Number

The x position of the drag element
y Number

The y position of the drag element
w Number

The width of the drag element
h Number

The height of the drag element

`_unregDrag`

(

)

private

Defined in dd/js/ddm-base.js:139

Remove this drag object from the DDM._drags array.

Parameters:

d Drag

The drag object.

`_unregTarget`

(

drop

)

private

Provided by the dd-ddm-drop module.

Defined in dd/js/ddm-drop.js:350

Remove the passed in Target from the targets collection

Parameters:

drop Object

The Target to remove from the targets collection

`addAttr`

(

name
config
lazy

)

Object chainable

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

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

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`

(

)

chainable

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

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

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

`attrAdded`

(

name

)

Boolean

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

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

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

`bubble`

(

evt

)

Boolean

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

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

`clearCache`

()

Provided by the dd-ddm-drop module.

Defined in dd/js/ddm-drop.js:200

Clears the cache data used for this interaction.

`cssSizestoObject`

(

gutter

)

Object private

Defined in dd/js/ddm-base.js:249

//TODO Private, rename??... Helper method to use to set the gutter from the attribute setter. CSS style string for gutter: '5 0' (sets top and bottom to 5px, left and right to 0px), '1 2 3 4' (top 1px, right 2px, bottom 3px, left 4px)

Parameters:

gutter String

CSS style string for gutter

Returns:

Object:

The gutter Object Literal.

`destroy`

() BaseCore chainable

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

Destroy lifecycle method. Invokes destructors for the class hierarchy.

Returns:

BaseCore:

A reference to this object

`detach`

(

type
fn
context

)

EventTarget

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

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

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

`fire`

(

type
arguments

)

Boolean

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

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.

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.

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.

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:

Boolean:

True if the whole lifecycle of the event went through, false if at any point the event propagation was halted.

`get`

(

name

)

Any

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

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

Gets multiple attribute values.

Parameters:

attrs String[] | 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.

`getBestMatch`

(

drops
all

)

Object or Array

Provided by the dd-ddm-drop module.

Defined in dd/js/ddm-drop.js:226

This method will gather the area for all potential targets and see which has the hightest covered area and return it.

Parameters:

drops Array

An Array of drops to scan for the best match.
all Boolean

If present, it returns an Array. First item is best match, second is an Array of the other items in the original Array.

Returns:

Object or Array:

`getDelegate`

()

Provided by the dd-delegate module.

Defined in dd/js/delegate.js:311

Get a delegate instance from a container node

Returns:

Y.DD.Delegate

`getDrag`

(

node

)

Object

Defined in dd/js/ddm-base.js:274

Get a valid Drag instance back from a Node or a selector string, false otherwise

Parameters:

node String/Object

The Node instance or Selector string to check for a valid Drag Object

Returns:

Object:

`getDrop`

(

node

)

Object

Provided by the dd-ddm-drop module.

Defined in dd/js/ddm-drop.js:374

Get a valid Drop instance back from a Node or a selector string, false otherwise

Parameters:

node String/Object

The Node instance or Selector string to check for a valid Drop Object

Returns:

Object:

`getEvent`

(

type
prefixed

)

CustomEvent

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

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

`getNode`

(

)

Node

Defined in dd/js/ddm-base.js:309

Return a node instance from the given node, selector string or Y.Base extended object.

Parameters:

n Node/Object/String

The node to resolve.

Returns:

Node:

`getTargets`

()

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

Returns an array of bubble targets for this object.

Returns:

EventTarget[]

`init`

(

cfg

)

BaseCore chainable

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

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

`isOverTarget`

(

drop

)

Boolean

Provided by the dd-ddm-drop module.

Defined in dd/js/ddm-drop.js:165

Check to see if the Drag element is over the target, method varies on current mode

Parameters:

drop Object

The drop to check against

Returns:

Boolean:

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

Note: New attributes cannot be added using this interface. New attributes must be added using addAttr, or an appropriate manner for a class which utilises Attributes (e.g. the ATTRS property in Base).

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.

`on`

(

type
fn
[context]
[arg*]

)

EventHandle

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

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

 this.on("change", this._onChange, this);

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.

 this.on({
     "attrChange" : this._onAttrChange,
     "change"     : this._onChange
 });

You can also pass an array of event names as the first argument to subscribe to all listed events with the same callback.

 this.on([ "change", "attrChange" ], this._onChange);

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

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

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]

)

Array

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

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] String optional

The prefix. Defaults to this._yuievt.config.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

`publish`

(

type
opts

)

CustomEvent

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

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

Returns:

CustomEvent:

the custom event

`regDelegate`

()

Provided by the dd-delegate module.

Defined in dd/js/delegate.js:303

`removeAttr`

(

name

)

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

Removes an attribute from the host object

Parameters:

name String

The name of the attribute to be removed.

`removeTarget`

(

)

chainable

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

Removes a bubble target

Parameters:

o EventTarget

the target to remove

`reset`

(

name

)

Object chainable

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

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
[opts]

)

Object chainable

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

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.
[opts] Object optional

Optional data providing the circumstances for the change.

Returns:

Object:

A reference to the host object.

`setAttrs`

(

attrs
[opts]

)

Object chainable

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

Sets multiple attribute values.

Parameters:

attrs Object

An object with attributes name/value pairs.
[opts] Object optional

Optional data providing the circumstances for the change.

Returns:

Object:

A reference to the host object.

`stopDrag`

() chainable

Defined in dd/js/ddm-base.js:207

Method will forcefully stop a drag operation. For example calling this from inside an ESC keypress handler will stop this drag.

`subscribe`

() deprecated

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

Deprecated: use on

subscribe to an event

`swapNode`

(

n1
n2

)

Node

Defined in dd/js/ddm-base.js:330

Swap the position of 2 nodes based on their DOM location.

Parameters:

n1 Node

The first node to swap
n2 Node

The first node to swap

Returns:

Node:

`swapPosition`

(

n1
n2

)

Node

Defined in dd/js/ddm-base.js:292

Swap the position of 2 nodes based on their CSS positioning.

Parameters:

n1 Node

The first node to swap
n2 Node

The first node to swap

Returns:

Node:

`syncActiveShims`

(

force

)

Provided by the dd-ddm-drop module.

Defined in dd/js/ddm-drop.js:64

This method will sync the position of the shims on the Drop Targets that are currently active.

Parameters:

force Boolean

Resize/sync all Targets.

`toString`

() String

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

Default toString implementation. Provides the constructor NAME and the instance guid, if set.

Returns:

String:

String representation for this object

`unsubscribe`

() deprecated

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

Deprecated: use detach

detach a listener

`unsubscribeAll`

(

type

)

deprecated

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

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

Properties

`_active`

Boolean

Defined in dd/js/ddm-base.js:72

flag set when we activate our first drag, so DDM can start listening for events.

`_activeShims`

Array private

Provided by the dd-ddm-drop module.

Defined in dd/js/ddm-drop.js:20

Placeholder for all active shims on the page

`_allowAdHocAttrs`

Boolean protected

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

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

Default: undefined (false)

`_debugShim`

Boolean private

Provided by the dd-ddm module.

Defined in dd/js/ddm.js:19

Set this to true to set the shims opacity to .5 for debugging it, default: false.

`_delegates`

Array private

Provided by the dd-delegate module.

Defined in dd/js/delegate.js:295

Holder for all Y.DD.Delegate instances

`_drags`

Array private

Defined in dd/js/ddm-base.js:109

Holder for all registered drag elements.

`_noShim`

Boolean private

Provided by the dd-ddm-drop module.

Defined in dd/js/ddm-drop.js:13

This flag turns off the use of the mouseover/mouseout shim. It should not be used unless you know what you are doing.

`_pg`

Node private

Provided by the dd-ddm module.

Defined in dd/js/ddm.js:12

The shim placed over the screen to track the mousemove event.

`_shimming`

Boolean private

Defined in dd/js/ddm-base.js:218

Set to true when drag starts and useShim is true. Used in pairing with _docMove

`activeDrag`

Drag

Defined in dd/js/ddm-base.js:116

A reference to the currently active draggable object.

`activeDrop`

Object

Provided by the dd-ddm-drop module.

Defined in dd/js/ddm-drop.js:111

A reference to the active Drop Target

`CSS_PREFIX`

String

Defined in dd/js/ddm-base.js:102

The PREFIX to attach to all DD CSS class names

`INTERSECT`

Number private

Provided by the dd-ddm-drop module.

Defined in dd/js/ddm-drop.js:91

In intersect mode, a Drop is targeted by "part" of the drag node being over the Target

`mode`

Number private

Provided by the dd-ddm-drop module.

Defined in dd/js/ddm-drop.js:77

The mode that the drag operations will run in 0 for Point, 1 for Intersect, 2 for Strict

`name`

String deprecated

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

Deprecated: Use this.constructor.NAME

The string used to identify the class of this object.

`otherDrops`

Object

Provided by the dd-ddm-drop module.

Defined in dd/js/ddm-drop.js:124

An object literal of Other Drop Targets that we encountered during this interaction (in the case of overlapping Drop Targets)

`POINT`

Number private

Provided by the dd-ddm-drop module.

Defined in dd/js/ddm-drop.js:84

In point mode, a Drop is targeted by the cursor being over the Target

`STRICT`

Number private

Provided by the dd-ddm-drop module.

Defined in dd/js/ddm-drop.js:98

In strict mode, a Drop is targeted by the "entire" drag node being over the Target

`targets`

Array

Provided by the dd-ddm-drop module.

Defined in dd/js/ddm-drop.js:130

All of the Targets

`useHash`

Boolean

Provided by the dd-ddm-drop module.

Defined in dd/js/ddm-drop.js:105

Should we only check targets that are in the viewport on drags (for performance), default: true

`validDrops`

Array

Provided by the dd-ddm-drop module.

Defined in dd/js/ddm-drop.js:117

An array of the valid Drop Targets for this interaction.

Attributes

`clickPixelThresh`

Number

Defined in dd/js/ddm-base.js:30

The number of pixels to move to start a drag operation, default is 3.

Fires event `clickPixelThreshChange`

Fires when the value for the configuration attribute clickPixelThresh 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.

`clickTimeThresh`

Number

Defined in dd/js/ddm-base.js:38

The number of milliseconds a mousedown has to pass to start a drag operation, default is 1000.

Fires event `clickTimeThreshChange`

Fires when the value for the configuration attribute clickTimeThresh 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:212

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.

`dragCursor`

String

Defined in dd/js/ddm-base.js:22

The cursor to apply when dragging, if shimmed the shim will get the cursor.

Fires event `dragCursorChange`

Fires when the value for the configuration attribute dragCursor 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.

`dragMode`

String

Defined in dd/js/ddm-base.js:55

This attribute only works if the dd-drop module is active. It will set the dragMode (point, intersect, strict) of all future Drag instances.

Fires event `dragModeChange`

Fires when the value for the configuration attribute dragMode 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:198

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.

`throttleTime`

Number

Defined in dd/js/ddm-base.js:46

The number of milliseconds to throttle the mousemove event. Default: 150

Fires event `throttleTimeChange`

Fires when the value for the configuration attribute throttleTime 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

`ddm:end`

CustomEvent

Defined in dd/js/ddm-base.js:363

Fires from the DDM after the DDM finishes, before the drag end events.

`ddm:start`

CustomEvent

Defined in dd/js/ddm-base.js:358

Fires from the DDM before all drag events fire.

`destroy`

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

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

`init`

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

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.

APIs

DD.DDM Class

Constructor

DD.DDM

Item Index

Methods

Properties

Attributes

Events

Methods

_activateTargets

_addActiveShim

Parameters:

_addAttrs

Parameters:

_addLazyAttr

Parameters:

_addOutOfOrder

Parameters:

_addValid

Parameters:

_aggregateAttrs

Parameters:

Returns:

_attrCfgHash

_baseDestroy

_baseInit

_calcTickArray

Parameters:

Returns:

_calcTicks

Parameters:

Returns:

_cloneDefaultValue

Parameters:

_createFrame

_createPG

_deactivateTargets

_defAttrChangeFn

Parameters:

_defDestroyFn

Parameters:

_defInitFn

Parameters:

_destroyHierarchy

_docMove

Parameters:

_dropMove

_end

_endDrag

_filterAdHocAttrs

Parameters:

Returns:

_fireAttrChange

Parameters:

_getAttr

Parameters:

Returns:

_getAttrCfg

Parameters:

Returns:

_getAttrCfgs

Returns:

_getAttrInitVal

Parameters:

Returns:

_getAttrs

Parameters:

Returns:

_getClasses

Returns:

_getFullType

Parameters:

Returns:

_getInstanceAttrCfgs

Parameters:

Returns:

_getStateVal

Parameters:

Returns:

`DD.DDM`

`_activateTargets`

`_addActiveShim`

`_addAttrs`

`_addLazyAttr`

`_addOutOfOrder`

`_addValid`

`_aggregateAttrs`

`_attrCfgHash`

`_baseDestroy`

`_baseInit`

`_calcTickArray`

`_calcTicks`

`_cloneDefaultValue`

`_createFrame`

`_createPG`

`_deactivateTargets`

`_defAttrChangeFn`

`_defDestroyFn`

`_defInitFn`

`_destroyHierarchy`

`_docMove`

`_dropMove`

`_end`

`_endDrag`

`_filterAdHocAttrs`

`_fireAttrChange`

`_getAttr`

`_getAttrCfg`

`_getAttrCfgs`

`_getAttrInitVal`

`_getAttrs`

`_getClasses`

`_getFullType`

`_getInstanceAttrCfgs`

`_getStateVal`

`_getType`

`_handleTargetOver`

`_hasActiveShim`

`_hasPotentialSubscribers`

`_initAttrHost`

`_initAttribute`

`_initAttrs`

`_initBase`

`_initHierarchy`

`_initHierarchyData`

`_isLazyAttr`

`_lookup`

`_monitor`

`_move`

`_normAttrVals`

`_parseType`

`_pg_activate`

`_pg_deactivate`

`_pg_size`

`_preInitEventCfg`

`_protectAttrs`

`_publish`

`_regDrag`

`_regTarget`

`_removeActiveShim`

`_removeValid`

`_set`

`_setAttr`

`_setAttrs`

`_setAttrVal`

`_setDragMode`

`_setFrame`

`_setStateVal`

`_setupListeners`

`_start`