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