Plugin.Drag Class

Extends DD.Drag

Defined in: dd/js/dd-plugin.js:8

Module: dd-plugin
Parent Module: dd

Simple Drag plugin that can be attached to a Node or Widget via the plug method.

Constructor

`Plugin.Drag`

()

Defined in dd/js/dd-plugin.js:8

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

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

`_align`

(

xy

)

private

Inherited from DD.Drag: dd/js/drag.js:1118

Calculates the offsets and set's the XY that the element will move to.

Parameters:

xy Array

The xy coords to align with.

`_alignNode`

(

eXY

)

private

Inherited from DD.Drag: dd/js/drag.js:1136

This method performs the alignment before the element move.

Parameters:

eXY Array

The XY to move the element to, usually comes from the mousemove DOM event.

`_attachWidgetListeners`

() private

Defined in dd/js/dd-plugin.js:117

If this is a Widget, then attach the positioning listeners

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

`_canDrag`

(

)

Boolean private

Inherited from DD.Drag: dd/js/drag.js:436

Checks the object for the methods needed to drag the object around. Normally this would be a node instance, but in the case of Graphics, it may be an SVG node or something similar.

Parameters:

n Object

The object to check

Returns:

Boolean: True or false if the Object contains the methods needed to Drag

`_checkEvents`

() private

Defined in dd/js/dd-plugin.js:79

Attached to the drag:start event, it checks if this plugin needs to attach or detach listeners for widgets. If dd-proxy is plugged the default widget positioning should be ignored.

`_createEvents`

() private

Inherited from DD.Drag: dd/js/drag.js:518

This method creates all the events for this Event Target and publishes them so we get Event Bubbling.

`_defAlignFn`

(

)

private

Inherited from DD.Drag: dd/js/drag.js:1127

Calculates the offsets and set's the XY that the element will move to.

Parameters:

e EventFacade

The drag:align 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.

`_defDestroyFn`

(

)

protected

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

Default destroy event handler

Parameters:

e EventFacade

Event object

`_defDragFn`

(

ev

)

private

Inherited from DD.Drag: dd/js/drag.js:1190

Default function for drag:drag. Fired from _moveNode.

Parameters:

ev EventFacade

The drag:drag event

`_defEndFn`

() private

Inherited from DD.Drag: dd/js/drag.js:1097

Handler for fixing the selection in IE

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

`_defMouseDownFn`

(

)

private

Inherited from DD.Drag: dd/js/drag.js:763

Handler for the mousedown DOM event

Parameters:

e EventFacade

The Event

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

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

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

`_fixDragStart`

(

)

private

Inherited from DD.Drag: dd/js/drag.js:707

The function we use as the ondragstart handler when we start a drag in Internet Explorer. This keeps IE from blowing up on images as drag handles.

Parameters:

e Event

The Event

`_fixIEMouseDown`

() private

Inherited from DD.Drag: dd/js/drag.js:733

This method copies the onselectstart listner on the document to the _ieSelectFix property

`_fixIEMouseUp`

() private

Inherited from DD.Drag: dd/js/drag.js:744

This method copies the _ieSelectFix property back to the onselectstart listner on the document.

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

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

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

`_handleMouseDownEvent`

(

ev

)

private

Inherited from DD.Drag: dd/js/drag.js:754

Handler for the mousedown DOM event

Parameters:

ev EventFacade

The Event

`_handleMouseUp`

(

ev

)

private

Inherited from DD.Drag: dd/js/drag.js:694

Handler for the mouseup DOM event

Parameters:

ev EventFacade

The Event

`_handleTarget`

(

config

)

private

Inherited from DD.Drag: dd/js/drag.js:487

Attribute handler for the target config attribute.

Parameters:

config Boolean/Object

The Config

`_ieSelectFix`

() private

Inherited from DD.Drag: dd/js/drag.js:719

The function we use as the onselectstart handler when we start a drag in Internet Explorer

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

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

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

`_move`

(

ev

)

