dojo/dnd/Source.js

• Provides:

  • dojo.dnd.Source

• Requires:

  • dojo.dnd.Selector in common
  • dojo.dnd.Manager in common

• dojo.dnd.Source

  • type

    Function

  • chains:
    • dojo.dnd.Selector: (prototype)
    • dojo.dnd.Selector: (call)
  • parameters:
    • node: (typeof DOMNode|String)

      node or node's id to build the source on

    • params: (typeof dojo.dnd.__SourceArgs)

      any property of this class may be configured via the params
      object which is mixed-in to the <code>dojo.dnd.Source</code> instance

  • summary

    a Source object, which can be used as a DnD source, or a DnD target

• dojo.dnd.Source.isSource

  • type

    Object

• dojo.dnd.Source.horizontal

  • type

    bool

• dojo.dnd.Source.copyOnly

  • type

    bool

• dojo.dnd.Source.selfCopy

  • type

    bool

• dojo.dnd.Source.selfAccept

  • type

    Object

• dojo.dnd.Source.skipForm

  • type

    bool

• dojo.dnd.Source.withHandles

  • type

    bool

• dojo.dnd.Source.autoSync

  • type

    bool

• dojo.dnd.Source.delay

  • type

    Number

• dojo.dnd.Source.accept

  • type

    Object

• dojo.dnd.Source.generateText

  • type

    Object

• dojo.dnd.Source.constructor

  • constructor - constructor
  • type

    Function

  • parameters:
    • node: (typeof DOMNode|String)

      node or node's id to build the source on

    • params: (typeof dojo.dnd.__SourceArgs)

      any property of this class may be configured via the params
      object which is mixed-in to the <code>dojo.dnd.Source</code> instance

  • summary

    a constructor of the Source

• dojo.dnd.Source.checkAcceptance

  • parameters:
    • source: (typeof Object)

      the source which provides items

    • nodes: (typeof Array)

      the list of transferred items

  • returns

    Boolean

  • summary

    checks if the target can accept nodes from this source

  • type

    Function

• dojo.dnd.Source.copyState

  • parameters:
    • keyPressed: (typeof Boolean)

      the "copy" key was pressed

    • self: (typeof Boolean)

      optional flag that means that we are about to drop on itself

  • returns

    Boolean

  • summary

    Returns true if we need to copy items, false to move.
    It is separated to be overwritten dynamically, if needed.

  • type

    Function

• dojo.dnd.Source.destroy

  • summary

    prepares the object to be garbage-collected

  • type

    Function

• dojo.dnd.Source.targetAnchor

  • type

    Object

• dojo.dnd.Source.markupFactory

  • parameters:
    • params
    • node
  • type

    Function

• dojo.dnd.Source.onMouseMove

  • parameters:
    • e: (typeof Event)

      mouse event

  • summary

    event processor for onmousemove

  • type

    Function

• dojo.dnd.Source.targetBox

  • type

    Object

• dojo.dnd.Source.onMouseDown

  • parameters:
    • e: (typeof Event)

      mouse event

  • summary

    event processor for onmousedown

  • type

    Function

• dojo.dnd.Source.mouseDown

  • type

    bool

• dojo.dnd.Source._lastX

  • type

    Number

• dojo.dnd.Source._lastY

  • type

    Number

• dojo.dnd.Source.onMouseUp

  • parameters:
    • e: (typeof Event)

      mouse event

  • summary

    event processor for onmouseup

  • type

    Function

• dojo.dnd.Source.onDndSourceOver

  • parameters:
    • source: (typeof Object)

      the source which has the mouse over it

  • summary

    topic event processor for /dnd/source/over, called when detected a current source

  • type

    Function

• dojo.dnd.Source.onDndStart

  • parameters:
    • source: (typeof Object)

      the source which provides items

    • nodes: (typeof Array)

      the list of transferred items

    • copy: (typeof Boolean)

      copy items, if true, move items otherwise

  • summary

    topic event processor for /dnd/start, called to initiate the DnD operation

  • type

    Function

• dojo.dnd.Source.isDragging

  • type

    bool

• dojo.dnd.Source.onDndDrop

  • parameters:
    • source: (typeof Object)

      the source which provides items

    • nodes: (typeof Array)

      the list of transferred items

    • copy: (typeof Boolean)

      copy items, if true, move items otherwise

    • target: (typeof Object)

      the target which accepts items

  • summary

    topic event processor for /dnd/drop, called to finish the DnD operation

  • type

    Function

• dojo.dnd.Source.onDndCancel

  • summary

    topic event processor for /dnd/cancel, called to cancel the DnD operation

  • type

    Function

• dojo.dnd.Source.before

  • type

    Object

• dojo.dnd.Source.onDrop

  • parameters:
    • source: (typeof Object)

      the source which provides items

    • nodes: (typeof Array)

      the list of transferred items

    • copy: (typeof Boolean)

      copy items, if true, move items otherwise

  • summary

    called only on the current target, when drop is performed

  • type

    Function

• dojo.dnd.Source.onDropExternal

  • parameters:
    • source: (typeof Object)

      the source which provides items

    • nodes: (typeof Array)

      the list of transferred items

    • copy: (typeof Boolean)

      copy items, if true, move items otherwise

  • summary

    called only on the current target, when drop is performed
    from an external source

  • type

    Function

