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" : "unbind",
 133       "type" : "function",
 134       "desc" : "Unbinds the paging toolbar from the specified {@link Roo.data.Store}",
 135       "sig" : "(store)",
 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" : "store",
 150           "type" : "Roo.data.Store",
 151           "desc" : "The data store to unbind",
 152           "isOptional" : false
 153         }
 154       ],
 155       "returns" : []
 156     },
 157     {
 158       "name" : "addDom",
 159       "type" : "function",
 160       "desc" : "Adds a new element to the toolbar from the passed {@link Roo.DomHelper} config.",
 161       "sig" : "(config)",
 162       "static" : false,
 163       "memberOf" : "Roo.Toolbar",
 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" : "config",
 176           "type" : "Object",
 177           "desc" : "",
 178           "isOptional" : false
 179         }
 180       ],
 181       "returns" : [
 182         {
 183           "name" : "",
 184           "type" : "Roo.Toolbar.Item",
 185           "desc" : "The element's item"
 186         }
 187       ]
 188     },
 189     {
 190       "name" : "addElement",
 191       "type" : "function",
 192       "desc" : "Adds any standard HTML element to the toolbar",
 193       "sig" : "(el)",
 194       "static" : false,
 195       "memberOf" : "Roo.Toolbar",
 196       "isStatic" : false,
 197       "isConstructor" : false,
 198       "isPrivate" : false,
 199       "example" : "",
 200       "deprecated" : "",
 201       "since" : "",
 202       "see" : "",
 203       "exceptions" : "",
 204       "requires" : "",
 205       "params" : [
 206         {
 207           "name" : "el",
 208           "type" : "String/HTMLElement/Element",
 209           "desc" : "The element or id of the element to add",
 210           "isOptional" : false
 211         }
 212       ],
 213       "returns" : [
 214         {
 215           "name" : "",
 216           "type" : "Roo.Toolbar.Item",
 217           "desc" : "The element's item"
 218         }
 219       ]
 220     },
 221     {
 222       "name" : "getEl",
 223       "type" : "function",
 224       "desc" : "Returns the Element for this toolbar.",
 225       "sig" : "()\n{\n\n}",
 226       "static" : false,
 227       "memberOf" : "Roo.Toolbar",
 228       "isStatic" : false,
 229       "isConstructor" : false,
 230       "isPrivate" : false,
 231       "example" : "",
 232       "deprecated" : "",
 233       "since" : "",
 234       "see" : "",
 235       "exceptions" : "",
 236       "requires" : "",
 237       "params" : [],
 238       "returns" : [
 239         {
 240           "name" : "",
 241           "type" : "Roo.Element",
 242           "desc" : ""
 243         }
 244       ]
 245     },
 246     {
 247       "name" : "hide",
 248       "type" : "function",
 249       "desc" : "Hide the toolbar",
 250       "sig" : "()\n{\n\n}",
 251       "static" : false,
 252       "memberOf" : "Roo.Toolbar",
 253       "isStatic" : false,
 254       "isConstructor" : false,
 255       "isPrivate" : false,
 256       "example" : "",
 257       "deprecated" : "",
 258       "since" : "",
 259       "see" : "",
 260       "exceptions" : "",
 261       "requires" : "",
 262       "params" : [],
 263       "returns" : []
 264     },
 265     {
 266       "name" : "addSeparator",
 267       "type" : "function",
 268       "desc" : "Adds a separator",
 269       "sig" : "()\n{\n\n}",
 270       "static" : false,
 271       "memberOf" : "Roo.Toolbar",
 272       "isStatic" : false,
 273       "isConstructor" : false,
 274       "isPrivate" : false,
 275       "example" : "",
 276       "deprecated" : "",
 277       "since" : "",
 278       "see" : "",
 279       "exceptions" : "",
 280       "requires" : "",
 281       "params" : [],
 282       "returns" : [
 283         {
 284           "name" : "",
 285           "type" : "Roo.Toolbar.Item",
 286           "desc" : "The separator item"
 287         }
 288       ]
 289     },
 290     {
 291       "name" : "show",
 292       "type" : "function",
 293       "desc" : "Show the toolbar",
 294       "sig" : "()\n{\n\n}",
 295       "static" : false,
 296       "memberOf" : "Roo.Toolbar",
 297       "isStatic" : false,
 298       "isConstructor" : false,
 299       "isPrivate" : false,
 300       "example" : "",
 301       "deprecated" : "",
 302       "since" : "",
 303       "see" : "",
 304       "exceptions" : "",
 305       "requires" : "",
 306       "params" : [],
 307       "returns" : []
 308     },
 309     {
 310       "name" : "addFill",
 311       "type" : "function",
 312       "desc" : "Adds a fill element that forces subsequent additions to the right side of the toolbar",
 313       "sig" : "()\n{\n\n}",
 314       "static" : false,
 315       "memberOf" : "Roo.Toolbar",
 316       "isStatic" : false,
 317       "isConstructor" : false,
 318       "isPrivate" : false,
 319       "example" : "",
 320       "deprecated" : "",
 321       "since" : "",
 322       "see" : "",
 323       "exceptions" : "",
 324       "requires" : "",
 325       "params" : [],
 326       "returns" : [
 327         {
 328           "name" : "",
 329           "type" : "Roo.Toolbar.Fill",
 330           "desc" : "The fill item"
 331         }
 332       ]
 333     },
 334     {
 335       "name" : "addSpacer",
 336       "type" : "function",
 337       "desc" : "Adds a spacer element",
 338       "sig" : "()\n{\n\n}",
 339       "static" : false,
 340       "memberOf" : "Roo.Toolbar",
 341       "isStatic" : false,
 342       "isConstructor" : false,
 343       "isPrivate" : false,
 344       "example" : "",
 345       "deprecated" : "",
 346       "since" : "",
 347       "see" : "",
 348       "exceptions" : "",
 349       "requires" : "",
 350       "params" : [],
 351       "returns" : [
 352         {
 353           "name" : "",
 354           "type" : "Roo.Toolbar.Spacer",
 355           "desc" : "The spacer item"
 356         }
 357       ]
 358     },
 359     {
 360       "name" : "add",
 361       "type" : "function",
 362       "desc" : "Adds element(s) to the toolbar -- this function takes a variable number of \narguments of mixed type and adds them to the toolbar.",
 363       "sig" : "(arg1, arg2)",
 364       "static" : false,
 365       "memberOf" : "Roo.Toolbar",
 366       "isStatic" : false,
 367       "isConstructor" : false,
 368       "isPrivate" : false,
 369       "example" : "",
 370       "deprecated" : "",
 371       "since" : "",
 372       "see" : "",
 373       "exceptions" : "",
 374       "requires" : "",
 375       "params" : [
 376         {
 377           "name" : "arg1",
 378           "type" : "Mixed",
 379           "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>",
 380           "isOptional" : false
 381         },
 382         {
 383           "name" : "arg2",
 384           "type" : "Mixed",
 385           "desc" : "",
 386           "isOptional" : false
 387         }
 388       ],
 389       "returns" : []
 390     },
 391     {
 392       "name" : "addField",
 393       "type" : "function",
 394       "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}.",
 395       "sig" : "(field)",
 396       "static" : false,
 397       "memberOf" : "Roo.Toolbar",
 398       "isStatic" : false,
 399       "isConstructor" : false,
 400       "isPrivate" : false,
 401       "example" : "",
 402       "deprecated" : "",
 403       "since" : "",
 404       "see" : "",
 405       "exceptions" : "",
 406       "requires" : "",
 407       "params" : [
 408         {
 409           "name" : "field",
 410           "type" : "Roo.form.Field",
 411           "desc" : "",
 412           "isOptional" : false
 413         }
 414       ],
 415       "returns" : [
 416         {
 417           "name" : "",
 418           "type" : "Roo.ToolbarItem",
 419           "desc" : ""
 420         }
 421       ]
 422     },
 423     {
 424       "name" : "addText",
 425       "type" : "function",
 426       "desc" : "Adds text to the toolbar",
 427       "sig" : "(text)",
 428       "static" : false,
 429       "memberOf" : "Roo.Toolbar",
 430       "isStatic" : false,
 431       "isConstructor" : false,
 432       "isPrivate" : false,
 433       "example" : "",
 434       "deprecated" : "",
 435       "since" : "",
 436       "see" : "",
 437       "exceptions" : "",
 438       "requires" : "",
 439       "params" : [
 440         {
 441           "name" : "text",
 442           "type" : "String",
 443           "desc" : "The text to add",
 444           "isOptional" : false
 445         }
 446       ],
 447       "returns" : [
 448         {
 449           "name" : "",
 450           "type" : "Roo.Toolbar.Item",
 451           "desc" : "The element's item"
 452         }
 453       ]
 454     },
 455     {
 456       "name" : "addItem",
 457       "type" : "function",
 458       "desc" : "Adds any Toolbar.Item or subclass",
 459       "sig" : "(item)",
 460       "static" : false,
 461       "memberOf" : "Roo.Toolbar",
 462       "isStatic" : false,
 463       "isConstructor" : false,
 464       "isPrivate" : false,
 465       "example" : "",
 466       "deprecated" : "",
 467       "since" : "",
 468       "see" : "",
 469       "exceptions" : "",
 470       "requires" : "",
 471       "params" : [
 472         {
 473           "name" : "item",
 474           "type" : "Roo.Toolbar.Item",
 475           "desc" : "",
 476           "isOptional" : false
 477         }
 478       ],
 479       "returns" : [
 480         {
 481           "name" : "",
 482           "type" : "Roo.Toolbar.Item",
 483           "desc" : "The item"
 484         }
 485       ]
 486     },
 487     {
 488       "name" : "addButton",
 489       "type" : "function",
 490       "desc" : "Adds a button (or buttons). See {@link Roo.Toolbar.Button} for more info on the config.",
 491       "sig" : "(config)",
 492       "static" : false,
 493       "memberOf" : "Roo.Toolbar",
 494       "isStatic" : false,
 495       "isConstructor" : false,
 496       "isPrivate" : false,
 497       "example" : "",
 498       "deprecated" : "",
 499       "since" : "",
 500       "see" : "",
 501       "exceptions" : "",
 502       "requires" : "",
 503       "params" : [
 504         {
 505           "name" : "config",
 506           "type" : "Object/Array",
 507           "desc" : "A button config or array of configs",
 508           "isOptional" : false
 509         }
 510       ],
 511       "returns" : [
 512         {
 513           "name" : "",
 514           "type" : "Roo.Toolbar.Button/Array",
 515           "desc" : ""
 516         }
 517       ]
 518     },
 519     {
 520       "name" : "insertButton",
 521       "type" : "function",
 522       "desc" : "Inserts any {@link Roo.Toolbar.Item}/{@link Roo.Toolbar.Button} at the specified index.",
 523       "sig" : "(index, item)",
 524       "static" : false,
 525       "memberOf" : "Roo.Toolbar",
 526       "isStatic" : false,
 527       "isConstructor" : false,
 528       "isPrivate" : false,
 529       "example" : "",
 530       "deprecated" : "",
 531       "since" : "",
 532       "see" : "",
 533       "exceptions" : "",
 534       "requires" : "",
 535       "params" : [
 536         {
 537           "name" : "index",
 538           "type" : "Number",
 539           "desc" : "The index where the item is to be inserted",
 540           "isOptional" : false
 541         },
 542         {
 543           "name" : "item",
 544           "type" : "Object/Roo.Toolbar.Item/Roo.Toolbar.Button (may be Array)",
 545           "desc" : "The button, or button config object to be inserted.",
 546           "isOptional" : false
 547         }
 548       ],
 549       "returns" : [
 550         {
 551           "name" : "",
 552           "type" : "Roo.Toolbar.Button/Item",
 553           "desc" : ""
 554         }
 555       ]
 556     },
 557     {
 558       "name" : "addxtype",
 559       "type" : "function",
 560       "desc" : "Add an Xtype element",
 561       "sig" : "(xtype)",
 562       "static" : false,
 563       "memberOf" : "Roo.Toolbar",
 564       "isStatic" : false,
 565       "isConstructor" : false,
 566       "isPrivate" : false,
 567       "example" : "",
 568       "deprecated" : "",
 569       "since" : "",
 570       "see" : "",
 571       "exceptions" : "",
 572       "requires" : "",
 573       "params" : [
 574         {
 575           "name" : "xtype",
 576           "type" : "Object",
 577           "desc" : "Xtype Object",
 578           "isOptional" : false
 579         }
 580       ],
 581       "returns" : [
 582         {
 583           "name" : "",
 584           "type" : "Object",
 585           "desc" : "created Object"
 586         }
 587       ]
 588     }
 589   ],
 590   "events" : []
 591 }