Yahoo! UI Library

dd  3.0.0pr2

Yahoo! UI Library > dd > Proxy
Search:
 
Filters

Class Proxy - extends Drag

This class extends dd-drag to allow for creating a proxy drag node, instead of dragging the original node.

Constructor

Proxy ( )

Methods

_createFrame

private void _createFrame ( )
Create the proxy element if it doesn't already exist and set the DD.DDM._proxy value
Returns: void

_setFrame

private void _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.
Returns: void

end

void end ( )
Ends the drag operation, if moveOnEnd is set it will position the Drag Element to the new location of the proxy.
Returns: void

initializer

private void initializer ( )
Lifecycle method
Returns: void

start

void start ( )
Starts the drag operation and sets the dragNode config option.
Returns: void

Events

borderStyleChange

borderStyleChange ( event )
Fires when the value for the configuration attribute 'borderStyle' 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:
event <Event.Facade> An Event Facade object with the following attribute specific properties added:
prevVal
The value of the attribute, prior to it being set
newVal
The value the attribute is to be set to
attrName
The name of the attribute being set
subAttrName
If setting a property within the attribute's value, the name of the sub-attribute property being set

moveOnEndChange

moveOnEndChange ( event )
Fires when the value for the configuration attribute 'moveOnEnd' 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:
event <Event.Facade> An Event Facade object with the following attribute specific properties added:
prevVal
The value of the attribute, prior to it being set
newVal
The value the attribute is to be set to
attrName
The name of the attribute being set
subAttrName
If setting a property within the attribute's value, the name of the sub-attribute property being set

positionProxyChange

positionProxyChange ( event )
Fires when the value for the configuration attribute 'positionProxy' 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:
event <Event.Facade> An Event Facade object with the following attribute specific properties added:
prevVal
The value of the attribute, prior to it being set
newVal
The value the attribute is to be set to
attrName
The name of the attribute being set
subAttrName
If setting a property within the attribute's value, the name of the sub-attribute property being set

proxyChange

proxyChange ( event )
Fires when the value for the configuration attribute 'proxy' 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:
event <Event.Facade> An Event Facade object with the following attribute specific properties added:
prevVal
The value of the attribute, prior to it being set
newVal
The value the attribute is to be set to
attrName
The name of the attribute being set
subAttrName
If setting a property within the attribute's value, the name of the sub-attribute property being set

resizeFrameChange

resizeFrameChange ( event )
Fires when the value for the configuration attribute 'resizeFrame' 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:
event <Event.Facade> An Event Facade object with the following attribute specific properties added:
prevVal
The value of the attribute, prior to it being set
newVal
The value the attribute is to be set to
attrName
The name of the attribute being set
subAttrName
If setting a property within the attribute's value, the name of the sub-attribute property being set

Configuration Attributes

borderStyle - Boolean

The default border style for the border of the proxy. Default: 1px solid #808080

moveOnEnd - Boolean

Move the original node at the end of the drag. Default: true

positionProxy - Boolean

Make the Proxy node appear in the same place as the original node. Default: true

proxy - Boolean

Make this Draggable instance a Proxy instance. Default: false

resizeFrame - Boolean

Make the Proxy node assume the size of the original node. Default: true

Configuration attributes inherited from Base:


Copyright © 2008 Yahoo! Inc. All rights reserved.