private

Inherited from DD.Drag: dd/js/drag.js:1212

Fired from DragDropMgr (DDM) on mousemove.

Parameters:

ev EventFacade

The mousemove DOM event

`_moveNode`

() private

Inherited from DD.Drag: dd/js/drag.js:1148

This method performs the actual element move.

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

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

`_prep`

() private

Inherited from DD.Drag: dd/js/drag.js:996

Attach event listners and add classname

`_prevEndFn`

() private

Inherited from DD.Drag: dd/js/drag.js:1106

Handler for preventing the drag:end event. It will reset the node back to it's start position

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

`_removeWidgetListeners`

() private

Defined in dd/js/dd-plugin.js:105

Remove the attached widget listeners

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

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

`_setStartPosition`

(

xy

)

private

Inherited from DD.Drag: dd/js/drag.js:870

Sets the current position of the Element and calculates the offset

Parameters:

xy Array

The XY coords to set the position to.

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

`_timeoutCheck`

() private

Inherited from DD.Drag: dd/js/drag.js:887

The method passed to setTimeout to determine if the clickTimeThreshold was met.

`_unprep`

() private

Inherited from DD.Drag: dd/js/drag.js:1009

Detach event listeners and remove classname

`_updateStopPosition`

(

)

private

Defined in dd/js/dd-plugin.js:184

Updates the last position where the widget was stopped.

Parameters:

e EventFacade

Event Facade

`_usesWidgetPosition`

() private

Defined in dd/js/dd-plugin.js:66

Returns true if widget uses widgetPosition, otherwise returns false

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

`addHandle`

(

str

)

Self chainable

Inherited from DD.Drag: dd/js/drag.js:917

Add a handle to a drag element. Drag only initiates when a mousedown happens on this element.

Parameters:

str String

The selector to test for a valid handle. Must be a child of the element.

Returns:

Self:

`addInvalid`

(

str

)

Self chainable

Inherited from DD.Drag: dd/js/drag.js:951

Add a selector string to test the handle against. If the test passes the drag operation will not continue.

Parameters:

str String

The selector to test against to determine if this is an invalid drag handle.

Returns:

Self:

`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

`addToGroup`

(

)

Self chainable

Inherited from DD.Drag: dd/js/drag.js:457

Add this Drag instance to a group, this should be used for on-the-fly group additions.

Parameters:

g String

The group to add this Drag Instance to.

Returns:

Self:

`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

`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

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

() BaseCore chainable

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

Destroy lifecycle method. Invokes destructors for the class hierarchy.

Returns:

BaseCore: A reference to this object

`destructor`

() private

Inherited from DD.Drag: dd/js/drag.js:1255

Lifecycle destructor, unreg the drag from the DDM and remove listeners

`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

`end`

() Self chainable

Inherited from DD.Drag: dd/js/drag.js:1070

Ends the drag operation

Returns:

Self:

`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

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

`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

`getTargets`

()

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

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: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 DD.Drag but overwritten in dd/js/dd-plugin.js:134

Sets up event listeners on drag events if interacting with a widget

`initializer`

(

)

private

Defined in dd/js/dd-plugin.js:152

Updates x,y or xy attributes on widget based on where the widget is dragged

Parameters:

e EventFacade

Event Facade

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

