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