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