`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

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

`removeFromGroup`

(

)

Self chainable

Inherited from DD.Drag: dd/js/drag.js:469

Remove this Drag instance from a group, this should be used for on-the-fly group removals.

Parameters:

g String

The group to remove this Drag Instance from.

Returns:

Self:

`removeHandle`

(

str

)

Self chainable

Inherited from DD.Drag: dd/js/drag.js:899

Remove a Selector added by addHandle

Parameters:

str String

The selector for the handle to be removed.

Returns:

Self:

`removeInvalid`

(

str

)

Self chainable

Inherited from DD.Drag: dd/js/drag.js:936

Remove an invalid handle added by addInvalid

Parameters:

str String

The invalid handle to remove from the internal list.

Returns:

Self:

`removeTarget`

(

)

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

Removes a bubble target

Parameters:

o EventTarget

the target to remove

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

`start`

() Self chainable

Inherited from DD.Drag: dd/js/drag.js:1028

Starts the drag operation

Returns:

Self:

`stopDrag`

() Self chainable

Inherited from DD.Drag: dd/js/drag.js:1243

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

Returns:

Self:

`subscribe`

() deprecated

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

Deprecated: use on

subscribe to an event

`toString`

() String

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

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

`validClick`

(

ev

)

Boolean

Inherited from DD.Drag: dd/js/drag.js:799

Method first checks to see if we have handles, if so it validates the click against the handle. Then if it finds a valid handle, it checks it against the invalid handles list. Returns true if a good handle was used, false otherwise.

Parameters:

ev EventFacade

The Event

Returns:

Boolean:

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)

`_bubbleTargets`

Unknown private

Inherited from DD.Drag: dd/js/drag.js:451

The default bubbleTarget for this object. Default: Y.DD.DDM

`_clickTimeout`

Boolean private

Inherited from DD.Drag: dd/js/drag.js:639

Holder for the setTimeout call

`_dragThreshMet`

Boolean private

Inherited from DD.Drag: dd/js/drag.js:625

Private flag to see if the drag threshhold was met

`_endTime`

Date private

Inherited from DD.Drag: dd/js/drag.js:597

The getTime of the mouseup event. Not used, just here in case someone wants/needs to use it.

`_ev_md`

EventFacade private

Inherited from DD.Drag: dd/js/drag.js:583

A private reference to the mousedown DOM event

`_fromTimeout`

Boolean private

Inherited from DD.Drag: dd/js/drag.js:632

Flag to determine if the drag operation came from a timeout

`_groups`

Array private

Inherited from DD.Drag: dd/js/drag.js:511

Storage Array for the groups this drag belongs to.

`_handles`

Object private

Inherited from DD.Drag: dd/js/drag.js:604

A private hash of the valid drag handles

`_ieSelectBack`

Unknown private

Inherited from DD.Drag: dd/js/drag.js:727

We will hold a copy of the current "onselectstart" method on this property, and reset it after we are done using it.

`_invalids`

Object private

Inherited from DD.Drag: dd/js/drag.js:611

A private hash of the invalid selector strings

`_invalidsDefault`

Object private

Inherited from DD.Drag: dd/js/drag.js:618

A private hash of the default invalid selector strings: {'textarea': true, 'input': true, 'a': true, 'button': true, 'select': true}

`_startTime`

Date private

Inherited from DD.Drag: dd/js/drag.js:590

The getTime of the mousedown event. Not used, just here in case someone wants/needs to use it.

`actXY`

Array

Inherited from DD.Drag: dd/js/drag.js:670

The xy that the node will be set to. Changing this will alter the position as it's dragged.

`deltaXY`

Array

Inherited from DD.Drag: dd/js/drag.js:646

The offset of the mouse position to the element's position

`lastXY`

Array

Inherited from DD.Drag: dd/js/drag.js:664

The position of the element as it's moving (for offset calculations)

`mouseXY`

Array

Inherited from DD.Drag: dd/js/drag.js:682

The XY coords of the mousemove

`NAME`

String

Defined in dd/js/dd-plugin.js:30

dd-plugin

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

`nodeXY`

Array

Inherited from DD.Drag: dd/js/drag.js:658

The initial element position

`NS`

String

Defined in dd/js/dd-plugin.js:37

The Drag instance will be placed on the Node instance under the dd namespace. It can be accessed via Node.dd;

`realXY`

Array

Inherited from DD.Drag: dd/js/drag.js:676

The real xy position of the node.

`region`

Object

Inherited from DD.Drag: dd/js/drag.js:688

A region object associated with this drag, used for checking regions while dragging.

`startXY`

Array

Inherited from DD.Drag: dd/js/drag.js:652

The initial mouse position

`target`

Object

Inherited from DD.Drag: dd/js/drag.js:481

This will be a reference to the Drop instance associated with this drag if the target: true config attribute is set..

Attributes

`_stoppedPosition`

private

Defined in dd/js/dd-plugin.js:57

refers to the [x,y] coordinate where the drag was stopped last

Fires event `_stoppedPositionChange`

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

`_widget`

private

Defined in dd/js/dd-plugin.js:48

refers to a Y.Widget if its the host, otherwise = false.

Fires event `_widgetChange`

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

`activeHandle`

Node

Inherited from DD.Drag: dd/js/drag.js:318

Config option is set by Drag to inform you of which handle fired the drag event (in the case that there are several handles): default false.

Fires event `activeHandleChange`

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

`bubbles`

Object deprecated

Inherited from DD.Drag: dd/js/drag.js:412

Controls the default bubble parent for this Drag instance. Default: Y.DD.DDM. Set to false to disable bubbling. Use bubbleTargets in config

Fires event `bubblesChange`

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

`clickPixelThresh`

Number

Inherited from DD.Drag: dd/js/drag.js:262

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

Inherited from DD.Drag: dd/js/drag.js:270

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.

`data`

Mixed

Inherited from DD.Drag: dd/js/drag.js:294

A payload holder to store arbitrary data about this drag object, can be used to store any value.

Fires event `dataChange`

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

`dragging`

Boolean

Inherited from DD.Drag: dd/js/drag.js:335

This attribute is not meant to be used by the implementor, it is meant to be used as an Event tracker so you can listen for it to change.

Fires event `draggingChange`

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

Inherited from DD.Drag: dd/js/drag.js:358

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

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.

`dragNode`

Node

Inherited from DD.Drag: dd/js/drag.js:229

Y.Node instance to use as the draggable element, defaults to node

Fires event `dragNodeChange`

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

`groups`

Array

Inherited from DD.Drag: dd/js/drag.js:369

Array of groups to add this drag into.

Fires event `groupsChange`

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

`haltDown`

Boolean

Inherited from DD.Drag: dd/js/drag.js:425

Should the mousedown event be halted. Default: true

Fires event `haltDownChange`

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

`handles`

Array

Inherited from DD.Drag: dd/js/drag.js:389

Array of valid handles to add. Adding something here will set all handles, even if previously added with addHandle

Fires event `handlesChange`

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

`lock`

Boolean

Inherited from DD.Drag: dd/js/drag.js:278

Set to lock this drag element so that it can't be dragged: default false.

Fires event `lockChange`

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

`move`

Boolean

Inherited from DD.Drag: dd/js/drag.js:302

If this is false, the drag element will not move with the cursor: default true. Can be used to "resize" the element.

Fires event `moveChange`

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

`node`

Node

Inherited from DD.Drag: dd/js/drag.js:212

Y.Node instance to use as the element to initiate a drag operation

Fires event `nodeChange`

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

`offsetNode`

Boolean

Inherited from DD.Drag: dd/js/drag.js:246

Offset the drag element by the difference in cursor position: default true

Fires event `offsetNodeChange`

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

`primaryButtonOnly`

Boolean

Inherited from DD.Drag: dd/js/drag.js:326

By default a drag operation will only begin if the mousedown occurred with the primary mouse button. Setting this to false will allow for all mousedown events to trigger a drag.

Fires event `primaryButtonOnlyChange`

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

`startCentered`

Boolean

Inherited from DD.Drag: dd/js/drag.js:254

Center the dragNode to the mouse position on drag:start: default false

Fires event `startCenteredChange`

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

`target`

Boolean

Inherited from DD.Drag: dd/js/drag.js:346

This attribute only works if the dd-drop module has been loaded. It will make this node a drop target as well as draggable.

Fires event `targetChange`

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

`useShim`

Boolean

Inherited from DD.Drag: dd/js/drag.js:310

Use the protective shim on all drag operations: default true. Only works with dd-ddm, not dd-ddm-base.

Fires event `useShimChange`

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

`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

