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