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

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