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

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