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

   1 {
   2   "name" : "Roo.Toolbar",
   3   "augments" : [],
   4   "desc" : "Basic Toolbar class.",
   5   "isSingleton" : false,
   6   "isStatic" : false,
   7   "isBuiltin" : false,
   8   "memberOf" : "Toolbar",
   9   "example" : "",
  10   "deprecated" : "",
  11   "since" : "",
  12   "see" : "",
  13   "params" : [
  14     {
  15       "name" : "container",
  16       "type" : "Object",
  17       "desc" : "The config object",
  18       "isOptional" : false
  19     }
  20   ],
  21   "returns" : [],
  22   "throws" : "",
  23   "requires" : "",
  24   "config" : [
  25     {
  26       "name" : "text",
  27       "type" : "string",
  28       "desc" : "",
  29       "memberOf" : ""
  30     },
  31     {
  32       "name" : "container",
  33       "type" : "String/HTMLElement/Element",
  34       "desc" : "The id or element that will contain the toolbar",
  35       "memberOf" : ""
  36     },
  37     {
  38       "name" : "items",
  39       "type" : "Array",
  40       "desc" : "array of button configs or elements to add (will be converted to a MixedCollection)",
  41       "memberOf" : ""
  42     }
  43   ],
  44   "methods" : [
  45     {
  46       "name" : "addDom",
  47       "type" : "function",
  48       "desc" : "Adds a new element to the toolbar from the passed {@link Roo.DomHelper} config.",
  49       "sig" : "(config)",
  50       "static" : false,
  51       "memberOf" : "",
  52       "isStatic" : false,
  53       "isConstructor" : false,
  54       "isPrivate" : false,
  55       "example" : "",
  56       "deprecated" : "",
  57       "since" : "",
  58       "see" : "",
  59       "exceptions" : "",
  60       "requires" : "",
  61       "params" : [
  62         {
  63           "name" : "config",
  64           "type" : "Object",
  65           "desc" : "",
  66           "isOptional" : false
  67         }
  68       ],
  69       "returns" : [
  70         {
  71           "name" : "",
  72           "type" : "Roo.Toolbar.Item",
  73           "desc" : "The element's item"
  74         }
  75       ]
  76     },
  77     {
  78       "name" : "addElement",
  79       "type" : "function",
  80       "desc" : "Adds any standard HTML element to the toolbar",
  81       "sig" : "(el)",
  82       "static" : false,
  83       "memberOf" : "",
  84       "isStatic" : false,
  85       "isConstructor" : false,
  86       "isPrivate" : false,
  87       "example" : "",
  88       "deprecated" : "",
  89       "since" : "",
  90       "see" : "",
  91       "exceptions" : "",
  92       "requires" : "",
  93       "params" : [
  94         {
  95           "name" : "el",
  96           "type" : "String/HTMLElement/Element",
  97           "desc" : "The element or id of the element to add",
  98           "isOptional" : false
  99         }
 100       ],
 101       "returns" : [
 102         {
 103           "name" : "",
 104           "type" : "Roo.Toolbar.Item",
 105           "desc" : "The element's item"
 106         }
 107       ]
 108     },
 109     {
 110       "name" : "getEl",
 111       "type" : "function",
 112       "desc" : "Returns the Element for this toolbar.",
 113       "sig" : "()\n{\n\n}",
 114       "static" : false,
 115       "memberOf" : "",
 116       "isStatic" : false,
 117       "isConstructor" : false,
 118       "isPrivate" : false,
 119       "example" : "",
 120       "deprecated" : "",
 121       "since" : "",
 122       "see" : "",
 123       "exceptions" : "",
 124       "requires" : "",
 125       "params" : [],
 126       "returns" : [
 127         {
 128           "name" : "",
 129           "type" : "Roo.Element",
 130           "desc" : ""
 131         }
 132       ]
 133     },
 134     {
 135       "name" : "hide",
 136       "type" : "function",
 137       "desc" : "Hide the toolbar",
 138       "sig" : "()\n{\n\n}",
 139       "static" : false,
 140       "memberOf" : "",
 141       "isStatic" : false,
 142       "isConstructor" : false,
 143       "isPrivate" : false,
 144       "example" : "",
 145       "deprecated" : "",
 146       "since" : "",
 147       "see" : "",
 148       "exceptions" : "",
 149       "requires" : "",
 150       "params" : [],
 151       "returns" : []
 152     },
 153     {
 154       "name" : "addSeparator",
 155       "type" : "function",
 156       "desc" : "Adds a separator",
 157       "sig" : "()\n{\n\n}",
 158       "static" : false,
 159       "memberOf" : "",
 160       "isStatic" : false,
 161       "isConstructor" : false,
 162       "isPrivate" : false,
 163       "example" : "",
 164       "deprecated" : "",
 165       "since" : "",
 166       "see" : "",
 167       "exceptions" : "",
 168       "requires" : "",
 169       "params" : [],
 170       "returns" : [
 171         {
 172           "name" : "",
 173           "type" : "Roo.Toolbar.Item",
 174           "desc" : "The separator item"
 175         }
 176       ]
 177     },
 178     {
 179       "name" : "show",
 180       "type" : "function",
 181       "desc" : "Show the toolbar",
 182       "sig" : "()\n{\n\n}",
 183       "static" : false,
 184       "memberOf" : "",
 185       "isStatic" : false,
 186       "isConstructor" : false,
 187       "isPrivate" : false,
 188       "example" : "",
 189       "deprecated" : "",
 190       "since" : "",
 191       "see" : "",
 192       "exceptions" : "",
 193       "requires" : "",
 194       "params" : [],
 195       "returns" : []
 196     },
 197     {
 198       "name" : "addFill",
 199       "type" : "function",
 200       "desc" : "Adds a fill element that forces subsequent additions to the right side of the toolbar",
 201       "sig" : "()\n{\n\n}",
 202       "static" : false,
 203       "memberOf" : "",
 204       "isStatic" : false,
 205       "isConstructor" : false,
 206       "isPrivate" : false,
 207       "example" : "",
 208       "deprecated" : "",
 209       "since" : "",
 210       "see" : "",
 211       "exceptions" : "",
 212       "requires" : "",
 213       "params" : [],
 214       "returns" : [
 215         {
 216           "name" : "",
 217           "type" : "Roo.Toolbar.Fill",
 218           "desc" : "The fill item"
 219         }
 220       ]
 221     },
 222     {
 223       "name" : "addSpacer",
 224       "type" : "function",
 225       "desc" : "Adds a spacer element",
 226       "sig" : "()\n{\n\n}",
 227       "static" : false,
 228       "memberOf" : "",
 229       "isStatic" : false,
 230       "isConstructor" : false,
 231       "isPrivate" : false,
 232       "example" : "",
 233       "deprecated" : "",
 234       "since" : "",
 235       "see" : "",
 236       "exceptions" : "",
 237       "requires" : "",
 238       "params" : [],
 239       "returns" : [
 240         {
 241           "name" : "",
 242           "type" : "Roo.Toolbar.Spacer",
 243           "desc" : "The spacer item"
 244         }
 245       ]
 246     },
 247     {
 248       "name" : "add",
 249       "type" : "function",
 250       "desc" : "Adds element(s) to the toolbar -- this function takes a variable number of \narguments of mixed type and adds them to the toolbar.",
 251       "sig" : "(arg1, arg2)",
 252       "static" : false,
 253       "memberOf" : "",
 254       "isStatic" : false,
 255       "isConstructor" : false,
 256       "isPrivate" : false,
 257       "example" : "",
 258       "deprecated" : "",
 259       "since" : "",
 260       "see" : "",
 261       "exceptions" : "",
 262       "requires" : "",
 263       "params" : [
 264         {
 265           "name" : "arg1",
 266           "type" : "Mixed",
 267           "desc" : "The following types of arguments are all valid:<br />\n<ul>\n<li>{@link Roo.Toolbar.Button} config: A valid button config object (equivalent to {@link #addButton})</li>\n<li>HtmlElement: Any standard HTML element (equivalent to {@link #addElement})</li>\n<li>Field: Any form field (equivalent to {@link #addField})</li>\n<li>Item: Any subclass of {@link Roo.Toolbar.Item} (equivalent to {@link #addItem})</li>\n<li>String: Any generic string (gets wrapped in a {@link Roo.Toolbar.TextItem}, equivalent to {@link #addText}).\nNote that there are a few special strings that are treated differently as explained nRoo.</li>\n<li>'separator' or '-': Creates a separator element (equivalent to {@link #addSeparator})</li>\n<li>' ': Creates a spacer element (equivalent to {@link #addSpacer})</li>\n<li>'->': Creates a fill element (equivalent to {@link #addFill})</li>\n</ul>",
 268           "isOptional" : false
 269         },
 270         {
 271           "name" : "arg2",
 272           "type" : "Mixed",
 273           "desc" : "",
 274           "isOptional" : false
 275         }
 276       ],
 277       "returns" : []
 278     },
 279     {
 280       "name" : "addField",
 281       "type" : "function",
 282       "desc" : "Adds a dynamically rendered Roo.form field (TextField, ComboBox, etc).\nNote: the field should not have been rendered yet. For a field that has already been\nrendered, use {@link #addElement}.",
 283       "sig" : "(field)",
 284       "static" : false,
 285       "memberOf" : "",
 286       "isStatic" : false,
 287       "isConstructor" : false,
 288       "isPrivate" : false,
 289       "example" : "",
 290       "deprecated" : "",
 291       "since" : "",
 292       "see" : "",
 293       "exceptions" : "",
 294       "requires" : "",
 295       "params" : [
 296         {
 297           "name" : "field",
 298           "type" : "Roo.form.Field",
 299           "desc" : "",
 300           "isOptional" : false
 301         }
 302       ],
 303       "returns" : [
 304         {
 305           "name" : "",
 306           "type" : "Roo.ToolbarItem",
 307           "desc" : ""
 308         }
 309       ]
 310     },
 311     {
 312       "name" : "addText",
 313       "type" : "function",
 314       "desc" : "Adds text to the toolbar",
 315       "sig" : "(text)",
 316       "static" : false,
 317       "memberOf" : "",
 318       "isStatic" : false,
 319       "isConstructor" : false,
 320       "isPrivate" : false,
 321       "example" : "",
 322       "deprecated" : "",
 323       "since" : "",
 324       "see" : "",
 325       "exceptions" : "",
 326       "requires" : "",
 327       "params" : [
 328         {
 329           "name" : "text",
 330           "type" : "String",
 331           "desc" : "The text to add",
 332           "isOptional" : false
 333         }
 334       ],
 335       "returns" : [
 336         {
 337           "name" : "",
 338           "type" : "Roo.Toolbar.Item",
 339           "desc" : "The element's item"
 340         }
 341       ]
 342     },
 343     {
 344       "name" : "addItem",
 345       "type" : "function",
 346       "desc" : "Adds any Toolbar.Item or subclass",
 347       "sig" : "(item)",
 348       "static" : false,
 349       "memberOf" : "",
 350       "isStatic" : false,
 351       "isConstructor" : false,
 352       "isPrivate" : false,
 353       "example" : "",
 354       "deprecated" : "",
 355       "since" : "",
 356       "see" : "",
 357       "exceptions" : "",
 358       "requires" : "",
 359       "params" : [
 360         {
 361           "name" : "item",
 362           "type" : "Roo.Toolbar.Item",
 363           "desc" : "",
 364           "isOptional" : false
 365         }
 366       ],
 367       "returns" : [
 368         {
 369           "name" : "",
 370           "type" : "Roo.Toolbar.Item",
 371           "desc" : "The item"
 372         }
 373       ]
 374     },
 375     {
 376       "name" : "addButton",
 377       "type" : "function",
 378       "desc" : "Adds a button (or buttons). See {@link Roo.Toolbar.Button} for more info on the config.",
 379       "sig" : "(config)",
 380       "static" : false,
 381       "memberOf" : "",
 382       "isStatic" : false,
 383       "isConstructor" : false,
 384       "isPrivate" : false,
 385       "example" : "",
 386       "deprecated" : "",
 387       "since" : "",
 388       "see" : "",
 389       "exceptions" : "",
 390       "requires" : "",
 391       "params" : [
 392         {
 393           "name" : "config",
 394           "type" : "Object/Array",
 395           "desc" : "A button config or array of configs",
 396           "isOptional" : false
 397         }
 398       ],
 399       "returns" : [
 400         {
 401           "name" : "",
 402           "type" : "Roo.Toolbar.Button/Array",
 403           "desc" : ""
 404         }
 405       ]
 406     },
 407     {
 408       "name" : "insertButton",
 409       "type" : "function",
 410       "desc" : "Inserts any {@link Roo.Toolbar.Item}/{@link Roo.Toolbar.Button} at the specified index.",
 411       "sig" : "(index, item)",
 412       "static" : false,
 413       "memberOf" : "",
 414       "isStatic" : false,
 415       "isConstructor" : false,
 416       "isPrivate" : false,
 417       "example" : "",
 418       "deprecated" : "",
 419       "since" : "",
 420       "see" : "",
 421       "exceptions" : "",
 422       "requires" : "",
 423       "params" : [
 424         {
 425           "name" : "index",
 426           "type" : "Number",
 427           "desc" : "The index where the item is to be inserted",
 428           "isOptional" : false
 429         },
 430         {
 431           "name" : "item",
 432           "type" : "Object/Roo.Toolbar.Item/Roo.Toolbar.Button (may be Array)",
 433           "desc" : "The button, or button config object to be inserted.",
 434           "isOptional" : false
 435         }
 436       ],
 437       "returns" : [
 438         {
 439           "name" : "",
 440           "type" : "Roo.Toolbar.Button/Item",
 441           "desc" : ""
 442         }
 443       ]
 444     },
 445     {
 446       "name" : "addxtype",
 447       "type" : "function",
 448       "desc" : "Add an Xtype element",
 449       "sig" : "(xtype)",
 450       "static" : false,
 451       "memberOf" : "",
 452       "isStatic" : false,
 453       "isConstructor" : false,
 454       "isPrivate" : false,
 455       "example" : "",
 456       "deprecated" : "",
 457       "since" : "",
 458       "see" : "",
 459       "exceptions" : "",
 460       "requires" : "",
 461       "params" : [
 462         {
 463           "name" : "xtype",
 464           "type" : "Object",
 465           "desc" : "Xtype Object",
 466           "isOptional" : false
 467         }
 468       ],
 469       "returns" : [
 470         {
 471           "name" : "",
 472           "type" : "Object",
 473           "desc" : "created Object"
 474         }
 475       ]
 476     }
 477   ],
 478   "events" : []
 479 }