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

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