• dojo.dnd.Source._normalizedCreator

  • parameters:
    • node
    • hint
  • type

    Function

• dojo.dnd.Source.onDropInternal

  • parameters:
    • nodes: (typeof Array)

      the list of transferred items

    • copy: (typeof Boolean)

      copy items, if true, move items otherwise

  • summary

    called only on the current target, when drop is performed
    from the same target/source

  • type

    Function

• dojo.dnd.Source.onDraggingOver

  • summary

    called during the active DnD operation, when items
    are dragged over this target, and it is not disabled

  • type

    Function

• dojo.dnd.Source.onDraggingOut

  • summary

    called during the active DnD operation, when items
    are dragged away from this target, and it is not disabled

  • type

    Function

• dojo.dnd.Source.onOverEvent

  • summary

    this function is called once, when mouse is over our container

  • type

    Function

• dojo.dnd.Source.onOutEvent

  • summary

    this function is called once, when mouse is out of our container

  • type

    Function

• dojo.dnd.Source._markTargetAnchor

  • parameters:
    • before: (typeof Boolean)

      insert before, if true, after otherwise

  • summary

    assigns a class to the current target anchor based on "before" status

  • type

    Function

• dojo.dnd.Source._markTargetAnchor.before

  • type

    Boolean

  • summary

    insert before, if true, after otherwise

• dojo.dnd.Source._unmarkTargetAnchor

  • summary

    removes a class of the current target anchor based on "before" status

  • type

    Function

• dojo.dnd.Source._markDndStatus

  • parameters:
    • copy
  • summary

    changes source's state based on "copy" status

  • type

    Function

• dojo.dnd.Source._legalMouseDown

  • parameters:
    • e: (typeof Event)

      mouse event

  • returns

    Boolean

  • summary

    checks if user clicked on "approved" items

  • type

    Function

• dojo.dnd.Source.sourceState

  • type

    String

• dojo.dnd.Source.targetState

  • type

    String

• dojo.dnd.Source.topics

  • type

    Array

• dojo.dnd.Target

  • type

    Function

  • chains:
    • dojo.dnd.Source: (prototype)
    • dojo.dnd.Source: (call)
  • parameters:
    • node
    • params
  • summary

    a Target object, which can be used as a DnD target

• dojo.dnd.Target.constructor

  • constructor - constructor
  • type

    Function

  • parameters:
    • node
    • params
  • summary

    a constructor of the Target --- see the <code>dojo.dnd.Source.constructor</code> for details

• dojo.dnd.Target.markupFactory

  • parameters:
    • params
    • node
  • type

    Function

• dojo.dnd.Target.isSource

  • type

    bool

• dojo.dnd.AutoSource

  • type

    Function

  • chains:
    • dojo.dnd.Source: (prototype)
    • dojo.dnd.Source: (call)
  • parameters:
    • node
    • params
  • summary

    a source that syncs its DnD nodes by default

• dojo.dnd.AutoSource.constructor

  • constructor - constructor
  • type

    Function

  • parameters:
    • node
    • params
  • summary

    constructor of the AutoSource --- see the Source constructor for details

• dojo.dnd.AutoSource.markupFactory

  • parameters:
    • params
    • node
  • type

    Function

• dojo.dnd.AutoSource.autoSync

  • type

    Object

• dojo.dnd.__SourceArgs

  • summary

    a dict of parameters for DnD Source configuration. Note that any
    property on Source elements may be configured, but this is the
    short-list

  • type

    Function

• dojo.dnd.__SourceArgs.isSource

  • optional
  • type

    Boolean

  • summary

    can be used as a DnD source. Defaults to true.

• dojo.dnd.__SourceArgs.accept

  • optional
  • type

    Array

  • summary

    list of accepted types (text strings) for a target; defaults to
    ["text"]

• dojo.dnd.__SourceArgs.autoSync

  • type

    Boolean

  • summary

    if true refreshes the node list on every operation; false by default

• dojo.dnd.__SourceArgs.copyOnly

  • optional
  • type

    Boolean

  • summary

    copy items, if true, use a state of Ctrl key otherwise,
    see selfCopy and selfAccept for more details

• dojo.dnd.__SourceArgs.delay

  • type

    Number

  • summary

    the move delay in pixels before detecting a drag; 0 by default

• dojo.dnd.__SourceArgs.horizontal

  • optional
  • type

    Boolean

  • summary

    a horizontal container, if true, vertical otherwise or when omitted

• dojo.dnd.__SourceArgs.selfCopy

  • optional
  • type

    Boolean

  • summary

    copy items by default when dropping on itself,
    false by default, works only if copyOnly is true

• dojo.dnd.__SourceArgs.selfAccept

  • optional
  • type

    Boolean

  • summary

    accept its own items when copyOnly is true,
    true by default, works only if copyOnly is true

• dojo.dnd.__SourceArgs.withHandles

  • optional
  • type

    Boolean

  • summary

    allows dragging only by handles, false by default

• dojo.dnd.__SourceArgs.generateText

  • optional
  • type

    Boolean

  • summary

    generate text node for drag and drop, true by default

• dojo.dnd

  • type

    Object

• dojo

  • type

    Object