Provides the base Drag Drop Manager required for making a Node draggable.
DD.DDM
_activateTargets
Clear the cache and activate the shims of all the targets
_addActiveShim
d
Adds a Drop Target to the list of active shims
d
Object
The Drop instance to add to the list.
_addAttrs
cfgs
values
lazy
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).
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]
Finishes initializing an attribute which has been lazily added.
_addOutOfOrder
name
cfg
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: ...
}
});
_addValid
drop
Add a Drop Target to the list of Valid Targets. This list get's regenerated on each new drag operation.
drop
Object
_aggregateAttrs
allAttrs
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).
allAttrs
Array
An array of ATTRS definitions across classes in the hierarchy (subclass first, Base last)
The aggregate set of ATTRS definitions for the instance
_attrCfgHash
Utility method to define the attribute hash used to filter/whitelist property mixes for this class for iteration performance reasons.
_baseDestroy
Internal destroy implementation for BaseCore
_baseInit
Internal initialization implementation for BaseCore
_calcTickArray
pos
ticks
off1
off2
This method is used with the tickXArray and tickYArray config options
The tick position
_calcTicks
pos
start
tick
off1
off2
Helper method to calculate the tick offsets for a given position
The new position based on the tick calculation
_cloneDefaultValue
cfg
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.
cfg
Object
_createFrame
Create the proxy element if it doesn't already exist and set the DD.DDM._proxy value
_createPG
Creates the shim and adds it's listeners to it.
_deactivateTargets
This method fires the drop:hit, drag:drophit, drag:dropmiss methods and deactivates the shims..
_defAttrChangeFn
e
eventFastPath
Default function for attribute change events.
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
_defInitFn
e
Default init event handler
e
EventFacade
Event object, with a cfg property which refers to the configuration object passed to the constructor.
_destroyHierarchy
Destroys the class hierarchy for this instance by invoking the destructor method on the prototype of each class in the hierarchy.
_docMove
ev
Internal listener for the mousemove on Document. Checks if the shim is in place to only call _move once per mouse move
ev
EventFacade
The Dom mousemove Event
_dropMove
This method is called when the move method is called on the Drag Object.
_end
Internal method used by Drag to signal the end of a drag operation
_endDrag
Factory method to be overwritten by other DDM's
_filterAdHocAttrs
allAttrs
userVals
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.
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]
Utility method to help setup the event payload and fire the attribute change event.
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
Provides the common implementation for the public get method, allowing Attribute hosts to over-ride either method.
See get for argument details.
name
String
The name of the attribute.
The value of the attribute.
_getAttrCfg
name
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.
name
String
Optional. The attribute name. If not provided, the method will return the configuration for all attributes.
The configuration properties for the given attribute, or all attributes.
_getAttrCfgs
Returns an aggregated set of attribute configurations, by traversing the class hierarchy.
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
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.
The initial value of the attribute.
_getAttrs
attrs
Implementation behind the public getAttrs method, to get multiple attribute values.
An object with attribute name/value pairs.
_getClasses
Returns the class hierarchy for this object, with BaseCore being the last class in the array.
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
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.
type
String
The short type to prefix
The prefixed type, if a prefix is set, otherwise the type passed in
_getInstanceAttrCfgs
allCfgs
A helper method used to isolate the attrs config for this instance to pass to addAttrs
,
from the static cached ATTRS for the class.
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.
The set of attributes to be added for this instance, suitable
for passing through to addAttrs
.
_getStateVal
name
[cfg]
Gets the stored value for the attribute, from either the internal state object, or the state proxy if it exits
The stored value of the attribute
_getType
If the instance has a prefix attribute and the event type is not prefixed, the instance prefix is applied to the supplied type.
_handleTargetOver
This method execs _handleTargetOver on all valid Drop Targets
_hasActiveShim
This method checks the _activeShims Object to see if there is a shim active.
_hasPotentialSubscribers
fullType
fullType
String
The fully prefixed type name
Whether the event has potential subscribers or not
_initAttrHost
attrs
values
lazy
Constructor logic for attributes. Initializes the host state, and sets up the inital attributes passed to the constructor.
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
Initializes AttributeCore
_initAttrs
attrs
values
lazy
Utility method to set up initial attributes defined during construction, either through the constructor.ATTRS property, or explicitly passed in.
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
Internal construction logic for BaseCore.
config
Object
The constructor configuration object
_initHierarchy
userVals
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.
userVals
Object
Object with configuration property name/value pairs
_initHierarchyData
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
Checks whether or not the attribute is one which has been added lazily and still requires initialization.
name
String
The name of the attribute
true if it's a lazily added attribute, false otherwise.
_lookup
Filters the list of Drops down to those in the viewport.
The valid Drop Targets that are in the viewport.
_monitor
what
eventType
o
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.
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
Internal listener for the mousemove DOM event to pass to the Drag's move method.
ev
EventFacade
The Dom mousemove Event
_normAttrVals
valueHash
Utility method to normalize attribute values. The base implementation simply merges the hash to protect the original.
valueHash
Object
An object with attribute name/value pairs
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
Returns an array with the detach key (if provided), and the prefixed event name from _getType Y.on('detachcategory| menu:click', fn)
_pg_activate
Activates the shim
_pg_deactivate
Deactivates the shim
_pg_size
Sizes the shim on: activatation, window:scroll, window:resize
_preInitEventCfg
config
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.
config
Object
The user configuration object
_protectAttrs
attrs
Utility method to protect an attribute configuration hash, by merging the entire object and the individual attr config objects.
attrs
Object
A hash of attribute to configuration object pairs.
A protected version of the attrs argument.
_publish
fullType
etOpts
ceOpts
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.
The published event. If called without etOpts
or ceOpts
, this will
be the default CustomEvent
instance, and can be configured independently.
_regDrag
d
Adds a reference to the drag object to the DDM._drags array, called in the constructor of Drag.
d
Drag
The Drag object
_regTarget
t
Add the passed in Target to the targets collection
t
Object
The Target to add to the targets collection
_removeActiveShim
d
Removes a Drop Target to the list of active shims
d
Object
The Drop instance to remove from the list.
_removeValid
drop
Removes a Drop Target from the list of Valid Targets. This list get's regenerated on each new drag operation.
drop
Object
_set
name
val
[opts]
Allows setting of readOnly/writeOnce attributes. See set for argument details.
A reference to the host object.
_setAttr
name
value
[opts]
force
Provides the common implementation for the public set and protected _set methods.
See set for argument details.
A reference to the host object.
_setAttrs
attrs
[opts]
Implementation behind the public setAttrs method, to set multiple attribute values.
A reference to the host object.
_setAttrVal
attrName
subAttrName
prevVal
newVal
[opts]
[attrCfg]
Updates the stored value of the attribute in the privately held State object, if validation and setter passes.
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.
true if the new attribute value was stored, false if not.
_setDragMode
mode
Handler for dragMode attribute setter.
Number The Mode to be set
_setFrame
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
Sets the stored value for the attribute, in either the internal state object, or the state proxy if it exits
name
String
The name of the attribute
value
Any
The value of the attribute
_setupListeners
Add the document listeners.
_start
Internal method used by Drag to signal the start of a drag operation
_startDrag
x
y
w
h
Factory method to be overwritten by other DDM's
_unregDrag
d
Remove this drag object from the DDM._drags array.
d
Drag
The drag object.
_unregTarget
drop
Remove the passed in Target from the targets collection
drop
Object
The Target to remove from the targets collection
addAttr
name
config
lazy
Adds an attribute with the provided configuration to the host object.
The config argument object supports the following properties:
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.
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)
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.
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.
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.
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.
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).
A reference to the host object.
addAttrs
cfgs
values
lazy
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.
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.
A reference to the host object.
addTarget
o
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.
o
EventTarget
the target to add
after
type
fn
[context]
[arg*]
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.
A subscription handle capable of detaching the subscription
attrAdded
name
Checks if the given attribute has been added to the host
name
String
The name of the attribute to check.
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
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
detach handle
bubble
evt
Propagate an event. Requires the event-custom-complex module.
evt
CustomEvent
the custom event to propagate
the aggregated return value from Event.Custom.fire
clearCache
Clears the cache data used for this interaction.
cssSizestoObject
gutter
//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)
gutter
String
CSS style string for gutter
The gutter Object Literal.
destroy
Destroy lifecycle method. Invokes destructors for the class hierarchy.
A reference to this object
detach
type
fn
context
Detach one or more listeners the from the specified event
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)
the host
detachAll
type
Removes all listeners from the specified event. If the event type is not specified, all listeners from all hosted custom events will be removed.
type
String
The type, or name of the event
fire
type
arguments
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.
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.
True if the whole lifecycle of the event went through, false if at any point the event propagation was halted.
get
name
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.
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")
)
The value of the attribute
getAttrs
attrs
Gets multiple attribute values.
An object with attribute name/value pairs.
getBestMatch
drops
all
This method will gather the area for all potential targets and see which has the hightest covered area and return it.
getDelegate
Get a delegate instance from a container node
Y.DD.Delegate
getDrag
node
Get a valid Drag instance back from a Node or a selector string, false otherwise
node
String/Object
The Node instance or Selector string to check for a valid Drag Object
getDrop
node
Get a valid Drop instance back from a Node or a selector string, false otherwise
node
String/Object
The Node instance or Selector string to check for a valid Drop Object
getEvent
type
prefixed
Returns the custom event of the provided type has been created, a falsy value otherwise
the custom event or null
getNode
n
Return a node instance from the given node, selector string or Y.Base extended object.
n
Node/Object/String
The node to resolve.
getTargets
Returns an array of bubble targets for this object.
EventTarget[]
init
cfg
Init lifecycle method, invoked during construction. Sets up attributes and invokes initializers for the class hierarchy.
cfg
Object
Object with configuration property name/value pairs
A reference to this object
isOverTarget
drop
Check to see if the Drag element is over the target, method varies on current mode
drop
Object
The drop to check against
modifyAttr
name
config
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:
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).
on
type
fn
[context]
[arg*]
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.
A subscription handle capable of detaching that subscription
once
type
fn
[context]
[arg*]
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.
A subscription handle capable of detaching the subscription
onceAfter
type
fn
[context]
[arg*]
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.
A subscription handle capable of detaching that subscription
parseType
type
[pre]
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.
an array containing:
publish
type
opts
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.
type
String
the type, or name of the event
opts
Object
optional config params. Valid properties are:
the custom event
regDelegate
Register a Delegate with the DDM
removeAttr
name
Removes an attribute from the host object
name
String
The name of the attribute to be removed.
reset
name
Resets the attribute (or all attributes) to its initial value, as long as the attribute is not readOnly, or writeOnce.
name
String
Optional. The name of the attribute to reset. If omitted, all attributes are reset.
A reference to the host object.
set
name
value
[opts]
Sets the value of an attribute.
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.
A reference to the host object.
setAttrs
attrs
[opts]
Sets multiple attribute values.
A reference to the host object.
stopDrag
Method will forcefully stop a drag operation. For example calling this from inside an ESC keypress handler will stop this drag.
subscribe
subscribe to an event
swapPosition
n1
n2
Swap the position of 2 nodes based on their CSS positioning.
syncActiveShims
force
This method will sync the position of the shims on the Drop Targets that are currently active.
force
Boolean
Resize/sync all Targets.
toString
Default toString implementation. Provides the constructor NAME and the instance guid, if set.
String representation for this object
unsubscribe
detach a listener
unsubscribeAll
type
Removes all listeners from the specified event. If the event type is not specified, all listeners from all hosted custom events will be removed.
type
String
The type, or name of the event
_allowAdHocAttrs
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
Set this to true to set the shims opacity to .5 for debugging it, default: false.
_noShim
This flag turns off the use of the mouseover/mouseout shim. It should not be used unless you know what you are doing.
_shimming
Set to true when drag starts and useShim is true. Used in pairing with _docMove
activeDrag
A reference to the currently active draggable object.
INTERSECT
In intersect mode, a Drop is targeted by "part" of the drag node being over the Target
mode
The mode that the drag operations will run in 0 for Point, 1 for Intersect, 2 for Strict
otherDrops
An object literal of Other Drop Targets that we encountered during this interaction (in the case of overlapping Drop Targets)
STRICT
In strict mode, a Drop is targeted by the "entire" drag node being over the Target
useHash
Should we only check targets that are in the viewport on drags (for performance), default: true
clickPixelThresh
The number of pixels to move to start a drag operation, default is 3.
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.
e
EventFacade
clickTimeThresh
The number of milliseconds a mousedown has to pass to start a drag operation, default is 1000.
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.
e
EventFacade
destroyed
Flag indicating whether or not this object has been through the destroy lifecycle phase.
Default: false
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.
e
EventFacade
dragCursor
The cursor to apply when dragging, if shimmed the shim will get the cursor.
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.
e
EventFacade
dragMode
This attribute only works if the dd-drop module is active. It will set the dragMode (point, intersect, strict) of all future Drag instances.
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.
e
EventFacade
initialized
Flag indicating whether or not this object has been through the init lifecycle phase.
Default: false
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.
e
EventFacade
throttleTime
The number of milliseconds to throttle the mousemove event. Default: 150
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.
e
EventFacade
destroy
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).
e
EventFacade
Event object
init
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).
e
EventFacade
Event object, with a cfg property which refers to the configuration object passed to the constructor.