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