--- /dev/null
+{
+ "name" : "Roo.PagingToolbar",
+ "augments" : [
+ "Roo.Toolbar"
+ ],
+ "desc" : "A specialized toolbar that is bound to a {@link Roo.data.Store} and provides automatic paging controls.",
+ "isSingleton" : false,
+ "isStatic" : false,
+ "isBuiltin" : false,
+ "memberOf" : "PagingToolbar",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "config",
+ "type" : "Object",
+ "desc" : "The config object",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ ],
+ "config" : [
+ {
+ "name" : "pageSize",
+ "type" : "Number",
+ "desc" : "The number of records to display per page (defaults to 20)",
+ "memberOf" : "Roo.PagingToolbar",
+ "values" : [
+ ]
+ },
+ {
+ "name" : "dataSource",
+ "type" : "Roo.data.Store",
+ "desc" : "The underlying data store providing the paged data",
+ "memberOf" : "Roo.PagingToolbar",
+ "values" : [
+ ]
+ },
+ {
+ "name" : "container",
+ "type" : "String/HTMLElement/Element",
+ "desc" : "container The id or element that will contain the toolbar",
+ "memberOf" : "Roo.PagingToolbar",
+ "values" : [
+ ]
+ },
+ {
+ "name" : "emptyMsg",
+ "type" : "String",
+ "desc" : "The message to display when no records are found (defaults to \"No data to display\")",
+ "memberOf" : "Roo.PagingToolbar",
+ "values" : [
+ ]
+ },
+ {
+ "name" : "items",
+ "type" : "Array",
+ "desc" : "array of button configs or elements to add (will be converted to a MixedCollection)",
+ "memberOf" : "Roo",
+ "values" : [
+ ]
+ },
+ {
+ "name" : "displayInfo",
+ "type" : "Boolean",
+ "desc" : "True to display the displayMsg (defaults to false)",
+ "memberOf" : "Roo.PagingToolbar",
+ "values" : [
+ ]
+ },
+ {
+ "name" : "displayMsg",
+ "type" : "String",
+ "desc" : "The paging status message to display (defaults to \"Displaying {start} - {end} of {total}\")",
+ "memberOf" : "Roo.PagingToolbar",
+ "values" : [
+ ]
+ }
+ ],
+ "methods" : [
+ {
+ "name" : "bind",
+ "desc" : "Binds the paging toolbar to the specified {@link Roo.data.Store}",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "memberOf" : "Roo.PagingToolbar",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "store",
+ "type" : "Roo.data.Store",
+ "desc" : "The data store to bind",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ ]
+ },
+ {
+ "name" : "unbind",
+ "desc" : "Unbinds the paging toolbar from the specified {@link Roo.data.Store}",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "memberOf" : "Roo.PagingToolbar",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "store",
+ "type" : "Roo.data.Store",
+ "desc" : "The data store to unbind",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ ]
+ },
+ {
+ "name" : "addDom",
+ "desc" : "Adds a new element to the toolbar from the passed {@link Roo.DomHelper} config.",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "memberOf" : "Roo.Toolbar",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "config",
+ "type" : "Object",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Toolbar.Item",
+ "desc" : "The element's item"
+ }
+ ]
+ },
+ {
+ "name" : "addElement",
+ "desc" : "Adds any standard HTML element to the toolbar",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "memberOf" : "Roo.Toolbar",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "el",
+ "type" : "String/HTMLElement/Element",
+ "desc" : "The element or id of the element to add",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Toolbar.Item",
+ "desc" : "The element's item"
+ }
+ ]
+ },
+ {
+ "name" : "getEl",
+ "desc" : "Returns the Element for this toolbar.",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "memberOf" : "Roo.Toolbar",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Element",
+ "desc" : ""
+ }
+ ]
+ },
+ {
+ "name" : "hide",
+ "desc" : "Hide the toolbar",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "memberOf" : "Roo.Toolbar",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ ],
+ "returns" : [
+ ]
+ },
+ {
+ "name" : "addSeparator",
+ "desc" : "Adds a separator",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "memberOf" : "Roo.Toolbar",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Toolbar.Item",
+ "desc" : "The separator item"
+ }
+ ]
+ },
+ {
+ "name" : "show",
+ "desc" : "Show the toolbar",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "memberOf" : "Roo.Toolbar",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ ],
+ "returns" : [
+ ]
+ },
+ {
+ "name" : "addFill",
+ "desc" : "Adds a fill element that forces subsequent additions to the right side of the toolbar",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "memberOf" : "Roo.Toolbar",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Toolbar.Fill",
+ "desc" : "The fill item"
+ }
+ ]
+ },
+ {
+ "name" : "addSpacer",
+ "desc" : "Adds a spacer element",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "memberOf" : "Roo.Toolbar",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Toolbar.Spacer",
+ "desc" : "The spacer item"
+ }
+ ]
+ },
+ {
+ "name" : "add",
+ "desc" : "Adds element(s) to the toolbar -- this function takes a variable number of \narguments of mixed type and adds them to the toolbar.",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "memberOf" : "Roo.Toolbar",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "arg1",
+ "type" : "Mixed",
+ "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>",
+ "isOptional" : false
+ },
+ {
+ "name" : "arg2",
+ "type" : "Mixed",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ ]
+ },
+ {
+ "name" : "addField",
+ "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}.",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "memberOf" : "Roo.Toolbar",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "field",
+ "type" : "Roo.form.Field",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.ToolbarItem",
+ "desc" : ""
+ }
+ ]
+ },
+ {
+ "name" : "addText",
+ "desc" : "Adds text to the toolbar",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "memberOf" : "Roo.Toolbar",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "text",
+ "type" : "String",
+ "desc" : "The text to add",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Toolbar.Item",
+ "desc" : "The element's item"
+ }
+ ]
+ },
+ {
+ "name" : "addItem",
+ "desc" : "Adds any Toolbar.Item or subclass",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "memberOf" : "Roo.Toolbar",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "item",
+ "type" : "Roo.Toolbar.Item",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Toolbar.Item",
+ "desc" : "The item"
+ }
+ ]
+ },
+ {
+ "name" : "addButton",
+ "desc" : "Adds a button (or buttons). See {@link Roo.Toolbar.Button} for more info on the config.",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "memberOf" : "Roo.Toolbar",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "config",
+ "type" : "Object/Array",
+ "desc" : "A button config or array of configs",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Toolbar.Button/Array",
+ "desc" : ""
+ }
+ ]
+ },
+ {
+ "name" : "insertButton",
+ "desc" : "Inserts any {@link Roo.Toolbar.Item}/{@link Roo.Toolbar.Button} at the specified index.",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "memberOf" : "Roo.Toolbar",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "index",
+ "type" : "Number",
+ "desc" : "The index where the item is to be inserted",
+ "isOptional" : false
+ },
+ {
+ "name" : "item",
+ "type" : "Object/Roo.Toolbar.Item/Roo.Toolbar.Button (may be Array)",
+ "desc" : "The button, or button config object to be inserted.",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Toolbar.Button/Item",
+ "desc" : ""
+ }
+ ]
+ },
+ {
+ "name" : "addxtype",
+ "desc" : "Add an Xtype element",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "memberOf" : "Roo.Toolbar",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "xtype",
+ "type" : "Object",
+ "desc" : "Xtype Object",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Object",
+ "desc" : "created Object"
+ }
+ ]
+ }
+ ],
+ "events" : [
+ ]
+}
\ No newline at end of file
projects / roojs1 / blobdiff