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