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

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