`drag:addHandle`

CustomEvent

Inherited from DD.Drag: dd/js/drag.js:55

Fires after a handle is added.

Event Payload:

event EventFacade

An Event Facade object with the following specific property added:

handle
The handle that was added.

`drag:addInvalid`

CustomEvent

Inherited from DD.Drag: dd/js/drag.js:73

Fires after an invalid selector is added.

Event Payload:

event EventFacade

An Event Facade object with the following specific property added:

handle
The handle that was added.

`drag:afterMouseDown`

CustomEvent

Inherited from DD.Drag: dd/js/drag.js:37

Fires after the mousedown event has been cleared.

Event Payload:

event EventFacade

An Event Facade object with the following specific property added:

ev
The original mousedown event.

`drag:align`

CustomEvent

Inherited from DD.Drag: dd/js/drag.js:123

Fires when this node is aligned.

Event Payload:

event EventFacade

An Event Facade object with the following specific property added:

pageX
The current node position X.

pageY
The current node position Y.

`drag:drag`

CustomEvent

Inherited from DD.Drag: dd/js/drag.js:109

Fires every mousemove during a drag operation.

Event Payload:

event EventFacade

An Event Facade object with the following specific property added:

pageX
The current node position X.

pageY
The current node position Y.

scroll
Should a scroll action occur.

