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" : "container",
  41       "type" : "String/HTMLElement/Element",
  42       "desc" : "container The id or element that will contain the toolbar",
  43       "memberOf" : ""
  44     },
  45     {
  46       "name" : "emptyMsg",
  47       "type" : "String",
  48       "desc" : "The message to display when no records are found (defaults to \"No data to display\")",
  49       "memberOf" : ""
  50     },
  51     {
  52       "name" : "items",
  53       "type" : "Array",
  54       "desc" : "array of button configs or elements to add (will be converted to a MixedCollection)",
  55       "memberOf" : "Roo.Toolbar"
  56     },
  57     {
  58       "name" : "displayMsg",
  59       "type" : "String",
  60       "desc" : "The paging status message to display (defaults to \"Displaying {start} - {end} of {total}\")",
  61       "memberOf" : ""
  62     },
  63     {
  64       "name" : "displayInfo",
  65       "type" : "Boolean",
  66       "desc" : "True to display the displayMsg (defaults to false)",
  67       "memberOf" : ""
  68     }
  69   ],
  70   "methods" : [
  71     {
  72       "name" : "bind",
  73       "type" : "function",
  74       "desc" : "Binds the paging toolbar to the specified {@link Roo.data.Store}",
  75       "sig" : "(store)",
  76       "static" : false,
  77       "memberOf" : "",
  78       "isStatic" : false,
  79       "isConstructor" : false,
  80       "isPrivate" : false,
  81       "example" : "",
  82       "deprecated" : "",
  83       "since" : "",
  84       "see" : "",
  85       "exceptions" : "",
  86       "requires" : "",
  87       "params" : [
  88         {
  89           "name" : "store",
  90           "type" : "Roo.data.Store",
  91           "desc" : "The data store to bind",
  92           "isOptional" : false
  93         }
  94       ],
  95       "returns" : []
  96     },
  97     {
  98       "name" : "unbind",
  99       "type" : "function",
 100       "desc" : "Unbinds the paging toolbar from the specified {@link Roo.data.Store}",
 101       "sig" : "(store)",
 102       "static" : false,
 103       "memberOf" : "",
 104       "isStatic" : false,
 105       "isConstructor" : false,
 106       "isPrivate" : false,
 107       "example" : "",
 108       "deprecated" : "",
 109       "since" : "",
 110       "see" : "",
 111       "exceptions" : "",
 112       "requires" : "",
 113       "params" : [
 114         {
 115           "name" : "store",
 116           "type" : "Roo.data.Store",
 117           "desc" : "The data store to unbind",
 118           "isOptional" : false
 119         }
 120       ],
 121       "returns" : []
 122     },
 123     {
 124       "name" : "addDom",
 125       "type" : "function",
 126       "desc" : "Adds a new element to the toolbar from the passed {@link Roo.DomHelper} config.",
 127       "sig" : "(config)",
 128       "static" : false,
 129       "memberOf" : "Roo.Toolbar",
 130       "isStatic" : false,
 131       "isConstructor" : false,
 132       "isPrivate" : false,
 133       "example" : "",
 134       "deprecated" : "",
 135       "since" : "",
 136       "see" : "",
 137       "exceptions" : "",
 138       "requires" : "",
 139       "params" : [
 140         {
 141           "name" : "config",
 142           "type" : "Object",
 143           "desc" : "",
 144           "isOptional" : false
 145         }
 146       ],
 147       "returns" : [
 148         {
 149           "name" : "",
 150           "type" : "Roo.Toolbar.Item",
 151           "desc" : "The element's item"
 152         }
 153       ]
 154     },
 155     {
 156       "name" : "addElement",
 157       "type" : "function",
 158       "desc" : "Adds any standard HTML element to the toolbar",
 159       "sig" : "(el)",
 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" : "el",
 174           "type" : "String/HTMLElement/Element",
 175           "desc" : "The element or id of the element to add",
 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" : "getEl",
 189       "type" : "function",
 190       "desc" : "Returns the Element for this toolbar.",
 191       "sig" : "()\n{\n\n}",
 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       "returns" : [
 205         {
 206           "name" : "",
 207           "type" : "Roo.Element",
 208           "desc" : ""
 209         }
 210       ]
 211     },
 212     {
 213       "name" : "hide",
 214       "type" : "function",
 215       "desc" : "Hide the toolbar",
 216       "sig" : "()\n{\n\n}",
 217       "static" : false,
 218       "memberOf" : "Roo.Toolbar",
 219       "isStatic" : false,
 220       "isConstructor" : false,
 221       "isPrivate" : false,
 222       "example" : "",
 223       "deprecated" : "",
 224       "since" : "",
 225       "see" : "",
 226       "exceptions" : "",
 227       "requires" : "",
 228       "params" : [],
 229       "returns" : []
 230     },
 231     {
 232       "name" : "addSeparator",
 233       "type" : "function",
 234       "desc" : "Adds a separator",
 235       "sig" : "()\n{\n\n}",
 236       "static" : false,
 237       "memberOf" : "Roo.Toolbar",
 238       "isStatic" : false,
 239       "isConstructor" : false,
 240       "isPrivate" : false,
 241       "example" : "",
 242       "deprecated" : "",
 243       "since" : "",
 244       "see" : "",
 245       "exceptions" : "",
 246       "requires" : "",
 247       "params" : [],
 248       "returns" : [
 249         {
 250           "name" : "",
 251           "type" : "Roo.Toolbar.Item",
 252           "desc" : "The separator item"
 253         }
 254       ]
 255     },
 256     {
 257       "name" : "show",
 258       "type" : "function",
 259       "desc" : "Show the toolbar",
 260       "sig" : "()\n{\n\n}",
 261       "static" : false,
 262       "memberOf" : "Roo.Toolbar",
 263       "isStatic" : false,
 264       "isConstructor" : false,
 265       "isPrivate" : false,
 266       "example" : "",
 267       "deprecated" : "",
 268       "since" : "",
 269       "see" : "",
 270       "exceptions" : "",
 271       "requires" : "",
 272       "params" : [],
 273       "returns" : []
 274     },
 275     {
 276       "name" : "addFill",
 277       "type" : "function",
 278       "desc" : "Adds a fill element that forces subsequent additions to the right side of the toolbar",
 279       "sig" : "()\n{\n\n}",
 280       "static" : false,
 281       "memberOf" : "Roo.Toolbar",
 282       "isStatic" : false,
 283       "isConstructor" : false,
 284       "isPrivate" : false,
 285       "example" : "",
 286       "deprecated" : "",
 287       "since" : "",
 288       "see" : "",
 289       "exceptions" : "",
 290       "requires" : "",
 291       "params" : [],
 292       "returns" : [
 293         {
 294           "name" : "",
 295           "type" : "Roo.Toolbar.Fill",
 296           "desc" : "The fill item"
 297         }
 298       ]
 299     },
 300     {
 301       "name" : "addSpacer",
 302       "type" : "function",
 303       "desc" : "Adds a spacer element",
 304       "sig" : "()\n{\n\n}",
 305       "static" : false,
 306       "memberOf" : "Roo.Toolbar",
 307       "isStatic" : false,
 308       "isConstructor" : false,
 309       "isPrivate" : false,
 310       "example" : "",
 311       "deprecated" : "",
 312       "since" : "",
 313       "see" : "",
 314       "exceptions" : "",
 315       "requires" : "",
 316       "params" : [],
 317       "returns" : [
 318         {
 319           "name" : "",
 320           "type" : "Roo.Toolbar.Spacer",
 321           "desc" : "The spacer item"
 322         }
 323       ]
 324     },
 325     {
 326       "name" : "add",
 327       "type" : "function",
 328       "desc" : "Adds element(s) to the toolbar -- this function takes a variable number of \narguments of mixed type and adds them to the toolbar.",
 329       "sig" : "(arg1, arg2)",
 330       "static" : false,
 331       "memberOf" : "Roo.Toolbar",
 332       "isStatic" : false,
 333       "isConstructor" : false,
 334       "isPrivate" : false,
 335       "example" : "",
 336       "deprecated" : "",
 337       "since" : "",
 338       "see" : "",
 339       "exceptions" : "",
 340       "requires" : "",
 341       "params" : [
 342         {
 343           "name" : "arg1",
 344           "type" : "Mixed",
 345           "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>",
 346           "isOptional" : false
 347         },
 348         {
 349           "name" : "arg2",
 350           "type" : "Mixed",
 351           "desc" : "",
 352           "isOptional" : false
 353         }
 354       ],
 355       "returns" : []
 356     },
 357     {
 358       "name" : "addField",
 359       "type" : "function",
 360       "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}.",
 361       "sig" : "(field)",
 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" : "field",
 376           "type" : "Roo.form.Field",
 377           "desc" : "",
 378           "isOptional" : false
 379         }
 380       ],
 381       "returns" : [
 382         {
 383           "name" : "",
 384           "type" : "Roo.ToolbarItem",
 385           "desc" : ""
 386         }
 387       ]
 388     },
 389     {
 390       "name" : "addText",
 391       "type" : "function",
 392       "desc" : "Adds text to the toolbar",
 393       "sig" : "(text)",
 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" : "text",
 408           "type" : "String",
 409           "desc" : "The text to add",
 410           "isOptional" : false
 411         }
 412       ],
 413       "returns" : [
 414         {
 415           "name" : "",
 416           "type" : "Roo.Toolbar.Item",
 417           "desc" : "The element's item"
 418         }
 419       ]
 420     },
 421     {
 422       "name" : "addItem",
 423       "type" : "function",
 424       "desc" : "Adds any Toolbar.Item or subclass",
 425       "sig" : "(item)",
 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" : "item",
 440           "type" : "Roo.Toolbar.Item",
 441           "desc" : "",
 442           "isOptional" : false
 443         }
 444       ],
 445       "returns" : [
 446         {
 447           "name" : "",
 448           "type" : "Roo.Toolbar.Item",
 449           "desc" : "The item"
 450         }
 451       ]
 452     },
 453     {
 454       "name" : "addButton",
 455       "type" : "function",
 456       "desc" : "Adds a button (or buttons). See {@link Roo.Toolbar.Button} for more info on the config.",
 457       "sig" : "(config)",
 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" : "config",
 472           "type" : "Object/Array",
 473           "desc" : "A button config or array of configs",
 474           "isOptional" : false
 475         }
 476       ],
 477       "returns" : [
 478         {
 479           "name" : "",
 480           "type" : "Roo.Toolbar.Button/Array",
 481           "desc" : ""
 482         }
 483       ]
 484     },
 485     {
 486       "name" : "insertButton",
 487       "type" : "function",
 488       "desc" : "Inserts any {@link Roo.Toolbar.Item}/{@link Roo.Toolbar.Button} at the specified index.",
 489       "sig" : "(index, item)",
 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" : "index",
 504           "type" : "Number",
 505           "desc" : "The index where the item is to be inserted",
 506           "isOptional" : false
 507         },
 508         {
 509           "name" : "item",
 510           "type" : "Object/Roo.Toolbar.Item/Roo.Toolbar.Button (may be Array)",
 511           "desc" : "The button, or button config object to be inserted.",
 512           "isOptional" : false
 513         }
 514       ],
 515       "returns" : [
 516         {
 517           "name" : "",
 518           "type" : "Roo.Toolbar.Button/Item",
 519           "desc" : ""
 520         }
 521       ]
 522     },
 523     {
 524       "name" : "addxtype",
 525       "type" : "function",
 526       "desc" : "Add an Xtype element",
 527       "sig" : "(xtype)",
 528       "static" : false,
 529       "memberOf" : "Roo.Toolbar",
 530       "isStatic" : false,
 531       "isConstructor" : false,
 532       "isPrivate" : false,
 533       "example" : "",
 534       "deprecated" : "",
 535       "since" : "",
 536       "see" : "",
 537       "exceptions" : "",
 538       "requires" : "",
 539       "params" : [
 540         {
 541           "name" : "xtype",
 542           "type" : "Object",
 543           "desc" : "Xtype Object",
 544           "isOptional" : false
 545         }
 546       ],
 547       "returns" : [
 548         {
 549           "name" : "",
 550           "type" : "Object",
 551           "desc" : "created Object"
 552         }
 553       ]
 554     }
 555   ],
 556   "events" : []
 557 }