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