info
Object hash containing calculated XY arrays: start, xy, delta, offset

`drag:drophit`

CustomEvent

Inherited from DD.Drag: dd/js/drag.js:168

Fires when this node is dropped on a valid Drop Target. (Fired from dd-ddm-drop)

Event Payload:

event EventFacade

An Event Facade object with the following specific property added:

drop
The best guess on what was dropped on.

drag
The drag object at the time of the event.

others
An array of all the other drop targets that was dropped on.

`drag:dropmiss`

CustomEvent

Inherited from DD.Drag: dd/js/drag.js:180

Fires when this node is dropped on an invalid Drop Target. (Fired from dd-ddm-drop)

Event Payload:

event EventFacade

An Event Facade object with the following specific property added:

pageX
The current node position X.

pageY
The current node position Y.

`drag:end`

CustomEvent

Inherited from DD.Drag: dd/js/drag.js:95

Fires at the end of a drag operation.

Event Payload:

event EventFacade

An Event Facade object with the following specific property added:

pageX
The current node position X.

pageY
The current node position Y.

startTime
The startTime of the event, from the start event.

endTime
The endTime of the event. getTime on the current Date object.

`drag:enter`

CustomEvent

Inherited from DD.Drag: dd/js/drag.js:147

Fires when this node enters a Drop Target. (Fired from dd-drop)

Event Payload:

event EventFacade

An Event Facade object with the following specific property added:

drop
The drop object at the time of the event.

drag
The drag object at the time of the event.

`drag:exit`

CustomEvent

Inherited from DD.Drag: dd/js/drag.js:158

Fires when this node exits a Drop Target. (Fired from dd-drop)

Event Payload:

event EventFacade

An Event Facade object with the following specific property added:

drop
The drop object at the time of the event.

`drag:mouseDown`

CustomEvent

Inherited from DD.Drag: dd/js/drag.js:27

Handles the mousedown DOM event, checks to see if you have a valid handle then starts the drag timers.

Event Payload:

event EventFacade

An Event Facade object with the following specific property added:

ev
The original mousedown event.

`drag:mouseup`

CustomEvent

Inherited from DD.Drag: dd/js/drag.js:21

Handles the mouseup DOM event, does nothing internally just fires.

`drag:over`

CustomEvent

Inherited from DD.Drag: dd/js/drag.js:136

Fires when this node is over a Drop Target. (Fired from dd-drop)

Event Payload:

event EventFacade

An Event Facade object with the following specific property added:

drop
The drop object at the time of the event.

drag
The drag object at the time of the event.

