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