fx.DragDropItem Extends goog.events.EventTarget
Class representing a source or target element for drag and drop operations.

Inheritance

Constructor

goog.fx.DragDropItem(elementopt_data)

Parameters

element : Element | string
Dom Node, or string representation of node id, to be used as drag source/drop target.
opt_data : Object=
Data associated with the source/target.

Instance Methods

Public Protected Private
getCurrentDragElement() Element
Gets the element that is currently being dragged.
Returns: Element  The element that is currently being dragged.
code »
getData() Object | null | undefined
Get the data associated with the source/target.
Returns: Object | null | undefined  Data associated with the source/target.
code »
getDraggableElement(target) Element
Gets the element that is actually draggable given that the given target was attempted to be dragged. This should be overriden when the element that was given actually contains many items that can be dragged. From the target, you can determine what element should actually be dragged.
Arguments:
target : Element
The target that was attempted to be dragged.
Returns: Element  The element that is draggable given the target. If none are draggable, this will return null.
code »
getDraggableElements() !Array.<Element>
Gets all the elements of this item that are potentially draggable/
Returns: !Array.<Element>  The draggable elements.
code »
maybeStartDrag_(eventelement)
Adds mouse move, mouse out and mouse up handlers.
Arguments:
event : goog.events.BrowserEvent
Mouse down event.
element : Element
Element.
code »
mouseDown_(event)
Event handler for mouse down.
Arguments:
event : goog.events.BrowserEvent
Mouse down event.
code »
mouseMove_(event)
Event handler for mouse move. Starts drag operation if moved more than the threshold value.
Arguments:
event : goog.events.BrowserEvent
Mouse move or mouse out event.
code »
mouseUp_(event)
Event handler for mouse up. Removes mouse move, mouse out and mouse up event handlers.
Arguments:
event : goog.events.BrowserEvent
Mouse up event.
code »
setParent(parent)
Sets the dragdrop to which this item belongs.
Arguments:
parent : goog.fx.AbstractDragDrop
The parent dragdrop.
code »
addEventListener(typeopt_captureopt_handlerScope)
Use #listen instead, when possible. Otherwise, use goog.events.listen if you are passing Object (instead of Function) as handler. Adds an event listener to the event target. The same handler can only be added once per the type. Even if you add the same handler multiple times using the same type then it will only be called once when the event is dispatched.
Arguments:
type : string
The type of the event to listen for.
: ?function():? | ?{handleEvent:function():?
No description.
opt_capture : boolean=
In DOM-compliant browsers, this determines whether the listener is fired during the capture or bubble phase of the event.
opt_handlerScope : Object=
Object in whose scope to call the listener.
code »
assertInitialized_()
Asserts that the event target instance is initialized properly.
code »
dispatchEvent()
No description.
code »
disposeInternal()
Removes listeners from this object. Classes that extend EventTarget may need to override this method in order to remove references to DOM Elements and additional listeners.
code »
fireListeners()
No description.
code »
getListener()
No description.
code »
getListeners()
No description.
code »
getParentEventTarget() goog.events.EventTarget
Returns the parent of this event target to use for bubbling.
Returns: goog.events.EventTarget  The parent EventTarget or null if there is no parent.
code »
hasListener()
No description.
code »
listen()
No description.
code »
listenOnce()
No description.
code »
removeAllListeners()
No description.
code »
removeEventListener(typeopt_captureopt_handlerScope)
Use #unlisten instead, when possible. Otherwise, use goog.events.unlisten if you are passing Object (instead of Function) as handler. Removes an event listener from the event target. The handler must be the same object as the one added. If the handler has not been added then nothing is done.
Arguments:
type : string
The type of the event to listen for.
: ?function():? | ?{handleEvent:function():?
No description.
opt_capture : boolean=
In DOM-compliant browsers, this determines whether the listener is fired during the capture or bubble phase of the event.
opt_handlerScope : Object=
Object in whose scope to call the listener.
code »
setParentEventTarget(parent)
Sets the parent of this event target to use for capture/bubble mechanism.
Arguments:
parent : goog.events.EventTarget
Parent listenable (null if none).
code »
setTargetForTesting(target)
Sets the target to be used for event.target when firing event. Mainly used for testing. For example, see goog.testing.events.mixinListenable.
Arguments:
target : !Object
The target.
code »
unlisten()
No description.
code »
unlistenByKey()
No description.
code »
addOnDisposeCallback(callbackopt_scope)
Invokes a callback function when this object is disposed. Callbacks are invoked in the order in which they were added.
Arguments:
callback : function(this:T):?
The callback function.
opt_scope : T=
An optional scope to call the callback in.
code »
dispose() void
Disposes of the object. If the object hasn't already been disposed of, calls #disposeInternal. Classes that extend goog.Disposable should override #disposeInternal in order to delete references to COM objects, DOM nodes, and other disposable objects. Reentrant.
Returns: void  Nothing.
code »
disposeInternal()
Deletes or nulls out any references to COM objects, DOM nodes, or other disposable objects. Classes that extend goog.Disposable should override this method. Not reentrant. To avoid calling it twice, it must only be called from the subclass' disposeInternal method. Everywhere else the public dispose method must be used. For example:
  mypackage.MyClass = function() {
    mypackage.MyClass.base(this, 'constructor');
    // Constructor logic specific to MyClass.
    ...
  };
  goog.inherits(mypackage.MyClass, goog.Disposable);

  mypackage.MyClass.prototype.disposeInternal = function() {
    // Dispose logic specific to MyClass.
    ...
    // Call superclass's disposeInternal at the end of the subclass's, like
    // in C++, to avoid hard-to-catch issues.
    mypackage.MyClass.base(this, 'disposeInternal');
  };
code »
getDisposed() boolean
Use #isDisposed instead. No description.
Returns: boolean  Whether the object has been disposed of.
code »
isDisposed() boolean
No description.
Returns: boolean  Whether the object has been disposed of.
code »
registerDisposable(disposable)
Associates a disposable object with this object so that they will be disposed together.
Arguments:
disposable : goog.disposable.IDisposable
that will be disposed when this object is disposed.
code »

Instance Properties

constructor :
No description.
Code »
currentDragElement_ :
The current element being dragged. This is needed because a DragDropItem can have multiple elements that can be dragged.
Code »
data :
Data associated with element.
Code »
element :
Reference to drag source/target element
Code »
eventHandler_ : goog.events.EventHandler
Event handler for listeners on events that can initiate a drag.
Code »
Drag object the item belongs to.
Code »
actualEventTarget_ : goog.events.EventTarget
The object to use for event.target. Useful when mixing in an EventTarget to another object.
Code »
constructor :
No description.
Code »
eventTargetListeners_ : goog.events.ListenerMap
Maps of event type to an array of listeners.
Code »
parentEventTarget_ : goog.events.EventTarget
Parent event target, used during event bubbling. TODO(user): Change this to goog.events.Listenable. This currently breaks people who expect getParentEventTarget to return goog.events.EventTarget.
Code »
creationStack :
If monitoring the goog.Disposable instances is enabled, stores the creation stack trace of the Disposable instance.
Code »
disposed_ :
Whether the object has been disposed of.
Code »
onDisposeCallbacks_ :
Callbacks to invoke when this object is disposed.
Code »

Static Properties

goog.fx.DragDropItem.superClass_ :
No description.
Code »

Package fx

Package Reference