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