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

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