git.roojs.org Git - roojs1/blob - docs/symbols/Roo.PagingToolbar.json

   1 {
   2   "name" : "Roo.PagingToolbar",
   3   "augments" : [
   4     "Roo.Toolbar"
   5   ],
   6   "childClasses" : {  },
   7   "tree_children" : [
   8     "Roo.Toolbar.Item",
   9     "Roo.Toolbar.Fill",
  10     "Roo.Toolbar.Separator",
  11     "Roo.Toolbar.Spacer",
  12     "Roo.Toolbar.TextItem",
  13     "Roo.Toolbar.Button",
  14     "Roo.Toolbar.SplitButton",
  15     "Roo.form.Field",
  16     "Roo.form.Checkbox",
  17     "Roo.form.ComboBox",
  18     "Roo.form.ComboBoxArray",
  19     "Roo.form.ComboCheck",
  20     "Roo.form.ComboNested",
  21     "Roo.form.DateField",
  22     "Roo.form.DayPicker",
  23     "Roo.form.DisplayField",
  24     "Roo.form.FCKeditor",
  25     "Roo.form.GridField",
  26     "Roo.form.Hidden",
  27     "Roo.form.HtmlEditor",
  28     "Roo.form.MonthField",
  29     "Roo.form.NumberField",
  30     "Roo.form.Radio",
  31     "Roo.form.Select",
  32     "Roo.form.Signature",
  33     "Roo.form.TextArea",
  34     "Roo.form.TextField",
  35     "Roo.form.TriggerField"
  36   ],
  37   "tree_parent" : [],
  38   "desc" : "A specialized toolbar that is bound to a {@link Roo.data.Store} and provides automatic paging controls.",
  39   "isSingleton" : false,
  40   "isStatic" : false,
  41   "isBuiltin" : false,
  42   "isAbstract" : false,
  43   "isBuilderTop" : false,
  44   "memberOf" : "PagingToolbar",
  45   "example" : "",
  46   "deprecated" : "",
  47   "since" : "",
  48   "see" : "",
  49   "params" : [
  50     {
  51       "name" : "config",
  52       "type" : "Object",
  53       "desc" : "The config object",
  54       "isOptional" : false
  55     }
  56   ],
  57   "returns" : [],
  58   "throws" : "",
  59   "requires" : "",
  60   "config" : [
  61     {
  62       "name" : "text",
  63       "type" : "string",
  64       "desc" : "",
  65       "memberOf" : "Roo.Toolbar"
  66     },
  67     {
  68       "name" : "pageSize",
  69       "type" : "Number",
  70       "desc" : "The number of records to display per page (defaults to 20)",
  71       "memberOf" : ""
  72     },
  73     {
  74       "name" : "container",
  75       "type" : "String/HTMLElement/Element",
  76       "desc" : "container The id or element that will contain the toolbar",
  77       "memberOf" : ""
  78     },
  79     {
  80       "name" : "emptyMsg",
  81       "type" : "String",
  82       "desc" : "The message to display when no records are found (defaults to \"No data to display\")",
  83       "memberOf" : ""
  84     },
  85     {
  86       "name" : "items",
  87       "type" : "Array",
  88       "desc" : "array of button configs or elements to add (will be converted to a MixedCollection)",
  89       "memberOf" : "Roo.Toolbar"
  90     },
  91     {
  92       "name" : "displayMsg",
  93       "type" : "String",
  94       "desc" : "The paging status message to display (defaults to \"Displaying {start} - {end} of {total}\")",
  95       "memberOf" : ""
  96     },
  97     {
  98       "name" : "displayInfo",
  99       "type" : "Boolean",
 100       "desc" : "True to display the displayMsg (defaults to false)",
 101       "memberOf" : ""
 102     }
 103   ],
 104   "methods" : [
 105     {
 106       "name" : "bind",
 107       "type" : "function",
 108       "desc" : "Binds the paging toolbar to the specified {@link Roo.data.Store}",
 109       "sig" : "(store)",
 110       "static" : false,
 111       "memberOf" : "",
 112       "isStatic" : false,
 113       "isConstructor" : false,
 114       "isPrivate" : false,
 115       "example" : "",
 116       "deprecated" : "",
 117       "since" : "",
 118       "see" : "",
 119       "exceptions" : "",
 120       "requires" : "",
 121       "params" : [
 122         {
 123           "name" : "store",
 124           "type" : "Roo.data.Store",
 125           "desc" : "The data store to bind",
 126           "isOptional" : false
 127         }
 128       ],
 129       "returns" : []
 130     },
 131     {
 132       "name" : "onClick",
 133       "type" : "function",
 134       "desc" : "event that occurs when you click on the navigation buttons - can be used to trigger load of a grid.",
 135       "sig" : "(which)",
 136       "static" : false,
 137       "memberOf" : "",
 138       "isStatic" : false,
 139       "isConstructor" : false,
 140       "isPrivate" : false,
 141       "example" : "",
 142       "deprecated" : "",
 143       "since" : "",
 144       "see" : "",
 145       "exceptions" : "",
 146       "requires" : "",
 147       "params" : [
 148         {
 149           "name" : "which",
 150           "type" : "String",
 151           "desc" : "(first|prev|next|last|refresh)  which button to press.",
 152           "isOptional" : false
 153         }
 154       ],
 155       "returns" : []
 156     },
 157     {
 158       "name" : "unbind",
 159       "type" : "function",
 160       "desc" : "Unbinds the paging toolbar from the specified {@link Roo.data.Store}",
 161       "sig" : "(store)",
 162       "static" : false,
 163       "memberOf" : "",
 164       "isStatic" : false,
 165       "isConstructor" : false,
 166       "isPrivate" : false,
 167       "example" : "",
 168       "deprecated" : "",
 169       "since" : "",
 170       "see" : "",
 171       "exceptions" : "",
 172       "requires" : "",
 173       "params" : [
 174         {
 175           "name" : "store",
 176           "type" : "Roo.data.Store",
 177           "desc" : "The data store to unbind",
 178           "isOptional" : false
 179         }
 180       ],
 181       "returns" : []
 182     },
 183     {
 184       "name" : "addDom",
 185       "type" : "function",
 186       "desc" : "Adds a new element to the toolbar from the passed {@link Roo.DomHelper} config.",
 187       "sig" : "(config)",
 188       "static" : false,
 189       "memberOf" : "Roo.Toolbar",
 190       "isStatic" : false,
 191       "isConstructor" : false,
 192       "isPrivate" : false,
 193       "example" : "",
 194       "deprecated" : "",
 195       "since" : "",
 196       "see" : "",
 197       "exceptions" : "",
 198       "requires" : "",
 199       "params" : [
 200         {
 201           "name" : "config",
 202           "type" : "Object",
 203           "desc" : "",
 204           "isOptional" : false
 205         }
 206       ],
 207       "returns" : [
 208         {
 209           "name" : "",
 210           "type" : "Roo.Toolbar.Item",
 211           "desc" : "The element's item"
 212         }
 213       ]
 214     },
 215     {
 216       "name" : "addElement",
 217       "type" : "function",
 218       "desc" : "Adds any standard HTML element to the toolbar",
 219       "sig" : "(el)",
 220       "static" : false,
 221       "memberOf" : "Roo.Toolbar",
 222       "isStatic" : false,
 223       "isConstructor" : false,
 224       "isPrivate" : false,
 225       "example" : "",
 226       "deprecated" : "",
 227       "since" : "",
 228       "see" : "",
 229       "exceptions" : "",
 230       "requires" : "",
 231       "params" : [
 232         {
 233           "name" : "el",
 234           "type" : "String/HTMLElement/Element",
 235           "desc" : "The element or id of the element to add",
 236           "isOptional" : false
 237         }
 238       ],
 239       "returns" : [
 240         {
 241           "name" : "",
 242           "type" : "Roo.Toolbar.Item",
 243           "desc" : "The element's item"
 244         }
 245       ]
 246     },
 247     {
 248       "name" : "getEl",
 249       "type" : "function",
 250       "desc" : "Returns the Element for this toolbar.",
 251       "sig" : "()\n{\n\n}",
 252       "static" : false,
 253       "memberOf" : "Roo.Toolbar",
 254       "isStatic" : false,
 255       "isConstructor" : false,
 256       "isPrivate" : false,
 257       "example" : "",
 258       "deprecated" : "",
 259       "since" : "",
 260       "see" : "",
 261       "exceptions" : "",
 262       "requires" : "",
 263       "params" : [],
 264       "returns" : [
 265         {
 266           "name" : "",
 267           "type" : "Roo.Element",
 268           "desc" : ""
 269         }
 270       ]
 271     },
 272     {
 273       "name" : "hide",
 274       "type" : "function",
 275       "desc" : "Hide the toolbar",
 276       "sig" : "()\n{\n\n}",
 277       "static" : false,
 278       "memberOf" : "Roo.Toolbar",
 279       "isStatic" : false,
 280       "isConstructor" : false,
 281       "isPrivate" : false,
 282       "example" : "",
 283       "deprecated" : "",
 284       "since" : "",
 285       "see" : "",
 286       "exceptions" : "",
 287       "requires" : "",
 288       "params" : [],
 289       "returns" : []
 290     },
 291     {
 292       "name" : "addSeparator",
 293       "type" : "function",
 294       "desc" : "Adds a separator",
 295       "sig" : "()\n{\n\n}",
 296       "static" : false,
 297       "memberOf" : "Roo.Toolbar",
 298       "isStatic" : false,
 299       "isConstructor" : false,
 300       "isPrivate" : false,
 301       "example" : "",
 302       "deprecated" : "",
 303       "since" : "",
 304       "see" : "",
 305       "exceptions" : "",
 306       "requires" : "",
 307       "params" : [],
 308       "returns" : [
 309         {
 310           "name" : "",
 311           "type" : "Roo.Toolbar.Item",
 312           "desc" : "The separator item"
 313         }
 314       ]
 315     },
 316     {
 317       "name" : "show",
 318       "type" : "function",
 319       "desc" : "Show the toolbar",
 320       "sig" : "()\n{\n\n}",
 321       "static" : false,
 322       "memberOf" : "Roo.Toolbar",
 323       "isStatic" : false,
 324       "isConstructor" : false,
 325       "isPrivate" : false,
 326       "example" : "",
 327       "deprecated" : "",
 328       "since" : "",
 329       "see" : "",
 330       "exceptions" : "",
 331       "requires" : "",
 332       "params" : [],
 333       "returns" : []
 334     },
 335     {
 336       "name" : "addFill",
 337       "type" : "function",
 338       "desc" : "Adds a fill element that forces subsequent additions to the right side of the toolbar",
 339       "sig" : "()\n{\n\n}",
 340       "static" : false,
 341       "memberOf" : "Roo.Toolbar",
 342       "isStatic" : false,
 343       "isConstructor" : false,
 344       "isPrivate" : false,
 345       "example" : "",
 346       "deprecated" : "",
 347       "since" : "",
 348       "see" : "",
 349       "exceptions" : "",
 350       "requires" : "",
 351       "params" : [],
 352       "returns" : [
 353         {
 354           "name" : "",
 355           "type" : "Roo.Toolbar.Fill",
 356           "desc" : "The fill item"
 357         }
 358       ]
 359     },
 360     {
 361       "name" : "addSpacer",
 362       "type" : "function",
 363       "desc" : "Adds a spacer element",
 364       "sig" : "()\n{\n\n}",
 365       "static" : false,
 366       "memberOf" : "Roo.Toolbar",
 367       "isStatic" : false,
 368       "isConstructor" : false,
 369       "isPrivate" : false,
 370       "example" : "",
 371       "deprecated" : "",
 372       "since" : "",
 373       "see" : "",
 374       "exceptions" : "",
 375       "requires" : "",
 376       "params" : [],
 377       "returns" : [
 378         {
 379           "name" : "",
 380           "type" : "Roo.Toolbar.Spacer",
 381           "desc" : "The spacer item"
 382         }
 383       ]
 384     },
 385     {
 386       "name" : "add",
 387       "type" : "function",
 388       "desc" : "Adds element(s) to the toolbar -- this function takes a variable number of \narguments of mixed type and adds them to the toolbar.",
 389       "sig" : "(arg1, arg2)",
 390       "static" : false,
 391       "memberOf" : "Roo.Toolbar",
 392       "isStatic" : false,
 393       "isConstructor" : false,
 394       "isPrivate" : false,
 395       "example" : "",
 396       "deprecated" : "",
 397       "since" : "",
 398       "see" : "",
 399       "exceptions" : "",
 400       "requires" : "",
 401       "params" : [
 402         {
 403           "name" : "arg1",
 404           "type" : "Mixed",
 405           "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>",
 406           "isOptional" : false
 407         },
 408         {
 409           "name" : "arg2",
 410           "type" : "Mixed",
 411           "desc" : "",
 412           "isOptional" : false
 413         }
 414       ],
 415       "returns" : []
 416     },
 417     {
 418       "name" : "addField",
 419       "type" : "function",
 420       "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}.",
 421       "sig" : "(field)",
 422       "static" : false,
 423       "memberOf" : "Roo.Toolbar",
 424       "isStatic" : false,
 425       "isConstructor" : false,
 426       "isPrivate" : false,
 427       "example" : "",
 428       "deprecated" : "",
 429       "since" : "",
 430       "see" : "",
 431       "exceptions" : "",
 432       "requires" : "",
 433       "params" : [
 434         {
 435           "name" : "field",
 436           "type" : "Roo.form.Field",
 437           "desc" : "",
 438           "isOptional" : false
 439         }
 440       ],
 441       "returns" : [
 442         {
 443           "name" : "",
 444           "type" : "Roo.ToolbarItem",
 445           "desc" : ""
 446         }
 447       ]
 448     },
 449     {
 450       "name" : "addText",
 451       "type" : "function",
 452       "desc" : "Adds text to the toolbar",
 453       "sig" : "(text)",
 454       "static" : false,
 455       "memberOf" : "Roo.Toolbar",
 456       "isStatic" : false,
 457       "isConstructor" : false,
 458       "isPrivate" : false,
 459       "example" : "",
 460       "deprecated" : "",
 461       "since" : "",
 462       "see" : "",
 463       "exceptions" : "",
 464       "requires" : "",
 465       "params" : [
 466         {
 467           "name" : "text",
 468           "type" : "String",
 469           "desc" : "The text to add",
 470           "isOptional" : false
 471         }
 472       ],
 473       "returns" : [
 474         {
 475           "name" : "",
 476           "type" : "Roo.Toolbar.Item",
 477           "desc" : "The element's item"
 478         }
 479       ]
 480     },
 481     {
 482       "name" : "addItem",
 483       "type" : "function",
 484       "desc" : "Adds any Toolbar.Item or subclass",
 485       "sig" : "(item)",
 486       "static" : false,
 487       "memberOf" : "Roo.Toolbar",
 488       "isStatic" : false,
 489       "isConstructor" : false,
 490       "isPrivate" : false,
 491       "example" : "",
 492       "deprecated" : "",
 493       "since" : "",
 494       "see" : "",
 495       "exceptions" : "",
 496       "requires" : "",
 497       "params" : [
 498         {
 499           "name" : "item",
 500           "type" : "Roo.Toolbar.Item",
 501           "desc" : "",
 502           "isOptional" : false
 503         }
 504       ],
 505       "returns" : [
 506         {
 507           "name" : "",
 508           "type" : "Roo.Toolbar.Item",
 509           "desc" : "The item"
 510         }
 511       ]
 512     },
 513     {
 514       "name" : "addButton",
 515       "type" : "function",
 516       "desc" : "Adds a button (or buttons). See {@link Roo.Toolbar.Button} for more info on the config.",
 517       "sig" : "(config)",
 518       "static" : false,
 519       "memberOf" : "Roo.Toolbar",
 520       "isStatic" : false,
 521       "isConstructor" : false,
 522       "isPrivate" : false,
 523       "example" : "",
 524       "deprecated" : "",
 525       "since" : "",
 526       "see" : "",
 527       "exceptions" : "",
 528       "requires" : "",
 529       "params" : [
 530         {
 531           "name" : "config",
 532           "type" : "Object/Array",
 533           "desc" : "A button config or array of configs",
 534           "isOptional" : false
 535         }
 536       ],
 537       "returns" : [
 538         {
 539           "name" : "",
 540           "type" : "Roo.Toolbar.Button/Array",
 541           "desc" : ""
 542         }
 543       ]
 544     },
 545     {
 546       "name" : "insertButton",
 547       "type" : "function",
 548       "desc" : "Inserts any {@link Roo.Toolbar.Item}/{@link Roo.Toolbar.Button} at the specified index.",
 549       "sig" : "(index, item)",
 550       "static" : false,
 551       "memberOf" : "Roo.Toolbar",
 552       "isStatic" : false,
 553       "isConstructor" : false,
 554       "isPrivate" : false,
 555       "example" : "",
 556       "deprecated" : "",
 557       "since" : "",
 558       "see" : "",
 559       "exceptions" : "",
 560       "requires" : "",
 561       "params" : [
 562         {
 563           "name" : "index",
 564           "type" : "Number",
 565           "desc" : "The index where the item is to be inserted",
 566           "isOptional" : false
 567         },
 568         {
 569           "name" : "item",
 570           "type" : "Object/Roo.Toolbar.Item/Roo.Toolbar.Button (may be Array)",
 571           "desc" : "The button, or button config object to be inserted.",
 572           "isOptional" : false
 573         }
 574       ],
 575       "returns" : [
 576         {
 577           "name" : "",
 578           "type" : "Roo.Toolbar.Button/Item",
 579           "desc" : ""
 580         }
 581       ]
 582     },
 583     {
 584       "name" : "addxtype",
 585       "type" : "function",
 586       "desc" : "Add an Xtype element",
 587       "sig" : "(xtype)",
 588       "static" : false,
 589       "memberOf" : "Roo.Toolbar",
 590       "isStatic" : false,
 591       "isConstructor" : false,
 592       "isPrivate" : false,
 593       "example" : "",
 594       "deprecated" : "",
 595       "since" : "",
 596       "see" : "",
 597       "exceptions" : "",
 598       "requires" : "",
 599       "params" : [
 600         {
 601           "name" : "xtype",
 602           "type" : "Object",
 603           "desc" : "Xtype Object",
 604           "isOptional" : false
 605         }
 606       ],
 607       "returns" : [
 608         {
 609           "name" : "",
 610           "type" : "Object",
 611           "desc" : "created Object"
 612         }
 613       ]
 614     }
 615   ],
 616   "events" : []
 617 }