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

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