git.roojs.org Git - roojs1/blob - docs/symbols/Roo.json

   1 {
   2   "name" : "Roo",
   3   "augments" : [],
   4   "desc" : "Roo core utilities and functions.",
   5   "isSingleton" : true,
   6   "isStatic" : false,
   7   "isBuiltin" : false,
   8   "memberOf" : "Roo",
   9   "example" : "",
  10   "deprecated" : "",
  11   "since" : "",
  12   "see" : "",
  13   "params" : [],
  14   "returns" : [],
  15   "config" : [],
  16   "methods" : [
  17     {
  18       "name" : "each",
  19       "desc" : "Iterates an array calling the passed function with each item, stopping if your function returns false. If the\npassed array is not really an array, your function is called once with it.\nThe supplied function is called with (Object item, Number index, Array allItems).",
  20       "isStatic" : true,
  21       "isConstructor" : false,
  22       "isPrivate" : false,
  23       "memberOf" : "Roo",
  24       "example" : "",
  25       "deprecated" : "",
  26       "since" : "",
  27       "see" : "",
  28       "params" : [
  29         {
  30           "name" : "array",
  31           "type" : "Array/NodeList/Mixed",
  32           "desc" : "",
  33           "isOptional" : false
  34         },
  35         {
  36           "name" : "fn",
  37           "type" : "Function",
  38           "desc" : "",
  39           "isOptional" : false
  40         },
  41         {
  42           "name" : "scope",
  43           "type" : "Object",
  44           "desc" : "",
  45           "isOptional" : false
  46         }
  47       ],
  48       "returns" : []
  49     },
  50     {
  51       "name" : "get",
  52       "desc" : "Static method to retrieve Element objects. Uses simple caching to consistently return the same object.\nAutomatically fixes if an object was recreated with the same id via AJAX or DOM.\nShorthand of {@link Roo.Element#get}",
  53       "isStatic" : true,
  54       "isConstructor" : false,
  55       "isPrivate" : false,
  56       "memberOf" : "Roo",
  57       "example" : "",
  58       "deprecated" : "",
  59       "since" : "",
  60       "see" : "",
  61       "params" : [
  62         {
  63           "name" : "el",
  64           "type" : "String/HTMLElement/Element",
  65           "desc" : "The id of the node, a DOM Node or an existing Element.",
  66           "isOptional" : false
  67         }
  68       ],
  69       "returns" : [
  70         {
  71           "name" : "",
  72           "type" : "Element",
  73           "desc" : "The Element object"
  74         }
  75       ]
  76     },
  77     {
  78       "name" : "decode",
  79       "desc" : "Shorthand for {@link Roo.util.JSON#decode}",
  80       "isStatic" : true,
  81       "isConstructor" : false,
  82       "isPrivate" : false,
  83       "memberOf" : "Roo",
  84       "example" : "",
  85       "deprecated" : "",
  86       "since" : "",
  87       "see" : "",
  88       "params" : [],
  89       "returns" : []
  90     },
  91     {
  92       "name" : "getDom",
  93       "desc" : "Return the dom node for the passed string (id), dom node, or Roo.Element",
  94       "isStatic" : true,
  95       "isConstructor" : false,
  96       "isPrivate" : false,
  97       "memberOf" : "Roo",
  98       "example" : "",
  99       "deprecated" : "",
 100       "since" : "",
 101       "see" : "",
 102       "params" : [
 103         {
 104           "name" : "el",
 105           "type" : "String/HTMLElement/Roo.Element",
 106           "desc" : "",
 107           "isOptional" : false
 108         }
 109       ],
 110       "returns" : [
 111         {
 112           "name" : "",
 113           "type" : "",
 114           "desc" : "HTMLElement"
 115         }
 116       ]
 117     },
 118     {
 119       "name" : "urlEncode",
 120       "desc" : "Takes an object and converts it to an encoded URL. e.g. Roo.urlEncode({foo: 1, bar: 2}); would return \"foo=1&bar=2\".  Optionally, property values can be arrays, instead of keys and the resulting string that's returned will contain a name/value pair for each array value.",
 121       "isStatic" : true,
 122       "isConstructor" : false,
 123       "isPrivate" : false,
 124       "memberOf" : "Roo",
 125       "example" : "",
 126       "deprecated" : "",
 127       "since" : "",
 128       "see" : "",
 129       "params" : [
 130         {
 131           "name" : "o",
 132           "type" : "Object",
 133           "desc" : "",
 134           "isOptional" : false
 135         }
 136       ],
 137       "returns" : [
 138         {
 139           "name" : "",
 140           "type" : "String",
 141           "desc" : ""
 142         }
 143       ]
 144     },
 145     {
 146       "name" : "addBehaviors",
 147       "desc" : "Applies event listeners to elements by selectors when the document is ready.\nThe event name is specified with an @ suffix.\n<pre><code>\nRoo.addBehaviors({\n   // add a listener for click on all anchors in element with id foo\n   '#foo a@click' : function(e, t){\n       // do something\n   },\n\n   // add the same listener to multiple selectors (separated by comma BEFORE the @)\n   '#foo a, #bar span.some-class@mouseover' : function(){\n       // do something\n   }\n});\n</code></pre>",
 148       "isStatic" : true,
 149       "isConstructor" : false,
 150       "isPrivate" : false,
 151       "memberOf" : "Roo",
 152       "example" : "",
 153       "deprecated" : "",
 154       "since" : "",
 155       "see" : "",
 156       "params" : [
 157         {
 158           "name" : "obj",
 159           "type" : "Object",
 160           "desc" : "The list of behaviors to apply",
 161           "isOptional" : false
 162         }
 163       ],
 164       "returns" : []
 165     },
 166     {
 167       "name" : "getGridSize",
 168       "desc" : "Find the current bootstrap width Grid size\nNote xs is the default for smaller.. - this is currently used by grids to render correct columns",
 169       "isStatic" : true,
 170       "isConstructor" : false,
 171       "isPrivate" : false,
 172       "memberOf" : "Roo",
 173       "example" : "",
 174       "deprecated" : "",
 175       "since" : "",
 176       "see" : "",
 177       "params" : [],
 178       "returns" : []
 179     },
 180     {
 181       "name" : "factory",
 182       "desc" : "Creates namespaces to be used for scoping variables and classes so that they are not global.  Usage:\n<pre><code>\nRoo.factory({ xns: Roo.data, xtype : 'Store', .....});\nRoo.factory(conf, Roo.data);\n</code></pre>",
 183       "isStatic" : true,
 184       "isConstructor" : false,
 185       "isPrivate" : false,
 186       "memberOf" : "Roo",
 187       "example" : "",
 188       "deprecated" : "",
 189       "since" : "",
 190       "see" : "",
 191       "params" : [
 192         {
 193           "name" : "classname",
 194           "type" : "String",
 195           "desc" : "",
 196           "isOptional" : false
 197         },
 198         {
 199           "name" : "namespace",
 200           "type" : "String",
 201           "desc" : "(optional)",
 202           "isOptional" : false
 203         }
 204       ],
 205       "returns" : []
 206     },
 207     {
 208       "name" : "apply",
 209       "desc" : "Copies all the properties of config to obj.",
 210       "isStatic" : true,
 211       "isConstructor" : false,
 212       "isPrivate" : false,
 213       "memberOf" : "Roo",
 214       "example" : "",
 215       "deprecated" : "",
 216       "since" : "",
 217       "see" : "",
 218       "params" : [
 219         {
 220           "name" : "obj",
 221           "type" : "Object",
 222           "desc" : "The receiver of the properties",
 223           "isOptional" : false
 224         },
 225         {
 226           "name" : "config",
 227           "type" : "Object",
 228           "desc" : "The source of the properties",
 229           "isOptional" : false
 230         },
 231         {
 232           "name" : "defaults",
 233           "type" : "Object",
 234           "desc" : "A different object that will also be applied for default values",
 235           "isOptional" : false
 236         }
 237       ],
 238       "returns" : [
 239         {
 240           "name" : "",
 241           "type" : "Object",
 242           "desc" : "returns obj"
 243         }
 244       ]
 245     },
 246     {
 247       "name" : "onReady",
 248       "desc" : "Fires when the document is ready (before onload and before images are loaded).  Shorthand of {@link Roo.EventManager#onDocumentReady}.",
 249       "isStatic" : true,
 250       "isConstructor" : false,
 251       "isPrivate" : false,
 252       "memberOf" : "Roo",
 253       "example" : "",
 254       "deprecated" : "",
 255       "since" : "",
 256       "see" : "",
 257       "params" : [
 258         {
 259           "name" : "fn",
 260           "type" : "Function",
 261           "desc" : "The method the event invokes",
 262           "isOptional" : false
 263         },
 264         {
 265           "name" : "scope",
 266           "type" : "Object",
 267           "desc" : "An  object that becomes the scope of the handler",
 268           "isOptional" : false
 269         },
 270         {
 271           "name" : "override",
 272           "type" : "boolean",
 273           "desc" : "If true, the obj passed in becomes\n                            the execution scope of the listener",
 274           "isOptional" : false
 275         }
 276       ],
 277       "returns" : []
 278     },
 279     {
 280       "name" : "select",
 281       "desc" : "Selects elements based on the passed CSS selector to enable working on them as 1.",
 282       "isStatic" : true,
 283       "isConstructor" : false,
 284       "isPrivate" : false,
 285       "memberOf" : "Roo",
 286       "example" : "",
 287       "deprecated" : "",
 288       "since" : "",
 289       "see" : "",
 290       "params" : [
 291         {
 292           "name" : "selector",
 293           "type" : "String/Array",
 294           "desc" : "The CSS selector or an array of elements",
 295           "isOptional" : false
 296         },
 297         {
 298           "name" : "unique",
 299           "type" : "Boolean",
 300           "desc" : "(optional) true to create a unique Roo.Element for each element (defaults to a shared flyweight object)",
 301           "isOptional" : false
 302         },
 303         {
 304           "name" : "root",
 305           "type" : "HTMLElement/String",
 306           "desc" : "(optional) The root element of the query or id of the root",
 307           "isOptional" : false
 308         }
 309       ],
 310       "returns" : [
 311         {
 312           "name" : "",
 313           "type" : "CompositeElementLite/CompositeElement",
 314           "desc" : ""
 315         }
 316       ]
 317     },
 318     {
 319       "name" : "applyIf",
 320       "desc" : "Copies all the properties of config to obj if they don't already exist.",
 321       "isStatic" : true,
 322       "isConstructor" : false,
 323       "isPrivate" : false,
 324       "memberOf" : "Roo",
 325       "example" : "",
 326       "deprecated" : "",
 327       "since" : "",
 328       "see" : "",
 329       "params" : [
 330         {
 331           "name" : "obj",
 332           "type" : "Object",
 333           "desc" : "The receiver of the properties",
 334           "isOptional" : false
 335         },
 336         {
 337           "name" : "config",
 338           "type" : "Object",
 339           "desc" : "The source of the properties",
 340           "isOptional" : false
 341         }
 342       ],
 343       "returns" : [
 344         {
 345           "name" : "",
 346           "type" : "Object",
 347           "desc" : "returns obj"
 348         }
 349       ]
 350     },
 351     {
 352       "name" : "getCmp",
 353       "desc" : "Shorthand for {@link Roo.ComponentMgr#get}",
 354       "isStatic" : true,
 355       "isConstructor" : false,
 356       "isPrivate" : false,
 357       "memberOf" : "Roo",
 358       "example" : "",
 359       "deprecated" : "",
 360       "since" : "",
 361       "see" : "",
 362       "params" : [
 363         {
 364           "name" : "id",
 365           "type" : "String",
 366           "desc" : "",
 367           "isOptional" : false
 368         }
 369       ],
 370       "returns" : [
 371         {
 372           "name" : "",
 373           "type" : "",
 374           "desc" : "Roo.Component"
 375         }
 376       ]
 377     },
 378     {
 379       "name" : "id",
 380       "desc" : "Generates unique ids. If the element already has an id, it is unchanged",
 381       "isStatic" : true,
 382       "isConstructor" : false,
 383       "isPrivate" : false,
 384       "memberOf" : "Roo",
 385       "example" : "",
 386       "deprecated" : "",
 387       "since" : "",
 388       "see" : "",
 389       "params" : [
 390         {
 391           "name" : "el",
 392           "type" : "String/HTMLElement/Element",
 393           "desc" : "(optional) The element to generate an id for",
 394           "isOptional" : false
 395         },
 396         {
 397           "name" : "prefix",
 398           "type" : "String",
 399           "desc" : "(optional) Id prefix (defaults \"Roo-gen\")",
 400           "isOptional" : false
 401         }
 402       ],
 403       "returns" : [
 404         {
 405           "name" : "",
 406           "type" : "String",
 407           "desc" : "The generated Id."
 408         }
 409       ]
 410     },
 411     {
 412       "name" : "encodeURIComponent",
 413       "desc" : "Safe version of encodeURIComponent",
 414       "isStatic" : true,
 415       "isConstructor" : false,
 416       "isPrivate" : false,
 417       "memberOf" : "Roo",
 418       "example" : "",
 419       "deprecated" : "",
 420       "since" : "",
 421       "see" : "",
 422       "params" : [
 423         {
 424           "name" : "data",
 425           "type" : "String",
 426           "desc" : "",
 427           "isOptional" : false
 428         }
 429       ],
 430       "returns" : [
 431         {
 432           "name" : "",
 433           "type" : "String",
 434           "desc" : ""
 435         }
 436       ]
 437     },
 438     {
 439       "name" : "encode",
 440       "desc" : "Shorthand for {@link Roo.util.JSON#encode}",
 441       "isStatic" : true,
 442       "isConstructor" : false,
 443       "isPrivate" : false,
 444       "memberOf" : "Roo",
 445       "example" : "",
 446       "deprecated" : "",
 447       "since" : "",
 448       "see" : "",
 449       "params" : [],
 450       "returns" : []
 451     },
 452     {
 453       "name" : "fly",
 454       "desc" : "Gets the globally shared flyweight Element, with the passed node as the active element. Do not store a reference to this element -\nthe dom node can be overwritten by other code.\nShorthand of {@link Roo.Element#fly}",
 455       "isStatic" : true,
 456       "isConstructor" : false,
 457       "isPrivate" : false,
 458       "memberOf" : "Roo",
 459       "example" : "",
 460       "deprecated" : "",
 461       "since" : "",
 462       "see" : "",
 463       "params" : [
 464         {
 465           "name" : "el",
 466           "type" : "String/HTMLElement",
 467           "desc" : "The dom node or id",
 468           "isOptional" : false
 469         },
 470         {
 471           "name" : "named",
 472           "type" : "String",
 473           "desc" : "(optional) Allows for creation of named reusable flyweights to\n                                 prevent conflicts (e.g. internally Roo uses \"_internal\")",
 474           "isOptional" : false
 475         }
 476       ],
 477       "returns" : [
 478         {
 479           "name" : "",
 480           "type" : "Element",
 481           "desc" : "The shared Element object"
 482         }
 483       ]
 484     },
 485     {
 486       "name" : "isEmpty",
 487       "desc" : "Returns true if the passed value is null, undefined or an empty string (optional).",
 488       "isStatic" : true,
 489       "isConstructor" : false,
 490       "isPrivate" : false,
 491       "memberOf" : "Roo",
 492       "example" : "",
 493       "deprecated" : "",
 494       "since" : "",
 495       "see" : "",
 496       "params" : [
 497         {
 498           "name" : "value",
 499           "type" : "Mixed",
 500           "desc" : "The value to test",
 501           "isOptional" : false
 502         },
 503         {
 504           "name" : "allowBlank",
 505           "type" : "Boolean",
 506           "desc" : "(optional) Pass true if an empty string is not considered empty",
 507           "isOptional" : false
 508         }
 509       ],
 510       "returns" : [
 511         {
 512           "name" : "",
 513           "type" : "Boolean",
 514           "desc" : ""
 515         }
 516       ]
 517     },
 518     {
 519       "name" : "query",
 520       "desc" : "Selects an array of DOM nodes by CSS/XPath selector. Shorthand of {@link Roo.DomQuery#select}",
 521       "isStatic" : true,
 522       "isConstructor" : false,
 523       "isPrivate" : false,
 524       "memberOf" : "Roo",
 525       "example" : "",
 526       "deprecated" : "",
 527       "since" : "",
 528       "see" : "",
 529       "params" : [
 530         {
 531           "name" : "path",
 532           "type" : "String",
 533           "desc" : "The selector/xpath query",
 534           "isOptional" : false
 535         },
 536         {
 537           "name" : "root",
 538           "type" : "Node",
 539           "desc" : "(optional) The start of the query (defaults to document).",
 540           "isOptional" : false
 541         }
 542       ],
 543       "returns" : [
 544         {
 545           "name" : "",
 546           "type" : "Array",
 547           "desc" : ""
 548         }
 549       ]
 550     },
 551     {
 552       "name" : "urlDecode",
 553       "desc" : "Takes an encoded URL and and converts it to an object. e.g. Roo.urlDecode(\"foo=1&bar=2\"); would return {foo: 1, bar: 2} or Roo.urlDecode(\"foo=1&bar=2&bar=3&bar=4\", true); would return {foo: 1, bar: [2, 3, 4]}.",
 554       "isStatic" : true,
 555       "isConstructor" : false,
 556       "isPrivate" : false,
 557       "memberOf" : "Roo",
 558       "example" : "",
 559       "deprecated" : "",
 560       "since" : "",
 561       "see" : "",
 562       "params" : [
 563         {
 564           "name" : "string",
 565           "type" : "String",
 566           "desc" : "",
 567           "isOptional" : false
 568         },
 569         {
 570           "name" : "overwrite",
 571           "type" : "Boolean",
 572           "desc" : "(optional) Items of the same name will overwrite previous values instead of creating an an array (Defaults to false).",
 573           "isOptional" : false
 574         }
 575       ],
 576       "returns" : [
 577         {
 578           "name" : "",
 579           "type" : "Object",
 580           "desc" : "A literal with members"
 581         }
 582       ]
 583     },
 584     {
 585       "name" : "escapeRe",
 586       "desc" : "Escapes the passed string for use in a regular expression",
 587       "isStatic" : true,
 588       "isConstructor" : false,
 589       "isPrivate" : false,
 590       "memberOf" : "Roo",
 591       "example" : "",
 592       "deprecated" : "",
 593       "since" : "",
 594       "see" : "",
 595       "params" : [
 596         {
 597           "name" : "str",
 598           "type" : "String",
 599           "desc" : "",
 600           "isOptional" : false
 601         }
 602       ],
 603       "returns" : [
 604         {
 605           "name" : "",
 606           "type" : "String",
 607           "desc" : ""
 608         }
 609       ]
 610     },
 611     {
 612       "name" : "extend",
 613       "desc" : "Extends one class with another class and optionally overrides members with the passed literal. This class\nalso adds the function \"override()\" to the class that can be used to override\nmembers on an instance.",
 614       "isStatic" : true,
 615       "isConstructor" : false,
 616       "isPrivate" : false,
 617       "memberOf" : "Roo",
 618       "example" : "",
 619       "deprecated" : "",
 620       "since" : "",
 621       "see" : "",
 622       "params" : [
 623         {
 624           "name" : "subclass",
 625           "type" : "Object",
 626           "desc" : "The class inheriting the functionality",
 627           "isOptional" : false
 628         },
 629         {
 630           "name" : "superclass",
 631           "type" : "Object",
 632           "desc" : "The class being extended",
 633           "isOptional" : false
 634         },
 635         {
 636           "name" : "overrides",
 637           "type" : "Object",
 638           "desc" : "(optional) A literal with members",
 639           "isOptional" : false
 640         }
 641       ],
 642       "returns" : []
 643     },
 644     {
 645       "name" : "override",
 646       "desc" : "Adds a list of functions to the prototype of an existing class, overwriting any existing methods with the same name.\nUsage:<pre><code>\nRoo.override(MyClass, {\n    newMethod1: function(){\n        // etc.\n    },\n    newMethod2: function(foo){\n        // etc.\n    }\n});\n </code></pre>",
 647       "isStatic" : true,
 648       "isConstructor" : false,
 649       "isPrivate" : false,
 650       "memberOf" : "Roo",
 651       "example" : "",
 652       "deprecated" : "",
 653       "since" : "",
 654       "see" : "",
 655       "params" : [
 656         {
 657           "name" : "origclass",
 658           "type" : "Object",
 659           "desc" : "The class to override",
 660           "isOptional" : false
 661         },
 662         {
 663           "name" : "overrides",
 664           "type" : "Object",
 665           "desc" : "The list of functions to add to origClass.  This should be specified as an object literal\ncontaining one or more methods.",
 666           "isOptional" : false
 667         }
 668       ],
 669       "returns" : []
 670     },
 671     {
 672       "name" : "selectNode",
 673       "desc" : "Selects a single element as a Roo Element\nThis is about as close as you can get to jQuery's $('do crazy stuff')",
 674       "isStatic" : true,
 675       "isConstructor" : false,
 676       "isPrivate" : false,
 677       "memberOf" : "Roo",
 678       "example" : "",
 679       "deprecated" : "",
 680       "since" : "",
 681       "see" : "",
 682       "params" : [
 683         {
 684           "name" : "selector",
 685           "type" : "String",
 686           "desc" : "The selector/xpath query",
 687           "isOptional" : false
 688         },
 689         {
 690           "name" : "root",
 691           "type" : "Node",
 692           "desc" : "(optional) The start of the query (defaults to document).",
 693           "isOptional" : false
 694         }
 695       ],
 696       "returns" : [
 697         {
 698           "name" : "",
 699           "type" : "Roo.Element",
 700           "desc" : ""
 701         }
 702       ]
 703     },
 704     {
 705       "name" : "type",
 706       "desc" : "Returns the type of object that is passed in. If the object passed in is null or undefined it\nreturn false otherwise it returns one of the following values:<ul>\n<li><b>string</b>: If the object passed is a string</li>\n<li><b>number</b>: If the object passed is a number</li>\n<li><b>boolean</b>: If the object passed is a boolean value</li>\n<li><b>function</b>: If the object passed is a function reference</li>\n<li><b>object</b>: If the object passed is an object</li>\n<li><b>array</b>: If the object passed is an array</li>\n<li><b>regexp</b>: If the object passed is a regular expression</li>\n<li><b>element</b>: If the object passed is a DOM Element</li>\n<li><b>nodelist</b>: If the object passed is a DOM NodeList</li>\n<li><b>textnode</b>: If the object passed is a DOM text node and contains something other than whitespace</li>\n<li><b>whitespace</b>: If the object passed is a DOM text node and contains only whitespace</li>",
 707       "isStatic" : true,
 708       "isConstructor" : false,
 709       "isPrivate" : false,
 710       "memberOf" : "Roo",
 711       "example" : "",
 712       "deprecated" : "",
 713       "since" : "",
 714       "see" : "",
 715       "params" : [
 716         {
 717           "name" : "object",
 718           "type" : "Mixed",
 719           "desc" : "",
 720           "isOptional" : false
 721         }
 722       ],
 723       "returns" : [
 724         {
 725           "name" : "",
 726           "type" : "String",
 727           "desc" : ""
 728         }
 729       ]
 730     }
 731   ],
 732   "events" : []
 733 }