sync
[roojs1] / docs / symbols / Roo.dd.DragDropMgr.json
index 7b9338a..08a29c3 100644 (file)
   "see" : "",
   "params" : [],
   "returns" : [],
+  "throws" : "",
+  "requires" : "",
   "config" : [],
   "methods" : [
     {
       "name" : "isDragDrop",
+      "type" : "function",
       "desc" : "Utility function to determine if a given element has been\nregistered as a drag drop item.",
+      "sig" : "(id)",
+      "static" : false,
+      "memberOf" : "",
       "isStatic" : false,
       "isConstructor" : false,
       "isPrivate" : false,
-      "memberOf" : "Roo.dd.DragDropMgr",
       "example" : "",
       "deprecated" : "",
       "since" : "",
       "see" : "",
+      "exceptions" : "",
+      "requires" : "",
       "params" : [
         {
           "name" : "id",
     },
     {
       "name" : "getRelated",
+      "type" : "function",
       "desc" : "Returns the drag and drop instances that are in all groups the\npassed in instance belongs to.",
+      "sig" : "(p_oDD, bTargetsOnly)",
+      "static" : false,
+      "memberOf" : "",
       "isStatic" : false,
       "isConstructor" : false,
       "isPrivate" : false,
-      "memberOf" : "Roo.dd.DragDropMgr",
       "example" : "",
       "deprecated" : "",
       "since" : "",
       "see" : "",
+      "exceptions" : "",
+      "requires" : "",
       "params" : [
         {
           "name" : "p_oDD",
     },
     {
       "name" : "getScrollLeft",
+      "type" : "function",
       "desc" : "Gets the scrollLeft",
+      "sig" : "()\n{\n\n}",
+      "static" : false,
+      "memberOf" : "",
       "isStatic" : false,
       "isConstructor" : false,
       "isPrivate" : false,
-      "memberOf" : "Roo.dd.DragDropMgr",
       "example" : "",
       "deprecated" : "",
       "since" : "",
       "see" : "",
+      "exceptions" : "",
+      "requires" : "",
       "params" : [],
       "returns" : [
         {
     },
     {
       "name" : "regDragDrop",
+      "type" : "function",
       "desc" : "Each DragDrop instance must be registered with the DragDropMgr.\nThis is executed in DragDrop.init()",
+      "sig" : "(oDD, sGroup)",
+      "static" : false,
+      "memberOf" : "",
       "isStatic" : false,
       "isConstructor" : false,
       "isPrivate" : false,
-      "memberOf" : "Roo.dd.DragDropMgr",
       "example" : "",
       "deprecated" : "",
       "since" : "",
       "see" : "",
+      "exceptions" : "",
+      "requires" : "",
       "params" : [
         {
           "name" : "oDD",
     },
     {
       "name" : "handleWasClicked",
+      "type" : "function",
       "desc" : "Recursively searches the immediate parent and all child nodes for\nthe handle element in order to determine wheter or not it was\nclicked.",
+      "sig" : "(node)",
+      "static" : false,
+      "memberOf" : "",
       "isStatic" : false,
       "isConstructor" : false,
       "isPrivate" : false,
-      "memberOf" : "Roo.dd.DragDropMgr",
       "example" : "",
       "deprecated" : "",
       "since" : "",
       "see" : "",
+      "exceptions" : "",
+      "requires" : "",
       "params" : [
         {
           "name" : "node",
     },
     {
       "name" : "refreshCache",
+      "type" : "function",
       "desc" : "Refreshes the cache of the top-left and bottom-right points of the\ndrag and drop objects in the specified group(s).  This is in the\nformat that is stored in the drag and drop instance, so typical\nusage is:\n<code>\nRoo.dd.DragDropMgr.refreshCache(ddinstance.groups);\n</code>\nAlternatively:\n<code>\nRoo.dd.DragDropMgr.refreshCache({group1:true, group2:true});\n</code>",
+      "sig" : "(groups)",
+      "static" : false,
+      "memberOf" : "",
       "isStatic" : false,
       "isConstructor" : false,
       "isPrivate" : false,
-      "memberOf" : "Roo.dd.DragDropMgr",
       "example" : "",
       "deprecated" : "",
       "since" : "",
       "see" : "",
+      "exceptions" : "",
+      "requires" : "",
       "params" : [
         {
           "name" : "groups",
     },
     {
       "name" : "getCss",
+      "type" : "function",
       "desc" : "Returns the style property for the DOM element (i.e.,\ndocument.getElById(id).style)",
+      "sig" : "(id)",
+      "static" : false,
+      "memberOf" : "",
       "isStatic" : false,
       "isConstructor" : false,
       "isPrivate" : false,
-      "memberOf" : "Roo.dd.DragDropMgr",
       "example" : "",
       "deprecated" : "This has been deprecated: use Roo.getDom instead",
       "since" : "",
       "see" : "",
+      "exceptions" : "",
+      "requires" : "",
       "params" : [
         {
           "name" : "id",
     },
     {
       "name" : "swapNode",
+      "type" : "function",
       "desc" : "Swap two nodes.  In IE, we use the native method, for others we\nemulate the IE behavior",
+      "sig" : "(n1, n2)",
+      "static" : false,
+      "memberOf" : "",
       "isStatic" : false,
       "isConstructor" : false,
       "isPrivate" : false,
-      "memberOf" : "Roo.dd.DragDropMgr",
       "example" : "",
       "deprecated" : "",
       "since" : "",
       "see" : "",
+      "exceptions" : "",
+      "requires" : "",
       "params" : [
         {
           "name" : "n1",
     },
     {
       "name" : "stopEvent",
+      "type" : "function",
       "desc" : "Utility to stop event propagation and event default, if these\nfeatures are turned on.",
+      "sig" : "(e)",
+      "static" : false,
+      "memberOf" : "",
       "isStatic" : false,
       "isConstructor" : false,
       "isPrivate" : false,
-      "memberOf" : "Roo.dd.DragDropMgr",
       "example" : "",
       "deprecated" : "",
       "since" : "",
       "see" : "",
+      "exceptions" : "",
+      "requires" : "",
       "params" : [
         {
           "name" : "e",
     },
     {
       "name" : "lock",
+      "type" : "function",
       "desc" : "Lock all drag and drop functionality",
+      "sig" : "()\n{\n\n}",
+      "static" : false,
+      "memberOf" : "",
       "isStatic" : false,
       "isConstructor" : false,
       "isPrivate" : false,
-      "memberOf" : "Roo.dd.DragDropMgr",
       "example" : "",
       "deprecated" : "",
       "since" : "",
       "see" : "",
+      "exceptions" : "",
+      "requires" : "",
       "params" : [],
       "returns" : []
     },
     {
       "name" : "moveToEl",
+      "type" : "function",
       "desc" : "Sets the x/y position of an element to the location of the\ntarget element.",
+      "sig" : "(moveEl, targetEl)",
+      "static" : false,
+      "memberOf" : "",
       "isStatic" : false,
       "isConstructor" : false,
       "isPrivate" : false,
-      "memberOf" : "Roo.dd.DragDropMgr",
       "example" : "",
       "deprecated" : "",
       "since" : "",
       "see" : "",
+      "exceptions" : "",
+      "requires" : "",
       "params" : [
         {
           "name" : "moveEl",
     },
     {
       "name" : "unlock",
+      "type" : "function",
       "desc" : "Unlock all drag and drop functionality",
+      "sig" : "()\n{\n\n}",
+      "static" : false,
+      "memberOf" : "",
       "isStatic" : false,
       "isConstructor" : false,
       "isPrivate" : false,
-      "memberOf" : "Roo.dd.DragDropMgr",
       "example" : "",
       "deprecated" : "",
       "since" : "",
       "see" : "",
+      "exceptions" : "",
+      "requires" : "",
       "params" : [],
       "returns" : []
     },
     {
       "name" : "getDDById",
+      "type" : "function",
       "desc" : "Returns the DragDrop instance for a given id",
+      "sig" : "(id)",
+      "static" : false,
+      "memberOf" : "",
       "isStatic" : false,
       "isConstructor" : false,
       "isPrivate" : false,
-      "memberOf" : "Roo.dd.DragDropMgr",
       "example" : "",
       "deprecated" : "",
       "since" : "",
       "see" : "",
+      "exceptions" : "",
+      "requires" : "",
       "params" : [
         {
           "name" : "id",
     },
     {
       "name" : "isLegalTarget",
+      "type" : "function",
       "desc" : "Returns true if the specified dd target is a legal target for\nthe specifice drag obj",
+      "sig" : "(the, the)",
+      "static" : false,
+      "memberOf" : "",
       "isStatic" : false,
       "isConstructor" : false,
       "isPrivate" : false,
-      "memberOf" : "Roo.dd.DragDropMgr",
       "example" : "",
       "deprecated" : "",
       "since" : "",
       "see" : "",
+      "exceptions" : "",
+      "requires" : "",
       "params" : [
         {
           "name" : "the",
     },
     {
       "name" : "isTypeOfDD",
+      "type" : "function",
       "desc" : "My goal is to be able to transparently determine if an object is\ntypeof DragDrop, and the exact subclass of DragDrop.  typeof\nreturns \"object\", oDD.constructor.toString() always returns\n\"DragDrop\" and not the name of the subclass.  So for now it just\nevaluates a well-known variable in DragDrop.",
+      "sig" : "(the)",
+      "static" : false,
+      "memberOf" : "",
       "isStatic" : false,
       "isConstructor" : false,
       "isPrivate" : false,
-      "memberOf" : "Roo.dd.DragDropMgr",
       "example" : "",
       "deprecated" : "",
       "since" : "",
       "see" : "",
+      "exceptions" : "",
+      "requires" : "",
       "params" : [
         {
           "name" : "the",
     },
     {
       "name" : "startDrag",
+      "type" : "function",
       "desc" : "Fired when either the drag pixel threshol or the mousedown hold\ntime threshold has been met.",
+      "sig" : "(x, y)",
+      "static" : false,
+      "memberOf" : "",
       "isStatic" : false,
       "isConstructor" : false,
       "isPrivate" : false,
-      "memberOf" : "Roo.dd.DragDropMgr",
       "example" : "",
       "deprecated" : "",
       "since" : "",
       "see" : "",
+      "exceptions" : "",
+      "requires" : "",
       "params" : [
         {
           "name" : "x",
     },
     {
       "name" : "getStyle",
+      "type" : "function",
       "desc" : "Returns the specified element style property",
+      "sig" : "(el, styleProp)",
+      "static" : false,
+      "memberOf" : "",
       "isStatic" : false,
       "isConstructor" : false,
       "isPrivate" : false,
-      "memberOf" : "Roo.dd.DragDropMgr",
       "example" : "",
       "deprecated" : "This has been deprecated: use Roo.lib.Dom.getStyle",
       "since" : "",
       "see" : "",
+      "exceptions" : "",
+      "requires" : "",
       "params" : [
         {
           "name" : "el",
     },
     {
       "name" : "getPosX",
+      "type" : "function",
       "desc" : "Returns the X position of an html element",
+      "sig" : "(el)",
+      "static" : false,
+      "memberOf" : "",
       "isStatic" : false,
       "isConstructor" : false,
       "isPrivate" : false,
-      "memberOf" : "Roo.dd.DragDropMgr",
       "example" : "",
       "deprecated" : "This has been deprecated: use Roo.lib.Dom.getX instead",
       "since" : "",
       "see" : "",
+      "exceptions" : "",
+      "requires" : "",
       "params" : [
         {
           "name" : "el",
     },
     {
       "name" : "getPosY",
+      "type" : "function",
       "desc" : "Returns the Y position of an html element",
+      "sig" : "(el)",
+      "static" : false,
+      "memberOf" : "",
       "isStatic" : false,
       "isConstructor" : false,
       "isPrivate" : false,
-      "memberOf" : "Roo.dd.DragDropMgr",
       "example" : "",
       "deprecated" : "This has been deprecated: use Roo.lib.Dom.getY instead",
       "since" : "",
       "see" : "",
+      "exceptions" : "",
+      "requires" : "",
       "params" : [
         {
           "name" : "el",
     },
     {
       "name" : "isLocked",
+      "type" : "function",
       "desc" : "Is drag and drop locked?",
+      "sig" : "()\n{\n\n}",
+      "static" : false,
+      "memberOf" : "",
       "isStatic" : false,
       "isConstructor" : false,
       "isPrivate" : false,
-      "memberOf" : "Roo.dd.DragDropMgr",
       "example" : "",
       "deprecated" : "",
       "since" : "",
       "see" : "",
+      "exceptions" : "",
+      "requires" : "",
       "params" : [],
       "returns" : [
         {
     },
     {
       "name" : "getBestMatch",
+      "type" : "function",
       "desc" : "Helper function for getting the best match from the list of drag\nand drop objects returned by the drag and drop events when we are\nin INTERSECT mode.  It returns either the first object that the\ncursor is over, or the object that has the greatest overlap with\nthe dragged element.",
+      "sig" : "(dds)",
+      "static" : false,
+      "memberOf" : "",
       "isStatic" : false,
       "isConstructor" : false,
       "isPrivate" : false,
-      "memberOf" : "Roo.dd.DragDropMgr",
       "example" : "",
       "deprecated" : "",
       "since" : "",
       "see" : "",
+      "exceptions" : "",
+      "requires" : "",
       "params" : [
         {
           "name" : "dds",
     },
     {
       "name" : "getLocation",
+      "type" : "function",
       "desc" : "Returns a Region object containing the drag and drop element's position\nand size, including the padding configured for it",
+      "sig" : "(oDD)",
+      "static" : false,
+      "memberOf" : "",
       "isStatic" : false,
       "isConstructor" : false,
       "isPrivate" : false,
-      "memberOf" : "Roo.dd.DragDropMgr",
       "example" : "",
       "deprecated" : "",
       "since" : "",
       "see" : "",
+      "exceptions" : "",
+      "requires" : "",
       "params" : [
         {
           "name" : "oDD",
     },
     {
       "name" : "isHandle",
+      "type" : "function",
       "desc" : "Utility function to determine if a given element has been\nregistered as a drag drop handle for the given Drag Drop object.",
+      "sig" : "(id)",
+      "static" : false,
+      "memberOf" : "",
       "isStatic" : false,
       "isConstructor" : false,
       "isPrivate" : false,
-      "memberOf" : "Roo.dd.DragDropMgr",
       "example" : "",
       "deprecated" : "",
       "since" : "",
       "see" : "",
+      "exceptions" : "",
+      "requires" : "",
       "params" : [
         {
           "name" : "id",
     },
     {
       "name" : "getScrollTop",
+      "type" : "function",
       "desc" : "Gets the scrollTop",
+      "sig" : "()\n{\n\n}",
+      "static" : false,
+      "memberOf" : "",
       "isStatic" : false,
       "isConstructor" : false,
       "isPrivate" : false,
-      "memberOf" : "Roo.dd.DragDropMgr",
       "example" : "",
       "deprecated" : "",
       "since" : "",
       "see" : "",
+      "exceptions" : "",
+      "requires" : "",
       "params" : [],
       "returns" : [
         {
     },
     {
       "name" : "numericSort",
+      "type" : "function",
       "desc" : "Numeric array sort function",
+      "sig" : "()\n{\n\n}",
+      "static" : false,
+      "memberOf" : "",
       "isStatic" : false,
       "isConstructor" : false,
       "isPrivate" : false,
-      "memberOf" : "Roo.dd.DragDropMgr",
       "example" : "",
       "deprecated" : "",
       "since" : "",
       "see" : "",
+      "exceptions" : "",
+      "requires" : "",
       "params" : [],
       "returns" : []
     },
     {
       "name" : "regHandle",
+      "type" : "function",
       "desc" : "Each DragDrop handle element must be registered.  This is done\nautomatically when executing DragDrop.setHandleElId()",
+      "sig" : "(sDDId, sHandleId)",
+      "static" : false,
+      "memberOf" : "",
       "isStatic" : false,
       "isConstructor" : false,
       "isPrivate" : false,
-      "memberOf" : "Roo.dd.DragDropMgr",
       "example" : "",
       "deprecated" : "",
       "since" : "",
       "see" : "",
+      "exceptions" : "",
+      "requires" : "",
       "params" : [
         {
           "name" : "sDDId",
     },
     {
       "name" : "getElement",
+      "type" : "function",
       "desc" : "Returns the actual DOM element",
+      "sig" : "(id)",
+      "static" : false,
+      "memberOf" : "",
       "isStatic" : false,
       "isConstructor" : false,
       "isPrivate" : false,
-      "memberOf" : "Roo.dd.DragDropMgr",
       "example" : "",
       "deprecated" : "This has been deprecated: use Roo.getDom instead",
       "since" : "",
       "see" : "",
+      "exceptions" : "",
+      "requires" : "",
       "params" : [
         {
           "name" : "id",
     },
     {
       "name" : "verifyEl",
+      "type" : "function",
       "desc" : "This checks to make sure an element exists and is in the DOM.  The\nmain purpose is to handle cases where innerHTML is used to remove\ndrag and drop objects from the DOM.  IE provides an 'unspecified\nerror' when trying to access the offsetParent of such an element",
+      "sig" : "(el)",
+      "static" : false,
+      "memberOf" : "",
       "isStatic" : false,
       "isConstructor" : false,
       "isPrivate" : false,
-      "memberOf" : "Roo.dd.DragDropMgr",
       "example" : "",
       "deprecated" : "",
       "since" : "",
       "see" : "",
+      "exceptions" : "",
+      "requires" : "",
       "params" : [
         {
           "name" : "el",