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