`drag:removeHandle`

CustomEvent

Inherited from DD.Drag: dd/js/drag.js:46

Fires after a handle is removed.

Event Payload:

event EventFacade

An Event Facade object with the following specific property added:

handle
The handle that was removed.

`drag:removeInvalid`

CustomEvent

Inherited from DD.Drag: dd/js/drag.js:64

Fires after an invalid selector is removed.

Event Payload:

event EventFacade

An Event Facade object with the following specific property added:

handle
The handle that was removed.

`drag:start`

CustomEvent

Inherited from DD.Drag: dd/js/drag.js:82

Fires at the start of a drag operation.

Event Payload:

event EventFacade

An Event Facade object with the following specific property added:

pageX
The original node position X.

pageY
The original node position Y.

startTime
The startTime of the event. getTime on the current Date object.

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

APIs

Plugin.Drag Class

Constructor

Plugin.Drag

Item Index

Methods

Properties

Attributes

Events

Methods

_addAttrs

Parameters:

_addLazyAttr

Parameters:

_aggregateAttrs

Parameters:

Returns:

_align

Parameters:

_alignNode

Parameters:

_attachWidgetListeners

_attrCfgHash

_baseDestroy

_baseInit

_canDrag

Parameters:

Returns:

_checkEvents

_createEvents

_defAlignFn

Parameters:

_defAttrChangeFn

Parameters:

_defDestroyFn

Parameters:

_defDragFn

Parameters:

_defEndFn

_defInitFn

Parameters:

_defMouseDownFn

Parameters:

_destroyHierarchy

_filterAdHocAttrs

Parameters:

Returns:

_filterAttrCfs

Parameters:

Returns:

_fireAttrChange

Parameters:

_fixDragStart

Parameters:

_fixIEMouseDown

_fixIEMouseUp

_getAttr

Parameters:

Returns:

_getAttrCfg

Parameters:

Returns:

_getAttrCfgs

Returns:

_getAttrInitVal

Parameters:

Returns:

_getAttrs

Parameters:

Returns:

_getClasses

Returns:

_getStateVal

Parameters:

Returns:

_getType

_handleMouseDownEvent

Parameters:

_handleMouseUp

Parameters:

`Plugin.Drag`

`_addAttrs`

`_addLazyAttr`

`_aggregateAttrs`

`_align`

`_alignNode`

`_attachWidgetListeners`

`_attrCfgHash`

`_baseDestroy`

`_baseInit`

`_canDrag`

`_checkEvents`

`_createEvents`

`_defAlignFn`

`_defAttrChangeFn`

`_defDestroyFn`

`_defDragFn`

`_defEndFn`

`_defInitFn`

`_defMouseDownFn`

`_destroyHierarchy`

`_filterAdHocAttrs`

`_filterAttrCfs`

`_fireAttrChange`

`_fixDragStart`

`_fixIEMouseDown`

`_fixIEMouseUp`

`_getAttr`

`_getAttrCfg`

`_getAttrCfgs`

`_getAttrInitVal`

`_getAttrs`

`_getClasses`

`_getStateVal`

`_getType`

`_handleMouseDownEvent`

`_handleMouseUp`

`_handleTarget`

`_ieSelectFix`

`_initAttrHost`

`_initAttribute`

`_initAttrs`

`_initBase`

`_initHierarchy`

`_initHierarchyData`

`_isLazyAttr`

`_monitor`

`_move`

`_moveNode`

`_normAttrVals`

`_parseType`

`_preInitEventCfg`

`_prep`

`_prevEndFn`

`_protectAttrs`

`_removeWidgetListeners`

`_set`

`_setAttr`

`_setAttrs`

`_setAttrVal`

`_setStartPosition`

`_setStateVal`

`_timeoutCheck`

`_unprep`

`_updateStopPosition`

`_usesWidgetPosition`

`addAttr`

`addAttrs`

`addHandle`

`addInvalid`

`addTarget`

`addToGroup`